Connect with phone

curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/phone-code/{phone} \
  --header 'Client-Token: <api-key>'

import requests

url = "https://api.z-api.io/instances/{instanceId}/token/{token}/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.z-api.io/instances/{instanceId}/token/{token}/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.z-api.io/instances/{instanceId}/token/{token}/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.z-api.io/instances/{instanceId}/token/{token}/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))

}

require 'uri'
require 'net/http'

url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/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

GET

instances

{instanceId}

token

{token}

phone-code

{phone}

Connect with phone

curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/phone-code/{phone} \
  --header 'Client-Token: <api-key>'

import requests

url = "https://api.z-api.io/instances/{instanceId}/token/{token}/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.z-api.io/instances/{instanceId}/token/{token}/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.z-api.io/instances/{instanceId}/token/{token}/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.z-api.io/instances/{instanceId}/token/{token}/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))

}

require 'uri'
require 'net/http'

url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/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

Overview

Allows connection without scanning the QRCode, using the “Connect with phone number” feature.

Attributes

string

required

Your instance ID. Available in the Z-API panel under Instances.

string

required

Your Z-API instance token.

Path

string

required

Phone number with country code (e.g.: 5511999999999)

Response

200

This endpoint may return the standard connection code, or, on devices that require the Passkey, return the Challenge object to continue the authentication process.

Example response for the connection code

{
  "value": "A1B2C3D4E5"
}

Example response for devices that require the Passkey

{
  "challenge": {
    "allowCredentials": [],
    "challenge": "V275tRcRUu2XjHiF9a6GTKFaZj8G4W_EEuRwdW5zCAM",
    "extensions": {
      "uvm": true
    },
    "rpId": "whatsapp.com",
    "timeout": 600000,
    "userVerification": "required"
  }
}

In cases where this response is returned, it is necessary to complete the authentication requested via the Challenge. For this, we have the Complete the Challenge endpoint.

405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.

​Overview

​Attributes

​Header

​Path

​Response

​200

​405

Overview

Attributes

Header

Path

Response

200

405