The POST v0/{accountKey}/calls/{callGuid}
endpoint allows manipulation of call recording for a call currently in progress; use the resource to either pause or resume a recording during the call. You control recording of the call that you specify in the query string parameter, callGuid. For information about getting GUID for the current call, see Getting agent details.
Pausing a recording using this API will not make a VCC call PCI Compliant. Consider using Vonage's Secure Payment capability to achieve a PCI-compliant solution. |
This endpoint requires the following headers:
Authorization (required)
This header requires an OAuth bearer token. For information on the bearer token, see How to use your bearer access token.
Content-Type(required)
application/json
Indicates that the media type sent by the client is JavaScript Object Notation (JSON).
curl -X POST "https://***.newvoicemedia.com/v0/a1b2c3d4e5/calls/94e5928c-7f7e-4645-ad72-61010f906449" -d '{ "recordingStatus": "Paused" }' -H "Authorization: Bearer <ACCESS_TOKEN>" -H "Content-Type: application/json" |
Body:
{ "recordingStatus": "Paused" } |
curl -X POST "https://***.newvoicemedia.com/v0/a1b2c3d4e5/calls/94e5928c-7f7e-4645-ad72-61010f906449" -d '{ "recordingStatus": "Started" }' -H "Authorization: Bearer <ACCESS_TOKEN>" -H "Content-Type: application/json" |
Body:
{ "recordingStatus": "Started" } |
Successful calls return HTTP status code of 201, containing the following message and headers.
Returns HTTP Status Code 202 Accepted.
The controlling of the call is carried out asynchronously - To check that the status has been correctly updated continue to call GET requests against that call.
{ "recordingStatus": "Paused" } |
Returns HTTP Status Code 400.
{ "message": "The request is invalid." } |
Returns HTTP Status Code 404.
{ "message": "The requested resource was not found." } |