Retarus SMS (preview)
Met de Retarus SMS-connector kunnen organisaties sms-berichten automatiseren en betrouwbaar leveren vanuit Microsoft-werkstromen. Gebruik deze om SMS-taken te verzenden, de status van de taak op te vragen, resultaten voor levering per ontvanger op te halen en api-versiegegevens op te halen. Er zijn een actief Retarus-account en geldige API-referenties vereist. Neem contact op met Retarus om een testaccount voor deze service of een van onze andere SMS-services te verkrijgen.
Deze connector is beschikbaar in de volgende producten en regio's:
| Dienst | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Logic Apps- | Standaard | Alle Logic Apps-regio's , met uitzondering van het volgende: - Azure Government-regio's - Azure China-regio's - Us Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Contactpersoon | |
|---|---|
| Naam | Retarus |
| URL | https://www.retarus.com/ |
| E-mailen | info@retarus.com |
| Connector-metagegevens | |
|---|---|
| Uitgever | retarus GmbH |
| Webpagina | https://www.retarus.com/ |
| Privacybeleid | https://www.retarus.com/data-privacy-policy/ |
| Categorieën | Communicatie; Marketing |
Retarus SMS
Met de Retarus SMS-connector kunnen organisaties het verzenden van sms-berichten automatiseren en hun bezorgingsstatus bijhouden.
Het biedt veilige en betrouwbare communicatiemogelijkheden voor zakelijke werkstromen waarvoor grootschalige sms-levering is vereist. U kunt de connector gebruiken om berichten te verzenden, de status van taken te controleren, bezorgingsresultaten per ontvanger op te halen en versiegegevens van de API te openen.
Vereiste voorwaarden
Een Retarus SMS-account met geldige API-referenties. Een Azure-account en -abonnement met beheerdersbevoegdheden. Ondersteunde bewerkingen De connector ondersteunt de volgende bewerkingen:
- Een sms-taak verzenden: verzend een of meer sms-berichten naar een of meer geadresseerden.
- Haal de taakstatus op: haal de status en sms-id's voor een eerder ingediende taak op.
- Haal alle taken op voor de opgegeven criteria: Haal een lijst met taak-id's op die zijn gefilterd op tijdsbereik of andere criteria.
- Haal de status op voor alle geadresseerden van een taak: haal bezorgingsresultaten op voor elke geadresseerde in een specifieke SMS-taak.
- Haal de versie-informatie op: haal de huidige versiegegevens van de Retarus SMS-API op.
Implementatie-instructies
Ga als volgt te werk om deze connector te gebruiken:
- configureer deze in uw omgeving als een aangepaste connector.
- Geef geldige Retarus-API-referenties op die zijn gekoppeld aan uw Retarus-account.
- Zorg ervoor dat uw account is ingericht voor SMS-for-Applications, zodat u sms-taken kunt verzenden en taakgegevens kunt opvragen die beschikbaar zijn gesteld door de API.
Een verbinding maken
De connector ondersteunt de volgende verificatietypen:
| standaard | Parameters voor het maken van verbinding. | Alle regio's | Niet deelbaar |
Verstek
Van toepassing: Alle regio's
Parameters voor het maken van verbinding.
Dit is geen deelbare verbinding. Als de power-app wordt gedeeld met een andere gebruiker, wordt een andere gebruiker gevraagd om expliciet een nieuwe verbinding te maken.
| Naam | Typologie | Description | Verplicht |
|---|---|---|---|
| username | beveiligde string | De gebruikersnaam voor deze API | Klopt |
| wachtwoord | beveiligde string | Het wachtwoord voor deze API | Klopt |
Beperkingslimieten
| Name | Aanroepen | Verlengingsperiode |
|---|---|---|
| API-aanroepen per verbinding | 100 | 60 seconden |
Acties
| Alle taken ophalen voor de opgegeven criteria |
Met deze bewerking wordt een lijst met taak-id's opgehaald voor een opgegeven periode en eventuele optionele filters. |
| De status voor alle geadresseerden van een taak ophalen |
Met deze bewerking wordt de status van het afzonderlijke bericht opgehaald voor alle geadresseerden van een specifieke taak. |
| De taakstatus ophalen |
Met deze bewerking worden de taakstatus en de lijst met SMS-id's voor de taak opgehaald. Als u de status van het afzonderlijke bericht voor alle berichten in een taak wilt ophalen, gebruikt u het SMS-eindpunt met de bijbehorende jobId-parameter. |
| De versie-informatie ophalen |
Met deze bewerking worden de huidige versiegegevens voor de API opgehaald. |
| Een sms-taak verzenden |
Met deze bewerking worden een of meer sms-berichten met een of meer geadresseerden verzonden. Het antwoord bevat de taak-id (jobId) van de nieuwe SMS-taak. |
Alle taken ophalen voor de opgegeven criteria
Met deze bewerking wordt een lijst met taak-id's opgehaald voor een opgegeven periode en eventuele optionele filters.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Alleen taak-id's retourneren
|
jobIdsOnly | True | boolean |
Alleen taak-id's retourneren. Momenteel wordt alleen 'true' ondersteund. |
|
Van tijdstempel
|
fromTs | date-time |
Van tijdstempel (ISO-8601). Het interval tussen vanT's en toT's kan maximaal 30 dagen zijn. |
|
|
Naar tijdstempel
|
toTs | date-time |
Naar tijdstempel (ISO-8601). Het interval tussen vanT's en toT's kan maximaal 30 dagen zijn. |
|
|
Alleen geopende taken retourneren
|
open | boolean |
Alleen geopende taken retourneren. |
|
|
Offset
|
offset | integer |
Parameter die wordt gebruikt voor paginering. Haal een subset records op die beginnen met de offsetwaarde. |
|
|
Maximum aantal geretourneerde resultaten
|
limit | integer |
Het aantal geretourneerde resultaten beperken. De waarde moet tussen 0 en 1000 zijn. |
Retouren
- response
- array of JobReport
De status voor alle geadresseerden van een taak ophalen
Met deze bewerking wordt de status van het afzonderlijke bericht opgehaald voor alle geadresseerden van een specifieke taak.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Functie-ID
|
jobId | True | string |
De retarus-taak-id. |
Retouren
- response
- array of RecipientReport
De taakstatus ophalen
Met deze bewerking worden de taakstatus en de lijst met SMS-id's voor de taak opgehaald. Als u de status van het afzonderlijke bericht voor alle berichten in een taak wilt ophalen, gebruikt u het SMS-eindpunt met de bijbehorende jobId-parameter.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Functie-ID
|
jobId | True | string |
De retarus-taak-id. |
Retouren
- Body
- JobReport
De versie-informatie ophalen
Met deze bewerking worden de huidige versiegegevens voor de API opgehaald.
Retouren
- Body
- VersionInfoResponse
Een sms-taak verzenden
Met deze bewerking worden een of meer sms-berichten met een of meer geadresseerden verzonden. Het antwoord bevat de taak-id (jobId) van de nieuwe SMS-taak.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Src
|
src | string |
De afzender-id wordt weergegeven aan de geadresseerde. |
|
|
encoding
|
encoding | string | ||
|
billcode
|
billcode | string |
Max. 70 tekens. |
|
|
statusRequested
|
statusRequested | boolean |
Bezorgingsmelding aangevraagd. |
|
|
flits
|
flash | boolean | ||
|
customerRef
|
customerRef | string |
Aanbevolen maximaal 64 tekens. |
|
|
validityMin
|
validityMin | integer |
Geldigheid van de sms in minuten. Wanneer 0 de standaardwaarde van de provider wordt gebruikt. Anders moeten waarden tussen 5 en 2880 minuten zijn. |
|
|
maxParts
|
maxParts | integer |
Maximaal toegestane onderdelen in een bericht met meerdere delen. Waarden moeten tussen 1 en 20 zijn. Langere berichten worden afgekapt. |
|
|
invalidCharacters
|
invalidCharacters | string |
Definieer hoe ongeldige tekens in sms moeten worden verwerkt. |
|
|
qos
|
qos | string |
Kwaliteit van Dienstverlening. |
|
|
jobPeriod
|
jobPeriod | date-time |
Tijdstempel om te plannen wanneer de SMS-taak moet worden verwerkt (iso-8601). |
|
|
duplicateDetection
|
duplicateDetection | boolean | ||
|
blackoutPeriods
|
blackoutPeriods | array of string | ||
|
Tekst
|
text | True | string |
Foo |
|
Dst
|
dst | True | string | |
|
customerRef
|
customerRef | string |
Aanbevolen maximaal 64 tekens. Telefoonnummer voor mobiele geadresseerde dat standaard wordt gebruikt. |
|
|
blackoutPeriods
|
blackoutPeriods | array of string |
Retouren
- Body
- JobResponse
Definities
JobResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
jobId
|
jobId | string |
JobReport
| Name | Pad | Type | Description |
|---|---|---|---|
|
jobId
|
jobId | string | |
|
Src
|
src | string |
Afzender-id. |
|
encoding
|
encoding | string | |
|
billcode
|
billcode | string | |
|
statusRequested
|
statusRequested | boolean |
Bezorgingsmelding aangevraagd. |
|
flits
|
flash | boolean | |
|
validityMin
|
validityMin | integer |
Geldigheid van de sms in minuten. |
|
customerRef
|
customerRef | string |
Aanbevolen maximaal 64 tekens. |
|
qos
|
qos | string |
Kwaliteit van Dienstverlening. |
|
ontvangstbewijzen
|
receiptTs | date-time |
Tijdstempel die aangeeft wanneer de taak is ontvangen door Retarus (iso-8601). |
|
finishedTs
|
finishedTs | date-time |
Tijdstempel die aangeeft wanneer de SMS de uiteindelijke status heeft ontvangen (iso-8601). |
|
recipientIds
|
recipientIds | array of string |
RecipientReport
| Name | Pad | Type | Description |
|---|---|---|---|
|
smsId
|
smsId | string | |
|
Dst
|
dst | string |
Het mobiele telefoonnummer van de geadresseerde. |
|
processStatus
|
processStatus | string |
Huidige processtatus (zie SMS-statuscodes voor uitgaande status). |
|
status
|
status | string |
Status (zie sms-statuscodes voor uitgaande berichten). |
|
customerRef
|
customerRef | string |
Aanbevolen maximaal 64 tekens. |
|
reden
|
reason | string | |
|
sentTs
|
sentTs | date-time |
Tijdstempel toen de sms werd verzonden (iso-8601). |
|
finishedTs
|
finishedTs | date-time |
Tijdstempel die aangeeft wanneer de sms de uiteindelijke status heeft ontvangen (iso-8601). |
VersionInfoResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
bouwnummer
|
buildNumber | integer | |
|
buildTimestamp
|
buildTimestamp | string | |
|
majeurVersie
|
majorVersion | integer | |
|
minorVersion
|
minorVersion | integer | |
|
versionInfo
|
versionInfo | string | |
|
message
|
message | string |