获取客户群聊列表
企业可通过此接口获取客户群列表,也可以通过userid获取指定员工的群聊列表
请求方式: GET(HTTPS)
请求地址: https://open.wshoto.com/openapi/chat/group/list
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 调用接口凭证 |
userid | string | 否 | 企业成员的userid,userid不能与external_user_id同时传入 |
user_type | string | 否 | userid对应企业成员在群内的身份 0:群主 1: 群成员 默认值0 |
external_user_id | string | 否 | 群成员的外部联系人id,userid不能与external_user_id同时传入 |
chat_id | string | 否 | 群id |
current_index | int | 否 | 页码。默认值为1 |
page_size | int | 否 | 列表返回长度。默认值为20,最大值为100 |
返回值:
{
"code": 0,
"msg": "请求成功",
"data": {
"total": 4,
"records": [
{
"chat_id": "wrROPkDQAAgp7NDFK1CVMzS1w001V400",
"name": "群聊",
"owner": "SuShenMeiShengQileiGuanJia",
"notice": "禁止发广告",
"create_time": 1608269181797,
"count": 4,
"chat_administrator_user_ids": [
"zhangsan",
"lisi"
],
"chat_tag_infos": [
{
"chat_tag_id": "abc",
"chat_tag_name": "abcName"
},
{
"chat_tag_id": "abc1",
"chat_tag_name": "abc1Name"
}
]
},
{
"chat_id": "wmJYSuBgAAFyDEU2SLeCVZbblxaxzX4w",
"name": "群聊2",
"owner": "SuShenMeiShengQileiGuanJia",
"notice": "禁止发广告",
"create_time": 1608269181797,
"count": 1,
"chat_administrator_user_ids": [
"zhangsan1",
"lisi1"
],
"chat_tag_infos": [
{
"chat_tag_id": "abc",
"chat_tag_name": "abcName",
"chat_tag_group_id": "abc",
"chat_tag_group_name": "abcName"
}
]
}
]
}
}
返回说明:
参数 | 类型 | 说明 |
---|---|---|
code | int | 出错返回码,为0表示成功,非0表示调用失败 |
msg | string | 返回码描述 |
data | Page | 分页对象 |
total | int | 总量 |
records | Chat[] | 群聊列表 |
chat_id | string | 客户群ID |
name | string | 客户群名称 |
owner | string | 群主ID |
notice | string | 群公告 |
create_time | long | 群的创建时间 |
count | int | 群人数 |
chat_administrator_user_ids | array | 群管理员ID集合 |
chat_tag_infos | object[] | 群标签信息集合 |
chat_tag_id | string | 群标签ID |
chat_tag_name | string | 群标签名称 |
chat_tag_group_id | string | 群标签组ID |
chat_tag_group_name | string | 群标签组名称 |