DownloadFileError
Метод DownloadFileError
Примените этот метод для скачивания файла с ошибками валидации. Для этого выполните POST запрос с входными параметрами к точке подключения, указанными ниже.
Точка подключения:
POST: https://api.exolve.ru/campaign/v1/DownloadFileError
Авторизация
Передайте следующие Заголовки HTTP для успешной авторизации.
Имя | Тип | Описание |
---|---|---|
Authorization | string | API-ключ приложения с Bearer перед ним. Пример: Bearer e***s0 , где e***s0 замените на API-ключ вашего приложения |
Входные параметры
Передайте следующие параметры в теле запроса в JSON формате. Параметры, отмеченные жирным шрифтом, являются обязательными.
Параметр | Тип | Описание |
---|---|---|
campaign_id | uint64 | идентификатор рассылки |
file_id | uint64 | идентификатор загруженного файла |
Выходные параметры
Параметр | Тип | Описание |
---|---|---|
file | File | файл с результатами валидации |
File
Параметр | Тип | Описание |
---|---|---|
name | string | название файла |
mime_type | string | тип объекта для браузера |
content | bytes | список контактов и ошибок валидации в формате base64 |
Возможные ошибки
Код | Статус | Пример сообщения | Описание |
---|---|---|---|
404 | Not Found | Not Found | некорректный URL запроса |
401 | Unauthorized | invalid token | невалидный API-ключ |
400 | Bad Request | token is empty | в запросе не передан API-ключ |
400 | Bad Request | couldn’t parse incoming jwt token: couldn’t parse token: invalid character ‘[character]’ looking for beginning of value | невалидный API-ключ |
404 | Not Found | file not found | файл с указанным ID в поле file_id не найден |
403 | Forbidden | permission denied | данные введены в неверном формате |
400 | Bad Request | invalid DownloadFileErrorRequest.CampaignId: value must be greater than 0 | поле campaign_id и его значение отсутствуют в запросе |
400 | Bad Request | invalid DownloadFileErrorRequest.FileId: value must be greater than 0 | поле file_id и его значение отсутствуют в запросе |
400 | Bad Request | invalid character ‘[character]’ looking for beginning of value | невалидное или пустое значение в одном из полей |
400 | Bad Request | invalid value for uint64 type: ‘[value]’ | невалидное или пустое значение в одном из полей с типом uint64 |
400 | Bad Request | invalid character " after object key:value pair | в запросе пропущена запятая в одном из параметров |
Примеры
Входные параметры:
{
"campaign_id": "12345",
"file_id": "119362165802627072"
}
Выходные параметры:
{
"file": {
"name": "report_contacts.csv",
"mime_type": "text/csv",
"content": "bnVtYmVyO3RpbWUgem9uZTtlcnJvciAobnVtYmVyKQo3OTEzMTIwMjEyMjs7Cjc5MTMxMjAyMTIyO1VUQysyO2R1cGxpY2F0ZQo3OTA1MTIzNDU2NztVVEMrNTsK"
}
}