API 文档
搜索文档…
获取合辑列表

接口

请求地址
1
GET /api/v3/catalog
Copied!

授权

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

参数

参数
参数类型
参数说明
是否必填
page
integer
页数(默认第一页,最小为1)
pageSize
integer
每页显示数量(默认10,最小为0)
order
string
排序方式(默认: 'id desc' )

请求样例

1
GET /api/v3/catalog?page=1&pageSize=5&order=id desc
Copied!

响应参数

参数
类型
描述
pager
object
pager.page
integer
当前页
pager.pageSize
integer
每页返回数量
pager.total
integer
合辑总量
items
array<object>
合辑明细
chapter
array<object>
合辑章节
chapter.selection
string
章节名称
chapter.activityIds
array<string>
活动ID列表
chapter.activities
array<object>
活动内容
chapter.activities.id
string
活动ID
chapter.activities.name
string
活动名称
chapter.activities.isPushing
boolean
是否正在推流
chapter.activities.imgCover
string
活动封面
chapter.activities.link
string
活动链接
chapter.activities.type
string
活动类型(枚举值[ 'live':直播;'video':视频])
chapter.activities.startedAt
string
开始时间
chapter.activities.endedAt
string
结束时间
id
integer
合辑ID
agentId
integer
客户ID
name
string
合辑名称
createdAt
string
创建时间
updatedAt
string
更新时间
appearance
object
界面配置
appearance.cover
string
abstract
object
简介信息
abstract.richText
string
html
share
object
分享配置
share.title
string
share.wechat
object
share.wechat.text
string
share.wechat.image
string
share.wechatZone
object
share.wechatZone.text
string
share.wechatZone.image
string
link
string
合辑页面地址

响应示例

1
{
2
"pager": {
3
"page": 1,
4
"pageSize": 5,
5
"total": 1
6
},
7
"items": [
8
{
9
"chapters": [
10
{
11
"selection": "",
12
"activityIds": [
13
"xxxxxxxx",
14
"xxxxxxxx",
15
],
16
"activities": [
17
{
18
"id": "xxxxxxxx",
19
"name": "emma",
20
"isPushing": false,
21
"type": "video",
22
"startedAt": "2098-12-31T16:00:00.000Z",
23
"endedAt": "2222-08-25T12:05:00.000Z",
24
"imgCover": "https://doc.shangzhibo.tv/resources/xxxxxx/xxxxxxxx/asdasdasdas.jpeg",
25
"link": "http://shangzhibo.tv/watch/xxxxxxxx"
26
},
27
{
28
"id": "xxxxxxxx",
29
"name": "waston",
30
"isPushing": false,
31
"type": "live",
32
"startedAt": "2021-09-07T06:05:00.000Z",
33
"endedAt": "2021-09-08T06:05:00.000Z",
34
"imgCover": "https://doc.shangzhibo.tv/resources/xxxxxx/xxxxxxxx/asdasdasd.jpeg",
35
"link": "http://shangzhibo.tv/watch/xxxxxxxx"
36
}
37
]
38
}
39
],
40
"id": xxx,
41
"agentId": xxxxxx,
42
"name": "share",
43
"createdAt": "2021-08-26T09:51:06.000Z",
44
"updatedAt": "2021-09-09T02:31:21.000Z",
45
"appearance": {
46
"cover": "https://doc.shangzhibo.tv/resources/xxxxxx/fdsfdsfds.jpeg"
47
},
48
"abstract": {},
49
"share": {
50
"title": "share",
51
"wechat": {
52
"text": "",
53
"image": "https://doc.shangzhibo.tv/system/activity/template/default-share-img.png"
54
},
55
"wechatZone": {
56
"text": "",
57
"image": "https://doc.shangzhibo.tv/system/activity/template/default-share-img.png"
58
}
59
},
60
"link": "http://shangzhibo.tv/w/catalog/xxx"
61
}
62
]
63
}
Copied!
最近更新 1mo ago