您可通过此接口更新指定直播间的以下观看限制配置信息:公开、密码、白名单、自定义、手机号。
请求频率:单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | UpdateViewingRestriction | 接口名称。当前 API 的名称为 UpdateViewingRestriction 。 |
Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
ActivityId | Long | 是 | 1770****81234 | 直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。 |
IsSubViewingRestrictionEnable | Boolean | 否 |
| 是否开启次观看限制。默认值为
|
ViewingRestriction | Object of ViewingRestriction | 是 | - | 主观看限制的配置信息。 |
SubViewingRestriction | Object of ViewingRestriction | 否 |
| 次观看限制的配置信息。 说明 仅在 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
ViewingAccountType | Integer | 是 |
| 观看限制。取值如下:
|
ViewingRestrictionButtonTitle | String | 否 |
| 观看按钮文案。长度为 1 到 12 个字符。默认为“观看限制 + 观看”,例如 说明 仅在 |
CommentRestriction | Object of CommentRestriction | 否 |
| 评论限制配置信息。 说明 仅在 |
PasswordViewingRestriction | Object of PasswordViewingRestriction | 否 |
| 密码观看限制配置信息。 说明 仅在 |
WhiteListViewingRestriction | Object of WhiteListViewingRestriction | 否 |
| 白名单观看限制配置信息。您可通过调用 InsertWhitelist 接口添加观众白名单。 说明 仅在 |
CustomViewingRestriction | Object of CustomViewingRestriction | 否 |
| 自定义观看限制配置信息。 说明 仅在 |
PhoneViewingRestriction | Object of PhoneViewingRestriction | 否 |
| 手机号观看限制配置信息。 说明 仅在 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
IsAllowPublic | Boolean | 否 |
| 评论限制是否为公开。默认值为
说明
|
IsAllowWechat | Boolean | 否 |
| 评论限制是否为微信。默认值为
说明
|
IsAllowCustom | Boolean | 否 |
| 评论限制是否为自定义。默认值为
说明
|
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Password | String | 是 |
| 观看密码。长度为 4 到 12 个字符。支持以下字符:
|
Prompt | String | 否 | 欢迎观看本场直播 | 提示文案。长度为 1 到 20 个字符。默认值为欢迎观看本场直播 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
WelcomeTitle | String | 否 | 欢迎观看本场直播 | 欢迎标题。长度为 1 到 20 个字符。默认值为欢迎观看本场直播 。 |
InputPrompt | String | 否 | 请输入校验信息 | 输入提示。长度为 1 到 20 个字符。默认值为请输入校验信息 。 |
EnableTrial | Boolean | 否 |
| 是否开启试看功能。默认值为
|
TrialTime | Integer | 否 |
| 试看时间。默认值为
说明 仅在 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
CustomApp | String | 是 | App A | 登录账号 App,即您自有账号系统的名称。 |
CustomUrl | String | 是 | http://myDomain/auth | 登录链接,即您的自有账号系统登录页面的链接。链接需包含协议头。 |
ErrorRedirectUrl | String | 否 | http://myDomain/auth?error=1 | 错误重定向地址,即自定义鉴权校验失败后,进入的鉴权校验失败页面的地址。长度为 1 到 256 个字符。链接需包含协议头。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Prompt | String | 否 | 欢迎观看本场直播 | 提示文案。默认值为欢迎观看本场直播 。 |
IsPhoneListMode | Boolean | 否 |
| 是否开启白名单模式功能。默认值为
说明 将参数值设置为 |
EnableSMS | Boolean | 否 |
| 是否开启短信提醒功能。默认值为
|
EnableTrial | Boolean | 否 |
| 是否开启试看功能。默认值为
|
TrialTime | Integer | 否 |
| 试看时间。默认值为
说明 仅在 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
ActivityId | Long | 1770****81234 | 直播间 ID。 |
ViewingRestriction | Object of ViewingRestriction | - | 主观看限制的配置信息。 |
SubViewingRestriction | Object of ViewingRestriction |
| 次观看限制的配置信息。 说明 仅在 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
ViewingAccountType | Integer |
| 观看限制。取值如下:
|
ViewingRestrictionButtonTitle | String |
| 观看按钮文案。 说明 仅在 |
CommentRestriction | Object of CommentRestriction |
| 评论限制配置信息。 说明 仅在 |
PasswordViewingRestriction | Object of PasswordViewingRestriction |
| 密码观看限制配置信息。 说明 仅在 |
WhiteListViewingRestriction | Object of WhiteListViewingRestriction |
| 白名单观看限制配置信息。 说明 仅在 |
CustomViewingRestriction | Object of CustomViewingRestriction |
| 自定义观看限制配置信息。 说明 仅在 |
PhoneViewingRestriction | Object of PhoneViewingRestriction |
| 手机号观看限制配置信息。 说明 仅在 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
IsAllowPublic | Boolean |
| 评论限制是否为公开。取值如下:
说明 该参数取值为 |
IsAllowWechat | Boolean |
| 评论限制是否为微信。取值如下:
|
IsAllowCustom | Boolean |
| 评论限制是否为自定义。取值如下:
说明 该参数取值为 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Password | String | 123456 | 观看密码。 |
Prompt | String | 欢迎观看本场直播 | 提示文案。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
WelcomeTitle | String | 欢迎观看本场直播 | 欢迎标题。 |
InputPrompt | String | 请输入校验信息 | 输入提示。 |
EnableTrial | Boolean |
| 是否开启试看功能。取值如下:
|
TrialTime | Integer |
| 试看时间。单位为分钟。 说明 当 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
CustomApp | String | App A | 登录账号 App,即您自有账号系统的名称。 |
CustomUrl | String | http://myDomain/auth | 登录链接,即您的自有账号系统登录页面的链接。链接包含协议头。 |
ErrorRedirectUrl | String | http://myDomain/auth?error=1 | 错误重定向地址,即自定义鉴权校验失败后,进入的鉴权校验失败页面的地址。链接包含协议头。 |
SecretKey | String | /u/hii/:na | Secret Key,用于计算校验签名(Sign 值),计算方法详见回调参数。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Prompt | String | 欢迎观看本场直播 | 提示文案。 |
IsPhoneListMode | Boolean |
| 是否开启白名单模式功能。取值如下:
|
EnableTrial | Boolean |
| 是否开启试看功能。取值如下:
|
TrialTime | Integer |
| 试看时间。单位为分钟。 说明 当 |
EnableSMS | Boolean |
| 是否开启短信提醒功能。取值如下:
|
POST https://livesaas.volcengineapi.com/?Action=UpdateViewingRestriction&Version=2023-08-01 { "ActivityId": 1770****81234, "IsSubViewingRestrictionEnable": true, "ViewingRestriction": { "ViewingAccountType": 1, "ViewingRestrictionButtonTitle": "公开观看", "CommentRestriction": { "IsAllowPublic": true, "IsAllowWechat": true, "IsAllowCustom": false }, "PasswordViewingRestriction": { "Password": "", "Prompt": "" }, "WhitelistViewingRestriction": { "WelcomeTitle": "", "InputPrompt": "", "EnableTrial": false, "TrialTime": 0 }, "CustomViewingRestriction": { "CustomApp": "", "CustomUrl": "", "ErrorRedirectUrl": "" }, "PhoneViewingRestriction": { "Prompt": "", "EnableTrial": false, "TrialTime": 0, "EnableSMS": false, "IsPhoneListMode": false } }, "SubViewingRestriction": { "ViewingAccountType": 2, "ViewingRestrictionButtonTitle": "密码观看", "CommentRestriction": { "IsAllowPublic": false, "IsAllowWechat": true, "IsAllowCustom": true }, "PasswordViewingRestriction": { "Password": "123456", "Prompt": "欢迎观看本场直播" }, "WhitelistViewingRestriction": { "WelcomeTitle": "", "InputPrompt": "", "EnableTrial": false, "TrialTime": 0 }, "CustomViewingRestriction": { "CustomApp": "App A", "CustomUrl": "http://myDomain/auth", "ErrorRedirectUrl": "http://myDomain/auth?error=1" }, "PhoneViewingRestriction": { "Prompt": "", "EnableTrial": false, "TrialTime": 0, "EnableSMS": false, "IsPhoneListMode": false } } }
{ "ResponseMetadata": { "Action": "UpdateViewingRestriction", "Region": "cn-north-1", "RequestId": "202303101311****AEE6215ADC71105DF5", "Service": "livesaas", "Version": "2023-08-01", "SystemTime": 1685969459 }, "Result": { "ActivityId": 1770****81234, "ViewingRestriction": { "ViewingAccountType": 1, "ViewingRestrictionButtonTitle": "公开观看", "CommentRestriction": { "IsAllowPublic": true, "IsAllowWechat": true, "IsAllowCustom": false }, "PasswordViewingRestriction": { "Password": "", "Prompt": "" }, "WhitelistViewingRestriction": { "WelcomeTitle": "", "InputPrompt": "", "EnableTrial": false, "TrialTime": 0 }, "CustomViewingRestriction": { "CustomApp": "", "CustomUrl": "", "ErrorRedirectUrl": "", "SecretKey": "" }, "PhoneViewingRestriction": { "Prompt": "", "EnableTrial": false, "TrialTime": 0, "EnableSMS": false, "IsPhoneListMode": false } }, "SubViewingRestriction": { "ViewingAccountType": 2, "ViewingRestrictionButtonTitle": "密码观看", "CommentRestriction": { "IsAllowPublic": false, "IsAllowWechat": true, "IsAllowCustom": true }, "PasswordViewingRestriction": { "Password": "123456", "Prompt": "欢迎观看本场直播" }, "WhitelistViewingRestriction": { "WelcomeTitle": "", "InputPrompt": "", "EnableTrial": false, "TrialTime": 0 }, "CustomViewingRestriction": { "CustomApp": "App A", "CustomUrl": "http://myDomain/auth", "ErrorRedirectUrl": "http://myDomain/auth?error=1", "SecretKey": "/u/hii/:na" }, "PhoneViewingRestriction": { "Prompt": "", "EnableTrial": false, "TrialTime": 0, "EnableSMS": false, "IsPhoneListMode": false } } } }