Get Call Information

Overview

Retrieves all metadata available for a call.

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

Request

Get Call Information:

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

Get Call Information HTTP GET sample:

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

Detailed description of the API request elements:

URL parameter	Parameter example	Description	Requirements

URL parameter	Parameter example	Description	Requirements
action	action=GetCallInformation	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 callID, platformCallID, nativeID, meetingID or extension parameter is mandatory
platformCallID	platformCallID=71627389	The value of the Platform Call ID field.
nativeID	nativeID=TRS26140192	The value of the Technical Call Identifier field.
meetingID	meetingID=WHBFM6DD	The Lync Meeting ID.
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	Mandatory if the extension parameter is specified
returnInvitation	returnInvitation=1	If 1, then the Lync Invitation details acquired by Verba from the technical account will be returned in the response.
returnSharedItems	returnSharedItems=1	If 1, then the corresponding shared items will be returned in the response.
returnMetadata	returnMetadata=1	If 1, then the corresponding custom metadata will be returned in the response.
returnIM	returnIM=1	If 1, then the corresponding IM messages will be returned in the response.
returnTranscriptDB	returnTranscriptDB=1	If 1, then the corresponding transcript will be returned in the response as stored in the database (clear text).
returnTranscriptFile	returnTranscriptFile=1	If 1, then the corresponding transcript will be returned in the response as stored in the transcript file (special transcript format) in Base64 format.
returnVoiceQuality	returnVoiceQuality=1	If 1, then the corresponding voice quality check results will be returned in the response.

Response

XML based response sample on success:

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

<native_id>25579707</native_id>

<location>PETER-PC</location>

<source_ip>192.168.1.210</source_ip>

<source_caller_id>1000</source_caller_id>

<source_name>John Smith</source_name>

<destination_ip>192.168.1.67</destination_ip>

<destination_caller_id>9999</destination_caller_id>

<destination_name>Earl Jones</destination_name>

<start_time>2011.03.24 14:02:19.673</start_time>

<end_time>2011.03.24 14:02:24.325</end_time>

<audio_codec_id>4</audio_codec_id>

<direction_id>0</diection_id>

<cause_id>0</cause_id>

<signaling_id>2</signaling_id>

<recorder_service_id>2</recorder_service_id>

<ondemand>false</ondemand>

<conference>false</conference>

<recorder_service_id>1</recorder_service_id>

<platform_call_id>WHBFM6DD</platform_call_id>

<do_not_delete>0</do_not_delete>

<secondary>false</secondary>

<recorded_party>false</recorded_party>

<meeting_id>WHBFM6DD</meeting_id>

<invitation_organizer_cn>boss@company.com</invitation_organizer_cn>

<invitation_organizer_email>boss@company.com</invitation_organizer_email>

<shared_item>

<publisher>boss@company.com</publisher>

<title>Lync Meeting WHBFM6DD</title>

<publicity_level>public_to_everybody</publicity_level>

<accessible_by_url>true</accessible_by_url>

<allow_download>false</allow_download>

</shared_item>

</verbacdr>

</Response>

</VerbaApi>

XML based response sample on error:

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

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

</Response>

</VerbaApi>