# 预览消息

调试工具

接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南

接口英文名:preview

本接口发送消息给指定用户,在手机端查看消息的样式和排版。

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/cgi-bin/message/mass/preview?access_token=ACCESS_TOKEN

# 云调用

  • 本接口不支持云调用

# 第三方调用

  • 本接口支持第三方平台代商家调用。

  • 该接口所属的权限集 id 为:7

  • 服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。

# 2. 请求参数

# 查询参数 Query String parameters

参数名类型必填说明
access_tokenstring接口调用凭证,可使用 access_tokenauthorizer_access_token

# 请求体 Request Payload

参数名类型必填说明
touserstring接收消息用户对应该公众号的openid(touser、towxname二选一)
towxnamestring接收消息用户微信号,实现对微信号的预览(touser、towxname二选一)
msgtypestring群发的消息类型,图文消息为mpnews,文本消息为text,语音为voice,音乐为music,图片为image,视频为mpvideo,卡券为wxcard
mpnewsobject图文消息
textobject文本消息
voiceobject语音消息
musicobject音乐消息
imageobject图片消息
mpvideoobject视频消息
wxcardobject卡券消息

# Body.mpnews Object Payload

图文消息

参数名类型必填说明
media_id-用于群发的消息的media_id

# Body.text Object Payload

文本消息

参数名类型必填说明
content-发送文本消息时文本的内容

# Body.voice Object Payload

语音消息

参数名类型必填说明
media_id-用于群发的消息的media_id

# Body.music Object Payload

音乐消息

参数名类型必填说明
media_id-用于群发的消息的media_id

# Body.image Object Payload

图片消息

参数名类型必填说明
media_id-用于群发的消息的media_id

# Body.mpvideo Object Payload

视频消息

参数名类型必填说明
media_id-用于群发的消息的media_id

# Body.wxcard Object Payload

卡券消息

参数名类型必填说明
card_idstring卡券ID
card_extobject卡券属性

# Body.wxcard.card_ext Object Payload

卡券属性

参数名类型必填说明
codestring卡券code
openidstring用户openid
timestampstring时间戳
signaturestring签名

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
errcodenumber错误码
errmsgstring错误信息

# 4. 注意事项

为了满足第三方平台开发者的需求,在保留对openID预览能力的同时,增加了对指定微信号发送预览的能力,但该能力每日调用次数有限制(100次),请勿滥用。

# 5. 代码示例

请求示例

{
   "towxname":"示例的微信号", 
   "mpnews":{              
      "media_id":"123dsdajkasd231jhksad"             
   },
   "msgtype":"mpnews" 
}

返回示例

{
   "errcode":0,
   "errmsg":"preview success"
}

# 6. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码

错误码错误描述解决方案
0ok或者in a normal stateok是指从不正常变成正常 in a normal state是指本来就正常

# 7. 适用范围

本接口在不同账号类型下的可调用情况:
公众号服务号
仅认证 仅认证
  • 仅认证:表示仅允许企业主体已认证账号调用,未认证或不支持认证的账号无法调用
  • 其他未明确声明的账号类型,如无特殊说明,均不可调用此接口;