tencent cloud

1. API Description

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

• This API is used to get event notifications from the business server through reliable callback.
• The API gets event data through long polling. That is, if there is any unconsumed event on the server, the event notification will be returned to the requester immediately. If there is no unconsumed event on the server, the request will be suspended in the backend until a new event is generated.
• The request can be suspended for up to 5 seconds. It's recommended to set the request timeout period to 10 seconds.
• Event notifications not pulled will be retained for up to 4 days and may be cleared after this period.
• After the API returns an event, the caller must call the ConfirmEvents API within 30 seconds to confirm that the event notification has been processed. Otherwise, the event notification will be pulled again after 30 seconds.
• This API can get up to 16 event notifications at a time.

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

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.

3. Output Parameters

4. Example

Example1 Pull events

Pull events

Input Example

POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: PullEvents
<Public Request Parameter>

{}

Output Example

{
    "Response": {
        "EventSet": [
            {
                "EventHandle": "EventHandle1",
                "EventType": "ProcedureStateChanged",
                "FileUploadEvent": null,
                "ExtractCopyRightWatermarkCompleteEvent": null,
                "QualityInspectCompleteEvent": null,
                "ProcedureStateChangeEvent": {
                    "TaskId": "1256712345-Procedure-475b7237438a39560b9879a4556cb177t2",
                    "Status": "FINISH",
                    "ErrCode": 0,
                    "Message": "",
                    "FileId": "5285890784246869930",
                    "FileName": "small",
                    "FileUrl": "https://123.vod2.myqcloud.com/d042887avodtransgzp1256768367/c643347c5285890784246869930/1546950643_4191274987.100_0.jpg",
                    "SessionContext": "",
                    "SessionId": "",
                    "OperationType": "",
                    "TasksNotifyMode": "Finish",
                    "TasksPriority": 0,
                    "Operator": "",
                    "MetaData": {
                        "AudioDuration": 59.990001678467,
                        "AudioStreamSet": [
                            {
                                "Bitrate": 383854,
                                "Codec": "aac",
                                "SamplingRate": 48000
                            }
                        ],
                        "Md5": "07d635581e7f295b623f40bad0fbfd4c1",
                        "Bitrate": 1021028,
                        "Container": "mov,mp4,m4a,3gp,3g2,mj2",
                        "Duration": 60,
                        "Height": 480,
                        "Rotate": 0,
                        "Size": 7700180,
                        "VideoDuration": 60,
                        "VideoStreamSet": [
                            {
                                "Bitrate": 637174,
                                "Codec": "h264",
                                "CodecTag": "",
                                "Fps": 23,
                                "Height": 480,
                                "Width": 640,
                                "DynamicRangeInfo": {
                                    "HDRType": "",
                                    "Type": "SDR"
                                }
                            }
                        ],
                        "Width": 640
                    },
                    "MediaProcessResultSet": [
                        {
                            "Type": "Transcode",
                            "TranscodeTask": {
                                "Status": "SUCCESS",
                                "ErrCode": 0,
                                "ErrCodeExt": "",
                                "Message": "SUCCESS",
                                "Progress": 100,
                                "BeginProcessTime": "2023-09-08T02:23:29Z",
                                "FinishTime": "2023-09-08T03:23:29Z",
                                "Input": {
                                    "Definition": 20,
                                    "WatermarkSet": [],
                                    "TraceWatermark": {
                                        "Switch": "ON",
                                        "Definition": 1
                                    },
                                    "CopyRightWatermark": {
                                        "Text": "copyRightxxx"
                                    },
                                    "MosaicSet": [],
                                    "HeadTailSet": [],
                                    "StartTimeOffset": 2,
                                    "EndTimeOffset": 3
                                },
                                "Output": {
                                    "Url": "http://123.vod2.myqcloud.com/d042887avodtransgzp1256768367/c643347c5285890784246869930/v.f20.mp4",
                                    "Size": 4189073,
                                    "Container": "mov,mp4,m4a,3gp,3g2,mj2",
                                    "Height": 480,
                                    "Width": 640,
                                    "Bitrate": 552218,
                                    "Md5": "eff7031ad7877865f9a3240e9ab165ad",
                                    "Duration": 60.04700088501,
                                    "VideoStreamSet": [
                                        {
                                            "Bitrate": 503727,
                                            "Codec": "h264",
                                            "CodecTag": "",
                                            "Fps": 24,
                                            "Height": 480,
                                            "Width": 640,
                                            "DynamicRangeInfo": {
                                                "HDRType": "",
                                                "Type": "SDR"
                                            }
                                        }
                                    ],
                                    "AudioStreamSet": [
                                        {
                                            "Bitrate": 48491,
                                            "Codec": "aac",
                                            "SamplingRate": 44100
                                        }
                                    ],
                                    "Definition": 0,
                                    "DigitalWatermarkType": "None",
                                    "CopyRightWatermarkText": ""
                                }
                            },
                            "AnimatedGraphicTask": null,
                            "SnapshotByTimeOffsetTask": null,
                            "SampleSnapshotTask": null,
                            "ImageSpriteTask": null,
                            "CoverBySnapshotTask": null
                        }
                    ],
                    "AiContentReviewResultSet": [],
                    "AiAnalysisResultSet": [],
                    "AiRecognitionResultSet": []
                },
                "FileDeleteEvent": null,
                "PullCompleteEvent": null,
                "EditMediaCompleteEvent": null,
                "SplitMediaCompleteEvent": null,
                "ComposeMediaCompleteEvent": null,
                "WechatPublishCompleteEvent": null,
                "TranscodeCompleteEvent": null,
                "ConcatCompleteEvent": null,
                "ClipCompleteEvent": null,
                "CreateImageSpriteCompleteEvent": null,
                "SnapshotByTimeOffsetCompleteEvent": null,
                "WechatMiniProgramPublishCompleteEvent": null,
                "RemoveWatermarkCompleteEvent": null,
                "RestoreMediaCompleteEvent": null,
                "RebuildMediaCompleteEvent": null,
                "ExtractTraceWatermarkCompleteEvent": null,
                "ReviewAudioVideoCompleteEvent": null,
                "DescribeFileAttributesCompleteEvent": null,
                "ReduceMediaBitrateCompleteEvent": null
            }
        ],
        "RequestId": "5ca61a3a-6b8e-4b4e-9256-fdc001190064ef0"
    }
}

5. Developer Resources

SDK

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

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for Node.js
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++

Command Line Interface

• Tencent Cloud CLI 3.0

6. Error Code

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