更新直播分享配置信息--企业直播-火山引擎

文档中心

立即注册

导航

更新直播分享配置信息

最近更新时间：2024.12.20 15:12:20首次发布时间：2024.12.17 10:30:22

调用 UpdateActivityPoster 接口更新指定直播间的直播分享配置信息，包含自定义分享地址、邀请海报和邀请榜单等信息。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。

请求说明

请求方式：POST
请求地址：https://livesaas.volcengineapi.com/?Action=UpdateActivityPoster&Version=2023-08-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`UpdateActivityPoster`	接口名称。当前 API 的名称为 `UpdateActivityPoster`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。

Body

参数	类型	是否必选	示例值	描述
PosterConfig	Object of PosterConfig	是	`-`	直播分享配置信息。

PosterConfig

参数	类型	是否必选	示例值	描述
ActivityId	Long	是	`181251****649932`	直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。
CanShare	Integer	是	`2`	是否开启分享。取值如下： `1`：不开启 `2`：开启说明仅在取值为 `2` 时，该接口的直播分享具体配置才会生效。
CustomTitle	String	否	`分享标题`	分享标题。在观众通过微信分享直播间的卡片消息中作为标题展示。不传该参数或传空值，则默认为直播间名称。说明观众必须通过二维码扫码进入直播间，并选择分享直播间至微信好友或朋友圈，才会展示分享卡片消息。
CustomDesc	String	否	`分享描述`	分享描述。在观众通过微信分享直播间的卡片消息中作为描述展示。不传该参数或传空值，则默认为直播间名称。说明观众必须通过二维码扫码进入直播间，并选择分享直播间至微信好友或朋友圈，才会展示分享卡片消息。
CustomImage	String	否	`https://image.***`	分享图标的 URL。在观众通过微信分享直播间的卡片消息中作为图片展示或者在浏览器地址栏、书签、标签页等位置作为直播间网页图标展示。支持配置大小不超过 2 MB 的 JPG 或 PNG 格式的图片。建议图片尺寸为 100*100。说明观众必须通过二维码扫码进入直播间，并选择分享直播间至微信好友或朋友圈，才会展示分享卡片消息。
CustomAddress	String	否	`https://live.byteoc.com/*/*`	自定义分享地址，需包含协议头。长度为 1 到 251 个字符。不传该参数或传空值，则默认为观看页地址。该参数应用于分享链接和二维码（包含海报上的二维码），适用于对直播分享地址有自身品牌特殊要求的场景。说明自定义分享地址不支持通过微信的卡片消息进行分享。
CanInvite	Integer	是	`2`	是否开启邀请海报。取值如下： `1`：不开启 `2`：开启
IsForceLogin	Integer	是	`2`	是否开启强制登录。取值如下： `1`：不开启 `2`：开启。开启后，PC 端观众必须先登录直播间才能获取邀请海报，移动端观众必须先登录直播间才能获取邀请海报、分享二维码和链接
CoverImage	String	否	`https://image.***`	海报封面图的 URL。不传该参数或传空值，则默认为直播间横屏封面图。支持配置大小不超过 2 MB 的 JPG 或 PNG 格式的图片。建议图片尺寸比例为 16:9。
Title	String	否	`海报标题`	海报标题。说明 `CanInvite` 取值为 `2` 时，该参数必选。
Sponsor	String	否	`主办方`	主办方。说明 `CanInvite` 取值为 `2` 时，该参数必选。
ActivityAddress	String	否	`活动地点`	活动地点。
ActivityDesc	String	否	`活动简介`	活动简介。
LiveType	Integer	是	`1`	直播方式。取值如下： `1`：竖屏直播，即通过分享的链接、二维码或海报进入的是竖屏直播间 `2`：横屏直播，即通过分享的链接、二维码或海报进入的是横屏直播间
InviteListEnable	Integer	是	`2`	是否开启邀请榜单。取值如下： `1`：不开启 `2`：开启说明观众只有在登录直播间后，才能分享自己的专属链接、二维码或海报邀请其他人观看直播。当新用户通过某观众分享的专属链接、二维码或海报首次进入并登录直播间后，该观众的邀请人数增加 1 人。当邀请人数相同时，先达到该邀请人数的观众排名更高。
InviteContent	String	否	`邀请榜`	榜单名称，长度为 1 到 75 个字符。如开启多语言，则每种语言最多支持 15 个字符。说明 `InviteListEnable` 取值为 `2` 时，该参数必选。
InviteShowPeople	Integer	否	`15`	上榜人数。取值范围为 [1,50]。说明 `InviteListEnable` 取值为 `2` 时，该参数必选。

返回参数

参数	类型	示例值	描述
PosterConfig	Object of PosterConfig	`-`	直播分享配置信息。

PosterConfig

参数	类型	示例值	描述
ActivityId	Long	`181251****649932`	直播间 ID。
CanShare	Integer	`2`	是否开启分享。取值如下： `1`：不开启 `2`：开启
CustomTitle	String	`分享标题`	分享标题。在观众通过微信分享直播间的卡片消息中作为标题展示。说明观众必须通过二维码扫码进入直播间，并选择分享直播间至微信好友或朋友圈，才会展示分享卡片消息。
CustomDesc	String	`分享描述`	分享描述。在观众通过微信分享直播间的卡片消息中作为描述展示。说明观众必须通过二维码扫码进入直播间，并选择分享直播间至微信好友或朋友圈，才会展示分享卡片消息。
CustomImage	String	`https://image.***`	分享图标的 URL。在观众通过微信分享直播间的卡片消息中作为图片展示或者在浏览器地址栏、书签、标签页等位置作为直播间网页图标展示。说明观众必须通过二维码扫码进入直播间，并选择分享直播间至微信好友或朋友圈，才会展示分享卡片消息。
CustomAddress	String	`https://live.byteoc.com/*/*`	自定义分享地址，包含协议头。该参数应用于分享链接和二维码（包含海报上的二维码），适用于对直播分享地址有自身品牌特殊要求的场景。说明自定义分享地址不支持通过微信的卡片消息进行分享。
CanInvite	Integer	`2`	是否开启邀请海报。取值如下： `1`：不开启 `2`：开启
IsForceLogin	Integer	`2`	是否开启强制登录。取值如下： `1`：不开启 `2`：开启。开启后，PC 端观众必须先登录直播间才能获取邀请海报，移动端观众必须先登录直播间才能获取邀请海报、分享二维码和链接
CoverImage	String	`https://image.***`	海报封面图的 URL。
Title	String	`海报标题`	海报标题。
Sponsor	String	`主办方`	主办方。
LiveStartTime	Long	`1728548880`	直播时间。Unix 时间戳，单位为秒。
ActivityAddress	String	`活动地点`	活动地点。
ActivityDesc	String	`活动简介`	活动简介。
LiveType	Integer	`1`	直播方式。取值如下： `1`：竖屏直播，即通过分享的链接、二维码或海报进入的是竖屏直播间 `2`：横屏直播，即通过分享的链接、二维码或海报进入的是横屏直播间
InviteListEnable	Integer	`2`	是否开启邀请榜单。取值如下： `1`：不开启 `2`：开启说明观众只有在登录直播间后，才能分享自己的专属链接、二维码或海报邀请其他人观看直播。当新用户通过某观众分享的专属链接、二维码或海报首次进入并登录直播间后，该观众的邀请人数增加 1 人。当邀请人数相同时，先达到该邀请人数的观众排名更高。
InviteContent	String	`邀请榜`	榜单名称。
InviteShowPeople	Integer	`15`	上榜人数。

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateActivityPoster&Version=2023-08-01
{
    "PosterConfig": {
        "ActivityId": 181251****649932,
        "CoverImage": "https://image.***",
        "Title": "海报标题",
        "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
    }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "UpdateActivityPoster",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "PosterConfig": {
            "ActivityId": 181251****649932,
            "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
        }
    }
}

错误码

下表提供了该接口特有的错误码，公共错误码请参见公共错误码和错误码文档。

状态码	错误码	错误信息	说明
500	InvalidParameter.InviteListEnableInvalid	The specified parameter InviteListEnable is invalid.	`InviteListEnable` 参数不符合规范。请修改后重试。参数取值为 `2` 时，请确保直播间内至少开启一个菜单。