Keep Call

Overview

Keeps the on-demand call.

The function is available as a HTTP GET or HTTP POST request.

Request

Keep Call:

http://<host>/verba/api?action=KeepCall

Keep Call HTTP GET sample:

http://192.168.1.104/verba/api?action=KeepCall&apiKey=74c8eea0-50c6-40b2-9f3e-252ed501c3c8&token=09835e02-6c10-11e0-bb22-ba324924019b&responseType=XML&extension=8856&status=ongoing

Parameters

Detailed description of the API request elements:

URL parameter	Example	Description	Requirements
action	action=KeepCall	Name of the HTTP API request.	Mandatory
apiKey	apiKey=74c8eea0-50c6-40b2-9f3e-252ed501c3c8	API key used to identify the application.	Mandatory
token	token=09835e02-6c10-11e0-bb22-ba324924019b	Unique identifier for authenticated sessions. After successful authentication, the API sends back a token, which has to be used for each request.	Mandatory if authentication is configured for the given API key.
responseType	responseType=XML	Defines the format of the response of the API request. The following valid values apply: XML: the response is formatted and structured in XML, designed for applications HTML: the response is in human readable format and formatted using standard HTML; it can be directly displayed in any browser. TEXT: simple clear text based response	If the parameter is missing, it defaults to XML.
callID	callID=a8343631-9f35-4a3a-83f0-9e81592339fb	Defines the internal ID of the call.	Either the callID or either the number parameter is mandatory
extension	extension=8856	Defines the phone number that is a participant of the call. The API will look for a call with the status defined, where the number is either the calling party or the called party. If the API, for some reason, finds more than 1 record, it will respond with error.	Either the callID or either the number parameter is mandatory
status	status=ongoing	Defines the status of the requested call. Comma separated values can be specified.The following valid values and value combinations apply: ongoing - the API will look for an ongoing call, where the number is either the calling party or the called party next - the API will look for the next call in the upcoming 1 minute time range after the API request, where the number is either the calling party or the called party last - the API will look for the last finished call, where the number is either the calling party or the called party ongoing, next - the API will look for an ongoing call, where the number is either the calling party or the called party; if no record was found, the API will look for the next call in the upcoming 1 minute time range after the API request, where the number is either the calling party or the called party last, ongoing - the API will look for the last finished call, where the number is either the calling party or the called party; if no record was found, the API will look for an ongoing call, where the number is either the calling party or the called party	Mandatory if the number parameter is specified
type	type=manualRecord	Instead of marking an on-demand call for recording, the following other types of data can be modified: manualRecord - start recording of a Controlled extension do_not_delete - set the Protected flag
unmark	unmark=1	If unmark=1 is set, the system does quite the opposite of the normal opereation: if type=manualRecord - stop recording of a Controlled extension if type=do_not_delete - remove the Protected flag

Response

XML based response sample on success

<?xml version="1.0" encoding="UTF-8"?>

</VerbaApi>

XML based response sample on error

<?xml version="1.0" encoding="UTF-8"?>

<ErrorMessage>Unable to keep the call, because the call cannot be found.</ErrorMessage>

</Response>

</VerbaApi>

HTML based response sample

<html>

<body>

<p>The call has been marked for recording.</p>

</body>

</html>

TEXT based response sample

The call has been marked for recording.

VFC Capture (Verba) 9.8