# The SMS Works API

## API Docs
- auth [/auth/getApiKey](https://ch7kuloxkk.apidog.io/api-3531425.md): Utility method. Please generate your API key by following the instructions on your account page at https://thesmsworks.co.uk/user/login
- auth [/auth/token](https://ch7kuloxkk.apidog.io/api-3531413.md): Generates a JSON Web Token for including in the Authorization header of all your calls to the API. This only needs to be done once. Generate the customer ID, API Key & Secret required for this call from the API Key tab your account page.
- batch messages [/batch/schedule](https://ch7kuloxkk.apidog.io/api-3531418.md): Schedules a batch of SMS messages to be sent at the date time you specify
- batch messages [/batch/send](https://ch7kuloxkk.apidog.io/api-3531417.md): Send a single SMS message to multiple recipients
- batch messages [/batch/{batchid}](https://ch7kuloxkk.apidog.io/api-3531424.md): Retrieve all messages in a batch with the given batch ID
- batch messages [/batches/schedule/{batchid}](https://ch7kuloxkk.apidog.io/api-3531412.md): Cancels a scheduled SMS message
- credits [/credits/balance](https://ch7kuloxkk.apidog.io/api-3531410.md): Returns the number of credits currently available on the account
- messages [/message/flash](https://ch7kuloxkk.apidog.io/api-3531423.md): Sends an SMS flash message, which appears on the recipients lock screen
- messages [/message/schedule](https://ch7kuloxkk.apidog.io/api-3531414.md): Schedules an SMS message to be sent at the date-time you specify
- messages [/message/send](https://ch7kuloxkk.apidog.io/api-3531426.md): Send an SMS Message
- messages [/messages](https://ch7kuloxkk.apidog.io/api-3531419.md): Retrieve up to 1000 messages matching your search criteria
- messages [/messages/failed](https://ch7kuloxkk.apidog.io/api-3531420.md): Get failed messages matching your search criteria
- messages [/messages/inbox](https://ch7kuloxkk.apidog.io/api-3531427.md): Get unread uncoming messages matching your search criteria
- messages [/messages/schedule/{messageid}](https://ch7kuloxkk.apidog.io/api-3531415.md): Cancels a scheduled SMS message
- messages [/messages/{messageid}](https://ch7kuloxkk.apidog.io/api-3531421.md): Delete the message with the mathcing messageid
- messages [/messages/{messageid}](https://ch7kuloxkk.apidog.io/api-3531422.md): Retrieve a logged message by the message ID
- utils [/utils/errors/{errorcode}](https://ch7kuloxkk.apidog.io/api-3531411.md): Returns a sample error object for the given error code. Useful for designing code to react to errors when they occur for real.
- utils [/utils/test](https://ch7kuloxkk.apidog.io/api-3531416.md): Returns the customer ID to the caller