Skip to main content
Uma instância representa uma conta WhatsApp Business vinculada ao Hub — mais especificamente, um número de telefone (phone_number_id) associado a um WABA (waba_id).

Estrutura de uma instância

Organização
└── Instância
    ├── phone_number_id  (ex: +55 11 99999-9999)
    ├── waba_id          (WhatsApp Business Account)
    ├── business_id      (Meta Business)
    └── access_token     (gerenciado pelo Hub)

Criando uma instância

A forma recomendada é via Embedded Signup — o fluxo OAuth da Meta que captura automaticamente todos os IDs e o token de acesso:
POST /api/onboarding/embedded-signup
{
  "code": "OAUTH_CODE_DA_META"
}
Você também pode criar manualmente se já tiver as credenciais:
POST /api/instances
{
  "phone_number_id": "1234567890",
  "waba_id": "0987654321",
  "business_id": "1122334455",
  "access_token": "EAABsbCS...",
  "display_phone_number": "+55 11 99999-9999"
}

Status de uma instância

StatusDescrição
ACTIVEFuncionando normalmente
INACTIVEDesativada pelo Hub
PENDINGAguardando ativação/registro

Identificando a instância nas requisições

Com um token de instância, o phone_number_id é resolvido automaticamente. Com um token de organização, passe o phone_number_id no body:
{
  "messaging_product": "whatsapp",
  "phone_number_id": "1234567890",
  "to": "5511999999999",
  "type": "text",
  "text": { "body": "Olá!" }
}