Swagger

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 Public API calls, please visit here.

For on-premise deployments, adjust the default URL "app.mluvii.com".

Campaigns

Chatbot

Companies

Contacts

Departments

EmailMessages

EmailThreads

Forms

Groups

Guests

Phones

Sessions

Tags

Users

Webhooks

Widgets

WhatsApp

Campaigns

Within campaigns, you can search for lists or specific campaigns. You can also create phone or WhatsApp campaigns, change some of their parameters, or delete them (if they have not been launched). You can also use the API to change the status of campaigns (start, pause, end) or add additional contacts for calling from the Contact Directory.

Chatbot

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.

Contacts

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.

Companies

This area of the API is primarily for the server administrator to use to retrieve the existing rest(s) and more details about each company's settings.

Departments

It is used to get a list of existing tenants and create new tenants within the company, or you can also use the API to add users to existing tenants. You can also check the status of the group queue for each communication channel.

EmailMessages

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.). Last but not least, you can use the API to generate email messages for your operators. The address and content of the email can already be pre-populated, as well as relevant attachments can be included with the email message.

EmailThreads

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.

Forms

If necessary, you can get information on all available forms.

Groups

Here you have the option to get a list of all existing groups, or just a detail of one in particular.

Guests

Anonymizes the identity of the client. Removes the relationship between the client's cookie and the client's identity ID within the Contact directory.

Phones

It is useful for getting all available phone numbers for a given company and also in case of making an outgoing call or getting data for analysis of a specific phone call.

Sessions

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, and 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.

Tags

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.

Users

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.

Webhooks

Here you can get, delete, or update an individual webhook. Get all webhooks, register a webhook for an event, or delete all webhooks.

Widgets

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.

WhatsApp

The current API has 3 endpoints

• GET /api/v1/WhatsApp

• POST /api/v1/WhatsApp/{id}/sendTemplates

• GET /api/v1/WhatsApp/{id}/sentTemplates

The first endpoint returns all WA subscriptions(id, tenant id, name and phone number). Parameter id is a value that you need for other endpoints.

The second endpoint is for the bulk sending of WA messages with the parameters below

• formID - id of form in mluvii

• language - language version of form

• recipients - an array of contacts to whom you want to send the form (Template Message)

  • contactId - phone number in international format

  • fieldValues - values that will replace placeholders in form. Values must be in the same order as you want them in form

The third endpoint returns data about sent messages for WA subscriptions. You can filter values with * since, offset, and limit attributes.

An overview of all API commands can be found here.