Appearance
更新群会话V3.1.0
基本信息
中文名: 更新群会话
接口名: /chat/group/update
所在目录: 消息
调用方式: POST(HTTPS)
发布版本: V3.1.0
请求参数
| 名称 | ** 类型** | ** 是否必填** | ** 示例值** | ** 描述** |
|---|---|---|---|---|
| showHistoryType | java.lang.Integer | 否 | 新成员可查看100条历史消息<br/>1:开启 ; 0:关闭 | |
| chatId | java.lang.String | 是 | 会话cid | |
| newOwnerAccountId | java.lang.Long | 否 | 新群管理员uid | |
| validationType | java.lang.Integer | 否 | 入群审核<br/>1:开启 ; 0:关闭 | |
| icon | java.lang.String | 否 | 新群头像 | |
| searchable | java.lang.Integer | 否 | 群是否可被公开搜索<br/>1:可被公开搜索 ; 0:不可被公开搜索 | |
| managementType | java.lang.Integer | 否 | 仅群管理员和子管理员可管理群<br/>1:开启 ; 0:关闭 | |
| accountId | java.lang.Long | 是 | 操作人uid,一般是群管理员 | |
| addUserIdList | java.util.List#java.lang.String | 否 | [“12345”, “12355”] | 待添加的用户id,<br/>1,最大100人<br/>2,要注意添加后是否超出群规模限制 |
| mentionAllAuthority | java.lang.Integer | 否 | 仅群管理员和子管理员可at所有人<br/>1:开启 ; 0:关闭 | |
| disableRead | java.lang.Integer | 否 | 已读回执设置(app上高亮的时候为0)<br/>1:已读回执功能关闭 ; 0:已读回执功能开启 | |
| tenantId | java.lang.Long | 是 | 租户id | |
| name | java.lang.String | 否 | 新群名称,仅支持文字和emoji。 | |
| silenceAll | java.lang.Integer | 否 | 群禁言<br/>1:开启群禁言 ; 0:关闭群禁言 | |
| delUserIdList | java.util.List#java.lang.String | 否 | [“12345”, “12355”] | 移除群成员uid列表,最大100人 |
返回参数
| 参数 | ** 子参数** | ** 类型** | ** 描述** |
|---|---|---|---|
| data | Map | 数据对象 | |
| updateDisableReadFlag | boolean | 设置已读回执结果的key<br/>true 表示变更成功,false 表示失败 | |
| updateManageTypeFlag | boolean | 更改管理类型结果的key<br/>true 表示变更成功,false 表示失败 | |
| addMembers | boolean | 添加群成员结果的key<br/>true 表示变更成功,false 表示失败 | |
| updateIcon | boolean | 更新群图标结果的key<br/>true 表示变更成功,false 表示失败 | |
| updateName | boolean | 更新群名称结果的key<br/>true 表示变更成功,false 表示失败 | |
| removeMembers | boolean | 移除群成员结果的key<br/>true 表示变更成功,false 表示失败 | |
| updateSilenceFlag | boolean | 更改禁言设置结果的key<br/>true 表示变更成功,false 表示失败 | |
| setNewOwner | boolean | 设置新群管理员结果的key<br/>true 表示变更成功,false 表示失败 | |
| responseMessage | String | 错误信息 | |
| responseCode | String | 错误码 | |
| success | boolean | 业务处理是否成功 |
