BootView WebApi

<back to all web services

CreateSms

The following routes are available for this service:
POST/smsCreates and new SmS and adds a log entry to the sms log
CreateSms Parameters:
NameParameterData TypeRequiredDescription
SmsNumberbodystringYesThe SMS number.
SmsMessagebodystringYesThe SMS Message.
CollectionAttemptIDbodyGuidNoThe Collection Attempt Id.
CreateSmsResult Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /csv/reply/CreateSms HTTP/1.1 
Host: api.paylock.com 
Content-Type: text/csv
Content-Length: length

{"smsNumber":"String","smsMessage":"String","collectionAttemptID":"00000000000000000000000000000000"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"success":false}