获取客户群成员列表
企业可通过此接口获取客户群成员列表,也可通过指定chat_id获取指定客户群成员列表
请求方式: GET(HTTPS)
请求地址: https://open.wshoto.com/openapi/chat/group/member/list
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 调用接口凭证 |
chat_id | string | 是 | 群聊id |
current_index | int | 否 | 页码。默认值为1 |
page_size | int | 否 | 列表返回长度。默认值为20,最大值为100 |
返回值:
{
"code": 0,
"msg": "请求成功",
"data": {
"total": 2,
"records": [
{
"userid": "wmJYSuBgAAFXR9UdLD_YJhs2657hRedQ",
"type": 2,
"join_time": 1608269181797,
"join_scene": 3,
"user_chat_nick_name": "acv",
"invitor": "acv"
},
{
"userid": "wmJYSuBgAAr_1ipy4BmyaAaJm8E37QHA",
"type": 2,
"join_time": 1608269181797,
"join_scene": 3,
"user_chat_nick_name": "acv",
"invitor": "acv"
}
]
}
}
返回说明:
参数 | 类型 | 说明 |
---|---|---|
code | int | 出错返回码,为0表示成功,非0表示调用失败 |
msg | string | 返回码描述 |
data | object | 分页对象 |
total | int | 总记录数 |
records | Chat[] | 记录列表 |
userid | string | 群成员id |
type | int | 成员类型。 1 - 企业成员 2 - 外部联系人 |
join_time | long | 进群时间 |
join_scene | int | 入群方式。 1 - 由成员邀请入群(直接邀请入群) 2 - 由成员邀请入群(通过邀请链接入群) 3 - 通过扫描群二维码入群 |
user_chat_nick_name | string | 员工群内昵称 |
invitor | string | 邀请人 |