云点播微信小程序视频发布-媒体处理相关接口-API 中心-腾讯云

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。示例值：5285485487985271487
SubAppId	否	Integer	点播应用 ID。从2023年12月25日起开通点播的客户，如访问点播应用中的资源（无论是默认应用还是新创建的应用），必须将该字段填写为应用 ID。示例值：125
SourceDefinition	否	Integer	发布视频所对应的转码模板 ID，为0代表原始视频。示例值：10

3. 输出参数

参数名称	类型	描述
TaskId	String	任务 ID。示例值：125xxx65-wechat-mini-program-publish-bffb15
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

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

输入示例

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

输出示例

{
    "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。

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

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

微信小程序视频发布

本页目录：