发送客服消息

调用本接口可以发送客服消息给用户,当用户和小程序客服产生特定动作的交互时(具体动作列表请见下方说明),微信将会把消息数据推送给开发者,开发者可以在一段时间内(目前为 48 小时)调用客服接口,通过调用该接口 来发送消息给普通用户。此接口主要用于客服等有人工消息处理环节的功能,方便开发者为用户提供更加优质的服务。

详情可见发送客服消息,使用过程中如遇到问题,可在开放平台服务商专区发帖交流。

注意:目前允许的动作列表如下,不同动作触发后,允许的客服接口下发消息条数和下发时限不同。详情请查看发送客服消息

请求地址

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

请求参数

属性 类型 默认值 必填 说明
access_token String 第三方平台接口调用令牌authorizer_access_token
touser string 用户的 OpenID
msgtype string 消息类型
text Object 文本消息,msgtype="text" 时必填
image Object 图片消息,msgtype="image" 时必填
link Object 图文链接,msgtype="link" 时必填
miniprogrampage Object 小程序卡片,msgtype="miniprogrampage" 时必填

msgtype 的合法值

说明
text 文本消息
image 图片消息
link 图文链接
miniprogrampage 小程序卡片

text 的结构

属性 类型 默认值 必填 说明
content string 文本消息内容

image 的结构

属性 类型 默认值 必填 说明
media_id string 发送的图片的媒体ID,通过 上传媒体文件 上传图片文件获得。

link 的结构

属性 类型 默认值 必填 说明
title string 消息标题
description string 图文链接消息
url string 图文链接消息被点击后跳转的链接
thumb_url string 图文链接消息的图片链接,支持 JPG、PNG 格式,较好的效果为大图 640 X 320,小图 80 X 80

miniprogrampage 的结构

属性 类型 默认值 必填 说明
title string 消息标题
pagepath string 小程序的页面路径,跟app.json对齐,支持参数,比如pages/index/index?foo=bar
thumb_media_id string 小程序消息卡片的封面, image 类型的 media_id,通过 上传媒体文件 上传图片文件获得,建议大小为 520*416

返回值说明

返回的 JSON 数据包

属性 类型 说明
errcode number 错误码
errmsg string 错误信息

返回码说明

说明
0 请求成功
-1 系统繁忙,此时请开发者稍候再试
40001 获取 access_token 时 AppSecret 错误,或者 access_token 无效。请开发者认真比对 AppSecret 的正确性,或查看是否正在为恰当的小程序调用接口
40002 不合法的凭证类型
40003 不合法的 OpenID,请开发者确认 OpenID 是否是其他小程序的 OpenID
45015 回复时间超过限制
45047 客服接口下行条数超过上限
48001 API 功能未授权,请确认小程序已获得该接口
其他错误码 请查看全局错误码

下发消息示例

发送文本消息

{
  "touser":"OPENID",
  "msgtype":"text",
  "text":
  {
    "content":"Hello World"
  }
}

发送文本消息时,支持添加可跳转小程序的文字连接

文本内容...<a href="http://www.qq.com" data-miniprogram-appid="appid" data-miniprogram-path="pages/index/index">点击跳小程序</a>
说明:
  1. data-miniprogram-appid 项,填写小程序appid,则表示该链接跳转小程序;
  2. data-miniprogram-path项,填写小程序路径,路径与app.json中保持一致,可带参数;
  3. 对于不支持 data-miniprogram-appid 项的客户端版本(6.5.16 以下),如果有 herf 项,则仍然保持跳 href 中的链接;
  4. 小程序发带小程序文字链的文本消息,data-miniprogram-appid必须是该小程序的appid。

发送图片消息

{
  "touser":"OPENID",
  "msgtype":"image",
  "image": {
    "media_id":"MEDIA_ID"
  }
}

发送图文链接

每次可以发送一个图文链接

{
  "touser": "OPENID",
  "msgtype": "link",
  "link": {
    "title": "Happy Day",
    "description": "Is Really A Happy Day",
    "url": "URL",
    "thumb_url": "THUMB_URL"
  }
}

发送小程序卡片

{
 "touser":"OPENID",
 "msgtype":"miniprogrampage",
 "miniprogrampage": {
   "title":"title",
   "pagepath":"pagepath",
   "thumb_media_id":"thumb_media_id"
 }
}