The SMS Works API
  1. auth
The SMS Works API
  • auth
    • /auth/getApiKey
      GET
    • /auth/token
      POST
  • batch messages
    • /batch/schedule
      POST
    • /batch/send
      POST
    • /batch/{batchid}
      GET
    • /batches/schedule/{batchid}
      DELETE
  • credits
    • /credits/balance
      GET
  • messages
    • /message/flash
      POST
    • /message/schedule
      POST
    • /message/send
      POST
    • /messages
      POST
    • /messages/failed
      POST
    • /messages/inbox
      POST
    • /messages/schedule/{messageid}
      DELETE
    • /messages/{messageid}
      DELETE
    • /messages/{messageid}
      GET
  • utils
    • /utils/errors/{errorcode}
      GET
    • /utils/test
      GET
  1. auth

/auth/getApiKey

GET
/auth/getApiKey
auth
Utility method. Please generate your API key by following the instructions on your account page at https://thesmsworks.co.uk/user/login
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.thesmsworks.co.uk/v1/auth/getApiKey?customerid='
Response Response Example
200 - Example 1
{
    "message": "string",
    "errorCode": 0,
    "permanent": true,
    "status": "string"
}

Request

Query Params
customerid
string 
required
Utility method. Please generate your API key by following the instructions on your account page at https://thesmsworks.co.uk/user/login

Responses

🟢200Error
application/json
Body
message
string 
required
errorCode
number 
required
Numeric code used to identify the error. Integer.
permanent
boolean 
optional
status
string 
required
🟢201Success
Modified at 2022-09-11 19:34:57
Next
/auth/token
Built with