1. Interface 1.1 Receiver Calling Number Message Text Additional Parameters... 3

Transcription

1 smstrade 2SMS API - Specifications In order to facilitate the sending of automated SMS messages, there is an additional interface available on the HTTP-Gateway which is documented in the following pages. Table of Contents 1. Interface 1.1 Receiver Calling Number Message Text Additional Parameters Examples 2.1 Variant Variant 2 Single delivery Variant 2 Bulk delivery... 6 Page 1 of 6

2 1. Interface The interface offers the simple possibility of sending SMS text messages while an with defined content is delivered to the smstrade 2SMS Gateway. In the event of syntactical errors an error will be sent back to the sender. 1.1 Receiver Calling Number There are two variants for receiver specification: Variant 1 Address Mobile Number @ 2sms.smstrade.de @ 2sms.smstrade.de @ 2sms.smstrade.de Variant 2 Address 2sms@smstrade.de Mobile Number Handed over in the body text message 1.2 Message Text The text of the SMS message is sorted from the subject of the . The following guidelines apply: Maximum length: 153 characters If the length is more than 160 characters the SMS is automatically linked. The message should be sent to the interface UTF-8 encoded. MIME-Header, like that used by Mozilla Thunderbird, will be automatically decoded. Paragraphs in the SMS message can be created using \n. Page 2 of 6

3 1.3 Additional Parameters Control commands for SMS sending are located in the content or body of the message. Distinct sections can be separated using pound signs (#). Important: The message must be composed as a text message and not as a HTML message! clients such as Microsoft Outlook or Mozilla Thunderbird have a menu option for sending the message as "Text or "Only Text". Please find more detailed information in the documentation of your program. The body of the message must have the following format: Variant 1 (Sending via @ 2sms.smstrade.de) #Key#Route #From# Variant 2 (Sending via 2sms@smstrade.de) #Key#To#Route #From# key Parameter Description Example Personal identification code abcdefghijklmnop to from route Your Gateway Key is located in the Customer Center under the section "HTTP Interface". SMS receivers separated by comma The calling numbers of the message receivers with country code. Can also be sent to German numbers with country code. Source identifier With Gold and Direct SMS you can specify your own individual source identifier. This must be contained in 11 alphanumeric characters or up to 16 numeric characters. SMS route Each SMS can be sent via one of the smstrade routes. Please find further information about routes in the Routes Overview in the Customer Center , SMSTRADE basic gold direct Page 3 of 6

4 2. Examples 2.1 Variant 1 Sending via @ 2sms.smstrade.de Page 4 of 6

5 2.2 Variant 2 Single Delivery Sending via 2sms@smstrade.de Page 5 of 6

6 2.3 Variant 2 Bulk Delivery Sending via 2sms@smstrade.de Page 6 of 6