调用 GetActivityPoster 接口获取指定直播间的直播分享配置信息，包含自定义分享地址、邀请海报和邀请榜单等信息。
请求频率：单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | GetActivityPoster | 接口名称。当前 API 的名称为 GetActivityPoster。 |
| Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01。 |
| ActivityId | Long | 是 | 177985****487296 | 直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| PosterConfig | Object of PosterConfig | - | 直播分享配置信息。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| ActivityId | Long | 177985****487296 | 直播间 ID。 |
CanShare | Integer |
| 是否开启分享。取值如下：
|
CustomTitle | String |
| 分享标题。在观众通过微信分享直播间的卡片消息中作为标题展示。 说明 观众必须通过二维码扫码进入直播间，并选择分享直播间至微信好友或朋友圈，才会展示分享卡片消息。 |
CustomDesc | String |
| 分享描述。在观众通过微信分享直播间的卡片消息中作为描述展示。 说明 观众必须通过二维码扫码进入直播间，并选择分享直播间至微信好友或朋友圈，才会展示分享卡片消息。 |
CustomImage | String |
| 分享图标的 URL。在观众通过微信分享直播间的卡片消息中作为图片展示或者在浏览器地址栏、书签、标签页等位置作为直播间网页图标展示。 说明 观众必须通过二维码扫码进入直播间，并选择分享直播间至微信好友或朋友圈，才会展示分享卡片消息。 |
CustomAddress | String |
| 自定义分享地址，包含协议头。该参数应用于分享链接和二维码（包含海报上的二维码），适用于对直播分享地址有自身品牌特殊要求的场景。 说明 自定义分享地址不支持通过微信的卡片消息进行分享。 |
CanInvite | Integer |
| 是否开启邀请海报。取值如下：
|
IsForceLogin | Integer |
| 是否开启强制登录。取值如下：
|
| CoverImage | String | https://image.*** | 海报封面图的 URL。 |
| Title | String | 海报标题 | 海报标题。 |
| Sponsor | String | 主办方 | 主办方。 |
| LiveStartTime | Long | 1728548880 | 直播时间。Unix 时间戳，单位为秒。 |
| ActivityAddress | String | 活动地点 | 活动地点。 |
| ActivityDesc | String | 活动简介 | 活动简介。 |
LiveType | Integer |
| 直播方式。取值如下：
|
InviteListEnable | Integer |
| 是否开启邀请榜单。取值如下：
说明 观众只有在登录直播间后，才能分享自己的专属链接、二维码或海报邀请其他人观看直播。当新用户通过某观众分享的专属链接、二维码或海报首次进入并登录直播间后，该观众的邀请人数增加 1 人。当邀请人数相同时，先达到该邀请人数的观众排名更高。 |
| InviteContent | String | 邀请榜 | 榜单名称。 |
| InviteShowPeople | Integer | 15 | 上榜人数。 |
GET https://livesaas.volcengineapi.com/?Action=GetActivityPoster&Version=2023-08-01&ActivityId=177985****487296
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "GetActivityPoster", "Version": "2023-08-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1697446406 }, "Result": { "PosterConfig": { "ActivityId": 177985****487296, "CoverImage": "https://image.***", "Title": "海报标题", "LiveStartTime": 1728548880, "ActivityDesc": "活动简介", "CustomTitle": "分享标题", "CustomDesc": "分享描述", "CustomImage": "https://image.***", "IsForceLogin": 2, "CanShare": 2, "CanInvite": 2, "Sponsor": "主办方", "ActivityAddress": "活动地点", "LiveType": 1, "CustomAddress": "https://live.byteoc.com/***/***", "InviteListEnable": 2, "InviteContent": "邀请榜", "InviteShowPeople": 15 } } }