...
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:
| 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:
| 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:
|
unmark | unmark=1 | If unmark=1 is set, the system does quite the opposite of the normal opereation:
|
Response
XML based response sample on success
...
Info | ||
---|---|---|
| ||
<?xml version="1.0" encoding="UTF-8"?> <VerbaApi> <Response code="2" type="KeepCall"> <ErrorMessage description="Error">Unable <ErrorMessage>Unable to keep the call, because the call cannot be found.</ErrorMessage> </Response> </VerbaApi> |
...