Crear instância WhatsApp

curl --request POST \ --url https://api.notifique.dev/v1/whatsapp/instances \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "name": "Soporte", "mode": "UNOFFICIAL" } '

{ "success": true, "data": { "instance": { "id": "inst_abc", "name": "Soporte", "status": "PENDING", "phoneNumber": null, "mode": "UNOFFICIAL" }, "connection": { "status": "pending_qr", "base64": "data:image/png;base64,...", "code": "2@...", "count": 1 } } }

Autorizaciones

Authorization

string

header

requerido

API Key no header Authorization. Exemplo: Authorization: Bearer sk_live_xxxxx

Cuerpo

application/json

name

string

requerido

Nombre para identificar este número en el panel (ej.: Soporte, Ventas).

Required string length: 3 - 1024

expectedPhoneNumber

string

Opcional. Número internacional que espera conectar (ej.: 5511999999999). Si escanea otro chip, la API responde 409.

Required string length: 10 - 20

generateShareableLink

boolean

predeterminado:false

Genera un enlace para que otra persona termine la conexión. Use true cuando quien va a escanear o iniciar sesión en Meta no está en su pantalla. Omita o use false para recibir el QR en la respuesta y mostrarlo en su interfaz.

metaEmbeddedCode

string

Código de Facebook al completar el registro Meta en el navegador (Embedded Signup). Obligatorio en la línea oficial, salvo con enlace compartible.

metaPhoneNumberId

string

ID del número en Meta (línea oficial).

metaWabaId

string

ID de la cuenta WhatsApp Business en Meta (línea oficial).

metaBusinessId

string

ID opcional del portafolio Business en Meta.

metaPin

string

PIN opcional de registro del número en Cloud API de Meta.

mode

enum<string>

Tipo de conexión. UNOFFICIAL (predeterminado): QR en el celular, ideal para pruebas. OFFICIAL: línea Meta (registro en navegador o enlace para el cliente). OFFICIAL_BYOK: línea Meta con token e IDs que ya posee. OFFICIAL_BSP: reservado.

Opciones disponibles:

UNOFFICIAL,

OFFICIAL,

OFFICIAL_BYOK,

OFFICIAL_BSP

metaAccessToken

string

Token de acceso permanente de Meta (modo BYOK — credenciales propias).

Respuesta

Número registrado. Si aún falta conectar, la respuesta trae el QR (connection.base64) o un enlace (shareableLink) para terminar.

success

boolean

Ejemplo:

true

data

object

Show child attributes