SMS for Applications (anteprima)
Il connettore SMS Retarus consente alle organizzazioni di automatizzare e recapitare in modo affidabile messaggi di testo dai flussi di lavoro Microsoft. Usarlo per inviare processi SMS, eseguire query sullo stato del processo, recuperare i risultati del recapito per destinatario e ottenere i dettagli della versione dell'API. Sono necessari un account Retarus attivo e credenziali API valide. Per ottenere un account di test per questo servizio o per qualsiasi altro servizio SMS, contattare Retarus.
Questo connettore è disponibile nei prodotti e nelle aree seguenti:
| Servizio | Class | Regions |
|---|---|---|
| Copilot Studio | Di alta qualità | Tutte le aree di Power Automate , ad eccezione delle seguenti: - Governo degli Stati Uniti (GCC) - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD) |
| App per la logica | Normale | Tutte le aree di App per la logica , ad eccezione delle seguenti: - Aree di Azure per enti pubblici - Aree di Azure Cina - Dipartimento della Difesa degli Stati Uniti (DoD) |
| Power Apps | Di alta qualità | Tutte le aree di Power Apps , ad eccezione dei seguenti: - Governo degli Stati Uniti (GCC) - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD) |
| Power Automate | Di alta qualità | Tutte le aree di Power Automate , ad eccezione delle seguenti: - Governo degli Stati Uniti (GCC) - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD) |
| Contatto | |
|---|---|
| Nome | Retarus |
| URL | https://www.retarus.com/ |
| info@retarus.com |
| Metadati del connettore | |
|---|---|
| Editore | retarus GmbH |
| Sito web | https://www.retarus.com/ |
| Informativa sulla privacy | https://www.retarus.com/data-privacy-policy/ |
| Categorie | Comunicazione; Marketing |
Retarus SMS
Il connettore SMS Retarus consente alle organizzazioni di automatizzare l'invio di sms e tenere traccia dello stato di recapito.
Offre funzionalità di comunicazione sicure e affidabili per i flussi di lavoro aziendali che richiedono la distribuzione di SMS su larga scala. È possibile usare il connettore per inviare messaggi, controllare lo stato dei processi, recuperare i risultati del recapito per destinatario e accedere alle informazioni sulla versione dell'API.
Prerequisiti
Un account SMS Retarus con credenziali API valide. Un account e una sottoscrizione di Azure con privilegi amministrativi. Operazioni supportate Il connettore supporta le operazioni seguenti:
- Inviare un processo SMS: inviare uno o più messaggi SMS a uno o più destinatari.
- Ottenere lo stato del processo: recuperare lo stato e gli ID SMS per un processo inviato in precedenza.
- Ottenere tutti i processi per i criteri specificati: recuperare un elenco di ID processo filtrati in base all'intervallo di tempo o ad altri criteri.
- Ottenere lo stato per tutti i destinatari di un processo: recuperare i risultati del recapito per ogni destinatario in un processo SMS specifico.
- Ottenere le informazioni sulla versione: recuperare le informazioni sulla versione corrente dell'API SMS Retarus.
Istruzioni per la distribuzione
Per usare questo connettore:
- configurarlo nell'ambiente come connettore personalizzato.
- Specificare le credenziali dell'API Retarus valide associate all'account Retarus.
- Assicurarsi che il provisioning dell'account venga effettuato per SMS-for-Applications in modo che sia possibile inviare processi SMS ed eseguire query sulle informazioni sul processo esposte dall'API.
Creazione di una connessione
Il connettore supporta i tipi di autenticazione seguenti:
| Predefinita | Parametri per la creazione della connessione. | Tutte le aree | Non condivisibile |
Predefinito
Applicabile: tutte le aree
Parametri per la creazione della connessione.
Questa non è una connessione condivisibile. Se l'app power viene condivisa con un altro utente, verrà richiesto a un altro utente di creare una nuova connessione in modo esplicito.
| Nome | TIPO | Description | Obbligatorio |
|---|---|---|---|
| username | securestring | Nome utente per questa API | Vero |
| parola d’ordine | securestring | Password per questa API | Vero |
Limiti per la limitazione delle richieste
| Nome | Chiamate | Periodo di rinnovo |
|---|---|---|
| Chiamate API per connessione | 100 | 60 secondi |
Azioni
| Inviare un processo SMS |
Questa operazione invia uno o più messaggi SMS con uno o più destinatari ciascuno. La risposta contiene l'ID processo (jobId) del nuovo processo SMS. |
| Ottenere le informazioni sulla versione |
Questa operazione recupera le informazioni sulla versione corrente per l'API. |
| Ottenere lo stato del processo |
Questa operazione recupera lo stato del processo e l'elenco di ID SMS per il processo. Per ottenere lo stato del singolo messaggio per tutti i messaggi in un processo, usare l'endpoint SMS con il parametro jobId corrispondente. |
| Ottenere lo stato per tutti i destinatari di un processo |
Questa operazione recupera lo stato del singolo messaggio per tutti i destinatari di un processo specifico. |
| Ottenere tutti i processi per i criteri specificati |
Questa operazione recupera un elenco di ID processo per un periodo di tempo specificato ed eventuali filtri facoltativi. |
Inviare un processo SMS
Questa operazione invia uno o più messaggi SMS con uno o più destinatari ciascuno. La risposta contiene l'ID processo (jobId) del nuovo processo SMS.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Src
|
src | string |
ID mittente visualizzato al destinatario. |
|
|
encoding
|
encoding | string | ||
|
billcode
|
billcode | string |
Max. 70 caratteri. |
|
|
statusRequested
|
statusRequested | boolean |
Notifica di recapito richiesta. |
|
|
Flash
|
flash | boolean | ||
|
customerRef
|
customerRef | string |
Numero massimo consigliato di 64 caratteri. |
|
|
validitàMin
|
validityMin | integer |
Validità dell'SMS in minuti. Quando si usa 0 il valore predefinito del provider. In caso contrario, i valori devono essere compresi tra 5 e 2880 minuti. |
|
|
maxParts
|
maxParts | integer |
Numero massimo di parti consentite in un messaggio in più parti. I valori devono essere compresi tra 1 e 20. I messaggi più lunghi vengono troncati. |
|
|
invalidCharacters
|
invalidCharacters | string |
Definire come gestire caratteri non validi in SMS. |
|
|
QoS
|
qos | string |
Qualità del servizio. |
|
|
jobPeriod
|
jobPeriod | date-time |
Timestamp da pianificare quando avviare l'elaborazione del processo SMS (iso-8601). |
|
|
duplicateDetection
|
duplicateDetection | boolean | ||
|
blackoutPeriods
|
blackoutPeriods | array of string | ||
|
text
|
text | True | string |
Foo |
|
Dst
|
dst | True | string | |
|
customerRef
|
customerRef | string |
Numero massimo consigliato di 64 caratteri. Numero di telefono cellulare destinatario utilizzato come predefinito. |
|
|
blackoutPeriods
|
blackoutPeriods | array of string |
Restituisce
- Corpo
- JobResponse
Ottenere le informazioni sulla versione
Questa operazione recupera le informazioni sulla versione corrente per l'API.
Restituisce
- Corpo
- VersionInfoResponse
Ottenere lo stato del processo
Questa operazione recupera lo stato del processo e l'elenco di ID SMS per il processo. Per ottenere lo stato del singolo messaggio per tutti i messaggi in un processo, usare l'endpoint SMS con il parametro jobId corrispondente.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID lavoro
|
jobId | True | string |
ID processo Retarus. |
Restituisce
- Corpo
- JobReport
Ottenere lo stato per tutti i destinatari di un processo
Questa operazione recupera lo stato del singolo messaggio per tutti i destinatari di un processo specifico.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID lavoro
|
jobId | True | string |
ID processo Retarus. |
Restituisce
- response
- array of RecipientReport
Ottenere tutti i processi per i criteri specificati
Questa operazione recupera un elenco di ID processo per un periodo di tempo specificato ed eventuali filtri facoltativi.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Restituisce solo id jobID
|
jobIdsOnly | True | boolean |
Restituisce solo id processo. Attualmente è supportato solo "true". |
|
Dal timestamp
|
fromTs | date-time |
Dal timestamp (ISO-8601). L'intervallo tra i tipi daT e toT può essere un massimo di 30 giorni. |
|
|
Per timestamp
|
toTs | date-time |
Per timestamp (ISO-8601). L'intervallo tra i tipi daT e toT può essere un massimo di 30 giorni. |
|
|
Restituisce solo processi aperti
|
open | boolean |
Restituisce solo processi aperti. |
|
|
Offset
|
offset | integer |
Parametro utilizzato per la paginazione. Recuperare un subset di record che iniziano con il valore di offset. |
|
|
Numero massimo di risultati restituiti
|
limit | integer |
Limitare il numero di risultati restituiti. Il valore deve essere compreso tra 0 e 1000. |
Restituisce
- response
- array of JobReport
Definizioni
JobResponse
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
jobId
|
jobId | string |
JobReport
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
jobId
|
jobId | string | |
|
Src
|
src | string |
ID mittente. |
|
encoding
|
encoding | string | |
|
billcode
|
billcode | string | |
|
statusRequested
|
statusRequested | boolean |
Notifica di recapito richiesta. |
|
Flash
|
flash | boolean | |
|
validitàMin
|
validityMin | integer |
Validità dell'SMS in minuti. |
|
customerRef
|
customerRef | string |
Numero massimo consigliato di 64 caratteri. |
|
QoS
|
qos | string |
Qualità del servizio. |
|
ricevute
|
receiptTs | date-time |
Timestamp che indica quando il processo è stato ricevuto da Retarus (iso-8601). |
|
FinishedTs
|
finishedTs | date-time |
Timestamp che indica quando l'SMS ha ricevuto lo stato finale (iso-8601). |
|
recipientIds
|
recipientIds | array of string |
RecipientReport
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
smsId
|
smsId | string | |
|
Dst
|
dst | string |
Numero di telefono cellulare del destinatario. |
|
processStatus
|
processStatus | string |
Stato del processo corrente (vedere Sms Outbound Status Codes). |
|
status
|
status | string |
Stato (vedere SMS Outbound Status Codes). |
|
customerRef
|
customerRef | string |
Numero massimo consigliato di 64 caratteri. |
|
reason
|
reason | string | |
|
messaggi inviati
|
sentTs | date-time |
Timestamp quando è stato inviato l'SMS (iso-8601). |
|
FinishedTs
|
finishedTs | date-time |
Timestamp che indica quando l'SMS ha ricevuto lo stato finale (iso-8601). |
VersionInfoResponse
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
buildNumber
|
buildNumber | integer | |
|
buildTimestamp
|
buildTimestamp | string | |
|
majorVersion
|
majorVersion | integer | |
|
minorVersion
|
minorVersion | integer | |
|
versionInfo
|
versionInfo | string | |
|
message
|
message | string |