Skip to main content

Introdução

A API REST do WhataBot permite que você gerencie programaticamente sessões de conversa, fluxos, espaços de trabalho, setores e clientes OAuth. Todos os endpoints v1 são acessíveis através de requisições HTTP padrão que retornam respostas JSON.

URL Base

Todas as requisições da API v1 são feitas para:

Formato de Resposta

Todas as respostas são retornadas como JSON. Respostas bem-sucedidas usam códigos de status HTTP padrão (200, 201, 202, 204). Respostas de erro seguem o formato:

Paginação

Endpoints de listagem suportam paginação via parâmetros de consulta: Respostas paginadas incluem:

Autenticação

Todos os endpoints v1 usam autenticação por Chave de API via cabeçalho X-Api-Key:
Consulte a página de Autenticação para instruções de como criar sua chave de API.

Referência Rápida

Autenticação

Chaves de API e autenticação para iframe.

Webhooks

Receba notificações de sessões via callback.

Sessões

Crie e gerencie sessões de conversa.

Fluxos

Crie e liste fluxos de conversa.

Espaços de Trabalho

Gerencie espaços de trabalho.

Setores

Gerencie setores para transferências.