You need to enable JavaScript to run this app.
最新活动
产品
解决方案
定价
生态与合作
支持与服务
开发者
了解我们
导航
企业直播
  • 文档首页
    • /
  • 企业直播

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

最近更新时间：2023.05.22 14:31:18

首次发布时间：2022.03.29 22:10:12

我的收藏

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

请求说明

  • 接口名称：UpdateCustomizationViewPermissionAPI
  • 请求方式：POST
  • 接口地址：http://livesaas.volcengineapi.com/?Action=UpdateCustomizationViewPermissionAPI&Version=2020-06-01
  • 请求频率：单用户请求频率限制为 120 次/分钟。

请求参数

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

Query

参数类型是否必选描述
ActionString是接口名称
VersionString是接口版本。直播当前 API 的版本为 2020-06-01

Body

参数类型是否必选描述
ActivityIdInt64是直播间 ID
CustomUrlString是自定义观看的登录链接。该链接需要包含协议头。
CustomAppString否自定义观看的 App 名称
ErrorRedirectUrlString否自定义鉴权校验失败后，进入的鉴权校验失败页面的地址。该地址需要包含协议头。默认跳转至企业直播的自定义鉴权校验失败页面。

返回参数

参数类型描述
SecretKeyString自定义登录的密钥

示例

请求示例

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" 
    }
}

异常返回示例

{
    "ResponseMetadata":{
        "RequestId":"201806041104200100100232280022D30",
        "Action":"UpdateCustomizationViewPermissionAPI",
        "Version":"2020-06-01",
        "Service":"livesaas",
        "Region":"cn-north-1",
        "SystemTime":1656067132,
        "Error":{
          "Code":"200000",
          "Message":"参数异常" 
        }
    }
}

错误码

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