# 预览消息
接口应在服务器端调用,不可在前端(小程序、网页、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_token | string | 是 | 接口调用凭证,可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
touser | string | 否 | 接收消息用户对应该公众号的openid(touser、towxname二选一) |
towxname | string | 否 | 接收消息用户微信号,实现对微信号的预览(touser、towxname二选一) |
msgtype | string | 是 | 群发的消息类型,图文消息为mpnews,文本消息为text,语音为voice,音乐为music,图片为image,视频为mpvideo,卡券为wxcard |
mpnews | object | 否 | 图文消息 |
text | object | 否 | 文本消息 |
voice | object | 否 | 语音消息 |
music | object | 否 | 音乐消息 |
image | object | 否 | 图片消息 |
mpvideo | object | 否 | 视频消息 |
wxcard | object | 否 | 卡券消息 |
# 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_id | string | 否 | 卡券ID |
card_ext | object | 否 | 卡券属性 |
# Body.wxcard.card_ext Object Payload
卡券属性
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
code | string | 否 | 卡券code |
openid | string | 否 | 用户openid |
timestamp | string | 否 | 时间戳 |
signature | string | 否 | 签名 |
# 3. 返回参数
# 返回体 Response Payload
参数名 | 类型 | 说明 |
---|---|---|
errcode | number | 错误码 |
errmsg | string | 错误信息 |
# 4. 注意事项
为了满足第三方平台开发者的需求,在保留对openID预览能力的同时,增加了对指定微信号发送预览的能力,但该能力每日调用次数有限制(100次),请勿滥用。
# 5. 代码示例
请求示例
{
"towxname":"示例的微信号",
"mpnews":{
"media_id":"123dsdajkasd231jhksad"
},
"msgtype":"mpnews"
}
返回示例
{
"errcode":0,
"errmsg":"preview success"
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
0 | ok或者in a normal state | ok是指从不正常变成正常 in a normal state是指本来就正常 |
# 7. 适用范围
本接口在不同账号类型下的可调用情况:
公众号 | 服务号 |
---|---|
仅认证 | 仅认证 |
- 仅认证:表示仅允许企业主体已认证账号调用,未认证或不支持认证的账号无法调用
- 其他未明确声明的账号类型,如无特殊说明,均不可调用此接口;