Start

POST
/api/v1/vc/start-recording

Request Parameters

Name Type Description Required
title string Name given to the video. Defaults to the SIP address if not provided.
sipAddress string SIP address for the video recording. Yes

Example Request

{
  "title": "Morning Call Recording",
  "sipAddress": "sip.address@company.com"
}

Example Response

{
  "videoId": "d369ffff-cba8-4e89-8b7f-b69863cc0295"
}

Response Codes

Code Description
200 ok
401 Unauthorized error
500 Internal server error

Stop

POST
/api/v1/vc/stop-recording

Request Parameters

Name Type Description Required
videoId string GUID for the video recording. Yes

Example Request

{ 
"videoId": "d369ffff-cba8-4e89-8b7f-b69863cc0295"  
}

Response Codes

Code Description
200 ok
401 Unauthorized error
500 Internal server error

Status

GET
/api/v1/vc/recording-status/{id}

Request Parameters

Name Type Description Required
id path GUID for the video recording. Yes

Example Response

{
  "status": "Recording"
}

Possible values include: Initializing, Connecting, Recording, Processing, Uploading to Rev

Response Codes

Code Description
200 ok
401 Unauthorized error
500 Internal server error