SMSC WebService User Guide
Contents
1. 007d 005c 005b 007e 005d 007c 20ac 16 162. 0394 OO5f 03a6 0393 039b 03a9 03a0 03a8 03a3 0398 039e 00 00 OOdf 00 9 0020 0021 0022 0023 00a4 0025 0026 0027 Character o E Ds O HA 1G lt LINE FEED gt g X CARRIAGE RETURN gt vo 5 gt 7 SPACE gt A e x ae 13 16 o link mobility 0028 0029 002a 002b 002c 002d 002e 002f 0030 0031 0032 0033 0034 0035 0036 0037 0038 0039 003a 003b 003c 003d 003e 003f 00a1 0041 0042 0043 0044 0045 0046 0047 0048 0049 004a 004b 004c 004d 004e 004f 0050 0051 0052 0053 0054 0055 Nee 4 2 14 16 5 link mobility 0056 0057 0058 0059 005a 00c4 0046 00 1 00 00a7 OObf 0061 0062 0063 0064 0065 0066 0067 0068 0069 006a 006b 006c 006d 006e 006f 0070 0071 0072 0073 0074 0075 0076 0077 0078 0079 007a 00e4 00 6 0011 oofc 00e0 lt 5 3 o o Ci 2 lt x a 9 15 16 5 link mobility 5 link mobility 8 1 Extended GSM characters The following characters will be handled as extended characters and will use 2 bytes of space per character Unicode hex Character 000c FORM FEED 005e e 007b 1
3. Name Data type Description resultCode Integer The result code See Result Codes for more information resultDescription String This is the textual description for the result code 5 12CustomParameter Name Data type Description key String Key parameter Valid keys and values may be given by support if needed value String Value parameter 8 16 5 link mobility 6 Constants in the WebService 6 1 TON TON stands for type of number and describes how the number should be presented source and destination Value decimal Description 0 Short number 1 5 digits 1 Alphanumeric Up to 11 valid GSM default alphabet characters Some operators don t accept all the characters Safe characters are A Z a z 0 9 2 MSISDN A mobile number on international format starting with 6 2 DCS DCS stands for Data Coding Scheme and describes how the data should be presented Basic values that are used when sending are Value hex Description 00 GSM default alphabet encoding 04 8 bit binary data 08 UCS2 encoded More information about DCS can be read in the ETSI specification GSM 03 38 9 16 5 link mobility 6 3 CustomParameters Key Description chargeOnly true or false indicates that the message only should be charged not possible for all markets async true or false indicates if the message should be sent asynchronous
4. This is provided by Support password String This is the password which is used for authentication This is provided by Support msisdn String This is the MSIDN that should be resolved Mobile number on international format starting with 7 16 5 9 LookupResult 5 link mobility Name Data type Description operator String This is the resolved operator which the system will use when sending messages to the specified MSISDN Format is for example se telia no telenor dk tdc resultCode Integer The result code See Result Codes for more information resultDescription String This is the textual description for the result code 5 10 RefundParameters Name Data type Description username String This is the username which is used for authentication This is provided by Support serviceld Integer This is the serviceId which is used for authentication This is provided by Support password String This is the password which is used for authentication This is provided by Support destination String This is the MSIDN that should be resolved Mobile number on international format starting with messageld String This is the ID of the original charge message customerParameters List of Optional parameters may be specified if CustomParameter requested by support List of available constants 5 11 RefundResult
5. atenated useDeliveryReport Boolean True indicates that a delivery report should be sent back when the message has come to a final state It s recommended to set this value to true validityTime Long This specifies how long the message is supposed to live The value should be specified in milliseconds 1 indicates default validity time should apply Recommended time is between 15 minutes 900000 and 48 hours 172800000 tariffClass String Used for Premium SMS otherwise empty or null Format currency in ISO 4217 cent of currency Example SEK350 equals 3 50 SEK vat Float Used for Premium SMS 25 equals 25 1 equals not used or default customerParameters List of Optional parameters may be specified if CustomParameter requested by support List of available constants 5 7 SendResult Name Data type Description messageld String This is the unique messageld that will appear in the delivery report and should be referred to when sending questions to support resultCode Integer The result code See Result Codes for more information resultDescription String This is the textual description for the result code 5 8 LookupParameters Name Data type Description username String This is the username which is used for authentication This is provided by Support serviceld Integer This is the serviceId which is used for authentication
6. ce 5 2 send This is the method that should be used when sending SMS messages 5 2 1 Parameters Parameter Data type Description message SendParameters See SendParameters for more information 5 2 2 Returns This method returns an object of the type SendResult 5 3 lookup This method lookup which operator a specific number will be delivered to 5 3 1 Parameters Parameter Data type Description message LookupParameters See LookupParameters for more information 4 16 sw link mobility 5 3 2 Returns This method returns an object of the type LookupResult Successful results with supplied operator will use return code 200 Ok 5 4 Refund This method will refund a charge transaction 5 4 1 Parameters Parameter Data type Description message RefundParameters See RefundParameters for more information 5 16 5 link mobility 5 5 Objects in the WebService The following objects are used in the WebService 5 6 SendParameters Name Data type Description username String This is the username which is used for authentication This is provided by Support serviceld Integer This is the serviceId which is used for authentication This is provided by Support password String This is the password which is used for authentication This is provided by Support source String This is the source number from where the messag
7. e should be sent The format is depending on the specified sourceTON sourceTON Integer This is the source type of number See TON for more information destination String This is the destination number The format is depending on the specified destinationTON destinationTON Integer This is the destination type of number See TON for more information dcs Integer This is the Data Coding Scheme that should be used when sending the SMS See DCS for more information userDataHeader String This value may be specified when sending concatenated SMS WAP push etc The format is hex encoded 8 bit bytes More information about valid UDH for long SMS etc may be given by support upon request userData String This is the message itself The DCS specifies the format on this value GSM default alphabet encoded messages has a maximum length of 1377 bytes Note that Extended GSM characters need 2 bytes for one character 1 GSM7 message is 160 non extended characters 153 non extended characters for GSM7 if the message is concatenated Binary messages should be hex encoded as 8 bit bytes and the maximum length is 140 bytes 280 bytes when hex encoded UCS2 encoded messages has a maximum length of 567 6 16 5 link mobility Note that messages will be split into several SMS if the text doesn t fit in one SMS 1 UCS2 encoded message is 70 characters or 63 characters if the message is conc
8. ew link mobility SMSC WebService User Guide Modified 2014 09 18 Version 3 0 Authors Kenny Colliander Nordin KCN Johannes Andreasson JA This document is for the designated recipient only and may contain privileged proprietary or otherwise private information If you have received it in error please notify the sender immediately and delete the original Any other use of the document by you is prohibited 5 link mobility 1 Index T LEUR UM 2 2 Change history oni erect chal sr rt Rr Cd ena xu RT Pa RU e RR 2 3 Introduction nennen messen aen aaa aaa aaa aaa aaa aaa a 3 4 WSDL and locations 4 5 Methods the 4 5 1 getVerslOn ener vea va vr d Ra peer dee pa 4 5 1 1 4 5 1 2 Rn v 4 5 2 sna I C Ur 4 5 2 1 Parameters 4 5 2 2 RECURS e n a pa CURA RA n RD en RR NR 4 5 3 lOOKU M O M 4 5 3 1 Parameters eec aic a ac Rn x RR 4 5 3 2 DA da 5 5 4 iir PIER 5 5 4 1 Parameters aac dic RR 5 5 5 Objects in the WebService isi sett dE ERR ENS 6 5 6 SendParameters cccccccecceeccceeeccceeucueueucueeeucueueucueeeec
9. instead of synchronous Note that premium should be sent as asynchronous productDescription Used for premium SMS Description on the invoice market specific productCategory Used for premium SMS Indicates the category of purchase contact support for appropriate value age Used for premium SMS Indicate the required age for the customer market specific referenceId Used for premium SMS Reference ID from MO SMS market specific 10 16 5 link mobility 7 Result Codes These are the result codes that may appear in the resultCode variable in SendResult and LookupResult Code Description 0 Unknown error 1 Temporary routing error 2 Permanent routing error 3 Maximum throttling exceeded 4 Timeout 100 Service not found 101 User not found 102 Account not found 103 Invalid password 104 Configuration error 200 OK this code will only be used by methods that not deliver messages 1000 Sent 1001 Delivered 1002 Expired 1003 Deleted 1004 Mobile full 1005 Queued 1006 Not delivered 1007 Delivered charging delayed 1008 Charged message not sent 1009 Charged message not delivered 1010 Expired no delivery report 2000 Invalid source number 2001 Short number is not supported as source 2002 Alpha is not supported as source 2003 MSISDN is not supported as source number 2100 Short number is not supported as destination 2101 Alpha is no
10. n working with both operators and connection aggregators This platform is designed to handle large traffic volumes maintain a high availability and make it easy to route traffic via multiple connections This is document describes the WebService SOAP interface to the SMSC platform This document will not handle specific use cases as concatenated messages WAP push Flash SMS etc More information about those cases can be provided by contacting support 3 16 5 link mobility 4 WSDL and locations This interface can be reached at two different URLs which are connected to the Internet via different ISPs You can choose to access this service via HTTP or HTTPS We recommend that you implement your program so it automatically can switch between the both URLs to get higher availability Protocol URL to WSDL HTTP 1 http ws1 sp247 net smscws api wsdl HTTP 2 http ws2 sp247 net smscws api wsdl HTTPS 1 https wsi1 sp247 net smscws api wsdl HTTPS 2 https ws2 sp247 net smscws api wsdl 5 Methods in the WebService The methods are listed below with their parameters and all possible response codes 5 1 getVersion This method returns the current version of the WebService 5 1 1 Parameters There are no parameters for this method 5 1 2 Returns This method returns the current version number of the WebService as a string This value should only be used for information or testing of availability of the servi
11. t supported as destination 2102 MSISDN is not supported as destination 2103 Operation blocked 2104 Unknown subscriber 2105 Destination blocked 2106 Number error 2107 Destination temporary blocked 2200 Charging error 2201 Subscriber has low balance 2202 Maximum purchase exceeded 2203 Customer too young 2204 Prepaid subscriber not allowed 2205 Service rejected by subscriber 2206 Subscriber not registered in payment system 2300 Refunded 2301 Could not refund due to illegal or missing MSISDN 11 16 s link mobility 2302 Could not refund due to missing messageld 2303 Charged message is queued for refund 3000 GSM encoding is not supported 3001 UCS2 encoding is not supported 4000 Delivery report is not supported 4001 Invalid message content 4002 Invalid tariff 4003 Invalid user data 4004 Invalid user data header 4005 Invalid data coding 4006 Invalid VAT 4007 Unsupported content for destination 12 16 8 GSM default alphabet The default GSM alphabet is the alphabet that will be used when specifying DCS 0 default DCS The following characters will use 1 byte per character Unicode hex 0040 00a3 0024 00a5 00e8 00e9 OOf9 00ec OOf2 00c7 000a 00d8 0018 000d 00c5 00e5
12. uenereuunercuuneesuenersageeys 6 5 7 SendResult ece ire eec ev exu ek wey va ww ey sauna Vw CARRY va VC CY va AW EA ws 7 5 8 LookupParamieters ERR Ea 7 5 9 LOOKUPRESUIticicesssteiversioviceracteatevnscvad er aa Ru Fia a Par EYE DIE pe 8 5 10 ea ww yeY vau eaa cx vendo va ava CY ca AA 8 5 11 Ref ndRes lt iier rer Rr eR Deed rex ries Pec Ee RR RARE 8 5 12 CustomParameter 8 6 Constants in the 9 61 EEUU 9 6 2 pec mem ES 9 6 3 Custombaramieters viii seva vovv d e XX YR EY EE T E EY C CA RC C CR 10 7 Result erret kei eR ebbe bao ren i tV vd iere ud redire c Ure dod etr 11 8 GSM default 13 8 1 Extended GSM characters na n 16 2 Change 38 Rev Date Changes from previous release 1 0 Created 1 1 2009 12 16 KCN Added customParameters to SendParameters Added lookup method Added response code 200 OK 2 0 2013 04 05 KCN Updated support for long SMS Added error codes Changed logo 2 0a 2013 06 25 Minor updates of spelling and added more custom parameters 3 0 2014 09 18 JA New method Refund Added result codes for refunds 2 16 sw link mobility 3 Introduction LINK Mobility has been a SMS distributor since 2001 and has much experience i
Download Pdf Manuals
Related Search