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>'
import requests

url = "https://api.ezapi.com.br/instances/{instanceId}/token/{instanceToken}/phone-code/{phone}"

headers = {"Client-Token": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'Client-Token': '<api-key>'}};

fetch('https://api.ezapi.com.br/instances/{instanceId}/token/{instanceToken}/phone-code/{phone}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.ezapi.com.br/instances/{instanceId}/token/{instanceToken}/phone-code/{phone}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Client-Token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.ezapi.com.br/instances/{instanceId}/token/{instanceToken}/phone-code/{phone}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Client-Token", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.ezapi.com.br/instances/{instanceId}/token/{instanceToken}/phone-code/{phone}")
  .header("Client-Token", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.ezapi.com.br/instances/{instanceId}/token/{instanceToken}/phone-code/{phone}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Client-Token"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "pairingCode": "AZK7-KH39"
}
{
  "error": "Unauthorized",
  "message": "Invalid instanceToken"
}
{
  "error": "Instance not found"
}
{
  "error": "Instance is already connected"
}
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"