Skip to main content
GET
/
instances
/
{instanceId}
/
token
/
{instanceToken}
/
phone-code
/
{phone}
Gerar código de pareamento
curl --request GET \
  --url https://api.ezapi.com.br/instances/{instanceId}/token/{instanceToken}/phone-code/{phone} \
  --header 'Client-Token: <api-key>'
{
  "pairingCode": "AZK7-KH39"
}
Solicita um código de pareamento para conectar a instância sem escanear QR Code.
Aliases consolidados da collection: Phone Code (Pairing Code), Pegar QRCode - Telefone.
O código de pareamento só é retornado quando a instância ainda não está conectada. A API aguarda até 15 segundos pela resposta do worker antes de responder com 408 Pairing code timeout.

Authorizations

​
Client-Token
string
header
required

Path Parameters

​
instanceId
string
required

Identificador único da instância.

Example:

"abc1234567890"

​
instanceToken
string
required

Token privado da instância retornado na criação.

Example:

"tok_a1b2c3d4e5f6"

​
phone
string
required

Número no formato internacional, sem +, espaços ou pontuação.

Example:

"5511999999999"

Response

Resposta de sucesso.

​
pairingCode
string
required
Example:

"AZK7-KH39"