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

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
dateFrom	Обязательный параметр. Дата и время, с которого учитывать активность контактов. Required parameter. The date and the time from which you want to get contact activity.
dateTo	Обязательный параметр. Дата и время, до которого учитывать активность контактов. Required parameter. The date and the time to which you want to get contact activity.
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/contacts/messages

История сообщений для контакта. Поддерживаемые медиа типы - EMAIL, SMS, VIBER.

Messages history per contact. Supported media types - EMAIL, SMS, VIBER.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
dateFrom	Обязательный параметр. Дата или дата со временем, с которого вычитывать историю контакта. Значения даты/времени передаются в формате ISO_8061 Формат для даты: YYYY-MM-DD Формат для даты со временем: YYYY-MM-DDTHH:mm Required parameter. The date or the datetime from which you want to get contact history. Date/time values are transferred with ISO_8061 format. Date format: YYYY-MM-DD Date with time format: YYYY-MM-DDTHH:mm
dateTo	Обязательный параметр. Дата или дата со временем, до которого вычитывать историю контакта. Значения даты/времени передаются в формате ISO_8061 Формат для даты: YYYY-MM-DD Формат для даты со временем: YYYY-MM-DDTHH:mm Required parameter. The date or the datetime to which you want to get contact history. Date/time values are transferred with ISO_8061 format. Date format: YYYY-MM-DD Date with time format: YYYY-MM-DDTHH:mm
email	Email (только один из contactId, email, phone должен быть указан). Email (only one of contactId, email, phone should be specified).
phone	Номер телефона контакта (только один из contactId, email, phone должен быть указан). Contact phone number (only one of contactId, email, phone should be specified).
sms	Устаревшее. Синоним для phone. Deprecated. Synonym for phone.
contactId	Идентификатор контакта (только один из contactId, email, phone должен быть указан). Contact ID (only one of contactId, email, phone should be specified).
offset	Смещение относительно первой записи. Для пагинации. Дефолтное значение - 0 Offset from first item. For pagination. Default value - 0	0
maxrows	Максимальное количество возвращаемых записей. Дефолтное значение - 10. Масимальное значение - 100 Max amount of items in response. Default value - 10. Maximum value - 100	10

/v2/version

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

Get protocol version.

Тип метода:

Type of method:

GET.

/v1/account/info

Получить информацию об аккаунте.

Get current account info.

Тип метода:

Type of method:

GET.

/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(Bearer Authentication).
Используйте токен только если вам по определенным причинам не подходит Basic-авторизация по логину и паролю.
Методы, для которых доступна авторизация по токену:
POST /v1/event
POST /v1/past_events
DELETE /v1/past_events

Generate API token(Bearer Authentication).
Use token only if Basic authentication is not appropriate for you.
Available methods for token authorization:
POST /v1/event
POST /v1/past_events
DELETE /v1/past_events

Тип метода:

Type of method:

POST.

/v1/balance

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

Get organisation balance.

Тип метода:

Type of method:

GET.

/v1/broadcast

Создать рассылку. Для email, sms, web push, viber

Create broadcast. For email, sms, web push, viber

Тип метода:

Type of method:

POST.

/v1/broadcast/{broadcast_id}

Получить информацию о рассылке.

Get broadcast info.

Тип метода:

Type of method:

GET.

Параметры
Parameters

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

/v1/broadcast/{broadcast_id}

Отменить запланированную рассылку.

Cancel scheduled broadcast.

Тип метода:

Type of method:

DELETE.

Параметры
Parameters

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

/v1/broadcasts

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

Get broadcasts.

Тип метода:

Type of method:

GET.

Параметры
Parameters

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

/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/{id}/subscriptions

Получение категорий, на которые подписан контакт.

Returns subscriptions which a contact is subscribed to.

Тип метода:

Type of method:

GET.

Параметры
Parameters

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

/v1/contact/{id}/subscriptions

Изменение категорий, на которые подписан контакт.

Change contact subscription categories.

Тип метода:

Type of method:

PUT.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
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/contact/token/activated/{app_uuid}/{token_id}

Изменение активности токена

Change token activity

Тип метода:

Type of method:

PUT.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
token_id	Токен Token id
app_uuid	Индификатор приложения Application id

/v1/contact/token/activated/{app_uuid}/{token_id}

Получение активности токена

Get token activity

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
token_id	Токен Token id
app_uuid	Индификатор приложения Application id

/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.
Order management via events.

Тип метода:

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/interactions/{interaction_id}/status

Обновить статус отправки

Update interaction status

Тип метода:

Type of method:

PUT.

Параметры
Parameters

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

/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 OLD

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

This operation is deprecated.

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

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

Тип метода:

Type of method:

POST.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	ID сообщения. Поддерживаются email, SMS и Viber сообщения. Message ID. Currently email, SMS and Viber messages are supported.

/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 сообщения. Поддерживаются email, SMS и Viber сообщения. Message ID. Currently email, SMS and Viber messages are supported.

/v1/message/email

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

Send email message. If contact with such email address is not exist it will be created.

Тип метода:

Type of method:

POST.

/v1/message/email/status OLD

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

This operation is deprecated.

Получить статус одиночного 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 OLD

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

This operation is deprecated.

Получить статус одиночного 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/status

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

Get status of a single 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 OLD

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

This operation is deprecated.

Получить статус одиночного 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 base 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 base email message.

Тип метода:

Type of method:

DELETE.

Параметры
Parameters

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

/v1/messages/email/{id}

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

Update base email message.

Тип метода:

Type of method:

PUT.

Параметры
Parameters

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

/v1/messages/email/{id}/{language}

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

Delete translated email message.

Тип метода:

Type of method:

DELETE.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Идентификатор email-сообщения. Email message id.
language	Код языка email-сообщения Согласно ISO_639-1 Email message language code According to ISO_639-1

/v1/messages/email/{id}/{language}

Обновить дочернее email-сообщение

Update translated email message.

Тип метода:

Type of method:

PUT.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Идентификатор email-сообщения. Email message id.
language	Код языка email-сообщения Согласно ISO_639-1 Email message language code According to ISO_639-1

/v1/messages/email/{id}/viewLink

Получить ссылку для просмотра email сообщения.

Get email message view link.

Тип метода:

Type of method:

GET.

Параметры
Parameters

Название Name	Описание Description	Значение по умолчанию Default value
id	Идентификатор сообщения 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/messages/sms/{id}

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

Get SMS message.

Тип метода:

Type of method:

GET.

Параметры
Parameters

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

/v1/orders

Добавить набор заказов.
Управление заказами через события.

Add orders.
Order management via events.

Тип метода:

Type of method:

POST.

/v1/past_events

Сгенерировать события за прошедшее время.
Сценарии по данным событиям запущены не будут. В одном запросе может быть до 500 событий. Подробнее.

Generate past events.
Workflows will no be launched for these events. You can send up to 500 events per request. Learn more.

Тип метода:

Type of method:

POST.

/v1/past_events

Удалить события за выбранные период.

Remove events during selected period

Тип метода:

Type of method:

DELETE.

/v1/preprocessor/file/{id}

Обновить файл для препроцессора.

Update file for preprocessor.

Тип метода:

Type of method:

POST.

Параметры
Parameters

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

/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
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/subscriptions

Получение категорий подписок организации

Returns organization subscriptions

Тип метода:

Type of method:

GET.

/v1/version

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

Get protocol version.

Тип метода:

Type of method:

GET.