API 文档
搜索文档…
创建活动

接口

创建活动
1
POST /api/activity
Copied!

授权

请求 header
1
Authorization: Bearer <accessToken>
Copied!
注:请将上方的 <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 拉流地址

响应样例

1
{
2
"id": "8930091",
3
"name": "哈哈哈",
4
"imgCover": "//shangzhibo-img.b0.upaiyun.com/system/activity/template/default-preview.jpg",
5
"status": "enabled",
6
"agentId": 100020,
7
"startedAt": "2017-08-09T09:48:02.000Z",
8
"endedAt": "2017-08-10T09:48:02.000Z",
9
"pushDomain": "push.shangzhibo.tv",
10
"pullDomain": "play.shangzhibo.tv",
11
"isPushing": false,
12
"createdAt": "2017-08-09T08:48:02.120Z",
13
"updatedAt": "2017-08-09T08:48:02.120Z",
14
"app": "onelive",
15
"stream": "893009-jksdupure",
16
"progress": "OnGoing",
17
"isPrologueEnabled": true,
18
"isEpilogueEnabled": true,
19
"isLiveEnabled": true,
20
"fake": {
21
"baseCount": 0,
22
"increaseMin": 1,
23
"increaseMax": 1
24
},
25
"isFakeEnabled": false,
26
"isFilterAllEnabled": false,
27
"isRobotEnabled": false,
28
"isTranscodable": false,
29
"robot": {
30
"initialCount": 10,
31
"incrementCount": 1
32
},
33
"expired": false,
34
"maxConcurrentUser": -1,
35
"maxPushingTime": -1,
36
"subagentIds": [1, 2],
37
"pullUrls": {
38
"default": "play.shangzhibo.tv/onelive/10075533-sTd6IzKoEU",
39
"flv": "play.shangzhibo.tv/onelive/10075533-sTd6IzKoEU.flv",
40
"m3u8": "play.shangzhibo.tv/onelive/10075533-sTd6IzKoEU.m3u8"
41
}
42
}
Copied!

响应 400

startedAtendedAt 值不是合法的时间格式

1
{
2
"status": 400,
3
"name": "BadRequest",
4
"message": "Invalid Date",
5
}
Copied!

活动名称已经存在

1
{
2
"status": 400,
3
"name": "NameExist",
4
"message": "名字已经存在",
5
}
Copied!

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

1
{
2
"status": 400,
3
"name": "BadRequest",
4
"message": "您的账号未开通直播加速功能",
5
}
Copied!

响应 401

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

1
{
2
"status": 401,
3
"name": "Unauthorized",
4
"message": "您没有创建子账号的权限",
5
}
Copied!

响应 404

subagentIds 中的子账号 Id 不存在时

1
{
2
"status": 404,
3
"name": "NotFount",
4
"message": "Subagent Not Found",
5
}
Copied!
最近更新 5mo ago