Domain name for API request: vod.intl.tencentcloudapi.com.
A maximum of 100 requests can be initiated per second for this API.
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: PullEvents. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-17. |
| Region | No | String | Common Params. This parameter is not required. |
| ExtInfo | No | String | Reserved field, used for special purposes. |
| SubAppId | No | Integer | VOD application ID. For customers who activate VOD services after December 25, 2023, when accessing resources in VOD applications (whether the default application or a newly created application), this field must be set to the app ID. |
| Parameter Name | Type | Description |
|---|---|---|
| EventSet | Array of EventContent | List of events. |
| 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. |
Pull an event
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: PullEvents
<Common request parameters>
{}{
"Response": {
"EventSet": [
{
"EventHandle": "EventHandle1",
"EventType": "ProcedureStateChanged",
"FileUploadEvent": null,
"ExtractCopyRightWatermarkCompleteEvent": null,
"QualityInspectCompleteEvent": null,
"ProcedureStateChangeEvent": {
"TaskId": "1256712345-Procedure-475b7237438a39560b9879a4556cb177t2",
"Status": "FINISH",
"FileId": "5285890784246869930",
"FileName": "small",
"FileUrl": "https://example.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"
},
"CopyRightWatermark": {
"Text": "copyRightxxx"
},
"MosaicSet": [],
"HeadTailSet": [],
"StartTimeOffset": 2,
"EndTimeOffset": 3
},
"Output": {
"Url": "http://example.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,
"AdaptiveDynamicStreamingTask": 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,
"QualityEnhanceCompleteEvent": null,
"PersistenceCompleteEvent": null,
"ComplexAdaptiveDynamicStreamingCompleteEvent": null
}
],
"RequestId": "5ca61a3a-6b8e-4b4e-9256-fdc001190064ef0"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
| InternalError | Internal error. |
| InvalidParameterValue | Parameter value error. |
| ResourceNotFound | The resource does not exist. |
| UnauthorizedOperation | Unauthorized operation. |
文档反馈