Pular para o conteúdo

Cancelar da fila

DELETE/connections/{id}/queue/{jobId}

Tira da fila uma mensagem que ainda não foi enviada. Só uma mensagem que ainda espera a vez pode ser cancelada: a que já está sendo enviada, já foi enviada ou já saiu da fila responde 404. Escopo necessário: messages:send.

Ver em Markdown

Parâmetros de caminho

idstring · uuidobrigatório

Identificador da conexão (o número) que enfileirou a mensagem.

jobIdstring · uuidobrigatório

O jobId da resposta de POST /connections/{id}/send.

Respostas

Respostas: código de status, erro e descrição
CódigoErro e descrição
200A mensagem saiu da fila e não vai ser enviada: {"cancelled": true}.
400FST_ERR_VALIDATIONid ou jobId não é um UUID.
401Sem chave de API, ou com uma chave inválida (desconhecida, revogada ou expirada).
403A chave de API não tem o escopo messages:send; a mensagem do erro cita o escopo que falta.
404A conexão não existe ou não é de quem chama (o recurso de outra pessoa responde igual a um que não existe). Também quando o job não está esperando na fila: ele não existe, já está sendo enviado, já foi enviado ou já foi cancelado.
429Requisições demais deste IP de origem, ou autenticações com falha demais: espere Retry-After segundos.Cabeçalho: Retry-After

Detalhes

O clientRef do envio cancelado continua reservado por 7 dias: um novo POST /connections/{id}/send com o mesmo clientRef responde 200 com o job cancelado e "duplicate": true, sem enfileirar nada. Para enviar de novo, use outro clientRef.

O registro de mensagens (GET /messages) passa a mostrar o envio como falho, com o motivo Cancelado via API. Nenhum webhook é enviado.

Guia: Enviar mensagens

Esta página ajudou? · Atualizado em 28 set 2026