Overview
Excerpt |
---|
Retrieves the unique identifier of the given call. |
...
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:
| 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:
|
platformCallID | platformCallID=71627389 | The value of the Platform Call ID field. |
nativeID | nativeID=TRS26140192 | The value of the Technical Call Identifier field. |
type | type=manualRecord | Flag to query controlled recording call. |
Response
XML based response sample on success
Info | ||
---|---|---|
| ||
<?xml version="1.0" encoding="UTF-8"?> <VerbaApi> <Response code="0" type="GetCallID"/> <CallID>a8343631-9f35-4a3a-83f0-9e81592339fb</CallID> </Response></VerbaApi> |
XML based response sample on error
Info | ||
---|---|---|
| ||
<?xml version="1.0" encoding="UTF-8"?> <VerbaApi> <Response code="2" type="GetCallID"> <ErrorMessage description="Error">Unable <ErrorMessage>Unable to retrieve the call identifier, because the call cannot be found.</ErrorMessage> </Response> </VerbaApi> |
...