UploadContactFile

Метод UploadContactFile

Примените этот метод для загрузки файла с контактами для рассылки. Для этого выполните POST запрос с входными параметрами к точке подключения, указанными ниже.

Точка подключения:

POST: https://api.exolve.ru/campaign/v1/UploadContactFile

Авторизация

Передайте следующие Заголовки HTTP для успешной авторизации.

Имя Тип Описание
Authorization string API-ключ приложения с Bearer перед ним. Пример: Bearer e***s0, где e***s0 замените на API-ключ вашего приложения

Входные параметры

Передайте следующие параметры в теле запроса в JSON формате. Параметры, отмеченные жирным шрифтом, являются обязательными.

Параметр Тип Описание
campaign_id uint64 идентификатор рассылки
file File файл с контактами

File

Параметр Тип Описание
name string название файла
mime_type string тип объекта для браузера (text/csv, text/x-csv, text/plain, application/csv, application/x-csv)
content bytes список контактов в формате base64

Выходные параметры

Параметр Тип Описание
file_id uint64 идентификатор загруженного файла

Возможные ошибки

Код Статус Пример сообщения Описание
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-ключ
400 Bad Request couldn’t upload contact file: format file not csv формат загружаемого файла не является .csv
400 Bad Request couldn’t upload info contact file: empty campaign id отсутствует поле campaign_id
400 Bad Request couldn’t upload info contact file: empty file content отсутствует поле content
400 Bad Request invalid character ‘[character]’ looking for beginning of value невалидное значение в одном из полей
400 Bad Request invalid value for uint64 type: ‘[value]’ невалидное или пустое значение в поле id с типом uint64
400 Bad Request invalid character " after object key:value pair в запросе пропущена запятая в одном из параметров

Примеры

Входные параметры:

{
    "campaign_id": "12345",
    "file": {
        "content": "bnVtYmVyO3RpbWUgem9uZQ0KNzk5OTExMTIyMzM7VVRDKzINCjc5OTk0NDQ1NTY2O1VUQys1",
        "mime_type": "text/csv",
        "name": "contacts.csv"
    }
}

Выходные параметры:

{
    "file_id": "119362165802627072"
}

Содержание статьи