Udostępnij przez

Sms for Applications (wersja zapoznawcza)

Łącznik programu Retarus SMS umożliwia organizacjom automatyzowanie i niezawodne dostarczanie wiadomości SMS z przepływów pracy firmy Microsoft. Służy do przesyłania zadań SMS, wykonywania zapytań o stan zadania, pobierania wyników dostarczania poszczególnych adresatów i pobierania szczegółów wersji interfejsu API. Wymagane jest aktywne konto Retarus i prawidłowe poświadczenia interfejsu API. Aby uzyskać konto testowe dla tej usługi lub dowolnej z naszych innych usług SMS, skontaktuj się z firmą Retarus.

Ten łącznik jest dostępny w następujących produktach i regionach:

Usługa Class Regions
Copilot Studio Premium Wszystkie regiony usługi Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Logic Apps Standard Wszystkie regiony usługi Logic Apps z wyjątkiem następujących:
     — Regiony platformy Azure Government
     — Regiony platformy Azure (Chiny)
     - Departament Obrony USA (DoD)
Power Apps Premium Wszystkie regiony usługi Power Apps z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Power Automate - narzędzie do automatyzacji procesów Premium Wszystkie regiony usługi Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Kontakt
Name Retarus
adres URL https://www.retarus.com/
Email info@retarus.com
Metadane łącznika
Publisher retarus GmbH
Witryna internetowa https://www.retarus.com/
Zasady ochrony prywatności https://www.retarus.com/data-privacy-policy/
Kategorie Komunikacja; Marketing

Retarus SMS

Łącznik programu Retarus SMS umożliwia organizacjom automatyzowanie wysyłania wiadomości SMS i śledzenie ich stanu dostarczania.
Zapewnia bezpieczne i niezawodne możliwości komunikacji dla przepływów pracy biznesowych, które wymagają dostarczania wiadomości SMS na dużą skalę. Łącznik służy do wysyłania komunikatów, sprawdzania stanu zadań, pobierania wyników dostarczania poszczególnych adresatów i uzyskiwania dostępu do informacji o wersji interfejsu API.

Wymagania wstępne

Konto retarus SMS z prawidłowymi poświadczeniami interfejsu API. Konto platformy Azure i subskrypcja z uprawnieniami administracyjnymi. Obsługiwane operacje Łącznik obsługuje następujące operacje:

  • Wyślij zadanie SMS: wyślij co najmniej jedną wiadomość SMS do co najmniej jednego adresata.
  • Pobierz stan zadania: pobierz stan i identyfikatory wiadomości SMS dla wcześniej przesłanego zadania.
  • Pobierz wszystkie zadania dla podanych kryteriów: pobierz listę identyfikatorów zadań filtrowanych według zakresu czasu lub innych kryteriów.
  • Uzyskaj stan dla wszystkich adresatów zadania: pobieranie wyników dostarczania dla każdego adresata w określonym zadaniu programu SMS.
  • Uzyskaj informacje o wersji: pobierz informacje o bieżącej wersji interfejsu API programu SMS Retarus.

Instrukcje dotyczące wdrażania

Aby użyć tego łącznika:

  1. skonfiguruj go w środowisku jako łącznik niestandardowy.
  2. Podaj prawidłowe poświadczenia interfejsu API Retarus skojarzone z kontem usługi Retarus.
  3. Upewnij się, że twoje konto jest aprowizowane dla aplikacji SMS-for-Applications, aby można było przesyłać zadania sms i wysyłać informacje o zadaniu zapytań uwidocznione przez interfejs API.

Tworzenie połączenia

Łącznik obsługuje następujące typy uwierzytelniania:
Wartość domyślna Parametry tworzenia połączenia. Wszystkie regiony Nie można udostępniać

Domyślny

Dotyczy: wszystkie regiony

Parametry tworzenia połączenia.

Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.

Name Typ Description Wymagane
nazwa użytkownika securestring Nazwa użytkownika dla tego interfejsu API Prawda
hasło securestring Hasło dla tego interfejsu API Prawda

Limity ograniczania

Nazwa Wywołania Okres odnowienia
Wywołania interfejsu API na połączenie 100 60 sekund

Akcje

Pobieranie stanu dla wszystkich adresatów zadania

Ta operacja pobiera pojedynczy stan wiadomości dla wszystkich adresatów określonego zadania.
Pobieranie stanu zadania

Ta operacja pobiera stan zadania i listę identyfikatorów wiadomości SMS dla zadania. Aby uzyskać stan pojedynczej wiadomości dla wszystkich komunikatów w zadaniu, użyj punktu końcowego programu SMS z odpowiednim parametrem jobId.
Pobieranie wszystkich zadań dla podanych kryteriów

Ta operacja pobiera listę identyfikatorów zadań dla określonego okresu i wszystkich opcjonalnych filtrów.
Uzyskiwanie informacji o wersji

Ta operacja pobiera bieżące informacje o wersji interfejsu API.
Wysyłanie zadania sms

Ta operacja wysyła co najmniej jedną wiadomość SMS z co najmniej jednym adresatem. Odpowiedź zawiera identyfikator zadania (jobId) nowego zadania SMS.

Pobieranie stanu dla wszystkich adresatów zadania

Identyfikator operacji:
listRecipients

Ta operacja pobiera pojedynczy stan wiadomości dla wszystkich adresatów określonego zadania.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator zadania
 jobId True string

Identyfikator zadania Retarus.

Zwraca

response
array of RecipientReport

Pobieranie stanu zadania

Identyfikator operacji:
getJob

Ta operacja pobiera stan zadania i listę identyfikatorów wiadomości SMS dla zadania. Aby uzyskać stan pojedynczej wiadomości dla wszystkich komunikatów w zadaniu, użyj punktu końcowego programu SMS z odpowiednim parametrem jobId.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator zadania
 jobId True string

Identyfikator zadania Retarus.

Zwraca

Body
JobReport

Pobieranie wszystkich zadań dla podanych kryteriów

Identyfikator operacji:
listJobs

Ta operacja pobiera listę identyfikatorów zadań dla określonego okresu i wszystkich opcjonalnych filtrów.

Parametry

Nazwa Klucz Wymagane Typ Opis
Zwracanie tylko identyfikatorów zadań
 jobIdsOnly True boolean

Zwraca tylko identyfikatory zadań. Obecnie obsługiwane są tylko wartości "true".
Od znacznika czasu
 fromTs date-time

Od sygnatury czasowej (ISO-8601). Interwał między wartościami odTs i toTs może wynosić maksymalnie 30 dni.
Znacznik czasu
 toTs date-time

Znacznik czasu (ISO-8601). Interwał między wartościami odTs i toTs może wynosić maksymalnie 30 dni.
Zwracanie tylko otwartych zadań
 open boolean

Zwracanie tylko otwartych zadań.
Przesunięcie
 offset integer

Parametr używany do stronicowania. Pobierz podzbiór rekordów rozpoczynających się od wartości przesunięcia.
Zwrócone maksymalne wyniki
 limit integer

Ogranicz liczbę zwróconych wyników. Wartość musi należeć do zakresu od 0 do 1000.

Zwraca

response
array of JobReport

Uzyskiwanie informacji o wersji

Identyfikator operacji:
get

Ta operacja pobiera bieżące informacje o wersji interfejsu API.

Zwraca

Body
VersionInfoResponse

Wysyłanie zadania sms

Identyfikator operacji:
postJob

Ta operacja wysyła co najmniej jedną wiadomość SMS z co najmniej jednym adresatem. Odpowiedź zawiera identyfikator zadania (jobId) nowego zadania SMS.

Parametry

Nazwa Klucz Wymagane Typ Opis
Src
 src string

Identyfikator nadawcy wyświetlany adresatowi.
kodowanie
 encoding string
kod rachunku
 billcode string

Max. 70 znaków.
statusRequested
 statusRequested boolean

Zażądano powiadomienia o dostawie.
lampa błyskowa
 flash boolean
customerRef
 customerRef string

Zalecane maksymalnie 64 znaki.
validityMin
 validityMin integer

Ważność wiadomości SMS w minutach. Gdy jest używana wartość domyślna dostawcy 0. W przeciwnym razie wartości muszą należeć do zakresu od 5 do 2880 minut.
maxParts
 maxParts integer

Maksymalna dozwolona liczba części w komunikacie wieloczęściowym. Wartości muszą należeć do zakresu od 1 do 20. Dłuższe komunikaty są obcinane.
invalidCharacters
 invalidCharacters string

Zdefiniuj sposób obsługi nieprawidłowych znaków w programie SMS.
Funkcja QoS
 qos string

Jakość usług.
jobPeriod
 jobPeriod date-time

Sygnatura czasowa planowania rozpoczęcia przetwarzania zadania programu SMS (iso-8601).
duplicateDetection
 duplicateDetection boolean
blackoutPeriods
 blackoutPeriods array of string
SMS
 text True string

Foo
Czasu letniego
 dst True string
customerRef
 customerRef string

Zalecane maksymalnie 64 znaki. Numer telefonu komórkowego odbiorcy używany jako domyślny.
blackoutPeriods
 blackoutPeriods array of string

Zwraca

Body
JobResponse

Definicje

ZadanieResponse

Nazwa Ścieżka Typ Opis
jobId
 jobId string

Raport zadania

Nazwa Ścieżka Typ Opis
jobId
 jobId string
Src
 src string

Identyfikator nadawcy.
kodowanie
 encoding string
kod rachunku
 billcode string
statusRequested
 statusRequested boolean

Zażądano powiadomienia o dostawie.
lampa błyskowa
 flash boolean
validityMin
 validityMin integer

Ważność wiadomości SMS w minutach.
customerRef
 customerRef string

Zalecane maksymalnie 64 znaki.
Funkcja QoS
 qos string

Jakość usług.
paragony
 receiptTs date-time

Sygnatura czasowa wskazująca, kiedy zadanie zostało odebrane przez retarus (iso-8601).
gotowe
 finishedTs date-time

Sygnatura czasowa wskazująca, kiedy sms otrzymał stan końcowy (iso-8601).
identyfikatory adresatów
 recipientIds array of string

OdbiorcaRaport

Nazwa Ścieżka Typ Opis
smsId
 smsId string
Czasu letniego
 dst string

Numer telefonu komórkowego adresata.
processStatus
 processStatus string

Bieżący stan procesu (zobacz Kody stanu ruchu wychodzącego sms).
stan
 status string

Stan (zobacz Kody stanu ruchu wychodzącego sms).
customerRef
 customerRef string

Zalecane maksymalnie 64 znaki.
powód
 reason string
sentTs
 sentTs date-time

Sygnatura czasowa wysłania wiadomości SMS (iso-8601).
gotowe
 finishedTs date-time

Sygnatura czasowa wskazująca, kiedy sms otrzymał stan końcowy (iso-8601).

VersionInfoResponse

Nazwa Ścieżka Typ Opis
Numer kompilacji
 buildNumber integer
buildTimestamp
 buildTimestamp string
majorVersion (wersja główna)
 majorVersion integer
wersja pomocnicza
 minorVersion integer
versionInfo
 versionInfo string
komunikat
 message string