tencent cloud

All product documents
APIs
DocumentationAPIsTencent Interactive WhiteboardRecording Video Generation APIsSetVideoGenerationTaskCallback
SetVideoGenerationTaskCallback
Last updated: 2024-11-26 18:56:30
SetVideoGenerationTaskCallback
Last updated: 2024-11-26 18:56:30

1. API Description

Domain name for API request: tiw.intl.tencentcloudapi.com.

This API is used to set the callback URL for recording video generation.

A maximum of 20 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 Params. The value used for this API: SetVideoGenerationTaskCallback.
Version Yes String Common Params. The value used for this API: 2019-09-19.
Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-singapore.
SdkAppId Yes Integer SdkAppId of the whiteboard application.
Callback Yes String Callback URL of the offline recording task result. If it is specified as null, the set callback URL is deleted. The callback URL only supports the HTTP or HTTPS protocol, and therefore the callback URL must start with http:// or https://.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Setting the callback URL for recording video generation

Input Example

https://tiw.intl.tencentcloudapi.com/?Action=SetVideoGenerationTaskCallback
&SdkAppId=1400000001
&Callback=https://example.com/videoGeneration/callback
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
    }
}

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
AuthFailure
InvalidParameter.BodyParameterTypeUnmatched The parameter type does not match.
InvalidParameter.CallbackAddressFormatError The callback address format is invalid.
ResourceUnavailable.NotRegistered TIW is not enabled.
ResourceUnavailable.ServiceExpired The account is in arrears or the TIW service has expired.
UnauthorizedOperation.SdkAppId The SdkAppId does not exist or does not match the current Tencent Cloud account.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support