Get Media

Owned by Kiss, Mate
Last updated: Aug 10, 2022 by Krisztian PappVersion comment
2 min read

Overview

Retrieves the media for the given call.

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

Request

Get Media:

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

Get Media HTTP GET sample:

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

Parameters

Detailed description of the API request elements:

URL parameterExample

Description

Requirements
actionaction=GetMediaName 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.

ccdr_id

callID=a8343631-9f35-4a3a-83f0-9e81592339fbDefines the internal ID of the call.Either the ccdr_id or either the extension parameter is mandatory
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.Either the ccdr_id or either the extension parameter is mandatory
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 number parameter is specified

Response

The response contains the raw stream of the media file over HTTP in its original file format.