Доступные ресурсы eSputnik Rest API Available resources eSputnik Rest API

/v1/addressbooks

Получить список каталогов.
Каталог содержит списки дополнительных полей для контактов, которые доступны в вашей организации.

Get catalog list.
The catalog contains the list of additional fields for contacts that are available in your organisation.

Тип метода:

Type of method:

GET.

/v1/auth/token

Сгенерировать API token.
Используйте токен только если вам по определенным причинам не подходит Basic-авторизация по логину и паролю.

Generate API token.
Use token only if Basic authentication is not appropriate for you.

Тип метода:

Type of method:

POST.

/v1/balance

Получить баланс организации.

Get organisation balance.

Тип метода:

Type of method:

GET.

/v1/callouts/sms

Получить статистику sms-рассылок.

Get statistics for sms broadcasts

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
startindex		0
maxrows		10

/v1/contact

Добавить контакт.
Поле id будет проигнорировано.

Add contact.
The id field will be ignored.

Тип метода:

Type of method:

POST.

/v1/contact/{id}

Обновить контакт.
Поле id контакта будет проигнорировано.

Update contact.
The id field of contact will be ignored.

Тип метода:

Type of method:

PUT.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Идентификтор контакта Contact ID

/v1/contact/{id}

Удалить контакт.

Delete contact.

Тип метода:

Type of method:

DELETE.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Идентификатор контакта Contact ID

/v1/contact/{id}

Получить контакт.

Get contact.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Id контакта. Contact ID.

/v1/contact/subscribe

Подписать контакт.
Используется для интеграции форм подписки.
Если контакт не существует - будет создан с неподтверждённым email-ом.
Если контакт существует - будет обновлен.

Subscribe contact.
Used for subscription forms integration.
If contact does not exists - it will be created with not confirmed email.
If contact exists - it will be updated.

Тип метода:

Type of method:

POST.

/v1/contactActivity OLD

Эта операция устарела.

This operation is deprecated.

Активность контактов по рассылкам. Метод устарел, в будущем перестанет поддерживаться. Необходимо использовать новую версию /v2/contacts/activity

Get contact mailing activity. This method is deprecated and will not be supported in future. Use new version /v2/contacts/activity

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
dateFrom	Обязательный параметр. Дата и время, с которого учитывать активность контактов. Пересчёт данных производится раз в сутки. Required parameter. The date and the time from which you want to get contact activity. Data updates once a day.
dateTo	Обязательный параметр. Дата и время, до которого учитывать активность контактов. Пересчёт данных производится раз в сутки. Required parameter. The date and the time to which you want to get contact activity. Data updates once a day.
email	Email. Email.
sms	Номер телефона контакта. Contact phone number.
messageTag	Метка сообщения. Message tag.
activityStatus	Активность контакта (DELIVERED, UNDELIVERED, READ, UNSUBSCRIBED, CLICKED, SPAM). Activity status (DELIVERED, UNDELIVERED, READ, UNSUBSCRIBED, CLICKED, SPAM)
startindex	Номер первой возвращаемой активности контакта из результатов поиска. Нумерация начинается с 1. Number of the first contact activity from search results. Numbering starts from 1.	1
maxrows	Максимальное количество возвращаемых событий активности. Max amount of activity entries in response.	25000

/v1/contacts

Добавить/обновить контакты.
Существующие контакты будут обновлены, новые - добавлены.

Add/update contacts.
Existing contacts will be updated, new contacts will be added.

Тип метода:

Type of method:

POST.

/v1/contacts

Поиск контактов.
Метод возвращает не более 500 результатов.
В заголовке TotalCount указано общее число контактов.

Search contacts.
The method returns max 500 results.
There are total amount of contacts in TotalCount header.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
email	Email. Email.
sms	Номер телефона контакта. Contact phone number.
firstname	Имя контакта. Contact first name.
lastname	Фамилия контакта. Contact last name.
startindex	Номер первого возвращаемого контакта из результатов поиска. Нумерация начинается с 1. Number of first returned contact from search results. Numbering starts from 1.	1
maxrows	Максимальное количество возвращаемых контактов (не более 500). Max amount of returned contacts (max 500).	500

/v1/contacts/email

Получить email по идентификатору контакта.

Get email by contact id.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
ids	Идентификаторы контактов, для которых будут получены email-ы, разделённые запятыми. Comma separated list of contact IDs to get emails for.

/v1/contacts/upload

Добавить/обновить контакты из внешнего файла.
Существующие контакты будут обновлены, новые - добавлены.

Add/update contacts from external file.
Existing contacts will be updated, new contacts will be created.

Тип метода:

Type of method:

POST.

/v1/emails/unsubscribed/add

Добавить email-ы в список отписавшихся (отписать email-ы).

Add emails to unsubscribed list (unsubscribe emails).

Тип метода:

Type of method:

POST.

/v1/emails/unsubscribed/delete

Удалить email-ы из списка отписавшихся.

Remove emails from unsubscribed list.

Тип метода:

Type of method:

POST.

/v1/event

Сгенерировать событие.

Generate event.

Тип метода:

Type of method:

POST.

/v1/group/{id}/contacts

Поиск всех контактов в группе.

Get contacts from segment.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Идентификатор группы. Segment ID
startindex	Номер первого возвращаемого контакта из результатов поиска. Нумерация начинается с 1. Number of the first returned contact from search results. Numbering starts from 1.	1
maxrows	Максимальное количество возвращаемых контактов (не более 500). Max amount of contacts in the response (max 500).	500
orderByTs		false
asc		true

/v1/group/{id}/contacts/detach

Удалить все контакты из статической группы.

Delete all contacts from static segment.

Тип метода:

Type of method:

POST.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Идентификатор группы. Segment ID

/v1/groups

Поиск групп.

Get segments.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
name	Название группы. Segment name.
startindex	Номер первой возвращаемой группы из результатов поиска. Нумерация начинается с 1. Number of the first returned segment from search results. Numbering starts from 1.	1
maxrows	Максимальное количество возвращаемых групп (не более 500). Max amount of segments in the response (max 500).	500

/v1/importstatus/{sessionId}

Получение статуса сессии импорта контактов по асинхронному идентификатору сессии.

Get contact import session status by asynchronous session ID.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
sessionId	Асинхронный идентификатор сессии Asynchronous session identifier

/v1/interfaces/email

Получить email-интерфейсы (имена отправителей).

Get email interfaces

Тип метода:

Type of method:

GET.

/v1/interfaces/sms

Получить sms-интерфейсы (имена отправителей).

Get SMS interfaces (alpha names)

Тип метода:

Type of method:

GET.

/v1/message/{id}/send

Отправка рассылки по заранее созданному сообщению. Сообщение может дополнительно параметризироваться.

Dispatch start of the created message. Message can be parametrized additionally.

Тип метода:

Type of method:

POST.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	ID сообщения. Message ID.

/v1/message/{id}/smartsend

Отправка подготовленного сообщения одному или многим контактам. Сообщение может параметризироваться для каждого контакта отдельно.

Sending prepared message to one or many contacts. The message can be parametrized for each contact separately.

Тип метода:

Type of method:

POST.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	ID сообщения. Message ID.

/v1/message/email

Отправить email-сообщение. Если контакта с таким адресом нет, он будет создан.

Тип метода:

Type of method:

POST.

/v1/message/email/status

Получить статус одиночного email сообщения.

Get status of a single email message.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
ids	Идентификаторы одиночных сообщений, для которых будут получены статусы, разделённые запятыми. Comma separated list of IDs of single messages.

/v1/message/sms

Отправить sms-сообщение. Если контакта с таким номером телефона нет, он будет создан.

Send SMS message. If contact with such phone number is not exist it will be created.

Тип метода:

Type of method:

POST.

/v1/message/sms/status

Получить статус одиночного sms сообщения.

Get status of the single SMS message

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
ids	Идентификаторы одиночных сообщений, для которых будут получены статусы, разделённые запятыми. Comma separated list of IDs of single messages.

/v1/message/viber

Отправить viber-сообщение. Если контакта с таким номером телефона нет, он будет создан.

Send VIBER message. If contact with such phone number is not exist it will be created.

Тип метода:

Type of method:

POST.

/v1/message/viber/status

Получить статус одиночного viber сообщения.

Get status of the single VIBER message

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
ids	Идентификаторы одиночных сообщений, для которых будут получены статусы, разделённые запятыми. Comma separated list of IDs of single messages.

/v1/messages/email

Добавить email-сообщение.

Add email message.

Тип метода:

Type of method:

POST.

/v1/messages/email

Поиск email-сообщений по части названия или метки.
Метод возвращает не более 500 сообщений.
В заголовке TotalCount указано количество сообщений, которое вернул запрос.

Search email messages by part of name or tag.
Method returns maximum of 500 messages. TotalCount header contains number of messages returned by query.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
search	Условие поиска (часть названия сообщения или метки). Search condition (part of message name or tag).
startindex	Индекс первого возвращаемого сообщения из результатов поиска. Нумерация начинается с 1. Index of first message to return from search result. Numbering starts from 1.	1
maxrows	Максимальное количество возвращаемых сообщений (не более 500). Maximum number of messages to return (not more than 500).	500

/v1/messages/email/{id}

Получить email-сообщение.

Get email message.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Идентификатор email-сообщения. Email message id.

/v1/messages/email/{id}

Удалить email-сообщение.

Delete email message.

Тип метода:

Type of method:

DELETE.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Идентификатор email-сообщения. Email message id.

/v1/messages/email/{id}

Обновить email-сообщение.

Update email message.

Тип метода:

Type of method:

PUT.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Идентификатор email-сообщения. Email message id.

/v1/messages/sms

Поиск sms-сообщений по части названия или метки.
Метод возвращает не более 500 сообщений.
В заголовке TotalCount указано количество сообщений, которое вернул запрос.

Search sms messages by part of name or tag.
Method returns maximum of 500 messages.
TotalCount header contains number of messages returned by query.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
search	Условие поиска (часть названия сообщения или метки). Search condition (part of message name or tag).
startindex	Индекс первого возвращаемого сообщения из результатов поиска. Нумерация начинается с 1. Index of first message to return from search result. Numbering starts from 1.	1
maxrows	Максимальное количество возвращаемых сообщений (не более 500). Maximum number of messages to return (not more than 500).	500

/v1/name/correct

Исправить опечатки в имени.

Correct misspelling name.

Тип метода:

Type of method:

POST.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
name	Исходное имя. Given name.
language	Обязательный параметр. Исходный язык, доступные значения: RU, UA, EN. Required parameter. Given language, supported values: RU, UA, EN.

/v1/orders

Добавить набор заказов.

Add orders.

Тип метода:

Type of method:

POST.

/v1/preprocessor/file/{id}/status

Получение статуса сессии загрузки файла для препроцессора по асинхронному идентификатору сессии.

Retrieving file uploading session status for pre-processor by asynchronous session identifier.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Асинхронный идентификатор сессии Asynchronous session identifier

/v1/preprocessor/file/upload

Загрузить файл для препроцессора из внешнего репозитория.

Upload file for preprocessor from external repository.

Тип метода:

Type of method:

POST.

/v1/promocodes

Загрузить промокоды из csv файла. Существующие промокоды обновляются.

Upload promotional codes from a CSV file. Existing promotional codes will be updated.

Тип метода:

Type of method:

POST.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
file	Обязательный параметр. CSV файл с промокодами. Файл парсится по названиям колонок в первой строке. Ожидаемые названия колонок: - code - значение промокода; - expirationDate - дата завершения действия промокода; - discount - скидка; - type - тип промокода. - inUse - флаг, использованный промокод или нет. Все эти параметры могут быть переданы через URL запроса. Файл может содержать одну колонку без названия (значения промокодов). Required parameter. CSV file with promo codes. The file is parsed by the names of the columns in the first row. Expected names of the columns: - code - value of promo code; - expirationDate - term of promo code validity; - discount - discount; - type - type of promotional code; - inUse - tag used/unused promo code. All this parameters can be transferred in request URL. File can contain one column without name (values of promo codes).
expirationDate	Дата завершения действия промокода. Term of promo code validity.
discount	Скидка. Discount.
type	Тип промокода. Type of promo code.
inUse	Флаг, использованный промокод или нет. Tag used/unused promo code.	false

/v1/promocodes

Загрузить промокоды из JSON. Существующие промокоды обновляются.

Upload promotional codes in JSON format. Existing promotional codes will be updated.

Тип метода:

Type of method:

POST.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
expirationDate	Дата завершения действия промокода. Term of promo code validity.
discount	Скидка. Discount.
type	Тип промокода. Type of promo code.
inUse	Флаг, использованный промокод или нет. Tag used/unused promo code.	false

/v1/promocodes

Получить промокоды. В этом методе возвращается список всех доступных промокодов.

Get promotional codes. The method returns a list of all available promotional codes.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
type	Тип промокода. Type of promo code.
inUse	Был ли промокод уже использован. Tag used/unused promo code.
activeDueDays	Количество дней для подсчёта доступных промокодов (activeDueDays=7 означает: промокод будет доступен в течение следующих 7 дней, не считая сегодня). Number of days to calculate available promo codes (activeDueDays=7 means that promo code will be available for next 7 days).
discount	Скидка по промокоду. Discount.

/v1/promocodes/count

Получить количество доступных промокодов.

Get the amount of available promotional codes.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
type	Тип промокода. Type of promo code.
activeDueDays	Количество дней для подсчёта доступных промокодов (activeDueDays=7 означает: промокод будет доступен в течение следующих 7 дней, не считая сегодня). Number of days to calculate available promo codes (activeDueDays=7 means that promo code will be available for next 7 days).
discount	Скидка по промокоду. Discount.

/v1/version

Получить версию протокола.

Get protocol version.

Тип метода:

Type of method:

GET.

Ресурс Resource	Метод Method	Описание Description
/v2/contacts/activity	GET	Активность контактов по рассылкам. Get contacts activity.
/v2/version	GET	Получить версию протокола. Get protocol version.

/v2/contacts/activity

Активность контактов по рассылкам.

Get contacts activity.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
dateFrom	Обязательный параметр. Дата и время, с которого учитывать активность контактов. Пересчёт данных производится раз в сутки. Required parameter. The date and the time from which you want to get contact activity. Data updates once a day.
dateTo	Обязательный параметр. Дата и время, до которого учитывать активность контактов. Пересчёт данных производится раз в сутки. Required parameter. The date and the time to which you want to get contact activity. Data updates once a day.
email	Email. Email.
sms	Номер телефона контакта. Contact phone number.
messageTag	Метка сообщения. Message tag.
activityStatus	Активность контакта (DELIVERED, UNDELIVERED, READ, UNSUBSCRIBED, CLICKED, SPAM). Activity status (DELIVERED, UNDELIVERED, READ, UNSUBSCRIBED, CLICKED, SPAM)
offset	Смещение последней найденной активности из результатов предыдущего поиска для продолжения вычитки. См ContactActivity#offset Last found contact activity offset in previous search results. It is used to continue search. See ContactActivity#offset
maxrows	Максимальное количество возвращаемых событий активности. Max amount of activity entries in response.	25000

/v2/version

Получить версию протокола.

Get protocol version.

Тип метода:

Type of method:

GET.