A AuthMS API Wiki API Reference iam.tianv.com →

DELETE /communication/scheduled/{id}

取消指定ID且处于scheduled状态的消息定时发送任务。已发送或已失败的消息无法取消。取消后消息状态变更为cancelled。参考:ePrivacy Directive 2002/58/EC、CAN-SPAM Act。

通信服务 `bearerAuth` application/json

Request Parameters

NameInTypeRequiredDefaultExampleConstraintsDescription
id path string Yes 消息ID

Request Body

Schema: dto.CancelScheduledRequest

FieldTypeRequiredExampleConstraintsDescription
cancel_key string No

Responses

StatusDescriptionSchema
200取消成功dto.OKResponse
400请求参数错误dto.SimpleResponse
401未认证或令牌无效dto.SimpleResponse
403无权访问该资源dto.SimpleResponse
404消息不存在dto.SimpleResponse
409消息非scheduled状态,无法取消dto.SimpleResponse
500服务内部错误dto.SimpleResponse

Referenced Schemas

dto.OKResponse

FieldTypeRequiredExampleConstraintsDescription
code integer No 0
message string No success

dto.SimpleResponse

FieldTypeRequiredExampleConstraintsDescription
code integer No
message string No
timestamp string No