Skip to content

获取群聊列表

用于获取应用机器人所在群聊的群聊列表。

请求说明

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

请求头

名称是否必填说明
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值

查询参数(Query)

名称类型是否必填说明
pageinteger页码,默认 1
countinteger每次获取数量,默认值和最大值都为 200

请求地址示例

http
[GET] 配置域名+/o/woa/api/v2/developer/app/chats?page=1&count=100

响应体

名称类型说明
resultinteger状态码,非 0 表示失败,参照《状态码说明》
chatsarray群聊信息
 ∟ chat_idinteger群聊id
 ∟ namestring群聊名称
totalinteger总群聊数

响应体示例

json
{
  "chats": [
    {
      "chat_id": 10010, // 群聊id
      "name": "群聊1" // 群聊名称
    }
  ],
  "total": 50, // 总群聊数
  "result": 0 // 状态码
}