Documentation Index
Fetch the complete documentation index at: https://developer.z-api.io/llms.txt
Use this file to discover all available pages before exploring further.
Conceituação
Método utilizado para finalizar a transferência do WhatsApp do celular para a instância. Ele deve ser utilizado após o endpoint de Confirmar código retornar deviceConfirm: true no response.
Confirme a transferência no celular antes de fazer a requisição.Ao receber deviceConfirm: true, o WhatsApp exibirá uma notificação no celular onde está registrado solicitando a confirmação da transferência. Somente após aceitar essa confirmação no aparelho é que você deve chamar este endpoint. Caso contrário, a conexão não será transferida para a instância.
Fluxo esperado
- O endpoint Confirmar código retorna
"deviceConfirm": true
- O usuário confirma a transferência no celular onde o WhatsApp está registrado
- Após a confirmação no aparelho, chame este endpoint
- A conexão do WhatsApp é transferida do celular para a instância
Atributos
ID da sua instância. Disponível no painel Z-API em Instâncias.
Token da sua instância Z-API.
Response
200
Retorna true caso a transferência tenha sido confirmada com sucesso e a instância esteja conectada.
400
Requisição inválida. Verifique se a confirmação no celular foi realizada antes de chamar este endpoint.
405
Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no início deste tópico.
415
Caso você receba um erro 415, certifique de adicionar na headers da requisição o “Content-Type” do objeto que você está enviando, em sua grande maioria “application/json”.