API

A API permite enviar qualquer bloco ou flow através de uma solicitação POST API. Também permite enviar blocos para contatos com propriedades específicas.

Aqui está um exemplo de uma solicitação típica:

javascript
https://api.chatfuel.com/bots/<BOT_ID>/users/<USER_ID>/send?chatfuel_token=<TOKEN>&chatfuel_flow_name=<FLOW_NAME>&<USER_ATTRIBUTE_1>=<VALUE_1>&<USER_ATTRIBUTE_2>=<VALUE_2>

Com todos os dados preenchidos, sua solicitação deve ficar algo assim:

javascript
https://api.chatfuel.com/bots/612899e1a6ec6f5e0f2fe556/users/5949225915148689/send?chatfuel_token=jPvO73OSpKfQD9hwEb6EnrdgUwAHKQVEHHsNA25IbXEcVLA68myGXzjdXODaGhyS&chatfuel_block_id=63809fc68e17052f16c3ca01

Parâmetros e valores

Obrigatórios

Parâmetros:

chatfuel_token

Um destes parâmetros de roteamento:

chatfuel_flow_name
chatfuel_block_name
chatfuel_block_id

Valores da URL:

<BOT_ID>

<USER_ID>

Opcionais

Você pode adicionar estes para personalizar sua solicitação:

chatfuel_message_tag - Permite enviar mensagens fora da janela de 24 horas 🡽

<USER_ATTRIBUTE>=<VALUE> - Define propriedades personalizadas do usuário

Lista de parâmetros e valores disponíveis

Parâmetro	Descrição	Tipo
`chatfuel_token`	Token único para sua empresa	Obrigatório
`<BOT_ID>`	ID da sua empresa	Obrigatório
`<USER_ID>`	ID de um contato para o qual você quer enviar mensagem	Obrigatório
`chatfuel_flow_name`	Nome do seu flow	Obrigatório*
`chatfuel_block_name`	Nome do seu bloco	Obrigatório*
`chatfuel_block_id`	ID do seu bloco ou flow	Obrigatório*
`chatfuel_message_tag`	Tag para enviar mensagens fora da janela de 24 horas 🡽	Opcional
`<USER ATTRIBUTE>`	Nome e valor de uma propriedade do contato (Exemplo: `customertype=new`)	Opcional
`tags`	Lista de tags para definir para um contato (Exemplo: `tags=Helen,female,new_customer`). Novas tags substituirão as existentes.	Opcional

* Você deve incluir um destes três parâmetros de roteamento em sua solicitação: chatfuel_flow_name, chatfuel_block_name, ou chatfuel_block_id*

Como obter o token do Chatfuel

Vá para Configurações ➜ API.

Copiar chave da API para copiar seu token.

Se você precisar de um novo token, clique em Redefinir.

Como obter o ID da empresa

Um ID da empresa é uma combinação única de números e letras. Fica assim: 612899e1a6ec6f5e0f2fe556. Para obtê-lo:

Abra IA & Automação.

Clique na barra de endereços do seu navegador.

Copie o ID da sua empresa.

Como obter um ID de usuário

Existem dois tipos de IDs que você pode usar para o valor da URL <USER_ID>: user id ou chatfuel user id. A maneira mais fácil de obtê-los é procurá-los na aba Pessoas.

Abra Chat ao vivo.

Clique no seu nome na lista.

Encontre e copie um user id ou chatfuel user id.

Como obter ID para bloco ou flow

Um ID de bloco ou flow é similar a um ID de empresa: 61fbd2f0a2d3e66f2ed59de7.

Abra IA & Automação.

Abra seu flow.

Clique na barra de endereços do seu navegador.

Copie o ID do seu flow.

Para blocos:

Escolha seu bloco.

Copie o ID ao lado do ID do flow.

Regras

Você pode enviar até 25 RPS por bot para a API de Transmissão

Todos os parâmetros que começam com chatfuel_ são reservados e não devem ser usados