Saltar al contenido principal
POST
Crear inbox

Autorizaciones

Authorization
string
header
requerido

Token JWT de autenticación

Encabezados

x-company-id
string

Identificador de la empresa objetivo. Obligatorio solo para API keys globales (type=global). Se ignora para API keys de empresa y usuarios humanos.

Cuerpo

application/json
name
string
requerido

Nombre del inbox

Minimum string length: 1
webhook_url
string

URL del webhook para notificaciones

Minimum string length: 1
number
string

Número de teléfono del inbox (formato internacional)

Pattern: ^\+.*
default_agent
string

ID del agente predeterminado para conversaciones nuevas

channel
enum<string>

Canal de comunicación (WAP_AUTO_CLOSER, etc.)

Opciones disponibles:
WAP_AUTO_CLOSER,
WEB_V2,
EVOLUTION_API,
LINKEDIN,
EMAIL,
WEBCHAT
api_wap_config
object

Configuración de la API de WhatsApp Business

evolution_api_config
object

Configuración de la Evolution API

test_mode
object

Configuración del modo de prueba

general_config
object

Configuración general del inbox

coexistence_enabled
any

Campo de solo lectura, sincronizado automáticamente desde Meta.

disable_inbound_ai
boolean

Opt-in. Cuando es true, la IA no atiende el inbound orgánico: las conversaciones nuevas nacen para atención humana. La IA sigue atendiendo los leads de campaña. Por defecto false.

pdf_local_text_extraction
boolean

Habilitación (opt-in) del modo híbrido de lectura de PDF. Cuando es true, el texto se extrae localmente y la IA recibe el TEXTO en lugar de la imagen (sigue en el circuito, solo reorganiza): sin límite de tamaño y sin tokens de visión. Vuelve al camino de visión cuando la lectura local no sirve (PDF escaneado, no PDF, ilegible). Valor predeterminado: false.

default_owner
string | null

Opt-in. ID del usuario propietario predeterminado de cualquier conversación nueva de este inbox (el propietario explícito del caller tiene precedencia). Null/ausente = sin propietario predeterminado.

webchat_config
object

Configuración editable del canal WEBCHAT — site_key/hmac_secret los genera el servidor

Respuesta

Inbox creado correctamente

name
string
requerido

Nombre del inbox

number
string
requerido

Número de teléfono del inbox

company
any
requerido

Empresa propietaria del inbox

channel
string
requerido

Canal de comunicación (WAP_AUTO_CLOSER, etc.)

status
enum<string>
requerido

Status del inbox (ACTIVE, DELETED)

Opciones disponibles:
ACTIVE,
DELETED
_id
string

ID del inbox

webhook_url
string

URL del webhook para notificaciones

test_mode
object

Configuración del modo de prueba

default_agent
any

Agente predeterminado para conversaciones nuevas

api_wap_config
object

Configuración de la API de WhatsApp Business (solo para el canal)

evolution_api_config
object

Configuración de la Evolution API

linkedin_config
object

Configuración de LinkedIn (Unipile)

general_config
object

Configuración general del inbox

coexistence_enabled
boolean

Habilita la ingesta de smb_message_echoes (WhatsApp Coexistence).

disable_inbound_ai
boolean

Opt-in. Cuando es true, la IA no atiende inbound orgánico (conversaciones nuevas para atención humana); la IA sigue atendiendo leads de campaña.

pdf_local_text_extraction
boolean

Habilitación (opt-in) del modo híbrido de lectura de PDF. Cuando es true, el texto se extrae localmente y la IA recibe el TEXTO en lugar de la imagen (sigue en el circuito, solo reorganiza): sin límite de tamaño y sin tokens de visión. Vuelve al camino de visión cuando la lectura local no sirve (PDF escaneado, no PDF, ilegible). Valor predeterminado: false.

default_owner
string | null

ID del usuario propietario predeterminado de las conversaciones nuevas de este inbox (opt-in). Null = sin propietario predeterminado.

createdAt
any

Fecha de creación del inbox

updatedAt
any

Fecha de actualización del inbox