获取活动列表

接口

请求地址

GET api/activity

授权

请求 header

Authorization: Bearer <accessToken>
Content-Type: application/json

注：请将上方的<accessToken>替换为分配给您的秘钥串。关于如何获取 accessToken ，请咨询杨经理（18968187008）。

参数

参数	参数类型	是否必填	描述
isArchived	boolean	否	true 表示已归档，false 表示未归档
name	string	否	活动名称
isPushing	boolean	否	是否处于推流状态
orderBy	enum<createdAt desc, createdAt asc, startedAt desc, startedAt asc, endedAt desc, endedAt asc>	否	默认为 createdAt desc
page	integer	否	当前页数
pageSize	integer	否	每页几条
groupId	integer	否	活动分类ID，不传递则表示查询所有活动，传递 -1 表示查询未分类的活动，传递其他整数则表示查询对应分类的活动

GET /api/activity?isArchived=false&page=42&pageSize=42&groupId=-1

响应参数

参数	参数类型	参数说明
id	string	活动 ID
name	string	活动名称
imgCover	string	封面图片
status	string	活动状态，enabled 允许推流 disabled 禁止推流 forbidden 管理员禁止推流
agentId	integer	账号 ID
startedAt	string	活动开始时间
endedAt	string	活动结束时间
pushDomain	string	推流域名
pullDomain	string	拉流域名
groupId	integer	分类 ID
isPushing	boolean	是否在推流
createdAt	string	活动创建时间
updateAt	string	活动更新时间
app	string	应用名称
stream	string	流名称
progress	string	活动进程参数，未开始 (NotStart), 直播中 (OnGoing), 已结束 (Finished)
authKeys	object	如果没有开启防盗链，不会返回该参数；开启防盗链后 default 为 RTMP 流的密钥，m3u8 为HLS 流密钥
isPrologueEnabled	boolean	是否启用预设视频
isLiveEnabled	boolean	是否开启播放页直播
isFakeEnabled	boolean	是否启用人数放大
fake.baseCount	integer	观看人数放大——基础人数
fake.increaseMin	integer	观看人数放大——每增加一次真实用户访问，观看人数增加的最小值
fake.increaseMax	integer	观看人数放大——每增加一次真实用户访问，观看人数增加的最大值
isFilterAllEnabled	boolean	是否禁言所有观众
isRobotEnabled	boolean	是否启用机器人
robot.initialCount	integer	机器人——初始评论数
robot.incrementCount	integer	机器人——每增长 100 个用户 PV 增加的评论数
expired	boolean	活动是否超过最大推流时长
maxConcurrentUser	integer	最大并发在线人数，-1 表示不限制最大在线人数
maxPushingTime	integer	最大推流时长，单位 秒，-1 表示不限制最大推流时长
isTranscodable	boolean	该活动能否开启活动转码功能
subagentIds	Array<Integer>	子账号 Id 集合
pullUrls	object	拉流地址集合
pullUrls.default	string	rtmp 拉流地址
pullUrls.flv	string	flv 拉流地址
pullUrls.m3u8	string	hls 拉流地址

响应示例

{
    "pager": {
        "page": 1,
        "pageSize": 10,
        "total": 16
    },
    "items": [
        {
            "id": "2837888",
            "name": "创想人工智能峰会-深圳站",
            "status": "disabled",
            "agentId": 101691,
            "startedAt": "2018-01-29T06:58:26.000Z",
            "endedAt": "2018-01-29T10:58:26.000Z",
            "pushDomain": "push.shangzhibo.tv",
            "pullDomain": "play.shangzhibo.tv",
            "groupId": 233,
            "isPushing": false,
            "createdAt": "2018-01-29T05:58:28.000Z",
            "updatedAt": "2018-01-29T11:09:35.000Z",
            "app": "r1g3-d43BM",
            "stream": "Hkb3WOE2BM",
            "isPrologueEnabled": true,
            "isEpilogueEnabled": true,
            "isLiveEnabled": true,
            "fake": {
                "baseCount": 0,
                "increaseMin": 1,
                "increaseMax": 1
            },
            "isFakeEnabled": false,
            "isFilterAllEnabled": false,
            "isRobotEnabled": false,
            "robot": {
                "initialCount": 10,
                "incrementCount": 1
            },
            "expired": false,
            "maxConcurrentUser": -1,
            "maxPushingTime": -1,
            "subagentIds": [1, 2],
        }
    ]
}