Pular para o conteúdo principal
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
queue
Fila (Depreciada)
curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/queue \
  --header 'Client-Token: <api-key>'
Este endpoint esta obsoleto, pois o modelo de paginacao foi atualizado para um formato baseado em cursor (pagingState). Utilize o novo endpoint POST /queue. Descontinuacao programada: Este endpoint sera removido em 30/04.

​
Conceituação

Este método é responsável por retornar todas mensagens que estão em sua fila aguardando para ser processada.

​
Atributos

​
instanceId
string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
​
token
string
obrigatório
Token da sua instância Z-API.

​
Query Parameters

​
page
integer
obrigatório
Utilizado para paginação, informe a página de mensagens que quer buscar
​
pageSize
integer
obrigatório
Especifica o tamanho do retorno de mensagens por página
Para retornar apenas a contagem total de mensagens na fila, utilize: GET /queue/count

​
Response

​
200

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

​
405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no início deste tópico.

​
415

Caso você receba um erro 415, certifique de adicionar na headers da requisição o “Content-Type” do objeto que você está enviando, em sua grande maioria “application/json”.