本文内容

获取群聊列表

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

请求说明

请求地址 https://openapi.wps.cn/kopen/woa/api/v2/developer/app/chats
请求方法 GET
签名方式 wps-3,签名URL:/kopen/woa/api/v2/developer/app/chats
支持应用类型 企业自建应用、第三方企业应用
权限要求 群聊管理(xz_chat_mgr)

请求头

Header 名称 是否必填 说明
Content-Type 目前固定为:"application/json"
Content-Md5 当 HTTP 请求的 Body 有数据时,计算 Body 的 MD5 值,否则计算空字符串的 MD5 值。再将 MD5 值转为十六进制字符串形式。即:Format("%x", md5Byte)
Date RFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT
X-Auth X-Auth 计算方法参考签名说明

查询参数(Query)

名称 类型 是否必填 说明
company_token string 企业授权凭证
page integer 页码,默认 1
count integer 每次获取数量,默认值和最大值都为 200

请求地址示例

[GET] https://openapi.wps.cn/kopen/woa/api/v2/developer/app/chats?company_token=COMPANY_TOKEN&page=1&count=100

响应体

名称 类型 说明
result integer 状态码,非 0 表示失败,参照《状态码说明》
chats array 群聊信息
 ∟ chat_id integer 群聊 id
 ∟ name string 群聊名称
total integer 总群聊数

响应体示例

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