修改直播间观看限制/评论限制中自定义观看的登录链接--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

修改直播间观看限制/评论限制中自定义观看的登录链接

最近更新时间：2023.10.11 17:59:06首次发布时间：2022.03.29 22:10:12

修改直播间观看限制和评论限制中自定义观看的登录链接。

注意事项

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

请求说明

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

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共请求参数。

Query

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

Body

参数	类型	是否必选	示例值	描述
ActivityId	Long	是	`123`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。
CustomUrl	String	是	`https://www.example.com`	自定义观看的登录链接。该链接需要包含协议头。
CustomApp	String	否	`test`	自定义观看的 App 名称。
ErrorRedirectUrl	String	否	`https://www.error.com`	自定义鉴权校验失败后，进入的鉴权校验失败页面的地址。该地址需要包含协议头。默认跳转至企业直播的自定义鉴权校验失败页面。

返回参数

参数	类型	示例值	描述
SecretKey	String	`qwdqa`	自定义登录的密钥。

示例

请求示例

POST http://livesaas.volcengineapi.com/?Action=UpdateCustomizationViewPermissionAPI&Version=2020-06-01
{
  "ActivityId": 123,
  "CustomUrl": "https://www.example.com",
  "CustomApp": "test",
  "ErrorRedirectUrl": "https://www.error.com"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "201806041104200100100232280022D30",
    "Action": "UpdateCustomizationViewPermissionAPI",
    "Version": "2020-06-01",
    "Service": "livesaas",
    "Region": "cn-north-1",
    "SystemTime": 1656067132
  },
  "Result": {
    "SecretKey": "qwdqa"
  }
}

错误码

访问公共错误码获取详细信息。