How to make API call to Ideta's app

The purpose of this documentation is to present the API call configuration bubble, and to help you set up external API calls to Ideta's app.
In general, we recommend that you always test your API calls before deploying them on a channel, in order to ensure the validity of the settings.

You can test our APIs in Postman. We have a list with the request and pre-filled parameters and the body

Using the API bubble

It is possible to perform various actions via the bot using our API bubble:

• Display the conversations list
• Display the content of a conversation
• Restart or reset a conversation
• Delete, create or edit data
• Send a text message
• Enable the display of a bot bubble

First you need to get your secret key and your bot ID. The key is unique and allows you to remotely access the content of your bot.

You can find your bot ID and your secret key on the settings tabs

Your bubble id can be found in the URL, after "?node="

Display the conversations list

To get a list of posts

To get a number of conversations

The options

• "channel="
  You can find the differents channels in the publish section
• "startDate="
  In the format YYYY-MM-DD, for exemple "2021-04-15"
• "endDate="
  In the format YYYY-MM-DD, for exemple "2021-04-16"
• "conversation="
  A specific conversation ID - You can find it in the bot data keys
• "comparisons="
  A list of comparisons, separated by ";"

All these options correspond to the filtering options, which you can find in the Cockpit tab. Look up at the URL to see the syntax

For example, this query gives a list of conversations that are in the channels "sandbox" & "web" and where the last message was sent between "2021-10-11" and "2021-10-14" and where the data "first_name" exist:
‍
https://ideta.io/messaging/your_bot_id?channel=sandbox,web&startDate=2021-10-11&endDate=2021-10-14&comparisons=first_name,!

Display the conversation content

You have to send a POST request to the url with the request bellow.
https://api.ideta.io/messages/extract/ {channel}

Restart a conversation

You have to send a POST request to the url with the request bellow
https://api.ideta.io/conversations/resume/{channel} 

Reset a conversation

You can also delete the conversation and restart it.
You have to send a POST request to the url with the request bellow
https://api.ideta.io/conversations/reset {channel}

If you choose to delete the data and/or the messages of the conversation, you need to " true " or " false " for "deleteData" and "deleteMessages".

Delete or create/edit data

You can add or modify bot data.
You have to send a POST request to the url with the request below
https://api.ideta.io/data/store/{channel}.

You can modify the value of a data.
If we indicate "true" in "bypassChecks", the data will be created if it does not exist

Send a text message

You have to send a POST request to the url with the request below
https://api.ideta.io/conversations/send-message/{channel}

Activate the bot bubble display

You have to send a POST request to the url with the request below
https://api.ideta.io/conversations/send-message/{channel}