URLs

All the requests to access the REST api have the form https://www.babelway.net/SelfService3/rest/v2/hub-{hubId}/{action}.{format}?{parameters}, where

hubId	The id of your environment. It can be found in the Environment settings section, under the Admin menu.
format	The format in which you want to receive the answer. It must be 'json' or 'xml'. All actions support the 2 formats.
action and parameters	The name and parameters of the action you want to call. All available actions and parameters are documented in this section.

Authentication

All requests require authentication.

The API currently supports HTTP Basic Authentication.. Credentials can be provided either through the standard Authorization header or via the additional userName and pwd parameters.

Authentication uses the username and password associated with your user account. Please note that, due to a current limitation, API access is only supported for users who do not have Multi-Factor Authentication (MFA) enabled.

For security reasons, the Babelway REST API must always be accessed over an HTTPS (SSL/TLS) connection to ensure that credentials are encrypted during transmission.

Representations

All timestamps should be formatted as the number of milliseconds since January 1, 1970 (midnight UTC/GMT).

Babelway Database optimization

The Babelway Database is optimized in order to have very fast access to all recent messages (received in the last 7 days) and the older messages are archived.

To have a fast response when making API calls to the Babelway system, it is best to add a criteria like "Received in the last 7 days" or something like "Every day".