获取直播邀约用户列表
| 拥有此API的权限集 |
|---|
| 直播管理-查询 |
请求方式及url
- 请求方式：
POST - 请求头：
Content-Type:application/json - 接口地址：
https://api.xiaoe-tech.com/xe.alive.invite.user_list/1.0.0 - 频率限制：
10秒500次
在线调试工具
请求
响应
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| access_token | 是 | string | 专属token |
| alive_id | 是 | string | 直播间ID |
| invite_id | 是 | string | 邀约计划id |
| page | 是 | int | 页码，表示第几页，从1开始；默认1 |
| page_size | 是 | int | 每页条数，最大100条；默认10 |
请求示例
{
"access_token":"xe_xxxxx",
"alive_id" : "xxxxxx",
"page" : 1,
"page_size": 10
}
返回参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | int | 错误码 |
| msg | string | 错误描述 |
| data.total | int | 查询结果记录数 |
| data.list | object | 用户数据 |
用户数据list
| 参数名 | 类型 | 说明 |
|---|---|---|
| wx_union_id | string | 用户的unionid |
| xiaoe_user_id | string | 小鹅通用户ID |
| alive_id | string | 直播id |
| is_invited | string | 是否已邀约 |
| external_user_id | string | 客户企微id |
| invite_time | string | 成功邀约时间 |
| qw_user_id | string | 邀约的企微客服账号（员工企微id） |
返回示例
{
"code": 0,
"msg": "操作成功",
"data": {
"list": [
{
"alive_id": "l_66xxx",
"external_user_id": "wotJxxxx",
"invite_id": "i_92xxx",
"invite_time": "",
"is_invited": 0,
"qw_user_id": "a2c4cxxx",
"unionid": "",
"xiaoe_user_id": ""
}
],
"page": 1,
"page_size": 10,
"total": 10
}
}