In this section of the documentation, we have prepared a summary of the most interesting features that you can use in integrations with third-party systems.
For a complete overview of all REST API calls, please visit here.
Note: For on-premise deployments, adjust the default URL "app.mluvii.com".
Within campaigns, you can search for lists or specific campaigns. You can also create campaigns, change some of their parameters or delete them (if they have not been run). You can also use the API to change the status of campaigns (start, pause, end) or to add additional contacts to be called from the Contact directory.
Here we can, for example, anonymize a specific record in the Contact directory (within all sessions with a given contact), retrieve a list of contacts from the Contact directory sorted by ID, create a new contact in the Contact directory, retrieve a selected record from the Contact directory by ID, update or delete a specific contact in the Contact directory, or merge contacts into one.
Here you can check the availability of the selected group by ID.
Here you can export email messages to a .json file. You can export specific messages by ID, or choose bulk export where you can use and combine multiple conditions (sender email, processing date, etc.).
In the case of individual threads, you can export them (all messages including operator notes) according to their ID, add or delete tags, get (or update) parameters for a given email thread ID or, for example, get the routing history of an email thread.
If necessary, you can get information on all available forms.
Here you have the option to get a list of all existing groups, or just a detail of one in particular.
Anonymizes the identity of the client. Removes the relationship between the client's cookie and the client's identity ID within the Contact directory.
The API can be used to set up sending a callback URL (not valid for Microsoft Bot Framework chatbots), or sending a selected chatbot activity within a session.
For sessions, the API can be used to search for a session by session ID, anonymize individual sessions, retrieve (or update) parameters by session ID, add or delete tags by tagID or tag name. You can also get routing information for a given session or initiate an outgoing phone call. It is also possible to forward the current session (within the tenant) to a specific operator, group of operators or chatbot.
You can use the API to retrieve tag IDs, names or tags. This information can be used as the basis for subsequent REST API calls.
In the user area, you can search for users by their ID, retrieve all users, perform a password reset, retrieve the status of individual operators, set operator status, retrieve the status of all operators, and send/delete an invitation.
Here you can get, delete or update an individual webhook. Get all webhooks, register a webhook for an event or delete all webhooks.
At the widget level, you can use the API to change the widget's state once the current state has been detected. It is possible to modify the overall appearance and behavior of the widget. Alternatively, you can also set the specific form you want
An overview of all api commands can be found at this website.