Ресурс
Resource
|
Метод
Method
|
Описание
Description
|
---|---|---|
/v2/contacts/activity | GET |
Активность контактов по рассылкам.
Get contacts activity.
|
/v2/contacts/messages | GET |
История сообщений для контакта. Поддерживаемые медиа типы - EMAIL, SMS, VIBER.
Messages history per contact. Supported media types - EMAIL, SMS, VIBER.
|
/v2/contacts/recoms/{dataSourceId} | GET |
Рекомендации для контакта, основанные на веб-трекинге.
Contact recommendations based on web tracking.
|
/v2/version | GET |
Получить версию протокола.
Get protocol version.
|
/v1/account/info | GET |
Получить информацию об аккаунте.
Get current account info.
|
/v1/addressbooks | GET |
Получить список каталогов.
Каталог содержит списки дополнительных полей для контактов, которые доступны в вашей организации. Get catalog list.
The catalog contains the list of additional fields for contacts that are available in your organisation. |
/v1/auth/token | POST |
Сгенерировать 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 |
/v1/balance | GET |
Получить баланс организации.
Get organisation balance.
|
/v1/broadcast | POST |
Создать рассылку. Для email, sms, web push, viber
Create broadcast. For email, sms, web push, viber
|
/v1/broadcast/{broadcast_id} | GET |
Получить информацию о рассылке.
Get broadcast info.
|
/v1/broadcast/{broadcast_id} | DELETE |
Отменить запланированную рассылку.
Cancel scheduled broadcast.
|
/v1/broadcasts | GET |
Получить список рассылок.
Get broadcasts.
|
/v1/contact | POST |
Добавить контакт.
Поле id будет проигнорировано. Add contact.
The id field will be ignored. |
/v1/contact/{id} | PUT |
Обновить контакт.
Поле id контакта будет проигнорировано.
Update contact.
The id field of contact will be ignored. |
/v1/contact/{id} | DELETE |
Удалить контакт.
Delete contact.
|
/v1/contact/{id} | GET |
Получить контакт.
Get contact.
|
/v1/contact/{id}/subscriptions | GET |
Получение категорий, на которые подписан контакт.
Returns subscriptions which a contact is subscribed to.
|
/v1/contact/{id}/subscriptions | PUT |
Изменение категорий, на которые подписан контакт.
Change contact subscription categories.
|
/v1/contact/subscribe | POST |
Подписать контакт.
Используется для интеграции форм подписки. Если контакт не существует - будет создан с неподтверждённым 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. |
/v1/contact/token/activated/{app_uuid}/{token_id} | PUT |
Изменение активности токена
Change token activity
|
/v1/contact/token/activated/{app_uuid}/{token_id} | GET |
Получение активности токена
Get token activity
|
/v1/contacts | POST |
Добавить/обновить контакты.
Существующие контакты будут обновлены, новые - добавлены.
Add/update contacts.
Existing contacts will be updated, new contacts will be added. |
/v1/contacts | GET |
/**
Поиск контактов.
Метод возвращает не более 500 результатов. В заголовке TotalCount указано общее число контактов.
Search contacts.
The method returns max 500 results. There are total amount of contacts in TotalCount header. |
/v1/contacts/email | GET |
Получить email по идентификатору контакта.
Get email by contact id.
|
/v1/contacts/upload | POST |
Добавить/обновить контакты из внешнего файла.
Существующие контакты будут обновлены, новые - добавлены. Add/update contacts from external file.
Existing contacts will be updated, new contacts will be created. |
/v1/emails/unsubscribed/add | POST |
Добавить email-ы в список отписавшихся (отписать email-ы).
Add emails to unsubscribed list (unsubscribe emails).
|
/v1/emails/unsubscribed/delete | POST |
Удалить email-ы из списка отписавшихся.
Remove emails from unsubscribed list.
|
/v1/event | POST |
Сгенерировать событие.
Управление заказами через события.
Generate event.
Order management via events. |
/v1/group/{id}/contacts | GET |
Поиск всех контактов в группе.
Get contacts from segment.
|
/v1/group/{id}/contacts/detach | POST |
Удалить все контакты из статической группы.
Delete all contacts from static segment.
|
/v1/groups | GET |
Поиск групп.
Get segments.
|
/v1/importstatus/{sessionId} | GET |
Получение статуса сессии импорта контактов по асинхронному идентификатору сессии.
Get contact import session status by asynchronous session ID.
|
/v1/interactions/{interaction_id}/status | PUT |
Обновить статус отправки
Update interaction status
|
/v1/interfaces/email | GET |
Получить email-интерфейсы (имена отправителей).
Get email interfaces
|
/v1/interfaces/sms | GET |
Получить sms-интерфейсы (имена отправителей).
Get SMS interfaces (alpha names)
|
/v1/message/{id}/send OLD | POST |
Отправка рассылки по заранее созданному сообщению. Сообщение может дополнительно параметризироваться.
Метод устарел. Рекомендуется использовать вместо него метод /v1/message/{id}/smartsend.
Dispatch start of the created message. Message can be parametrized additionally.
Method is deprecated. It is recommended to use method /v1/message/{id}/smartsend instead. |
/v1/message/{id}/smartsend | POST |
Отправка подготовленного сообщения одному или многим контактам.
Сообщение может параметризироваться для каждого контакта отдельно.
Sending prepared message to one or many contacts.
The message can be parametrized for each contact separately.
|
/v1/message/email | POST |
Отправить email-сообщение.
Если контакта с таким адресом нет, он будет создан.
Send email message.
If contact with such email address is not exist it will be created.
|
/v1/message/email/status OLD | GET |
Получить статус одиночного email сообщения.
Meтод устарел. Рекомендуется использовать вместо него метод /v1/message/status.
Get status of a single email message.
Method is deprecated. It is recommended to use method /v1/message/status instead. |
/v1/message/sms | POST |
Отправить sms-сообщение.
Если контакта с таким номером телефона нет, он будет создан.
Send SMS message.
If contact with such phone number is not exist it will be created.
|
/v1/message/sms/status OLD | GET |
Получить статус одиночного sms сообщения.
Meтод устарел. Рекомендуется использовать вместо него метод /v1/message/status. Get status of the single SMS message.
Method is deprecated. It is recommended to use method /v1/message/status instead. |
/v1/message/status | GET |
Получить статус одиночного сообщения.
Get status of a single message.
|
/v1/message/viber | POST |
Отправить viber-сообщение.
Если контакта с таким номером телефона нет, он будет создан.
Send VIBER message.
If contact with such phone number is not exist it will be created.
|
/v1/message/viber/status OLD | GET |
Получить статус одиночного viber сообщения.
Meтод устарел. Рекомендуется использовать вместо него метод /v1/message/status. Get status of the single VIBER message.
Method is deprecated. It is recommended to use method /v1/message/status instead. |
/v1/messages/email | POST |
Добавить базовое email-сообщение.
Add base email message.
|
/v1/messages/email | GET |
Поиск 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. |
/v1/messages/email/{id} | GET |
Получить email-сообщение.
Get email message.
|
/v1/messages/email/{id} | DELETE |
Удалить базовое email-сообщение.
Delete base email message.
|
/v1/messages/email/{id} | PUT |
Обновить базовое email-сообщение.
Update base email message.
|
/v1/messages/email/{id}/{language} | DELETE |
Удалить дочернее email-сообщение.
Delete translated email message.
|
/v1/messages/email/{id}/{language} | PUT |
Обновить дочернее email-сообщение
Update translated email message.
|
/v1/messages/email/{id}/viewLink | GET |
Получить ссылку для просмотра email сообщения.
Get email message view link.
|
/v1/messages/sms | GET |
Поиск 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. |
/v1/messages/sms/{id} | GET |
Получить SMS-сообщение.
Get SMS message.
|
/v1/orders | POST |
Добавить набор заказов.
Управление заказами через события.
Add orders.
Order management via events. |
/v1/past_events | POST |
Сгенерировать события за прошедшее время.
Сценарии по данным событиям запущены не будут. В одном запросе может быть до 500 событий. Подробнее.
Generate past events.
Workflows will no be launched for these events. You can send up to 500 events per request. Learn more. |
/v1/past_events | DELETE |
Удалить события за выбранные период.
Remove events during selected period
|
/v1/preprocessor/file/{id} | POST |
Обновить файл для препроцессора.
Update file for preprocessor.
|
/v1/preprocessor/file/{id}/status | GET |
Получение статуса сессии загрузки файла для препроцессора по асинхронному идентификатору сессии.
Retrieving file uploading session status for pre-processor by asynchronous session identifier.
|
/v1/preprocessor/file/upload | POST |
Загрузить файл для препроцессора из внешнего репозитория.
Upload file for preprocessor from external repository.
|
/v1/promocodes | POST |
Загрузить промокоды из csv файла.
Существующие промокоды обновляются.
Upload promotional codes from a CSV file.
Existing promotional codes will be updated.
|
/v1/promocodes | POST |
Загрузить промокоды из JSON.
Существующие промокоды обновляются.
Upload promotional codes in JSON format.
Existing promotional codes will be updated.
|
/v1/promocodes | GET |
Получить промокоды. В этом методе возвращается список всех доступных промокодов.
Get promotional codes. The method returns a list of all available promotional codes.
|
/v1/promocodes/count | GET |
Получить количество доступных промокодов.
Get the amount of available promotional codes.
|
/v1/subscriptions | GET |
Получение категорий подписок организации
Returns organization subscriptions
|
/v1/version | GET |
Получить версию протокола.
Get protocol version.
|
Название 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.
|
||
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 |
Название 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 (только один из 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 |
Название Name |
Описание Description |
Значение по умолчанию Default value |
---|---|---|
dataSourceId |
Обязательный параметр.
Идентификатор источника данных(можно увидеть в Вашем аккаунте > Настройки > Источники данных Required parameter.
Data Source ID (can be seen in your account> Settings> Data Sources) |
|
contactId |
Идентификатор контакта (Хотя бы один из contactId, email, phone должен быть указан).
Contact ID (At least one of contactId, email, phone must be specified).
|
|
Email контакта(Хотя бы один из contactId, email, phone должен быть указан).
Contact email (At least one of contactId, email, phone must be specified).
|
||
phone |
Номер телефона контакта (Хотя бы один из contactId, email, phone должен быть указан).
Contact phone number (At least one of contactId, email, phone must be specified).
|
|
sms |
Устаревшее. Синоним для phone.
Deprecated. Synonym for phone.
|
|
products |
Список идентификаторов продуктов. Обязательное поле для product-based алгоритмов
An array of product IDs. Required for product-based algorithms
|
|
category |
Идентификатор категории. Обязательное поле для category-based алгоритмов
A category ID. Required for category-based algorithms.
|
Название Name |
Описание Description |
Значение по умолчанию Default value |
---|---|---|
broadcast_id |
Идентификатор рассылки
Broadcast id
|
Название Name |
Описание Description |
Значение по умолчанию Default value |
---|---|---|
broadcast_id |
Идентификатор рассылки
Broadcast id
|
Название 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 |
Название Name |
Описание Description |
Значение по умолчанию Default value |
---|---|---|
id |
Идентификтор контакта
Contact ID
|
Название Name |
Описание Description |
Значение по умолчанию Default value |
---|---|---|
id |
Идентификатор контакта
Contact ID
|
Название Name |
Описание Description |
Значение по умолчанию Default value |
---|---|---|
id |
Id контакта.
Contact ID.
|
Название Name |
Описание Description |
Значение по умолчанию Default value |
---|---|---|
id |
Идентификтор контакта
Contact ID
|
Название Name |
Описание Description |
Значение по умолчанию Default value |
---|---|---|
id |
Идентификтор контакта
Contact ID
|
Название Name |
Описание Description |
Значение по умолчанию Default value |
---|---|---|
token_id |
Токен
Token id
|
|
app_uuid |
Индификатор приложения
Application id
|
Название Name |
Описание Description |
Значение по умолчанию Default value |
---|---|---|
token_id |
Токен
Token id
|
|
app_uuid |
Индификатор приложения
Application id
|
/**
Название Name |
Описание Description |
Значение по умолчанию Default value |
---|---|---|
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 |
Название Name |
Описание Description |
Значение по умолчанию Default value |
---|---|---|
ids |
Идентификаторы контактов, для которых будут получены email-ы, разделённые запятыми.
Comma separated list of contact IDs to get emails for.
|
Название 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 |
Название Name |
Описание Description |
Значение по умолчанию Default value |
---|---|---|
id |
Идентификатор группы.
Segment ID
|
Название 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 |
Название Name |
Описание Description |
Значение по умолчанию Default value |
---|---|---|
sessionId |
Асинхронный идентификатор сессии
Asynchronous session identifier
|
Название Name |
Описание Description |
Значение по умолчанию Default value |
---|---|---|
interaction_id |
Идентификатор отправки
Interaction id
|
Название Name |
Описание Description |
Значение по умолчанию Default value |
---|---|---|
id |
ID сообщения. Поддерживаются email, SMS и Viber сообщения.
Message ID. Currently email, SMS and Viber messages are supported.
|
Название Name |
Описание Description |
Значение по умолчанию Default value |
---|---|---|
id |
ID сообщения. Поддерживаются email, SMS и Viber сообщения.
Message ID. Currently email, SMS and Viber messages are supported.
|
Название Name |
Описание Description |
Значение по умолчанию Default value |
---|---|---|
ids |
Идентификаторы одиночных сообщений, для которых будут получены статусы, разделённые запятыми.
Comma separated list of IDs of single messages.
|
Название Name |
Описание Description |
Значение по умолчанию Default value |
---|---|---|
ids |
Идентификаторы одиночных сообщений, для которых будут получены статусы, разделённые запятыми.
Comma separated list of IDs of single messages.
|
Название Name |
Описание Description |
Значение по умолчанию Default value |
---|---|---|
ids |
Идентификаторы одиночных сообщений, для которых будут получены статусы, разделённые запятыми.
Comma separated list of IDs of single messages.
|
Название Name |
Описание Description |
Значение по умолчанию Default value |
---|---|---|
ids |
Идентификаторы одиночных сообщений, для которых будут получены статусы, разделённые запятыми.
Comma separated list of IDs of single messages.
|
Название 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 |
Название Name |
Описание Description |
Значение по умолчанию Default value |
---|---|---|
id |
Идентификатор email-сообщения.
Email message id.
|
Название Name |
Описание Description |
Значение по умолчанию Default value |
---|---|---|
id |
Идентификатор email-сообщения.
Email message id.
|
Название Name |
Описание Description |
Значение по умолчанию Default value |
---|---|---|
id |
Идентификатор email-сообщения.
Email message id.
|
Название Name |
Описание Description |
Значение по умолчанию Default value |
---|---|---|
id |
Идентификатор email-сообщения.
Email message id.
|
|
language |
Код языка email-сообщения
Согласно ISO_639-1 Email message language code
According to ISO_639-1 |
Название Name |
Описание Description |
Значение по умолчанию Default value |
---|---|---|
id |
Идентификатор email-сообщения.
Email message id.
|
|
language |
Код языка email-сообщения
Согласно ISO_639-1 Email message language code
According to ISO_639-1 |
Название Name |
Описание Description |
Значение по умолчанию Default value |
---|---|---|
id |
Идентификатор сообщения
Message id
|
Название 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 |
Название Name |
Описание Description |
Значение по умолчанию Default value |
---|---|---|
id |
Идентификатор SMS-сообщения.
SMS message id.
|
Название Name |
Описание Description |
Значение по умолчанию Default value |
---|---|---|
id |
Идентификатор файла
FIle identifier
|
Название Name |
Описание Description |
Значение по умолчанию Default value |
---|---|---|
id |
Асинхронный идентификатор сессии
Asynchronous session identifier
|
Название Name |
Описание Description |
Значение по умолчанию Default value |
---|---|---|
expirationDate |
Дата завершения действия промокода.
Term of promo code validity.
|
|
discount |
Скидка.
Discount.
|
|
type |
Тип промокода.
Type of promo code.
|
|
inUse |
Флаг, использованный промокод или нет.
Tag used/unused promo code.
|
false |
Название Name |
Описание Description |
Значение по умолчанию Default value |
---|---|---|
expirationDate |
Дата завершения действия промокода.
Term of promo code validity.
|
|
discount |
Скидка.
Discount.
|
|
type |
Тип промокода.
Type of promo code.
|
|
inUse |
Флаг, использованный промокод или нет.
Tag used/unused promo code.
|
false |
Название 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.
|
Название 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.
|