Chatbots

Iniciar chatbot

POSThttps://api.seudominio.com.br/integrations/v1/chatbots/{id}/start

Inicia um chatbot de automação com o contato, abrindo a conversa se preciso.

O chatbot é validado antes de qualquer outra coisa: se não estiver publicado ou liberado para a API, nada é criado (nem contato, nem conversa).

Parâmetros de caminho

idstring (uuid)obrigatório

Id do chatbot.

Corpo da requisição

application/json

conversation_idinteger

Conversa de destino. Tem prioridade sobre contato e telefone.

contact_idinteger

Contato de destino. Usa a conversa mais recente dele (ou abre uma).

phone_numberstring (telefone)

Telefone do contato. Se não existir, o contato é criado. Aceita DDD + número ou +55...

namestring

Nome usado ao criar o contato pelo telefone.

channel_idstring (uuid)

Canal usado para abrir a conversa quando o contato ainda não tem uma. Sem ele, usa o primeiro canal conectado.

Corpo para testar

Respostas

AnteriorListar chatbots Próximo Gatilho por webhook

Token (Bearer)

Fica só nesta aba do navegador e é usado nos exemplos abaixo.

curl --request POST \
  --url 'https://api.seudominio.com.br/integrations/v1/chatbots/{id}/start' \
  --header 'Authorization: Bearer sk_SEU_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "phone_number": "11999990000",
  "name": "Maria"
}'

A chamada é real: age sobre os dados do seu workspace.

Resposta

{
  "conversation_id": 120,
  "contact_id": 35
}