设置会话所属标签
设置会话所属标签
将一个或多个会话添加到指定标签下,实现会话的标签化分组管理。单个会话可以同时属于多个标签,每个标签下最多可以添加 1000 个会话。
提示
- 设置会话所属标签前,需要先通过设置用户会话标签完成用户会话标签设置
- 每个标签下最多可以添加 1000 个会话,超出限制时最早添加的会话会被自动移除标签
- 单次操作最多支持 100 个会话
- 支持的会话类型:
1
(二人会话)、3
(群组会话)、6
(系统会话)
请求方法
POST: https://数据中心域名/tag/conversation/set.json
频率限制: 每秒 100 次
签名规则: 所有服务端 API 请求均需要进行签名验证,详见 API 请求签名。
正文参数
HTTP 请求正文数据格式为 application/json
,支持以下参数:
参数 | 类型 | 必传 | 说明 |
---|---|---|---|
userId | String | 是 | 会话所属的用户 ID。 |
tagId | String | 是 | 标签 ID。 注:您需确保该标签已存在,可通过获取用户标签列表查看。若不存在,则可通过创建用户标签创建。 |
conversations | Object[] | 是 | 会话列表。单次最多支持 100 个。 |
conversations[].targetId | String | 是 | 目标 ID。根据会话类型的不同,该字段为单聊用户 ID、群组 ID 或系统目标 ID。 |
conversations[].conversationType | int | 是 | 会话类型。支持的会话类型包括:1 (二人会话)、3 (群组会话)、6 (系统会话)。 |
请求示例
HTTP
POST /tag/conversation/set.json
Host: api.rong-api.com
App-Key: xxxxxx
Nonce: 14314
Timestamp: 111111111111
Signature: xxxxxxxxxxxxxxxxxxxxxxx
Content-Type: application/json
{
"userId":"testUserId",
"tagId":"tag1",
"conversations":[
{
"targetId":"user1",
"conversationType": 1
},
{
"targetId":"group1",
"conversationType": 3
}
]
}
返回结果
HTTP 响应正文包含具有以下结构的 JSON 对象:
返回值 | 返回类型 | 说明 |
---|---|---|
code | Number | 返回码。200 表示成功。详见服务端 API 状态码。 |
返回结果示例
HTTP
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{"code":200}