Criar 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": "Suporte", "mode": "UNOFFICIAL" } '

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

Autorizações

Authorization

string

header

obrigatório

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

Corpo

application/json

name

string

obrigatório

Nome para identificar este número no painel (ex.: Suporte, Vendas).

Required string length: 3 - 1024

expectedPhoneNumber

string

Opcional. Número internacional que você espera conectar (ex.: 5511999999999). Se escanear outro chip, a API responde 409.

Required string length: 10 - 20

generateShareableLink

boolean

padrão:false

Gera um link para outra pessoa concluir a conexão. Use true quando quem vai escanear ou fazer login Meta não está na sua tela. Omita ou use false para receber o QR direto na resposta e exibir na sua interface.

metaEmbeddedCode

string

Código retornado pelo Facebook ao concluir o cadastro Meta no navegador (Embedded Signup). Obrigatório na linha oficial, salvo quando usar link compartilhável.

metaPhoneNumberId

string

ID do número na Meta (linha oficial).

metaWabaId

string

ID da conta WhatsApp Business na Meta (linha oficial).

metaBusinessId

string

ID opcional do portfólio Business na Meta.

metaPin

string

PIN opcional de registro do número na Cloud API da Meta.

mode

enum<string>

Tipo de conexão. UNOFFICIAL (padrão): QR no celular, ideal para testes. OFFICIAL: linha Meta (cadastro no navegador ou link para o cliente). OFFICIAL_BYOK: linha Meta com token e IDs que você já possui. OFFICIAL_BSP: reservado.

Opções disponíveis:

UNOFFICIAL,

OFFICIAL,

OFFICIAL_BYOK,

OFFICIAL_BSP

metaAccessToken

string

Token de acesso permanente da Meta (modo BYOK — credenciais próprias).

Resposta

Número cadastrado. Se ainda falta conectar, a resposta traz o QR (connection.base64) ou um link (shareableLink) para concluir.

success

boolean

Exemplo:

true

data

object

Show child attributes