Skip to content

获取直播邀约用户列表

拥有此API的权限集
直播管理-查询

请求方式及url

  • 请求方式:POST
  • 请求头:Content-Type:application/json
  • 接口地址:https://api.xiaoe-tech.com/xe.alive.invite.user_list/1.0.0
  • 频率限制:10秒500次

接口调试

请求参数
响应结果
暂无响应数据

请求参数

参数名必选类型说明
access_tokenstring专属token
alive_idstring直播间ID
invite_idstring邀约计划id
pageint页码,表示第几页,从1开始;默认1
page_sizeint每页条数,最大100条;默认10

请求示例

 { 
     "access_token":"xe_xxxxx",
     "alive_id" : "xxxxxx", 
     "page" : 1,
     "page_size": 10
 }

返回参数说明

参数名类型说明
codeint错误码
msgstring错误描述
data.totalint查询结果记录数
data.listobject用户数据

用户数据list

参数名类型说明
wx_union_idstring用户的unionid
xiaoe_user_idstring小鹅通用户ID
alive_idstring直播id
is_invitedstring是否已邀约
external_user_idstring客户企微id
invite_timestring成功邀约时间
qw_user_idstring邀约的企微客服账号(员工企微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
   }
}