The SMS Works (Independent Publisher) (Preview)

  • Reference

The SMS Works is a low cost SMS service for developers based in the UK. You are only billed for delivered text messages.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Troy Taylor
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
Connector Metadata
Publisher Troy Taylor
Website https://thesmsworks.co.uk/
Privacy policy https://thesmsworks.co.uk/privacy
Categories Communication

Creating a connection

The connector supports the following authentication types:
Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
JWT Token securestring The JWT Token for this api True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Cancel scheduled batch

Cancels a scheduled SMS message.
Cancel scheduled message

Cancels a scheduled SMS message.
Delete message

Delete the message with the matching messageid.
Get credits

Returns the number of credits currently available on the account.
Get customer ID

Returns the customer ID to the caller.
Get failed messages

Retrieve failed messages matching your search criteria.
Get message

Retrieve a logged message by the message ID.
Get scheduled messages

Returns a list of messages scheduled from your account, comprising any messages scheduled in the last 3 months and any scheduled to send in the future.
Get unread messages

Get unread incoming messages matching your search criteria.
Retrieve batch messages

Retrieve all messages in a batch with the given batch ID.
Schedule batch

Schedules a batch of SMS messages to be sent at the date time you specify.
Schedule message

Schedules an SMS message to be sent at the date-time you specify.
Search messages

Retrieve up to 1000 messages matching your search criteria.
Send an SMS message

Sends an SMS message based on your parameters.
Send batch

Send a single SMS message to multiple recipients.
Send collection of messages

Sends a collection of unique SMS messages. Batches may contain up to 5000 messages at a time.
Send flash message

Sends an SMS flash message, which appears on the recipients lock screen.

Cancel scheduled batch

Operation ID:
CancelScheduledBatchJob

Cancels a scheduled SMS message.

Parameters

Name Key Required Type Description
Batch ID
 batchid True string

The ID of the batch you would like returned

Returns

response
CancelledMessageResponse

Cancel scheduled message

Operation ID:
CancelScheduledJob

Cancels a scheduled SMS message.

Parameters

Name Key Required Type Description
Message ID
 messageid True string

The ID of the message you would like returned

Returns

response
CancelledMessageResponse

Delete message

Operation ID:
DeleteMessage

Delete the message with the matching messageid.

Parameters

Name Key Required Type Description
Message ID
 messageid True string

The ID of the message you would like returned

Returns

response
DeletedMessageResponse

Get credits

Operation ID:
Credits

Returns the number of credits currently available on the account.

Returns

response
CreditsResponse

Get customer ID

Operation ID:
Test

Returns the customer ID to the caller.

Returns

response
TestResponse

Get failed messages

Operation ID:
GetFailedMessages

Retrieve failed messages matching your search criteria.

Parameters

Name Key Required Type Description
query
 query True

Returns

response
array of MessageResponse

Get message

Operation ID:
GetMessageById

Retrieve a logged message by the message ID.

Parameters

Name Key Required Type Description
Message ID
 messageid True string

The ID of the message you would like returned

Returns

response
MessageResponse

Get scheduled messages

Operation ID:
GetScheduledMessages

Returns a list of messages scheduled from your account, comprising any messages scheduled in the last 3 months and any scheduled to send in the future.

Returns

details of a message scheduled to be sent at a specified date and time

response
ScheduledMessagesResponse

Get unread messages

Operation ID:
GetInboxMessages

Get unread incoming messages matching your search criteria.

Parameters

Name Key Required Type Description
query
 query True

Returns

response
array of MessageResponse

Retrieve batch messages

Operation ID:
GetBatchById

Retrieve all messages in a batch with the given batch ID.

Parameters

Name Key Required Type Description
Batch ID
 batchid True string

The ID of the batch you would like returned

Returns

response
array of MessageResponse

Schedule batch

Operation ID:
ScheduleBatch

Schedules a batch of SMS messages to be sent at the date time you specify.

Parameters

Name Key Required Type Description
smsMessage
 smsMessage True

Message properties

Returns

response
ScheduledBatchResponse

Schedule message

Operation ID:
ScheduleMessage

Schedules an SMS message to be sent at the date-time you specify.

Parameters

Name Key Required Type Description
Sender
 sender True string

The sender of the message. Should be no longer than 11 characters for alphanumeric or 15 characters for numeric sender ID's. No spaces or special characters.
Destination
 destination True string

Telephone number of the recipient
Content
 content True string

Message to send to the recipient. Content can be up to 1280 characters in length. Messages of 160 characters or fewer are charged 1 credit. If your message is longer than 160 characters then it will be broken down in to chunks of 153 characters before being sent to the recipient's handset, and you will be charged 1 credit for each 153 characters. Messages sent to numbers registered outside the UK will be typically charged double credits, but for certain countries may be charged fractions of credits (e.g. 2.5). Please contact us for rates for each country.
Delivery Report URL
 deliveryreporturl string

The url to which we should POST delivery reports to for this message. If none is specified, we'll use the global delivery report URL that you've configured on your account page.
Schedule
 schedule string

Date at which to send the message. This is only used by the message/schedule service and can be left empty for other services.
Tag
 tag string

An identifying label for the message, which you can use to filter and report on messages you've sent later. Ideal for campaigns. A maximum of 280 characters.
TTL
 ttl number

The optional number of minutes before the delivery report is deleted. Optional. Omit to prevent delivery report deletion.
Response Email
 responseemail array of string

An optional list of email addresses to forward responses to this specific message to. An SMS Works Reply Number is required to use this feature.
Metadata
 Metadata object
Validity
 validity number

The optional number of minutes to attempt delivery before the message is marked as EXPIRED. Optional. The default is 2880 minutes.

Returns

response
array of ScheduledMessageResponse

Search messages

Operation ID:
GetMessages

Retrieve up to 1000 messages matching your search criteria.

Parameters

Name Key Required Type Description
query
 query True

Returns

response
array of MessageResponse

Send an SMS message

Operation ID:
SendMessage

Sends an SMS message based on your parameters.

Parameters

Name Key Required Type Description
Sender
 sender True string

The sender of the message. Should be no longer than 11 characters for alphanumeric or 15 characters for numeric sender ID's. No spaces or special characters.
Destination
 destination True string

Telephone number of the recipient
Content
 content True string

Message to send to the recipient. Content can be up to 1280 characters in length. Messages of 160 characters or fewer are charged 1 credit. If your message is longer than 160 characters then it will be broken down in to chunks of 153 characters before being sent to the recipient's handset, and you will be charged 1 credit for each 153 characters. Messages sent to numbers registered outside the UK will be typically charged double credits, but for certain countries may be charged fractions of credits (e.g. 2.5). Please contact us for rates for each country.
Delivery Report URL
 deliveryreporturl string

The url to which we should POST delivery reports to for this message. If none is specified, we'll use the global delivery report URL that you've configured on your account page.
Schedule
 schedule string

Date at which to send the message. This is only used by the message/schedule service and can be left empty for other services.
Tag
 tag string

An identifying label for the message, which you can use to filter and report on messages you've sent later. Ideal for campaigns. A maximum of 280 characters.
TTL
 ttl number

The optional number of minutes before the delivery report is deleted. Optional. Omit to prevent delivery report deletion.
Response Email
 responseemail array of string

An optional list of email addresses to forward responses to this specific message to. An SMS Works Reply Number is required to use this feature.
Metadata
 Metadata object
Validity
 validity number

The optional number of minutes to attempt delivery before the message is marked as EXPIRED. Optional. The default is 2880 minutes.

Returns

response
SendMessageResponse

Send batch

Operation ID:
SendBatch

Send a single SMS message to multiple recipients.

Parameters

Name Key Required Type Description
smsMessage
 smsMessage True

Message properties

Returns

response
BatchMessageResponse

Send collection of messages

Operation ID:
SendAny

Sends a collection of unique SMS messages. Batches may contain up to 5000 messages at a time.

Parameters

Name Key Required Type Description
messages
 messages True

An array of messages

Returns

response
BatchMessageResponse

Send flash message

Operation ID:
SendFlashMessage

Sends an SMS flash message, which appears on the recipients lock screen.

Parameters

Name Key Required Type Description
Sender
 sender True string

The sender of the message. Should be no longer than 11 characters for alphanumeric or 15 characters for numeric sender ID's. No spaces or special characters.
Destination
 destination True string

Telephone number of the recipient
Content
 content True string

Message to send to the recipient. Content can be up to 1280 characters in length. Messages of 160 characters or fewer are charged 1 credit. If your message is longer than 160 characters then it will be broken down in to chunks of 153 characters before being sent to the recipient's handset, and you will be charged 1 credit for each 153 characters. Messages sent to numbers registered outside the UK will be typically charged double credits, but for certain countries may be charged fractions of credits (e.g. 2.5). Please contact us for rates for each country.
Delivery Report URL
 deliveryreporturl string

The url to which we should POST delivery reports to for this message. If none is specified, we'll use the global delivery report URL that you've configured on your account page.
Schedule
 schedule string

Date at which to send the message. This is only used by the message/schedule service and can be left empty for other services.
Tag
 tag string

An identifying label for the message, which you can use to filter and report on messages you've sent later. Ideal for campaigns. A maximum of 280 characters.
TTL
 ttl number

The optional number of minutes before the delivery report is deleted. Optional. Omit to prevent delivery report deletion.
Response Email
 responseemail array of string

An optional list of email addresses to forward responses to this specific message to. An SMS Works Reply Number is required to use this feature.
Metadata
 Metadata object
Validity
 validity number

The optional number of minutes to attempt delivery before the message is marked as EXPIRED. Optional. The default is 2880 minutes.

Returns

response
SendMessageResponse

Definitions

TestResponse

CreditsResponse

ScheduledMessagesResponse

details of a message scheduled to be sent at a specified date and time

details of a message scheduled to be sent at a specified date and time

SendMessageResponse

ScheduledMessageResponse

ScheduledBatchResponse

CancelledMessageResponse

DeletedMessageResponse

BatchMessageResponse

MessageResponse