Get Media Encoded
Overview
Retrieves encoded media for the given call.
The function is available as a HTTP GET or HTTP POST request.
Request
Get Media Encoded:
http://<host>/verba/api?action=GetMediaEncoded
Get Media Encoded HTTP GET sample:
http://localhost:8010/verba/api?action=GetMediaEncoded&apiKey=D5D395D8-CD6E-4B92-8068-004E41874367&token=sbCSiDRKeEcytDYK98zgXtIw5G1qIbGf&cid=4abcc460-1f3b-11e1-9cfe-0016d4a3517c&format=mp3
Parameters
Detailed description of the API request elements:
URL parameter | Example | Description | Requirements |
|---|---|---|---|
action | action=GetMediaEncoded | Name of the HTTP API request. | Mandatory |
apiKey | apiKey=D5D395D8-CD6E-4B92-8068-004E41874367 | API key used to identify the application. | Mandatory |
token | token=AMGRkYRN23daANVnlac0dDUan51nQpOq | 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. |
cid | cid=4abcc460-1f3b-11e1-9cfe-0016d4a3517c | Defines the internal ID of the call. | Either the callID or either the numberparameter is mandatory |
format | format=mp3 | Format of the media to stream: | Mandatory |
Response
The response contains the call in a requested audio format.