Docs Overview/
Feedback

Webhook After Record Changed

Feature Description

The app backend can use this callback to track real-time changes in recording status.

Notes

To enable the callback, a callback URL must be configured and the switch corresponding to this callback protocol activated. For configuration methods, see Third-party Callback Configuration document.
The Instant Messaging (IM) backend sends this callback as an HTTP POST request to your app backend.
Upon receiving the callback request, the app backend must verify that the SDKAppID parameter in the request URL matches its own SDKAppID.

Scenarios That May Trigger This Callback

This callback is triggered when a user starts or stops recording from the client, or when the room's recording status changes.

Callback Trigger Timing

Triggered immediately after the recording status changes.

API Description

Example Request URL

The following example uses the app's configured callback URL https://www.example.com.
Example:
https://www.example.com?SdkAppid=$SDKAppID&CallbackCommand=$CallbackCommand&contenttype=json&ClientIP=$ClientIP&OptPlatform=$OptPlatform

Request Parameter Description

Parameter
Description
https
HTTPS protocol, POST request method.
www.example.com
Callback URL.
SdkAppid
SDKAppID assigned in the Instant Messaging (IM) console when creating the app.
CallbackCommand
Fixed value: Room.CallbackAfterRecordingChanged.
contenttype
Fixed value: json.
ClientIP
Client IP address, e.g., 127.0.0.1
OptPlatform
Client platform. For details, see the description of OptPlatform in Third-Party Callback Overview: Callback Protocol.

Example Request Payload

{
  "CallbackCommand": "Room.CallbackAfterRecordingChanged",
  "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 Payload Field Description

Field
Type
Description
CallbackCommand
String
Callback command.
EventGroupId
Number
Event group ID. 3 indicates cloud recording, 8 indicates web recording.
EventType
Number
Event type for the callback notification.
CallbackTs
Number
Unix timestamp (milliseconds) when the event callback server sends the callback request.
EventInfo
JSON Object
Event details. For more information, see Cloud Recording Callback EventInfo.

Example Response Payload

{
    "ActionStatus": "OK",
    "ErrorCode": 0,
    "ErrorInfo": ""
}

Response Payload Field Description

Field
Type
Attribute
Description
ActionStatus
String
Required
Result of request processing:
- OK: Processed successfully.
- FAIL: Processing failed.
ErrorCode
Integer
Required
Error code:
0: Processed successfully.
Non-zero: Processing failed.
ErrorInfo
String
Required
Error message.

Reference