Skip to main content
POST
Reconexão de Instância WABA
Use este endpoint para reconectar uma instância da API oficial (WABA) que foi desconectada, sem precisar excluí-la e criar outra. O ID da instância, os webhooks cadastrados e as configurações permanecem exatamente como estavam — você só fornece novamente as credenciais do número. Apenas instâncias com status disconnected podem ser reconectadas. Se a instância ainda estiver conectada, desconecte-a primeiro ou continue usando-a normalmente.

Credenciais

Envie o objeto waba com access_token, phone_number_id e waba_id — os mesmos campos aceitos na criação de instância. Campos opcionais como app_id, app_secret, webhook_verify_token e auth_method também são aceitos.
Se o número foi conectado pelo login com o Facebook, em vez de um token gerado no Meta Business Manager, faça a reconexão pelo painel da Zapster. Esse login precisa acontecer em uma página hospedada por nós e não pode ser reproduzido por chamada de API.

O que acontece na reconexão

Você não precisa refazer nada do que já estava configurado. Ao receber as credenciais, a Zapster:
  1. Confere o token com a Meta, para garantir que ele é válido e tem acesso ao número informado.
  2. Guarda as credenciais com segurança, criptografadas.
  3. Aponta as mensagens do número de volta para a sua instância, para que os webhooks voltem a chegar no endereço que você já tinha cadastrado.
  4. Conclui o registro do número na Meta, quando ainda for necessário.
Terminado isso, a instância volta ao status connected e volta a enviar e receber normalmente. Como o ID não muda, nada precisa ser alterado no seu código. Se alguma etapa falhar — token inválido, por exemplo — a instância continua desconectada e a resposta traz o motivo. Basta corrigir e chamar de novo.

Exemplos

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de caminho

instance_id
string
obrigatório

ID da instância.

Corpo

application/json
waba
object
obrigatório

Credenciais da Cloud API da Meta do número que será reconectado.

Resposta

Success

Estrutura de uma instância registrada na API.

created_at
string<date-time>
obrigatório

Data e hora de criação da instância no formato ISO 8601.

Exemplo:

"2024-10-03T21:56:22.620Z"

id
string
obrigatório

Identificador único da instância.

Exemplo:

"xy9rexnkwobmgg3tehgvs"

metadata
object
obrigatório

Metadados adicionais armazenados como chave e valor.

Exemplo:
name
string
obrigatório

Nome da instância.

Exemplo:

"MyNewInstance2"

owner
object
obrigatório

Informações sobre o proprietário da instância.

settings
object
obrigatório

Objeto opcional de configurações da sua instância.

status
enum<string>
obrigatório

Status atual da instância

Opções disponíveis:
connected,
disconnected,
offline
Exemplo:

"disconnected"

webhooks
object[]
obrigatório

Lista de webhooks configurados para esta instância.

connection_type
enum<string>

Tipo de conexão da instância:

  • unofficial: conexão via QR code (padrão)
  • waba: conexão via API oficial do WhatsApp (Cloud API da Meta)
Opções disponíveis:
unofficial,
waba
Exemplo:

"unofficial"

qrcode
string | null

QR Code da instância, caso disponível.

Exemplo:

null

lookup_key
string

Identificador de pesquisa criado anteriormente.

Exemplo:

"ins_8j7wlxmpjlixx9mux5"