接口：获取知客活动列表接口

  • 获取客户创建的知客直播列表数据

请求URL:

GET/v2/base-manage/list-activity

参数:

参数名 是否必须 类型 说明
status 否 string 活动状态： PREPARE =>预告，LIVING=>直播中，FINISH=>直播结束，PLAYBACK=>回放状态，不传为全部
page_size 是 int 每页大小<=100 ，默认为12
page 是 int 当前页
sort_by 否 string 排序：create_time=>创建时间，默认创建时间倒序
keyword 否 string 搜索关键字
app_id 是 string 用户的appId
signed_at 是 int 时间戳
sign 是 string 计算得到的签名

返回示例:

正确时返回:

{
    "code": 200,
    "msg": "",
    "data": {
        "total": 133,
        "total_page": 133,
        "curr_page": "1",
        "page_size": "1",
        "list": [
            {
                "id": 18179833,
                "title": "测试推荐卡片",
                "user_id": 21200013,
                "business_account_id": 26600001,
                "sponsor": "微吼直播",
                "start_time": "2021-05-22 00:00:00",
                "real_start_time": "2021-05-21 17:49:44",
                "end_time": "2021-05-24 14:14:29",
                "img_url": "mp-test/ec/ec/ececd6d3487358758ff03433b57dec95.jpg",
                "description": "",
                "status": "FINISH",
                "view_condition": "NONE",
                "live_room": "lss_0d8dd26b",
                "hd_room": "inav_4d8f15ef",
                "channel_room": "ch_A3Vl8vu3",
                "ext_channel_room": "ch_8j46SR84",
                "published": "Y",
                "created_at": "2021-05-21 17:49:07",
                "admin_closed": "N",
                "entry_time": 30,
                "whitelist_status": null,
                "is_portrait": "N",
                "is_playback": "N",
                "layout": 1,
                "manual": 2,
                "auth_chat": 2,
                "chat_filter": 2,
                "gift_status": 2,
                "reward_status": 2,
                "global_gift_status": 2,
                "global_reward_status": 2,
                "data_finish_time": "2021-05-24 14:29:29",
                "valid_status": "N",
                "user_count": 5,
                "appointment_count": 0,
                "sign_count": 0,
                "visit_num": "4"
            }
        ]
    },
    "request_id": "ffda77ee-66ed-464f-a06a-07ea2d73"
}

错误时返回:

{
    "code": 201,
    "msg": "invalid appid",
    "data": {}
}

返回参数说明:

公共相应参数，详细内容请参考[返回结果]

返回数据如下：

参数名 类型 说明
id int 课程ID
title string 活动标题
user_id int 客户id
business_account_id int 客户账号id
sponsor string 主办方
start_time string 预计开始时间
real_start_time string 真正开始时间
end_time string 直播结束时间
img_url string 活动图片地址
description string 活动描述
status string 活动状态
view_condition string 观看条件NONE: 无限制 INVITATION: 邀请APPOINT: 预约报名
live_room string 直播房间id
hd_room string 互动房间id
channel_room string 聊天频道房间id
ext_channel_room string 扩展消息频道
published string 是否发布：Y=>是，N=>否
created_at string 创建时间
admin_closed string 是否被后台关闭：Y=>是，N=>否
entry_time string 预期提前时间：30分钟，默认
whitelist_status string 白名单状态
is_portrait string
is_playback string
layout int 1.视频直播 2. 文档直播
manual int 活动报名人工审核开启状态 1.开启 2.关闭
auth_chat int 聊天人工审核开关1开启 2关闭
chat_filter int 聊天严禁词过滤状态1开启 2关闭
gift_status int 礼物开关 1:开启 2:关闭
reward_status int 打赏开关 1:开启 2:关闭
global_gift_status int 通用礼物开关 1:开启 2:关闭
global_reward_status int 通用打赏开关 1:开启 2:关闭
data_finish_time string 数据计算完成时间
valid_status string N
user_count int 用户总数
appointment_count int 预约总数
sign_count int 报名总数
visit_num int 访问总数

备注:

  • 更多返回错误代码请看首页的错误代码描述