Consultar uma lista de destinatários
Descrição
Esta operação consulta uma lista de destinatários.
Parâmetros da solicitação
|
Nome |
Tipo |
Obrigatório |
Descrição |
|
Action |
String |
Sim |
Parâmetro obrigatório. Defina o valor como QueryReceiverByParam. |
|
PageSize |
Integer |
Não |
Número de entradas por página. Valor padrão: 10. |
|
PageNo |
Integer |
Não |
Número da página atual. |
|
KeyWord |
String |
Não |
Palavras-chave. Por padrão, o sistema retorna todas as informações. |
|
Status |
Integer |
Não |
Status de entrega. Se você deixar este parâmetro vazio, o sistema retornará destinatários em todos os estados. |
Para obter mais informações sobre outros parâmetros de solicitação, consulte Parâmetros comuns de solicitação.
Parâmetros de resposta
|
Nome |
Tipo |
Descrição |
|
data |
Array |
Detalhes da lista de destinatários. |
|
NextStart |
String |
Usado para paginação. Se houver mais resultados, defina o parâmetro NextStart na próxima solicitação com este valor. |
|
PageSize |
Integer |
Número de entradas exibidas por página. |
|
RequestId |
String |
ID da solicitação. |
|
TotalCount |
Integer |
Número total de entradas. |
data
|
Nome |
Tipo |
Descrição |
|
ReceiverId |
String |
ID da lista de destinatários. |
|
ReceiversName |
String |
Nome da lista de destinatários. |
|
Count |
String |
Número total de endereços de destinatários. |
|
ReceiversAlias |
String |
Alias da lista de destinatários. |
|
Desc |
String |
Descrição. |
|
ReceiversStatus |
String |
Status da lista. 0: Upload em andamento. 1: Upload concluído. |
|
CreateTime |
String |
Hora de criação da lista. Exemplo: 2021-09-28T16:40:35Z. |
|
UtcCreateTime |
Long |
Timestamp UNIX. Exemplo: 1632818435. |
Exemplos
Exemplo de solicitação
http(s)://dm.aliyuncs.com/?Action=QueryReceiverByParam
&KeyWord=''
&Status=''
&PageNo=''
&PageSize=''
&<Common request parameters>Exemplo de resposta bem-sucedida
Formato JSON
{
"TotalCount": 9,
"RequestId": "E6603A47-F1B4-39E2-A773-87A72F3779C4",
"data": {
"receiver": [
{
"ReceiversStatus": 0,
"ReceiverId": "079984cfc696ce1b5bed3a43d2e6f97a",
"Desc": "List 2",
"UtcCreateTime": 1628816320,
"ReceiversName": "234235",
"CreateTime": "2021-08-13T08:58:40Z",
"ReceiversAlias": "test@example.net",
"Count": 1
}
]
}
}