Retarus SMS (предварительная версия)
Соединитель Retarus SMS позволяет организациям автоматизировать и надежно доставлять текстовые сообщения из рабочих процессов Майкрософт. Используйте его для отправки заданий SMS, состояния задания запроса, получения результатов доставки по получателям и получения сведений о версии API. Требуется активная учетная запись retarus и допустимые учетные данные API. Чтобы получить тестовую учетную запись для этой службы или любой другой службы SMS, обратитесь к Retarus.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | Class | Регионы |
|---|---|---|
| Copilot Studio | Премия | Все регионы Power Automate за исключением следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Логические приложения | Стандарт | Все регионы Logic Apps , кроме следующих: - Azure Government регионы - Azure регионы Китая - Министерство обороны США (DoD) |
| Power Apps | Премия | Все регионы Power Apps кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Power Automate | Премия | Все регионы Power Automate за исключением следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Контакт | |
|---|---|
| Имя | Ретарус |
| URL | https://www.retarus.com/ |
| Адрес электронной почты | info@retarus.com |
| Метаданные соединителя | |
|---|---|
| Publisher | retarus GmbH |
| Website | https://www.retarus.com/ |
| Политика конфиденциальности | https://www.retarus.com/data-privacy-policy/ |
| Категории | Коммуникация; Маркетинг |
Перенаправка SMS
Соединитель Retarus SMS позволяет организациям автоматизировать отправку текстовых сообщений и отслеживать их состояние доставки.
Она обеспечивает безопасные и надежные возможности обмена данными для рабочих процессов бизнеса, требующих крупномасштабной доставки SMS. Соединитель можно использовать для отправки сообщений, проверки состояния заданий, получения результатов доставки по получателям и доступа к сведениям о версии API.
Предпосылки
Учетная запись SMS retarus с допустимыми учетными данными API. Учетная запись Azure и подписка с правами администратора. Поддерживаемые операции Соединитель поддерживает следующие операции:
- Отправка задания SMS: отправка одного или нескольких SMS-сообщений одному или нескольким получателям.
- Получение состояния задания: получение идентификаторов состояния и SMS для ранее отправленного задания.
- Получение всех заданий для заданных условий: получение списка идентификаторов заданий, отфильтрованных по диапазону времени или другим критериям.
- Получение состояния для всех получателей задания: получение результатов доставки для каждого получателя в определенном задании SMS.
- Получение сведений о версии: получение сведений о текущей версии API retarus SMS.
Инструкции по развертыванию
Чтобы использовать этот соединитель, выполните указанные ниже действия.
- настройте его в вашей среде в качестве настраиваемого соединителя.
- Укажите допустимые учетные данные API Retarus, связанные с учетной записью Retarus.
- Убедитесь, что ваша учетная запись подготовлена для SMS-for-Applications, чтобы можно было отправлять задания SMS и запрашивать сведения о задании, предоставляемые API.
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| По умолчанию | Параметры для создания подключения. | Все регионы | Недоступен для совместного использования |
По умолчанию
Применимо: все регионы
Параметры для создания подключения.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| username | securestring | Имя пользователя для этого API | True |
| пароль | securestring | Пароль для этого API | True |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Отправка задания SMS |
Эта операция отправляет одно или несколько SMS-сообщений с одним или несколькими получателями. Ответ содержит идентификатор задания (jobId) нового задания SMS. |
| Получение всех заданий для заданных условий |
Эта операция извлекает список идентификаторов заданий за указанный период времени и любые необязательные фильтры. |
| Получение сведений о версии |
Эта операция извлекает сведения о текущей версии ДЛЯ API. |
| Получение состояния для всех получателей задания |
Эта операция извлекает состояние отдельного сообщения для всех получателей определенного задания. |
| Получение состояния задания |
Эта операция извлекает состояние задания и список идентификаторов SMS для задания. Чтобы получить состояние отдельного сообщения для всех сообщений в задании, используйте конечную точку SMS с соответствующим параметром jobId. |
Отправка задания SMS
Эта операция отправляет одно или несколько SMS-сообщений с одним или несколькими получателями. Ответ содержит идентификатор задания (jobId) нового задания SMS.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
src
|
src | string |
Идентификатор отправителя, отображаемый получателю. |
|
|
encoding
|
encoding | string | ||
|
код выставления счетов
|
billcode | string |
Max. 70 символов. |
|
|
statusRequested
|
statusRequested | boolean |
Запрошено уведомление о доставке. |
|
|
вспышка
|
flash | boolean | ||
|
customerRef
|
customerRef | string |
Рекомендуется использовать максимум 64 символов. |
|
|
validityMin
|
validityMin | integer |
Срок действия SMS в минутах. Если используется значение по умолчанию поставщика 0. В противном случае значения должны составлять от 5 до 2880 минут. |
|
|
maxParts
|
maxParts | integer |
Максимально допустимые части в сообщении с несколькими частями. Значения должны быть от 1 до 20. Более длинные сообщения усечены. |
|
|
InvalidCharacters
|
invalidCharacters | string |
Определите способ обработки недопустимых символов в SMS. |
|
|
QoS
|
qos | string |
Качество обслуживания. |
|
|
jobPeriod
|
jobPeriod | date-time |
Метка времени для планирования начала обработки задания SMS (iso-8601). |
|
|
дублированиеDetection
|
duplicateDetection | boolean | ||
|
blackoutPeriods
|
blackoutPeriods | array of string | ||
|
текст
|
text | True | string |
foo |
|
dst
|
dst | True | string | |
|
customerRef
|
customerRef | string |
Рекомендуется использовать максимум 64 символов. Номер мобильного телефона получателя, используемый по умолчанию. |
|
|
blackoutPeriods
|
blackoutPeriods | array of string |
Возвращаемое значение
- Тело
- JobResponse
Получение всех заданий для заданных условий
Эта операция извлекает список идентификаторов заданий за указанный период времени и любые необязательные фильтры.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Возвращать только идентификаторы заданий
|
jobIdsOnly | True | boolean |
Возвращает только идентификаторы заданий. В настоящее время поддерживается только true. |
|
Метка времени
|
fromTs | date-time |
Метка времени (ISO-8601). Интервал между типами отTs и toTs может составлять не более 30 дней. |
|
|
Метка времени
|
toTs | date-time |
Метка времени (ISO-8601). Интервал между типами отTs и toTs может составлять не более 30 дней. |
|
|
Возврат только открытых заданий
|
open | boolean |
Возвращает только открытые задания. |
|
|
Смещение
|
offset | integer |
Параметр, используемый для разбиения на страницы. Извлеките подмножество записей, начиная со значения смещения. |
|
|
Максимальное количество возвращенных результатов
|
limit | integer |
Ограничение количества возвращаемых результатов. Значение должно быть от 0 до 1000. |
Возвращаемое значение
- response
- array of JobReport
Получение сведений о версии
Эта операция извлекает сведения о текущей версии ДЛЯ API.
Возвращаемое значение
- Тело
- VersionInfoResponse
Получение состояния для всех получателей задания
Эта операция извлекает состояние отдельного сообщения для всех получателей определенного задания.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор задания
|
jobId | True | string |
Идентификатор задания Retarus. |
Возвращаемое значение
- response
- array of RecipientReport
Получение состояния задания
Эта операция извлекает состояние задания и список идентификаторов SMS для задания. Чтобы получить состояние отдельного сообщения для всех сообщений в задании, используйте конечную точку SMS с соответствующим параметром jobId.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор задания
|
jobId | True | string |
Идентификатор задания Retarus. |
Возвращаемое значение
- Тело
- JobReport
Определения
JobResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
jobId
|
jobId | string |
JobReport
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
jobId
|
jobId | string | |
|
src
|
src | string |
Идентификатор отправителя. |
|
encoding
|
encoding | string | |
|
код выставления счетов
|
billcode | string | |
|
statusRequested
|
statusRequested | boolean |
Запрошено уведомление о доставке. |
|
вспышка
|
flash | boolean | |
|
validityMin
|
validityMin | integer |
Срок действия SMS в минутах. |
|
customerRef
|
customerRef | string |
Рекомендуется использовать максимум 64 символов. |
|
QoS
|
qos | string |
Качество обслуживания. |
|
чеки
|
receiptTs | date-time |
Метка времени, указывающая, когда задание было получено Retarus (iso-8601). |
|
Завершенные элементы
|
finishedTs | date-time |
Метка времени, указывающая, когда SMS получил окончательное состояние (iso-8601). |
|
recipientIds
|
recipientIds | array of string |
RecipientReport
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
smsId
|
smsId | string | |
|
dst
|
dst | string |
Номер мобильного телефона получателя. |
|
processStatus
|
processStatus | string |
Текущее состояние процесса (см. коды состояния исходящего трафика SMS). |
|
статус
|
status | string |
Состояние (см. коды состояния исходящего трафика SMS). |
|
customerRef
|
customerRef | string |
Рекомендуется использовать максимум 64 символов. |
|
причина
|
reason | string | |
|
SentTs
|
sentTs | date-time |
Метка времени отправки SMS (iso-8601). |
|
Завершенные элементы
|
finishedTs | date-time |
Метка времени, указывающая, когда SMS получил окончательное состояние (iso-8601). |
VersionInfoResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
buildNumber
|
buildNumber | integer | |
|
buildTimestamp
|
buildTimestamp | string | |
|
majorVersion
|
majorVersion | integer | |
|
minorVersion
|
minorVersion | integer | |
|
versionInfo
|
versionInfo | string | |
|
сообщение
|
message | string |