Skip to content

获取群聊成员列表

适用版本>=v7.0.2505a.20250515

接口说明:获取群聊成员列表

使用说明

  • 应用需在群内
  • 可获取用户成员和群应用机器人,不包含群值班机器人和自定义机器人

请求说明

请求地址配置域名+/openapi+v7/chats/{chat_id}/members
请求方法GET
签名方式KSO-1(配置域名+/openapi不参与签名)
权限要求查询会话(应用授权)kso.chat.read
查询和管理会话(应用授权)kso.chat.readwrite

请求头(Header)

Header参数类型是否必填说明
X-Kso-DatestringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-AuthorizationstringKSO-1 签名值,详见《签名方法》
Authorizationstring授权凭证,格式为:Bearer {access_token}
X-Kso-Id-TypestringID 类型,可选值为 internalexternal,不传默认为internal。当值为 external 时,开启三方 ID 模式,此时接口请求和响应中的 user_id 和 dept_id 应为三方ID,即 ex_user_id 和 ex_dept_id

查询参数(Query)

名称参数类型是否必填说明
page_sizeint分页大小
page_tokenstring分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回next_page_token作为新的page_token,下次遍历可采用该page_token获取查询结果;当查询结果中next_page_token为空或无该返回值时,代表无下一页。
typestringuser:用户 "app":应用

响应体(Response)

名称类型说明
codeintegercode
msgstringmsg
dataobjectdata
itemsobject邀请失败的成员信息
identityarray加入会话的机器人或用户列表
app_idstring应用id,type为sp时有值
company_idstring公司id
typestringsp:机器人,user:用户
idstringtype为user为用户id,type为sp为spid
next_page_tokenstring分页token

响应体示例

json
{
  "code": 0,
  "msg": "success",
  "data": {
    "items": [
      {
        "identity": {
            "app_id": "string",
            "company_id": "string",
            "type": "user",
            "id": "string"
          }
      }
    ],
    "next_page_token": "string"
  }
}