Spryng Making Business Mobile (0) Spryng Headquarters: Herengracht BW Amsterdam - The Netherlands

Transcription

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

2 1. Connecting to the gateway When signing up for an account on you will choose a Username and Password that is specific to your account. Valid methods to connect to the gateway are GET or 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 SERVICE ROUTE ALLOWLONG Unique reference for delivery reports Destination Number(s) Originator address Content of SMS Reference tag to be added to differentiate between end users To select the Spryng Business or Economy route If you wish to send Long SMS 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: Alphanumeric Max length: 25 Example: REFERENCE= abc123 Remarks: Must be unique DESTINATION Destination Number(s) Type: MSISDN- numeric (international format without leading 00 or + ) MSISDN Max length: 1 MSISDN Example: DESTINATION= Remarks: More details on error handling in chapter 3 on result values

4 SENDER Originator address Type: Numeric or Alphanumeric Max length: 14 for Numeric or 11 for Alphanumeric Example: SENDER= SENDER=Your name BODY Content of SMS Type: GSM 7- bit alphabet for text message or Hex- numeric for binary/unicode message Max length: 160 chars for text message (default : ALLOWLONG=0) 612 chars (ALLOWLONG=1) When using long sms the system will automatically divide your message into message up to 153 characters per sms Example: BODY=This%20is%20a%20test%20SMS Remarks: More details on characters in chapter 5 on field types

5 SERVICE Reference tag can be used to create a filter in statistics Required: no Type: Alphanumeric Max length: 10 Example: SERVICE=Client1 ROUTE To select the Spryng Business, Spryng Economy Required: no Type: Predefined Min length: <na> Max length: <na> Values: BUSINESS,ECONOMY Default value: BUSINESS Example: ROUTE=ECONOMY ALLOWLONG If you wish to send Long SMS Required: Only if you wish to send Long SMS Type: Predefined Min length: <na> Max length: <na> Values: 0,1 Default value: 0 Example: ALLOWLONG=1 Remarks: When using long sms the system will automatically divide your message into message up to 153 characters per SMS

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. Credit amount API 7. Example API ******&DESTINATION= &SENDER=Spryng&BODY=test&ALLOWLONG=1