Help Center> Video On Demand> User Guide> Global Settings> Notifications> MFS
Updated on 2023-10-16 GMT+08:00
View PDF

MFS

If MFS is used, message notifications are free of charge.

MFS is not supported in CN North-Beijing1 and CN East-Shanghai2.

Configuring Notifications

  1. Log in to the VOD console.
  2. In the navigation pane, choose Global Settings > Notification Settings.

    1. Select desired events and enter the callback address.
    2. (Optional) If authentication is required, click Generate to generate an authentication key.
      MFS Notification Authentication Process shows the message notification authentication process.
      Figure 1 Configuring notifications
    MFS supports only REST messages. For details about the JSON message template, see Table 1.
    Table 1 JSON message

    Parameter

    Description

    Type

    event_type

    Event type. The options are as follows:

    • transcodeComplete: transcoding (encryption) completed
    • thumbnailComplete: snapshot captured
    • reviewComplete: review completed
    • createComplete: media file created
    • audioExtractComplete: audio extracted
    • coverComplete: thumbnail created
    • parseComplete: media file parsed

    String

    transcode_info

    Transcoding (including encryption) message. For details, see Transcoding Message Body.

    TranscodeInfo

    thumbnail_info

    Snapshot message. For details, see Snapshot Message Body.

    ThumbnailInfo

    review_info

    Review message. For details, see Review Message Body.

    ReviewInfo

    create_info

    Media file upload message. For details, see Media Upload and Audio Extraction Message Body.

    AssetInfo

    audio_extract_info

    Audio extraction message. For details, see Media Upload and Audio Extraction Message Body.

    AssetInfo

    cover_info

    Thumbnail message. For details, see Thumbnail Message Body.

    CoverInfo

    parse_info

    Media file parsing completion message. This parameter is available only when a media file has been parsed. For details, see Media File Parsing Message Body.

    ParseInfo

  3. Click OK.

MFS Notification Authentication Process

  1. VOD generates a timestamp based on the current time and uses the key configured in 2.b to calculate the signature string using HmacSHA256(VOD_{timestamp}_{body}, key).

    The signature string and timestamp are sent to the device in the HTTP message header, which is header[auth_sign] and header[auth_timestamp], respectively. In the preceding information, body indicates the message attribute in the message body.

  2. After receiving the response, the customer combines strings in the VOD_{timestamp}_{body} format and uses the key in the message header to check whether the signature string generated in HmacSHA256(VOD_{timestamp}_{body}, key) is the same as that in the message header. If they are the same, the authentication is successful.
Parent topic: Notifications