W3Cschool
恭喜您成為首批注冊用戶
獲得88經(jīng)驗值獎勵
本接口應(yīng)在服務(wù)器端調(diào)用,詳細(xì)說明參見服務(wù)端API。
本接口支持云調(diào)用。需開發(fā)者工具版本 >= 1.02.1904090(最新穩(wěn)定版下載)
wx-server-sdk >= 0.4.0
發(fā)送客服消息給用戶。詳細(xì)規(guī)則見 發(fā)送客服消息
調(diào)用方式:
POST https://api.weixin.qq.com/cgi-bin/message/custom/send?access_token=ACCESS_TOKEN
屬性 | 類型 | 默認(rèn)值 | 必填 | 說明 |
---|---|---|---|---|
access_token | string | 是 | 接口調(diào)用憑證 | |
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 的結(jié)構(gòu)
屬性 | 類型 | 默認(rèn)值 | 必填 | 說明 |
---|---|---|---|---|
content | string | 是 | 文本消息內(nèi)容 |
image 的結(jié)構(gòu)
屬性 | 類型 | 默認(rèn)值 | 必填 | 說明 |
---|---|---|---|---|
media_id | string | 是 | 發(fā)送的圖片的媒體ID,通過 新增素材接口 上傳圖片文件獲得。 |
link 的結(jié)構(gòu)
屬性 | 類型 | 默認(rèn)值 | 必填 | 說明 |
---|---|---|---|---|
title | string | 是 | 消息標(biāo)題 | |
description | string | 是 | 圖文鏈接消息 | |
url | string | 是 | 圖文鏈接消息被點擊后跳轉(zhuǎn)的鏈接 | |
thumb_url | string | 是 | 圖文鏈接消息的圖片鏈接,支持 JPG、PNG 格式,較好的效果為大圖 640 X 320,小圖 80 X 80 |
miniprogrampage 的結(jié)構(gòu)
屬性 | 類型 | 默認(rèn)值 | 必填 | 說明 |
---|---|---|---|---|
title | string | 是 | 消息標(biāo)題 | |
pagepath | string | 是 | 小程序的頁面路徑,跟app.json對齊,支持參數(shù),比如pages/index/index?foo=bar | |
thumb_media_id | string | 是 | 小程序消息卡片的封面, image 類型的 media_id,通過 新增素材接口 上傳圖片文件獲得,建議大小為 520*416 |
返回的 JSON 數(shù)據(jù)包
屬性 | 類型 | 說明 |
---|---|---|
errcode | number | 錯誤碼 |
errmsg | string | 錯誤信息 |
errcode 的合法值
值 | 說明 | 最低版本 |
---|---|---|
0 | 請求成功 | |
-1 | 系統(tǒng)繁忙,此時請開發(fā)者稍候再試 | |
40001 | 獲取 access_token 時 AppSecret 錯誤,或者 access_token 無效。請開發(fā)者認(rèn)真比對 AppSecret 的正確性,或查看是否正在為恰當(dāng)?shù)男〕绦蛘{(diào)用接口 | |
40002 | 不合法的憑證類型 | |
40003 | 不合法的 OpenID,請開發(fā)者確認(rèn) OpenID 是否是其他小程序的 OpenID | |
45015 | 回復(fù)時間超過限制 | |
45047 | 客服接口下行條數(shù)超過上限 | |
48001 | API 功能未授權(quán),請確認(rèn)小程序已獲得該接口 |
{
"touser":"OPENID",
"msgtype":"text",
"text":
{
"content":"Hello World"
}
}
發(fā)送文本消息時,支持添加可跳轉(zhuǎn)小程序的文字連接
文本內(nèi)容...<a rel="external nofollow" target="_blank" rel="external nofollow" target="_blank" data-miniprogram-appid="appid" data-miniprogram-path="pages/index/index">點擊跳小程序</a>
{
"touser":"OPENID",
"msgtype":"image",
"image": {
"media_id":"MEDIA_ID"
}
}
每次可以發(fā)送一個圖文鏈接
{
"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"
}
}
云調(diào)用是小程序·云開發(fā)提供的在云函數(shù)中調(diào)用微信開放接口的能力,需要在云函數(shù)中通過 wx-server-sdk 使用。
openapi.customerServiceMessage.send
需在 config.json 中配置 customerServiceMessage.send API 的權(quán)限,詳情
屬性 | 類型 | 默認(rèn)值 | 必填 | 說明 |
---|---|---|---|---|
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 的結(jié)構(gòu)
屬性 | 類型 | 默認(rèn)值 | 必填 | 說明 |
---|---|---|---|---|
content | string | 是 | 文本消息內(nèi)容 |
image 的結(jié)構(gòu)
屬性 | 類型 | 默認(rèn)值 | 必填 | 說明 |
---|---|---|---|---|
mediaId | string | 是 | 發(fā)送的圖片的媒體ID,通過 新增素材接口 上傳圖片文件獲得。 |
link 的結(jié)構(gòu)
屬性 | 類型 | 默認(rèn)值 | 必填 | 說明 |
---|---|---|---|---|
title | string | 是 | 消息標(biāo)題 | |
description | string | 是 | 圖文鏈接消息 | |
url | string | 是 | 圖文鏈接消息被點擊后跳轉(zhuǎn)的鏈接 | |
thumbUrl | string | 是 | 圖文鏈接消息的圖片鏈接,支持 JPG、PNG 格式,較好的效果為大圖 640 X 320,小圖 80 X 80 |
miniprogrampage 的結(jié)構(gòu)
屬性 | 類型 | 默認(rèn)值 | 必填 | 說明 |
---|---|---|---|---|
title | string | 是 | 消息標(biāo)題 | |
pagepath | string | 是 | 小程序的頁面路徑,跟app.json對齊,支持參數(shù),比如pages/index/index?foo=bar | |
thumbMediaId | string | 是 | 小程序消息卡片的封面, image 類型的 media_id,通過 新增素材接口 上傳圖片文件獲得,建議大小為 520*416 |
返回的 JSON 數(shù)據(jù)包
屬性 | 類型 | 說明 |
---|---|---|
errCode | number | 錯誤碼 |
errMsg | string | 錯誤信息 |
errCode 的合法值
值 | 說明 | 最低版本 |
---|---|---|
0 | 成功 |
拋出的異常
屬性 | 類型 | 說明 |
---|---|---|
errCode | number | 錯誤碼 |
errMsg | string | 錯誤信息 |
errCode 的合法值
值 | 說明 | 最低版本 |
---|---|---|
-1 | 系統(tǒng)繁忙,此時請開發(fā)者稍候再試 | |
40001 | 獲取 access_token 時 AppSecret 錯誤,或者 access_token 無效。請開發(fā)者認(rèn)真比對 AppSecret 的正確性,或查看是否正在為恰當(dāng)?shù)男〕绦蛘{(diào)用接口 | |
40002 | 不合法的憑證類型 | |
40003 | 不合法的 OpenID,請開發(fā)者確認(rèn) OpenID 是否是其他小程序的 OpenID | |
45015 | 回復(fù)時間超過限制 | |
45047 | 客服接口下行條數(shù)超過上限 | |
48001 | API 功能未授權(quán),請確認(rèn)小程序已獲得該接口 |
const cloud = require('wx-server-sdk')
cloud.init()
exports.main = async (event, context) => {
try {
const result = await cloud.openapi.customerServiceMessage.send({
touser: 'OPENID',
msgtype: 'text',
text: {
content: 'Hello World'
}
})
return result
} catch (err) {
return err
}
}
發(fā)送文本消息時,支持添加可跳轉(zhuǎn)小程序的文字連接
文本內(nèi)容...<a rel="external nofollow" target="_blank" rel="external nofollow" target="_blank" data-miniprogram-appid="appid" data-miniprogram-path="pages/index/index">點擊跳小程序</a>
const cloud = require('wx-server-sdk')
cloud.init()
exports.main = async (event, context) => {
try {
const result = await cloud.openapi.customerServiceMessage.send({
touser: 'OPENID',
msgtype: 'image',
image: {
mediaId: 'MEDIA_ID'
}
})
return result
} catch (err) {
return err
}
}
每次可以發(fā)送一個圖文鏈接
const cloud = require('wx-server-sdk')
cloud.init()
exports.main = async (event, context) => {
try {
const result = await cloud.openapi.customerServiceMessage.send({
touser: 'OPENID',
msgtype: 'link',
link: {
title: 'Happy Day',
description: 'Is Really A Happy Day',
url: 'URL',
thumbUrl: 'THUMB_URL'
}
})
return result
} catch (err) {
return err
}
}
const cloud = require('wx-server-sdk')
cloud.init()
exports.main = async (event, context) => {
try {
const result = await cloud.openapi.customerServiceMessage.send({
touser: 'OPENID',
msgtype: 'miniprogrampage',
miniprogrampage: {
title: 'title',
pagepath: 'pagepath',
thumbMediaId: 'thumb_media_id'
}
})
return result
} catch (err) {
return err
}
}
Copyright©2021 w3cschool編程獅|閩ICP備15016281號-3|閩公網(wǎng)安備35020302033924號
違法和不良信息舉報電話:173-0602-2364|舉報郵箱:jubao@eeedong.com
掃描二維碼
下載編程獅App
編程獅公眾號
聯(lián)系方式:
更多建議: