Low-level XML Recorder API

Owned by Kiss, Mate
May 24, 2022

Overview

The Verba Recording System provides a low level XML API directly to the recording engines.

Not all recorder services supports this API, for further information, please consult Verba Technologies.

The recorder service listens on the configured TCP port. For the default API port numbers, see Firewall configuration, port usage. The API protocol is based on XML and transmitted over TCP directly. No HTTP or other layers are present in the messages.

All of API requests are formed in XML documents, which are UTF-8 encoded. 3rd party applications, which implement the API, have listen on the TCP socket for incoming API connections. Connections sometimes are immediately closed after the response, and may be kept open for later use (sending notifications). To handle asynchronous requests, all requests should contain an ID, which is sent back in the response messages.

The API provides the following functionalities:

Request sample

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

<VerbaApi>

<Request type="GetManagementSummary" id="N"/>

</VerbaApi>

Response for successful request sample

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

<VerbaApi>

<Response code="0">

<Request type="GetManagementSummary" id="N"/>

</Response>

</VerbaApi>

Response for failed request sample

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

<VerbaApi>

<Response code="2" type="GetManagementSummary" id="N"/>

<ErrorMessage description="Processing Error">Escaped detailed error message (e.g. the full text of an exception)</ErrorMessage>

</Response>

</VerbaApi>