User API

11 January 2021

The API defines the methods used for integrating a user with an external system.

Call notification

This option allows for an external system to be notified when a call (that the user is a part of, either outgoing or incoming) is answered of hung up. The communication between Accolades and the external service consists of HTTP or HTTPS requests.

The following parameters can be defined:

Status: (active or inactive) if active then Accolades will send the notification, if inactive then the rest of the parameters are not available;
Protocol: (http sau https) defines the protocol used to send the notification;
Server: the server (IP of FQDN) where the notification is sent to;
Port: the port used for sending the notification;
Cale: the path for the file that will receive the notification (the path cannot be empty and it has to start with "/");

The structure used for a notification is detailed inside the API chapter of this document, the "Call notification" section.

Configuration

Accolades can save up to 2000 characters for each plarform user.

When an application is connected to the server, using an API, Accolades will send the text, on request. It is recommended to use existing standards for saving data (JSON, XML etc.). Accolades will not perform any validation on the text, it will be saved and sent as plain text, in a raw format.

More info about the options for reading this data, using the available API interfaces can be found on the API section of this documentation.