TrueDialog SMS

Соединитель SMS TrueDialog позволяет отправлять массовые и отдельные текстовые сообщения с помощью длинного кода и короткого кода.

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

Услуга 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)
Контакт
Имя Поддержка TrueDialog
URL https://www.truedialog.com/help/
Адрес электронной почты support@truedialog.com
Метаданные соединителя
Publisher TrueDialog Dynamics
Веб-сайт https://www.truedialog.com/
Политика конфиденциальности https://www.truedialog.com/privacy-policy/
Категории Communication

API SMS TrueDialog — это корпоративный класс с более предварительно созданными функциями, чем любое другое программное обеспечение SMS. Созданный для разработчиков API SMS является высоконадежным, безопасным и включает в себя предварительно созданную базу данных ISO 9001 для дополнительной защиты от отказа и соответствия требованиям. Кроме того, вы можете использовать полнофункциональное Enterprise-Grade SMS Texting Software.

Предпосылки

Эти учетные данные потребуются для продолжения:

  • План Microsoft Power Apps или Power Automate
  • Учетная запись TrueDialog и план и ключ API TrueDialog и секретный код для вашей учетной записи. Щелкните HERE , чтобы зарегистрировать.

Получение учетных данных

Щелкните HERE , чтобы зарегистрировать. При регистрации в TrueDialog ключ API и секретный код будут находиться в электронной почте учетных данных. Чтобы приступить к работе, обратитесь к нашей команде. Наша команда по клиентским службам мирового класса поможет вам пройти регистрацию и выбрать лучшую учетную запись для потребностей вашей компании.

СВЯЖИТЕСЬ С НАМИ:

электронная почта support@truedialog.com
Чат https://www.truedialog.com/
Телефон 512-501-5940

Начало работы с соединителем TrueDialog

После получения учетных данных можно начать использовать соединитель.

Действия

Отправка SMS

Наиболее ценным действием является "Отправить SMS". Он позволяет отправлять SMS в один или несколько получателей. Это действие содержит несколько обязательных полей:

  • Идентификатор учетной записи — можно использовать в ответе Get Current User Info или быть жестко закодирован.
  • Канал — оставьте значение по умолчанию 22 для использования связанного номера телефона по умолчанию.
  • Целевые объекты — допустимый номер телефона США без форматирования (например, +15125453809)
  • Сообщение — само сообщение.
  • Выполнение — оставьте значение по умолчанию true, если вы не хотите отложить отправку.

Triggers

Список обратных вызовов, зарегистрированных для учетной записи, можно найти здесь: https://ui.truedialog.com/Callbacks

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

Самый важный триггер. Эта операция активирует поток всякий раз, когда тексты конечных пользователей попадают в связанный номер телефона.

Идентификатор учетной записи необходим для регистрации триггера. Идентификатор учетной записи можно получить на портале TD, расположенный рядом с именем учетной записи в правом верхнем углу.

Входящее сообщение содержит текст сообщения и другие необходимые поля.

Стоп-сообщение получено

Эта операция активирует поток всякий раз, когда конечные пользователи тексты в STOP или синониме. Он также автоматически откажется от контакта в системе TrueDialog. Чтобы отправить сообщение контакту с отказом, задайте для флага значение True при отправке SMS. Используйте эту функцию ForceOptIt с осторожностью и убедитесь, что вы следите за записями отказа.

Предоставьте пользователям пошаговый процесс для начала работы с соединителем. Здесь следует выделить распространенные варианты использования, такие как ожидаемые популярные триггеры и действия, и как они могут помочь в сценариях автоматизации. Включите изображения, где это возможно.

Уведомление о доставке получено

Эта операция активирует поток для каждой квитанции уведомления о доставке. Обратите внимание, что не все мобильные операторы отправляют уведомление.

Недопустимые целевые объекты

Если один из целевых телефонов недопустим или в черный список, по-прежнему можно отправить SMS и не получить ошибку. Для этого необходимо задать для свойства IgnoreInvalidTargets значение true при отправке сообщения. Если недопустимые номера телефонов были представлены в списке отправленных получателей SMS, эта операция активирует потоки.

Известные проблемы и ограничения

API TrueDialog имеет больше возможностей по сравнению с пользовательским соединителем

Часто задаваемые вопросы

Чтобы получить последнее описание недрый API, посетите здесь

Укажите разбивку часто задаваемых вопросов и их соответствующие ответы здесь. Это может охватывать часто задаваемые вопросы о взаимодействии с базовой службой или о самом соединителе.

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

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

По умолчанию

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

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

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

Имя Тип Description Обязательно
username securestring Имя пользователя для этого API True
пароль securestring Пароль для этого API True

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

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

Действия

Обновление контактов

Обновление контакта
Отправка SMS

Отправка SMS одному или нескольким получателям
Поиск контактов

Ищет контакт по номеру телефона или адресу электронной почты.
Получение сведений о текущем пользователе

Получение сведений о пользователе, учетные данные которых использовались в connection
Получение сведений об учетной записи

Получение сведений об учетной записи
Создание контакта

Создание записи контакта в TrueDialog

Обновление контактов

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

Обновление контакта

Параметры

Имя Ключ Обязательно Тип Описание
ID счета
 accountId True string

Идентификатор учетной записи, которая будет использоваться в качестве родительской учетной записи для обновленного контакта
Код контактного лица
 contactid True string

Идентификатор контакта, который будет обновлен
Номер телефона
 PhoneNumber string

Номер мобильного телефона, если он доступен. Это или поле "Электронная почта" является обязательным
Адрес электронной почты
 Email string

Адрес электронной почты контакта. Это или поле PhoneNumber является ОБЯЗАТЕЛЬНЫМ.
Имя
 FirstName string

Имя контакта.
Фамилия
 LastName string

Фамилия контакта.

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

Тело
ContactResponse

Отправка SMS

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

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

Параметры

Имя Ключ Обязательно Тип Описание
ID счета
 accountId True string

Идентификатор учетной записи, который будет использоваться для отправки SMS
Каналы
 Channels True array of string

Каналы
Targets
 Targets True array of string

Targets
ContactListIds
 ContactListIds array of string

Идентификаторы списка контактов
ExcludeListIds
 ExcludeListIds array of string

Исключение идентификаторов списка
Идентификатор носителя
 MediaId integer

Идентификатор носителя
Message
 Message True string

Message
Игнорировать однократное использование
 IgnoreSingleUse boolean

Игнорировать однократное использование
ForceOptIn
 ForceOptIn boolean

Принудительное Opt-In
Schedules
 Schedules array of string

Список расписаний, связанных с действием
Execute
 Execute True boolean

Задайте значение true, если действие должно выполняться при создании
IgnoreInvalidTargets
 IgnoreInvalidTargets boolean

Указывает, следует ли игнорировать недопустимые числа

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

Тело
PushCampaignResponse

Поиск контактов

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

Ищет контакт по номеру телефона или адресу электронной почты.

Параметры

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

Учетная запись, в которую отображается контакт.
Номер телефона для поиска
 phone True string

Найдите существующие контакты с переданным номером телефона или электронной почтой.

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

Товары
ContactSearchRequest

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

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

Получение сведений о пользователе, учетные данные которых использовались в connection

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

Тело
UserResponse

Получение сведений об учетной записи

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

Получение сведений об учетной записи

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор учетной записи, которая должна быть получена
 accountId True string

Идентификатор учетной записи

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

Тело
AccountResponse

Создание контакта

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

Создание записи контакта в TrueDialog

Параметры

Имя Ключ Обязательно Тип Описание
ID счета
 accountId True string

Идентификатор учетной записи, которая будет использоваться в качестве родительской учетной записи для созданного контакта
Номер телефона
 PhoneNumber string

Номер мобильного телефона, если он доступен. Это или поле "Электронная почта" является обязательным
Адрес электронной почты
 Email string

Адрес электронной почты контакта. Это или поле PhoneNumber является ОБЯЗАТЕЛЬНЫМ.
Имя
 FirstName string

Имя контакта.
Фамилия
 LastName string

Фамилия контакта.

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

Тело
ContactResponse

Триггеры

Недопустимые целевые объекты

Эта операция активирует поток, если целевые объекты были отфильтрованы во время отправки SMS
Полученное входящее сообщение

Эта операция активирует поток всякий раз, когда тексты конечных пользователей в
Полученное ключевое слово

Эта операция активирует поток всякий раз, когда тексты конечных пользователей в ключевом слове
Стоп-сообщение получено

Эта операция активирует поток всякий раз, когда конечные пользователи тексты в STOP или синониме
Уведомление о доставке получено

Эта операция активирует поток для каждого уведомления о доставке

Недопустимые целевые объекты

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

Эта операция активирует поток, если целевые объекты были отфильтрованы во время отправки SMS

Параметры

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

Используйте идентификатор корневой учетной записи в большинстве случаев для подписки на уведомления.

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

Имя Путь Тип Описание
Метка времени обратного вызова
 CallbackTimestamp string

Дата и время отправки обратного вызова. Формат: гггг-ММ-ддTHH:mm:ss
CallbackURL
 CallbackURL string

URL-адрес обратного вызова
TransactionId
 TransactionId string

ИД транзакции
accountId
 AccountId integer

Идентификатор учетной записи
ActionId
 ActionId integer

Идентификатор действия
RunId
 RunId integer

Идентификатор запуска
InvalidTargets
 InvalidTargets array of object

Недопустимые целевые объекты
Цель
 InvalidTargets.Target string

Отфильтрованный целевой объект
ReasonId
 InvalidTargets.ReasonId integer

Идентификатор причины. 0 — недопустимо, 1 — отказ, 2 — дубликаты, 3 — заблокировано, 4 — неизменяемо, 5 — однопользовательское использование
Причина
 InvalidTargets.Reason string

Краткое описание причины

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

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

Эта операция активирует поток всякий раз, когда тексты конечных пользователей в

Параметры

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

Используйте идентификатор корневой учетной записи в большинстве случаев для подписки на уведомления.

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

Имя Путь Тип Описание
Имя учетной записи
 AccountName string

Имя учетной записи обратного вызова связано с
Код канала
 ChannelCode string

Код канала сообщение отправлено (фактический номер телефона для длинных кодов)
ChannelId
 ChannelId integer

Идентификатор канала, по который было отправлено сообщение
ContactId
 ContactId integer

Идентификатор контакта, если он есть (null для неизвестных контактов)
Message
 Message string

Фактический текст сообщения
Номер телефона
 PhoneNumber string

Целевой номер телефона
accountId
 AccountId integer

Идентификатор учетной записи обратного вызова связан с
Метка времени обратного вызова
 CallbackTimestamp string

Дата и время отправки обратного вызова. Формат: гггг-ММ-ддTHH:mm:ss
CallbackToken
 CallbackToken string

Маркер обратного вызова
TransactionId
 TransactionId string

Уникальный маркер

Полученное ключевое слово

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

Эта операция активирует поток всякий раз, когда тексты конечных пользователей в ключевом слове

Параметры

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

Используйте идентификатор корневой учетной записи в большинстве случаев для подписки на уведомления.

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

Имя Путь Тип Описание
Метка времени обратного вызова
 CallbackTimestamp string

Дата и время отправки обратного вызова: гггг-ММ-ддTHH:mm:ss
CallbackToken
 CallbackToken string

Маркер обратного вызова
TransactionId
 TransactionId string

ИД транзакции
accountId
 AccountId integer

Идентификатор учетной записи обратного вызова связан с
Имя учетной записи
 AccountName string

Имя учетной записи обратного вызова связано с
CampaignId (Идентификатор кампании)
 CampaignId integer

Идентификатор кампании
ChannelId
 ChannelId integer

ИД канала
Код канала
 ChannelCode string

Код канала сообщение отправлено (фактический номер телефона для длинных кодов)
ContactId
 ContactId integer

Идентификатор контакта, отправившего ключевое слово
Keyword
 Keyword string

Фактическое ключевое слово, отправленное
KeywordId
 KeywordId integer

Идентификатор отправленного ключевого слова
Message
 Message string

Фактический текст сообщения
Номер телефона
 PhoneNumber string

Номер телефона конечного пользователя, отправившего ключевое слово

Стоп-сообщение получено

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

Эта операция активирует поток всякий раз, когда конечные пользователи тексты в STOP или синониме

Параметры

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

Используйте идентификатор корневой учетной записи в большинстве случаев для подписки на уведомления.

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

Имя Путь Тип Описание
Метка времени обратного вызова
 CallbackTimestamp string

Дата и время отправки обратного вызова. Формат: гггг-ММ-ддTHH:mm:ss
CallbackToken
 CallbackToken string

Маркер обратного вызова
TransactionId
 TransactionId string

ИД транзакции
accountId
 AccountId integer

Идентификатор учетной записи
Имя учетной записи
 AccountName string

Имя учетной записи обратного вызова связано с
ChannelId
 ChannelId integer

ИД канала
Код канала
 ChannelCode string

Код канала сообщение отправлено (фактический номер телефона для длинных кодов)
ContactId
 ContactId integer

Контактный номер
ContactAccountId
 ContactAccountId integer

Идентификатор учетной записи, владеющей записью контакта
ContactAccountName
 ContactAccountName string

Имя учетной записи, владеющей записью контакта
Номер телефона
 PhoneNumber string

Номер телефона конечного пользователя, который был отказано

Уведомление о доставке получено

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

Эта операция активирует поток для каждого уведомления о доставке

Параметры

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

Используйте идентификатор корневой учетной записи в большинстве случаев для подписки на уведомления.

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

Имя Путь Тип Описание
Метка времени обратного вызова
 CallbackTimestamp string

Дата и время отправки обратного вызова. Формат: гггг-ММ-ддTHH:mm:ss
CallbackToken
 CallbackToken string

Маркер обратного вызова
TransactionId
 TransactionId string

ИД транзакции
accountId
 AccountId integer

Идентификатор учетной записи
Имя учетной записи
 AccountName string

Имя учетной записи обратного вызова связано с
Идентификатор состояния
 StatusId integer

2 = доставлено; 3 = undelivered; 7 = неизвестно
Состояние
 Status string

Код доставки — ОК для доставленного сообщения или кода ошибки. Для undelivered — null
ChannelId
 ChannelId integer

ИД канала
Код канала
 ChannelCode string

Код канала сообщение отправлено (фактический номер телефона для длинных кодов)
MessageId
 MessageId string

MessageId
Номер телефона
 PhoneNumber string

Номер телефона
ContactId
 ContactId integer

Контактный номер
ActionId
 ActionId integer

Идентификатор действия
Message
 Message string

Фактический текст сообщения

Определения

AccountResponse

Имя Путь Тип Описание
id
 id integer

Идентификатор учетной записи.
статус
 status integer

Текущее состояние учетной записи.
parentId
 parentId integer

Идентификатор учетной записи, которая является родительской учетной записью этой учетной записи.
имя
 name string

Имя учетной записи
создано
 created string

После создания учетной записи.
allowCallback
 allowCallback boolean

Если эта учетная запись разрешена использовать механизм обратного вызова.
callbackToken
 callbackToken string

Маркер обратного вызова
type
 type integer

Тип учетной записи (master или subaccount)
тип аккаунта
 accountType integer

Имя типа учетной записи
isApproved
 isApproved boolean

Учетная запись утверждена или нет

ContactResponse

Имя Путь Тип Описание
accountId
 accountId integer

Идентификатор учетной записи
номер телефона
 phoneNumber string

Номер телефона
электронная почта
 email string

электронная почта
preferredLanguageId
 preferredLanguageId string

Предпочтительный идентификатор языка
предпочтительный язык
 preferredLanguage string

Предпочтительный язык
assignedId
 assignedId string

назначенный идентификатор
Имя
 firstName string

Имя (Первое имя)
lastName
 lastName string

Фамилия
phoneStatusId
 phoneStatusId integer

Идентификатор состояния телефона
phoneStatus
 phoneStatus integer

Состояние телефона
phoneHardErrorCount
 phoneHardErrorCount integer

Число жестких ошибок телефона
phoneSoftErrorCount
 phoneSoftErrorCount integer

Число мягких ошибок телефона
phoneTotalHardErrorCount
 phoneTotalHardErrorCount integer

Общее число жестких ошибок телефона
phoneTotalSoftErrorCount
 phoneTotalSoftErrorCount integer

Общее число мягких ошибок телефона
phoneLastHardError
 phoneLastHardError string

Последняя ошибка телефона
phoneLastSoftError
 phoneLastSoftError string

Последняя обратимая ошибка телефона
phoneHardErrorSince
 phoneHardErrorSince string

Ошибка телефона с жесткой ошибкой
phoneSoftErrorSince
 phoneSoftErrorSince string

Ошибка обратимого телефона с момента
statusId
 statusId integer

Идентификатор состояния
создано
 created string

создано
изменено
 modified string

изменено
создано кем
 createdBy string

создано by
modifiedBy
 modifiedBy string

изменено
id
 id integer

id

ContactSearchRequest

Имя Путь Тип Описание
id
 id integer

id
accountId
 accountId integer

Идентификатор учетной записи
statusId
 statusId integer

Идентификатор состояния
номер телефона
 phoneNumber string

Номер телефона
электронная почта
 email string

электронная почта
assignedId
 assignedId string

назначенный идентификатор
Имя
 firstName string

Имя (Первое имя)
lastName
 lastName string

Фамилия
subscriptions
 subscriptions array of

subscriptions
attributes
 attributes array of

attributes
phoneStatusId
 phoneStatusId integer

Идентификатор состояния телефона
создано
 created string

создано
создано кем
 createdBy string

создано by
изменено
 modified string

изменено
modifiedBy
 modifiedBy string

изменено

PushCampaignResponse

Имя Путь Тип Описание
channels
 channels array of

channels
targets
 targets array of string

targets
targetsUrl
 targetsUrl string

Url-адрес целевого объекта
targetsColumn
 targetsColumn string

Целевой столбец
contactListIds
 contactListIds array of

Идентификаторы списка контактов
excludeListIds
 excludeListIds array of

исключить идентификаторы списка
campaignId
 campaignId integer

Идентификатор кампании
mediaId
 mediaId string

Идентификатор носителя
сообщение
 message string

сообщение
от / из / с (context-dependent)
 from string

от / из / с (context-dependent)
субъект
 subject string

субъект
ignoreSingleUse
 ignoreSingleUse boolean

игнорировать одноразовое использование
forceOptIn
 forceOptIn boolean

принудительное Opt-In
statusId
 statusId integer

Идентификатор состояния
roundRobinById
 roundRobinById boolean

округление робин по идентификатору
globalRoundRobin
 globalRoundRobin boolean

глобальный раунд Робин
статус
 status string

статус
id
 id integer

id
accountId
 accountId integer

Идентификатор учетной записи
создано
 created string

создано
изменено
 modified string

изменено
создано кем
 createdBy string

создано by
modifiedBy
 modifiedBy string

изменено
schedules
 schedules array of

schedules

UserResponse

Имя Путь Тип Описание
userName
 userName string

userName
accountId
 accountId integer

Идентификатор учетной записи
электронная почта
 email string

электронная почта
Имя
 firstName string

Имя (Первое имя)
lastName
 lastName string

Фамилия
номер телефона
 phoneNumber string

Номер телефона
isAdmin
 isAdmin boolean

— администратор
key
 apiKey.key string

key
secret
 apiKey.secret string

secret
lastActivity
 apiKey.lastActivity string

последнее действие
TypeId
 apiKey.typeId integer

Идентификатор типа
type
 apiKey.type integer

type
label
 apiKey.label string

label
userName
 apiKey.userName string

userName
validTo
 apiKey.validTo string

Допустимое значение
accountId
 apiKey.accountId integer

Идентификатор учетной записи
id
 apiKey.id integer

id
isChatUser
 isChatUser boolean

— "Пользователь чата"
reportOnly
 reportOnly boolean

Только отчет
requestNumber
 requestNumber boolean

Номер запроса
canCreateContact
 canCreateContact boolean

может создать контакт
isAlertAgent
 isAlertAgent boolean

— агент генерации оповещений
согласованный
 agreed boolean

согласованный
Комментарий
 comment string

Комментарий
isApproved
 isApproved boolean

Утверждено
isLockedOut
 isLockedOut boolean

Заблокировано
lastLockoutDate
 lastLockoutDate string

последняя дата блокировки
дата создания
 creationDate string

Дата создания
lastLoginDate
 lastLoginDate string

дата последнего входа
LastActivityDate
 lastActivityDate string

дата последнего действия
lastPasswordChangedDate
 lastPasswordChangedDate string

дата последнего изменения пароля