Skip to content

更新群聊信息

用于更新应用机器人所在群聊的信息。

请求说明

请求地址配置域名+/o/woa/api/v1/developer/app/chats/
请求方法PUT
签名方式wps-4
支持应用类型企业自建应用、第三方企业应用
权限要求管理会话及会话成员信息(kso.im.chat.manage)

请求头

Header 名称是否必填说明
Content-Type目前固定为:application/json
Wps-Docs-Date取当前时间, 示例: Wed, 23 Jan 2013 06:43:08 GMT
Wps-Docs-Authorization计算方法参考签名说明
Authorization授权token,格式:Bearer ${access_token},${access_token}需替换为从授权接口获取的access_token值

路径参数(Path)

名称类型是否必填说明
chatidinteger群聊会话 id

请求体(Body)

名称类型是否必填说明
namestring群聊名称
ownerint群主 id(不支持机器人成为群主)
avatarstring群聊头像 store_key
join_approveboolean是否开启【群主所属企业的人员进群需审核】
change_info_constraintboolean是否开启【仅群主和管理员可修改群信息】
mention_all_disableboolean是否开启【仅群主和管理员可@所有人】
enable_nicknameboolean是否开启【群昵称优先展示】

请求地址示例

http
[PUT] 配置域名+/o/woa/api/v1/developer/app/chats/{chatid}

请求体示例

json
{
  "name": "string",
  "owner": 123,
  "join_approve": true,
  "change_info_constraint": true,
  "mention_all_disable": true,
  "enable_nickname": true,
  "avatar": "string"
}

响应体

名称类型说明
resultinteger状态码,非 0 表示失败,参照《状态码说明》

响应体示例

json
{
  "result": 0
}