OverviewAdds 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.
Attach Metadata HTTP GET sample:
Detailed description of the API request elements:
|action||action=AttachMetaData||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.|
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=a8343631-9f35-4a3a-83f0-9e81592339fb||Defines the internal ID of the call, which the metadata is attached to.||Either the callID or either the number parameter is mandatory|
|extension||extension=8856||Defines 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|
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|
|customVariable1||customVariable1=ACME||Key-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.||-|
|customVariable2||customVariable2=John%20Smith||Key-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|
|meetingID||meetingID=T0MZJ99J||Defines the conference ID, which will define every conference leg in Verba. This parameter can be used for simple metadata attaching.||-|
|participants||participants=3564,email@example.com||List of the participating phone numbers or SIP URIs||-|
|startTimes||startTimes=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.
|endTimes||endTimes=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.
XML based response sample on success:
<?xml version="1.0" encoding="UTF-8"?>
<Response code="0" type="AttachMetaData"/>
XML based response sample on error:
<?xml version="1.0" encoding="UTF-8"?>
<Response code="2" type="AttachMetaData">
<ErrorMessage description="Error">Unable to attach the metadata to the call, because the call cannot be found.</ErrorMessage>
HTML based response sample:
<p>The system successfully attached the metadata to the defined call.</p>
TEXT based response sample: