POST | /sms | Creates and new SmS and adds a log entry to the sms log |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
SmsNumber | body | string | Yes | The SMS number. |
SmsMessage | body | string | Yes | The SMS Message. |
CollectionAttemptID | body | Guid | No | The Collection Attempt Id. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Success | form | bool | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /sms HTTP/1.1
Host: api.paylock.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"smsNumber":"String","smsMessage":"String","collectionAttemptID":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"success":false}