Channel Callback Feature (Deprecated)
This is not a SaaS backend feature. It corresponds to the documentation for the live room information modification callback. This callback has no backend configuration page, and it is recommended not to use this feature for business purposes.
The SaaS backend feature [Live Room Information Modification Callback] corresponds to the documentation: Channel Change Callback Notification
Purpose
When a live channel under an account is created, deleted, or modified (including basic information settings, lecturer settings, guest settings, and live status changes), a callback notification will be sent to the configured interface address.
Details
After setting the callback interface address, when channel creation, modification, or deletion operations occur, the callback interface will be requested via the POST method.
Timeout and Retry
If the callback server does not receive a response from your server within 5 seconds after sending the notification, it is considered a failure. Subsequent failures will be retried 3 more times at intervals of 5 seconds, 10 seconds, and 20 seconds.
Callback Message Format
Event callback messages are sent to your server via HTTP/HTTPS POST requests, where:
- Character encoding format: UTF-8.
- Request: The body format is JSON. The URL will include
timestampandsign. The signature verification method ismd5(body + timestamp + appSecret). - Response requirement: The response header must specify
Content-Type: application/json. - Correct response: An HTTP status code of 200 indicates successful business reception and processing. Any other status is considered a failure and will be retried.
Callback Data Example
- Example of "Channel Creation":
URL parameters:
timestamp=1620878344475&sign=eb7d6b79d3816214131015973294b179Response body:
{
"channelId": 2290918,
"channelName": "演示频道",
"eventType": "ADD",
"eventTime": "2021-05-13 11:58:29"
}
- Example of "Channel Modification":
URL parameters:
timestamp=1620878679926&sign=176230a93b89023a974976eafda7c12aResponse body:
{
"channelId": 2290918,
"channelName": "演示频道",
"liveStatus": "waiting",
"eventType": "MODIFY",
"eventTime": "2021-05-13 12:04:04",
"startTime": "2021-05-13 22:04:04",
"splashImg":"https://liveimages.videocc.net/uploaded/images/2021/05/fyjxijew0x1.jpg"
"publisher": "主持人",
"teacher": {
"nickname": "讲师",
"actor": "讲师"
},
"guests": [
{
"nickname": "陈老师",
"actor": "嘉宾"
}
]
}
- Example of "Channel Deletion":
URL parameters:
timestamp=1620878775840&sign=2e4867bc2a6df0f648ed7ba43a63421cResponse body:
{
"channelId": 2290918,
"channelName": "演示频道",
"eventType": "DELETE",
"eventTime": "2021-05-13 12:05:40"
}
Callback Parameter Description
| Parameter Name | Type and Range | Description |
|---|---|---|
| channelId | int | Channel ID |
| channelName | string | Channel name |
| liveStatus | string | Live status (live - live, end - ended, waiting - waiting for live, playback - playback) |
| eventType | string | Event type (ADD - creation, MODIFY - modification, DELETE - deletion) |
| eventTime | string | Event trigger time |
| publisher | string | Host |
| splashImg | string | Splash page image |
| startTime | string | Broadcast start time |
| teacher | object | Host |
| teacher.nickname | string | Host nickname |
| teacher.actor | string | Host title |
| guests | array | Guests |
| guests[].nickname | string | Guest nickname |
| guests[].actor | string | Guest title |
