更新会话信息
更新群信息,支持更新名称、头像、设置
请求说明
请求地址 | https://openapi.wps.cn/v7/chats/{chat_id}/update |
---|---|
请求方法 | POST |
签名方式 | KSO-1 |
权限要求 | 查询和管理会话(应用授权) kso.chat.readwrite |
请求头(Header)
Header 名称 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
Content-Type | string | 是 | 使用:application/json |
X-Kso-Date | string | 是 | RFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT |
X-Kso-Authorization | string | 是 | KSO-1 签名值,详见《签名方法》 |
Authorization | string | 是 | 授权凭证,格式为:Bearer {access_token} |
路径参数(Path)
名称 | 参数类型 | 说明 |
---|---|---|
chat_id | string | 会话 id |
请求体(Body)
名称 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
avatar | string | 否 | 群聊头像存储 key |
is_disable_all_send | boolean | 否 | 是否开启【全员禁言】 |
is_enable_nickname | boolean | 否 | 是否开启【群昵称优先展示】 |
is_join_approve | boolean | 否 | 是否开启【群主所属企业的人员进群需审核】 |
is_owner_admin_modify | boolean | 否 | 是否开启【仅群主和管理员可修改群信息】 |
name | string | 否 | 会话名称 |
owner_id | string | 否 | 新群主 id |
请求地址示例
[POST] https://openapi.wps.cn/v7/chats/{chat_id}/update
请求体示例
json
{
"avatar": "string",
"is_disable_all_send": false,
"is_enable_nickname": false,
"is_join_approve": false,
"is_owner_admin_modify": false,
"name": "string",
"owner_id": "string"
}
响应体
名称 | 参数类型 | 说明 |
---|---|---|
code | integer | 响应代码。非 0 表示失败,参照《状态码说明》 |
msg | string | 响应信息 |
more | object | 更多的错误信息 |
响应体示例
json
{
"code": 0,
"msg": "string"
}