All Products
Search
Document Center

Direct Mail:QueryReceiverDetail

Last Updated:Mar 13, 2024

Queries the details of recipient list.

Request parameters

Parameter

Type

Required

Description

Action

String

Yes

The operation that you want to perform. Set the value to QueryReceiverDetail.

ReceiverId

String

Yes

The ID of the recipient list. The ID of the recipient list is returned after you call the CreateReceiver operation to create the recipient list.

KeyWord

String

No

The email address of the recipient. The email address must be 0 to 50 characters in length. Example: a***@example.net.

PageSize

Integer

No

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

NextStart

String

No

The start position of the next record. Default value: 0.

For information about other request parameters, see Common request parameters.

Response parameters

Parameter

Type

Description

DataSchema

String

The field name of the data recipient's content

RequestId

String

RequestId

data

Array

The data entries.

NextStart

String

The start position of the next record.

TotalCount

Integer

Total quantity (obsolete fields, compatible with historical reasons)

data

Parameter

Type

Description

UtcCreateTime

Long

The timestamp. Example: 1632818435.

Email

String

The email address of the recipient.

CreateTime

String

The time when the recipient was created. Example: 2021-09-28T16:40:35Z.

Data

String

The content.

Examples

Sample requests

http(s)://dm.aliyuncs.com/?Action=SaveReceiverDetail
&ReceiverId=754fa694ba2ad64b86c0cb575963e21f
&PageSize=1
&KeyWord=''
&NextStart=''
&<Common request parameters>

Sample success responses

JSON format

{
  "DataSchema": "UserName,NickName,Gender,Birthday,Mobile",
  "RequestId": "90AA5D9E-A802-5F11-A0C5-537AAB8CACD2",
  "data": {
    "detail": [
      {
        "UtcCreateTime": 1692080837,
        "Email": "111@example.net",
        "CreateTime": "2023-08-15T14:27:17Z",
        "Data": "name,nickname,gender,birthday,mobile"
      }
    ]
  },
  "NextStart": "9cac254583#401#754fa694ba2ad64b86c0cb575963e21f-1691745155#xxx@example.net"
}

Error Codes

For a list of error codes, visit the API Error Center.