全部产品
Search
文档中心

视频直播:添加截图回调配置

更新时间:Apr 28, 2024

调用AddLiveSnapshotNotifyConfig添加截图回调配置。

QPS限制

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

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String AddLiveSnapshotNotifyConfig

系统规定参数。取值:AddLiveSnapshotNotifyConfig

DomainName String www.yourdomain***.com

主播流域名。

NotifyUrl String http://callback.yourdomain***.com

回调URL,必须是合法URL,长度不超过500。

NotifyReqAuth String yes

回调鉴权开关。取值:

  • yes:开启。
  • no(默认):关闭。
说明 当填yes时NotifyAuthKey必填。
NotifyAuthKey String yourkey

回调鉴权密钥,长度为16~32个字符,只允许填大小写字母和数字。

说明 当NotifyReqAuth参数值为yes时该参数必填。

返回数据

名称

类型

示例值

描述

RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F3EC5

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=AddLiveSnapshotNotifyConfig
&DomainName=www.yourdomain***.com
&NotifyUrl=http://callback.yourdomain***.com
&NotifyReqAuth=yes
&NotifyAuthKey=yourkey
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<AddLiveSnapshotNotifyConfigResponse>
    <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F3EC5</RequestId>
</AddLiveSnapshotNotifyConfigResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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