SMS pour applications (préversion)
Le connecteur Retarus SMS permet aux organisations d’automatiser et de distribuer de manière fiable des messages texte à partir de flux de travail Microsoft. Utilisez-le pour envoyer des travaux SMS, interroger l’état du travail, récupérer les résultats de remise par destinataire et obtenir les détails de la version de l’API. Un compte Retarus actif et des informations d’identification d’API valides sont nécessaires. Pour obtenir un compte de test pour ce service ou l’un de nos autres services SMS, contactez Retarus.
Ce connecteur est disponible dans les produits et régions suivants :
| Service | classe | Régions |
|---|---|---|
| Copilot Studio | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Applications logiques | Norme | Toutes les régions Logic Apps , à l’exception des suivantes : - Régions Azure Government - Régions Azure Chine - Us Department of Defense (DoD) |
| Power Apps | Premium | Toutes les régions Power Apps , à l’exception des suivantes : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Contact | |
|---|---|
| Nom | Retarus |
| URL | https://www.retarus.com/ |
| Messagerie électronique | info@retarus.com |
| Métadonnées du connecteur | |
|---|---|
| Éditeur | retarus GmbH |
| Website | https://www.retarus.com/ |
| Politique de confidentialité | https://www.retarus.com/data-privacy-policy/ |
| Catégories | Communication; Marketing |
Retarus SMS
Le connecteur Retarus SMS permet aux organisations d’automatiser l’envoi de sms et de suivre leur état de remise.
Il fournit des fonctionnalités de communication sécurisées et fiables pour les flux de travail métier qui nécessitent une livraison SMS à grande échelle. Vous pouvez utiliser le connecteur pour envoyer des messages, vérifier l’état des travaux, récupérer les résultats de remise par destinataire et accéder aux informations de version de l’API.
Prerequisites
Un compte SMS Retarus avec des informations d’identification d’API valides. Un compte Azure et un abonnement disposant de privilèges d’administration. Opérations prises en charge Le connecteur prend en charge les opérations suivantes :
- Envoyer un travail SMS : envoyez un ou plusieurs sms à un ou plusieurs destinataires.
- Obtenez l’état du travail : récupérez l’état et les ID SMS d’un travail précédemment envoyé.
- Obtenez tous les travaux pour les critères donnés : récupérez une liste d’ID de travail filtrés par intervalle de temps ou d’autres critères.
- Obtenez l’état de tous les destinataires d’un travail : récupérez les résultats de remise pour chaque destinataire dans un travail SMS spécifique.
- Obtenez les informations de version : récupérez les informations de version actuelles de l’API SMS Retarus.
Instructions de déploiement
Pour utiliser ce connecteur :
- configurez-le dans votre environnement en tant que connecteur personnalisé.
- Fournissez les informations d’identification de l’API Retarus valides associées à votre compte Retarus.
- Vérifiez que votre compte est approvisionné pour SMS-for-Applications afin de pouvoir envoyer des travaux SMS et interroger les informations de travail exposées par l’API.
Création d’une connexion
Le connecteur prend en charge les types d’authentification suivants :
| Par défaut | Paramètres de création de connexion. | Toutes les régions | Non partageable |
Faire défaut
Applicable : Toutes les régions
Paramètres de création de connexion.
Cette connexion n’est pas partageable. Si l’application power est partagée avec un autre utilisateur, un autre utilisateur est invité à créer une connexion explicitement.
| Nom | Type | Descriptif | Obligatoire |
|---|---|---|---|
| nom d'utilisateur | securestring | Nom d’utilisateur de cette API | Vrai |
| mot de passe | securestring | Mot de passe de cette API | Vrai |
Limitations
| Nom | Appels | Période de renouvellement |
|---|---|---|
| Appels d’API par connexion | 100 | 60 secondes |
Actions
| Envoyer un travail SMS |
Cette opération envoie un ou plusieurs sms avec un ou plusieurs destinataires chacun. La réponse contient l’ID de travail (jobId) du nouveau travail SMS. |
| Obtenir les informations de version |
Cette opération récupère les informations de version actuelles de l’API. |
| Obtenir l’état de tous les destinataires d’un travail |
Cette opération récupère l’état du message individuel pour tous les destinataires d’un travail spécifique. |
| Obtenir l’état du travail |
Cette opération récupère l’état du travail et la liste des ID SMS pour le travail. Pour obtenir l’état du message individuel pour tous les messages d’un travail, utilisez le point de terminaison SMS avec le paramètre jobId correspondant. |
| Obtenir tous les travaux pour les critères donnés |
Cette opération récupère une liste d’ID de travail pour une période spécifiée et tous les filtres facultatifs. |
Envoyer un travail SMS
Cette opération envoie un ou plusieurs sms avec un ou plusieurs destinataires chacun. La réponse contient l’ID de travail (jobId) du nouveau travail SMS.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
src
|
src | string |
ID de l’expéditeur affiché au destinataire. |
|
|
encoding
|
encoding | string | ||
|
billcode
|
billcode | string |
Max. 70 caractères. |
|
|
statusRequested
|
statusRequested | boolean |
Notification de remise demandée. |
|
|
flash
|
flash | boolean | ||
|
customerRef
|
customerRef | string |
Nombre maximal recommandé de 64 caractères. |
|
|
validityMin
|
validityMin | integer |
Validité du SMS en minutes. Lorsque 0 la valeur par défaut du fournisseur est utilisée. Sinon, les valeurs doivent être comprises entre 5 et 2880 minutes. |
|
|
maxParts
|
maxParts | integer |
Nombre maximal de parties autorisées dans un message à plusieurs parties. Les valeurs doivent être comprises entre 1 et 20. Les messages plus longs sont tronqués. |
|
|
invalidCharacters
|
invalidCharacters | string |
Définissez comment gérer des caractères non valides dans SMS. |
|
|
QoS
|
qos | string |
Qualité de service. |
|
|
jobPeriod
|
jobPeriod | date-time |
Horodatage à planifier quand commencer à traiter le travail SMS (iso-8601). |
|
|
duplicateDetection
|
duplicateDetection | boolean | ||
|
blackoutPeriods
|
blackoutPeriods | array of string | ||
|
texte
|
text | True | string |
Foo |
|
Dst
|
dst | True | string | |
|
customerRef
|
customerRef | string |
Nombre maximal recommandé de 64 caractères. Numéro de téléphone mobile du destinataire utilisé par défaut. |
|
|
blackoutPeriods
|
blackoutPeriods | array of string |
Retours
- Corps
- JobResponse
Obtenir les informations de version
Cette opération récupère les informations de version actuelles de l’API.
Retours
- Corps
- VersionInfoResponse
Obtenir l’état de tous les destinataires d’un travail
Cette opération récupère l’état du message individuel pour tous les destinataires d’un travail spécifique.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID du travail
|
jobId | True | string |
ID du travail Retarus. |
Retours
- response
- array of RecipientReport
Obtenir l’état du travail
Cette opération récupère l’état du travail et la liste des ID SMS pour le travail. Pour obtenir l’état du message individuel pour tous les messages d’un travail, utilisez le point de terminaison SMS avec le paramètre jobId correspondant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID du travail
|
jobId | True | string |
ID du travail Retarus. |
Retours
- Corps
- JobReport
Obtenir tous les travaux pour les critères donnés
Cette opération récupère une liste d’ID de travail pour une période spécifiée et tous les filtres facultatifs.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Retourner uniquement les ID de travail
|
jobIdsOnly | True | boolean |
Retourne uniquement les ID de travail. Actuellement, seule la valeur « true » est prise en charge. |
|
À partir de l’horodatage
|
fromTs | date-time |
À partir de l’horodatage (ISO-8601). L’intervalle entre fromTs et toTs peut être d’un maximum de 30 jours. |
|
|
Pour timestamp
|
toTs | date-time |
Pour timestamp (ISO-8601). L’intervalle entre fromTs et toTs peut être d’un maximum de 30 jours. |
|
|
Renvoyer uniquement les travaux ouverts
|
open | boolean |
Retournez uniquement les travaux ouverts. |
|
|
Décalage
|
offset | integer |
Paramètre utilisé pour la pagination. Récupérez un sous-ensemble d’enregistrements commençant par la valeur de décalage. |
|
|
Nombre maximal de résultats retournés
|
limit | integer |
Limitez le nombre de résultats retournés. La valeur doit être comprise entre 0 et 1 000. |
Retours
- response
- array of JobReport
Définitions
JobResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
jobId
|
jobId | string |
JobReport
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
jobId
|
jobId | string | |
|
src
|
src | string |
ID de l’expéditeur. |
|
encoding
|
encoding | string | |
|
billcode
|
billcode | string | |
|
statusRequested
|
statusRequested | boolean |
Notification de remise demandée. |
|
flash
|
flash | boolean | |
|
validityMin
|
validityMin | integer |
Validité du SMS en minutes. |
|
customerRef
|
customerRef | string |
Nombre maximal recommandé de 64 caractères. |
|
QoS
|
qos | string |
Qualité de service. |
|
receiptTs
|
receiptTs | date-time |
Horodatage indiquant quand le travail a été reçu par Retarus (iso-8601). |
|
finishedTs
|
finishedTs | date-time |
Horodatage indiquant quand le SMS a reçu son état final (iso-8601). |
|
recipientIds
|
recipientIds | array of string |
RecipientReport
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
smsId
|
smsId | string | |
|
Dst
|
dst | string |
Numéro de téléphone mobile du destinataire. |
|
processStatus
|
processStatus | string |
État actuel du processus (voir Codes d’état sortant SMS). |
|
status
|
status | string |
État (voir Codes d’état sortant SMS). |
|
customerRef
|
customerRef | string |
Nombre maximal recommandé de 64 caractères. |
|
reason (Raison)
|
reason | string | |
|
sentTs
|
sentTs | date-time |
Horodatage lorsque le SMS a été envoyé (iso-8601). |
|
finishedTs
|
finishedTs | date-time |
Horodatage qui indique quand le SMS a reçu son état final (iso-8601). |
VersionInfoResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
buildNumber
|
buildNumber | integer | |
|
buildTimestamp
|
buildTimestamp | string | |
|
majorVersion
|
majorVersion | integer | |
|
minorVersion
|
minorVersion | integer | |
|
versionInfo
|
versionInfo | string | |
|
Message
|
message | string |