All Products
Search
Document Center

:Miscellaneous

Last Updated:Oct 29, 2025

Query a task

Send a test email

Create an invalid address or domain name

Query a task

Description

You can call QueryTaskByParam to query a task.

Request parameters

Name

Type

Required

Description

Action

String

Yes

A required parameter. Set the value to QueryTaskByParam.

KeyWord

String

No

The keyword for the query. By default, all information is returned.

Status

Integer

No

The status. By default, tasks in all statuses are returned. A value of 1 indicates that the task was sent successfully.

PageNo

Integer

No

The page number. Default value: 1.

PageSize

Integer

No

The number of entries to show on each page. Default value: 10.

For other request parameters, see Common request parameters.

Return parameters

Name

Type

Description

PageNumber

Integer

The page number.

PageSize

Integer

The number of entries per page.

TotalCount

Integer

The total number of entries.

data

Array

The records.

data

Name

Type

Description

TemplateName

String

The template name.

TaskId

String

The task ID.

ReceiversName

String

The recipient name.

TaskStatus

String

The task status. A value of 1 indicates that the task was sent successfully.

AddressType

String

The address type. A value of 1 indicates a sender address. A value of 0 indicates a random address.

TagName

String

The tag.

RequestCount

String

The number of requests.

CreateTime

String

The creation time.

UtcCreateTime

Integer

The creation time.

For common return parameters, see Common return parameters.

Send a test email

Description

You can call SendTestByTemplate to send a test email.

Request parameters

Name

Type

Required

Description

Action

String

Yes

A required parameter. Set the value to SendTestByTemplate.

TemplateId

String

Yes

The template ID.

UserName

String

No

The user name. The maximum length is 30 characters.

NickName

String

No

The nickname. The maximum length is 30 characters.

Birthday

String

No

The birthday. The maximum length is 30 characters.

Gender

String

No

The gender. The maximum length is 30 characters.

Mobile

String

No

The mobile number. The maximum length is 30 characters.

Email

String

Yes

The recipient address. The maximum length is 60 characters.

AccountName

String

Yes

The sender address. The maximum length is 60 characters.

For more information, see Common request parameters.

Return parameters

For more information, see Common return parameters.

Create an invalid address or domain name

Description

The CreateUserSuppression operation creates a suppression for an invalid address or domain name.

Request parameters

Name

Type

Required

Description

Action

String

Yes

A required parameter. Set the value to CreateUserSuppression.

Address

String

Yes

The email address or domain name, such as test@example.net or example.net.

For common request parameters, see Common request parameters.

Return parameters

Name

Type

Description

SuppressionId

Integer

59511

For more information, see Common return parameters.