更新会话
简要描述
- 多个用户对同一会话可选择性的设置字段。
请求方式
post
请求 URL
http://x.x.x.x:10002/conversation/set_conversations
Header
header名 | 示例值 | 选填 | 类型 | 说明 |
---|---|---|---|---|
operationID | 1646445464564 | 必填 | string | operationID用于全局链路追踪 |
token | eyJhbxxxx3Xs | 必填 | string | 管理员token |
请求参数示例
{
"userIDs": [
"1"
],
"conversation": {
"conversationID": "sg_xadxwr24",
"conversationType": 1,
"userID": "1",
"groupID": "xadxwr24",
"recvMsgOpt": 0,
"isPinned": false,
"isPrivateChat": true,
"ex": "",
"burnDuration": 30
}
}
Field Name | Optional | Type | Description |
---|---|---|---|
userIDs | Required | string[] | 要设置会话字段的用户ID列表 |
conversationID | Required | string | 会话ID |
conversationType | Required | int | 会话类型,单聊为1,群聊为3 |
userID | Optional | string | 会话类型为单聊时必填 |
groupID | Optional | string | 会话类型为群聊时必填 |
recvMsgOpt | Optional | int | 会话免打扰状态 |
isPinned | Optional | boolean | 会话是否置顶 |
isPrivateChat | Optional | boolean | 是否开启阅后即焚 |
ex | Optional | string | 会话扩展字段 |
burnDuration | Optional | string | 设置会话阅后即焚时间,单位秒 |
成功返回示例
{
"errCode": 0,
"errMsg": "",
"errDlt": ""
}
成功返回示例的参数说明
参数名 | 类型 | 说明 |
---|---|---|
errCode | int | 错误码,0表示成功 |
errMsg | string | 错误简要信息,无错误时为空 |
errDlt | errDlt | 错误详细信息,无错误时为空 |
失败返回示例
{
"errCode": 1001,
"errMsg": "ArgsError",
"errDlt": "userID is empty: 1001 ArgsError"
}
失败返回示例的参数说明
参数名 | 类型 | 说明 |
---|---|---|
errCode | int | 错误码,0表示成功 |
errMsg | string | 错误简要信息,无错误时为空 |
errDlt | errDlt | 错误详细信息,无错误时为空 |