微信小程序 setUpdatableMsg

2022-05-11 14:53 更新

updatableMessage.setUpdatableMsg

本接口應(yīng)在服務(wù)器端調(diào)用,詳細(xì)說明參見服務(wù)端API。
本接口支持云調(diào)用。需開發(fā)者工具版本 >= 1.02.1904090(最新穩(wěn)定版下載
wx-server-sdk >= 0.4.0

修改被分享的動態(tài)消息。詳見動態(tài)消息。

調(diào)用方式:

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

HTTPS 調(diào)用

請求地址

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

請求參數(shù)

屬性 類型 默認(rèn)值 必填 說明
access_token string 接口調(diào)用憑證
activity_id string 動態(tài)消息的 ID,通過 updatableMessage.createActivityId 接口獲取
target_state number 動態(tài)消息修改后的狀態(tài)(具體含義見后文)
template_info Object 動態(tài)消息對應(yīng)的模板信息

target_state 的合法值

說明 最低版本
0 未開始
1 已開始

template_info 的結(jié)構(gòu)

屬性 類型 默認(rèn)值 必填 說明
parameter_list Array.<Object> 模板中需要修改的參數(shù)

parameter_list 的結(jié)構(gòu)

屬性 類型 默認(rèn)值 必填 說明
name string 要修改的參數(shù)名
value string 修改后的參數(shù)值

name 的合法值

說明 最低版本
member_count target_state = 0 時必填,文字內(nèi)容模板中 member_count 的值
room_limit target_state = 0 時必填,文字內(nèi)容模板中 room_limit 的值
path target_state = 1 時必填,點擊「進(jìn)入」啟動小程序時使用的路徑。
對于小游戲,沒有頁面的概念,可以用于傳遞查詢字符串(query),如 "?foo=bar"
version_type target_state = 1 時必填,點擊「進(jìn)入」啟動小程序時使用的版本。
有效參數(shù)值為:develop(開發(fā)版),trial(體驗版),release(正式版)

返回值

Object

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

屬性 類型 說明
errcode number 錯誤碼
errmsg number 錯誤信息

errcode 的合法值

說明 最低版本
0 請求成功
-1 系統(tǒng)繁忙。此時請開發(fā)者稍候再試
42001 access_token 過期
44002 post 數(shù)據(jù)為空
47001 post 數(shù)據(jù)中參數(shù)缺失
47501 參數(shù) activity_id 錯誤
47502 參數(shù) target_state 錯誤
47503 參數(shù) version_type 錯誤
47504 activity_id 過期

消息狀態(tài)

消息有兩個狀態(tài)(target_state),分別有其對應(yīng)的文字內(nèi)容和顏色。文字內(nèi)容模板和顏色不支持變更。

狀態(tài) 文字內(nèi)容 顏色 允許轉(zhuǎn)移的狀態(tài)
0 "成員正在加入,當(dāng)前 {member_count}/{room_limit} 人" #FA9D39 0, 1
1 "已開始" #CCCCCC

活動的默認(rèn)有效期是 24 小時。活動結(jié)束后,消息內(nèi)容會變成統(tǒng)一的樣式:

  • 文字內(nèi)容:“已結(jié)束”
  • 文字顏色:#00ff00

curl 調(diào)用示例

curl -d '{"activity_id": "966_NGiqxxxxxxxxx...xxxxxxxxE33BlwX", "target_state": 0, "template_info": {"parameter_list": [{"name": "member_count", "value": "2"}, {"name":"room_limit", "value": "5"} ] } }' \
'https://api.weixin.qq.com/cgi-bin/message/wxopen/updatablemsg/send?access_token=ACCESS_TOKEN'

云調(diào)用

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

接口方法

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

請求參數(shù)

屬性 類型 默認(rèn)值 必填 說明
activityId string 動態(tài)消息的 ID,通過 updatableMessage.createActivityId 接口獲取
targetState number 動態(tài)消息修改后的狀態(tài)(具體含義見后文)
templateInfo Object 動態(tài)消息對應(yīng)的模板信息

targetState 的合法值

說明 最低版本
0 未開始
1 已開始

templateInfo 的結(jié)構(gòu)

屬性 類型 默認(rèn)值 必填 說明
parameterList Array.<Object> 模板中需要修改的參數(shù)

parameterList 的結(jié)構(gòu)

屬性 類型 默認(rèn)值 必填 說明
name string 要修改的參數(shù)名
value string 修改后的參數(shù)值

name 的合法值

說明 最低版本
member_count target_state = 0 時必填,文字內(nèi)容模板中 member_count 的值
room_limit target_state = 0 時必填,文字內(nèi)容模板中 room_limit 的值
path target_state = 1 時必填,點擊「進(jìn)入」啟動小程序時使用的路徑。
對于小游戲,沒有頁面的概念,可以用于傳遞查詢字符串(query),如 "?foo=bar"
version_type target_state = 1 時必填,點擊「進(jìn)入」啟動小程序時使用的版本。
有效參數(shù)值為:develop(開發(fā)版),trial(體驗版),release(正式版)

返回值

Object

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

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

errCode 的合法值

說明 最低版本
0 成功

異常

Object

拋出的異常

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

errCode 的合法值

說明 最低版本
-1 系統(tǒng)繁忙。此時請開發(fā)者稍候再試
42001 access_token 過期
44002 post 數(shù)據(jù)為空
47001 post 數(shù)據(jù)中參數(shù)缺失
47501 參數(shù) activity_id 錯誤
47502 參數(shù) target_state 錯誤
47503 參數(shù) version_type 錯誤
47504 activity_id 過期


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

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號