Skip to content

获取会话成员列表

适用版本>=v7.0.2411b.20241128

接口说明:获取会话成员列表

请求说明

请求地址配置域名+/openapi+/v7/audit/chats/{chat_id}/members
请求方法GET
签名方式KSO-1(配置域名+/openapi不参与签名)
权限要求查询审计会话(应用授权) kso.chat_audit.read
读写审计会话(应用授权) kso.chat_audit.readwrite

请求头(Header)

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

路径参数(Query)

名称类型是否必填说明
chat_idint64会话Id

查询参数(Query)

名称类型是否必填说明
page_sizeint64分页大小 大于0 小于等于100
page_tokenstring翻页token

响应体(Response)

名称类型说明
codeintegercode
msgstringmsg
dataobjectnull
itemsarray[object]
chat_idstring会话ID
idstring成员ID
identitystring成员身份结构
avatarstring用户头像
company_idstring用户所在企业
idstring用户Id
namestring名称
typestring用户(user) 服务商(sp)
ctimeinteger创建时间
ext_attrsarray[object]拓展属性
namestring拓展属性名称
valuestring拓展属性值
group_ext_attrsstring群聊成员扩展属性
rolestring成员角色,普通成员:normal,管理员:admin,群主:owner
statusstring成员状态:正常状态:normal,已离职:resigned,已被禁言:banned
moreobject更多的错误信息

响应体示例

json
{
  "code": 0,
  "data": {
    "items": [
      {
        "ctime": 0,
        "ext_attrs": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "group_ext_attrs": {
          "avatar": {
            "avatars": ["string"],
            "type": "default"
          },
          "dept_id": "string",
          "owner_id": "string",
          "settings": {
            "is_disable_all_send": false,
            "is_disable_part_send": false,
            "is_enable_nickname": true,
            "is_external_join_approve": true,
            "is_join_approve": false,
            "is_owner_admin_at_all": false,
            "is_owner_admin_modify": false
          }
        },
        "id": "string",
        "chat_id": "string",
        "identity": {
          "avatar": "string",
          "company_id": "string",
          "id": "string",
          "name": "string",
          "type": "string"
        }
      }
    ],
    "next_page_token": "string"
  },
  "msg": "success"
}