获取群聊成员列表
获取群聊成员列表
请求说明
| 请求地址 | 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 |
| status | string | 是 | 成员状态 normal：正常状态；resigned：已离职；banned：已被禁言 |
| 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 | 响应数据 |
| ∟ items | array[object] | 获取群聊成员列表 |
| ∟ ∟ group_ext_attrs | object | 群聊成员扩展字段，当会话类型为群聊 group 时，该字段才有值 |
| ∟ ∟ ∟ role | string[enum] | 成员角色 normal：普通成员；admin：管理员；owner：拥有者，即群主 |
| ∟ ∟ ∟ status | string[enum] | 成员状态 normal：正常状态；resigned：已离职；banned：已被禁言 |
| ∟ ∟ identity | object | 用户 id，返回用户 id 和企业 id |
| ∟ ∟ ∟ avatar | string | 用户头像 |
| ∟ ∟ ∟ company_id | string | 企业 id |
| ∟ ∟ ∟ id | string | 用户 id |
| ∟ ∟ ∟ name | string | 用户名称 |
| ∟ ∟ ∟ type | string[enum] | 身份类型 user：用户；sp：服务主体 |
| ∟ next_page_token | string | 下一页 token |
| more | object | 更多的错误信息 |
响应体示例
json
{
"code": 0,
"data": {
"items": [
{
"group_ext_attrs": {
"role": "string[enum]",
"status": "string[enum]"
},
"identity": {
"avatar": "string",
"company_id": "string",
"id": "string",
"name": "string",
"type": "string[enum]"
}
}
],
"next_page_token": "string"
},
"msg": "string"
}