The SMS Works API
  1. utils
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. utils

/utils/errors/{errorcode}

GET
/utils/errors/{errorcode}
utils
Returns a sample error object for the given error code. Useful for designing code to react to errors when they occur for real.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.thesmsworks.co.uk/v1/utils/errors/'
Response Response Example
{
    "message": "string",
    "errorCode": 0,
    "permanent": true,
    "status": "string"
}

Request

Path Params
errorcode
string 
required
The code of the error you would like returned

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
Modified at 2022-09-11 19:34:57
Previous
/messages/{messageid}
Next
/utils/test
Built with