分页获取群成员列表

功能说明

• 可以分页获取群组成员列表。
• 群组角色包含群主、群管理员和普通群成员，三个角色权限范围依次递减。
  • 群主拥有群的所有权限；
  • 群管理员拥有管理黑名单、白名单和禁言等权限；
  • 群主加管理员数量共 100 个，即管理员最多可添加 99 个。

调用频率上限

100 次/秒/App Key

请求 URL

GET https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/users?pagenum={N}&pagesize={N}&joined_time={true/false}

参数	类型	是否必需	描述
group_id	Int	是	群组 ID。
pagenum	Int	否	当前页码。默认从第 1 页开始获取。
pagesize	Int	否	每页期望返回的群组成员数量。取值范围为 [1,1000]。默认为 1000。若传入的值大于 1000，则获取 1000 个群组成员。
joined_time	Bool	否	是否需返回用户加入群组的时间： - true：返回 - （默认）false：不返回

关于请求 URL 中的其他参数说明，详见 请求 URL 参数介绍。

请求示例

# 将 <YourAppToken> 替换为你在服务端生成的 App Token

curl -X GET HTTP://XXXX/XXXX/XXXX/chatgroups/10XXXX85/users?pagesize=1000&pagenum=1&joined_time=true'  \
-H 'Authorization: Bearer <YourAppToken>'

请求 header 参数

关于 Authorization 字段的说明，详见 请求 header 参数说明。

响应示例

{
  "action": "get",
  "application": "cc7380d5-XXXX-XXXX-a93e-51d6d590b475",
  "params": {
    "joined_time": [
        "true"
    ],
    "pagesize": ["2"],
    "pagenum": ["2"]
  },
  "uri": "https://XXXX/XXXX/XXXX/chatgroups/10XXXX85/users",
  "entities": [],
  "data": [
    {
          "owner": "user1",
          "joined_time": 1732524850107
    },
    {
          "member": "user2",
          "joined_time": 173252433456
    }
  ],
  "timestamp": 1489074511416,
  "duration": 0,
  "organization": "XXXX",
  "applicationName": "testapp",
  "count": 2
}

响应 body 字段

如果返回的 HTTP 状态码为 200，表示请求成功，响应包体中 data 字段的说明如下：

字段	类型	描述
data	JSON Array	群组成员信息。
- owner	String	群主的用户 ID。例如：{"owner": "user1"}。
- member	String	群组管理员和普通成员的用户 ID。例如：{"member": "user3"}。
- joined_time	String	加入群组的时间。

其他字段的说明如下：

字段	类型	描述
action	String	请求方法。
application	String	应用在系统内的唯一标识。该标识由系统生成，开发者无需关心。
params	JSON	查询参数。
- joined_time	Bool	是否返回用户加入群组的时间： - true：返回 - false：不返回
- pagesize	Array	每页期望显示的群组成员数量。
- pagenum	Array	当前页码。
uri	String	请求 URL。
entities	JSON	响应实体。
timestamp	Long	HTTP 响应的 Unix 时间戳，单位为毫秒。
duration	Long	从发送 HTTP 请求到响应的时长，单位为毫秒。
organization	String	环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 org_name 相同。
applicationName	String	你在环信控制台创建应用时填入的应用名称，与请求参数 app_name 相同。
count	Int	本次调用实际获取的群成员数量。

如果返回的 HTTP 状态码非 200，表示请求失败。你可以参考 错误码 了解可能的原因。

错误码

如果返回的 HTTP 状态码非 200，表示请求失败，可能提示以下错误码：

HTTP 状态码	错误类型	错误提示	可能原因	处理建议
401	unauthorized	Unable to authenticate (OAuth)	token 不合法，可能过期或 token 错误。	使用新的 token 访问。
404	service_resource_not_found	do not find this group:XX	群组不存在。	使用合法的群 ID。

关于其他错误，你可以参考 响应状态码 了解可能的原因。