Skip to end of metadata
Go to start of metadata

Overview

Adds metadata to any recorded call.

Additional metadata can include various variables received from a contact center like outbound call campaign identifier, service queue identifier, etc. This API function can be also used to insert various data from a CRM or ERP solutions including customer identifier, account name, ticket identifier, etc. Having these extra metadata fields, users can retrieve recording in a very easy and quick way by simply using these additional data fields.

The Verba API allows to define unlimited number of custom fields using the Custom Meta Data Designer, which is available in the Verba Web Application. After defining the custom fields, 3rd party applications can use the API and insert information referring to the field definitions.

The function is available as a HTTP GET or HTTP POST request.

Request

Attach Metadata:

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

Attach Metadata HTTP GET sample:

http://192.168.1.104/verba/api?action=AttachMetaData&apiKey=74c8eea0-50c6-40b2-9f3e-252ed501c3c8&token=09835e02-6c10-11e0-bb22-ba324924019b&responseType=HTML&callID=a8343631-9f35-4a3a-83f0-9e81592339fb&customVariable1=ACME&customVariable2=John%20Smith

Parameters

Detailed description of the API request elements:

URL parameterExample

Description

Requirements
actionaction=AttachMetaDataName 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, which the metadata is attached to.Either the callID or either the number parameter is mandatory
extensionextension=8856Defines the phone number that is a participant of the call which the metadata is attached to. The API will look for a call with the status defined, 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
customVariable1customVariable1=ACMEKey-value pair defining the identifier of the custom field variable and the data itself. The custom variable field identifier has to match exactly the ID defined in the Custom Meta Data Designer.-
customVariable2customVariable2=John%20SmithKey-value pair defining the identifier of the custom field variable and the data itself.-
Additional reserved parameters for appending Conference Participants only from Verba 8.2
meetingIDmeetingID=T0MZJ99JDefines the conference ID, which will define every conference leg in Verba. This parameter can be used for simple metadata attaching.-
participantsparticipants=3564,customer@company.comList of the participating phone numbers or SIP URIs-
startTimesstartTimes=2015-02-22 23:00:00.000,2015-02-22 23:10:00.000

List of the participants' join time. The sequence of join times has to match with the participants parameter sequence to insert the proper join time of the participant.

Format is either "YYYY-MM-DD hh:mm:ss.SSS", "YYYY-MM-DD hh:mm:ss" or "YYYY-MM-DD hh:mm"

-
endTimesendTimes=2015-02-22 23:15:00.000,2015-02-22 23:16:00.000

List of the participants' leave time. The sequence of end times has to match with the participants parameter sequence to insert the proper leave time of the participant.

Format is either "YYYY-MM-DD hh:mm:ss.SSS", "YYYY-MM-DD hh:mm:ss" or "YYYY-MM-DD hh:mm"

-

Response

XML based response sample on success:

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

<VerbaApi>

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

</VerbaApi>

 

XML based response sample on error:

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

<VerbaApi>

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

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

</Response>

</VerbaApi>

 

HTML based response sample:

<html>

<body>

<p>The system successfully attached the metadata to the defined call.</p>

</body>

</html>

 

TEXT based response sample:

The system successfully attached the metadata to the defined call.