The SMS Works API
  1. Schemas
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
    • /message/schedule
    • /message/send
    • /messages
    • /messages/failed
    • /messages/inbox
    • /messages/schedule/{messageid}
    • /messages/{messageid}
    • /messages/{messageid}
  • utils
    • /utils/errors/{errorcode}
    • /utils/test
  • Schemas
    • Schemas
      • BatchMessage
      • BatchMessageResponse
      • CancelledMessageResponse
      • CreditsResponse
      • DeletedMessageResponse
      • ErrorModel
      • ExtendedErrorModel
      • Login
      • Message
      • MessageResponse
      • MetaData
      • Query
      • ScheduledBatchResponse
      • ScheduledMessageResponse
      • SendMessageResponse
      • TestResponse
      • TokenResponse
      • apiKeyResponse
  1. Schemas

Message

SMS message object

{
    "content": "Your super awesome message",
    "deliveryreporturl": "http://your.domain.com/delivery/report/path",
    "destination": "447777777777",
    "metadata": [
        {
            "key": "myKey1",
            "value": "myValue1"
        },
        {
            "key": "myKey2",
            "value": "myValue2"
        }
    ],
    "responseemail": [
        "my.email@mycompany.co.uk",
        "my.other.email@mycompany.co.uk"
    ],
    "schedule": "Sun Sep 03 2020 15:34:23 GMT+0100 (BST)",
    "sender": "YourCompany",
    "tag": "SummerSpecial",
    "ttl": 10
}
Built with