资源工坊

获取群聊信息 ​

用于获取应用机器人所在群聊的信息。

请求说明 ​

请求地址配置域名+/o/woa/api/v1/developer/app/chats/info/
请求方法GET
签名方式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） ​

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

请求地址示例 ​

http
[GET] 配置域名+/o/woa/api/v1/developer/app/chats/info/{id}

响应体 ​

名称类型说明
resultinteger状态码，非 0 表示失败，参照《状态码说明》
idinteger会话 id
namestring会话名称
ownerinteger群主 id（不支持机器人成为群主）
avatarobject群聊头像
 ∟ typestring头像类型。分两种情况：如果 type 返回值为空，则代表当前群聊为系统默认头像（由创建群聊时的群成员头像组合生成），故下面的 list 的字段即为群聊成员头像；如果 type 返回值为 custom，则代表自定义头像，list 内则只会有 1 条数据
 ∟ list[]string多个组合头像的地址
join_approveboolean是否开启【群主所属企业的人员进群需审核】
change_info_constraintboolean是否开启【仅群主和管理员可修改群信息】
mention_all_disableboolean是否开启【仅群主和管理员可@所有人】
enable_nicknameboolean是否开启【群昵称优先展示】

响应体示例 ​

json
{
  "result": 0,
  "id": 0,
  "name": "string",
  "owner": 123,
  "join_approve": true,
  "change_info_constraint": true,
  "mention_all_disable": true,
  "enable_nickname": true,
  "avatar": {
    "type": "string",
    "list": ["string"]
  }
}