Spryng Making Business Mobile Mobile Terminated Premium SMS Gateway. Contents:

Transcription

1 Mobile Terminated Premium SMS Gateway Contents: 1. Connecting to the gateway 2. Parameters 3. Return Values 4. Delivery Reports 5. Field types 6. Networkcode 7. Example API

2 1. Connecting to the gateway Access to the gateway is via the Internet. The web address is: When signing up for an account on you will choose a Username and Password that is specific to your account. Valid method to connect to the gateway is POST with a Content- Type of application/xwww- form- urlencoded. You can also use https 2. Parameters (parameter name = Case sensitive): USERNAME PASSWORD REFERENCE DESTINATION SENDER BODY TARIFF SHORTCODE KEYWORD NETWORKCODE Unique reference for delivery reports Destination Number(s) Originator address Content of SMS Amount to be charged to recipient incl VAT (Premium SMS) Shortcode over which the MT Premium SMS is sent. Keyword of associated MO message. Mobile operators netwerkcode. See appendix E. USERNAME Type: Alphanumeric, Case sensitive Min length: 2 Max length: 32 Example: USERNAME=username

3 PASSWORD Type: Alphanumeric, Case sensitive Min length: 6 Max length: 32 Example: PASSWORD=password REFERENCE Unique reference for delivery reports Required: Only if you want to receive delivery reports Type: Alphanumeriek Min length: 1 Max length: 25 Example: REFERENCE= abc123 Remarks: Must be unique DESTINATION Destination Number(s) Type: MSISDN- numeric (international format without leading 00 or + ) Min length: 1 MSISDN Max length: MSISDN Example: DESTINATION= , Remarks: More details on error handling in chapter 3 on result values

4 SENDER Originator address Type: Numeric or Alphanumeric Min length: 1 Max length: 14 for Numeric or 11 for Alphanumeric Example: SENDER= SENDER=Your name Remarks: For alphanumeric only the characters a- z, A- Z, 0-9 are supported BODY Content of SMS Type: GSM 7- bit alphabet for text message. Min length: 1 Max length: 160 chars for text message Example: BODY=This%20is%20a%20test%20SMS Remarks: More details on characters in chapter 5 on field types TARIFF Consumers tariff, in eurocents, charged to the consumer per message, incl VAT Type: Numeric Min length: 2 Max length: 3 Values: 25, 35, 40, 55, 70, 80, 90, 110, 150, 300 Example: TARIFF=70 Remarks: Some form of opt- in is requires from the recipient

5 SHORTCODE Premium SMS Reguired: yes Type: Numeric (national format) Min length: <na> Max length: <na> Default value: <na> Example: SHORTCODE=5030 KEYWORD Premium SMS Reguired: yes if shortcode is shared Type: Alphanumeric Min length: 2 Max length: 15 Default value: <na> Example: KEYWORD=WIN NETWORKCODE Premium SMS Reguired: yes Type: Numeric Min length: 5 Max length: 5 Default value: <nne> Example: NETWORKCODE=20601 Remarks: See point 6

6 3. Return Values: 1 Succesfully received Missing Parameter username too short username too long password too short password too long destination too short destination too long sender too short sender too long body too short body too long Security Error Unknown Route Route access violation Insufficient Credits Technical Error 4. Delivery Reports You can set your delivery reports by logging on to your account on and selecting the menu item Instellingen in your SMS dashboard. Here you can enter the url of your script (servlet, php script, perl, etc ) on which you wish to receive your delivery reports. This script should expect two parameters, this will be sent via an HTTP GET. When you require a delivery reports you should not specify more than 1 DESTINATION in the request The following status values will be sent: 10 Delivered 20 Not Delivered Example: REFERENCE=abc123&STATUS=10

7 5. Field types Numeric: characters 0 to 9 Alphanumeric: character from ISO MSISDN- numeric characters 0 to 9, first character might be a '+' sign Hex- numeric: characters 0 to 9 and a- f and A- F GSM 7- bit alphabet (allowed characters in text messages): The characters 'a' through 'z', 'A' through 'Z', '0' through '9', linefeed, carriage return $ èéùìòçøøåå_^{}\[~] ÆæßÉ!"# %&'()*+,-./:;<=>? ÄÖÑÜ äöñüà To use the sign please use %80 6. Networkcode Orange: SFR: Bouygues 20800, 20801, , 20811, , 20821, Example API STINATION=336********&SENDER=Spryng&BODY=test&TARIFF=25&KEYWORD=WIN&SHOR TCODE=5030&NETWORKCODE=20800