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

/batch/schedule

POST
/batch/schedule
Schedules a batch of SMS messages to be sent at the date time you specify
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.thesmsworks.co.uk/v1/batch/schedule' \
--header 'Content-Type: application/json' \
--data-raw '{
    "content": "My super awesome batch message",
    "deliveryreporturl": "http://your.domain.com/delivery/report/path",
    "destinations": [
        "447777777777",
        "447777777778",
        "447777777779"
    ],
    "schedule": "Wed Jul 19 2017 20:26:28 GMT+0100 (BST)",
    "sender": "YourCompany",
    "tag": "SummerSpecial",
    "ttl": 10
}'
Response Response Example
200 - Example 1
{
    "message": "string",
    "errorCode": 0,
    "permanent": true,
    "status": "string"
}

Request

Body Params application/json

Examples

Responses

🟢200Error
application/json
Body

🟢201Success
Modified at 2022-09-11 19:34:57
Previous
/auth/token
Next
/batch/send
Built with