Thesmsworks
The SMS Works is an SMS messaging API and gateway for sending and managing text messages.
- Base URL:
https://api.thesmsworks.co.uk/v1 - Auth:
header:Authorization(pass your key via theapiKeyinput)
Operations
get_batch_batchid— GET /batch/{batchid} — Retrieve all messages in a batch with the given batch IDget_credits_balance— GET /credits/balance — Returns the number of credits currently available on the accountget_messages_schedule— GET /messages/schedule — Returns a list of messages scheduled from your account, comprising any messagesget_messages_messageid— GET /messages/{messageid} — Retrieve a logged message by the message IDget_utils_errors_errorcode— GET /utils/errors/{errorcode} — Returns a sample error object for the given error code. Useful for designing codget_utils_test— GET /utils/test — Returns the customer ID to the caller
Inputs
apiKey— your thesmsworks API keyoperation— one of the operations above- path parameters when an operation's path contains
{...} query— optional JSON object of query paramsbody— JSON object for create/update ops
Example
operation: get_batch_batchid
apiKey: <your key>
Publishes
The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.
erroroperationresultstatus
Input Properties
Every property this tool accepts, from its own tool.iml.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
apiKey |
string | yes | — | DEPRECATED — bind an API Key credential to the task with credentialName instead. A key pasted here is stored in the workflow definition in clear and appears in every export of it. Still honoured for workflows built before the change. |
operation |
string | yes | — | One of: get_batch_batchid, get_credits_balance, get_messages_schedule, get_messages_messageid, get_utils_errors_errorcode, get_utils_test |
batchid |
string | no | — | Path parameter batchid (required by some operations). |
errorcode |
string | no | — | Path parameter errorcode (required by some operations). |
messageid |
string | no | — | Path parameter messageid (required by some operations). |
query |
string | no | — | Query-string parameters as a JSON object string, e.g. {"limit": 50}. Parsed and url-encoded onto the request. |