全部產品
Search
文件中心

Quick BI:GetMailTaskList - 擷取訂閱工作清單資訊

更新時間:Dec 05, 2025

擷取訂閱工作清單資訊,注意:當調用者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。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情