Skip to end of metadata
Go to start of metadata

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:

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

Add Marker HTTP GET sample:

http://192.168.1.104/verba/api?action=AddMarker&apiKey=74c8eea0-50c6-40b2-9f3e-252ed501c3c8&token=09835e02-6c10-11e0-bb22-ba324924019b&responseType=HTML&callID=a8343631-9f35-4a3a-83f0-9e81592339fb&mmode=start&mname=Agreement

Parameters

Detailed description of the API request elements:

URL parameterExample

Description

Requirements
actionaction=AddMarkerName 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.
responseTyperesponseType=HTML

Defines the format of the response of the API request. The following valid values apply:

  • XML: the response is formatted and structured in XML, designed for applications
  • HTML: the response is in human readable format and formatted using standard HTML; it can be directly displayed in any browser.
  • TEXT: simple clear text based response
If the parameter is missing, it defaults to XML.

callID

callID=a8343631-9f35-4a3a-83f0-9e81592339fbDefines the internal ID of the call.Either the callID or either the number parameter is mandatory
extensionextension=8856Defines 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.Either the callID or either the number parameter is mandatory
statusstatus=ongoing,next

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
mmodemmode=start

Marker mode can be one of the followings:

  • start - this mode sets a new marker at the current time position in the call
  • end - this mode ends a marker at the current time position in the call
  • segment - this mode adds a marker with a defined start and end position

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.
mnamemname=AgreementKey-value pair defining the identifier of the custom field variable and the data itself.Mandatory
mstartmstart=15This 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
mendmend=30This 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 version="1.0" encoding="UTF-8"?>

<VerbaApi>

<Response code="0" type="AddMarker"/>

</VerbaApi>

 

XML based response sample on error:

<?xml version="1.0" encoding="UTF-8"?>

<VerbaApi>

<Response code="2" type="AddMarker">

<ErrorMessage description="Error">Unable to add marker to the call, because the call cannot be found.</ErrorMessage>

</Response>

</VerbaApi>

 

HTML based response sample:

<html>

<body>

<p>The system successfully added the marker to the defined call.</p>

</body>

</html>

 

TEXT based response sample:

The system successfully added the marker to the defined call.