获取群聊成员列表
获取群聊成员列表
请求说明
| 请求地址 | https://openapi.wps.cn/v7/chats/{chat_id}/members |
|---|---|
| 请求方法 | GET |
| 签名方式 | KSO-1 |
| 权限要求 | 查询和管理会话(应用授权) kso.chat.readwrite查询会话(应用授权) kso.chat.read |
请求头(Header)
| Header 名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| Content-Type | string | 是 | 使用:application/json |
| X-Kso-Date | string | 是 | RFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT |
| X-Kso-Authorization | string | 是 | KSO-1 签名值,详见《签名方法》 |
| Authorization | string | 是 | 授权凭证,格式为:Bearer {access_token} |
路径参数(Path)
| 名称 | 参数类型 | 说明 |
|---|---|---|
| chat_id | string | 会话 id |
查询参数(Query)
| 名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| page_size | integer | 是 | 分页大小 |
| page_token | string | 否 | 分页 token |
| type | string | 否 | 成员类型,默认值为用户 user:用户;sp:服务主体 |
请求地址示例
[GET] https://openapi.wps.cn/v7/chats/{chat_id}/members?page_size={integer}&page_token={string}&status={string}&type={string}响应体
| 名称 | 参数类型 | 说明 |
|---|---|---|
| code | integer | 响应代码。非 0 表示失败,参照《状态码说明》 |
| msg | string | 响应信息 |
| data | object | data |
| ∟ items | object | 邀请失败的成员信息 |
| ∟ ∟ identity | array | 加入会话的机器人或用户列表 |
| ∟ ∟ ∟ app_id | string | 应用id,type为sp时有值 |
| ∟ ∟ ∟ company_id | string | 公司id |
| ∟ ∟ ∟ type | string | sp:机器人,user:用户 |
| ∟ ∟ ∟ id | string | type为user为用户id,type为sp为spid |
| ∟ next_page_token | string | 分页token |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"items": [
{
"identity": {
"app_id": "string",
"company_id": "string",
"type": "user",
"id": "string"
}
}
],
"next_page_token": "string"
}
}