Obtém uma lista de arquivos de validação carregados.
Experimente agora
Testar
Autorização RAM
Sintaxe da solicitação
GET HTTP/1.1
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
| StartTime |
string |
Sim |
A hora de início. A hora está em UTC e segue o formato RFC 3339. |
2025-12-19T08:30:00Z |
| EndTime |
string |
Sim |
A hora de término. A hora está em UTC e segue o formato RFC 3339. |
2025-12-19T20:30:00Z |
| FileKeyword |
string |
Não |
Uma palavra-chave no nome do arquivo. |
keyword |
| Page |
integer |
Não |
O número da página. |
1 |
| PageSize |
integer |
Não |
O número de entradas por página. |
10 |
Elementos de resposta
|
Elemento |
Tipo |
Descrição |
Exemplo |
|
object |
O objeto de resposta. |
||
| RequestId |
string |
O ID da solicitação. |
xxx |
| HasNext |
boolean |
Indica se existe uma próxima página de dados. |
true |
| Page |
integer |
O número da página. |
1 |
| PageSize |
integer |
O número de entradas por página. |
10 |
| TotalSize |
integer |
O número total de entradas. |
100 |
| TotalPages |
integer |
O número total de páginas. |
10 |
| Files |
array<object> |
A lista de arquivos. |
|
|
object |
|||
| FileName |
string |
O nome do arquivo. |
test.csv |
| UploadTime |
string |
A hora em que o arquivo foi enviado. |
2000-01-01T00:00:00Z |
| Status |
string |
O status da tarefa. |
completed |
| Percentage |
string |
O progresso de execução da tarefa. |
100% |
| CompleteTime |
string |
A hora em que a tarefa foi concluída. |
2000-01-01T00:00:00Z |
| TotalNum |
string |
O número de endereços a serem validados na tarefa. |
10 |
| ProcessedNum |
string |
O número de endereços que foram validados. |
10 |
| ValidNum |
string |
O número de endereços com o resultado de validação 'Valid'. |
5 |
| InvalidNum |
string |
O número de endereços com o resultado de validação 'Invalid'. |
4 |
| CatchAllNum |
string |
O número de endereços com o resultado de validação 'CatchAll'. |
1 |
| DoNotMailNum |
string |
O número de endereços com o resultado de validação 'DoNotMail'. |
0 |
| UnknownNum |
string |
O número de endereços com o resultado de validação 'Unknown'. |
0 |
| IsDownloadable |
boolean |
Indica se o resultado pode ser baixado. |
true |
| FileId |
string |
O ID do arquivo. |
xxx |
Exemplos
Resposta de sucesso
JSON formato
{
"RequestId": "xxx",
"HasNext": true,
"Page": 1,
"PageSize": 10,
"TotalSize": 100,
"TotalPages": 10,
"Files": [
{
"FileName": "test.csv",
"UploadTime": "2000-01-01T00:00:00Z",
"Status": "completed",
"Percentage": "100%",
"CompleteTime": "2000-01-01T00:00:00Z",
"TotalNum": "10",
"ProcessedNum": "10",
"ValidNum": "5",
"InvalidNum": "4",
"CatchAllNum": "1",
"DoNotMailNum": "0",
"UnknownNum": "0",
"IsDownloadable": true,
"FileId": "xxx"
}
]
}
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.