This feature has been deprecated and is replaced by Call Recording Web Service API.
The Pause/Resume API is a simple API to enable third party application pause control of call and screen recording. A simple usage scenario is a call center employing PC-based agent dashboards that include a call-hold feature. A third party developer can leverage the Pause/Resume API to ensure that both the call and the screen recording pause when the call-hold feature is enabled, and that recording resumes when the call-hold feature is disabled.
The Pause/Resume API has the following basic features:
- Fully HTTP (REST)-based API for maximum compatibility and ease of use.
- User authenticated sessions to prevent pause/resume control of unauthorized calls.
- List calls in progress with filter parameters to restrict results based on the IP address or phone number and call direction.
Sample API calls using the cURL tool are displayed here.
Basic Procedure
The following procedure outlines the steps required in order for an application to pause or resume call recording for a call currently in progress.
- Log in via an HTTP POST request using a valid Call Recording username and password.
- Send an HTTP GET request (with optional filter parameters) to list calls in progress. Calls that the logged-in user has access to (permissions to see call details of) will include a call details URI in the result list.
- Send an HTTP GET request to one specific call details URI. The reply is an XML document that includes a pause/resume URI if the logged-in user has appropriate permissions for this action.
- Send an HTTP POST/PUT request to the pause/resume URI with
paused=trueto pause the call/screen recording orpause=falseto resume call/screen recording. - Log out, again via an HTTP POST request.
Known Issues and Limitations
- An arbitrary (random) cookie must be included in the initial login POST request, otherwise the login will not be successful.
- The response to the initial login POST request currently does not indicate if authentication was successful.