# 发送客服消息

调试工具

接口应在服务器端调用，详细说明参见服务端API。

# 接口说明

# 接口英文名

sendCustomMessage

# 功能描述

该接口用于发送客服消息给用户。详细规则见发送客服消息

# 注意事项

发送文本消息时，支持添加可跳转小程序的文字连接.
data-miniprogram-appid 项，填写小程序appid，则表示该链接跳转小程序
data-miniprogram-path项，填写小程序路径，路径与app.json中保持一致，可带参数；
对于不支持 data-miniprogram-appid 项的客户端版本（6.5.16 以下），如果有 herf 项，则仍然保持跳 href 中的链接；
小程序发带小程序文字链的文本消息，data-miniprogram-appid必须是该小程序的appid

# 调用方式

# HTTPS 调用


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

# 第三方调用

调用方式以及出入参和HTTPS相同，仅是调用的token不同
该接口所属的权限集id为：1、6、19、59、100、101
服务商获得其中之一权限集授权后，可通过使用authorizer_access_token代商家进行调用

# 请求参数

属性

类型

必填

说明

access_token

string

是

接口调用凭证，该参数为 URL 参数，非 Body 参数。使用getAccessToken 或者 authorizer_access_token

touser

string

是

用户的 OpenID

msgtype

string

是

消息类型。text表示文本消息；image表示图片消息；link表示图文链接；miniprogrampage表示小程序卡片。

text

object

否

文本消息，msgtype="text" 时必填

	属性	类型	必填	说明
	content	string	否	文本消息内容。msgtype="text" 时必填

image

object

否

图片消息，msgtype="image" 时必填

	属性	类型	必填	说明
	media_id	string	否	发送的图片的媒体ID，通过 uploadTempMedia上传图片文件获得。

link

object

否

图文链接，msgtype="link" 时必填

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

miniprogrampage

object

否

小程序卡片，msgtype="miniprogrampage" 时必填

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

# 返回参数

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

# 调用示例

示例说明: 发送文本消息

# 请求数据示例


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

# 返回数据示例


{
  "errcode":0,
  "errmsg":"ok"
}

示例说明: 发送图片消息

# 请求数据示例


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

# 返回数据示例


{
  "errcode":0,
  "errmsg":"ok"
}

示例说明: 发送图文链接

# 请求数据示例


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

# 返回数据示例


{
  "errcode":0,
  "errmsg":"ok"
}

示例说明: 发送小程序卡片

# 请求数据示例


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

# 返回数据示例


{
  "errcode":0,
  "errmsg":"ok"
}

# 错误码

错误码	错误描述	解决方案
-1	system error	系统繁忙，此时请开发者稍候再试
40001	invalid credential access_token isinvalid or not latest	获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口
40013	invalid appid	不合法的 AppID ，请开发者检查 AppID 的正确性，避免异常字符，注意大小写
70000	为保护未成年人权益，该条消息发送失败