Access to APIS

To access APIS, go to Preferences > Api > API access.

The identifier is botUUID.

Note that you will also need an Authorization that you can obtain by following the procedure on this page.

Click the link displayed if you want to access the servlet.

You can then view the different API accesses and make the desired changes for each item you can access.

Servlet

• Account: allows you to get all the bots that a user has access to.

• Account preferences: allows you to get information about user account preferences. You can also add or remove them.

• Authentication: allows you to generate a valid token for 24 hours.

• BO users: allows you to add a user.

• Bot preferences: allows you to get information about your bot's preferences. You can also add or remove them. See next section for more information from concrete use cases.

• Callback: allows you to manage various Twilio operations.

• Chat: allows you to manage various dialogs-related operations.

• Competencies: allows you to manage various operations related to competencies (adding a competency for a user account, deleting competency, etc.).

• Dialogs: allows you to perform massive dialogs exports.

• External matchers: allows you to manage various operations related to external matchers (check the status of the Luis mirror, export the database in Luis format, etc.).

• Knowledge base: allows you to import or export a knowledge base.

• Log Explicit: allows you to manage various log-related operations.

• Matching groups: allows you to get all the matching groups of your bot.

• Operators availability: allows you to know the availability of operators.

• Saml2 service provider for chatboxes: allows you to manage various SAML related operations.

• Server status: allows you to get information about server status and debug information.

• Surveys: allows to manage various operations on the surveys (creation of survey, retrieval of surveys, etc.).

• Transfer Bot Data: allows you to manage the import of data from your bot. You can import or export a gallery images.

• Who am I: allows you to retrieve the information received by the servlet.

Bot preferences

This part allows you to activate certain parameters within the dydu platform.

Enable SAML Service

In order to enable the SAML service on your platform, it may be necessary to add this preference to your bot preferences (if this has not been done yet). To do so, please follow the following procedure:

1. Go to Preferences > Api > API access and click the link provided.

2. Click Bot preferences.

3. Click PUT /preferences/bot/[botUUID]/{name}/{value}.

4. Fill in the fields:

   • **botUUID:**Your bot ID;

   • name: chatbox.auth.saml.menu.enabled;

   • value: true;

   • Authorization: generated token.

5. Click Execute.

   The SAML service is now available.

Enable monitored dialogs

In order to enable monitored dialogs on your platform, it may be necessary to add this preference to your bot preferences (if this has not been done yet). To do so, please follow the procedure:

1. Go to Preferences > Api > API access and click the link provided.

2. Click Bot preferences.

3. Click PUT /preferences/bot/[botUUID]/{name}/{value}.

4. Fill in the fields:

   • botUUID: your bot ID;

   • name: livechat.createmonitoreddialogs;

   • value: true;

   • Authorization: generated token.

5. Click Execute.

   Monitored dialogs are now available.

Customize the service name in the GDPR mail body

In order to customize the service name in the GDPR mail body, you must change the bot.servicename parameter in the preferences of your bot. To do so, please follow the procedure:

1. Go to Preferences > APIS > API access and click the link provided.

2. Click Bot preferences.

3. Click PUT /preferences/bot/[botUUID]/{name}/{value}.

4. Fill in the fields:

   • botUUID: your bot ID;

   • name: bot.servicename;

   • value: your service name;

   • Authorization: generated token.

5. Click Execute.

   The GDPR mail with the name of the service is now customized.

Enable matching group No associated with Social Bot

For a very large number of cases, this configuration is not necessary (pre-existing configuration).

In order to be able to optimally manage the confirmation when the user wants to leave Slot, you need your bot can handle the No matching group of the social bot. Otherwise, your bot may trigger the dropping of the knowledge Slot when the user did not want it. In order to complete this configuration, please follow these steps:

1. Go to Contents > Matching groups.

2. Click on the Social group to scroll through the groups and then click on the group No.

1. Click Dependencies.

2. Retrieve the UUID from the URL that matches the sequence of numbers and letters after the group = element. Thus, if the URL is: https://app1.earth.doyoudreamup.com/website/knowledges/groupgraph?group=07881a62-cc44-45c3-9aea-fc53727931f0, the information retrieved is: 07881a62-cc44-45c3-9aea-fc53727931f0

3. Go to Preferences > Api > API access and click the link provided.

4. Click Bot preferences.

5. Click PUT /preferences/bot/[botUUID]/{name}/{value}.

6. Fill in the fields:

   • botUUID: your bot ID;

   • name: bot.no.group.uuid;

   • value: enter the value retrieved when step 4;

   • Authorization: generated token.

7. Click Execute.

Your bot is now able to handle the No matching group associated with your server's social bot.