Fila

Método#

/queue#

GET https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/queue

Conceituação#

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

Atributos#

Obrigatórios#

Atributos	Tipo	Descrição

Opcionais#

Atributos	Tipo	Descrição

Request Params#

URL exemplo#

Método

GET https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/queue

Response#

200#

Atributos	Tipo	Descrição
size	string	Numero de mensagens na fila
messages	array string	Array com as menssagens da fila

Array Messages

Atributos	Tipo	Descrição
size	string	Numero de mensagens na fila
Message	string	Texto da Mensagem
Phone	string	Fone do destinatário
ZaapId	string	ID da mensagem no Z-API
Created	timetamp	Data da mensagem
MessageId	string	ID da mensagem

Exemplo

{
  "size": 2,
  "messages": [
    {
      "Message": "Mensagem da fila 1",
      "Phone": "5511999999999",
      "ZaapId": "39BB1684570F00E91090F6BBC7EE7646",
      "Created": 1624977905648,
      "MessageId": "7AD29EAA5EF34C301F0B"
    },
    {
      "Message": "Mensagem da fila 2",
      "Phone": "5511999999999",
      "ZaapId": "39BB1685172AB008542A7E0B862A54DF",
      "Created": 1624977906907,
      "MessageId": "517AEF0FDE834DADJJFC8"
    }
  ]
}

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"