Callback of the recording status

---

Description

To receive a task status event immediately upon a status change, you need to provide a callback URL when enabling the Cloud Recording service.

During recording, an HTTP request will be initiated to the callback URL using the POST method and the request message body is in JSON format.

Callback parameters

• Listed below are detail member parameters when event_type is 1.

Listed below are file_info member parameters.

• Listed below are detail member parameters when event_type is 2.

• Listed below are detail member parameters when event_type is 3.

• The detail parameter is left empty when event_type is 4 or 5.

• Listed below is the detail member parameter when event_type is 6.

• Listed below are detail member parameters when event_type is 102.

• The detail parameter is left empty when event_type is 201 or 202.

Sample request

The following is a request example of the recording status callback method:

{
    "app_id": 1234567890, 
    "detail": {
        "file_info": [
            {
                "begin_timestamp": 1637753762084, 
                "duration": 170039, 
                "file_id": "YZ4joOE4IwmFAAAT_6677_800221_800221_VA_20211124113602084.mp4", 
                "file_size": 25349026, 
                "file_url": “file_url”, 
                "media_track_type": 3, 
                "output_file_format": "mp4", 
                "resolution_height": 720, 
                "resolution_width": 1280, 
                "status": 3, 
                "stream_id": "800221", 
                "user_id": "800221", 
                "user_name": "play_800221", 
                "video_id": ""
            }
        ], 
        "upload_status": 1
    }, 
    "event_type": 1, 
    "message": "", 
    "nonce": "100480", 
    "room_id": "6677", 
    "sequence": 1, 
    "signature": "12345678987654321", 
    "task_id": "YZ4joOE4IwmFAAAT", 
    "timestamp": "1637753949"
}

Source verification

Checks whether a callback request is initiated from the Cloud Recording service.

Verification method

Check whether the calculated signature is the same as that carried in the callback request. The following figure shows how to calculate a signature.

• nonce: parameter in the callback request
• timestamp: parameter in the callback request
• callbacksecret: generated during project registration on the ZEGOCLOUD Admin Console.

Sample code

Sample code in PHP:

$signature = $_POST["signature"];
$timestamp = $_POST["timestamp"];
$nonce = $_POST["nonce"];

$secret = callbacksecret;// Callback secret obtained in the background.
$tmpArr = array($secret, $timestamp, $nonce);
sort($tmpArr, SORT_STRING);
$tmpStr = implode( $tmpArr );
$tmpStr = sha1( $tmpStr );

if( $tmpStr == $signature ){
    return true;
} else {
    return false;
}

Sample code in Java:

// Obtain the values of signature, timestamp, and nonce from the request.
String signature = request.getParameter("signature");
long timestamp = request.getParameter("timestamp");
String nonce = request.getParameter("nonce");

// Back end obtains callbacksecret
String secret = callbacksecret;

String[] tempArr = {secret, ""+timestamp, nonce};
Arrays.sort(tempArr);

String tmpStr = "";
for (int i = 0; i < tempArr.length; i++) {
    tmpStr += tempArr[i];
}
tmpStr = org.apache.commons.codec.digest.DigestUtils.sha1Hex(tmpStr);

return tmpStr.equals(signature);

Sample response

$timestamp = 1470820198;
$nonce = 123412;
$secret = 'secret';

Original string requiring encryption after ranking splice:1234121470820198secret
The result of encryption will be:5bd59fd62953a8059fb7eaba95720f66d19e4517

Return code

HTTP status code 2XX (such as 200) indicates success and all other return codes indicate failure.