updatableMessage.setUpdatableMsg

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

本接口支持 云开发 。需开发者工具版本 >= 1.02.1904090（最新稳定版下载），wx-server-sdk >= 0.4.0

服务器端调用

POST message/wxopen/updatablemsg/send?access_token=(ACCESS_TOKEN)
Synopsis

修改被分享的动态消息。详见 动态消息 。

Mimetype

application/json

Query Parameters

  • access_token/cloudbase_access_token (string) – 必选 接口调用凭证

Request JSON Object

  • activity_id (string) – 必选 动态消息的 ID，通过 updatableMessage.createActivityId 接口获取

  • target_state (number) – 必选 动态消息修改后的状态: 0 未开始 1 已开始

  • template_info (Object) –

    必选 动态消息对应的模板信息

    • parameter_list (Array.<Object>) 必选 模板中需要修改的参数

      • name (string) 必选 要修改的参数名

        • 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（正式版）

      • value (string) 是 修改后的参数值

Response JSON Object

  • errcode (number) –

    错误码

    • 0 请求成功

    • -1 系统繁忙。此时请开发者稍候再试

    • 42001 access_token 过期

    • 44002 post 数据为空

    • 47001 post 数据中参数缺失

    • 47501 参数 activity_id 错误

    • 47502 参数 target_state 错误

    • 47503 参数 version_type 错误

    • 47504 activity_id 过期

  • errmsg (string) – 错误信息

请求示例
 1POST message/wxopen/updatablemsg/send HTTP/1.1
 2Host: https://api.weixin.qq.com/cgi-bin/
 3Accept: application/json, text/javascript
 4{
 5  "activity_id": "966_NGiqxxxxxxxxx...xxxxxxxxE33BlwX",
 6  "target_state": 0,
 7  "template_info": {
 8    "parameter_list": [
 9      {
10        "name": "member_count",
11        "value": "2"
12      },
13      {
14        "name":"room_limit",
15        "value": "5"
16      }
17    ]
18  }
19}

消息状态

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

状态

文字内容

颜色 允

许转移的状态

0

“成员正在加入，当前 {member_count}/{room_limit} 人”

#FA9D39

0, 1

1

“已开始”

#CCCCCC

无

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

  • 文字内容：“已结束”

  • 文字颜色：#00ff00

云调用

openapi.updatableMessage.setUpdatableMsg({activityId, targetState, templateInfo})

云调用是微信云开发提供的在云函数中调用微信开放接口的能力，需要在云函数中通过 wx-server-sdk 使用。

:: 需在 config.json 中配置 updatableMessage.setUpdatableMsg API 的权限，详情

参数

  • activityId (string()) – 是 动态消息的 ID，通过 updatableMessage.createActivityId 接口获取

  • targetState (number()) – 是 动态消息修改后的状态（具体含义见后文）: 0 未开始 1 已开始

  • templateInfo (Object()) –

    是 动态消息对应的模板信息

    • parameterList Array.<Object> 是 模板中需要修改的参数

      • name string 是 要修改的参数名

        • 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（正式版）

      • value string 是 修改后的参数值

返回

  • errCode (number): 错误码 0 成功

  • errMsg (string): 错误信息

抛出

{errCode,errMsg}() –

  • errCode (number): 错误码

  • errMsg (string): 错误信息

    • -1 系统繁忙。此时请开发者稍候再试

    • 42001 access_token 过期

    • 44002 post 数据为空

    • 47001 post 数据中参数缺失

    • 47501 参数 activity_id 错误

    • 47502 参数 target_state 错误

    • 47503 参数 version_type 错误

    • 47504 activity_id 过期