# 修改动态消息

调试工具

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

本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载),wx-server-sdk >= 0.4.0

# 接口说明

# 接口英文名

setUpdatableMsg

# 功能描述

该接口用于修改被分享的动态消息。详见动态消息

# 调用方式

# HTTPS 调用


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

# 云调用

  • 出入参和HTTPS调用相同,调用方式可查看云调用说明文档

  • 接口方法为: openapi.updatableMessage.setUpdatableMsg

# 第三方调用

  • 调用方式以及出入参和HTTPS相同,仅是调用的token不同

  • 该接口所属的权限集id为:18

  • 服务商获得其中之一权限集授权后,可通过使用authorizer_access_token代商家进行调用

# 请求参数

属性 类型 必填说明
access_token string 接口调用凭证,该参数为 URL 参数,非 Body 参数。使用getAccessToken 或者 authorizer_access_token
activity_id string 动态消息的 ID,通过 createActivityId 接口获取
target_state number 动态消息修改后的状态(具体含义见后文)
template_info object 动态消息对应的模板信息
属性 类型 必填 说明
parameter_list array<object> 模板中需要修改的参数
属性 类型 必填 说明
name string 要修改的参数名
value string 修改后的参数值

# 返回参数

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

# 其他说明

# target_state 的合法值

说明
0 未开始
1 已开始

# name 的合法值

说明
member_count target_state = 0 时必填,文字内容模板中 member_count 的值
room_limit target_state = 0 时必填,文字内容模板中 room_limit 的值
path target_state = 1 时必填,点击「进入」启动小程序时使用的路径。
对于小游戏,没有页面的概念,可以用于传递查询字符串(query),如 "?foo=bar"
version_type target_state = 1 时必填,点击「进入」启动小程序时使用的版本。
有效参数值为:develop(开发版),trial(体验版),release(正式版)

# 消息状态

消息有两个状态(target_state),分别有其对应的文字内容和颜色。文字内容模板和颜色不支持变更。

状态 文字内容 颜色 允许转移的状态
0 "成员正在加入,当前 {member_count}/{room_limit} 人" #FA9D39 0, 1
1 "已开始" #CCCCCC

活动的默认有效期是 24 小时。活动结束后,消息内容会变成统一的样式:

  • 文字内容:“已结束”
  • 文字颜色:#00ff00

# 调用示例

示例说明: HTTPS调用

# 请求数据示例


{
"activity_id": "966_NGiqxxxxxxxxxx...xxxxxxxxE33BlwX", 
"target_state": 0, 
"template_info": {
"parameter_list": [
{"name": "member_count", 
"value": "2"}, 
{"name":"room_limit", 
"value": "5"} 
] 
} 
} 

# 返回数据示例


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

# 错误码

错误码 错误码取值 解决方案
40001 invalid credential  access_token isinvalid or not latest 获取 access_token 时 AppSecret 错误,或者 access_token 无效。请开发者认真比对 AppSecret 的正确性,或查看是否正在为恰当的公众号调用接口
42001 access_token expired access_token 超时,请检查 access_token 的有效期,请参考基础支持 - 获取 access_token 中,对 access_token 的详细机制说明
44002 empty post data POST 的数据包为空
47001 data format error 解析 JSON/XML 内容错误;post 数据中参数缺失;检查修正后重试。
47501 activity_id error 参数 activity_id 错误
47502 target_state error 参数 target_state 错误
47503 version_type error 参数 version_type 错误,调整后重试
47504 activity_id expired time activity_id 过期