# 發(fā)送客服消息
接口應(yīng)在服務(wù)器端調(diào)用,詳細(xì)說明參見服務(wù)端API。
# 接口說明
# 接口英文名
sendCustomMessage
# 功能描述
該接口用于發(fā)送客服消息給用戶。詳細(xì)規(guī)則見 發(fā)送客服消息
# 注意事項
- 發(fā)送文本消息時,支持添加可跳轉(zhuǎn)小程序的文字連接.
- data-miniprogram-appid 項,填寫小程序appid,則表示該鏈接跳轉(zhuǎn)小程序
- data-miniprogram-path項,填寫小程序路徑,路徑與app.json中保持一致,可帶參數(shù);
- 對于不支持 data-miniprogram-appid 項的客戶端版本(6.5.16 以下),如果有 herf 項,則仍然保持跳 href 中的鏈接;
- 小程序發(fā)帶小程序文字鏈的文本消息,data-miniprogram-appid必須是該小程序的appid
# 調(diào)用方式
# HTTPS 調(diào)用
POST https://api.weixin.qq.com/cgi-bin/message/custom/send?access_token=ACCESS_TOKEN
# 第三方調(diào)用
調(diào)用方式以及出入?yún)⒑虷TTPS相同,僅是調(diào)用的token不同
該接口所屬的權(quán)限集id為:1、6、19、59、100、101
服務(wù)商獲得其中之一權(quán)限集授權(quán)后,可通過使用authorizer_access_token代商家進(jìn)行調(diào)用
# 請求參數(shù)
| 屬性 | 類型 | 必填 | 說明 | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| access_token | string | 是 | 接口調(diào)用憑證,該參數(shù)為 URL 參數(shù),非 Body 參數(shù)。使用getAccessToken 或者 authorizer_access_token | ||||||||||||||||||||||||||
| touser | string | 是 | 用戶的 OpenID | ||||||||||||||||||||||||||
| msgtype | string | 是 | 消息類型。text表示文本消息;image表示圖片消息;link表示圖文鏈接;miniprogrampage表示小程序卡片。 | ||||||||||||||||||||||||||
| text | object | 否 | 文本消息,msgtype="text" 時必填 | ||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||
| image | object | 否 | 圖片消息,msgtype="image" 時必填 | ||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||
| link | object | 否 | 圖文鏈接,msgtype="link" 時必填 | ||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||
| miniprogrampage | object | 否 | 小程序卡片,msgtype="miniprogrampage" 時必填 | ||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||
# 返回參數(shù)
| 屬性 | 類型 | 說明 |
|---|---|---|
| errcode | number | 錯誤碼 |
| errmsg | string | 錯誤信息 |
# 調(diào)用示例
示例說明: 發(fā)送文本消息
# 請求數(shù)據(jù)示例
{
"touser":"OPENID",
"msgtype":"text",
"text":
{
"content":"Hello World"
}
}
# 返回數(shù)據(jù)示例
{
"errcode":0,
"errmsg":"ok"
}
示例說明: 發(fā)送圖片消息
# 請求數(shù)據(jù)示例
{
"touser":"OPENID",
"msgtype":"image",
"image": {
"media_id":"MEDIA_ID"
}
}
# 返回數(shù)據(jù)示例
{
"errcode":0,
"errmsg":"ok"
}
示例說明: 發(fā)送圖文鏈接
# 請求數(shù)據(jù)示例
{
"touser": "OPENID",
"msgtype": "link",
"link": {
"title": "Happy Day",
"description": "Is Really A Happy Day",
"url": "URL",
"thumb_url": "THUMB_URL"
}
}
# 返回數(shù)據(jù)示例
{
"errcode":0,
"errmsg":"ok"
}
示例說明: 發(fā)送小程序卡片
# 請求數(shù)據(jù)示例
{
"touser":"OPENID",
"msgtype":"miniprogrampage",
"miniprogrampage": {
"title":"title",
"pagepath":"pagepath",
"thumb_media_id":"thumb_media_id"
}
}
# 返回數(shù)據(jù)示例
{
"errcode":0,
"errmsg":"ok"
}
# 錯誤碼
| 錯誤碼 | 錯誤描述 | 解決方案 |
|---|---|---|
| -1 | system error | 系統(tǒng)繁忙,此時請開發(fā)者稍候再試 |
| 40001 | invalid credential? access_token isinvalid or not latest | 獲取 access_token 時 AppSecret 錯誤,或者 access_token 無效。請開發(fā)者認(rèn)真比對 AppSecret 的正確性,或查看是否正在為恰當(dāng)?shù)墓娞栒{(diào)用接口 |
| 40013 | invalid appid | 不合法的 AppID ,請開發(fā)者檢查 AppID 的正確性,避免異常字符,注意大小寫 |
| 70000 | 為保護(hù)未成年人權(quán)益,該條消息發(fā)送失敗 |