Messaging API. API Specification Document Messaging API. Functionality: Send SMS Messages.

Transcription

1 Functionality: Send SMS Messages. This gateway can be accessed via the HTTP or HTTPs Protocol by submitting values to the API server and can be used to send simple text messages to single or multiple mobile numbers with each request. Protocol The 5cSMS API receives API Requests through the HTTP Protocol and will accept a or POST request with the required parameters. Most programming languages have modules, which facilitate creating and executing such a request. Once a request is received the server will respond to advise the status of the request and various details that can be used interpreted by your software and/or stored for future use, such as a Message ID or Account Balance. URI The can be accessed by calling either of the following URIs; or Digital Signature (Optional) beta Rather than provide your password as part of your request you can use a digital signature of Hash to authenticate. This signature is a hash using parts of your message and a unique private key. To generate your hash you should concatenate you message text (before it is encoded) with the destination number string and your private key then create an MD5 hash from this string. The resulting hash is your digital signature. To receive your private key you should contact service@5centsms.com.au Message To Private Key Hash Digital Signature Hello abc123 MD5( Hello abc123 ) = dafl3jaf34asb Hello , abc123 MD5( Hello , abc123 ) = Ifvewyf8734g

2 Request Parameters The following parameters must be assigned values and passed to the API on a per request basis; Parameter Details Example username Your login/username (usually user@5centsms.com.au your address) password Your password password digitalsignature (optional) See Digital Signature section above to The destination mobile , number. To send the same message to multiple mobile numbers each separate mobile number must be separated by a comma "," and a maximum of 399 separate numbers can be specified in a single request. sender The name or number of the SMS sender. Can be up to 11 alphanumeric characters or up to 15 numerical characters message reply (Optional) The message parameter refers to the actual message that is to be sent to the destination mobile number. The message can contain a maximum of 612* characters, including spaces. Due to restrictions in the HTTP protocol format, special characters must be encoded. We recommend using an in- built function to encode your message text. *Messages > 160 characters are charged as multipart messages. This parameter can be used to set any replies to be forwarded to your registered and our Reply Notification API. This option will invalidate the sender parameter. NOTE Setting the reply parameter to api will also enable notifications. this%20is%20a%20test. api

3 Response Parameters Once your message has been submitted to the API you will receive feedback in the HTTP response as to the success of the transmission and a number of values. These values can be used and/or stored by your application. These values will always be separated by a character. For Example: A B C or A C or A B For the the status of each destination number in your request will be separated by a new line character and a HTML break tag. Parameter Details Examples Status 0: Request Rejected 1: Sent 1 2 2: Failed Destination The destination number for this message aa Message ID Unique message identifier Notes AccountBalance Notes providing further information on a messages status The current balance of your account. (The number of messages remaining) Postpaid accounts will return a negative number. OK Invalid Destination Number

4 Example Request and Responses Sending a Single SMS /api/send.php?username=test@5centsms.com.au&password=testpassword&sender= &to= &message=this%20is% 20a%20test HTTP/1.1 Date: Sun, 16 Jan :09:10 GMT OK<br> Sending a Bulk SMS /api/send.php?username=test@5centsms.com.au&password=testpassword&sender= &to= , &messag e= this%20is%20a%20test HTTP/1.1 Date: Sun, 16 Jan :11:09 GMT OK<br> OK<br> Sending an SMS to Receive a Response by /API /api/send.php?username=test@5centsms.com.au&password=testpassword&sender= &to= &message=this%20is% 20a%20test&reply= HTTP/1.1

5 Date: Sun, 16 Jan :09:10 GMT OK<br>