tencent cloud

云点播

ModifyEventConfig

下载
聚焦模式
字号
最后更新时间: 2026-09-18 15:59:56

1. API Description

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

Tencent Cloud Video on Demand (VOD) provides customers with media upload, media management, media processing, and other services. During or after these services are executed, VOD also offers various event notifications, helping developers detect service processing status and perform the next business operation.

Developers can call this interface to achieve the following:

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

On-demand application ID. For customers who activate on-demand services from December 25, 2023, this field must be filled in with the app ID when accessing resources in on-demand applications, whether it is the default application or a newly created application.

Mode No String

Method of receiving event notifications.

  • PUSH: HTTP callback notification;
  • PULL: Reliable notification based on message queue.
  • NotificationUrl No String

    When using HTTP callback notification as the receiving channel, this is the address for receiving 3.0 format callbacks.
    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 complete event notifications. Default "OFF" ignores the event notification, and "ON" receives event notifications.

    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" ignores the event notification, and "ON" receives event notifications.

    SignKey No String

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

    • Sign: string. 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. Expiration time, the UNIX timestamp when the event notification signature expires. The default expiration time for notifications from Tencent Cloud is 10 minutes. If the time specified by the T value in a message notification has expired, deem this notification invalid, and furthermore prevent network replay attacks. T is in decimal UNIX timestamp format, that is, 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 activated.
    InternalError Internal error.
    InvalidParameter Parameter error.
    UnauthorizedOperation Unauthorized operation.

    帮助和支持

    本页内容是否解决了您的问题?

    填写满意度调查问卷,共创更好文档体验。

    文档反馈