在线调试
更新会话分组
更新时间: 2024/07/17 16:57:14
功能描述
该接口用于更新指定的会话分组。
- 更新会话分组名称。
- 更新会话分组的扩展信息。
- 在分组中添加会话,每次最多添加 100 个会话。
- 在分组中删除会话,每次最多删除 100 个会话。
调用频率
单个应用默认最高调用频率请参考 频控说明。
请求
URL
PATCH https://open.yunxinapi.com/im/v2/conversation_groups/:{group_id}
Header
请求 Header 的参数说明请参见请求 Header。
路径参数
参数名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
group_id |
Long | 必选 | 会话分组 ID。 |
请求体参数
参数名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
account_id |
String | 必选 | 云信账号 ID。 |
name |
String | 可选 | 更新后的会话分组名称。 |
server_extension |
String | 可选 | 更新后的会话分组扩展字段。 |
+
conversations |
Object | 可选 | 会话列表。 |
请求体示例
json{
"account_id": "Accid1",
"name": "name",
"server_extension": "extension",
"conversations": {
"type": 1,
"conversation_ids": [
"Accid1|1|Accid2",
"Accid1|2|tid",
"Accid1|3|tid"
]
}
}
响应
Header
响应 Header 的参数说明请参见响应 Header。
响应体参数
参数名称 | 类型 | 描述 | 是否必返回 |
---|---|---|---|
code |
Integer | 状态码,200 表示请求成功。 | 是 |
msg |
String | 提示信息。请求失败时返回错误信息,请求成功时返回 "success"。 | 是 |
+
data |
Object | 返回的 JSON 数据对象,请求失败则返回空对象。 | 是 |
响应体示例
json{
"code": 200,
"msg": "success",
"data": {
"conversation_group": {
"name": "name",
"group_id": 1,
"server_extension": "extension",
"create_time": 1,
"update_time": 1
},
"success_list": [
"Accid1|1|Accid2",
"Accid1|2|tid",
"Accid1|3|tid"
],
"failed_list": [
{
"conversation_id": "Accid1|1|Accid2",
"error_code": 102404,
"error_msg": "error"
}
]
}
}
错误码
错误码 | 错误码描述 | 错误信息示例 |
---|---|---|
200 | 请求成功 | success |
414 | 参数错误 | parameter error |
102404 | 用户不存在 | account not exist |
500 | 服务器内部错误 | internal server error |
此文档是否对你有帮助?