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

Query

search parameters for querying the message database

{
    "credits": 2,
    "destination": "447777777777",
    "from": "Wed Jul 12 2017 20:26:28 GMT+0100 (BST)",
    "keyword": "SKYWALKER",
    "metadata": [
        {
            "key": "myKey1",
            "value": "myValue1"
        },
        {
            "key": "myKey2",
            "value": "myValue2"
        }
    ],
    "sender": "YourCompany",
    "status": "SENT",
    "to": "Wed Jul 19 2017 20:26:28 GMT+0100 (BST)",
    "unread": true
}
Built with