创建活动

接口

创建活动

POST /api/activity

授权

请求 header

Authorization: Bearer <accessToken>

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

参数

参数	参数类型	参数说明	是否必填
name	string	活动名称	是
startedAt	datetime	直播开始时间，格式为 UTC 时间	否
endedAt	datetime	直播结束时间，格式为 UTC 时间	否
subagentIds	Array<Integer>	子账号 Id 集合	否
transcodeEnabled	Boolean	是否开启画质控制(需要开启直播转码功能)	否
boost	string	push-global 全球推流 pull-global 全球播放 all-global 全球推流 + 全球播放 push-us 美国推流 push-de 德国推流 push-hk 香港推流 push-sg 新加坡推流 pull-us 美国播放 pull-de 德国播放 pull-hk 香港播放 pull-sg 新加坡播放 该参数需额外开通海外节点功能	否

响应 200

参数	参数类型	参数说明
id	string	活动 ID
name	string	活动名称
imgCover	string	封面图片
status	string	活动状态，enabled 允许推流 disabled 禁止推流 forbidden 管理员禁止推流
agentId	integer	账号 ID
startedAt	string	活动开始时间
endedAt	string	活动结束时间
pushDomain	string	推流域名
pullDomain	string	拉流域名
isPushing	boolean	是否在推流
createdAt	string	活动创建时间
updateAt	string	活动更新时间
app	string	应用名称
stream	string	流名称
progress	string	活动进程参数，未开始 (NotStart), 直播中 (OnGoing), 已结束 (Finished)
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 拉流地址

响应样例

{
    "id": "8930091",
    "name": "哈哈哈",
    "imgCover": "//shangzhibo-img.b0.upaiyun.com/system/activity/template/default-preview.jpg",
    "status": "enabled",
    "agentId": 100020,
    "startedAt": "2017-08-09T09:48:02.000Z",
    "endedAt": "2017-08-10T09:48:02.000Z",
    "pushDomain": "push.shangzhibo.tv",
    "pullDomain": "play.shangzhibo.tv",
    "isPushing": false,
    "createdAt": "2017-08-09T08:48:02.120Z",
    "updatedAt": "2017-08-09T08:48:02.120Z",
    "app": "onelive",
    "stream": "893009-jksdupure",
    "progress": "OnGoing",
    "isPrologueEnabled": true,
    "isEpilogueEnabled": true,
    "isLiveEnabled": true,
    "fake": {
        "baseCount": 0,
        "increaseMin": 1,
        "increaseMax": 1
    },
    "isFakeEnabled": false,
    "isFilterAllEnabled": false,
    "isRobotEnabled": false,
    "isTranscodable": false,
    "robot": {
        "initialCount": 10,
        "incrementCount": 1
    },
    "expired": false,
    "maxConcurrentUser": -1,
    "maxPushingTime": -1,
    "subagentIds": [1, 2],
    "pullUrls": {
        "default": "play.shangzhibo.tv/onelive/10075533-sTd6IzKoEU",
        "flv": "play.shangzhibo.tv/onelive/10075533-sTd6IzKoEU.flv",
        "m3u8": "play.shangzhibo.tv/onelive/10075533-sTd6IzKoEU.m3u8"
    }
}

响应 400

startedAt、endedAt 值不是合法的时间格式

{
    "status": 400,
    "name": "BadRequest",
    "message": "Invalid Date",
}

活动名称已经存在

{
    "status": 400,
    "name": "NameExist",
    "message": "名字已经存在",
}

未开通直播加速功能，当且仅当参数中传递了 boost

{
    "status": 400,
    "name": "BadRequest",
    "message": "您的账号未开通直播加速功能",
}

响应 401

没有创建子账号的权限, 当且仅当在传递参数时加入了 subagentIds 参数

{
    "status": 401,
    "name": "Unauthorized",
    "message": "您没有创建子账号的权限",
}

响应 404

subagentIds 中的子账号 Id 不存在时

{
    "status": 404,
    "name": "NotFount",
    "message": "Subagent Not Found",
}