Comment faire un appel API vers l'application Ideta ?

Le but de cette documentation est de présenter la bulle de configuration des appels d'API, et de vous aider à mettre en place des appels d'API externes vers l'application Ideta.
En général, nous vous recommandons de toujours tester vos appels d'API avant de les déployer sur un canal, afin de vous assurer de la validité des paramètres.

Vous pouvez tester nos API dans Postman. Nous avons une liste avec la requête et les paramètres pré-remplis et le corps

Utilisation de la bulle API

Il est possible d'effectuer diverses actions via le bot en utilisant notre bulle API :

• Afficher la liste des conversations
• Afficher le contenu d'une conversation
• Redémarrer ou réinitialiser une conversation
• Supprimer, créer ou modifier des données
• Envoyer un message texte
• Activez l'affichage d'une bulle bot

Vous devez d'abord obtenir votre clé secrète et votre identifiant de robot. La clé est unique et vous permet d'accéder à distance au contenu de votre bot.

Vous trouverez votre ID de robot et votre clé secrète dans les onglets des paramètres.

L'identifiant de votre bulle se trouve dans l'URL, après "?node=".

Afficher la liste des conversations

Pour obtenir une liste de postes

Pour obtenir un certain nombre de conversations

Les options

• "channel="
  Vous pouvez trouver les différents canaux dans la section "publish".
• "startDate="
  Au format AAAA-MM-JJ, par exemple "2021-04-15".
• "endDate="
  Au format AAAA-MM-JJ, par exemple "2021-04-16".
• "conversation="
  Un ID de conversation spécifique - Vous pouvez le trouver dans les clés de données du bot
• "comparaisons="
  Une liste de comparaisons, séparées par des " ;".

Toutes ces options correspondent aux options de filtrage, que vous pouvez trouver dans l'onglet Cockpit. Regardez l'URL pour voir la syntaxe

Par exemple, cette requête donne une liste des conversations qui sont dans les canaux "sandbox" & "web" et dont le dernier message a été envoyé entre "2021-10-11" et"2021-10-14" et où les données "first_name" existent :

https://ideta.io/messaging/your_bot_id?channel=sandbox,web&startDate=2021-10-11&endDate=2021-10-14&comparisons=first_name, !

Afficher le contenu de la conversation

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

Reprendre une conversation

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

Réinitialiser une 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".

Supprimer ou créer/modifier des données

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

Envoyer un message texte

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

Activez l'affichage des bulles du bot

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