Skip to content
开发文档
能力中心
应用市场
WebOffice
开发者后台

更新会话信息

更新群信息,支持更新名称、头像、设置

请求说明

请求地址https://openapi.wps.cn/v7/chats/{chat_id}/update
请求方法POST
签名方式KSO-1
权限要求查询和管理会话(应用授权) kso.chat.readwrite

请求头(Header)

Header 名称参数类型是否必填说明
Content-Typestring使用:application/json
X-Kso-DatestringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-AuthorizationstringKSO-1 签名值,详见《签名方法》
Authorizationstring授权凭证,格式为:Bearer {access_token}

路径参数(Path)

名称参数类型说明
chat_idstring会话 id

请求体(Body)

名称参数类型是否必填说明
avatarstring群聊头像存储 key
is_disable_all_sendboolean是否开启【全员禁言】
is_enable_nicknameboolean是否开启【群昵称优先展示】
is_join_approveboolean是否开启【群主所属企业的人员进群需审核】
is_owner_admin_modifyboolean是否开启【仅群主和管理员可修改群信息】
namestring会话名称
owner_idstring新群主 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"
}

响应体

名称参数类型说明
codeinteger响应代码。非 0 表示失败,参照《状态码说明》
msgstring响应信息
moreobject更多的错误信息

响应体示例

json
{
  "code": 0,
  "msg": "string"
}
回到旧版