Fila
Message Queue
Fila
Retorna mensagens da fila aguardando processamento com suporte a paginacao por cursor
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 utilizandopagingState.
Atributos
Obrigatorios
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.
Body (Opcionais)
integer
Numero de mensagens retornadas por requisicao. Valor padrao: 20, maximo: 30.
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:Response
200
array
Lista de mensagens na fila
string
Cursor para a proxima pagina
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
pagingStateretornado para buscar as proximas paginas - Quando
hasMoreforfalse, nao existem mais mensagens disponiveis