Skip to main content
POST
Criar inbox

Autorizações

Authorization
string
header
obrigatório

Token JWT de autenticação

Cabeçalhos

x-company-id
string

Identificador da empresa-alvo. Obrigatório apenas para API Keys globais (type=global). Ignorado para API Keys de empresa e usuários humanos.

Corpo

application/json
name
string
obrigatório

Nome do inbox

Minimum string length: 1
number
string
obrigatório

Número de telefone do inbox (formato internacional)

Minimum string length: 1
Pattern: ^\+.*
webhook_url
string

URL do webhook para notificações

Minimum string length: 1
default_agent
string

ID do agente padrão para novas conversas

channel
enum<string>

Canal de comunicação (WAP_AUTO_CLOSER, etc)

Opções disponíveis:
WAP_AUTO_CLOSER,
WEB_V2,
EVOLUTION_API,
LINKEDIN,
EMAIL
api_wap_config
object

Configurações da API do WhatsApp Business

evolution_api_config
object

Configurações da Evolution API

test_mode
object

Configurações de modo de teste

general_config
object

Configurações gerais do inbox

coexistence_enabled
any

Campo somente leitura, sincronizado automaticamente a partir da Meta.

process_unsupported_messages
boolean

Permite que mensagens UNSUPPORTED da Meta sigam o fluxo normal do agent em vez de serem puladas. Default false.

disable_inbound_ai
boolean

Opt-in. Quando true, a IA não atende inbound orgânico (novas conversas nascem para atendimento humano); a IA segue atendendo leads de campanha. Default false (aplicado via Mongoose schema).

pdf_local_text_extraction
boolean

Opt-in do modo híbrido de leitura de PDF. Quando true, o texto é extraído localmente e a IA recebe o TEXTO em vez da imagem (ela segue no circuito, só reorganiza): sem limite de tamanho e sem tokens de visão. Cai de volta no caminho de visão quando a leitura local não serve (PDF escaneado, não-PDF, ilegível). Default false.

default_owner
string | null

Opt-in. ID do usuário dono padrão de qualquer conversa nova deste inbox (dono explícito do caller tem precedência). Null/ausente = sem dono padrão.

Resposta

Inbox criado com sucesso

name
string
obrigatório

Nome do inbox

number
string
obrigatório

Número de telefone do inbox

company
any
obrigatório

Empresa proprietária do inbox

channel
string
obrigatório

Canal de comunicação (WAP_AUTO_CLOSER, etc)

status
enum<string>
obrigatório

Status do inbox (ACTIVE, DELETED)

Opções disponíveis:
ACTIVE,
DELETED
_id
string

ID do inbox

webhook_url
string

URL do webhook para notificações

test_mode
object

Configurações de modo de teste

default_agent
any

Agente padrão para novas conversas

api_wap_config
object

Configurações da API do WhatsApp Business (apenas para canal)

evolution_api_config
object

Configurações da Evolution API

linkedin_config
object

Configurações do LinkedIn (Unipile)

general_config
object

Configurações gerais do inbox

coexistence_enabled
boolean

Habilita ingestao de smb_message_echoes (WhatsApp Coexistence).

process_unsupported_messages
boolean

Permite que mensagens UNSUPPORTED da Meta sigam o fluxo normal do agent.

disable_inbound_ai
boolean

Opt-in. Quando true, a IA não atende inbound orgânico (novas conversas para atendimento humano); a IA segue atendendo leads de campanha.

pdf_local_text_extraction
boolean

Opt-in do modo híbrido de leitura de PDF. Quando true, o texto é extraído localmente e a IA recebe o TEXTO em vez da imagem (ela segue no circuito, só reorganiza): sem limite de tamanho e sem tokens de visão. Cai de volta no caminho de visão quando a leitura local não serve (PDF escaneado, não-PDF, ilegível). Default false.

default_owner
string | null

ID do usuário dono padrão das conversas novas deste inbox (opt-in). Null = sem dono padrão.

createdAt
any

Data de criação do inbox

updatedAt
any

Data de atualização do inbox