调用SetSnapshotCallbackAuth设置截图回调鉴权配置。

使用说明

设置截图回调鉴权前,需要配置截图回调URL,回调URL配置,请参见添加直播截图配置

本接口支持主播流域名配置截图回调鉴权,调用时请保证参数设置符合要求。

QPS限制

本接口的单用户QPS限制为30次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String SetSnapshotCallbackAuth

系统规定参数。取值:SetSnapshotCallbackAuth

CallbackAuthKey String yourkey

自定义回调鉴权密钥。

CallbackReqAuth String yes

回调鉴权开关。取值:

  • yes:开启。
  • no:关闭。
DomainName String example.aliyundoc.com

主播流域名。

返回数据

名称 类型 示例值 描述
RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F4CD5

请求ID。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=SetSnapshotCallbackAuth
&CallbackAuthKey=yourkey
&CallbackReqAuth=yes
&DomainName=example.aliyundoc.com
&<公共请求参数>

正常返回示例

XML格式

<SetSnapshotCallbackAuthResponse> 
  <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD5</RequestId>
</SetSnapshotCallbackAuthResponse>

JSON格式

{
    "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD5"
}

错误码

访问错误中心查看更多错误码。