Put Media
Overview
Uploads a media file with metadata.
The function is available as an HTTP POST request. CDR metadata should be added to the request URL as GET parameters, the media file(s) should be in the POST body with multipart/form-data encoding (normal file upload).
Request
Put Media HTTP POST URL:
http://<host>/verba/api?action=PutMedia
Parameters
The following parameters can be defined in the URL:
URL parameter | Example | Description | Requirements |
|---|---|---|---|
action | PutMedia | Name of the HTTP API request. | Mandatory |
apiKey | 74c8eea0-50c6-40b2-9f3e-252ed501c3c8 | API key used to identify the application. | Mandatory |
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. |
nativeid | 3A4B8016-FA30-44EC-9C1F-63D7279F8A68 | Platform ID of the added media file (e.g. SIP ID for SIP IP calls) |
|
location | HOSTNAME | Name of the device where the media is recorded |
|
starttime | 2011-03-24 14:02:19.673 | Start time of the recording | Mandatory |
endtime | 2011-03-24 14:10:25 | End time of the recording | Mandatory |
srccallerid | 1234 | Phone number of the caller party |
|
srcip | 192.168.1.1 | IP address of the caller party |
|
srcname | Joe | Name of the caller party |
|
dstcallerid | 1235 | Phone number of the called party |
|
dstip | 192.168.1.2 | IP address of the called party |
|
dstname | Susan | Name of the called party |
|
audiocodec | 0 | Codec ID of the recorded media |
|
direction | 1 | Direction of the recorded media (e.g. incoming call) |
|
cause | 0 | Termination code of the media recording (e.g. 0 is normal) |
|
donotdelete | 0 | Marks if the call is protected |
|
conference | 0 | Marks if the call is a conference with more than 2 parties |
|
signalingid | 1 | Signalling used by the recorded media session |
|
recorderserviceid | 10 | ID of the recording technology used to record the media |
|
sourceaudiortpcount | 1566 |
|
|
destinationaudiortpcount | 1734 |
|
|
Response
XML based response sample on success:
<?xml version="1.0" encoding="UTF-8"?>
<VerbaApi>
<Response code="0" type="PutMedia"/>
<ccdrid>9b4f1f86-5d22-4907-9a33-47610a5f0038</ccdrid>
</VerbaApi>
XML based response sample on error:
<?xml version="1.0" encoding="UTF-8"?>
<VerbaApi>
<Response code="-20" type="PutMedia">
<ErrorMessage>starttime parameter is mandatory</ErrorMessage>
</Response>
</VerbaApi>