API

A Integração de API permite que você acesse o CosmoBots de outro sistema, servindo como um canal que é responsável por processar o envio e retorne de mensagens entre o usuário e o bot.

Primeiro você deve escolher qual o tipo de API que você deseja e Habilitá-la.

Existem quatro tipos de API: Mensagens, Conversas, Intenções e Usuários.

Logo abaixo você terá um resumo da API escolhida, com o tipo de método, Url da API, uma breve descrição e a versão.

Autenticação

Nessa seção você terá o botid e token necessários para realizar a autenticação.

Nome

Tipo

Descrição

botid

string

ID do seu bot no CosmoBots: 1866e980-d661-15e7-b7bf-cb2aa1b94640 (ID ilustrativo)

token

string

Chave Token específica para este bot, podendo ser usada em qualquer dos serviços de API disponíveis: 2973f350-06db-11e9-92ad-5b7ab3d1568c (token ilustrativo)

Parâmetros

Nome

Tipo

Descrição

uid

string

ID do usuário que conversa com o bot. Caso seja um novo usuário enviando a primeira mensagem enviar 'new_user'.

user

object

Caso seja um novo usuário, você tem a opção de enviar os seguintes campos padrões do usuário: first_name, last_name, email

type

string

Tipo de mensagem sendo enviada. Podem ser 5 opções: text (texto simples), payload (resposta ao clicar em um botão, por exemplo), image (conteúdo de uma imagem), audio (conteúdo de um áudio), video (conteúdo de um vídeo)

time

integer

Data/Hora em milisegundos de quando a mensagem foi enviada.

data

object

Conforme o tipo da mensagem definido acima, aqui será colocado o conteúdo/valor destes dados.

Retorno

Nome

Tipo

Descrição

uid

string

ID do usuário que conversa com o bot. No retorno, será informado o ID criado para este usuário e que deve ser usado nas chamadas seguintes.

time

integer

Data/Hora em milisegundos de quando a mensagem foi processada.

data

object

Aqui será colocado um array contendo 1 ou mais tipos de dados retornados. Existem 6 opções de tipo: text (texto simples), text_buttons (texto com botões), cards (cartões com imagem e botões), image (conteúdo de uma imagem), audio (conteúdo de um áudio), video (conteúdo de um vídeo)

Exemplos

A seção de exemplos serve pra você entender e testar, você pode testar um Texto Simples, Texto com botões e Cartões. Levando em consideração as duas tabelas acima de Parâmetros e Retorno, vamos analisar o exemplo abaixo:

Nesse caso nós enviamos para o bot um "Hey There" do tipo texto. Agora vamos ver como funcionará o Retorno: