更新直播间观看账号配置信息--企业直播-火山引擎

文档中心

立即注册

导航

更新直播间观看账号配置信息

最近更新时间：2024.09.06 11:08:31首次发布时间：2023.06.15 10:37:14

更新直播间主要和次要观看账号的配置信息。

说明

如需更新公开、密码、白名单或手机号的观看限制配置信息，可调用 UpdateViewingRestriction 接口。

注意事项

请求频率：单用户请求频率限制为 120 次/分钟。

请求说明

请求方式：POST
请求地址：https://livesaas.volcengineapi.com/?Action=UpdateActivityViewPermissionAPI&Version=2020-06-01

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ActivityId	Integer	是	`17678654498813`	直播间 ID。您可以通过调用 ListActivityAPI 接口查询 ID。
ViewingRestriction	Object of ViewingRestrictions	是	`-`	主要观看账号的配置信息。
IsSubViewingRestrictionEnable	Boolean	否	`false`	是否开启次要观看账号。默认取值为 `false`。 false：关闭 true：开启
SubViewingRestriction	Object of ViewingRestrictions	否	`-`	次要观看账号的配置信息。当 `IsSubViewingRestrictionEnable` 取值为 `true` 时，该参数必填。

ViewingRestrictions

参数类型是否必选示例值描述

参数	类型	是否必选	示例值	描述
ViewingAccountType	Integer	是	`4`	观看账号的类型。 4：自定义登录
ViewingRestrictionButtonTitle	String	否	`自定义登录`	登录方式的按钮文案。
CustomViewingRestriction	Object of CustomViewingRestriction	否	`-`	自定义登录的配置信息。当 `ViewingAccountType` 取值为 `4` 时，该参数必填。

ViewingAccountType

Integer

是

4

观看账号的类型。

4：自定义登录

ViewingRestrictionButtonTitle String 否 自定义登录 登录方式的按钮文案。

CustomViewingRestriction Object of CustomViewingRestriction 否 - 自定义登录的配置信息。当 ViewingAccountType 取值为 4 时，该参数必填。

CustomViewingRestriction

参数	类型	是否必选	示例值	描述
CustomApp	String	否	`test`	登录账号 App。您的自有账号系统名称。当 `ViewingAccountType` 取值为 `4` 时，该参数必填。
CustomUrl	String	否	`https://www.example.com`	登录链接。您的自有账号系统登录页面的链接。当 `ViewingAccountType` 取值为 `4` 时，该参数必填。
ErrorRedirectUrl	String	否	`https://www.error.com`	自定义鉴权校验失败后，进入的鉴权校验失败页面的地址。该地址需要包含协议头。

返回参数

参数	类型	示例值	描述
ActivityId	Integer	`17678654498813`	直播间 ID。
ViewingRestrictionInfo	Object of ViewingRestrictionInfo	`-`	主要观看账号的配置信息。
SubViewingRestrictionInfo	Object of ViewingRestrictionInfo	`-`	次要观看账号的配置信息。

ViewingRestrictionInfo

参数类型示例值描述

参数	类型	示例值	描述
ViewingAccountType	Integer	`4`	观看账号的类型。 4：自定义
ViewingRestrictionButtonTitle	String	`自定义登录`	登录方式的按钮文案。
CustomViewingRestrictionInfo	Object of CustomViewingRestrictionInfo	`-`	自定义登录的配置信息。

ViewingAccountType

Integer

4

观看账号的类型。

4：自定义

ViewingRestrictionButtonTitle String 自定义登录 登录方式的按钮文案。

CustomViewingRestrictionInfo Object of CustomViewingRestrictionInfo - 自定义登录的配置信息。

CustomViewingRestrictionInfo

参数	类型	示例值	描述
CustomApp	String	`test`	登录账号 App。您的自有账号系统名称。
CustomUrl	String	`https://www.example.com`	登录链接。您的自有账号系统登录页面的链接。
SecretKey	String	`4446556644`	自定义登录的密钥。根据 `CustomApp` 和 `CustomUrl` 自动生成，用于计算校验签名（ `Sign` 值），计算方法详见回调参数。
ErrorRedirectUrl	String	`https://www.error.com`	自定义鉴权校验失败后，进入的鉴权校验失败页面的地址。该地址包含协议头。

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateActivityViewPermissionAPI&Version=2020-06-01
{
    "ActivityId":17678654498813,
    "ViewingRestriction":{
        "ViewingAccountType": 4,
        "ViewingRestrictionButtonTitle": "自定义登录",
        "CustomViewingRestriction": {
            "CustomApp":"test",
            "CustomUrl":"https://www.example.com",
            "ErrorRedirectUrl":"https://www.error.com"
        }
    },
    "IsSubViewingRestrictionEnable":true,
    "SubViewingRestriction":{
        "ViewingAccountType": 4,
        "ViewingRestrictionButtonTitle": "自定义登录2",
        "CustomViewingRestriction": {
            "CustomApp":"test2",
            "CustomUrl":"https://www.example2.com",
            "ErrorRedirectUrl":"https://www.error2.com"
        }
    }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230605205058E9BE7972A2C2C02C334F",
        "Action": "UpdateActivityViewPermissionAPI",
        "Version": "2020-06-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1685969459
    },
    "Result": {
        "ActivityId": 17678654498813,
        "ViewRestrictionInfo": {
            "ViewingAccountType": 4,
            "ViewRestrictionButtonTitle": "自定义登录",
            "CustomViewingRestrictionInfo": {
                "CustomApp": "test",
                "CustomUrl": "https://www.example.com",
                "SecretKey": "4446556644",
                "ErrorRedirectUrl": "https://www.error.com"
            }
        },
        "SubViewRestrictionInfo": {
            "ViewingAccountType": 4,
            "ViewRestrictionButtonTitle": "自定义登录2",
            "CustomViewingRestrictionInfo": {
                "CustomApp": "test2",
                "CustomUrl": "https://www.example2.com",
                "SecretKey": "rereereerr",
                "ErrorRedirectUrl": "https://www.error2.com"
            }
        }
    }
}

错误码

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

状态码	错误码	错误信息	说明
400	InvalidParameter.ActivityIDInvalid	The specified parameter ActivityID is invalid.	直播间 ID 不符合规范，请修改后重试。
400	InvalidParameter.ViewingAccountTypeInvalid	The specified parameter ViewingAccountType is invalid.	主要观看账号的配置信息不符合规范，请修改后重试。
400	InvalidParameter.SubViewingRestrictionInvalid	The specified parameter SubViewingRestrictionInvalid is invalid.	次要观看账号的配置信息不符合规范，请修改后重试。