Stream Status Notifications

Updated on 2024-12-06 GMT+08:00

View PDF

You can add a URL on the Live console for receiving messages when stream push starts or ends. The messages are sent as POST requests to your server through an HTTP API. Then your server returns the status code 200 to confirm that the messages have been received.

Notes

In the AP-Bangkok region, submit a service ticket for review after configuring stream status notifications. The configuration takes effect only after it is approved.

After stream status notifications are enabled, you will receive a message each time when a live stream 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 pushing 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 pushing and stream disconnection are in the same stream pushing event. The timestamps generated in the stream pushing and stream disconnection of the same stream pushing 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

Log in to the Live console.
In the navigation pane, choose Domains.
Click Manage in the Operation column of the desired ingest domain name.
In the navigation pane, choose Template > Stream Status Notifications.
Click Add. On the displayed dialog box, add a notification URL, as shown in Figure 1.

NOTE:

Only HTTP and HTTPS URLs are supported.

Figure 1 Adding a notification URL
Authentication Key: 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.
Click OK.

When stream pushing 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 pushing and stream disconnection messages. Table 1 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"
}

**Table 1** Message body
Field	Description
domain	Ingest domain name
app	Application name
stream	Stream name
user_args	Stream pushing parameter
client_ip	IP address of the streaming device
node_ip	IP address of the receiver
publish_timestamp	Unix timestamp. One single timestamp is generated for each stream pushing event.
event	Stream pushing or stream disconnection. Options: PUBLISH: Stream pushing starts. PUBLISH_DONE: Stream pushing ends.
auth_timestamp	UNIX timestamp when the event notification signature expires. This parameter is carried when an authentication key is configured. The value is a decimal UNIX timestamp, that is, the number of seconds that have elapsed since January 1, 1970 (midnight UTC/GMT). Example: 1592639100 (June 20, 2020 15:45)
auth_sign	Event notification signature. This parameter is carried when an authentication key is configured. auth_sign = HmacSHA256 (event + domain + app + stream + auth_timestamp, key) key indicates the key used for authentication.

Parent topic: Stream Push

Previous topic: Snapshot Capturing

Next topic: HLS

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot