Overview

Retrieves the unique identifier of the given call.

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

Request

Get Call ID:

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

Get Call ID HTTP GET sample:

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

Parameters

Detailed description of the API request elements:

URL parameter	Example	Description	Requirements
action	action=GetCallID	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=HTML	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.
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.
status	status=last	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
platformCallID	platformCallID=71627389	The value of the Platform Call ID field.
nativeID	nativeID=TRS26140192	The value of the Technical Call Identifier field.

Response

XML based response sample on success

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

</Response>

</VerbaApi>

XML based response sample on error

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

<ErrorMessage description="Error">Unable to retrieve the call identifier, because the call cannot be found.</ErrorMessage>

</Response>

</VerbaApi>

HTML based response sample

<html>

<body>

</body>

</html>

TEXT based response sample

a8343631-9f35-4a3a-83f0-9e81592339fb

Browser not supported