GetMailTaskList - 获取订阅任务列表信息

获取订阅任务列表信息,注意:当调用者ak的权限不能查看其他人的订阅任务时,则只能返回当前调用者有权限的列表。

调试

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

调试

授权信息

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

请求语法

POST  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

PageNum

integer

当前页码:

  • 起始值:1

  • 默认值:1

1

PageSize

integer

每页行数:

  • 默认值:25

10

UserNick

string

订阅负责人的用户昵称,如果不传则查全部。

test

Paused

boolean

订阅任务是否已暂停。

true

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

请求 ID。

0c52************8e1952a3

Result

object

订阅任务的分页信息。

PageNum

integer

页码。

1

PageSize

integer

请求接口时设置的每页行数。

10

TotalNum

integer

总条数

1

TotalPages

integer

总页码

1

Pre

integer

上一页,为 NULL or 0,表示没有上一页。

null

Next

integer

下一页,为 NULL or 0,表示没有下一页。

null

Data

array<object>

订阅任务信息模型数组。

object

订阅任务信息模型。

MailId

string

订阅任务的邮件 ID。

2342526

Paused

boolean

任务是否暂停。

  • true -- 暂停

  • false -- 未暂停

true

BizOwnerUserId

string

负责人 userId。

asag****2423

BizOwnerName

string

负责人昵称。

test

SubscribeName

string

订阅任务名称。

test

Success

boolean

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

  • true:请求成功

  • false:请求失败

true

示例

正常返回示例

JSON格式

{
  "RequestId": "0c52************8e1952a3",
  "Result": {
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1,
    "TotalPages": 1,
    "Pre": 0,
    "Next": 0,
    "Data": [
      {
        "MailId": "2342526",
        "Paused": true,
        "BizOwnerUserId": "asag****2423",
        "BizOwnerName": "test",
        "SubscribeName": "test"
      }
    ]
  },
  "Success": true
}

错误码

HTTP status code

错误码

错误信息

描述

400 Internal.System.Error An internal system error occurred. 系统内部异常。
400 UserRoleConfig.NotContain.Function The user %s does not have permission to operate. 此用户%s没有权限操作。
400 Invalid.Parameter.Error The parameter is invalid:%s. 无效参数%s。

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

变更历史

更多信息,参考变更详情