Pular para o conteúdo principal
POST
Fila

Conceituacao

Este metodo retorna as mensagens que estao na fila aguardando processamento, com suporte a paginacao por cursor. Diferente do GET, este endpoint permite controlar a paginacao de forma mais eficiente utilizando pagingState.

Atributos

Obrigatorios

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.

Body (Opcionais)

pageSize
integer
Numero de mensagens retornadas por requisicao. Valor padrao: 20, maximo: 30.
pagingState
string
Cursor de paginacao. Quando nao informado, retorna a primeira pagina. Use o valor retornado na resposta para buscar as proximas paginas.

Request Body

Primeira pagina:
Proximas paginas:

Response

200

messages
array
Lista de mensagens na fila
pagingState
string
Cursor para a proxima pagina
hasMore
boolean
Indica se existem mais paginas

Paginacao

  • Caso nao envie pagingState, a primeira pagina sera retornada automaticamente
  • Caso nao informe pageSize, o valor padrao de 20 mensagens sera utilizado
  • O numero maximo de mensagens que podem ser retornadas por pagina e 30 mensagens
  • Utilize o pagingState retornado para buscar as proximas paginas
  • Quando hasMore for false, nao existem mais mensagens disponiveis

405

Neste caso certifique que esteja enviando corretamente a especificacao do metodo, ou seja verifique se voce enviou o POST ou GET conforme especificado no inicio deste topico.

415

Caso voce receba um erro 415, certifique de adicionar na headers da requisicao o “Content-Type” do objeto que voce esta enviando, em sua grande maioria “application/json”.