Skip to content

获取群聊成员列表

获取群聊成员列表

请求说明

请求地址https://openapi.wps.cn/v7/chats/{chat_id}/members
请求方法GET
签名方式KSO-1
权限要求查询和管理会话(应用授权) kso.chat.readwrite
查询会话(应用授权) kso.chat.read

请求头(Header)

Header 名称参数类型是否必填说明
Content-Typestring使用:application/json
X-Kso-DatestringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-AuthorizationstringKSO-1 签名值,详见《签名方法》
Authorizationstring授权凭证,格式为:Bearer {access_token}

路径参数(Path)

名称参数类型说明
chat_idstring会话 id

查询参数(Query)

名称参数类型是否必填说明
page_sizeinteger分页大小
page_tokenstring分页 token
typestring成员类型,默认值为用户
user:用户;sp:服务主体

请求地址示例

[GET] https://openapi.wps.cn/v7/chats/{chat_id}/members?page_size={integer}&page_token={string}&status={string}&type={string}

响应体

名称参数类型说明
codeinteger响应代码。非 0 表示失败,参照《状态码说明》
msgstring响应信息
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"
  }
}