Ir al contenido

Beta privada · apertura 23 de diciembre

Crea una conexión de WhatsApp, Instagram o Messenger

POST /v1/conecta/conexiones

Crea la conexión y devuelve alta_url para que una persona complete el alta con el proveedor. El proveedor es un dato de la conexión: tu integración no cambia si el número pasa de un proveedor a otro.

Dato Valor
Permiso conecta:administrar
Cobro No cobra.
Idempotency-Key Opcional
Herramienta MCP conexion_crear (Próximamente)
Nombre En Requerido Tipo Descripción
Idempotency-Key header No string Identifica una operación para que repetirla no la duplique. Si repites la petición con la misma clave y el mismo cuerpo, recibes la misma respuesta; con otro cuerpo, idempotencia_en_conflicto. Se guarda 24 horas.
X-Request-Id header No string Identificador de la petición. Va en cada respuesta; menciónalo al escribir a soporte.

application/json, obligatorio. Los campos anidados van con punto y los de listas con []. No se aceptan campos desconocidos.

Campo Tipo Requerido Descripción
proveedor “zernio” | “ycloud” | “meta” Sí Por dónde sale la conexión. Puedes pasar un número de un proveedor a otro sin cambiar tu integración.
canal “whatsapp” | “instagram” | “messenger” Sí
nombre string Sí Para reconocerla, por ejemplo «WhatsApp de ventas».
telefono string No Solo WhatsApp: el número a conectar, si ya lo sabes.

Contra el sandbox, con una clave onx_test_…:

Ventana de terminal
curl -X POST "https://api-sandbox.opennexum.com/v1/conecta/conexiones" \
-H "Authorization: Bearer onx_test_…" \
-H "Content-Type: application/json" \
-d '{
"proveedor": "zernio",
"canal": "whatsapp",
"nombre": "texto"
}'

Conexión creada, pendiente de alta.

Campo Tipo Requerido Descripción
id string Sí Identificador que empieza con con_.
proveedor “zernio” | “ycloud” | “meta” Sí Por dónde sale la conexión. Puedes pasar un número de un proveedor a otro sin cambiar tu integración.
canal “whatsapp” | “instagram” | “messenger” Sí
nombre string Sí
estado “pendiente” | “activa” | “desconectada” | “error” Sí
telefono string | null Sí
cuenta string | null Sí Usuario de Instagram o página de Facebook, si aplica.
alta_url string (uri) | null Sí Mientras está pendiente: dónde termina el alta una persona.
creada_en string (date-time) Sí Fecha y hora ISO 8601 con la zona de Lima (-05:00).
ultima_prueba_en string (date-time) | null Sí

Cada código tiene su explicación en Errores.