有奖:语音产品征文挑战赛火热进行中> HOT
文档中心 > API 中心 > 互动白板 > 其他接口 > 修改白板应用任务相关配置

1. 接口描述

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

修改白板应用任务相关的配置,包括存储桶、回调等

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyWhiteboardApplicationConfig。
Version String 公共参数,本接口取值:2019-09-19。
Region String 公共参数,详见产品支持的 地域列表
SdkAppId Integer 客户的SdkAppId
示例值:1400000001
Configs.N Array of WhiteboardApplicationConfig 白板应用任务相关配置

3. 输出参数

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

4. 示例

示例1 修改白板应用任务相关配置

输入示例

POST / HTTP/1.1
Host: tiw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyWhiteboardApplicationConfig
<公共请求参数>

{
    "Configs": [
        {
            "AdminUserId": "abcde",
            "BucketPrefix": "doc",
            "ResultDomain": "result.sample.com",
            "AdminUserSig": "abcde",
            "Callback": "http://www.example.com/callback",
            "BucketName": "test-120000001",
            "SdkAppId": 1400000001,
            "TaskType": "recording",
            "BucketLocation": "ap-guangzhou",
            "CallbackKey": "abcde"
        }
    ],
    "SdkAppId": 1400000001
}

输出示例

{
    "Response": {
        "RequestId": "d290f1ee-6c54-4b01-90e6-d701748f0851"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
FailedOperation.CosBucketInvalid COS桶无效,可能不存在或者未授权。
FailedOperation.GetCredentialFail 获取临时密钥失败。
InvalidParameter 参数错误。
InvalidParameter.BodyParameterTypeUnmatched 参数类型不匹配。
InvalidParameter.CallbackAddressFormatError 回调地址格式错误。
InvalidParameter.CdnDomainNotFound 未找到当前CDN域名。
InvalidParameter.InvalidTaskType 设置应用配置任务类型不支持。
InvalidParameter.SdkAppIdNotFound SdkAppId不存在或格式错误。
InvalidParameter.UnmarshalJSONBodyFail 解析JSON失败,可能参数数据类型不匹配。
ResourceUnavailable.NotRegistered 未开通互动白板。
ResourceUnavailable.ServiceExpired 账户欠费或者互动白板服务已过期。
UnauthorizedOperation.SdkAppId SdkAppId不存在或者SdkAppId与当前腾讯云账号不对应。