API 文档
搜索文档…
更新合辑内容

接口

创建合辑
1
PUT /api/v3/catalog/:catalogId/chapters
Copied!

授权

请求 header
1
Authorization: Bearer <accessToken>
Copied!
注:请将上方的 <accessToken> 替换为分配给您的秘钥串。关于如何获取 accessToken ,请咨询杨经理(18968187008)。

参数

参数
参数类型
是否必填
描述
catalogId
integer
合辑 ID
chapters
array
合辑内容
chapters[N].selection
string
章节名称, 默认为空字符串
chapters[N].activityIds
array
活动 ID 列表

请求示例

1
curl -H "Content-Type: application/json" \
2
-H "Authorization: Bearer <accessToken>" \
3
-X "PUT" http://shangzhibo.tv/api/v3/catalog/1/chapters -d $'{
4
"chapters": [
5
{
6
"selection": "第一章",
7
"activityIds": [
8
"10000002"
9
]
10
}
11
]
12
}'
Copied!

响应 200

参数
参数类型
描述
chapters
array
合辑内容
chapters[N].selection
string
章节名称, 默认为空字符串
chapters[N].activityIds
array
活动 ID 列表
chapters[N].activities
array
活动列表对应的活动内容
chapters[N].activities[M].id
string
活动ID
chapters[N].activities[M].name
string
活动名称
chapters[N].activities[M].link
string
活动打开链接
chapters[N].activities[M].type
enum["video", "live"]
活动类型, video 表示视频,live 表示直播

响应样例

1
{
2
"chapters": [
3
{
4
"selection": "第一章",
5
"activityIds": [
6
"10000002"
7
],
8
"activities": [
9
{
10
"id": "10000002",
11
"name": "测试活动",
12
"type": "video",
13
"link": "http://localhost:2127/watch/10000002"
14
}
15
]
16
}
17
]
18
}
Copied!

响应 400

活动已被其他合辑使用

1
{
2
"message": "Activity 10000002 has been used in another catalog",
3
"status": 400,
4
"name": "BadRequest"
5
}
Copied!

响应 404

活动不存在

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