Управление рассылками уведомлений

Наименование поля на русском	Наименование поля на английском	Обязательноcть	Описание
Адрес вебхука	callback url	Нет	URL-адрес, на который будет отправляться запрос. Задается в произвольном формате. Ограничение — 4000 байт.
Вложения	attachments	Нет	Вложения, например, изображения, аудиофайлы, документы, которые пересылаются в сообщении клиенту во ВКонтакте. Ограничение — не более 10 вложений в сообщении. Значение параметра задается в формате «<[-]owner_id>_<media_id>, photo\|video\|audio\|doc\|wall\|market\|poll».
Внешний идентификатор получателя	external id	Нет	ID получателя сообщения во внешней системе. Задается в произвольном формате. Используется любая последовательность символов. Ограничение по длине — 10240 байт.
Время старта рассылки	start time	Да	Время начала рассылки. Задается в формате «ЧЧ-ММ-СС».
Всегда отправлять	required	Нет	Выполнить отправку в указанный канал в любом случае, даже если успешная отправка уже была выполнена в другом канале. Возможные значения: - true — параметр используется; - false — параметр не используется.
Данные вебхука	callback data	Нет	Любые данные, которые используются в сообщении вебхука. Задаются в виде массива в формате JSON. Ограничение — 10240 байт.
Дата старта рассылки	start date	Да	Дата начала рассылки сообщений. Значение указывается в формате «ГГ-ММ-ДД».
Длительность доставки	validity period	Да	Длительность доставки сообщения в минутах. В качестве значения используется целое число в диапазоне от 1 - 2880 (макс. 48 часов). Если сообщение за это время не будет доставлено, то оно получит статус Expired.
Допустимое время отправки	allowed time ranges	Да	Диапазон времени, в течение которого выполняется отправка сообщений. Значение задается в формате JSON в виде строки `{"09:30:00", "12:00:00"}`
Идентификатор бота	bot id	Да	ID бота. Отображается для каждого сценария в личном кабинете, в разделе Сценарии ботов.
Идентификатор группы	group id	Нет	Произвольный идентификатор для объединения сообщений в группу.
Идентификатор загрузки	bulk id	Нет	Произвольный глобальный идентификатор сообщения.
Идентификатор отправки	flow id	Нет	Идентификатор связанных сообщений для отправки в Viber. Задается вручную или генерируется автоматически.
Идентификатор получателя	client id	Нет	ID клиента на платформе.
Идентификатор получателя в мессенджере	messenger user id	Да	Номер телефона получателя сообщения для клиентской рассылки в мессенджере. Номер телефона задается в формате 7хххххххххх.
Идентификатор устройства	push registration id	Нет	Уникальный идентификатор, который присваивается каждому установленному приложению на мобильном устройстве получателя push-сообщения.
Идентификатор чата	chat id	Да	ID чата. Отображается для каждого чата в разделе Текстовые боты → Настройки личного кабинета.
Идентификатор чат сессии	chat session id	Нет	ID чат-сессии. Служит для отправки сообщения в уже существующую чат-сессию. Где скопировать ID чат-сессии, читайте в статье Работа с диалогами чата.
Идентификатор шаблона	template id	Да	ID шаблона уведомления. Отображается для каждого шаблона в личном кабинете в разделе Уведомления → Шаблоны сообщений. Подробнее о работе с шаблонами уведомлений читайте в статье Управление шаблонами уведомлений.
Имя отправителя	from	Да	Зарегистрированное имя отправителя, которое отображается клиенту при получении сообщения в поле От кого.
Имя чат сессии	chat session name	Да	Имя чат-сессии оператора чата. Служит для создания чат-сессии. Содержится в ежемесячном подробном платежном отчете по сервису чатов в личном кабинете администратора, в разделе Отчеты.
Использовать короткие ссылки	use short links	Нет	Данный параметр предназначен для конвертации любого url-адреса, который содержится в тексте сообщения, в короткую ссылку. Возможные значения: - true — параметр используется; - false — параметр не используется.
Канал	channel	Да	Название канала отправки сообщений. Данный параметр может содержать только одно значение. Возможные значения: email, sms, push, viber, whatsapp, chat, vkontakte, odnoklassniki. Значение данного параметра соответствует значению, которое задается при создании нового шаблона уведомления. Подробнее о работе с шаблонами уведомлений читайте в статье Управление шаблонами уведомлений.
Каналы	channels	Нет	Названия нескольких каналов отправки сообщений. Возможные каналы: email, sms, push, viber, whatsapp, chat, vkontakte, odnoklassniki. Каналы указываются в строке в виде JSON-структуры. Данный параметр поддерживается не всеми провайдерами. Параметр используется только в том случае, если техническая поддержка компании TWIN говорит, что его необходимо использовать. Значение параметра задается в формате: { «channels»: { «email»: { «text»: «string», «subject»: «string», «fromEmail»: «pupkin@contora.com», «fromName»: «Vasya Pupkin», «provider»: «APN», «validityPeriod»: 10 }, «sms»: { «text»: «string», «from»: «CompanyName», «provider»: «APN», «validityPeriod»: 10 }, «push»: { «text»: «string», «from»: «string», «provider»: «APN», «validityPeriod»: 10 }, «viber»: { «text»: «string», «from»: «string», «imageUrl»: «string», «buttonUrl»: «string», «buttonText»: «string», «provider»: «APN», «validityPeriod»: 10 }, «whatsapp»: { «from»: «string», «templateName»: «string», «templateNamespace»: «string», «templateData»: [ «string» ], «language»: «string», «mediaUrl»: «string», «text»: «string», «provider»: «APN» }, «vkontakte»: { «from»: «string», «templateName»: «string», «templateData»: [ «string» ], «text»: «string», «provider»: «APN», «attachments»: [ «video-85635407_165186811», «wall-92255884_16» ] }, «odnoklassniki»: { «templateName»: «string», «templateData»: [ «string» ], «text»: «string», «provider»: «APN» }, «chat»: { «chatId»: «bce7d22e-dde6-4427-b391-ebbdfda44de6», «botId»: «bce7d22e-dde6-4427-b391-ebbdfda44de6», «messengerType»: «WHATSAPP», «chatSessionName»: «string», «provider»: «APN», «continueLastOrStartNewSession»: true } } }
Категория сообщений	message category	Нет	Тип сообщений в маркетинговой рассылке. Значение задается в произвольном формате. Данный параметр используется только в случае, если сообщения по умолчанию имеют параметр Отложенные.
Кнопка в чате	button	Нет	Данные, необходимые для формирования кнопки, которая отображается получателю в чате. Возможные значения: - text — текст на кнопке; - payload — данные для отправки, когда кнопка нажата; - url — URL-адрес, который открывается, когда кнопка нажата. Значение задается в формате JSON в виде строки: `{ "text": "string", "payload": "string", "url": "string" }`
Коды ошибок	error codes	Нет	Массив кодов ошибок, которые могут быть возвращены в ответ на неудачную отправку сообщения. Значение задается в формате JSON в виде массива: `[ "error_code1", "error_code2", "error_code3" ]`
Количество сообщений	count	Нет	Количество сообщений, отправленных за один запрос. В качестве значения используется целое число. Ограничение по значению — от 1 до 1000.
Номер телефона	phone number	Да	Номер телефона получателя сообщения. Задается в формате 7хххххххххх.
Оператор чата	chat operator	Да	Имя оператора чата, которое отображается получателю при получении сообщения в поле От кого.
Основной идентификатор чата	main chat id	Да	ID основного чата. Отображается для каждого чата в разделе Текстовые боты → Настройки личного кабинета.
Отображаемое имя	display name	Нет	Имя отправителя, которое отображается клиенту при получении сообщения в поле От кого.
Пароль	password	Да	Пароль для доступа к API.
Платежные данные	payment data	Нет	Данные, связанные с оплатой. Например, номер карты или идентификатор транзакции. Значение задается в формате JSON в виде строки `{"card_number": "string", "transaction_id": "string"}`
Платформа	platform	Да	Название платформы, на которой отправляется сообщение. Возможные значения: iOS, Android, Web.
Поле приоритета	priority	Нет	Порядок отправки сообщения. Возможные значения: - high — высокий приоритет; - normal — нормальный приоритет; - low — низкий приоритет.
Порядок отправки	send order	Да	Порядок отправки сообщений. Возможные значения: - sequential — последовательно; - parallel — параллельно.
Правила отправки	send rules	Нет	Правила отправки сообщений. Задаются в формате JSON в виде строки `{"rule1": "value1", "rule2": "value2"}`
Предпросмотр сообщения	message preview	Нет	Предварительный просмотр сообщения, отправляемого получателю. Значение задается в формате JSON в виде строки `{"text": "string", "image_url": "string"}`
Префикс	prefix	Нет	Префикс для номера телефона получателя сообщения. Задается в формате строки. Например, +7 для России.
Примечания	notes	Нет	Любые дополнительные сведения. Задаются в произвольном формате.
Принудительная отправка	force send	Нет	Параметр для принудительной отправки сообщения. Возможные значения: - true — параметр используется; - false — параметр не используется.
Режим отправки	send mode	Нет	Режим отправки сообщений. Возможные значения: - auto — автоматический режим; - manual — ручной режим.
Секретный ключ	secret key	Да	Секретный ключ для доступа к API.
Содержимое сообщения	message content	Да	Содержимое сообщения, которое отправляется получателю. Задается в формате строки.
Статус отправки	send status	Да	Статус отправки сообщения. Возможные значения: - sent — отправлено; - failed — не отправлено; - pending — в ожидании.
Структура данных	data structure	Нет	Структура данных сообщения. Значение задается в формате JSON в виде строки `{"field1": "value1", "field2": "value2"}`
Таймаут	timeout	Да	Таймаут в миллисекундах для отправки сообщения. В качестве значения используется целое число. Ограничение по значению — от 1000 до 60000.
Тип сообщения	message type	Да	Тип отправляемого сообщения. Возможные значения: - text — текстовое сообщение; - image — изображение; - video — видео; - audio — аудио; - document — документ.
Тип получателя	recipient type	Да	Тип получателя сообщения. Возможные значения: - individual — индивидуальный получатель; - group — группа получателей.
Уникальный идентификатор сообщения	unique message id	Да	Уникальный идентификатор сообщения. Задается в произвольном формате. Ограничение по длине — 10240 байт.
Фильтры	filters	Нет	Фильтры для отправки сообщения. Задаются в формате JSON в виде строки `{"filter1": "value1", "filter2": "value2"}`
Электронная почта	email	Да	Электронная почта получателя сообщения.
Язык	language	Нет	Язык шаблона сообщений. В качестве значений можно использовать любые языки. На текущий момент возможные значения: ru (русский), en (английский).

¶ Создание рассылки

¶ Редактирование рассылки

¶ Удаление рассылки