All Products
Search
Document Center

receiver operation

Last Updated: Apr 02, 2022

Create receiver list

Description

CreateReceiver API is used for creating a receiver list.

Request parameters

Name

Type

Required?

Description

Action

String

Required

API name, a system required parameter. Value: CreateReceiver.

ReceiversName

String

Required

Receiver list name

ReceiversAlias

String

Required

Receiver list alias

Desc

String

Required

Description

For other request parameters, see Public parameters.

Response parameters

Name

Type

Description

receiverId

String

Receiver ID

For more information about public response parameters, see Public parameters.

Delete receiver list

Description

DeleteReceiver API is used for deleting a receiver list.

Request parameters

Name

Type

Required?

Description

Action

String

Required

API name, a system required parameter. Value: DeleteReceiver.

ReceiverId

String

Required

Receiver list id

For other request parameters, see Public parameters.

Response parameters

For more information about public response parameters, see Public parameters.

Delete a single receiver

Description

DeleteReceiverDetail API is used for delete a single receiver.

Request parameters

Name

Type

Required?

Description

Action

String

Required

API name, a system required parameter. Value: DeleteReceiverDetail.

ReceiverId

String

Required

Receiver list id

Email

String

Required

Receiver address

For other request parameters, see Public parameters.

Response parameters

For more information about public response parameters, see Public parameters.

Create a single receiver

Description

SaveReceiverDetail API is used for creating a single receiver.

Request parameters

Name

Type

Required?

Description

Action

String

Required

API name, a system required parameter. Value: SaveReceiverDetail.

ReceiverId

String

Required

Receiver list id

Detail

String

Required

Content,Limit 500 pieces of data,Example: [{"b":"birthday","e":"xxx@alibabainc.com","g":"gender","m":" mobile","n":"nickname","u":"name"}]

For other request parameters, see Public parameters.

Response parameters

For more information about public response parameters, see Public parameters.

Query for details of a receiver list

Description

QueryReceiverDetail API is used for querying for details of a receiver list.

Request parameters

Name

Type

Required?

Description

Action

String

Required

API name, a system required parameter. Value: QueryReceiverDetail.

ReceiverId

String

Required

Receiver list id

KeyWord

String

Optional

The query keywords is email address and the length 0-50, Example:xxx@te.com

PageSize

Integer

Optional

Number of Items each page

NextStart

Integer

Optional

Next start

For other request parameters, see Public parameters.

Response parameters

Name

Type

Description

data

data

data

Name

Type

Description

DetailList

List

Detail list record

NextStart

Integer

Next start

DetailList

Name

Type

Description

email

String

Receiver address

data

String

content

createTime

String

create time

utcCreateTime

Long

time stamp

For more information about public response parameters, see Public parameters.

Query the receiver list

Description

QueryReceiverByParam API is used for query the receiver list.

Request parameters

Name

Type

Required?

Description

Action

String

Required

API name, a system required parameter. Value: QueryReceiverByParam.

PageSize

Integer

Optional

Number of Items each page

For other request parameters, see Public parameters.

Response parameters

Name

Type

Description

data

data

data

Name

Type

Description

total

Intege

total

data

List

data record

data record

Name

Type

Description

receiverId

String

Receiver ID

receiversName

String

Receiver list Name

count

int

The count of receiver address

receiversAlias

String

Receiver list alias

desc

String

Description

receiversStatus

int

status,uploading:0 or completed:1)

createTime

String

create time

utcCreateTime

Long

time stamp

For more information about public response parameters, see Public parameters.