SmartDialog
SmartDialog — это платформа, используемая для отправки и получения сообщений SMS и WhatsApp. Он предлагает широкий спектр служб интеллектуального обмена сообщениями.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | 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) |
| Контакт | |
|---|---|
| Имя | Интерактивная поддержка Arena |
| URL | https://www.arenainteractive.fi/contact |
| Адрес электронной почты | support@arenainteractive.fi |
| Метаданные соединителя | |
|---|---|
| Publisher | Арена Интерактивный Oy |
| Веб-сайт | https://www.arenainteractive.fi |
| Политика конфиденциальности | https://www.arenainteractive.fi/privacypolicy |
| Категории | Коммуникация; Сотрудничество |
Соединитель SmartDialog
Этот соединитель можно использовать для отправки и получения SMS-сообщений с помощью платформы SmartDialog.
Предпосылки
- Подписка и учетная запись SmartDialog. Пожалуйста, обратитесь к sales@arenainteractive.fi
- OAuth необходимо включить для вашей учетной записи, и необходимо запросить секрет клиента. Это можно сделать, отправив нам электронное письмо по адресу support@arenainteractive.fi.
Настройка
- Следуйте инструкциям в статье "Создание настраиваемого соединителя из определения OpenAPI".
- Создайте поток или PowerApp и добавьте действие SmartDialog из настраиваемого раздела. Войдите с помощью учетной записи SmartDialog.
Поддерживаемые действия
- Новое сообщение (триггер для получения сообщений)
- Отправка сообщения
- Отправка сообщения WhatsApp
- Отправка ответного сообщения для обсуждения
- Отправить ответное сообщение
- Выбор WhatsApp
- Отказ WhatsApp
- Создание шаблона WhatsApp
- Получение контакта группы
- Создание контакта группы
- Обновление контакта группы
- Удаление контакта группы
- Удаление всех контактов группы
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
|
Whats |
WhatsApp Opt In for sender and recipient. (не рекомендуется) |
| Обновление контакта группы |
Обновление контакта группы |
|
Отказ Whats |
WhatsApp Отказались от отправителя и получателя. (не рекомендуется) |
| Отправить ответное сообщение |
Отправьте получателю ответную строку. |
| Отправка ответного сообщения для обсуждения |
Отправьте ответное сообщение для обсуждения получателям. |
| Отправка сообщения |
Отправьте сообщение получателям. |
|
Отправка сообщения Whats |
Отправьте сообщение шаблона WhatsApp. |
| Получение контакта группы |
Получение контакта группы |
| Создание контакта группы |
Создание контакта группы |
|
Создание шаблона Whats |
Создайте шаблон WhatsApp. |
| Удаление всех контактов группы |
Удаление всех контактов группы |
| Удаление контакта группы |
Удаление контакта группы с помощью номера телефона. |
WhatsApp Opt In (не рекомендуется) [DEPRECATED]
WhatsApp Opt In for sender and recipient. (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Адрес отправителя
|
Sender | True | string |
Зарегистрирован номер удостоверения Whatsapp для регистрации. |
|
Адрес получателя
|
Recipient | True | string |
Номер получателя для согласия. |
Обновление контакта группы
Обновление контакта группы
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Клиент
|
Customer | True | string |
Клиент для получения групповых служб. |
|
Служба групп
|
Group Service | True | string |
Используемая служба группы. |
|
Телефон
|
Phone | True | string |
Номер телефона контакта для обновления. |
|
Active
|
active | boolean |
Флаг, указывающий, является ли контакт активным. |
|
|
Адрес электронной почты
|
string |
Адрес электронной почты контакта. |
||
|
Имя
|
firstName | string |
Имя контакта. |
|
|
Фамилия
|
lastName | string |
Фамилия контакта. |
|
|
Gender
|
gender | string |
Пол контакта. |
|
|
Год рождения
|
birthYear | integer |
Год рождения контакта. |
|
|
Адрес улицы
|
streetAddress | string |
Адрес улицы контакта. |
|
|
Почтовый индекс
|
zipCode | string |
Почтовый индекс контакта. |
|
|
Город
|
city | string |
Город контакта. |
|
|
Код страны
|
countryCode | string |
3-буквенный код страны контакта. |
|
|
Имя
|
name | string |
Имя свойства пользовательского контакта. |
|
|
Ценность
|
value | string |
Значение свойства пользовательского контакта. |
|
|
Регионы телефонного номера
|
phoneNumberRegions | array of string |
Регионы телефонного номера, используемые для синтаксического анализа номеров. По умолчанию Финляндия остается пустой. |
Возвращаемое значение
- response
- boolean
Отказ WhatsApp (не рекомендуется) [DEPRECATED]
WhatsApp Отказались от отправителя и получателя. (не рекомендуется)
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Адрес отправителя
|
Sender | True | string |
Зарегистрирован номер удостоверения Whatsapp для отказа. |
|
Адрес получателя
|
Recipient | True | string |
Номер рецепта для удаления из согласия. |
Отправить ответное сообщение
Отправьте получателю ответную строку.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор ParentMessage
|
ParentMessageId | True | string |
Идентификатор родительского сообщения для ответа. |
|
Клиент
|
Customer-Id | True | string |
Клиент, используемый для отправки. |
|
Услуга
|
Service-Id | True | string |
Служба, используемая для отправки. |
|
Отправитель сообщений
|
Sender | True | string |
Отправитель сообщения может быть буквенно-цифровым, длинным кодом или коротким кодом (применяются ограничения). |
|
Содержимое сообщения
|
Content | True | string |
Содержимое сообщения. |
|
Протокол сообщений
|
Protocol | True | string |
Протокол, используемый для отправки сообщения. |
|
Отправка даты и времени
|
SendDateTime | date-time |
Дата и время отправки сообщения. Оставьте пустым, чтобы мгновенно отправить. |
|
|
Address
|
Address | True | string |
Адрес получателя сообщения. |
|
Универсальный код ресурса (URI) вложения
|
AttachmentUri | string |
Универсальный код ресурса (URI) вложений, используемый при отправке сообщения WhatsApp, содержащего вложение. |
|
|
Данные клиента
|
CustomerData | string |
Данные выставления счетов и группирования для этого сообщения необязательные. |
|
|
Рекламное сообщение
|
AdMessage | boolean |
Необязательный флаг переопределения для маркировки сообщения как рекламного сообщения |
|
|
Url-адрес Dlr
|
DlrUrl | string |
URL-адрес обратного вызова состояния доставки через http-get. Вы можете добавить значения строки запросов в URL-адрес, они будут сохранены. |
|
|
Идентификатор запроса
|
RequestId | string |
Необязательный уникальный идентификатор запроса, который можно использовать для идентификации повторяющихся запросов. Если обнаружен повторяющийся идентификатор запроса, отправка отменяется. Нет никаких гарантий, что запросы с повторяющимися идентификаторами запросов будут заблокированы в ситуациях с высокой пропускной способностью и трафиком. Заданный идентификатор запроса будет "запоминаться" в течение 7 дней. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор сообщения
|
MessageId | string |
Только что созданный идентификатор сообщения. |
|
Число частей сообщения
|
MessagePartCount | integer |
Приблизительное количество частей сообщения для этого сообщения. |
|
Получатели
|
Recipients | array of object |
Получатели |
|
Адрес получателя
|
Recipients.Address | string |
Адрес получателя (номер телефона, адрес электронной почты или идентификатор пользователя и т. д.). |
|
Идентификатор получателя
|
Recipients.Id | string |
Идентификатор получателя, используемый для получения сведений о состоянии доставки. |
Отправка ответного сообщения для обсуждения
Отправьте ответное сообщение для обсуждения получателям.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Клиент
|
CustomerId | True | string |
Клиент, используемый для отправки. |
|
Идентификатор потока
|
ThreadId | True | string |
Идентификатор существующего потока для ответа. |
|
Содержимое сообщения
|
Content | True | string |
Содержимое сообщения. |
|
Данные клиента
|
CustomerData | string |
Данные выставления счетов и группирования для этого сообщения необязательные. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор сообщения
|
MessageId | string |
Только что созданный идентификатор сообщения. |
|
Число частей сообщения
|
MessagePartCount | integer |
Приблизительное количество частей сообщения для этого сообщения. |
|
Получатели
|
Recipients | array of object |
Получатели |
|
Адрес получателя
|
Recipients.Address | string |
Адрес получателя (номер телефона, адрес электронной почты или идентификатор пользователя и т. д.). |
|
Идентификатор получателя
|
Recipients.Id | string |
Идентификатор получателя, используемый для получения сведений о состоянии доставки. |
|
ThreadId
|
ThreadId | string |
Идентификатор потока, в который было отправлено сообщение. |
Отправка сообщения
Отправьте сообщение получателям.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Клиент
|
Customer-Id | True | string |
Клиент, используемый для отправки. |
|
Услуга
|
Service-Id | True | string |
Служба, используемая для отправки. |
|
Отправитель сообщений
|
Sender | True | string |
Отправитель сообщения может быть буквенно-цифровым, длинным кодом или коротким кодом (применяются ограничения). |
|
Содержимое сообщения
|
Content | True | string |
Содержимое сообщения. |
|
Протокол сообщений
|
Protocol | True | string |
Протокол, используемый для отправки сообщения. |
|
Отправка даты и времени
|
SendDateTime | date-time |
Дата и время отправки сообщения. Оставьте пустым, чтобы мгновенно отправить. |
|
|
Address
|
Address | True | string |
Адрес получателя сообщения. |
|
Универсальный код ресурса (URI) вложения
|
AttachmentUri | string |
Универсальный код ресурса (URI) вложений, используемый при отправке сообщения WhatsApp, содержащего вложение. |
|
|
Данные клиента
|
CustomerData | string |
Данные выставления счетов и группирования для этого сообщения необязательные. |
|
|
Рекламное сообщение
|
AdMessage | boolean |
Необязательный флаг переопределения для маркировки сообщения как рекламного сообщения |
|
|
Url-адрес Dlr
|
DlrUrl | string |
URL-адрес обратного вызова состояния доставки через http-get. Вы можете добавить значения строки запросов в URL-адрес, они будут сохранены. |
|
|
Идентификатор запроса
|
RequestId | string |
Необязательный уникальный идентификатор запроса, который можно использовать для идентификации повторяющихся запросов. Если обнаружен повторяющийся идентификатор запроса, отправка отменяется. Нет никаких гарантий, что запросы с повторяющимися идентификаторами запросов будут заблокированы в ситуациях с высокой пропускной способностью и трафиком. Заданный идентификатор запроса будет "запоминаться" в течение 7 дней. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор сообщения
|
MessageId | string |
Только что созданный идентификатор сообщения. |
|
Число частей сообщения
|
MessagePartCount | integer |
Приблизительное количество частей сообщения для этого сообщения. |
|
Получатели
|
Recipients | array of object |
Получатели |
|
Адрес получателя
|
Recipients.Address | string |
Адрес получателя (номер телефона, адрес электронной почты или идентификатор пользователя и т. д.). |
|
Идентификатор получателя
|
Recipients.Id | string |
Идентификатор получателя, используемый для получения сведений о состоянии доставки. |
Отправка сообщения WhatsApp
Отправьте сообщение шаблона WhatsApp.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Клиент
|
Customer-Id | True | string |
Клиент, используемый для отправки. |
|
Услуга
|
Service-Id | True | string |
Служба, используемая для отправки. |
|
Шаблон WhatsApp
|
TemplateName | True | string |
Шаблон, используемый для отправки. |
|
Address
|
Address | True | string |
Адрес получателя сообщения. |
|
BodyParameters
|
BodyParameters | array of string |
BodyParameters |
|
|
HeaderParameters
|
HeaderParameters | array of string |
HeaderParameters |
|
|
Тип
|
Type | string |
Тип кнопки. Только один тип на шаблон может содержать несколько одного типа. |
|
|
Текст
|
Data | string |
Текст кнопки. |
|
|
Отправка даты и времени
|
SendDateTime | string |
Дата и время отправки сообщения. Оставьте пустым, чтобы мгновенно отправить. |
|
|
Универсальный код ресурса (URI) вложения
|
AttachmentUri | string |
Uri вложения, если шаблон содержит вложение. |
|
|
Использование резервной передачи SMS
|
UseSmsFallback | boolean |
Следует использовать SMS в качестве резервной версии. |
|
|
Url-адрес Dlr
|
DlrUrl | string |
URL-адрес отчета о доставке, который получит обратный вызов после завершения процесса отправки. |
|
|
Данные клиента
|
CustomerData | string |
Данные выставления счетов и группирования для этого сообщения необязательные. |
|
|
Идентификатор запроса
|
RequestId | string |
Необязательный уникальный идентификатор запроса, который можно использовать для идентификации повторяющихся запросов. Если обнаружен повторяющийся идентификатор запроса, отправка отменяется. Нет никаких гарантий, что запросы с повторяющимися идентификаторами запросов будут заблокированы в ситуациях с высокой пропускной способностью и трафиком. Заданный идентификатор запроса будет "запоминаться" в течение 7 дней. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор сообщения
|
messageId | string |
Только что созданный идентификатор сообщения. |
|
Число частей сообщения
|
messagePartCount | integer |
Приблизительное количество частей сообщения для этого сообщения. |
|
recipients
|
recipients | array of object |
recipients |
|
Адрес получателя
|
recipients.address | string |
Адрес получателя (номер телефона, адрес электронной почты или идентификатор пользователя и т. д.). |
|
Идентификатор получателя
|
recipients.id | string |
Идентификатор получателя, используемый для получения сведений о состоянии доставки. |
Получение контакта группы
Получение контакта группы
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Клиент
|
Customer | True | string |
Клиент для получения групповых служб. |
|
Служба групп
|
Group Service | True | string |
Используемая служба группы. |
|
Телефон
|
Phone | True | string |
Номер телефона контакта. |
|
Регион
|
Region | string |
Необязательный регион Phonenumber, используемый для синтаксического анализа номера телефона. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Телефон
|
phone | string |
Номер телефона контакта. |
|
Адрес электронной почты
|
string |
Адрес электронной почты контакта. |
|
|
Имя
|
firstName | string |
Имя контакта. |
|
Фамилия
|
lastName | string |
Фамилия контакта. |
|
Gender
|
gender | string |
Пол контакта. |
|
Год рождения
|
birthYear | integer |
Год рождения контакта. |
|
Адрес улицы
|
streetAddress | string |
Адрес улицы контакта. |
|
Почтовый индекс
|
zipCode | string |
Почтовый индекс контакта. |
|
Город
|
city | string |
Город контакта. |
|
Код страны
|
countryCode | string |
Код страны контакта. |
|
Неудачные сообщения
|
failedMessages | integer |
Количество неудачных сообщений для контакта. |
|
Настраиваемые свойства
|
customContactProperties | array of object |
Коллекция настраиваемых свойств контакта, сохраненная для контакта. |
|
Имя
|
customContactProperties.name | string |
Имя свойства пользовательского контакта. |
|
Ценность
|
customContactProperties.value | string |
Значение свойства пользовательского контакта. |
Создание контакта группы
Создание контакта группы
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Клиент
|
Customer | True | string |
Клиент для получения групповых служб. |
|
Служба групп
|
Group Service | True | string |
Используемая служба группы. |
|
Active
|
active | boolean |
Флаг, указывающий, является ли контакт активным. |
|
|
Телефон
|
phone | True | string |
Номер телефона контакта. |
|
Адрес электронной почты
|
string |
Адрес электронной почты контакта. |
||
|
Имя
|
firstName | string |
Имя контакта. |
|
|
Фамилия
|
lastName | string |
Фамилия контакта. |
|
|
Gender
|
gender | string |
Пол контакта. |
|
|
Год рождения
|
birthYear | integer |
Год рождения контакта. |
|
|
Адрес улицы
|
streetAddress | string |
Адрес улицы контакта. |
|
|
Почтовый индекс
|
zipCode | string |
Почтовый индекс контакта. |
|
|
Город
|
city | string |
Город контакта. |
|
|
Код страны
|
countryCode | string |
3-буквенный код страны контакта. |
|
|
Имя
|
name | string |
Имя настраиваемого свойства. |
|
|
Ценность
|
value | string |
Значение настраиваемого свойства. |
|
|
Регионы телефонного номера
|
phoneNumberRegions | array of string |
Регионы телефонного номера, используемые для синтаксического анализа номеров. По умолчанию Финляндия остается пустой. |
Возвращаемое значение
Уникальный идентификатор созданного контакта.
- Контактный номер
- uuid
Создание шаблона WhatsApp
Создайте шаблон WhatsApp.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Клиент
|
Customer-Id | True | string |
Клиент, для создания шаблона для. |
|
IdentityNumber
|
IdentityNumber | True | string |
WhatsApp IdentityNumber, используемый для шаблона. |
|
Отображаемое имя
|
DisplayName | True | string |
Отображаемое имя шаблона. |
|
Content
|
RawContent | True | string |
Содержимое шаблона. |
|
Категория шаблона
|
Category | True | string |
Категория шаблона. |
|
Язык шаблона
|
Language | True | string |
2-символьный код для языка шаблона. |
|
Тип кнопки
|
Type | string |
Тип кнопки. |
|
|
Метка кнопки
|
Label | string |
Метка кнопки. |
|
|
Данные кнопки
|
Data | string |
Данные кнопки. URL-адрес (URL-адрес), номер телефона (звонок) или текст (QuickReply). Максимальная длина — 2000 для URL-адреса и 20 для номера телефона и текста. |
|
|
URL-адрес вложения
|
AttachmentUrl | string |
URL-адрес примера вложения. |
Удаление всех контактов группы
Удаление всех контактов группы
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Клиент
|
Customer | True | string |
Клиент для получения групповых служб. |
|
Служба групп
|
Group Service | True | string |
Используемая служба группы. |
Возвращаемое значение
- response
- boolean
Удаление контакта группы
Удаление контакта группы с помощью номера телефона.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Клиент
|
Customer | True | string |
Клиент для получения групповых служб. |
|
Служба групп
|
Group Service | True | string |
Используемая служба группы. |
|
Телефон
|
Phone | True | string |
Номер телефона контакта для удаления. |
Возвращаемое значение
- response
- boolean
Триггеры
| Новое сообщение |
Когда новое сообщение поступает в службу 2-Way. |
Новое сообщение
Когда новое сообщение поступает в службу 2-Way.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Клиент
|
Customer | True | string |
Клиент для использования. |
|
Услуга
|
Service | True | string |
Служба "2-путь", используемая. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Отправитель сообщений
|
sender | string |
Отправитель сообщения. |
|
Получатель сообщения
|
recipient | string |
Получатель сообщения. |
|
Содержимое сообщения
|
content | string |
Содержимое полученного сообщения. |
|
Метка времени сообщения
|
timestamp | date-time |
Метка времени сообщения. |
|
Протокол сообщений
|
protocol | string |
Протокол полученного сообщения. |
|
attachments
|
attachments | array of object |
attachments |
|
Имя файла вложения
|
attachments.name | string |
Имя файла вложения. |
|
Тип Mime вложения
|
attachments.mimeType | string |
Тип mime вложения. |
|
Расположение ресурса вложения
|
attachments.resourceLocation | string |
Расположение ресурса вложения. |
|
Идентификатор сообщения
|
messageId | string |
Уникальный идентификатор полученного сообщения. |
Определения
UUID (Универсальный уникальный идентификатор)
Уникальный идентификатор созданного контакта.
Уникальный идентификатор созданного контакта.
- Контактный номер
- uuid
булевый
Это базовый тип данных boolean.