The SMS Works API
Schemas
Copy Page
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
Schemas
Copy Page
SendMessageResponse
{
"credits"
:
180
,
"creditsUsed"
:
2
,
"messageid"
:
123456789
,
"status"
:
"SENT"
}