Query the details of a recipient list
Description
Queries the details of a specified recipient list.
Request parameters
Name | Type | Required | Description |
Action | String | Yes | A required parameter. Set the value to QueryReceiverDetail. |
ReceiverId | String | Yes | The ID of the recipient list. This ID is returned when you call the CreateReceiver operation. |
KeyWord | String | No | The recipient's email address. The address can be 0 to 50 characters long. Example: a***@example.net |
PageSize | Integer | No | The number of entries to return on each page. The default value is 10. |
NextStart | String | No | The start position of the next record. The default value is 0. |
For information about common request parameters, see Common request parameters.
Response parameters
Name | Type | Description |
DataSchema | String | The field names for the recipient content in the Data parameter. |
RequestId | String | The ID of the request. |
data | Array | The detailed information. |
NextStart | String | Used for paging. If more results exist, set the NextStart parameter in your next request to this value. |
TotalCount | Integer | The total number of entries. This parameter is obsolete and is retained for compatibility. |
data
Name | Type | Description |
UtcCreateTime | Long | The creation time, specified in UTC. |
String | The recipient's email address. | |
CreateTime | String | The creation time. For example: 2021-09-28T16:40:35Z |
Data | String | The content. |
Examples
Sample request
http(s)://dm.aliyuncs.com/?Action=SaveReceiverDetail
&ReceiverId=754fa694ba2ad64b86c0cb575963e21f
&PageSize=1
&KeyWord=''
&NextStart=''
&<Common request parameters>Sample success response
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, see the API Error Center.