微信小程序 send

2022-05-10 16:25 更新

customerServiceMessage.send

本接口應(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)用方式:

  • HTTPS 調(diào)用
  • 云調(diào)用

HTTPS 調(diào)用

請求地址

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

請求參數(shù)

屬性 類型 默認(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

返回值

Object

返回的 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)小程序已獲得該接口

下發(fā)消息示例

發(fā)送文本消息

{
  "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>
說明:
  1. data-miniprogram-appid 項,填寫小程序appid,則表示該鏈接跳轉(zhuǎn)小程序;
  2. data-miniprogram-path項,填寫小程序路徑,路徑與app.json中保持一致,可帶參數(shù);
  3. 對于不支持 data-miniprogram-appid 項的客戶端版本(6.5.16 以下),如果有 herf 項,則仍然保持跳 href 中的鏈接;
  4. 小程序發(fā)帶小程序文字鏈的文本消息,data-miniprogram-appid必須是該小程序的appid。

發(fā)送圖片消息

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

發(fā)送圖文鏈接

每次可以發(fā)送一個圖文鏈接

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

發(fā)送小程序卡片

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

云調(diào)用

云調(diào)用是小程序·云開發(fā)提供的在云函數(shù)中調(diào)用微信開放接口的能力,需要在云函數(shù)中通過 wx-server-sdk 使用。

接口方法

openapi.customerServiceMessage.send
需在 config.json 中配置 customerServiceMessage.send API 的權(quán)限,詳情

請求參數(shù)

屬性 類型 默認(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

返回值

Object

返回的 JSON 數(shù)據(jù)包

屬性 類型 說明
errCode number 錯誤碼
errMsg string 錯誤信息

errCode 的合法值

說明 最低版本
0 成功

異常

Object

拋出的異常

屬性 類型 說明
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)小程序已獲得該接口

下發(fā)消息示例

發(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: '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>
說明:
  1. data-miniprogram-appid 項,填寫小程序appid,則表示該鏈接跳轉(zhuǎn)小程序;
  2. data-miniprogram-path項,填寫小程序路徑,路徑與app.json中保持一致,可帶參數(shù);
  3. 對于不支持 data-miniprogram-appid 項的客戶端版本(6.5.16 以下),如果有 herf 項,則仍然保持跳 href 中的鏈接;
  4. 小程序發(fā)帶小程序文字鏈的文本消息,data-miniprogram-appid必須是該小程序的appid。

發(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: 'image',
        image: {
          mediaId: 'MEDIA_ID'
        }
      })
    return result
  } catch (err) {
    return err
  }
}

發(fā)送圖文鏈接

每次可以發(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
  }
}

發(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: 'miniprogrampage',
        miniprogrampage: {
          title: 'title',
          pagepath: 'pagepath',
          thumbMediaId: 'thumb_media_id'
        }
      })
    return result
  } catch (err) {
    return err
  }
}


以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號