API 文档
搜索文档…
获取门户页 热门/最新 活动

接口

请求地址
1
GET api/page/:id/activities
Copied!

授权

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

参数

参数
参数类型
是否必填
描述
id
string
门户页id
page
integer
当前页
pageSize
integer
每页条数
orderBy
enum
popular: 热门活动
latest : 最新活动(default)
1
GET /api/page/:id/activities?page=1&pageSize=10&orderBy=popular
Copied!

响应参数

参数
参数类型
参数说明
id
integer
活动id
name
string
活动名字
status
string
直播线路状态
isPushing
boolean
是否正在推流
startedAt
string
活动开始时间
endedAt
string
活动结束时间
createdAt
string
创建时间
link
string
活动观看页地址
pv
integer
活动观看人数
template
object
活动一些配置参数

响应示例

1
{
2
"pager":{
3
"page":1,
4
"pageSize":99,
5
"total":10
6
},
7
"items":[
8
{
9
"id":"10269952",
10
"name":"色白花青",
11
"status":"disabled",
12
"agentId":120489,
13
"isPushing":false,
14
"startedAt":"2021-02-24T11:10:00.000Z",
15
"endedAt":"2021-03-05T09:40:15.000Z",
16
"createdAt":"2021-01-26T10:14:42.000Z",
17
"updatedAt":"2021-03-05T09:40:30.000Z",
18
"link":"http://shangzhibo.tv/watch/10269952",
19
"pv":3004,
20
"template":{
21
"imgLogo":"https://doc.shangzhibo.tv/system/custom/shangzhibo/logo.svg",
22
"imgCover":"https://doc.shangzhibo.tv/client/user/121765/1587869188431/1587869188394_158786918839399.png",
23
"imgMobileCover":"https://doc.shangzhibo.tv/system/activity/template/default-mobile-index.png",
24
"followImg":"https://doc.shangzhibo.tv/system/activity/template/followImg.jpg",
25
"share":{
26
"wechat":{
27
"text":"",
28
"image":"https://doc.shangzhibo.tv/system/activity/template/default-share-img.png"
29
},
30
"qq":{
31
"text":"",
32
"image":"https://doc.shangzhibo.tv/system/activity/template/default-share-img.png"
33
},
34
"weibo":{
35
"text":"",
36
"image":"https://doc.shangzhibo.tv/system/activity/template/default-share-img.png"
37
}
38
},
39
"isCRMSignupEnabled":false,
40
"isNoRepeatDrawEnabled":false,
41
"auth":{
42
"methods":[
43
44
],
45
"payPrompt":"欢迎观看直播",
46
"payPrice":1,
47
"isTrailEnabled":false,
48
"trailTimeout":300,
49
"payExpiredTimeout":0,
50
"isSinglePasscodeEnabled":false
51
},
52
"isWechatShareDisabled":true,
53
"isHideDraw":false,
54
"isLikeEnabled":true,
55
"isAutoLikesEnabled":false,
56
"colorBackground":"",
57
"imgBackground":"https://doc.shangzhibo.tv/resources/120489/10269952/b2a32e93e25d9fd9e6513a56a0d0d9aa.jpg",
58
"positionLogo":"hide",
59
"imgLogoScale":100,
60
"imgLogoTransparency":100,
61
"countdownPosition":"leftTop",
62
"liveMode":"online",
63
"followName":"官方公众号",
64
"followDescription":"关注后可收到最新动态哦",
65
"mobileLayout":"overlay",
66
"mobileTitleType":"text",
67
"isResolutionEnabled":false,
68
"resolutionTypes":[
69
70
],
71
"isSubscribeEnabled":false,
72
"subscribeMessage":"",
73
"isDocEnabled":false,
74
"isDocFlatingEnabled":true,
75
"isDocUnfoldEnabled":false,
76
"isDocNotifyEnabled":false,
77
"isDocTurningEnabled":true,
78
"isGiftEnabled":true,
79
"isGiftFloatingEnabled":true,
80
"isGiftChatboxEnabled":false,
81
"isGraphicEnabled":false,
82
"isCountdownEnabled":false,
83
"isAdEnabled":false,
84
"isFaqEnabled":false,
85
"isFaqFloatingEnabled":true,
86
"isFaqChatboxEnabled":false,
87
"isVoteFloatingEnabled":true,
88
"isVoteBannerEnabled":true,
89
"isVoteChatboxEnabled":false,
90
"isVoteDisableClose":false,
91
"isShareCardEnabled":true,
92
"isLiveTranscodeEnabled":false,
93
"isPageEnabled":false,
94
"isLiveProtectionEnabled":false,
95
"promotions":[
96
97
],
98
"checkinScene":"before",
99
"isCommentDisabled":false,
100
"wechatLoginPattern":"normal",
101
"transcribeGuardConf":{
102
"fontSize":18,
103
"fontColor":"#FFF",
104
"opacity":90,
105
"showType":"level",
106
"text":"${username}"
107
},
108
"commentStyleCustomized":{
109
"template":0,
110
"tabsColor":"FFFFFF",
111
"backgroundImg":"",
112
"inputColor":"FFFFFF",
113
"fontColor":"000000",
114
"backgroundColor":"EEEEEE"
115
},
116
"commentAllowed":[
117
"agent",
118
"subagent"
119
]
120
}
121
}
122
]
123
}
Copied!
最近更新 8mo ago