tencent cloud

云点播

文档云点播服务端 API 文档Event Notification APIsModifyEventConfig

ModifyEventConfig

Download
聚焦模式
字号
最后更新时间： 2026-05-19 15:02:11

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 at the end of the execution of these services, Tencent Cloud On-Demand also provides various corresponding event notifications to facilitate developers to perceive the service processing status and Do the next business operation.

Developers can achieve this by calling this interface:

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

VOD application ID. Customers who activate on-demand services from December 25, 2023 must fill this field with the app ID when accessing resources in on-demand applications (whether default or newly created).
Mode No String

Method of receiving event notifications.

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

    When using the HTTP callback notification reception method, this is the address for receiving format callback 3.0.
    Note: If the NotificationUrl parameter is included with an empty string, the format callback 3.0 address will be cleared.
    UploadMediaCompleteEventSwitch No String

    Whether to receive video upload complete event notifications. The default "OFF" means the event notification is ignored, and "ON" means to receive event notifications.
    DeleteMediaCompleteEventSwitch No String

    Whether to receive video deletion completion event notification. Default "OFF" means the event notification is ignored, "ON" means receive event notifications.
    PersistenceCompleteEventSwitch No String

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

    Callback key, consisting of upper- and lower-case letters and numbers, with a maximum length of 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 calculates the Sign value by concatenating the encrypted SignKey and T and performing MD5 encryption, then places it in the notification message. Your backend server can verify whether the Sign is correct upon receiving the notification message using the same algorithm, thereby confirming whether the message is indeed from the Tencent Cloud backend.
    • T: int64 type. Expiration time, the UNIX timestamp when the event notification signature expires. Notifications from Tencent Cloud default to an expiration time of 10 minutes. If the time specified by the t value in a notification message has expired, the notification can be deemed invalid, preventing network replay attacks. The format of T is a decimal UNIX timestamp, representing 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 Set event notification information

    Input Example

    https://vod.intl.tencentcloudapi.com/?Action=ModifyEventConfig
&Mode=PUSH
&NotificationUrl=http://mydemo.com/receiveevent
&UploadMediaCompleteEventSwitch=ON
&<Public Request Parameter>

    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.
    上一篇: DescribeEventConfig下一篇: ConfirmEvents

    帮助和支持

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

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

    文档反馈