Get Call Information

Owned by Kiss, Mate
Jul 31, 2018
3 min read

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 parameterParameter example

Description

Requirements
actionaction=GetCallInformationName of the HTTP API request.Mandatory
apiKeyapiKey=74c8eea0-50c6-40b2-9f3e-252ed501c3c8API key used to identify the application.Mandatory
tokentoken=09835e02-6c10-11e0-bb22-ba324924019bUnique 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.
responseTyperesponseType=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.
callIDcallID=a8343631-9f35-4a3a-83f0-9e81592339fbDefines the internal ID of the call.Either callID, platformCallID, nativeID, meetingID or extension parameter is mandatory
platformCallIDplatformCallID=71627389The value of the Platform Call ID field.
nativeIDnativeID=TRS26140192The value of the Technical Call Identifier field.
meetingIDmeetingID=WHBFM6DDThe Lync Meeting ID.
extensionextension=8856Defines 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.
statusstatus=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
returnInvitationreturnInvitation=1If 1, then the Lync Invitation details acquired by Verba from the technical account will be returned in the response. 
returnSharedItemsreturnSharedItems=1If 1, then the corresponding shared items will be returned in the response. 
returnMetadatareturnMetadata=1If 1, then the corresponding custom metadata will be returned in the response. 
returnIMreturnIM=1If 1, then the corresponding IM messages will be returned in the response. 
returnTranscriptDBreturnTranscriptDB=1If 1, then the corresponding transcript will be returned in the response as stored in the database (clear text). 
returnTranscriptFilereturnTranscriptFile=1If 1, then the corresponding transcript will be returned in the response as stored in the transcript file (special transcript format) in Base64 format. 

Response

XML based response sample on success:

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

<VerbaApi>

<Response code="0" type="GetCallInformation">

<verbacdr state="1"> <!-- Finished Call State -->

<id>54bc7c43-561f-11e0-b752-005056c00008</id>

<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> <!-- G.711U 64 kbps -->

<direction_id>0</diection_id> <!-- Internal -->

<cause_id>0</cause_id> <!-- Normal -->

<signaling_id>2</signaling_id> <!-- SIP -->

<recorder_service_id>2</recorder_service_id> <!-- Cisco Central Recorder -->

<ondemand>false</ondemand>

<conference>false</conference>

<recorder_service_id>1</recorder_service_id>

<platform_call_id>WHBFM6DD</platform_call_id>

<manual>0</manual>

<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>

<id>C853EE44-3C96-4DED-9086-E1D6D313BA55</id>

<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"?>

<VerbaApi>

<Response code="2" type="GetCallInformation">

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

</Response>

</VerbaApi>

HTML based response sample:

<html>

<body>

<table>

<tr>

<td>Call ID</td>

<td>54bc7c43-561f-11e0-b752-005056c00008</td>

</tr>

<tr>

<td>Native Call ID</td>

<td>25579707</td>

</tr>

<tr>

<td>Recording Server</td>

<td>PETER-PC</td>

</tr>

<tr>

<td>Caller IP Address</td>

<td>192.168.1.210</td>

</tr>

<tr>

<td>Caller Phone Number</td>

<td>1000</td>

</tr>

<tr>

<td>Caller Name</td>

<td>John Smith</td>

</tr>

<tr>

<td>Called IP Address</td>

<td>192.168.1.67</td>

</tr>

<tr>

<td>Called Phone Number</td>

<td>9999</td>

</tr>

<tr>

<td>Called Name</td>

<td>Earl Jones</td>

</tr>

<tr>

<td>Start Date and Time</td>

<td>2011.03.24 14:02:19</td>

</tr>

<tr>

<td>End Date and Time</td>

<td>2011.03.24 14:02:24</td>

</tr>

<tr>

<td>Audio Codec</td>

<td>G.711U 64 kbps</td>

</tr>

<tr>

<td>Direction</td>

<td>Internal</td>

</tr>

<tr>

<td>End</td>

<td>Normal</td>

</tr>

<tr>

<td>Signaling</td>

<td>SIP</td>

</tr>

<tr>

<td>Recorder Service</td>

<td>Cisco Central Recorder</td>

</tr>

</table>

</body>

</html>

TEXT based response sample:

Call ID: 54bc7c43-561f-11e0-b752-005056c00008

Native Call ID: 25579707

Recording Server: PETER-PC

Caller IP Address: 192.168.1.210

Caller Phone Number: 1000

Caller Name: John Smith

Called IP Address: 192.168.1.67

Called Phone Number: 9999

Called Name: Earl Jones

Start Date and Time: 2011.03.24 14:02:19

End Date and Time: 2011.03.24 14:02:24

Audio Codec: G.711U 64 kbps

Direction: Internal

End: Normal

Signaling: SIP

Recorder Service: Cisco Central Recorder