API Stop Recording

From IVS Wiki
Revision as of 13:56, 14 April 2020 by IVSWikiBlue (talk | contribs) (Created page with "This API call will stop the current recording in the specified room. ===Resource URL=== <pre>http://valt.example.com/api/v3/rooms/{roomid}/record/stop</pre> ''Replace {roomid...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

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

Resource URL

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

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 Stopped 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 stopped.
id ID number for the recording that was stopped.
status true = recording stopped successfully, false = recording could not be stopped (reference messaged for reason)

Examples

Request

https://ivstest1.ad.ipivs.com/api/v3/rooms/59/record/stop?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": 615,
"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": "Recording in room not found",
"status": false
},
"code": 404
}