Fila
Método#
/queue#
GET https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/queue
Header#
| Key | Value |
|---|---|
| Client-Token | TOKEN DE SEGURANÇA DA CONTA |
Conceituação#
Este método é reponsavel por retornar todas mensagens que estão em sua fila aguardando para ser processada.
Atributos#
Obrigatórios#
| Atributos | Tipo | Descrição |
|---|---|---|
| page | integer | Utilizado para paginação você de informar aqui a pagina de mensagens que quer buscar |
| pageSize | integer | Especifica o tamanho do retorno de mensagens por pagina |
Opcionais#
| Atributos | Tipo | Descrição |
|---|---|---|
| count | string | Atributo utilizado para retornar o número de mensagens na fila |
Request Params#
URL exemplo#
Método
GET https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/queue?page=1&pageSize=100
ou
GET https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/queue/count
Response#
200#
| Atributos | Tipo | Descrição |
|---|---|---|
| messages | array string | Array com as menssagens da fila |
Array Messages
| Atributos | Tipo | Descrição |
|---|---|---|
| _id | string | ID da mensagem no Z-API |
| DelayMessage | string | Tempo em segundos entre o envio das mensagens |
| Message | string | Texto da Mensagem |
| IsTrial | boolean | Indica se a instância está utilizando trial |
| InstanceId | string | ID da instância |
| Phone | string | Número do destinatário |
| ZaapId | string | ID da mensagem no Z-API |
| DelayTyping | string | Duração do indicador do chat "digitando..." |
| MessageId | string | ID da mensagem |
| Created | timetamp | Data da mensagem |
Exemplo
405#
Neste caso certifique que esteja enviando o corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no inicio 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"