Appearance

获取直播间用户列表 ​

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

请求方式及url ​

  • 请求方式： POST
  • 请求头：Content-Type:application/json
  • 接口地址： https://api.xiaoe-tech.com/xe.alive.user.list/1.0.0
  • 频率限制：1秒2次

接口调试

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

请求参数 ​

参数名必选类型说明备注（示例）
access_token是string专属token...
resource_id是string直播id...
page是int页码...
page_size是int每页记录数范围取值：1-100...
equity_status否int直播权益状态：0-全部 1-有效 2-无效...
first_in_time_start否string首次进入时间（开始）yyyy-MM-dd HH-mm-ss...
first_in_time_end否string首次进入时间（结束）yyyy-MM-dd HH-mm-ss...
his_learn_time_max否int累计观看时长（秒）（小于等于）...
his_learn_time_min否int累计观看时长（秒）（大于等于）...
his_online_time_max否int直播间停留时长（秒）（小于等于）...
his_online_time_min否int直播间停留时长（秒）（大于等于）...
key_word否string关键字...
key_word_type否int关键字类型：2-昵称； 4-用户id...
last_in_time_start否string最近进入时间（开始）yyyy-MM-dd HH-mm-ss...
last_in_time_end否string最近进入时间（结束）yyyy-MM-dd HH-mm-ss...
order_by否int排序字段：0-不排序；1-直播间停留时长；2-累计观看时长；3-直播观看时长；4-回放观看时长；5-首次进入时间；6-进入进入时间；7-评论次数；8-直播间成交金额...
order_type否int0-不排序；1-降序；2-升序...
user_created_start否string用户创建时间（开始）yyyy-MM-dd...
user_created_end否string用户创建时间（结束）yyyy-MM-dd...
user_tags否array标签ID筛选[123,456]

请求示例 ​

{ 
    "access_token" : "xxxxxxxx",
    "resource_id": "l_64acc6bee4b03e4b54xxxxxxx",
    "page": 1,
    "page_size": 10
}

返回参数说明 ​

参数名必选类型说明备注（示例）
code是int错误码0
msg是string错误描述ok
data是Object返回值...
data.total是int查询结果记录数...
data.list是array直播间用户列表...

直播间用户列表 list

参数名必选类型说明备注（示例）
is_learned是int是否学习课程：0-否 1-是...
is_visited是int是否访问过直播：0-否 1-是...
is_policies是int“已取消权益”标志：1-是 2-否...
user_created_at是string用户注册时间2021-08-09 11:29:12
user_id是string用户id...
wx_avatar是string用户头像...
wx_nickname是string用户昵称...
real_name是string真实姓名...
user_tags是array用户标签列表
user_tags[].name是string用户标签名称
user_tags[].tag_id是string用户标签id
user_tags[].type是int用户标签类型：1-手动标签，2-自动标签
belong_promoter是string所属推广员
belong_promoter_id是string所属推广员ID
phone是string账号绑定手机号
phone_collect是string最近采集手机号
latest_visited_at是string最近访问店铺时间2022-01-24 18:00:00
is_seal是int账号状态：-2-待注销 -1-注销 0-正常，1-封号，2-禁止发评论，3-待激活...
transaction_number是int店内消费次数
pay_amount是int店内消费总额，单位：分
share_user是string所属邀请人
share_user_id是string所属邀请人id
alive_join_type是int加入方式：1-购买， 2-导入，3-活动领取，4-加密，5-好友赠送
alive_join_time是string加入时间
resource_collection_phone是string课程采集手机号
is_policies是int“已取消权益”标志：1-是 2-否2
his_online_time是int直播间停留时长，单位：秒
his_learn_time是int累计观看时长，单位：秒
his_learning_time是int直播观看时长，单位：秒
his_learned_time是int回放观看时长，单位：秒
first_in_time是string首次进入时间2023-07-11 11:23:37
last_in_time是string最近进入时间2023-07-11 11:23:37
is_subscribe是int是否预约：1-是 2-否
subscribe_phone是string预约登记手机号码
is_arrive是int是否到课： 0-否 1-是
comment_num是int评论次数(含隐藏评论数)
show_comment_num是int评论次数
sign_num是int签到次数
exceptional_price是int打赏金额，单位：分
participate_prize_num是int参与抽奖次数
prize_winner_num是int中奖次数
user_total_price是int直播间成交金额，单位：分
user_receive_coupon_num是int直播间领取优惠券张数
wx_union_id是string用户unionid（返回条件：商户已绑定自有微信服务号，且用户在绑定动作完成后有进入过平台登陆）

返回示例 ​

{
   "code": 0,
   "msg": "ok",
   "data": {
       "list": [
          {
               "alive_join_time": "",
               "alive_join_type": 0,
               "belong_promoter": "",
               "belong_promoter_id": "",
               "comment_num": 0,
               "equity_status": 2,
               "exceptional_price": 0,
               "first_in_time": "2023-07-07 18:01:01",
               "his_learn_time": 4443,
               "his_learned_time": 0,
               "his_learning_time": 4443,
               "his_online_time": 4884,
               "is_arrive": 0,
               "is_learned": 1,
               "is_policies": 0,
               "is_seal": 0,
               "is_subscribe": 0,
               "is_visited": 1,
               "last_in_time": "2023-07-07 19:22:32",
               "latest_visited_at": "2023-07-10 17:11:11",
               "participate_prize_num": 0,
               "pay_amount": 0,
               "phone": "",
               "phone_collect": "",
               "prize_winner_num": 0,
               "real_name": "特奥的中文测试号",
               "resource_collection_phone": "",
               "share_user": "",
               "share_user_id": "",
               "sign_num": 0,
               "subscribe_phone": "",
               "transaction_number": 0,
               "user_created_at": "2023-07-07 18:00:57",
               "user_id": "u_64a7e25946fed_6PM2lq4LP8",
               "user_receive_coupon_num": 0,
               "user_tags": [],
               "user_total_price": 0,
               "wx_avatar": "http://wechatavator-125xxxxxxxx.file.myqcloud.com/PM2lqxxx.jpeg",
               "wx_nickname": "特奥的中文测试号"
           },
       ],
       "total": 1
   }
}