Stream Status Notifications

Notes

After stream status notifications are enabled, you will receive a message each time when a livestream is pushed or disconnected. However, when a stream is disconnected soon after it was pushed, the server may receive the message on stream disconnection before receiving the message on stream push due to network transmission latency. In this case, you need to check the Unix timestamp parameter publish_timestamp in the message to check whether the stream push and stream disconnection are in the same stream push event. The timestamps generated for the stream push and stream disconnection of the same stream push event are the same.

Prerequisites

• You have added an ingest domain name.
• You have configured CNAME records at your domain names' DNS provider.

Adding a Notification URL

1. Log in to the Live console.
2. In the navigation pane, choose Domains.
3. Click Manage in the Operation column of the desired ingest domain name.
4. In the navigation pane, choose Template > Stream Status Notifications.
5. Click Add. In the Configure Notification Template dialog box displayed on the right, add the URL for receiving stream start and stop notifications, as shown in Figure 1.
   Table 1 describes the parameters.

   Figure 1 Adding a notification URL
   

   Table 1 Parameters

   Parameter	Description
   Protocol	A notification URL supports HTTP and HTTPS. HTTPS is more secure than HTTP and is recommended.
   Notification URL	Only HTTP and HTTPS URLs are supported.
   Authentication Key (Optional)	Authentication key. You need to configure this parameter only when notification authentication is required. A key contains 32 to 128 characters. A key can also be automatically generated.

6. Click OK.

   When stream push starts or ends, you will receive a notification message. For details about the notification message body, see Callback Example.

Managing Notification URLs

You can also perform the following operations:

• Editing a notification URL

  Click Edit in the Operation column to edit the URL or authentication key for receiving stream push messages.

• Deleting a notification URL

  Click Delete in the Operation column to delete the URL or authentication key for receiving stream push messages.

Callback Example

The following is an example of stream push and stream disconnection messages. Table 2 describes the fields in a message body.

{
    "domain":"push.example.com",
    "app":"live",
    "stream":"example_stream",
    "user_args":"auth_info=yz1TG0PVN/5isfyrGrRj10gKPCWqSS2X02t6QsRrocH+mEq0gQ0g8k6KhalS84sQ+kDprFyqI0yajbYiFmUO8e45B7ryaS+MpJBlYkhwnuFLnRiKK/IXG7.33436b625354564f6e4d4d434f55&cdn=hw",
    "client_ip":"100.111.*.*",
    "node_ip":"112.11.*.*",
    "publish_timestamp":"1587954134",
    "event":"PUBLISH",
    "auth_timestamp":1587954140,
    "auth_sign":"ff3b2bxxx5cfd56e76d72bed4c4aa2dxxxca8c2e46467d205a6417d4fc"
}