Pular para o conteúdo principal
POST
/
wa
/
instances
/
{instance_id}
/
pairing-code
Detalhes de uma Instância
curl --request POST \
  --url https://api.zapsterapi.com/v1/wa/instances/{instance_id}/pairing-code \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone_number": "<string>"
}
'
{
  "pairing_code": "WVXCDFJ9"
}
O código de pareamento é uma alternativa ao QR Code para conectar uma instância do WhatsApp a um dispositivo. Ele permite autenticar e vincular a conta sem a necessidade de escanear um QR Code, tornando o processo mais prático em algumas situações.

​
🛠️ Quando Usar o Código de Pareamento?

  • Caso esteja conectando um dispositivo sem acesso a uma câmera para escanear o QR Code.
  • Se o processo de conexão precisar ser automatizado em um fluxo onde a leitura de QR Code não é viável.
  • Para oferecer uma opção alternativa ao QR Code, facilitando a conexão.

​
📌 Como Funciona?

  • O WhatsApp gera um código temporário para vinculação.
  • Esse código deve ser inserido no aplicativo WhatsApp no dispositivo que deseja conectar.
  • Após a confirmação, a instância será pareada e estará pronta para uso.

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
​
phone_number
string
obrigatório

Número de telefone para qual será gerado o código de pareamento. Formato DDI + DDD + Número

Resposta

200 - application/json

Success

​
pairing_code
string

Código de pareamento que o usuário deve colocar no Whatsapp para se conectar.

Exemplo:

"WVXCDFJ9"