Get Markers
Overview
Get the list of segment markers for any recorded call.Segment of recordings can be marked in the system through the web interface and the Add Marker API call. This way users can easily identify important segments of a recording in the web-based player of the system. A typical application is to mark segments where e.g. a voice contract was made over telephone.
The function is available as a HTTP GET or HTTP POST request.
Request
Get Markers:
Get Markers HTTP GET sample:
Parameters
Detailed description of the API request elements:
URL parameter | Example | Description | Requirements |
---|---|---|---|
action | action=GetMarkers | 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=HTML | 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 the callID or either the number parameter is mandatory |
Response
XML based response sample on success:
XML based response sample on error:
HTML based response sample:
TEXT based response sample: