Pular para o conteúdo

Bots

Gerencie bots de atendimento automatizado. Bots podem ser configurados por conta ou globalmente na plataforma.

Bots da Conta

GET/api/v1/accounts/{account_id}/agent_bots

Lista os bots configurados na conta.

200Lista de bots
json
[
  {
    "id": 1,
    "name": "Bot Boas-vindas",
    "description": "Recepciona novos contatos",
    "outgoing_url": "https://meuapp.com/bot/webhook",
    "account_id": 1
  }
]
POST/api/v1/accounts/{account_id}/agent_bots

Cria um novo bot na conta.

Body

NomeTipoObrigatorioDescricao
namestringSimNome do bot
descriptionstringNaoDescricao
outgoing_urlstringSimURL do webhook que recebe mensagens para o bot processar
bash
curl -X POST "https://chat.seudominio.com/api/v1/accounts/1/agent_bots" \
  -H "api_access_token: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Bot Triagem",
    "description": "Faz triagem inicial das conversas",
    "outgoing_url": "https://meuapp.com/bot/triagem"
  }'
PATCH/api/v1/accounts/{account_id}/agent_bots/{id}

Atualiza um bot da conta.

DELETE/api/v1/accounts/{account_id}/agent_bots/{id}

Remove um bot da conta.

Bots de Agente (Platform API)

Bots globais gerenciados pela Platform API. Requerem token de plataforma.

GET/platform/api/v1/agent_bots

Lista todos os bots da plataforma.

POST/platform/api/v1/agent_bots

Cria um bot global na plataforma.

Body

NomeTipoObrigatorioDescricao
namestringSimNome do bot
descriptionstringNaoDescricao
outgoing_urlstringSimURL do webhook
GET/platform/api/v1/agent_bots/{id}

Obtem detalhes de um bot.

PATCH/platform/api/v1/agent_bots/{id}

Atualiza um bot.

DELETE/platform/api/v1/agent_bots/{id}

Remove um bot.