资源工坊

获取群聊成员 ​

用于获取应用机器人所在群聊的成员信息。

请求说明 ​

请求地址配置域名+/o/woa/api/v1/developer/app/chats/{id}/members
请求方法GET
签名方式wps-4
支持应用类型企业自建应用、第三方企业应用
权限要求管理会话及会话成员信息(kso.im.chat.manage)

请求头 ​

名称是否必填说明
Content-Type是固定为: application/json
Wps-Docs-Date是取当前时间, 示例: Wed, 23 Jan 2013 06:43:08 GMT
Wps-Docs-Authorization是计算方法参考签名说明
Authorization是授权token，格式：Bearer ${access_token}，${access_token}需替换为从授权接口获取的access_token值

路径参数（Path） ​

名称类型是否必填说明
idinteger是群聊会话 id

查询参数（Query） ​

名称类型是否必填说明
offsetinteger是下标
limitinteger是数量,最多 100 条
stateinteger否状态(-1：全部，0：正常，2：禁言)默认-1

请求地址示例 ​

http
[GET] 配置域名+/o/woa/api/v1/developer/app/chats/{id}/members?offset=5&limit=50&state=-1

响应体 ​

名称类型说明
resultinteger状态码，非 0 表示失败，参照《状态码说明》
membersarray群聊成员信息
 ∟ useridinteger成员id
 ∟ roleinteger成员角色：0-普通用户、1-群主、10-管理员
 ∟ ctimeinteger成员加入群聊的时间
 ∟ stateinteger成员状态，：0-正常、2-禁言
next_offsetinteger下一页的offset，-1表示没有下一页

响应体示例 ​

json
{
    "result": 0,
    "members": [
      {
        "userid": a234sdf,//群聊成员id
        "role": 0,        //0普通用户,1群主,10管理员
        "ctime": 123,
        "state": 0        //0正常,2禁言
      },
    ],
  "next_offset": -1
}