Query Mail Tasks via GetMailTaskList - Quick BI

Retrieves a list of tracking tasks. Note: If the caller's AccessKey (AK) does not have permission to view tracking tasks of other users, this operation returns only the tasks that the caller is authorized to access.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
PageNum	integer	No	The page number. Starts from: 1 Default value: 1	1
PageSize	integer	No	The number of entries to return on each page. Default value: 25	10
UserNick	string	No	The nickname of the user who owns the tracking task. If this parameter is not specified, all tasks are returned.	test
Paused	boolean	No	Specifies whether the tracking task is paused.	true

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	0c52************8e1952a3
Result	object	The paging information for the tracking tasks.
PageNum	integer	The page number.	1
PageSize	integer	The number of entries per page that was set for the request.	10
TotalNum	integer	The total number of entries.	1
TotalPages	integer	The total number of pages.	1
Pre	integer	The previous page number. A value of null or 0 indicates that there is no previous page.	null
Next	integer	The next page number. A value of null or 0 indicates that there is no next page.	null
Data	array<object>	An array of tracking task models.
	object	The tracking task model.
MailId	string	The mail ID of the tracking task.	2342526
Paused	boolean	Indicates whether the task is paused. true: The task is paused. false: The task is not paused.	true
BizOwnerUserId	string	The user ID of the owner.	asag****2423
BizOwnerName	string	The nickname of the owner.	test
SubscribeName	string	The name of the tracking task.	test
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

{
  "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
}

Error codes

HTTP status code	Error code	Error message	Description
400	Internal.System.Error	An internal system error occurred.	An internal system error occurred.
400	UserRoleConfig.NotContain.Function	The user %s does not have permission to operate.	The user %s does not have permission to operate.
400	Invalid.Parameter.Error	The parameter is invalid:%s.	invalid parameter: ${0}.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.