API

API Integration allows you to access CosmoBots from another system, serving as a channel that is responsible for processing the sending and returning of messages between the user and the bot.

First you must choose which type of API you want and Enable it.

There are four API types: Messages, Conversations, Intentions and Users.

Below you will have a summary of the chosen API, with the method type, API Url, a brief description and the version.

Authentication

In this section you will have the botid and token required to perform the authentication.

Parameters

Return

Examples

The examples section is for you to understand and test, you can test a Simple Text, Text with Buttons and Cards. Taking into account the two tables above Parameters and Return, let's look at the example below:

In that case we sent the bot a "Hey There" type text. Now let's see how the Return will work:

Last updated