Retarus SMS (förhandsversion)
Med Återrus SMS-anslutningsappen kan organisationer automatisera och leverera textmeddelanden från Microsoft-arbetsflöden på ett tillförlitligt sätt. Använd det för att skicka SMS-jobb, fråga efter jobbstatus, hämta leveransresultat per mottagare och hämta information om API-version. Ett aktivt Retarus-konto och giltiga API-autentiseringsuppgifter krävs. Kontakta Retarus för att få ett testkonto för den här tjänsten eller någon av våra andra SMS-tjänster.
Den här anslutningsappen är tillgänglig i följande produkter och regioner:
| Tjänster | Class | Regioner |
|---|---|---|
| Copilot Studio | Premie | Alla Power Automate-regioner utom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Logiska appar | Norm | Alla Logic Apps-regioner utom följande: – Azure Government-regioner – Regioner i Azure Kina - US Department of Defense (DoD) |
| Power Apps | Premie | Alla Power Apps-regioner utom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premie | Alla Power Automate-regioner utom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Namn | Retarus |
| URL | https://www.retarus.com/ |
| E-postmeddelande | info@retarus.com |
| Metadata för anslutningsprogram | |
|---|---|
| Utgivare | retarus GmbH |
| Webbplats | https://www.retarus.com/ |
| Sekretesspolicy | https://www.retarus.com/data-privacy-policy/ |
| Kategorier | Kommunikation; Marknadsföring |
Återtagande SMS
Med Återrus SMS-anslutningsappen kan organisationer automatisera sändningen av textmeddelanden och spåra deras leveransstatus.
Det ger säkra och tillförlitliga kommunikationsfunktioner för affärsarbetsflöden som kräver storskalig SMS-leverans. Du kan använda anslutningsappen för att skicka meddelanden, kontrollera status för jobb, hämta leveransresultat per mottagare och komma åt versionsinformation för API:et.
Förutsättningar
Ett Retarus SMS-konto med giltiga API-autentiseringsuppgifter. Ett Azure-konto och en prenumeration med administratörsbehörighet. Åtgärder som stöds Anslutningsappen stöder följande åtgärder:
- Skicka ett SMS-jobb: Skicka ett eller flera SMS till en eller flera mottagare.
- Hämta jobbstatus: Hämta status och SMS-ID:t för ett tidigare skickat jobb.
- Hämta alla jobb för de angivna kriterierna: Hämta en lista över jobb-ID:t filtrerade efter tidsintervall eller andra villkor.
- Hämta status för alla mottagare av ett jobb: Hämta leveransresultat för varje mottagare i ett specifikt SMS-jobb.
- Hämta versionsinformationen: Hämta den aktuella versionsinformationen för RETARUS SMS-API:et.
Distributionsinstruktioner
Så här använder du den här anslutningsappen:
- konfigurera den i din miljö som en anpassad anslutningsapp.
- Ange giltiga Retarus API-autentiseringsuppgifter som är associerade med ditt Retarus-konto.
- Kontrollera att ditt konto har etablerats för SMS-for-Applications så att du kan skicka SMS-jobb och fråga efter jobbinformation som exponeras av API:et.
Skapa en anslutning
Anslutningsappen stöder följande autentiseringstyper:
| Standardinställning | Parametrar för att skapa anslutning. | Alla regioner | Går inte att dela |
Standard
Tillämpligt: Alla regioner
Parametrar för att skapa anslutning.
Det här är inte delningsbar anslutning. Om power-appen delas med en annan användare uppmanas en annan användare att skapa en ny anslutning explicit.
| Namn | Typ | Description | Krävs |
|---|---|---|---|
| username | securestring | Användarnamnet för det här API:et | Sann |
| lösenord | securestring | Lösenordet för det här API:et | Sann |
Begränsningar för strypning
| Namn | Samtal | Förnyelseperioden |
|---|---|---|
| API-anrop per anslutning | 100 | 60 sekunder |
Åtgärder
| Hämta alla jobb för de angivna kriterierna |
Den här åtgärden hämtar en lista över jobb-ID:t för en angiven tidsperiod och eventuella valfria filter. |
| Hämta jobbstatus |
Den här åtgärden hämtar jobbstatusen och listan över SMS-ID:t för jobbet. Om du vill hämta statusen för enskilda meddelanden för alla meddelanden i ett jobb använder du SMS-slutpunkten med motsvarande jobId-parameter. |
| Hämta status för alla mottagare av ett jobb |
Den här åtgärden hämtar den enskilda meddelandestatusen för alla mottagare av ett visst jobb. |
| Hämta versionsinformationen |
Den här åtgärden hämtar den aktuella versionsinformationen för API:et. |
| Skicka ett SMS-jobb |
Den här åtgärden skickar ett eller flera SMS med en eller flera mottagare var. Svaret innehåller jobb-ID (jobId) för det nya SMS-jobbet. |
Hämta alla jobb för de angivna kriterierna
Den här åtgärden hämtar en lista över jobb-ID:t för en angiven tidsperiod och eventuella valfria filter.
Parametrar
| Namn | Nyckel | Krävs | Typ | Beskrivning |
|---|---|---|---|---|
|
Returnera endast job-ID:ar
|
jobIdsOnly | True | boolean |
Returnera endast job-ID:er. För närvarande stöds endast "true". |
|
Från tidsstämpel
|
fromTs | date-time |
Från tidsstämpel (ISO-8601). Intervallet mellan fromTs och toTs kan vara högst 30 dagar. |
|
|
Till tidsstämpel
|
toTs | date-time |
Till tidsstämpel (ISO-8601). Intervallet mellan fromTs och toTs kan vara högst 30 dagar. |
|
|
Returnera endast öppna jobb
|
open | boolean |
Returnera endast öppna jobb. |
|
|
Offset
|
offset | integer |
Parameter som används för sidnumrering. Hämta en delmängd av poster som börjar med förskjutningsvärdet. |
|
|
Maximalt antal returnerade resultat
|
limit | integer |
Begränsa antalet returnerade resultat. Värdet måste vara mellan 0 och 1 000. |
Returnerar
- response
- array of JobReport
Hämta jobbstatus
Den här åtgärden hämtar jobbstatusen och listan över SMS-ID:t för jobbet. Om du vill hämta statusen för enskilda meddelanden för alla meddelanden i ett jobb använder du SMS-slutpunkten med motsvarande jobId-parameter.
Parametrar
| Namn | Nyckel | Krävs | Typ | Beskrivning |
|---|---|---|---|---|
|
Jobb-ID
|
jobId | True | string |
Jobb-ID:t för Retarus. |
Returnerar
- Body
- JobReport
Hämta status för alla mottagare av ett jobb
Den här åtgärden hämtar den enskilda meddelandestatusen för alla mottagare av ett visst jobb.
Parametrar
| Namn | Nyckel | Krävs | Typ | Beskrivning |
|---|---|---|---|---|
|
Jobb-ID
|
jobId | True | string |
Jobb-ID:t för Retarus. |
Returnerar
- response
- array of RecipientReport
Hämta versionsinformationen
Den här åtgärden hämtar den aktuella versionsinformationen för API:et.
Returnerar
- Body
- VersionInfoResponse
Skicka ett SMS-jobb
Den här åtgärden skickar ett eller flera SMS med en eller flera mottagare var. Svaret innehåller jobb-ID (jobId) för det nya SMS-jobbet.
Parametrar
| Namn | Nyckel | Krävs | Typ | Beskrivning |
|---|---|---|---|---|
|
Src
|
src | string |
Avsändarens ID visas för mottagaren. |
|
|
encoding
|
encoding | string | ||
|
billcode
|
billcode | string |
Max. 70 tecken. |
|
|
statusRequested
|
statusRequested | boolean |
Leveransavisering begärd. |
|
|
blixt
|
flash | boolean | ||
|
customerRef
|
customerRef | string |
Rekommenderat max. 64 tecken. |
|
|
validityMin
|
validityMin | integer |
Sms:ets giltighet på några minuter. När 0 används providerns standardvärde. Annars måste värdena vara mellan 5 och 2 880 minuter. |
|
|
maxParts
|
maxParts | integer |
Maximalt antal tillåtna delar i ett meddelande i flera delar. Värdena måste vara mellan 1 och 20. Längre meddelanden trunkeras. |
|
|
invalidCharacters
|
invalidCharacters | string |
Definiera hur ogiltiga tecken ska hanteras i SMS. |
|
|
qos
|
qos | string |
Tjänstens kvalitet. |
|
|
jobPeriod
|
jobPeriod | date-time |
Tidsstämpel för att schemalägga när SMS-jobbet ska börja bearbetas (iso-8601). |
|
|
duplicateDetection
|
duplicateDetection | boolean | ||
|
blackoutPeriods
|
blackoutPeriods | array of string | ||
|
texten
|
text | True | string |
Foo |
|
Dst
|
dst | True | string | |
|
customerRef
|
customerRef | string |
Rekommenderat max. 64 tecken. Mottagarens mobiltelefonnummer används som standard. |
|
|
blackoutPeriods
|
blackoutPeriods | array of string |
Returnerar
- Body
- JobResponse
Definitioner
JobResponse
| Namn | Stig | Typ | Beskrivning |
|---|---|---|---|
|
jobId
|
jobId | string |
Jobbrapport
| Namn | Stig | Typ | Beskrivning |
|---|---|---|---|
|
jobId
|
jobId | string | |
|
Src
|
src | string |
Avsändar-ID. |
|
encoding
|
encoding | string | |
|
billcode
|
billcode | string | |
|
statusRequested
|
statusRequested | boolean |
Leveransavisering begärd. |
|
blixt
|
flash | boolean | |
|
validityMin
|
validityMin | integer |
Sms:ets giltighet på några minuter. |
|
customerRef
|
customerRef | string |
Rekommenderat max. 64 tecken. |
|
qos
|
qos | string |
Tjänstens kvalitet. |
|
receiptTs
|
receiptTs | date-time |
Tidsstämpel som anger när jobbet togs emot av Retarus (iso-8601). |
|
finishedTs
|
finishedTs | date-time |
Tidsstämpel som anger när SMS:et fick sin slutliga status (iso-8601). |
|
recipientIds
|
recipientIds | array of string |
Mottagarrapport
| Namn | Stig | Typ | Beskrivning |
|---|---|---|---|
|
smsId
|
smsId | string | |
|
Dst
|
dst | string |
Mottagarens mobiltelefonnummer. |
|
processStatus
|
processStatus | string |
Aktuell processstatus (se SMS Utgående statuskoder). |
|
status
|
status | string |
Status (se SMS Utgående statuskoder). |
|
customerRef
|
customerRef | string |
Rekommenderat max. 64 tecken. |
|
reason
|
reason | string | |
|
sentTs
|
sentTs | date-time |
Tidsstämpel när SMS:et skickades (iso-8601). |
|
finishedTs
|
finishedTs | date-time |
Tidsstämpel som anger när SMS:et fick sin slutliga status (iso-8601). |
VersionInfoResponse
| Namn | Stig | Typ | Beskrivning |
|---|---|---|---|
|
buildNumber (buildNummer)
|
buildNumber | integer | |
|
buildTimestamp
|
buildTimestamp | string | |
|
majorVersion
|
majorVersion | integer | |
|
minorVersion
|
minorVersion | integer | |
|
versionInfo
|
versionInfo | string | |
|
meddelande
|
message | string |