Cancel Messages Request

POST

/api/messages/request/cancel

Cancela uma requisição de mensagens através do RequestId.

Funcionalidades:

Cancelamento de requisições

Validação de propriedade (usuário só pode cancelar suas próprias mensagens)

Autenticação via X-API-Key header

Regras:

Apenas mensagens com status que permite cancelamento podem ser canceladas

O RequestId deve pertencer ao usuário autenticado

Mensagens já enviadas não podem ser canceladas

Cancelamento é atômico (todas as mensagens da requisição que estão passíveis de cancelamento)

Request

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Body

🟠400Bad Request

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.comtele.com.br/api/messages/request/cancel' \
--header 'X-API-Key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "requestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'

Response Example

200 - Cancelado com sucesso

{
    "hasError": false,
    "message": "Mensagens canceladas com sucesso.",
    "object": null,
    "totalRecords": 0,
    "errors": []
}

Modified at 2025-12-18 18:15:57

Messages Requests Report

Send RCS (File) Message