|
|
| This URL should be used with the input parameters |
| http://sms1.cardboardfish.com:9001/HTTPSMS? |
| This table lists each parameter that can be submitted to the URL given above. All of these parameters are required to send an SMS. Please see the HTTPSMS Protocol Specification (PDF) for optional parameters.
|
| Parameter |
Name |
Description |
Example Values |
| S |
System Type |
Must be set to value: H
|
H |
| UN |
Username |
Account username (case sensitive) |
user01 |
| P |
Password |
Account password (case sensitive) |
pass1 |
| DA |
Destination Address |
Destination mobile number in international format without + prefix. Up to 10 different numbers can be supplied separated by commas. |
447973123456 or 447875622322, 34610842235 |
| SA |
Source Address |
Originator address (sender id). Up to 16 numeric or 11 alphanumeric characters. |
CBF or 447973123456 or 8040 |
| M |
Message |
The SMS text for plain messages or UCS2 hex for Unicode. For binary, hex encoded 8-bit data. |
Please call me at the office. |
| ST (recommended) |
Source Address Type of Number (TON) |
Controls the type of originator where:
1=International numeric
0=National numeric
5=Aplhanumeric
|
See section 5.4 in the HTTPSMS Protocol Specification (PDF) |
| Example URL with all required parameters |
| http://sms1.cardboardfish.com:9001/HTTPSMS?S=H&UN=user01&P=pass1&DA=447973
123456&SA=CBF&M=Please%20call%20me%20at%20the%20office. |
| Successful Response: |
| HTTP Header |
200 OK |
| Content |
OK messageid1[ messageidn][ UR:userreference] |
|
| Error Response: |
| Error Response: Invalid Username |
| HTTP Header |
401 Unauthorized |
| Content |
ERR -10 |
| Error Response: Invalid Destination or Destination Not Covered |
| HTTP Header |
503 Service Unavailable |
| Content |
ERR -15 |
| Error Response: Not Enough Credit |
| HTTP Header |
402 Payment Required |
| Content |
ERR -5 |
| Error Response: System Error, Please Retry |
| HTTP Header |
500 Internal Server Error |
| Content |
ERR -20 |
| Error Response: Request Error, Do Not Retry |
| HTTP Header |
400 Bad Request |
| Content |
ERR -25 |
|
|
|