# 修改小程序聊天工具的动态卡片消息

[调试诊断](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_tools)

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：setChatToolMsg

该接口用于修改被分享的小程序聊天工具的动态卡片消息。

## 1. 调用方式

### HTTPS 调用

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

### 云调用

- 调用方法：chattoolmsg.send

- 出入参和 HTTPS 调用相同，调用方式可查看 [云调用](/doc/oplatform/developers/dev/cloudCall.md) 说明文档。

### 第三方调用

- 本接口不支持第三方平台调用。

## 2. 请求参数

### 查询参数 `Query String Parameters`

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "示例": "ACCESS_TOKEN",
    "说明": "接口调用凭证，可使用 [access_token](/miniprogram/dev/server/API/mp-access-token/api_getaccesstoken)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "activity_id",
    "类型": "string",
    "必填": "是",
    "说明": "动态消息的 ID，通过 [createActivityId](api_createactivityid) 接口获取"
  },
  {
    "参数名": "target_state",
    "类型": "number",
    "必填": "是",
    "说明": "动态消息修改后的状态"
  },
  {
    "参数名": "template_id",
    "类型": "string",
    "必填": "是",
    "说明": "模板id"
  },
  {
    "参数名": "participator_info_list",
    "类型": "objarray",
    "必填": "否",
    "说明": "更新后的聊天室成员状态"
  },
  {
    "参数名": "version_type",
    "类型": "number",
    "必填": "是",
    "说明": "0 正式版\n1 开发版\n2 体验版"
  }
]
```

">

### Body.participator_info_list(Array) `Object Payload`

更新后的聊天室成员状态

```json
[
  {
    "参数名": "group_openid",
    "类型": "string",
    "必填": "是",
    "说明": "聊天室用户的GroupOpenID，仅允许传入动态卡片所在聊天室内的GroupOpenID"
  },
  {
    "参数名": "state",
    "类型": "number",
    "必填": "是",
    "说明": "用户对卡片事件的完成状态。0：未完成（初始状态），1：已完成。目前只支持设置为 1"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误信息"
  }
]
```

## 4. 注意事项

本接口无特殊注意事项

## 5. 代码示例

请求示例

```json
{
"activity_id": "966_NGiqxxxxxxxxxx...xxxxxxxxE33BlwX", 
"target_state": 1, 
"template_id": "4A68CBB88A92B0A9311848DBA1E94A199B166463",
"version_type": 0,
"participator_info_list": [
{"group_openid": "aaaaaaaaaa", 
"state": 1}, 
{"group_openid": "bbbbbbbbb", 
"state": 1}, 
] 
}
```

返回示例

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

## 6. 错误码

以下是本接口的错误码列表，其他错误码可参考 [通用错误码](/doc/oplatform/developers/errCode/README.md)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

```json
[
  {
    "错误码": "40001",
    "错误描述": "invalid credential  access_token isinvalid or not latest",
    "解决方案": "获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口"
  },
  {
    "错误码": "40013",
    "错误描述": "appid不正确，或者不符合绑定关系要求",
    "解决方案": ""
  },
  {
    "错误码": "40097",
    "错误描述": "invalid args",
    "解决方案": "参数错误"
  },
  {
    "错误码": "42001",
    "错误描述": "access_token expired",
    "解决方案": "access_token 超时，请检查 access_token 的有效期，请参考基础支持 - 获取 access_token 中，对 access_token 的详细机制说明"
  },
  {
    "错误码": "44002",
    "错误描述": "empty post data",
    "解决方案": "POST 的数据包为空。post请求body参数不能为空。"
  },
  {
    "错误码": "47001",
    "错误描述": "data format error",
    "解决方案": "解析 JSON/XML 内容错误;post 数据中参数缺失;参数需以 JSON 字符串格式写在post请求的 body 中，请检查修正后重试"
  },
  {
    "错误码": "47501",
    "错误描述": "activity_id error",
    "解决方案": "参数 activity_id 错误"
  },
  {
    "错误码": "47502",
    "错误描述": "target_state error",
    "解决方案": "参数 target_state 错误"
  },
  {
    "错误码": "47504",
    "错误描述": "activity_id expired time",
    "解决方案": "activity_id 过期"
  }
]
```

## 7. 适用范围

本接口在不同账号类型下的可调用情况：

```json
[
  {
    "小程序": "✔",
    "小游戏": "✔"
  }
]
```

- ✔：该账号可调用此接口。
- 其他未明确声明的账号类型，如无特殊说明，均不可调用此接口。