Queue (Deprecated)

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

import requests

url = "https://api.z-api.io/instances/{instanceId}/token/{token}/queue"

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}/queue', 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}/queue",
  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}/queue"

	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.z-api.io/instances/{instanceId}/token/{token}/queue")
  .header("Client-Token", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/queue")

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}

queue

Queue (Deprecated)

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

import requests

url = "https://api.z-api.io/instances/{instanceId}/token/{token}/queue"

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}/queue', 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}/queue",
  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}/queue"

	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.z-api.io/instances/{instanceId}/token/{token}/queue")
  .header("Client-Token", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/queue")

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

This endpoint is obsolete, as the pagination model has been updated to a cursor-based format (pagingState). Please use the new POST /queue endpoint. Scheduled discontinuation: This endpoint will be removed on 04/30.

Overview

This method is responsible for returning all messages in your queue awaiting processing.

Attributes

instanceId

string

required

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

token

string

required

Your Z-API instance token.

Query Parameters

page

integer

required

Used for pagination, specify the message page you want to fetch

pageSize

integer

required

Specifies the number of messages returned per page

To return only the total message count in the queue, use: GET /queue/count

Response

200

{
  "messages": [
    {
      "_id": "39BB1684570F00E91090F6BBC7EE7646",
      "DelayMessage": -1,
      "Message": "Queue message 1",
      "IsTrial": false,
      "InstanceId": "3A5D07856DC26A1C9E2E08E691E63271",
      "Phone": "5511999999999",
      "ZaapId": "39BB1684570F00E91090F6BBC7EE7646",
      "DelayTyping": 0,
      "MessageId": "7AD29EAA5EF34C301F0B",
      "Created": 1624977905648
    }
  ]
}

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.

415

If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.

Introduction Queue

​Overview

​Attributes

​Header

​Query Parameters

​Response

​200

​405

​415

Overview

Attributes

Header

Query Parameters

Response

200

405

415