Skip to content

更新群信息

适用版本>=v7.0.2505a.20250515

接口说明:更新群信息

请求说明

请求地址配置域名+/openapi+/v7/chats/{chat_id}/update
请求方法POST
签名方式KSO-1(配置域名+/openapi不参与签名)
权限要求查询和管理会话(应用授权)kso.chat.readwrite

请求头(Header)

Header参数类型是否必填说明
X-Kso-DatestringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-AuthorizationstringKSO-1 签名值,详见《签名方法》
Authorizationstring授权凭证,格式为:Bearer {access_token}
X-Kso-Id-TypestringID 类型,可选值为 internalexternal,不传默认为internal。当值为 external 时,开启三方 ID 模式,此时接口请求和响应中的 user_id 和 dept_id 应为三方ID,即 ex_user_id 和 ex_dept_id

路径参数(Path)

名称类型说明
chat_idstring会话id

请求体(Body)

名称类型是否必填说明
avatarstring会话头像
is_enable_history_messagesbool新入群成员是否可查看历史消息
is_enable_nicknamebool群昵称是否优先展示
is_join_approvebool进群是否需要审核
is_owner_admin_add_bookmarkbool是否仅群主和管理员可添加群书签
is_owner_admin_modifybool是否仅群主和管理员修改群属性
is_disable_all_sendbool是否开启全员禁言
namestring会话名称
owner_idstring新群主id

请求体示例

json
{
  "avatar": "string",
  "is_enable_history_messages": false,
  "is_enable_nickname": false,
  "is_join_approve": false,
  "is_owner_admin_add_bookmark": false,
  "is_owner_admin_modify": false,
  "is_disable_all_send": false,
  "name": "string",
  "owner_id": "string"
}

响应体(Response)

名称类型说明
codeintegercode
msgstringmsg
dataobjectdata

响应体示例

json
{
  "msg": "success",
  "code": "200"
}