Inboxes

Um inbox é uma caixa de entrada — um canal de atendimento (por exemplo, um número de WhatsApp). Toda conversa pertence a um inbox, e é o inbox_id dele que você usa ao criar contatos e conversas.

Base e autenticação

As rotas desta página são relativas a /api/v1/accounts/{account_id} na base https://appchat01.interleads.chat e exigem o cabeçalho api_access_token.

Endpoints

Método	Rota	Descrição
GET	/inboxes	Lista os inboxes da conta
GET	/inboxes/{id}	Detalhes de um inbox
POST	/inboxes	Cria um inbox (requer um objeto channel)
PATCH	/inboxes/{id}	Atualiza um inbox
GET	/inboxes/{id}/agent_bot	Mostra o agent bot do inbox
POST	/inboxes/{id}/set_agent_bot	Liga/desliga o agent bot do inbox
GET	/inbox_members/{inbox_id}	Lista os agentes do inbox
POST	/inbox_members	Adiciona agentes (inbox_id, user_ids[])
PATCH	/inbox_members	Redefine a lista de agentes do inbox
DELETE	/inbox_members	Remove agentes do inbox

Listar inboxes

Este é o ponto de partida mais comum — pegar o inbox_id para usar nas demais chamadas:

curl "https://appchat01.interleads.chat/api/v1/accounts/3/inboxes" \
  -H "api_access_token: $INTERLEADS_TOKEN"

Cada item traz o id, o name e o tipo de canal do inbox.

Configurar um inbox

PATCH /inboxes/{id} atualiza opções de comportamento. Campos úteis: name, greeting_enabled / greeting_message, enable_auto_assignment, csat_survey_enabled, working_hours_enabled, timezone, allow_messages_after_resolved, lock_to_single_conversation, sender_name_type (friendly / professional), business_name.

curl -X PATCH "https://appchat01.interleads.chat/api/v1/accounts/3/inboxes/5" \
  -H "api_access_token: $INTERLEADS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "enable_auto_assignment": true,
    "greeting_enabled": true,
    "greeting_message": "Olá! Já já um atendente fala com você."
  }'

Agentes do inbox

Listar os agentes de um inbox:

curl "https://appchat01.interleads.chat/api/v1/accounts/3/inbox_members/5" \
  -H "api_access_token: $INTERLEADS_TOKEN"

Adicionar agentes (por user_ids):

curl -X POST "https://appchat01.interleads.chat/api/v1/accounts/3/inbox_members" \
  -H "api_access_token: $INTERLEADS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "inbox_id": 5, "user_ids": [7, 11] }'

Criar um inbox

POST /inboxes cria um inbox, mas o objeto channel varia conforme o tipo de canal (WhatsApp, e-mail, API etc.) e define toda a configuração de conexão.

Criação de canal costuma ser feita pelo painel

Conectar um novo número/canal envolve credenciais e etapas específicas de cada provedor. Na prática isso é feito pela tela de configuração da plataforma. Se você precisa criar inboxes programaticamente, fale com o suporte para receber o formato exato do channel do seu tipo de canal.

Erros comuns

Código	Significado
401	Token ausente ou inválido
404	Inbox não encontrado
422	Configuração inválida (ex.: channel incompleto ao criar)