Skip to main content
GET
Fila (Depreciada)
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

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

Query Parameters

integer
obrigatório
Utilizado para paginação, informe a página de mensagens que quer buscar
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

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”.