Курьер (независимый издатель) (предварительная версия)

Курьер — это служба и веб-студия для команд разработчиков для управления всеми сообщениями, инициируемых продуктом (электронная почта, чат, в приложении, SMS, push и т. д.) в одном месте. Курьер создан для разработчиков, которые хотят доставить исключительный интерфейс уведомлений.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга	Class	Регионы
Copilot Studio	Премия	Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD)
Логические приложения	Стандарт	Все регионы Logic Apps , кроме следующих: — Регионы Azure для государственных организаций — Регионы Azure Для Китая - Министерство обороны США (DoD)
Power Apps	Премия	Все регионы Power Apps , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD)
Power Automate	Премия	Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD)

Контакт
Имя	Трой Тейлор
URL	https://www.hitachisolutions.com
Адрес электронной почты	ttaylor@hitachisolutions.com

Метаданные соединителя
Publisher	Трой Тейлор
Веб-сайт	https://www.courier.com/
Политика конфиденциальности	https://www.courier.com/privacy/
Категории	Коммуникация; Социальные медиа

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:


По умолчанию	Параметры для создания подключения.	Все регионы	Недоступен для совместного использования

По умолчанию

Применимо: все регионы

Параметры для создания подключения.

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Имя	Тип	Description	Обязательно
Токен (в форме "Носитель вашегоToken")	securestring	Маркер (в форме носителя yourToken) для этого API	True

Ограничения регулирования

Имя	Вызовы	Период обновления
Вызовы API для каждого подключения	100	60 секунд

Действия

Архивация сообщения	Попросите архивировать сообщение.
Восстановление списка	Восстанавливает существующий список по идентификатору.
Вывод списка всех аудиторий	Извлеките все аудитории, связанные с вашей учетной записью.
Вывод списка участников аудитории	Получение списка участников аудитории.
Выполнение массового задания	Начните выполнение массового задания.
Добавление подписчиков в список	Добавьте дополнительных подписчиков в список.
Добавление пользователей в массовое задание	Прием данных пользователей в массовое задание.
Запуск нерегламентированной автоматизации	Вызов автоматизации в нерегламентированном запуске.
Запуск шаблонной автоматизации	Вызов запуска автоматизации из шаблона службы автоматизации.
Обновление профиля	Обновляет часть профиля.
Обновление списка	Создает или заменяет существующий список указанными значениями.
Отмена подписки пользователя из списка	Удаляет подписку на список по спискам и идентификаторам получателей.
Отправка сообщения	Отправляет сообщение одному или нескольким получателям.
Перечисление уведомлений	Извлекает список уведомлений.
Получение аудитории	Возвращает указанную аудиторию по идентификатору.
Получение бренда	Получение определенной торговой марки по идентификатору.
Получение всех событий аудита	Получение списка событий аудита.
Получение всех списков получателей	Получение списка всех списков получателей.
Получение журнала сообщения	Получение событий ранее отправленного сообщения.
Получение массового задания	Получение сведений о массовом задании.
Получение подписок списка	Извлекает подписки для списка.
Получение пользователей массового задания	Получение пользователей массового задания.
Получение профиля	Извлекает указанный профиль получателя.
Получение события аудита	Получение определенного события аудита по идентификатору.
Получение содержимого сообщения	Получение содержимого ранее отправленного сообщения.
Получение сообщения	Получение состояния сообщения.
Получение списка	Получение элементов списка.
Создание бренда	Создает новую фирменную символь из указанных параметров.
Создание или обновление аудитории	Создает или обновляет аудиторию на основе параметров и фильтров, предоставленных.
Создание массового задания	Создает массовое задание для указанных параметров сообщения.
Создание профиля	Объедините предоставленные значения с существующим профилем или создайте новый профиль, если он еще не существует.
Список брендов	Получение списка брендов.
Список сообщений	Получение состояний ранее отправленных сообщений.
Удаление аудитории	Удаляет указанную аудиторию получателя.
Удаление профиля	Удаляет указанный профиль получателя.
Удаление списка	Удаляет список по идентификатору списка.

Архивация сообщения

Идентификатор операции:: MessagePut

Попросите архивировать сообщение.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор запроса	request_id	True	string	Идентификатор запроса.

Возвращаемое значение

response: string

Восстановление списка

Идентификатор операции:: ListRestorePut

Восстанавливает существующий список по идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор списка	list_id	True	string	Идентификатор списка.

Возвращаемое значение

response: string

Вывод списка всех аудиторий

Идентификатор операции:: AudiencesGet

Извлеките все аудитории, связанные с вашей учетной записью.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Cursor	cursor		string	Курсор.

Возвращаемое значение

Имя	Путь	Тип	Описание
Товары	items	array of object
Идентификатор	items.id	string	Идентификатор.
Имя	items.name	string	Имя.
Description	items.description	string	Описание.
Operator	items.filter.operator	string	Оператор.
Ценность	items.filter.value	string	Значение.
Путь	items.filter.path	string	Путь.
Cursor	paging.cursor	string	Курсор.
Подробнее	paging.more	boolean	Есть ли больше.

Вывод списка участников аудитории

Идентификатор операции:: AudienceMembersGet

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор аудитории	audience_id	True	string	Идентификатор аудитории.
Cursor	cursor		string	Курсор.

Возвращаемое значение

Имя	Путь	Тип	Описание
Товары	items	array of object
Идентификатор члена	items.member_id	string	Идентификатор члена.
Добавлено в	items.added_at	string	При добавлении.
Идентификатор аудитории	items.audience_id	string	Идентификатор аудитории.
Версия аудитории	items.audience_version	integer	Версия аудитории.
Причина	items.reason	string	Причина.
Cursor	paging.cursor	string	Курсор.
Подробнее	paging.more	boolean	Есть ли больше.

Выполнение массового задания

Идентификатор операции:: BulkJobRunPost

Начните выполнение массового задания.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор задания	job_id	True	string	Идентификатор задания.

Возвращаемое значение

response: object

Добавление подписчиков в список

Идентификатор операции:: ListSubscribersPost

Добавьте дополнительных подписчиков в список.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор списка	list_id	True	string	Идентификатор списка.
Идентификатор получателя	recipientId		string	Идентификатор получателя.

Возвращаемое значение

response: string

Добавление пользователей в массовое задание

Идентификатор операции:: BulkJobUsersPost

Прием данных пользователей в массовое задание.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор задания	job_id	True	string	Идентификатор задания.
Recipient	recipient		string	Получатель.

Возвращаемое значение

response: string

Запуск нерегламентированной автоматизации

Идентификатор операции:: AutomationAdHocPost

Вызов автоматизации в нерегламентированном запуске.

Параметры

Имя	Ключ	Тип	Описание
Маркер отмены	cancelation_token	string	Маркер отмены.
Бренд	brand	string	Бренд.
Template	template	string	Шаблон.
Recipient	recipient	string	Получатель.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор запуска	runId	string	Идентификатор выполнения.

Запуск шаблонной автоматизации

Идентификатор операции:: AutomationTemplatedPost

Вызов запуска автоматизации из шаблона службы автоматизации.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
ИД шаблона	templateId	True	string	Идентификатор шаблона.
Бренд	brand		string	Бренд.
Template	template		string	Шаблон.
Recipient	recipient		string	Получатель.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор запуска	runId	string	Идентификатор выполнения.

Обновление профиля

Идентификатор операции:: ProfilePatch

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор получателя	recipient_id	True	string	Идентификатор получателя.
Операция	op		string	Операция.
Путь	path		string	Путь.
Ценность	value		string	Значение.

Возвращаемое значение

Имя	Путь	Тип	Описание
Состояние	status	string	Состояние.

Обновление списка

Идентификатор операции:: ListPut

Создает или заменяет существующий список указанными значениями.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор списка	list_id	True	string	Идентификатор списка.
Имя	name		string	Имя.

Возвращаемое значение

response: string

Отмена подписки пользователя из списка

Идентификатор операции:: ListSubscribeDelete

Удаляет подписку на список по спискам и идентификаторам получателей.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор списка	list_id	True	string	Идентификатор списка.
Идентификатор получателя	recipient_id	True	string	Идентификатор получателя.

Возвращаемое значение

response: string

Отправка сообщения

Идентификатор операции:: MessageSendPost

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идемпотентность	idempotency	True	string	Ключ идемпотентности.
Название	title		string	Заголовок.
Тело	body		string	Тело.
Идентификатор пользователя	user_id		string	Идентификатор пользователя.
Идентификатор списка	list_id		string	Идентификатор списка.
Идентификатор аудитории	audience_id		string	Идентификатор аудитории.
Адрес электронной почты	email		string	Адрес электронной почты.
Номер телефона	phone_number		string	Номер телефона.
Региональные настройки	locale		string	Языковой стандарт.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор запроса	requestId	string	Идентификатор запроса.

Перечисление уведомлений

Идентификатор операции:: NotificationsGet

Извлекает список уведомлений.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Cursor	cursor		string	Курсор.

Возвращаемое значение

Имя	Путь	Тип	Описание
Cursor	paging.cursor	string	Курсор.
Подробнее	paging.more	boolean	Есть ли больше.
Results	results	array of object
Создано в	results.created_at	integer	При создании.
Идентификатор	results.id	string	Идентификатор.
Данные	results.tags.data	array of object
Идентификатор	results.tags.data.id	string	Идентификатор.
Имя	results.tags.data.name	string	Имя.
Название	results.title	string	Заголовок.
Обновлено в	results.updated_at	integer	При обновлении по адресу.

Получение аудитории

Идентификатор операции:: AudienceGet

Возвращает указанную аудиторию по идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор аудитории	audience_id	True	string	Идентификатор аудитории.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	id	string	Идентификатор.
Имя	name	string	Имя.
Description	description	string	Описание.
Operator	filter.operator	string	Оператор.
Ценность	filter.value	string	Значение.
Путь	filter.path	string	Путь.

Получение бренда

Идентификатор операции:: BrandGet

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор бренда	brand_id	True	string	Идентификатор бренда.

Возвращаемое значение

Имя	Путь	Тип	Описание
Создано	created	integer	При создании.
Идентификатор	id	string	Идентификатор.
Имя	name	string	Имя.
Опубликовано	published	integer	При публикации.
Updated	updated	integer	Обновлено.
Версия	version	string	Версия.
Primary	settings.colors.primary	string	Основной объект.
Secondary	settings.colors.secondary	string	Вторичный.
Третичный	settings.colors.tertiary	string	Третичный.
Цвет панели	settings.email.header.barColor	string	Цвет панели.
HREF	settings.email.header.logo.href	string	The HREF.
Изображение	settings.email.header.logo.image	string	Изображение.
Markdown (язык разметки)	settings.email.footer.markdown	string	Markdown.
URL	settings.email.footer.social.facebook.url	string	URL-адрес.
URL	settings.email.footer.social.instagram.url	string	URL-адрес.
URL	settings.email.footer.social.linkedin.url	string	URL-адрес.
URL	settings.email.footer.social.medium.url	string	URL-адрес.
URL	settings.email.footer.social.twitter.url	string	URL-адрес.
Значок отключения сообщения	settings.inapp.disableMessageIcon	boolean	Следует ли отключить значок сообщения.
Размещение	settings.inapp.placement	string	Размещение.
Товары	snippets.items	array of string	Элементы.

Получение всех событий аудита

Идентификатор операции:: AuditEventsGet

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Cursor	cursor		string	Курсор.

Возвращаемое значение

Имя	Путь	Тип	Описание
Cursor	paging.cursor	string	Курсор.
Подробнее	paging.more	boolean	Есть ли больше.
Results	results	array of object
Идентификатор события аудита	results.auditEventId	string	Идентификатор события аудита.
Идентификатор	results.actor.id	string	Идентификатор.
Адрес электронной почты	results.actor.email	string	Адрес электронной почты.
Идентификатор	results.target.id	string	Идентификатор.
Адрес электронной почты	results.target.email	string	Адрес электронной почты.
Исходный материал	results.source	string	Источник.
Отметка времени	results.timestamp	string	Метка времени.
Тип	results.type	string	Тип.

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

Идентификатор операции:: ListsGet

Получение списка всех списков получателей.

Возвращаемое значение

Имя	Путь	Тип	Описание
Cursor	paging.cursor	string	Курсор.
Подробнее	paging.more	boolean	Есть ли больше.
Results	results	array of object
Создано	results.created	string	При создании.
Идентификатор	results.id	string	Идентификатор.
Имя	results.name	string	Имя.
Updated	results.updated	string	При обновлении.

Получение журнала сообщения

Идентификатор операции:: MessageHistoryGet

Получение событий ранее отправленного сообщения.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор сообщения	message_id	True	string	Идентификатор сообщения.
Тип	type		string	Тип.

Возвращаемое значение

Имя	Путь	Тип	Описание
Results	results	array of object
Имя	results.data.name	string	Имя.
Event	results.event	string	Событие.
Recipient	results.recipient	string	Получатель.
TS	results.ts	integer	The TS.
Тип	results.type	string	Тип.
Идентификатор события	results.event_id	string	Идентификатор события.
Идентификатор уведомления	results.notification_id	string	Идентификатор уведомления.
Идентификатор	results.channel.id	string	Идентификатор.
Идентификатор	results.integration.id	string	Идентификатор.
Provider	results.integration.provider	string	Поставщик.

Получение массового задания

Идентификатор операции:: BulkJobGet

Получение сведений о массовом задании.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор задания	job_id	True	string	Идентификатор задания.

Возвращаемое значение

Имя	Путь	Тип	Описание
Event	job.definition.event	string	Событие.
Очередь	job.enqueued	integer	Заквеченный.
Сбоев	job.failures	integer	Сбои.
Получено	job.received	integer	При получении.
Состояние	job.status	string	Состояние.

Получение подписок списка

Идентификатор операции:: ListSubscriptionsGet

Извлекает подписки для списка.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор списка	list_id	True	string	Идентификатор списка.
Cursor	cursor		string	Курсор.

Возвращаемое значение

Имя	Путь	Тип	Описание
Cursor	paging.cursor	string	Курсор.
Подробнее	paging.more	boolean	Есть ли больше.
Товары	items	array of object
Идентификатор получателя	items.recipientId	string	Идентификатор получателя.
Создано	items.created	string	При создании.

Получение пользователей массового задания

Идентификатор операции:: BulkJobUsersGet

Получение пользователей массового задания.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор задания	job_id	True	string	Идентификатор задания.

Возвращаемое значение

Имя	Путь	Тип	Описание
Товары	items	array of object
Recipient	items.recipient	string	Получатель.
Адрес электронной почты	items.email	string	Адрес электронной почты.
Региональные настройки	items.locale	string	Языковой стандарт.
Cursor	paging.cursor	string	Курсор.
Подробнее	paging.more	boolean	Есть ли больше.

Получение профиля

Идентификатор операции:: ProfileGet

Извлекает указанный профиль получателя.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор получателя	recipient_id	True	string	Идентификатор получателя.

Возвращаемое значение

Имя	Путь	Тип	Описание
Адрес электронной почты	profile.email	string	Адрес электронной почты.
Номер телефона	profile.phone_number	string	Номер телефона.

Получение события аудита

Идентификатор операции:: AuditEventGet

Получение определенного события аудита по идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор события аудита	audit-event-id	True	string	Идентификатор события аудита.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор события аудита	auditEventId	string	Идентификатор события аудита.
Идентификатор	actor.id	string	Идентификатор.
Адрес электронной почты	actor.email	string	Адрес электронной почты.
Идентификатор	target.id	string	Идентификатор.
Адрес электронной почты	target.email	string	Адрес электронной почты.
Исходный материал	source	string	Источник.
Отметка времени	timestamp	string	Метка времени.
Тип	type	string	Тип.

Получение содержимого сообщения

Идентификатор операции:: MessageContentGet

Получение содержимого ранее отправленного сообщения.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор сообщения	message_id	True	string	Идентификатор сообщения.

Возвращаемое значение

Имя	Путь	Тип	Описание
Results	results	array of object
Channel	results.channel	string	Канал.
Идентификатор канала	results.channel_id	string	Идентификатор канала.
HTML	results.content.html	string	The HTML.
Тема	results.content.subject	string	Тема.
Текст	results.content.text	string	Текст.
Блоки	results.content.blocks	array of object
Тип	results.content.blocks.type	string	Тип.
Текст	results.content.blocks.text	string	Текст.

Получение сообщения

Идентификатор операции:: MessageGet

Получение состояния сообщения.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор сообщения	message_id	True	string	Идентификатор сообщения.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	id	string	Идентификатор.
Состояние	status	string	Состояние.
Очередь	enqueued	integer	Заквеченный.
Sent	sent	integer	Отправленный.
Доставлено	delivered	integer	Доставлено.
Прочтено	opened	integer	Открывалось.
Нажал	clicked	integer	Щелчок.
Recipient	recipient	string	Получатель.
Event	event	string	Событие.
Notification	notification	string	Уведомление.
Ошибка	error	string	Ошибка.
Причина	reason	string	Причина.
Providers	providers	array of object
Sent	providers.sent	integer	Отправленный.
Доставлено	providers.delivered	integer	Доставлено.
Нажал	providers.clicked	integer	Щелчок.
Прочтено	providers.opened	integer	Открывалось.
Ошибка	providers.error	string	Ошибка.
Provider	providers.provider	string	Поставщик.
Состояние	providers.status	string	Состояние.

Получение списка

Идентификатор операции:: ListGet

Получение элементов списка.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор списка	list_id	True	string	Идентификатор списка.

Возвращаемое значение

Имя	Путь	Тип	Описание
Создано	created	string	При создании.
Идентификатор	id	string	Идентификатор.
Имя	name	string	Имя.
Updated	updated	string	Обновлено.

Создание бренда

Идентификатор операции:: BrandPost

Создает новую фирменную символь из указанных параметров.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id		string	Идентификатор.
Имя	name	True	string	Имя.
Primary	primary		string	Основной объект.
Secondary	secondary		string	Вторичный.
Третичный	tertiary		string	Третичный.
Цвет панели	barColor		string	Цвет панели.
HREF	href		string	The HREF.
Изображение	image		string	Изображение.
Markdown (язык разметки)	markdown		string	Markdown.
URL	url		string	URL-адрес.
URL	url		string	URL-адрес.
URL	url		string	URL-адрес.
URL	url		string	URL-адрес.
URL	url		string	URL-адрес.
Значок отключения сообщения	disableMessageIcon		boolean	Следует ли отключить значок сообщения.
Размещение	placement		string	Размещение.
Товары	items		array of string	Элементы.

Возвращаемое значение

response: string

Создание или обновление аудитории

Идентификатор операции:: AudiencePut

Создает или обновляет аудиторию на основе параметров и фильтров, предоставленных.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор аудитории	audience_id	True	string	Идентификатор аудитории.
Имя	name		string	Имя.
Путь	path		string	Путь.
Operator	operator		string	Оператор.
Ценность	value		string	Значение.
Путь	path		string	Путь.
Operator	operator		string	Оператор.
Ценность	value		string	Значение.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор	id	string	Идентификатор.
Имя	name	string	Имя.
Description	description	string	Описание.
Operator	filter.operator	string	Оператор.
Ценность	filter.value	string	Значение.
Путь	filter.path	string	Путь.
Фильтры	filter.filters	array of object
Путь	filter.filters.path	string	Путь.
Operator	filter.filters.operator	string	Оператор.
Ценность	filter.filters.value	string	Значение.

Создание массового задания

Идентификатор операции:: BulkJobPost

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

Параметры

Имя	Ключ	Тип	Описание
Event	event	string	Событие.
Бренд	brand	string	Бренд.
Template	template	string	Шаблон.
Идентификатор бренда	brand_id	string	Идентификатор бренда.
Метод	method	string	Метод.
Каналы	channels	array of string	Каналы.
Event	event	string	Событие.
Метки	tags	array of string	Теги.
Идентификатор трассировки	trace_id	string	Идентификатор трассировки.
кампания	campaign	string	Кампания.
Content	content	string	Содержимое.
Средний	medium	string	Средний.
Исходный материал	source	string	Источник.
Срок	term	string	Термин.

Возвращаемое значение

Имя	Путь	Тип	Описание
Идентификатор задания	jobId	string	Идентификатор задания.

Создание профиля

Идентификатор операции:: ProfilePost

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор получателя	recipient_id	True	string	Идентификатор получателя.
Адрес электронной почты	email		string	Адрес электронной почты.
Номер телефона	phone_number		string	Номер телефона.
Форматированные	formatted		string	Отформатированный адрес.
Адрес улицы	street_address		string	Адрес улицы.
Местность	locality		string	Локальность.
Регион	region		string	Область.
Почтовый индекс	postal_code		string	Почтовый индекс.
Страна	country		string	Страна.
Дата рождения	birthdate		string	Дата рождения.
Проверено по электронной почте	email_verified		boolean	Проверяется ли сообщение электронной почты.
Проверенный номер телефона	phone_number_verified		boolean	Проверяется ли номер телефона.
Заданное имя	given_name		string	Заданное имя.
Второе имя	middle_name		string	По промежуточному имени.
Фамилия	family_name		string	Имя семьи.
Предпочтительное имя	preferred_name		string	Предпочтительное имя.
Gender	gender		string	Пол.
Региональные настройки	locale		string	Языковой стандарт.
Рисунок	picture		string	Рисунок.
Profile	profile		string	Профиль.
Sub	sub		string	Вложенный элемент.
Обновлено в	updated_at		string	При обновлении по адресу.
Веб-сайт	website		string	Веб-сайт.
Сведения о зоне	zoneinfo		string	Сведения о зоне.
Именованный пользователь	named_user		string	Именованный пользователь.
Типы устройств	device_types		array of string	Типы устройств.
APN	apn		string	The APN.
Целевой объект ARN	target_arn		string	Целевой ARN.
Идентификатор канала	channel_id		string	Идентификатор канала.
Идентификатор пользователя	user_id		string	Идентификатор пользователя.
Токен	token		string	Маркер.
Tokens	tokens		array of string	Маркеры.
Идентификатор FACEBOOK PS	facebookPSID		string	Идентификатор Facebook PS.
Токен Firebase	firebaseToken		string	Токен Firebase.
От	from		string	От.
Идентификатор	id		string	Идентификатор.
Идентификатор пользователя	user_id		string	Идентификатор пользователя.
ID разговора	conversation_id		string	Идентификатор беседы.
Идентификатор арендатора	tenant_id		string	Идентификатор клиента.
URL-адрес службы	service_url		string	URL-адрес службы.
Идентификатор проигрывателя OneSignal	oneSignalPlayerID		string	Идентификатор проигрывателя OneSignal.
Маркер доступа	access_token		string	Маркер доступа.
Channel	channel		string	Канал.
Адрес электронной почты	email		string	Адрес электронной почты.
Идентификатор пользователя	user_id		string	Идентификатор пользователя.
URL	url		string	URL-адрес.
URL	url		string	URL-адрес.
Метод	method		string	Методы.
Mode	mode		string	Режим.
Имя пользователя	username		string	Имя пользователя.
Пароль	password		string	Пароль.
Токен	token		string	Маркер.
Profile	profile		string	Профиль.

Возвращаемое значение

response: string

Список брендов

Идентификатор операции:: BrandsGet

Получение списка брендов.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Cursor	cursor		string	Курсор.

Возвращаемое значение

Имя	Путь	Тип	Описание
Cursor	paging.cursor	string	Курсор.
Подробнее	paging.more	boolean	Есть ли больше.
Results	results	array of object
Создано	results.created	integer	При создании.
Идентификатор	results.id	string	Идентификатор.
Имя	results.name	string	Имя.
Опубликовано	results.published	integer	При публикации.
Updated	results.updated	integer	При обновлении.
Версия	results.version	string	Версия.
Primary	results.settings.colors.primary	string	Основной объект.
Secondary	results.settings.colors.secondary	string	Вторичный.
Третичный	results.settings.colors.tertiary	string	Третичный.
Цвет панели	results.settings.email.header.barColor	string	Цвет панели.
HREF	results.settings.email.header.logo.href	string	The HREF.
Изображение	results.settings.email.header.logo.image	string	Изображение.
Markdown (язык разметки)	results.settings.email.footer.markdown	string	Markdown.
URL	results.settings.email.footer.social.facebook.url	string	URL-адрес.
URL	results.settings.email.footer.social.instagram.url	string	URL-адрес.
URL	results.settings.email.footer.social.linkedin.url	string	URL-адрес.
URL	results.settings.email.footer.social.medium.url	string	URL-адрес.
URL	results.settings.email.footer.social.twitter.url	string	URL-адрес.
Значок отключения сообщения	results.settings.inapp.disableMessageIcon	boolean	Следует ли отключить значок сообщения.
Размещение	results.settings.inapp.placement	string	Размещение.
Товары	results.snippets.items	array of string	Элементы.

Список сообщений

Идентификатор операции:: MessagesGet

Получение состояний ранее отправленных сообщений.

Параметры

Имя	Ключ	Тип	Описание
Archived	archived	boolean	Архивировано ли.
Cursor	cursor	string	Курсор.
Event	event	string	Событие.
List	list	string	Список.
Идентификатор сообщения	messageId	string	Идентификатор сообщения.
Notification	notification	string	Уведомление.
Recipient	recipient	string	Получатель.
Состояние	status	string	Состояние.
Метки	tags	string	Теги.

Возвращаемое значение

Имя	Путь	Тип	Описание
Cursor	paging.cursor	string	Курсор.
Подробнее	paging.more	boolean	Есть ли больше.
Results	results	array of object
Идентификатор	results.id	string	Идентификатор.
Состояние	results.status	string	Состояние.
Очередь	results.enqueued	integer	Заквеченный.
Sent	results.sent	integer	Отправленный.
Доставлено	results.delivered	integer	Доставлено.
Прочтено	results.opened	integer	Открывалось.
Нажал	results.clicked	integer	Щелчок.
Recipient	results.recipient	string	Получатель.
Event	results.event	string	Событие.
Notification	results.notification	string	Уведомление.
Ошибка	results.error	string	Ошибка.
Причина	results.reason	string	Причина.

Удаление аудитории

Идентификатор операции:: AudienceDelete

Удаляет указанную аудиторию получателя.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор аудитории	audience_id	True	string	Идентификатор аудитории.

Возвращаемое значение

response: string

Удаление профиля

Идентификатор операции:: ProfileDelete

Удаляет указанный профиль получателя.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор получателя	recipient_id	True	string	Идентификатор получателя.

Возвращаемое значение

Имя	Путь	Тип	Описание
Состояние	status	string	Состояние.

Удаление списка

Идентификатор операции:: ListDelete

Удаляет список по идентификатору списка.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор списка	list_id	True	string	Идентификатор списка.

Возвращаемое значение

response: string

Определения

струна

Это базовый тип данных string.

объект

Это тип object.