GetMailTaskStatus - 查看邮件任务运行状态

查看组织内邮件任务运行状态(实时状态非最终状态)。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
MailIdstring

邮件 id

d5a59a898b634d75be5584f8dc159c62
TaskIdlong

任务 id

7218865303929605212

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

38C0FEC8-1510-415C-A9F1-9AE9422BDB65
Resultarray<object>

返回结果。

DATAobject

返回结果。

execTimestring

执行时间,时间格式为 yyyy-MM-dd HH:mm:ss

2024-10-09 17:34:11
mailIdstring

邮件 id

c38f73f4c5xxxxxc808c41b3f4d23b7852
statusstring

邮件状态,成功:SENT ,失败:FAILED ,进行中:PROCESSING

SENT
taskIdlong

任务 id

1282xxx610816
Successboolean

是否请求成功。取值范围:

  • true:请求成功
  • false:请求失败
true

示例

正常返回示例

JSON格式

{
  "RequestId": "38C0FEC8-1510-415C-A9F1-9AE9422BDB65",
  "Result": [
    {
      "execTime": "2024-10-09 17:34:11",
      "mailId": "c38f73f4c5xxxxxc808c41b3f4d23b7852",
      "status": "SENT",
      "taskId": 0
    }
  ],
  "Success": true
}

错误码

HTTP status code错误码错误信息描述
400Mail.Forbidden.AccessForbidden Access On This Operation.禁止访问此操作。
400Mail.Not.FoundMail not found.邮件不存在
400Mail.Subject.ErrorThe mail subject is invalid.邮件主题参数不合法

访问错误中心查看更多错误码。