Retarus SMS (Preview)
Konektor Retarus SMS umožňuje organizacím automatizovat a spolehlivě doručovat textové zprávy z pracovních postupů Microsoftu. Slouží k odesílání úloh SMS, stavu úlohy dotazu, načítání výsledků doručení pro jednotlivé příjemce a získání podrobností o verzi rozhraní API. Vyžaduje se aktivní účet Retarus a platné přihlašovací údaje rozhraní API. Pokud chcete získat testovací účet pro tuto službu nebo některou z našich dalších služeb SMS, obraťte se prosím na Retarus.
Tento konektor je dostupný v následujících produktech a oblastech:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Všechny oblasti Power Automate s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Logic Apps | Standard | Všechny oblasti Logic Apps s výjimkou následujících: – Oblasti Azure Government – Oblasti Azure China - Ministerstvo obrany USA (DoD) |
| Power Apps | Premium | Všechny oblasti Power Apps s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Power Automate | Premium | Všechny oblasti Power Automate s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Kontakt | |
|---|---|
| Název | Retarus |
| URL | https://www.retarus.com/ |
| info@retarus.com |
| Metadata konektoru | |
|---|---|
| Vydavatel | retarus GmbH |
| Internetová stránka | https://www.retarus.com/ |
| Zásady ochrany osobních údajů | https://www.retarus.com/data-privacy-policy/ |
| Kategorie | Komunikace; Marketing |
Retarus SMS
Konektor Retarus SMS umožňuje organizacím automatizovat odesílání textových zpráv a sledovat jejich stav doručení.
Poskytuje zabezpečené a spolehlivé komunikační funkce pro obchodní pracovní postupy, které vyžadují rozsáhlé doručování SMS. Pomocí konektoru můžete odesílat zprávy, kontrolovat stav úloh, načítat výsledky doručení pro jednotlivé příjemce a přistupovat k informacím o verzi rozhraní API.
Požadavky
Účet SMS Retarus s platnými přihlašovacími údaji rozhraní API Účet Azure a předplatné s oprávněními správce. Podporované operace Konektor podporuje následující operace:
- Odeslání úlohy SMS: Odeslání jedné nebo více sms zpráv jednomu nebo více příjemcům.
- Získejte stav úlohy: Načtěte stav a ID SMS pro dříve odeslanou úlohu.
- Získání všech úloh pro daná kritéria: Načtěte seznam ID úloh filtrovaných podle časového rozsahu nebo jiných kritérií.
- Získejte stav pro všechny příjemce úlohy: Načtěte výsledky doručení pro každého příjemce v konkrétní úloze SMS.
- Získejte informace o verzi: Načtěte aktuální informace o verzi rozhraní API služby Retarus SMS.
Pokyny k nasazení
Použití tohoto konektoru:
- nakonfigurujte ho ve vašem prostředí jako vlastní konektor.
- Zadejte platné přihlašovací údaje rozhraní API Retarus přidružené k vašemu účtu Retarus.
- Ujistěte se, že je váš účet zřízený pro SMS-for-Applications, abyste mohli odesílat úlohy SMS a dotazovat se na informace o úlohách vystavených rozhraním API.
Vytvoření připojení
Konektor podporuje následující typy ověřování:
| výchozí | Parametry pro vytvoření připojení | Všechny oblasti | Nesdílitelné |
Výchozí
Použitelné: Všechny oblasti
Parametry pro vytvoření připojení
Toto připojení není možné sdílet. Pokud se power app sdílí s jiným uživatelem, zobrazí se výzva k explicitní vytvoření nového připojení.
| Název | Typ | Description | Povinné |
|---|---|---|---|
| uživatelské jméno | securestring | Uživatelské jméno pro toto rozhraní API | Pravdivé |
| heslo | securestring | Heslo pro toto rozhraní API | Pravdivé |
Limity omezování
| Name | Volání | Období obnovení |
|---|---|---|
| Volání rozhraní API na připojení | 100 | 60 sekund |
Akce
| Odeslání úlohy SMS |
Tato operace odesílá jednu nebo více sms zpráv s jedním nebo více příjemci. Odpověď obsahuje ID úlohy (jobId) nové úlohy SMS. |
| Získání informací o verzi |
Tato operace načte informace o aktuální verzi rozhraní API. |
| Získání stavu pro všechny příjemce úlohy |
Tato operace načte stav jednotlivých zpráv pro všechny příjemce konkrétní úlohy. |
| Získání stavu úlohy |
Tato operace načte stav úlohy a seznam ID SMS pro úlohu. Pokud chcete získat stav jednotlivých zpráv pro všechny zprávy v úloze, použijte koncový bod SMS s odpovídajícím parametrem jobId. |
| Získání všech úloh pro daná kritéria |
Tato operace načte seznam ID úloh pro zadané časové období a všechny volitelné filtry. |
Odeslání úlohy SMS
Tato operace odesílá jednu nebo více sms zpráv s jedním nebo více příjemci. Odpověď obsahuje ID úlohy (jobId) nové úlohy SMS.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Src
|
src | string |
ID odesílatele se zobrazilo příjemci. |
|
|
kódování
|
encoding | string | ||
|
billcode
|
billcode | string |
Max. 70 znaků. |
|
|
statusRequested
|
statusRequested | boolean |
Bylo požadováno oznámení o doručení. |
|
|
blesk
|
flash | boolean | ||
|
customerRef
|
customerRef | string |
Doporučeno maximálně 64 znaků. |
|
|
validityMin
|
validityMin | integer |
Platnost sms v minutách. Pokud se použije výchozí hodnota 0 zprostředkovatele. Jinak musí být hodnoty v rozmezí 5 až 2880 minut. |
|
|
maxParts
|
maxParts | integer |
Maximální povolené části ve zprávě s více částmi Hodnoty musí být v rozsahu 1 až 20. Delší zprávy jsou zkráceny. |
|
|
invalidCharacters
|
invalidCharacters | string |
Definujte způsob zpracování neplatných znaků v sms. |
|
|
qos
|
qos | string |
Kvalita služby. |
|
|
jobPeriod
|
jobPeriod | date-time |
Časové razítko pro naplánování zahájení zpracování úlohy SMS (iso-8601). |
|
|
duplicateDetection
|
duplicateDetection | boolean | ||
|
blackoutPeriods
|
blackoutPeriods | array of string | ||
|
poslat SMS
|
text | True | string |
Foo |
|
Dst
|
dst | True | string | |
|
customerRef
|
customerRef | string |
Doporučeno maximálně 64 znaků. Číslo mobilního telefonu příjemce, které se používá jako výchozí. |
|
|
blackoutPeriods
|
blackoutPeriods | array of string |
Návraty
- Body
- JobResponse
Získání informací o verzi
Získání stavu pro všechny příjemce úlohy
Tato operace načte stav jednotlivých zpráv pro všechny příjemce konkrétní úlohy.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID úlohy
|
jobId | True | string |
ID úlohy Retarus. |
Návraty
- response
- array of RecipientReport
Získání stavu úlohy
Tato operace načte stav úlohy a seznam ID SMS pro úlohu. Pokud chcete získat stav jednotlivých zpráv pro všechny zprávy v úloze, použijte koncový bod SMS s odpovídajícím parametrem jobId.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID úlohy
|
jobId | True | string |
ID úlohy Retarus. |
Návraty
- Body
- JobReport
Získání všech úloh pro daná kritéria
Tato operace načte seznam ID úloh pro zadané časové období a všechny volitelné filtry.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Vrácení pouze identifikátorů jobID
|
jobIdsOnly | True | boolean |
Vrátit pouze identifikátory JOBID. V současné době se podporuje pouze hodnota true. |
|
Z časového razítka
|
fromTs | date-time |
Z časového razítka (ISO-8601). Interval mezi jednotlivými tečkami a toT může být maximálně 30 dnů. |
|
|
Časové razítko
|
toTs | date-time |
Časové razítko (ISO-8601) Interval mezi jednotlivými tečkami a toT může být maximálně 30 dnů. |
|
|
Vrácení pouze otevřených úloh
|
open | boolean |
Vrátí pouze otevřené úlohy. |
|
|
Posun
|
offset | integer |
Parametr použitý pro stránkování Načtěte podmnožinu záznamů začínající hodnotou posunu. |
|
|
Maximální vrácené výsledky
|
limit | integer |
Omezte počet vrácených výsledků. Hodnota musí být v rozsahu 0 až 1 000. |
Návraty
- response
- array of JobReport
Definice
JobResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
jobId
|
jobId | string |
JobReport
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
jobId
|
jobId | string | |
|
Src
|
src | string |
ID odesílatele. |
|
kódování
|
encoding | string | |
|
billcode
|
billcode | string | |
|
statusRequested
|
statusRequested | boolean |
Bylo požadováno oznámení o doručení. |
|
blesk
|
flash | boolean | |
|
validityMin
|
validityMin | integer |
Platnost sms v minutách. |
|
customerRef
|
customerRef | string |
Doporučeno maximálně 64 znaků. |
|
qos
|
qos | string |
Kvalita služby. |
|
účtenky
|
receiptTs | date-time |
Časové razítko označující, kdy byla úloha přijata retarusem (iso-8601). |
|
dokončené tečky
|
finishedTs | date-time |
Časové razítko označující, kdy SMS obdržela konečný stav (iso-8601). |
|
recipientIds
|
recipientIds | array of string |
RecipientReport
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
SMSId
|
smsId | string | |
|
Dst
|
dst | string |
Telefonní číslo příjemce. |
|
processStatus
|
processStatus | string |
Aktuální stav procesu (viz Stavové kódy odchozích přenosů SMS). |
|
stav
|
status | string |
Stav (viz Odchozí stavové kódy SMS). |
|
customerRef
|
customerRef | string |
Doporučeno maximálně 64 znaků. |
|
důvod
|
reason | string | |
|
sentTs
|
sentTs | date-time |
Časové razítko, kdy byla zpráva SMS odeslána (iso-8601). |
|
dokončené tečky
|
finishedTs | date-time |
Časové razítko, které označuje, kdy sms obdržela konečný stav (iso-8601). |
VersionInfoResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Číslo sestavení
|
buildNumber | integer | |
|
buildTimestamp
|
buildTimestamp | string | |
|
majorVersion
|
majorVersion | integer | |
|
minorVersion
|
minorVersion | integer | |
|
versionInfo
|
versionInfo | string | |
|
zpráva
|
message | string |