Fila do número
Mostra a fila de envio do número e o uso dos limites de envio: quantas mensagens esperam, os limites por minuto, hora e dia, o limite de destinatários novos a cada 24 horas e o aquecimento de um número conectado há menos de 14 dias. Escopo necessário: connections:read.
Parâmetros de caminho
idstring · uuidobrigatórioIdentificador da conexão (o número).
Respostas
| Código | Erro e descrição |
|---|---|
| 200 | A fila e os limites de envio do número. |
| 400 | FST_ERR_VALIDATIONid não é um UUID. |
| 401 | Sem chave de API, ou com uma chave inválida (desconhecida, revogada ou expirada). |
| 403 | A chave de API não tem o escopo connections:read; a mensagem do erro cita o escopo que falta. |
| 404 | A conexão não existe ou não é de quem chama (o recurso de outra pessoa responde igual a um que não existe). |
| 429 | Requisições demais deste IP de origem, ou autenticações com falha demais: espere Retry-After segundos.Cabeçalho: Retry-After |
| 503 | A instância do gateway que roda a conexão está mudando (um reinício, um failover) ou não responde: espere Retry-After segundos e tente de novo.Cabeçalho: Retry-After |
Detalhes
Na resposta: pending conta as mensagens cujo horário de envio já chegou e que esperam a vez; scheduled, as agendadas para depois pelo ritmo do número. limits são os limites em vigor agora (menores durante o aquecimento): perMinute, perHour, perDay e newRecipientsPerDay (null quando não há limite de destinatários novos). usage é o que já foi usado em cada janela, com newRecipients contando os destinatários novos das últimas 24 horas.
warmup descreve o aquecimento: createdAt é quando o número foi conectado (unix em milissegundos), endsAt quando o aquecimento termina (14 dias depois), isInWarmup diz se ele ainda está em curso e messagesSent quantas mensagens o número já enviou.
Funciona mesmo com a organização sem pagamento em dia: só consulta, não usa o WhatsApp.
Guia: Limites de envio