Add Marker
Overview
Adds segment markers to any recorded call.A segment of the recorded media can be marked automatically by your application. This way users can easily identify important segments of a recording in the web-based player of the system. This API allows to define multiple marker segments for a call.
A typical application is to mark segments where e.g. a voice contract was made over telephone.
You can use the function to start and end segments during the call, or define segment periods during or after the call.
The function is available as a HTTP GET or HTTP POST request.
Request
Add Marker:
Add Marker HTTP GET sample:
Parameters
Detailed description of the API request elements:
URL parameter | Example | Description | Requirements |
---|---|---|---|
action | action=AddMarker | 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. |
ccdr_id | callID=a8343631-9f35-4a3a-83f0-9e81592339fb | Defines the internal ID of the call. | The ccdr_id and the extension parameters are mandatory |
extension | extension=8856 | Defines the phone number that is a participant of the call which the marker is added. The API will look for a call with the status (see the status field below), 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. | The ccdr_id and the extension parameters are mandatoryhe |
status | status=ongoing,next | Defines the status of the requested call. Comma separated values can be specified.The following valid values and value combinations apply:
| Mandatory if the number parameter is specified |
mmode | mmode=start | Marker mode can be one of the followings:
Markers is defined by their name for segment start and end calls, therefore marker names should be different if multiple markers are added. Markers should not overlap. | Mandatory Start and End more requires that status is ongoing. |
mname | mname=Agreement | Key-value pair defining the identifier of the custom field variable and the data itself. | Mandatory |
mstart | mstart=15 | This parameter defines the end of a marker segment in seconds. If mmode is not segment, this parameter is not used. | Mandatory if the mmode is segment |
mend | mend=30 | This parameter defines the end of a marker segment in seconds. If mmode is not segment, this parameter is not used. | Mandatory if the mmode is segment |
Response
XML based response sample on success:
XML based response sample on error:
HTML based response sample:
TEXT based response sample: