Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Fix the examples

Overview

Excerpt

Retrieves all metadata available for a call.

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

Request

Get Call Information:

Info
iconfalse

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

...

Info
iconfalse

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

<VerbaApi>

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

>

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

<id>54bc7c43

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

id>

ccdr_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>1</recorder_service_id>

<ondemand>false</ondemand>

<conference>false</conference>

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

Info
iconfalse

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

<VerbaApi>

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

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

</Response>

</VerbaApi>