tencent cloud

APIs

DokumentasiAPIsVideo on DemandEvent Notification APIsModifyEventConfig

ModifyEventConfig

Unduh
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-09-22 22:25:23

1. API Description

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

Tencent Cloud VOD provides customers with media upload, media management, media processing, and other services. During or after the execution of these services, Tencent Cloud VOD also provides various event notifications, allowing developers to sense the service processing status and perform the next business operation.

Developers can call this API to:

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: ModifyEventConfig.
Version Yes String Common Params. The value used for this API: 2018-07-17.
Region No String Common Params. This parameter is not required.
SubAppId No Integer

Video-on-demand (VOD) application ID. For customers who activate VOD services on or after December 25, 2023, when accessing resources in VOD applications (whether the default application or a newly created application), this field must be filled with the application ID.
Mode No String

Method of receiving event notifications.

  • PUSH: HTTP callback notification;
  • PULL: Reliable Notification Based on Message Queue.
    		•
    NotificationUrl No String

    Address for receiving 3.0 format callbacks when using HTTP callback notification as the receiving channel.
    Note: If the NotificationUrl parameter is included and its value is an empty string, the 3.0 format callback address will be cleared.
    UploadMediaCompleteEventSwitch No String

    Whether to receive video upload completed event notifications. Default "OFF" means the event notification is ignored, and "ON" means event notifications are received.
    DeleteMediaCompleteEventSwitch No String

    Whether to receive video deletion completed event notifications. Default "OFF" ignores the event notification, and "ON" receives event notifications.
    PersistenceCompleteEventSwitch No String

    Whether to receive event notifications for clip solidification completion. Default "OFF" means the event notification is ignored, and "ON" means it is received.
    SignKey No String

    Callback key, consisting of upper- and lower-case letters and numbers, up to 32 characters. After configuration, the Sign and T fields will be sent in callbacks for authentication.

    • Sign: string type. Event notification security signature Sign = MD5 (SignKey + T). Description: Tencent Cloud concatenates the encrypted SignKey and T, calculates the Sign value through MD5, and places it in the notification message. Upon receiving the notification message, your backend server can verify whether Sign is correct based on the same algorithm, and furthermore confirm whether the message indeed comes from Tencent Cloud Backend.
    • T: int64 type. Expiration time, UNIX timestamp of event notification signature expiration. The default expiration time for message notifications from Tencent is 10 minutes. If the time specified by the T value in a message notification has expired, the notification can be deemed invalid, thereby preventing network replay attacks. T is in decimal UNIX timestamp format, i.e., the seconds elapsed since January 1, 1970 (midnight UTC/GMT).

    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 Event Notification Info

    Input Example

    https://vod.intl.tencentcloudapi.com/?Action=ModifyEventConfig
&Mode=PUSH
&NotificationUrl=http://mydemo.com/receiveevent
&UploadMediaCompleteEventSwitch=ON
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
    }
}

    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 enabled.
    InternalError Internal error.
    InvalidParameter Parameter error.
    UnauthorizedOperation Unauthorized operation.
    Topik sebelumnya: DescribeEventConfigTopik selanjutnya: ConfirmEvents

    Bantuan dan Dukungan

    Apakah halaman ini membantu?

    masukan

    Search
      Enter keywords to search documentation