互动白板设置白板推流回调地址-服务端 API-文档中心-腾讯云

1. 接口描述

接口请求域名： tiw.tencentcloudapi.com 。

设置白板推流回调地址，回调数据格式请参考文档：https://cloud.tencent.com/document/product/1137/40257

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：SetWhiteboardPushCallback。
Version	是	String	公共参数，本接口取值：2019-09-19。
Region	是	String	公共参数，详见产品支持的地域列表。
SdkAppId	是	Integer	客户的SdkAppId 示例值：1400000001
Callback	是	String	白板推流任务结果回调地址，如果传空字符串会删除原来的回调地址配置，回调地址仅支持 http或https协议，即回调地址以http://或https://开头。回调数据格式请参考文档：https://cloud.tencent.com/document/product/1137/40257 示例值：https://example.com/online/callback

参数名称	类型	描述
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

https://tiw.tencentcloudapi.com/?Action=SetWhiteboardPushCallback
&SdkAppId=1400000001
&Callback=https://example.com/online/callback
&<公共请求参数>

{
    "Response": {
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
    }
}

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
AuthFailure	CAM签名/鉴权错误。
InvalidParameter.BodyParameterTypeUnmatched	参数类型不匹配。
InvalidParameter.CallbackAddressFormatError	回调地址格式错误。
ResourceUnavailable.NotRegistered	未开通互动白板。
ResourceUnavailable.ServiceExpired	账户欠费或者互动白板服务已过期。
UnauthorizedOperation.SdkAppId	SdkAppId不存在或者SdkAppId与当前腾讯云账号不对应。