Feature Description
The App backend can view the recording status changes information in real time.
Notes
To enable this webhook, you must configure the webhook URL and enable the corresponding switch for this webhook. For more information on the configuration method, see Webhook Configuration. During this webhook, the Chat backend initiates an HTTP POST request to the app backend.
After receiving the webhook request, the app backend must check whether the SDKAppID contained in the request URL is the SDKAppID of the app.
For more security considerations, see the Security Considerations section in Webhook Overview. Webhook Triggering Scenarios
The app user started the live stream via the client app and enabled the recording setting.
The app user stopped the live stream via the client app while the room or console recording setting remained enabled.
Webhook Triggering Timing
Triggered after the recording status changes.
API Calling Description
Sample Request URL
In the following example, the webhook URL configured for the App is https://www.example.com. Example:
https://www.example.com?SdkAppid=$SDKAppID&CallbackCommand=$CallbackCommand&contenttype=json&ClientIP=$ClientIP&OptPlatform=$OptPlatform
Request Parameters
|
https | The request protocol is HTTPS, and the request method is POST. |
www.example.com | Webhook URL. |
SdkAppid | SDKAppID assigned to an application when the application is created in the Chat console. |
CallbackCommand | Fixed as: Follow.CallbackAfterCloudRecordingChanged. |
contenttype | The fixed value is: json. |
ClientIP | Client IP address. For example, 127.0.0.1. |
OptPlatform | Client platform. For valid values, see the description of OptPlatform in the Webhook Protocols section of Webhook Overview. |
Sample Requests
{
"CallbackCommand": "Follow.CallbackAfterCloudRecordingChanged",
"EventGroupId": 3,
"EventType": 305,
"CallbackTs": 1752580150082,
"EventInfo": {
"RoomId": "635055",
"EventTs": 1752580150,
"EventMsTs": 1752580150081,
"UserId": "user1",
"TaskId": "-m9-bVVU7id***K-m928oZWQndiborbEWH3zY-lIXlprc-gQvQE",
"Payload": {
"Status": 0
}
}
}
Request Fields
|
CallbackCommand | String | Webhook command. |
EventGroupId | Number | Event group ID, fixed at 3 for cloud recording. |
EventType | Number | Event type for callback notification. |
CallbackTs | Number | The Unix timestamp (in milliseconds) when the event callback server sends a callback request to your server. |
EventInfo | JSON Object | |
Sample Response
{
"ActionStatus": "OK",
"ErrorCode": 0,
"ErrorInfo": ""
}
Response Fields
|
ActionStatus | String | Required | Request processing result: OK: processing is successful. FAIL: processing failure. |
ErrorCode | Integer | Required | Error Code: 0: processing is successful. Non-zero: processing failure. |
ErrorInfo | String | Required | Error message. |
References