Limpar mensagens pendentes da fila de envio

Amb. de Desenv.

http://localhost:3000

DELETE

/instances/{instanceId}/messages/pending

Limpa as mensagens que ainda não foram enviadas desta instância.

Em termos simples, esta rota esvazia a fila de envio da instância:

remove mensagens que ainda estavam esperando para sair

cancela mensagens agendadas quando a fila suportar isso

marca as mensagens pendentes no banco como cancelled

Use quando quiser parar uma leva de envios antes que ela continue saindo.

Requisição

Authorization

Adicionar parâmetro em header

x-api-key

Exemplo:

x-api-key: ********************

Parâmetros de Caminho

Parâmetros Header

🟢200OK

application/json

Resposta para limpar as mensagens pendentes de uma instância.

Bodyapplication/json

🟠400Requisição Inválida

🟠401Não Autorizado

🟠403Proibido

🟠404Registo Não Encontrado

Request Example

Shell

JavaScript

Java

Swift

curl --location --request DELETE 'http://localhost:3000/instances//messages/pending' \
--header 'x-api-key: <api-key>'

Response Example

200 - Fila limpa

{
    "instanceId": "018f47ac-7a5b-7cc2-9f9a-9b8d7f6e5d4c",
    "cancelledTotal": 2
}

Modificado em 2026-06-12 15:08:32