Help Center> Media Processing Center> User Guide> Configuring Event Notifications
Updated on 2022-03-17 GMT+08:00

Configuring Event Notifications

You can configure event notifications before submitting a media processing task. Once the task is executed, you will receive notifications on the event you subscribe to. This function depends on the SMN service. Therefore, SMN charges you based on the number of notification messages. For details about the price, see SMN Pricing Details.

Creating an SMN Topic

  1. Log in to the SMN console. In the navigation pane, choose Topic Management > Topics. The Topics page is displayed.
  2. Click Create Topic in the upper right corner.
  3. In the displayed dialog box, configure topic information by referring to Table 1. Click OK.

    Table 1 Topic parameters

    Parameter

    Description

    Topic Name

    • This parameter is mandatory.
    • A topic name can include only letters, digits, hyphens (-), and underscores (_) and must start with a letter or digit.
    • Length: 1–256 characters

    Display Name

    This parameter is optional. When sending an email:

    • If the display name is not set, the sender is displayed as username@example.com.
    • Otherwise, the email sender is presented as Display name<username@example.com>.

    Tag

    Identifies cloud resources. This parameter is optional.

  4. Click Add Subscription in the Operation column.
  5. Configure the subscription protocol and endpoints. See Figure 1.

    Figure 1 Adding a subscription

    Table 2 describes the subscription parameters.

    Table 2 Subscription parameters

    Parameter

    Description

    Topic Name

    Name of the topic to be subscribed to. Retain the default value.

    Protocol

    Message notification method. Select a protocol from the drop-down list.

    The common protocols used by MPC are SMS, email, and HTTP/HTTPS.

    Endpoint

    Subscription endpoint. You can enter up to 10 SMS, email, HTTP, or HTTPS endpoints, one in each line.

    • SMS: Enter one or more valid phone numbers.

      The phone number must be preceded by a plus sign (+) and a country code.

      Examples:

      +8600000000000

      +8600000000001

    • Email: Enter one or more valid email addresses.

      Examples:

      username@example.com

      username2@example.com

    • HTTP or HTTPS: Enter one or more public network URLs.

      Examples:

      http://example.com/notification/action

      http://example2.com/notification/action

  6. Receive a subscription confirmation message and confirm subscription. If the subscription endpoint is an email address, the page shown in Figure 2 is displayed. Then, the subscription endpoints can receive messages published to the topic.

    Figure 2 Message subscription confirmation

Configuring a Topic Policy

  1. In the navigation pane of the SMN console, choose Topic Management > Topics.
  2. Click More > Configure Topic Policy in the Operation column.
  3. Configure topic policy parameters. See Figure 3.

    Figure 3 Configuring a topic policy

    Topic policies are classified into basic mode and advanced mode. The basic mode simply specifies which users or cloud services have permissions to publish messages to a topic. See Figure 3.

    Table 3 Description for configuring topic policies in basic mode

    Parameter

    Settings

    Description

    Users who can publish messages to this topic

    Topic creator

    Only the topic creator has the permission to publish messages to the topic.

    All users

    All users have the permission to publish messages to the topic.

    Specified user accounts

    Only specified users have the permission to publish messages to the topic.

    Users are specified in the format of urn:csp:iam::domainId:root, in which domainId indicates the account ID of a user.

    Every two users are separated with a comma (,). SMN does not limit the number of users you can specify, but the total length of a topic policy cannot exceed 30 KB.
    NOTE:
    • Enter the account ID of the user and click OK.Other information is automatically supplemented by the system.
    • To obtain a user's account ID, log in to the SMN console, hover the mouse over the username in the upper right corner and choose My Credentials from the drop-down list.

    Services that can publish messages to this topic

    See Figure 3.

    Select MPC. MPC has the permissions to access the topic.

Configuring Event Notifications

  1. Log in to the MPC console.
  2. In the navigation pane, choose Global Settings > Event Notifications.

  3. Select one or more events.
  4. Select one or more message types.

    Template Message Body describes a template message body. JSON Message Body describes the fields in a JSON message body.

    If Template message and JSON message are both selected, you will receive template messages via SMS and email, and receive JSON messages via HTTP and HTTPS.

  5. Select an SMN topic.
  6. Click OK.

Template Message Body

  • The following is an example of a template message used for transcoding started:
    Dear user, your video transcoding task (task ID: {task_id}) has been started. Log in to the MPC console or call the transcoding API to obtain transcoding details.
  • The following is an example of a template message used for a successful transcoding, snapshot, packaging, and animated GIF task:
    Dear user, your video {transcoding/snapshot/packaging/animated GIF/parsing} task (task ID: {task_id}) has been completed. Log in to the MPC console or call the transcoding API to obtain details.
  • The following is an example of a template message used for a failed transcoding, snapshot, packaging, and animated GIF task:
    Dear user, an error occurs when processing your video {transcoding/snapshot/packaging/animated GIF/parsing} task (task ID: {task_id}). Error code: {err_code}. Error information: {err_msg}.