Migrando o Tipo de Conexão
Migra a instância entre a conexão não oficial (QR Code) e a API oficial (WABA), preservando o ID, os webhooks e as configurações.
Não oficial para API oficial (WABA)
Envieconnection_type: "waba" junto com o objeto waba, contendo access_token, phone_number_id e waba_id.
waba.connected.
API oficial (WABA) para não oficial
Envieconnection_type: "unofficial", sem credenciais. A configuração WABA é removida com segurança na Meta e um novo ambiente de conexão é preparado. A instância fica disconnected, aguardando a leitura do QR Code (ou código de pareamento) para conectar o número.
Webhooks são revalidados
Os tipos de conexão suportam conjuntos diferentes de eventos de webhook, e a API oficial suporta um conjunto menor. Antes de migrar, os webhooks já cadastrados na instância são validados contra o tipo de destino: se algum estiver inscrito em um evento que o destino não emite, a migração é rejeitada com400 (unsupported_webhook_event), listando todos os eventos incompatíveis e os eventos válidos. Ajuste as inscrições e repita a chamada.
Confirmação para instâncias em uso
Migrar uma instância que não estádisconnected interrompe o serviço dela durante a troca, mesmo quando ela está apenas offline: só a instância já disconnected dispensa a confirmação. Nesse caso, a chamada exige o header X-Confirmation-Token, com um valor que identifique a confirmação (evite reenviar sempre o mesmo texto fixo). Sem ele, a API responde 409 (confirmation_required) e nada é alterado; o corpo da resposta traz em details o contexto da ação (action, resource, from, to e status).
Essa confirmação não é uma camada de segurança. Ela existe para evitar que uma migração disruptiva aconteça por engano, não para impedir chamadas mal-intencionadas.Autorizações
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Cabeçalhos
Token de confirmação, obrigatório quando a instância NÃO está
desconectada, inclusive quando está offline: a migração interrompe
o serviço dela durante a troca. Qualquer valor não vazio confirma a
chamada hoje; envie um valor que identifique a confirmação, sem fixar
sempre o mesmo texto. Sem o header nessa situação, a API responde
409 (confirmation_required).
Parâmetros de caminho
ID da instância.
Corpo
Tipo de conexão de destino:
unofficial: o metadata WABA é limpo e um pod é provisionado para a conexão por QR Codewaba: o pod é derrubado e o número é conectado pela Cloud API da Meta (exige credenciais)
unofficial, waba "waba"
Credenciais manuais da Cloud API da Meta, aceitas apenas
quando connection_type é waba.
Resposta
Success
Estrutura de uma instância registrada na API.
Data e hora de criação da instância no formato ISO 8601.
"2024-10-03T21:56:22.620Z"
Identificador único da instância.
"xy9rexnkwobmgg3tehgvs"
Metadados adicionais armazenados como chave e valor.
Nome da instância.
"MyNewInstance2"
Informações sobre o proprietário da instância.
Objeto opcional de configurações da sua instância.
Status atual da instância
connected, disconnected, offline "disconnected"
Lista de webhooks configurados para esta instância.
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)
unofficial, waba "unofficial"
QR Code da instância, caso disponível.
null
Identificador de pesquisa criado anteriormente.
"ins_8j7wlxmpjlixx9mux5"