1. 接口描述
接口请求域名: trtc.tencentcloudapi.com 。
如果您需要在 云端混流转码 时频繁新增自定义背景图或水印,可通过此接口上传新的图片素材。无需频繁新增图片的场景,建议直接在 控制台 > 应用管理 > 素材管理 中操作。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreatePicture。 |
Version | 是 | String | 公共参数,本接口取值:2019-07-22。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou 。 |
SdkAppId | 是 | Integer | 应用id 示例值:1234567 |
Content | 是 | String | 图片内容经base64编码后的string格式,最大长度为2M 示例值:abcde |
Suffix | 是 | String | 图片后缀名 示例值:jpg |
Height | 是 | Integer | 图片长度 示例值:15 |
Width | 是 | Integer | 图片宽度 示例值:15 |
XPosition | 是 | Integer | 显示位置x轴方向 示例值:15 |
YPosition | 是 | Integer | 显示位置y轴方向 示例值:15 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
PictureId | Integer | 图片id 示例值:123 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 上传图片
上传图片
输入示例
https://trtc.tencentcloudapi.com/?Action=CreatePicture
&Content=test
&Suffix=jpg
&SdkAppId=123
&Height=12
&Width=15
&XPosition=15
&YPosition=36
&<公共请求参数>
输出示例
{
"Response": {
"PictureId": 1400297109,
"RequestId": "049461e6-f2f5-4168-887e-aca4fbfa5fae"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure.UnRealNameAuthenticated | 未完成实名认证,不允许此操作。 |
InternalError | 内部错误。 |
InternalError.DBError | 数据库查询异常。 |
InvalidParameter.CheckContentFailed | 图片过大。 |
InvalidParameter.CheckSuffixFailed | 后缀名校验失败。 |
InvalidParameter.SdkAppId | SdkAppId参数错误。 |
UnknownParameter | 未知参数错误。 |