服务端 API 文档

微信小程序视频发布

最近更新时间:2021-05-18 08:10:48

我的收藏

1. 接口描述

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

将点播视频发布到微信小程序,供微信小程序播放器播放。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:WeChatMiniProgramPublish。
Version String 公共参数,本接口取值:2018-07-17。
Region String 公共参数,本接口不需要传递此参数。
FileId String 媒体文件 ID。
SourceDefinition Integer 发布视频所对应的转码模板 ID,为0代表原始视频。
SubAppId Integer 点播子应用 ID。如果要访问子应用中的资源,则将该字段填写为子应用 ID;否则无需填写该字段。

3. 输出参数

参数名称 类型 描述
TaskId String 任务 ID。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 发起小程序视频发布任务

对 fileId 为 5285485487985271487 的视频发起微信小程发布任务,且发布视频所对应的转码模板 ID 为 10。

输入示例

https://vod.tencentcloudapi.com/?Action=WeChatMiniProgramPublish
&FileId=5285485487985271487
&SourceDefinition=10
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3",
    "TaskId": "125xxx65-wechat-mini-program-publish-bffb15f07530b57bc1aabb01fac74bca"
  }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
FailedOperation.InvalidVodUser 没有开通点播业务。
FailedOperation.NoPrivileges 没有开通该接口使用权限。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.FileId FileId 不存在。
InvalidParameterValue.FileType 错误的视频类型。
InvalidParameterValue.SourceDefinition SourceDefinition 错误,请检查媒体文件是否有对应的转码。
InvalidParameterValue.SubAppId 参数值错误:子应用 ID。
ResourceNotFound.FileNotExist 资源不存在:文件不存在。
UnauthorizedOperation 未授权操作。
目录