tencent cloud

CSS supports callbacks. To use this feature, you need to create a callback template in the console, configure an address to receive callbacks for an event, and then bind the template with your push domain name. If the event triggers a callback during live streaming, Tencent Cloud will send a request to your server, which is responsible for responding to the request. After successful verification, the server will obtain a JSON packet of the callback through the address configured.
This document describes how to create, modify and delete a callback template in the console.

You can create a callback template in the following ways:

• Create a template in the CSS console. For details, see Creating a Callback Template.
• Create a template with APIs. For the parameters and request sample, see CreateLiveCallbackTemplate.

Must-knows

• After creating a template, you need to bind it with a push domain name. The binding takes effect in about 5-10 minutes.
• Make sure the HTTP or HTTPS server you use to receive callbacks are able to receive requests and respond normally.
• In the console, you can only bind and unbind callback templates at the domain level. For callback rules bound to specific streams by APIs, you need to call DeleteLiveCallbackRule to unbind them.
• For information on callback protocols, see How to Receive Event Notification.
• For information about the parameters in a callback, see the following documents:
• Stream pushing
• Stream interruption
• Recording
• Screencapturing
• Porn detection
• Relay
• Push errors

Creating a Callback Template

1. Log in to the CSS console.
2. Select Event Center > Live Stream Callback in the left sidebar.
3. Click Create Template, fill in the information, select the types of callbacks you want to receive, enter the callback URLs, and click Save.
   

   Item	Description
   Template Name	The callback template name, which can contain up to 30 Chinese characters, letters, numbers, underscores (_), and hyphens (-).
   Template Description	The description of the callback template, which can contain up to 100 Chinese characters, letters, numbers, underscores (_), and hyphens (-).
   Callback Key	A custom callback key. It can contain up to 32 letters and numbers. For details, see Common callback parameters.
   Push Callback	Enter an HTTP or HTTPS address to receive push callbacks.
   Interruption Callback	Enter an HTTP or HTTPS address to receive push interruption callbacks.
   Recording Callback	Enter an HTTP or HTTPS address to receive recording callbacks.
   Screencapture Callback	Enter an HTTP or HTTPS address to receive screencapture callbacks.
   Porn Detection Callback	Enter an HTTP or HTTPS address to receive porn detection callbacks.
   Error callbacks	Enter an HTTP or HTTPS address to receive push error callbacks.

Modifying a Callback Template

1. Select Event Center > Live Stream Callback.
2. Select the target callback template and click Edit to modify its information.
3. After modification, click Save.

Deleting a Callback Template

If a template is bound to a domain name, you need to unbind it before you can delete it. For detailed directions, see Unbinding Callback Template.

1. Select Event Center > Live Stream Callback.
2. Find the target callback template, and click Delete.
3. In the pop-up window, click Confirm.