# 预览消息

[调试诊断](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_tools)

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：preview

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

## 1. 调用方式

### HTTPS 调用

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

### 云调用

- 本接口不支持云调用。

### 第三方调用

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

- 该接口所属的权限集 id 为：7

- 服务商获得其中之一权限集授权后，可通过使用 [authorizer_access_token](/doc/oplatform/developers/dev/AuthorizerAccessToken.md) 代商家进行调用，具体可查看 [第三方调用](/doc/oplatform/Third-party_Platforms/2.0/Before_Develop/call_interface.md) 说明文档。

## 2. 请求参数

### 查询参数 `Query String Parameters`

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "说明": "接口调用凭证，可使用 [access_token](/doc/service/api/base/api_getaccesstoken)、[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "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`

文章

```json
[
  {
    "参数名": "media_id",
    "类型": "-",
    "必填": "否",
    "说明": "用于群发的消息的media_id"
  }
]
```

### Body.text `Object Payload`

文本消息

```json
[
  {
    "参数名": "content",
    "类型": "-",
    "必填": "否",
    "说明": "发送文本消息时文本的内容"
  }
]
```

### Body.voice `Object Payload`

语音消息

```json
[
  {
    "参数名": "media_id",
    "类型": "-",
    "必填": "否",
    "说明": "用于群发的消息的media_id"
  }
]
```

### Body.music `Object Payload`

音乐消息

```json
[
  {
    "参数名": "media_id",
    "类型": "-",
    "必填": "否",
    "说明": "用于群发的消息的media_id"
  }
]
```

### Body.image `Object Payload`

贴图消息

```json
[
  {
    "参数名": "media_id",
    "类型": "-",
    "必填": "否",
    "说明": "用于群发的消息的media_id"
  }
]
```

### Body.mpvideo `Object Payload`

视频消息

```json
[
  {
    "参数名": "media_id",
    "类型": "-",
    "必填": "否",
    "说明": "用于群发的消息的media_id"
  }
]
```

### Body.wxcard `Object Payload`

卡券消息

```json
[
  {
    "参数名": "card_id",
    "类型": "string",
    "必填": "否",
    "说明": "卡券ID"
  },
  {
    "参数名": "card_ext",
    "类型": "object",
    "必填": "否",
    "说明": "卡券属性"
  }
]
```

### Body.wxcard.card_ext `Object Payload`

卡券属性

```json
[
  {
    "参数名": "code",
    "类型": "string",
    "必填": "否",
    "说明": "卡券code"
  },
  {
    "参数名": "openid",
    "类型": "string",
    "必填": "否",
    "说明": "用户openid"
  },
  {
    "参数名": "timestamp",
    "类型": "string",
    "必填": "否",
    "说明": "时间戳"
  },
  {
    "参数名": "signature",
    "类型": "string",
    "必填": "否",
    "说明": "签名"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误信息"
  }
]
```

## 4. 注意事项

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

## 5. 代码示例

请求示例

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

返回示例

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

## 6. 错误码

以下是本接口的错误码列表，其他错误码可参考 [通用错误码](/doc/oplatform/developers/errCode/README.md)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

```json
[
  {
    "错误码": "0",
    "错误描述": "ok或者in a normal state",
    "解决方案": "ok是指从不正常变成正常 in a normal state是指本来就正常"
  }
]
```

## 7. 适用范围

本接口在不同账号类型下的可调用情况：

```json
[
  {
    "公众号": "仅认证",
    "服务号": "仅认证"
  }
]
```

- 仅认证：表示仅允许企业主体已认证账号调用，未认证或不支持认证的账号无法调用。
- 其他未明确声明的账号类型，如无特殊说明，均不可调用此接口。