/
Get Call Information
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:
Get Call Information HTTP GET sample:
Detailed description of the API request elements:
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:
| 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:
| 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 based response sample on error:
, multiple selections available,
Related content
API authentication
API authentication
More like this
Get Media Segment
Get Media Segment
More like this
Extension details
Extension details
More like this
User permissions
User permissions
More like this
Web interface quick reference
Web interface quick reference
More like this
Configuring Verba for passive recording
Configuring Verba for passive recording
More like this