De SMS Works (onafhankelijke uitgever) (preview)
De SMS Works is een goedkope SMS-service voor ontwikkelaars in het Verenigd Koninkrijk. U wordt alleen gefactureerd voor bezorgde sms-berichten.
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 | Troy Taylor |
| URL | https://www.hitachisolutions.com |
| E-mailen | ttaylor@hitachisolutions.com |
| Connectormetagegevens | |
|---|---|
| Uitgever | Troy Taylor |
| Webpagina | https://thesmsworks.co.uk/ |
| Privacybeleid | https://thesmsworks.co.uk/privacy |
| Categorieën | Communication |
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 |
|---|---|---|---|
| JWT-token | beveiligde string | Het JWT-token voor deze API | Klopt |
Beperkingslimieten
| Name | Aanroepen | Verlengingsperiode |
|---|---|---|
| API-aanroepen per verbinding | 100 | 60 seconden |
Acties
| Batch plannen |
Hiermee wordt een batch sms-berichten gepland die moeten worden verzonden op de datum waarop u opgeeft. |
| Batch verzenden |
Eén sms-bericht verzenden naar meerdere geadresseerden. |
| Batchberichten ophalen |
Haal alle berichten in een batch op met de opgegeven batch-id. |
| Bericht ophalen |
Haal een geregistreerd bericht op met de bericht-id. |
| Bericht plannen |
Hiermee wordt een sms-bericht gepland dat moet worden verzonden op de datum/tijd die u opgeeft. |
| Bericht verwijderen |
Verwijder het bericht met de overeenkomende messageid. |
| Berichten zoeken |
Haal maximaal 1000 berichten op die overeenkomen met uw zoekcriteria. |
| Een sms-bericht verzenden |
Hiermee wordt een sms-bericht verzonden op basis van uw parameters. |
| Flashbericht verzenden |
Hiermee wordt een sms-flashbericht verzonden dat wordt weergegeven op het vergrendelingsscherm van de geadresseerden. |
| Gepland bericht annuleren |
Hiermee wordt een gepland sms-bericht geannuleerd. |
| Geplande batch annuleren |
Hiermee wordt een gepland sms-bericht geannuleerd. |
| Geplande berichten ophalen |
Retourneert een lijst met berichten die zijn gepland vanuit uw account, bestaande uit alle berichten die in de afgelopen drie maanden zijn gepland en eventuele berichten die in de toekomst moeten worden verzonden. |
| Klant-id ophalen |
Retourneert de klant-id naar de beller. |
| Mislukte berichten ophalen |
Haal mislukte berichten op die overeenkomen met uw zoekcriteria. |
| Ongelezen berichten ophalen |
Ongelezen binnenkomende berichten ophalen die overeenkomen met uw zoekcriteria. |
| Tegoed ophalen |
Retourneert het aantal tegoeden dat momenteel beschikbaar is voor het account. |
| Verzameling berichten verzenden |
Hiermee wordt een verzameling unieke SMS-berichten verzonden. Batches kunnen maximaal 5000 berichten tegelijk bevatten. |
Batch plannen
Hiermee wordt een batch sms-berichten gepland die moeten worden verzonden op de datum waarop u opgeeft.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
smsMessage
|
smsMessage | True |
Berichteigenschappen |
Retouren
- response
- ScheduledBatchResponse
Batch verzenden
Eén sms-bericht verzenden naar meerdere geadresseerden.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
smsMessage
|
smsMessage | True |
Berichteigenschappen |
Retouren
- response
- BatchMessageResponse
Batchberichten ophalen
Haal alle berichten in een batch op met de opgegeven batch-id.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Batch-id
|
batchid | True | string |
De id van de batch die u wilt retourneren |
Retouren
- response
- array of MessageResponse
Bericht ophalen
Haal een geregistreerd bericht op met de bericht-id.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Bericht-id
|
messageid | True | string |
De id van het bericht dat u wilt retourneren |
Retouren
- response
- MessageResponse
Bericht plannen
Hiermee wordt een sms-bericht gepland dat moet worden verzonden op de datum/tijd die u opgeeft.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Afzender
|
sender | True | string |
De afzender van het bericht. Mag niet langer zijn dan 11 tekens voor alfanumerieke tekens of 15 tekens voor numerieke afzender-id's. Geen spaties of speciale tekens. |
|
Bestemming
|
destination | True | string |
Telefoonnummer van de geadresseerde |
|
Content
|
content | True | string |
Bericht dat naar de geadresseerde moet worden verzonden. Inhoud mag maximaal 1280 tekens lang zijn. Berichten van 160 tekens of minder worden 1 tegoed in rekening gebracht. Als uw bericht langer is dan 160 tekens, wordt het opgesplitst in segmenten van 153 tekens voordat het naar de handset van de geadresseerde wordt verzonden en wordt er 1 tegoed in rekening gebracht voor elke 153 tekens. Berichten die worden verzonden naar nummers die buiten het Verenigd Koninkrijk zijn geregistreerd, worden doorgaans dubbele tegoeden in rekening gebracht, maar voor bepaalde landen kunnen fracties van tegoeden in rekening worden gebracht (bijvoorbeeld 2,5). Neem contact met ons op voor tarieven voor elk land. |
|
URL van leveringsrapport
|
deliveryreporturl | string |
De URL waarnaar we post-bezorgingsrapporten voor dit bericht moeten verzenden. Als er geen is opgegeven, gebruiken we de URL van het globale leveringsrapport die u hebt geconfigureerd op uw accountpagina. |
|
|
Schema
|
schedule | string |
Datum waarop het bericht moet worden verzonden. Dit wordt alleen gebruikt door de berichten-/planningsservice en kan leeg blijven voor andere services. |
|
|
Tag
|
tag | string |
Een identificatielabel voor het bericht, dat u kunt gebruiken om berichten te filteren en te rapporteren die u later hebt verzonden. Ideaal voor campagnes. Maximaal 280 tekens. |
|
|
TTL
|
ttl | number |
Het optionele aantal minuten voordat het leveringsrapport wordt verwijderd. Optional. Weglaten om te voorkomen dat het bezorgingsrapport wordt verwijderd. |
|
|
Antwoord-e-mail
|
responseemail | array of string |
Een optionele lijst met e-mailadressen voor het doorsturen van antwoorden naar dit specifieke bericht. Een SMS Works-antwoordnummer is vereist om deze functie te kunnen gebruiken. |
|
|
Metagegevens
|
Metadata | object | ||
|
Geldigheid
|
validity | number |
Het optionele aantal minuten dat moet worden bezorgd voordat het bericht is gemarkeerd als VERLOPEN. Optional. De standaardwaarde is 2880 minuten. |
Retouren
- response
- array of ScheduledMessageResponse
Bericht verwijderen
Verwijder het bericht met de overeenkomende messageid.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Bericht-id
|
messageid | True | string |
De id van het bericht dat u wilt retourneren |
Retouren
- response
- DeletedMessageResponse
Berichten zoeken
Haal maximaal 1000 berichten op die overeenkomen met uw zoekcriteria.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
query
|
query | True |
Retouren
- response
- array of MessageResponse
Een sms-bericht verzenden
Hiermee wordt een sms-bericht verzonden op basis van uw parameters.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Afzender
|
sender | True | string |
De afzender van het bericht. Mag niet langer zijn dan 11 tekens voor alfanumerieke tekens of 15 tekens voor numerieke afzender-id's. Geen spaties of speciale tekens. |
|
Bestemming
|
destination | True | string |
Telefoonnummer van de geadresseerde |
|
Content
|
content | True | string |
Bericht dat naar de geadresseerde moet worden verzonden. Inhoud mag maximaal 1280 tekens lang zijn. Berichten van 160 tekens of minder worden 1 tegoed in rekening gebracht. Als uw bericht langer is dan 160 tekens, wordt het opgesplitst in segmenten van 153 tekens voordat het naar de handset van de geadresseerde wordt verzonden en wordt er 1 tegoed in rekening gebracht voor elke 153 tekens. Berichten die worden verzonden naar nummers die buiten het Verenigd Koninkrijk zijn geregistreerd, worden doorgaans dubbele tegoeden in rekening gebracht, maar voor bepaalde landen kunnen fracties van tegoeden in rekening worden gebracht (bijvoorbeeld 2,5). Neem contact met ons op voor tarieven voor elk land. |
|
URL van leveringsrapport
|
deliveryreporturl | string |
De URL waarnaar we post-bezorgingsrapporten voor dit bericht moeten verzenden. Als er geen is opgegeven, gebruiken we de URL van het globale leveringsrapport die u hebt geconfigureerd op uw accountpagina. |
|
|
Schema
|
schedule | string |
Datum waarop het bericht moet worden verzonden. Dit wordt alleen gebruikt door de berichten-/planningsservice en kan leeg blijven voor andere services. |
|
|
Tag
|
tag | string |
Een identificatielabel voor het bericht, dat u kunt gebruiken om berichten te filteren en te rapporteren die u later hebt verzonden. Ideaal voor campagnes. Maximaal 280 tekens. |
|
|
TTL
|
ttl | number |
Het optionele aantal minuten voordat het leveringsrapport wordt verwijderd. Optional. Weglaten om te voorkomen dat het bezorgingsrapport wordt verwijderd. |
|
|
Antwoord-e-mail
|
responseemail | array of string |
Een optionele lijst met e-mailadressen voor het doorsturen van antwoorden naar dit specifieke bericht. Een SMS Works-antwoordnummer is vereist om deze functie te kunnen gebruiken. |
|
|
Metagegevens
|
Metadata | object | ||
|
Geldigheid
|
validity | number |
Het optionele aantal minuten dat moet worden bezorgd voordat het bericht is gemarkeerd als VERLOPEN. Optional. De standaardwaarde is 2880 minuten. |
Retouren
- response
- SendMessageResponse
Flashbericht verzenden
Hiermee wordt een sms-flashbericht verzonden dat wordt weergegeven op het vergrendelingsscherm van de geadresseerden.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Afzender
|
sender | True | string |
De afzender van het bericht. Mag niet langer zijn dan 11 tekens voor alfanumerieke tekens of 15 tekens voor numerieke afzender-id's. Geen spaties of speciale tekens. |
|
Bestemming
|
destination | True | string |
Telefoonnummer van de geadresseerde |
|
Content
|
content | True | string |
Bericht dat naar de geadresseerde moet worden verzonden. Inhoud mag maximaal 1280 tekens lang zijn. Berichten van 160 tekens of minder worden 1 tegoed in rekening gebracht. Als uw bericht langer is dan 160 tekens, wordt het opgesplitst in segmenten van 153 tekens voordat het naar de handset van de geadresseerde wordt verzonden en wordt er 1 tegoed in rekening gebracht voor elke 153 tekens. Berichten die worden verzonden naar nummers die buiten het Verenigd Koninkrijk zijn geregistreerd, worden doorgaans dubbele tegoeden in rekening gebracht, maar voor bepaalde landen kunnen fracties van tegoeden in rekening worden gebracht (bijvoorbeeld 2,5). Neem contact met ons op voor tarieven voor elk land. |
|
URL van leveringsrapport
|
deliveryreporturl | string |
De URL waarnaar we post-bezorgingsrapporten voor dit bericht moeten verzenden. Als er geen is opgegeven, gebruiken we de URL van het globale leveringsrapport die u hebt geconfigureerd op uw accountpagina. |
|
|
Schema
|
schedule | string |
Datum waarop het bericht moet worden verzonden. Dit wordt alleen gebruikt door de berichten-/planningsservice en kan leeg blijven voor andere services. |
|
|
Tag
|
tag | string |
Een identificatielabel voor het bericht, dat u kunt gebruiken om berichten te filteren en te rapporteren die u later hebt verzonden. Ideaal voor campagnes. Maximaal 280 tekens. |
|
|
TTL
|
ttl | number |
Het optionele aantal minuten voordat het leveringsrapport wordt verwijderd. Optional. Weglaten om te voorkomen dat het bezorgingsrapport wordt verwijderd. |
|
|
Antwoord-e-mail
|
responseemail | array of string |
Een optionele lijst met e-mailadressen voor het doorsturen van antwoorden naar dit specifieke bericht. Een SMS Works-antwoordnummer is vereist om deze functie te kunnen gebruiken. |
|
|
Metagegevens
|
Metadata | object | ||
|
Geldigheid
|
validity | number |
Het optionele aantal minuten dat moet worden bezorgd voordat het bericht is gemarkeerd als VERLOPEN. Optional. De standaardwaarde is 2880 minuten. |
Retouren
- response
- SendMessageResponse
Gepland bericht annuleren
Hiermee wordt een gepland sms-bericht geannuleerd.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Bericht-id
|
messageid | True | string |
De id van het bericht dat u wilt retourneren |
Retouren
- response
- CancelledMessageResponse
Geplande batch annuleren
Hiermee wordt een gepland sms-bericht geannuleerd.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Batch-id
|
batchid | True | string |
De id van de batch die u wilt retourneren |
Retouren
- response
- CancelledMessageResponse
Geplande berichten ophalen
Retourneert een lijst met berichten die zijn gepland vanuit uw account, bestaande uit alle berichten die in de afgelopen drie maanden zijn gepland en eventuele berichten die in de toekomst moeten worden verzonden.
Retouren
details van een bericht dat moet worden verzonden op een opgegeven datum en tijd
- response
- ScheduledMessagesResponse
Klant-id ophalen
Mislukte berichten ophalen
Haal mislukte berichten op die overeenkomen met uw zoekcriteria.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
query
|
query | True |
Retouren
- response
- array of MessageResponse
Ongelezen berichten ophalen
Ongelezen binnenkomende berichten ophalen die overeenkomen met uw zoekcriteria.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
query
|
query | True |
Retouren
- response
- array of MessageResponse
Tegoed ophalen
Retourneert het aantal tegoeden dat momenteel beschikbaar is voor het account.
Retouren
- response
- CreditsResponse
Verzameling berichten verzenden
Hiermee wordt een verzameling unieke SMS-berichten verzonden. Batches kunnen maximaal 5000 berichten tegelijk bevatten.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
messages
|
messages | True |
Een matrix met berichten |
Retouren
- response
- BatchMessageResponse
Definities
TestResponse
CreditsResponse
ScheduledMessagesResponse
details van een bericht dat moet worden verzonden op een opgegeven datum en tijd
details van een bericht dat moet worden verzonden op een opgegeven datum en tijd