API Resume Recording

From IVS Wiki
Jump to: navigation, search

This API call will resume the current recording in the specified room.

Resource URL

http://valt.example.com/api/v3/rooms/{roomid}/record/resume

Replace {roomid} with the actual id number of the room. Rooms are numbered sequentially when added to VALT.

Resource Information

Method POST
Headers Content-Type:application/json
Response Type JSON
Authentication Required Yes

Parameters

No parameters can be passed to this call.

Response

Code Reason
200 Recording Resumed Successfully
401 Unauthorized
404 Room ID Not Found or Not Recording
JSON Response
data
message Contains a detailed message on why the recording could not be resumed.
id ID number for the recording that was paused.
status true = recording resumed successfully, false = recording could not be resumed (reference message for reason)

If the room is not currently paused, but is actively recording you will still receive a successful response.

Examples

Request

https://ivstest1.ad.ipivs.com/api/v3/rooms/59/record/resume?access_token=e82632d19c523678fea3d1016c6df9e9

Successful Response

Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.

{
"data":{
"id": 616,
"status": true
}
}

Failure Response

Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.

{
"data":{
"message": "The recording in the room is not found",
"status": false
},
"code": 404
}