Skip to main content
A API limita o número de requisições por empresa, em janelas fixas de um minuto. Todos os tokens da empresa dividem o mesmo limite, então criar um segundo token não aumenta a quantidade de chamadas permitidas.
O padrão é 120 requisições por minuto. Empresas que precisam de mais podem ter um limite próprio definido no plano. Se a sua integração vai precisar de mais que isso, fale com o comercial antes de planejá-la em cima do limite padrão.

Os headers

Toda resposta informa a situação atual da janela. Confie nesses headers em vez de contar as requisições do seu lado, porque a contagem inclui as outras integrações da empresa.
integer
Limite de requisições da empresa no minuto atual.
integer
Quantas requisições ainda cabem na janela atual.
integer
Segundos até a janela terminar e o contador voltar a zero.

Quando o limite é atingido

A resposta é 429 e traz mais um header:
integer
Segundos de espera antes de tentar de novo. Corresponde ao tempo que falta para a janela terminar.
Respeite o Retry-After. Se você repetir a chamada na hora, só consome a próxima janela e a integração continua recebendo 429. As outras integrações da empresa também são prejudicadas, porque dividem o mesmo limite.

Como tratar o 429

Como ficar longe do limite

Ler uma lista com perPage=100 custa 1 requisição a cada 100 registros. Com o padrão de 20, custa 5. É o ajuste que mais reduz o consumo e também o mais fácil de fazer. Veja Paginação.
Consultar GET /messages/jobs/{jobId} a cada 200 ms consome a janela inteira em pouco mais de 20 segundos. Comece com intervalos de 1 segundo e vá aumentando.
Filas, tags, tipos de qualificação, canais e campos personalizados mudam pouco. Buscar essas listas a cada operação é o desperdício mais comum. Leia uma vez e guarde uma cópia do seu lado.
Se três integrações fazem carga completa à meia-noite, elas disputam o mesmo limite. Espalhe os horários.

Envio de mensagens e o limite

POST /messages responde 202 na hora e faz o envio em segundo plano. A requisição conta para o limite, mas o envio em si não. A velocidade de saída das mensagens depende do provedor do canal.
Você consegue enfileirar 120 mensagens em um minuto, mas elas não vão sair todas nesse mesmo minuto. Para envios em volume, use campanhas em vez de um laço sobre POST /messages. A campanha foi feita para esse ritmo e permite pausar, retomar e acompanhar o envio pelo relatório.