多个用户对同一ID的会话设置字段
简要描述
- 多个用户对同一会话可选择性的设置字段。
请求方式
post
请求URL
{API_ADDRESS}/conversation/set_conversations
Header
| header名 | 示例值 | 选填 | 类型 | 说明 |
|---|---|---|---|---|
| operationID | 1646445464564 | 必填 | string | 用于全局链路追踪，建议使用时间戳，在每个请求中独立 |
| token | eyJhbxxxx3Xs | 必填 | string | 管理员 token |
请求参数示例
{
"userIDs": [
"6965946400"
],
"conversation": {
"conversationID": "si_4365007572_6965946400",
"conversationType": 1,
"userID": "4365007572",
"groupID": "",
"recvMsgOpt": 0,
"attachedInfo": "attached",
"isPinned": false,
"isPrivateChat": true,
"ex": "",
"burnDuration": 30
}
}
| 字段名 | 选填 | 类型 | 说明 |
|---|---|---|---|
| userIDs | 必填 | array | 要设置会话字段的用户ID列表 |
| userIDs | 必填 | array | 要设置会话字段的用户ID列表 |
| conversation | 必填 | object | 会话对象 |
| conversation.conversationID | 必填 | string | 会话ID |
| conversation.conversationType | 必填 | int | 会话类型，单聊为1，群聊为3 |
| conversation.userID | 选填 | string | 会话类型为单聊时必填 |
| conversation.groupID | 选填 | string | 会话类型为群聊时必填 |
| conversation.recvMsgOpt | 选填 | int | 会话免打扰状态 |
| conversation.attachedInfo | 选填 | string | 会话附加信息，预留字段 |
| conversation.isPinned | 选填 | boolean | 会话是否置顶 |
| conversation.isPrivateChat | 选填 | boolean | 是否开启阅后即焚 |
| conversation.ex | 选填 | string | 会话扩展字段 |
| conversation.burnDuration | 选填 | int | 设置会话阅后即焚时间，单位秒 |
成功返回示例
{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": null
}
成功返回示例的参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| errCode | int | 错误码，0表示成功 |
| errMsg | string | 错误简要信息，为空 |
| errDlt | errDlt | 错误详细信息，为空 |
| data | object | 通用数据对象，具体结构见下方 |
失败返回示例
{
"errCode": 1004,
"errMsg": "RecordNotFoundError",
"errDlt": ": [1004]RecordNotFoundError"
}
失败返回示例的参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| errCode | int | 错误码，具体查看全局错误码文档 |
| errMsg | string | 错误简要信息 |
| errDlt | errDlt | 错误详细信息 |