Obtém informações detalhadas sobre uma lista de destinatários.
Experimente agora
Testar
Autorização RAM
|
Ação |
Nível de acesso |
Tipo de recurso |
Chave de condição |
Ação dependente |
|
dm:QueryReceiverDetail |
get |
*All Resource
|
Nenhuma | Nenhuma |
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
| ReceiverId |
string |
Sim |
ID da lista de destinatários (retornado ao criar uma lista de destinatários usando a API CreateReceiver). |
1235 |
| PageSize |
integer |
Não |
Número de itens por página. Valor padrão: 10. |
10 |
| KeyWord |
string |
Não |
Endereço do destinatário, comprimento de 0 a 50. |
b***@example.net |
| NextStart |
string |
Não |
Posição inicial para o próximo item. Valor padrão: 0. |
0 |
Elementos de resposta
|
Elemento |
Tipo |
Descrição |
Exemplo |
|
object |
|||
| DataSchema |
string |
Nome do campo para os dados dos destinatários. |
UserName,NickName,Gender,Birthday,Mobile |
| NextStart |
string |
Usado para paginação. Se houver mais resultados, defina este valor retornado como NextStart na próxima solicitação. |
90f0243616#40test@example.com |
| RequestId |
string |
O ID da solicitação. |
10A1AD70-E48E-476D-98D9-39BD92193837 |
| TotalCount |
integer |
Contagem total (campo obsoleto, mantido para compatibilidade histórica). |
361 |
| data |
object |
||
| detail |
array<object> |
Informações detalhadas. |
|
|
object |
Informações detalhadas. |
||
| Data |
string |
Content |
{'Domains': ['a.example.net', 'b.example.net', 'c.example.net', 'd.example.net']} |
| UtcCreateTime |
integer |
Creation time in UTC format |
1569734892 |
|
string |
Recipient address |
a***@example.net |
|
| CreateTime |
string |
Creation Time |
2019-09-29T13:28Z |
Exemplos
Resposta de sucesso
JSON formato
{
"DataSchema": "UserName,NickName,Gender,Birthday,Mobile",
"NextStart": "90f0243616#40test@example.com",
"RequestId": "10A1AD70-E48E-476D-98D9-39BD92193837",
"TotalCount": 361,
"data": {
"detail": [
{
"Data": "{'Domains': ['a.example.net', 'b.example.net', 'c.example.net', 'd.example.net']}",
"UtcCreateTime": 1569734892,
"Email": "a***@example.net",
"CreateTime": "2019-09-29T13:28Z"
}
]
}
}
Códigos de erro
Consulte Códigos de Erro para uma lista completa.
Notas de versão
Consulte Notas de Versão para uma lista completa.