SMS for Applications (Vorschau)
Mit dem Retarus SMS-Connector können Organisationen Textnachrichten von Microsoft-Workflows automatisieren und zuverlässig übermitteln. Verwenden Sie sie zum Senden von SMS-Aufträgen, zum Abfragen des Auftragsstatus, zum Abrufen der Übermittlungsergebnisse pro Empfänger und zum Abrufen von API-Versionsdetails. Ein aktives Retarus-Konto und gültige API-Anmeldeinformationen sind erforderlich. Um ein Testkonto für diesen Dienst oder einen unserer anderen SMS-Dienste zu erhalten, wenden Sie sich bitte an Retarus.
Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:
| Dienstleistung | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Logik-Apps | Norm | Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche: – Azure Government-Regionen - Azure China-Regionen - US Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Name | Retarus |
| URL | https://www.retarus.com/ |
| info@retarus.com |
| Connectormetadaten | |
|---|---|
| Herausgeber | retarus GmbH |
| Webseite | https://www.retarus.com/ |
| Datenschutzrichtlinie | https://www.retarus.com/data-privacy-policy/ |
| Kategorien | Kommunikation; Marketing |
Retarus SMS
Der Retarus SMS-Connector ermöglicht Es Organisationen, das Senden von Textnachrichten zu automatisieren und ihren Zustellungsstatus nachzuverfolgen.
Es bietet sichere und zuverlässige Kommunikationsfunktionen für Geschäftsworkflows, die eine umfangreiche SMS-Übermittlung erfordern. Sie können den Connector verwenden, um Nachrichten zu senden, den Status von Aufträgen zu überprüfen, ergebnisse der Empfängerübermittlung abzurufen und auf Versionsinformationen der API zuzugreifen.
Voraussetzungen
Ein Retarus SMS-Konto mit gültigen API-Anmeldeinformationen. Ein Azure-Konto und -Abonnement mit Administratorrechten. Unterstützte Vorgänge Der Connector unterstützt die folgenden Vorgänge:
- Senden Sie einen SMS-Auftrag: Senden Sie eine oder mehrere SMS-Nachrichten an einen oder mehrere Empfänger.
- Abrufen des Auftragsstatus: Abrufen des Status und der SMS-IDs für einen zuvor übermittelten Auftrag.
- Abrufen aller Aufträge für die angegebenen Kriterien: Abrufen einer Liste von Auftrags-IDs, die nach Zeitbereich oder anderen Kriterien gefiltert werden.
- Abrufen des Status für alle Empfänger eines Auftrags: Abrufen der Übermittlungsergebnisse für jeden Empfänger in einem bestimmten SMS-Auftrag.
- Abrufen der Versionsinformationen: Abrufen der aktuellen Versionsinformationen der Retarus SMS-API.
Bereitstellungsanweisungen
So verwenden Sie diesen Connector:
- konfigurieren Sie sie in Ihrer Umgebung als benutzerdefinierter Connector.
- Geben Sie gültige Retarus-API-Anmeldeinformationen an, die Ihrem Retarus-Konto zugeordnet sind.
- Stellen Sie sicher, dass Ihr Konto für SMS-for-Applications bereitgestellt wird, damit Sie SMS-Aufträge übermitteln und Auftragsinformationen abfragen können, die von der API verfügbar gemacht werden.
Eine Verbindung wird erstellt
Der Connector unterstützt die folgenden Authentifizierungstypen:
| Vorgabe | Parameter zum Erstellen einer Verbindung. | Alle Regionen | Nicht teilbar |
Vorgabe
Anwendbar: Alle Regionen
Parameter zum Erstellen einer Verbindung.
Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.
| Name | Typ | Description | Erforderlich |
|---|---|---|---|
| username | securestring | Der Benutzername für diese API | Richtig |
| Kennwort | securestring | Das Kennwort für diese API | Richtig |
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 100 | 60 Sekunden |
Aktionen
| Abrufen aller Aufträge für die angegebenen Kriterien |
Dieser Vorgang ruft eine Liste der Auftrags-IDs für einen bestimmten Zeitraum und alle optionalen Filter ab. |
| Abrufen der Versionsinformationen |
Dieser Vorgang ruft die aktuellen Versionsinformationen für die API ab. |
| Abrufen des Auftragsstatus |
Dieser Vorgang ruft den Auftragsstatus und die Liste der SMS-IDs für den Auftrag ab. Um den status der einzelnen Nachrichten für alle Nachrichten in einem Auftrag abzurufen, verwenden Sie den SMS-Endpunkt mit dem entsprechenden jobId-Parameter. |
| Abrufen des Status für alle Empfänger eines Auftrags |
Dieser Vorgang ruft den status der einzelnen Nachrichten für alle Empfänger eines bestimmten Auftrags ab. |
| Senden eines SMS-Auftrags |
Dieser Vorgang sendet eine oder mehrere SMS-Nachrichten mit jeweils einem oder mehreren Empfängern. Die Antwort enthält die Auftrags-ID (jobId) des neuen SMS-Auftrags. |
Abrufen aller Aufträge für die angegebenen Kriterien
Dieser Vorgang ruft eine Liste der Auftrags-IDs für einen bestimmten Zeitraum und alle optionalen Filter ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Nur Auftrags-IDs zurückgeben
|
jobIdsOnly | True | boolean |
Gibt nur JobIDs zurück. Derzeit wird nur 'true' unterstützt. |
|
Vom Zeitstempel
|
fromTs | date-time |
Ab Zeitstempel (ISO-8601). Das Intervall zwischen "FromTs" und "ToTs" kann maximal 30 Tage betragen. |
|
|
Zeitstempel
|
toTs | date-time |
Zum Zeitstempel (ISO-8601). Das Intervall zwischen "FromTs" und "ToTs" kann maximal 30 Tage betragen. |
|
|
Nur offene Aufträge zurückgeben
|
open | boolean |
Gibt nur offene Aufträge zurück. |
|
|
Offset
|
offset | integer |
Parameter, der für die Paginierung verwendet wird. Rufen Sie eine Teilmenge von Datensätzen ab, die mit dem Offsetwert beginnen. |
|
|
Max. zurückgegebene Ergebnisse
|
limit | integer |
Beschränken Sie die Anzahl der zurückgegebenen Ergebnisse. Der Wert muss zwischen 0 und 1000 sein. |
Gibt zurück
- response
- array of JobReport
Abrufen der Versionsinformationen
Dieser Vorgang ruft die aktuellen Versionsinformationen für die API ab.
Gibt zurück
- Body
- VersionInfoResponse
Abrufen des Auftragsstatus
Dieser Vorgang ruft den Auftragsstatus und die Liste der SMS-IDs für den Auftrag ab. Um den status der einzelnen Nachrichten für alle Nachrichten in einem Auftrag abzurufen, verwenden Sie den SMS-Endpunkt mit dem entsprechenden jobId-Parameter.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Auftrags-ID
|
jobId | True | string |
Die Retarus-Auftrags-ID. |
Gibt zurück
- Body
- JobReport
Abrufen des Status für alle Empfänger eines Auftrags
Dieser Vorgang ruft den status der einzelnen Nachrichten für alle Empfänger eines bestimmten Auftrags ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Auftrags-ID
|
jobId | True | string |
Die Retarus-Auftrags-ID. |
Gibt zurück
- response
- array of RecipientReport
Senden eines SMS-Auftrags
Dieser Vorgang sendet eine oder mehrere SMS-Nachrichten mit jeweils einem oder mehreren Empfängern. Die Antwort enthält die Auftrags-ID (jobId) des neuen SMS-Auftrags.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
src
|
src | string |
Die Absender-ID, die dem Empfänger angezeigt wird. |
|
|
encoding
|
encoding | string | ||
|
Billcode
|
billcode | string |
Max. 70 Zeichen. |
|
|
statusRequested
|
statusRequested | boolean |
Übermittlungsbenachrichtigung angefordert. |
|
|
Blitz
|
flash | boolean | ||
|
customerRef
|
customerRef | string |
Empfohlen max. 64 Zeichen. |
|
|
gültigkeitMin
|
validityMin | integer |
Gültigkeit der SMS in Minuten. Wenn 0 der Standardwert des Anbieters verwendet wird. Andernfalls müssen die Werte zwischen 5 und 2880 Minuten betragen. |
|
|
maxParts
|
maxParts | integer |
Maximal zulässige Teile in einer mehrteiligen Nachricht. Die Werte müssen zwischen 1 und 20 sein. Längere Nachrichten werden abgeschnitten. |
|
|
invalidCharacters
|
invalidCharacters | string |
Definieren Sie, wie ungültige Zeichen in SMS behandelt werden. |
|
|
qos
|
qos | string |
Servicequalität. |
|
|
jobPeriod
|
jobPeriod | date-time |
Zeitstempel zum Planen des Beginns der Verarbeitung des SMS-Auftrags (iso-8601). |
|
|
duplicateDetection
|
duplicateDetection | boolean | ||
|
BlackoutPeriods
|
blackoutPeriods | array of string | ||
|
Text
|
text | True | string |
Foo |
|
Dst
|
dst | True | string | |
|
customerRef
|
customerRef | string |
Empfohlen max. 64 Zeichen. Mobiltelefonnummer des Empfängers, die standardmäßig verwendet wird. |
|
|
BlackoutPeriods
|
blackoutPeriods | array of string |
Gibt zurück
- Body
- JobResponse
Definitionen
JobResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
jobId
|
jobId | string |
JobReport
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
jobId
|
jobId | string | |
|
src
|
src | string |
Absender-ID. |
|
encoding
|
encoding | string | |
|
Billcode
|
billcode | string | |
|
statusRequested
|
statusRequested | boolean |
Übermittlungsbenachrichtigung angefordert. |
|
Blitz
|
flash | boolean | |
|
gültigkeitMin
|
validityMin | integer |
Gültigkeit der SMS in Minuten. |
|
customerRef
|
customerRef | string |
Empfohlen max. 64 Zeichen. |
|
qos
|
qos | string |
Servicequalität. |
|
receiptTs
|
receiptTs | date-time |
Zeitstempel, der angibt, wann der Auftrag von Retarus (iso-8601) empfangen wurde. |
|
fertig gestellte Dateien
|
finishedTs | date-time |
Zeitstempel, der angibt, wann die SMS ihren endgültigen Status erhalten hat (iso-8601). |
|
recipientIds
|
recipientIds | array of string |
RecipientReport
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
smsId
|
smsId | string | |
|
Dst
|
dst | string |
Mobiltelefonnummer des Empfängers. |
|
processStatus
|
processStatus | string |
Aktueller Prozessstatus (siehe SMS Outbound Status Codes). |
|
status
|
status | string |
Status (siehe SMS Outbound Status Codes). |
|
customerRef
|
customerRef | string |
Empfohlen max. 64 Zeichen. |
|
Grund
|
reason | string | |
|
sentTs
|
sentTs | date-time |
Zeitstempel, als die SMS gesendet wurde (iso-8601). |
|
fertig gestellte Dateien
|
finishedTs | date-time |
Zeitstempel, der angibt, wann die SMS ihren endgültigen Status erhalten hat (iso-8601). |
VersionInfoResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
buildNumber
|
buildNumber | integer | |
|
buildTimestamp
|
buildTimestamp | string | |
|
majorVersion
|
majorVersion | integer | |
|
minorVersion
|
minorVersion | integer | |
|
versionInfo
|
versionInfo | string | |
|
message
|
message | string |