PrevNext
search by keyword

Recent Pages

Documentation
Video on Demand
    Documentation
    Download PDF

    WeChatMiniProgramPublish

    Last updated: 2021-06-15 19:03:47
    Download PDF

    1. API Description

    Domain name for API request: vod.tencentcloudapi.com.

    This API is used to publish a VOD video on WeChat Mini Program for playback in the WeChat Mini Program player.

    A maximum of 100 requests can be initiated per second for this API.

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

    Parameter Name Required Type Description
    Action Yes String Common parameter. The value used for this API: WeChatMiniProgramPublish.
    Version Yes String Common parameter. The value used for this API: 2018-07-17.
    Region No String Common parameter. This parameter is not required for this API.
    FileId Yes String Media file ID.
    SourceDefinition No Integer ID of the transcoding template corresponding to the published video. 0 represents the source video.
    SubAppId No Integer Subapplication ID in VOD. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty.

    3. Output Parameters

    Parameter Name Type Description
    TaskId String Task ID.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Initiating a WeChat Mini Program publishing task

    This example shows you how to initiate a WeChat Mini Program publishing task for a video (fileId: 5285485487985271487) by using a transcoding template (ID: 10).

    Input Example

    https://vod.tencentcloudapi.com/?Action=WeChatMiniProgramPublish
&FileId=5285485487985271487
&SourceDefinition=10
&<Common request parameters>

    Output Example

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

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    FailedOperation Operation failed.
    FailedOperation.InvalidVodUser The VOD service is not activated.
    FailedOperation.NoPrivileges No permission to use this API.
    InternalError Internal error.
    InvalidParameter Invalid parameter.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.FileId The FileId does not exist.
    InvalidParameterValue.FileType Incorrect video type.
    InvalidParameterValue.SourceDefinition Incorrect SourceDefinition. Please check whether the media file is bound with a transcoding template.
    InvalidParameterValue.SubAppId Incorrect parameter value: subapplication ID
    ResourceNotFound.FileNotExist The resource does not exist: the file does not exist.
    UnauthorizedOperation Unauthorized operation.
    tencent
    Copyright © 2013-2021 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy