HTTP Gateway
Contents
1. 12 4 1 12 4 2 MMS gateway usage ss irinin iege s ua 12 4 3 XML GAGS ale SEJE SEE CR ESS 13 4 4 MO type MMS a aA 14 4 5 Example MO type 5 RARE NU E BER KA 14 5 Example 5 5 15 5 1 INCOMING MO message inanem nexus does sese tnde Ra i 15 5 2 Example MT Premillm dE nn eA RIDE ee 15 5 3 Example MT With notification 0 deer ek ca cued sae 15 5 4 Example MT Premium Reserve Capture ccccccececeeeeeeeceeeeeeeaeeeesecececeeeasaeererseeeeseeesaeeeee 15 5 5 ME m 15 5 6 Mi mPayment rna ipa Dante nue de 16 5 7 n ipeum a a O O E E 162. n 723 our w 2 ous GReeK CAPITAL LeTTER SIGMA NA _ wo 25 ous o wa _ 35 ona OOO ____ ______ 3 ous 5 5710 sed 2720 ose lt 2720 00825 Lerr CURLY BRACKET 1 2741 e 2747 182 REVERSE SOUDUS BACKSIASH X osc c ves 2760 Ox183C LEFT SQUARE BRACKET 1 ___ _ ves 276 _____________ __ e 27 62 RIGHTSQUAREBRACKET 1 2764 oaeo vennerne ______________ mre 271 Sno fno 25 ouc umwowmmiermae e 35 oan nes 30 our SMALL LETTER SHARPS German _ ves 3i oar CAPITAL LETTEREWrTHacuTE oxco __ ves x HTTP GatewayHttp Gateway 24 gt wireleSSFaCTORY Dec Hex Charactername Character CP1252 Comments Sup fexciamarionwane ____________ __ 3 o or 3s oe 3 3s
3. corens fmo 4 oas amesa oar esse 3 urreawwmess warmam a om 4 ws oma fussen vs comma 4 Toe risp TT cer souous sa 7 ou s vs Feo mero SS e oero ws 1 SY oes perm SS e Peas eres 7 DIGITNINE _____________ coon L5 os swa 08 EON Oat orearen Hansen gt o e __ ves osr question mark oer a ouo INVERTED EXCLAWATION MARE i ovat vs oar LATIN CAPITAL LeTTERA ous iann 8 ______ ves arin eter 5 oaa iann o o ves oas iann carar eree t 76 oas 7 72 oas ou 78 oss oua 75 umwcemairenk oase GatewayHttp Gateway 25
4. callbackurl Alphanumeric string Delivery notifications are sent to this url A callbackurl is required for receiving delivery notifications channel Numeric string The channel used for sending the message Channels are available upon request and are typically used for premium messages and when channel specific capabilities are required e g special national characters messageid Alphanumeric string The messageid is an external reference to the messages used when sending delivery notifications to the customer It is the responsibility of the customer to maintain unique messageid s If a messageid is not defined no callback with delivery status will be sent If sending to a list of MSISDN s this field should be empty or contain a list of the same length as mobile The list must be separated by a comma Each messageid is used for delivery notification for the message sent to the mobile at the same place in the mobile list mobile Numeric string The MSISDN of the receiver country code must always be included It is possible to send a list of MSISDN s each entry in the list must be separated by a comma and all MSISDN s must include country code If sending to a list of MSISDN s other fields will be equal which means that smsc text HTTP GatewayHttp Gateway 6 gt wireleSSFaACTORY channel and so on will have to be the same for all customers When maki
5. VES 107 LATINSMALLLETTERK 0681 ____ VES 21 LATIN SMALL LETTER L LATIN SMALL LETTER M LATIN SMALL LETTER N LATIN SMALL LETTER O LATIN SMALL LETTER P LATIN SMALL LETTER Q LATIN SMALL LETTER R LATIN SMALL LETTER S LATIN SMALL LETTER T LATIN SMALL LETTER U LATIN SMALL LETTER V HTTP GatewayHttp Gateway 26 gt wireleSSFaCTORY 125 126 a This character will look like an new line on the phone b This is as control code not a character c This character costs 2 bytes instead of 1 d This character MUST be URL encoded 11 SMS Length The following explains how much data can fit into 1 SMS when a message will be split and how it will be split 11 1 The Message Payload The Message Payload of an SMS is 1120bits Therefore the contents of an SMS can take up a maximum of 1120bits We can use these bits in various ways 11 2 Text SMS normal SMS Each character is 7bits long So we have 1120 72160 There is room for 160 characters in this kind of SMS MOST characters are 7bits long A few characters are 14bits long so using these characters actually counts as 2 characters against the total of 160 Please look at the Accepted Characters section for more information 11 3 Unicode SMS This kind of SMS contains text encoded in Unicode This allows for foreign alphabets like Chinese Japanese Korean Hebrew Arab etc Each character is 16bits long So we
6. Once the file has been downloaded the handset will try to do something with it play it store it etc The text and link is described in a special XML format Since XML is not designed for low bandwith connections like SMS the XML is incoded into something called WBXML that takes up much less space If you send WAPpush via WirelessFactory we will encode the text and link to WBXML and add the necessary UDH If neccesary we will split the SMS into multiple SMS You must make sure that the encoded WBXML message is not bigger than what can fit into the number of SMS you are willing to pay for A rule of the thumb if the length of text link is less than 120 then it will fit into 1 SMS HTTP GatewayHttp Gateway 29 gt wireleSSFaACTORY 12 Rules and regulations The Danish market is regulated by the framework agreement All users of shortcodes in Denmark have to observe the regulations in this regulation The content provider not the operator or the gateway company has the final responsibility to uphold these rules The market is monitored by the Danish Teleankenaevn who will fine any trespassers and have authority to shut down any services found to be in violation Shut down of services only happen in the most severe cases In compliment to the framework agreement some of the operators have moral and ethic guidelines These cover some aspects of doing business that the laws and regulations does not The gist of them is that
7. Payload teneri etapa MN FERE RR 27 11 2 Text SMS hormal SMS itin nh nutrices ra Ht sen 27 Unicode SMS EUM 27 114 The eem 28 11 5 Concatenated text SMS ER boerne 28 11 6 Concatenated Unicode SMS 222 score EDI EET eens 28 TL7 28 11 9 5 5 5 xanax nani cR cr tussis ago aur pau ERU UAE Y EE 28 11 9 Concatenated WAPpush 5 6 AGAR ERR ARAS REA ARIA NERA 28 11 10 WBXML WAP Binary XML ees eren ter eo ti e ua x a dE RE cardia a 29 Rules and regulations ee 30 12 1 Framework agreement in 5 30 12 1 1 Price reg lations 2 1 ce tere en 30 12 1 2 Information regulations ii ctis etse penas ibn E ax RUM a NE CREE RENS 30 12 2 Rammeaftalen in Danish tena rrr a E Re rara a Tia 30 12 2 1 Price regulations eee sena Ee QR ed aed TE
8. hannel 1299 Sheader POST gateway smspush HTTP 1 1 r n Sheader Host gatewayl wifact com r n Sheader Content type application x www form urlencoded r n Sheader Content length strlen Sstr r n r n Sheader S str Sfpl fsockopen 0 11 80 10 if 5 4 fputs fpl header else Sfp2 fsockopen url1 80 errno errstr 10 if fp2 fputs fp2 Sheader 7 Operator names A list of available operator names in Denmark We are aware that Sonofon has changed name to Telenor but the Sonofon name is still used to identify the network technically If needed Wireless Factory can provide an interface OCH where customers can lookup operator for a given MSISDN Please make inquiry to Wireless Factory to obtain details tdc sonofon telia hi3g Table 7 Operators HTTP GatewayHttp Gateway 17 8 Approved tariffs gt wireleSSFaACTORY 8 1 mBilling Digital premium services The following tariffs are approved when billing digital premium services 0 5 20 100 1 21 109 1 5 22 110 2 23 119 2 5 24 120 3 25 129 3 5 26 130 4 27 139 4 5 28 140 5 29 149 5 5 30 150 6 35 159 6 5 39 160 7 40 169 7 5 45 170 8 49 179 8 5 50 180 9 55 189 9 5 59 190 10 60 199 11 65 200 12 69 13 70 14 75 15 79
9. lt content gt lt presentation gt http wirelessfactory dk mms mo 654321 mms smil lt presentation gt lt text gt http wirelessfactory dk mms mo 654321 picture txt lt text gt lt image gt http wirelessfactory dk mms mo 654321 pix jpg lt image gt lt content gt lt message gt lt mo gt HTTP GatewayHttp Gateway 14 gt Nirelessractonmw 5 Example Messages 5 1 Incoming MO message Incoming message will look like mobile 45xxxxxxxx amp channel 1220 amp network tdc amp text keyword more text amp serviceid yyyyyyy 5 2 Example MT Premium Sending a normal text message to MSISDN 45xxxxxxxx for service yyyyyyyy http gateway1 wifact com gateway smspush customerid 000000000000000 amp mobile 45xxxxxxxx amp text hello world amp serviceid yyyyyyyy amp channel 1220 The same message charged 1 DKK sent to a TDC customer http gateway1 wifact com gateway smspush customerid 000000000000000 amp mobile 45xxxxxxxx amp text hello world amp serviceid yyyyyyyy amp channel 1220 amp price 100 amp smsc tdc A donation would be sent as http gateway1 wifact com gateway smspush customerid 000000000000000 amp mobile 45xxxxxxxx amp text hello world amp serviceid yyyyyyyy amp channel 1220 amp price 2500 amp smsc tdc amp donation 1 5 3 Example MT with notification Notification is requested by adding the parameters callbackurl and messageid http gateway1 wifact com gateway smspush customeri
10. 5 8 UNI CELEREM 16 6 Example 16 Gr 16 HTTP GatewayHttp Gateway 2 10 11 12 1 gt wireleSSFaCTORY 6 2 PAD ise 17 Operator 17 Approved tariffs S 18 8 1 Digital premium services mmm 18 8 2 mPayment Physical 0645 lt hah NEAR ER DENN ua 19 8 3 mDoantion DONATION Services YU aae MR aa DE EAT ean E Dia 20 KeyWords 21 9 1 Keyword availability check rr n etd Rhe 21 9 2 Order keyword e M 22 9 3 1 anse 23 Accepted 24 SMS Length 27 11 1 Ihe Message
11. have 1120 16270 There is room for 70 characters in each SMS HTTP GatewayHttp Gateway 27 gt 11 4 The is User Data Header Some SMS has some don t The is small amount of data that can be in the beginning of the Message Payload The UDH informs the handset how to handle the SMS Since the UDH is inside the Message Payload there is less space left for other things We must take this into account when we use UDH The length of the UDH varies but is always a multiple of 8bits 11 5 Concatenated text SMS A text message that is longer than 160 characters must be split up into multiple SMS Each of these SMS must include an UDH that will help the handset put the SMS in the right order The length of a concat SMS UDH is 48bits 6 bytes Each concatenated SMS can hold 1120 48 1072bits Since each character is 7bits long 1072 7 153 1 Concatenated SMS can hold 153 characters 2 Concatenated SMS can hold a total of 2 153 306 characters 3 Concatenated SMS can hold a total of 3 153 459 characters If you send a message that is longer than 160 characters Wireless Factory will take care of the splitting making the UDH etc and charge you accordingly 11 6 Concatenated Unicode SMS The length of a concat SMS UDH is 48bits 6 bytes Each concatenated SMS can hold 1120 48 1072bits Since each character is 16bits long 1072 16 67 characters Currently we do n
12. if you are in doubt as to the legality of a service then there is no doubt 12 1 Framework agreement in English http www rammeaftalen dk english 12 1 1 Price regulations http www rammeaftalen dk english operational rules 12 maximum amounts 12 1 2 Information regulations http www rammeaftalen dk english operational rules 14 information requirements 12 2 Rammeaftalen in Danish http www rammeaftalen dk 12 2 1 Price regulations http www rammeaftalen dk rammeaftalen operativt afsnit 12 beloebsgraenser 12 2 2 Information regulations http www rammeaftalen dk rammeaftalen operativt afsnit 14 informationskrav HTTP GatewayHttp Gateway 30 gt wireleSSFaACTORY 13 Revision 2 1 1 KH 2012 09 24 PHP Example updated and now reflects a SGET post example HTTP GatewayHttp Gateway 31
13. notification at all HTTP GatewayHttp Gateway 10 gt Nirelessracctonmw 3 MO messaging Receiving messages 3 1 Parameters The gateway delivers MO messages to a customer defined URL with the following parameters Parameter Opt Description channel Numeric string The channel that the message was received on mobile Numeric string The MSISDN of the user which is prefixed with the country code network Alphanumeric The smsc of the user The smsc is not string accessible when the message is received by a modem price e Numeric string The MO price of the message This parameter is only defined for MO Premium channels The price is in the lowest local currency of the channel e g Euro Cent A price of 100 for a Danish premium channel would imply a premium of 1 00 DKr serviceid Numeric string The id of the service to which the message is registered in the gateway The servicekey is contingent of the channel and or the message content text Alphanumeric The text received from the handset string delivered as cp1252 encoded text Max length 160 before URL encoding receivetime yyyyMMddhhmmss Time WF received the message from the operator Example 20111020152108 Table 6 Parameters MO messaging HTTP GatewayHttp Gateway 11 gt Nirelessracctonmw 4 MMS MO Messaging 4 1 Introduction The following describes the simple MMS interface for receiving MMS s throug
14. servicekey 2 stops the keyword test on the Danish shortcode 1220 HTTP GatewayHttp Gateway 23 gt wireleSSFaCTORY 10 Accepted characters character name Character 291252 Comments Sup o oo a i fomos 3 s a 3 4 SMALL LETTERE GRAVE s oos SMALL LETTERE wiTH acuTE O9 _ ves LATINSMALLLETTERU WH GRAVE u ono __ ves 7 SMALL LETTER WiTH GRAVE i s LATIN SMALL LETTERO WITH GRAVE ona _ ves oo LATIN CAPITAL LETTER CWITH CEDIA e __ ves ow uer __________________ LATIN cAPTTALLETTERO WiTH STROKE 8 __ ves 12 LATIN SMALLLETTERO WrTH STROKE o ves i5 049 fearnacereruen LATIN CAPITAL LETTERA WITHRING ABOVE A s oor LATIN SMALL LETTER A WITH RING ABOVE __ oes is ouo ewxcaemaLETERDRA NO Gr Ton 1s _______ ous r NA _ 30 ous GREEK CAPITAL LETTERLAMBDA NA NO Ci ous GREEK CAPITAL LETTEROMEGA NA wo oue
15. shortcode The shortcode for the keyword country The country code for the short code url_alias The name of the URL messages with this keyword should be dispatched to This name can be found in the gateway administration email The email that should receive updates for this The service returns HTTP status 200 OK if the requests is successful i e if all parameters are valid There are two possible return values in a successful request Keyword has been ordered Keyword has not been ordered e g because it is not available Error codes 400 Bad Request One or more parameters are missing 403 001 Invalid Customer ID The provided customer ID is invalid 403 002 Invalid Service Key The customer does not own the specified service key if it exists 403 003 Illegal Shortcode The provided shortcode is not allowed to be used by this customer 403 004 No More Keywords Allowed The customer has reached its keyword limit on the given shortcode 403 005 Invalid URL Alias The name of the dispatcher URL is invalid 500 Internal Server Error An internal error has occurred Please try again later Example http log wirelessfactory dk keywordhandler order customerid 1 amp amp servicekey 2 amp keyword test amp sh ortcode 1220 amp country 45 amp url alias MyUrl amp email test test test Customer with ID 1 on servicekey 2 orders the keyword test on the Danish shor
16. 16 80 17 89 18 90 2 All tariffs inc HTTP GatewayHttp Gateway 18 gt wireleSSFaACTORY 8 2 mPayment Physical goods The following tariffs are approved when billing physical premium services 0 5 20 100 1 21 109 15 22 110 2 23 119 2 5 24 120 3 25 129 3 5 26 130 4 27 139 4 5 28 140 5 29 149 5 5 30 150 6 35 159 6 5 39 160 7 40 169 7 5 45 170 8 49 179 8 5 50 180 9 55 189 9 5 59 190 10 60 199 11 65 200 12 69 209 13 70 210 14 75 219 15 79 220 16 80 225 17 89 18 90 3 All tariffs are inc HTTP GatewayHttp Gateway 19 gt wireleSSFaCTORY 8 3 mbDoantion Donation services The following tariffs are approved when billing donation services 0 40 110 5 50 120 10 60 130 15 70 140 20 80 150 25 90 30 100 All tariffs are exempted HTTP GatewayHttp Gateway 20 gt wireleSSFaCTORY 9 Keywords A web application that enables the user to Check availability of a keyword Order a keyword Stop a keyword The requests are only allowed when a correct customer ID is provided Please make sure you have a contract with cost pr keyword before using this part of the API as the cost pr keyword pr month without a contract is 100 DKK Prices can be found in Addendum 1 or 2 9 1 Keyword availabilit
17. N dE 30 12 2 2 Information regulations eset n etre idein RR CHR n nena ERROR RE REN E M RR 30 REVISION M 31 HTTP GatewayHttp Gateway 3 gt wireleSSFaCTORY 1 Welcome 1 1 Introduction This document describes the simple HTTP interface for sending premium and non premium SMS as well as receiving SMS and delivery notifications from the SMS Gateway of Wireless Factory The interface represents the simplest of ways to interact with the gateway 1 2 Contact Information Wireless Factory ApS Vestergade 2 1456 Copenhagen K Denmark Phone 45 70 20 12 92 Open 9 am to 4 pm Website http wirelessfactory dk 1 3 Terms and abbreviations The table below lists some of the commonly used terms and abbreviations in this document Term Abbreviation Definition Channel A channel refers to the number of an MO and or MT connection which can be shortcodes Large accounts or GSM modem numbers Customer The users of the gateway service of Wireless Factory MO Mobile Originated A message sent from a mobile is referred to as a MO SMS MT Mobile Terminated When sending a message to a mobile it is referred to as a MT Smsc Refers to the operator of a given country WF Shorthand for Wireless Factory SMS Short Message Service SMSC Short Message Service Center WAP Wireless Application Protocol Go to http www wapforum
18. P encoding parameter 1 Setting the HTTP header Content Type text html charset ISO 8859 4 HTTP GatewayHttp Gateway 5 2 3 Parameters gt Nirelessractonmw MT messages are required to include a content code and a description of its contents The gateway administrator can specify a standard content code and description for a service but sometimes each MT message requires an individual code and description The following parameters can be used to override the default code However a service must be pre approved for this When used both parameters are required If the service is not pre approved the parameters will be ignored and the message will be sent with the standard content code and description Callbackurl and messageid is mandatory for all premium services Parameters category Opt Format Numeric string Description The content code describing the contents of the message Refer to table 2 1 for a list of valid codes The customer must be pre approved for specifying this code otherwise it will be discarded category desc ription Alphanumeric string Max length 50 A user friendly description of the contents of the message If the category parameter is specified this parameter must be specified as well Please include description of supplier contents AND support phone address E g Company A S Competition 45 1234 5678 The contents of this field must not exceed 50 characters
19. Wireless Factory ApS Vestergade 2B 1 sal DK 1437 K benhavn K Office 45 70 20 12 92 www wirelessfactory dk HTTP Gateway Specification 13 december 2012 Version 2 1 1 gt wireleSSFaACTORY Table of Content 1 9 4 1 1 ER 4 1 2 Contact Information 4 1 3 Terms and Abbreviations era sedan 4 2 MT messaging How to send 5 2 1 Requirements AE 5 2 2 Gateway 5 c IIT 5 2 2 Parameter 6 2 1 Valid content COES iridna XR Reads Gehe aa ke Kx RE 8 2 2 5 5 M 8 2 3 Delivery s ear erret qnd RNV A NUN ERR A UE 10 3 MO messaging Receiving 11 3 1 Pardrmmeters meii ses ek qu 11 4 MMS MO Messaging
20. ageid and a callbackurl The delivery notification sent to the customers indicates whether the message has been deliver delivered to the handset or is undeliverable The parameters which are sent to the callbackurl are described in the table below as well as the meaning of the possible status codes Parameter Description messageid The id matching the id used when sending the message status A code indicating the result Table 4 Delivery notification parameters Status Meaning 0 Message delivered handset 1 Message cannot be routed The possible reasons for this message are e specified smsc might be unknown on the specified channel e The channel does not exist e The customer does not have rights to use the channel 2 Unknown subscriber The operator does not recognize the number 3 Account insufficient The customer has insufficient credit 4 Unknown SMSC unrecognized operator 5 Timed out 6 Unspecified error 7 Blacklisted The customer is barred by own request or by operator Customer needs to contact his operator 8 The message is delivered to the SMSC but no further delivery is forthcoming Table 5 Delivery notification status code The various networks support delivery notifications in varying degree ranging from full support to none E g some operators channels can only deliver a subset of the status codes above whilst other do not support delivery
21. d 000000000000000 amp mobile 45xxxxxxxx amp text hello world amp serviceid yyyyyyyy amp channel 1220 amp price 100 amp smsc tdc amp callbackurl http your site com service amp messageid 45xxxxxxxx uniqueID We will deliver notification like messageid 45xxxxxxxx uniqueID amp status 0 5 4 Example MT Premium Reserve Capture 5 5 MT mPayment HTTP GatewayHttp Gateway 15 gt Nirelessractonmw 5 6 MT mPayment Reserve capture 5 7 MT Donation 5 8 MT Bulk 6 Example Code Following code snippets are only examples and should not be used to without modifying to you specific needs 6 1 Java A method making a URL request to our server could look like below the String argument is a URL with all argument public void send String message try URL url new URL message conn HttpURLConnection url openConnection resp conn getResponseCode if resp 200 System out println Unable to deliver message due to resp tconn getMessage else System out println Message delivered catch Throwable t System out println Unable to make url request t getStackTrace HTTP GatewayHttp Gateway 16 gt wireleSSFaCTORY In php following is one way to make a request Surll gatewayl wifact com Surl2 gateway2 wifact com Sstr customerid 000000000000000 amp mobile 45xxxxxx amp smsc tdc amp serviceid xxxxxxxx amp text god jul amp c
22. gt wireleSSFaCTORY Character name LATIN CAPITAL LETTER L LATIN CAPITAL LETTER M Hex Ox4D LATIN CAPITAL LETTER 0 50 Ox4C 76 78 79 LATIN CAPITAL LETTER LATIN CAPITAL LETTER P LATIN CAPITAL LETTER 0x52 LATIN CAPITAL LETTER R 0x53 LATIN CAPITAL LETTER 5 0x54 LATIN CAPITAL LETTER T 0x55 LATIN CAPITAL LETTER U Ox56 LATIN CAPITAL LETTER V LATIN CAPITAL LETTER W 0x58 LATIN CAPITAL LETTER X 0 59 LATIN CAPITAL LETTER Y 5 LATIN CAPITAL LETTER Z 5 LATIN CAPITAL LETTER A WITH DIAERESIS LATIN CAPITAL LETTER WITH DIAERESIS OxD6 YES 93 050 LATIN CAPITAL LETTER N WITH TILDE Oxd2 _ YES 94 5 LATIN CAPITAL LETTER U WITH DIAERESIS 09 95 5 5 fyes 96 INVERTEDQUESTIONMARK ___ 97 0 61 LATINSMALLLETTERA 98 0 62 LATINSMALLLETTERB b YES LATINSMALLLETTERC 63 0x64 LATINSMALLLETTERD Ves 101 0 65 LATINSMALLLETTERE Ox 0 66 LATINSMALLLETTERF ves 103 967 LATINSMALLLETTERG 0697 YES 104 068 iamNsMALIETTERH 8 06 YES 105 LATINSMALLLETTERI 06 106 LATINSMALLLETTERJ i __
23. h Wireless Factory MMS Gateway The interface represents the simplest of ways to interact with the gateway NOTE At this point the gateway only serves MO MMS 4 2 MMS gateway usage scenario HTTP POST XML HTTP GET w Price ect gt 1 When the MMS Gateway receives MMS from one of the operators it constructs XML page This page gets posted to a Content Provider using HTTP POST 2 When the Content Provider has received the MMS the Content Provider should send a MT SMS to WF s SMS Gateway with correct billing info so that the received MMS will be charged 3 The SMS Gateway will deliver the SMS to the operator with correct billing info and the user will be charged HTTP GatewayHttp Gateway 12 gt wireleSSFaCTORY 4 3 XML Tags The Gateway delivers MO MMS as XML in a HTTP POST to a customer defined URL The Following tags are to be found inside the XML document Description mo Root tag describing which type of MMS it is MO or MT msgid A unique id given by the gateway identifying the message mobile The MSISDN of the user which is prefixed with the country code network Which network the MO message came from tdc sonofon etc channel Which shortcode the message was sent to keyword Which keyword the message was sent to message Which type of message this is Can be either SMIL or MMS timestamp Time when the message was recei
24. hat amp Dating 08 Competitions voting and polls 09 mCommerce 10 News amp information 11 Charity and donations 12 B2B 13 Other 2 2 Status Messages Once the request has been submitted to the gateway the request will be processed and an HTTP response code will be returned The HTTP response codes and their associated meaning are listed in the table below Http response code Http response text Meaning 200 N A Message received successfully by gateway 500 N A An internal gateway error occurred Please contact WF for further info 403 Unauthorized IP The request came from an unauthorized IP 400 Smsc missing or If the value of smsc parameter is unknown or malformed the smsc is missing in conjunction with sending a premium message 400 Error decoding text Both text is missing or we unable to decode the text field 401 Supplied category The parameter category_description was either description is not valid not specified or exceeded its maximum length This error will only occur if the parameter category is specified 401 Given category X The content code provided X is not a valid is not allowed content code refer to table XXX for a list of valid codes HTTP GatewayHttp Gateway 8 gt wireleSSFaACTORY 400 Malformed mobile Mobile must be digits only 400 Missing mobile The mobile para
25. meter is mandatory but not present in the request 400 Missing channel When sending premium messages the customer must supply a channel 400 Missing messageid When callback is requested by defining a callbackurl the customer must supply a unique id to use when making the callback 400 Missing servicekey The servicekey parameter is mandatory but missing in the request 400 Missing parameter Both messageid callbackurl must be for callback present but only one is in the request 401 Price Channel not The customer has not been approved for this allowed for price on this channel 401 Illegal servicekey The customer tries to send a message on illegal servicekey 400 Wrong timestamp Error in timestamp format format Should be yyyyMMddHHmmss 400 Different number of Delivery notification request when sending to more mobiles and than one MSISDN requires the same number of messageids messageid s as mobile numbers Table 3 HTTP response codes MT messaging If an error occurs while pushing to a list of receivers the http status message will contain two lines the last will be Sent count Where count is the number of messages which were successfully sent messages are always sent in the order they are placed in the list HTTP GatewayHttp Gateway 9 gt wireleSSFaCTORY 2 3 Delivery notification The gateway provides delivery notification for messages which are sent with a mess
26. ng request using http GET method one should be aware of the size limit for requests smsc Alphanumeric The smsc of the user e g the operator to which the string user subscribes Specifying the smsc of a user is necessary when sending premium MT messages Please refer to Operator names price Numeric string The price of the message Customers are explicitly given access to price categories for individual channels by Wireless Factory If no price is defined the message is sent zero charged The price is in the lowest local currency of the channel e g Euro Cent A price of 100 for a Danish premium channel would imply a premium of 1 00 DKK senderalias Alphanumeric The sender address of the message Note that not all string characters are usable and that it is not possible to Max length 12 reply to alphanumerical addresses It is not legal to change the sender of a charged message servicekey Numeric string Supplied by Wireless Factory can be used to distinguish services in our statistics interface loggroup Alphanumeric Used to group MT messages with same servicekey string in the statistics interface I e set this parameter to the keyword of the MO SMS Then the MO SMS will be grouped with the MT SMS Alphanumeric The url encoded text to send Read section X on SMS text string length to see how message length is calculated Max length 160 before URL encoding timestamp Date string of The message is sen
27. org for details Table 1 Terms and abbreviations HTTP GatewayHttp Gateway 4 gt 2 messaging How to send messages 2 1 Requirements In order to get your system connected to ours Wireless Factory needs to open your specific IP address in our firewall We should have received this during the initial talks For sending through us you have been given a Customer ID and either we have set up a service ID or you have created one yourself Refer to the gateway user manual for how to set up a service key Default character encoding must be observed for successful termination of messages The default character encoding is set to CP1252 2 2 Gateway servers The interface takes a list of input parameters which can be sent as either HTTP POST or HTTP GET All parameters must be sent exactly as defined in the table below and must be lowercase The base URL for invoking the service is http gateway1 dk wifact com gateway smspush To ensure access to the gateway in case of some sort of failure the service can also be reached on following failover URL http gateway2 dk wifact com gateway smspush In order to identify and verify the customer requesting an MT SMS to be sent a static IP is required on the sending server s Only messages sent from known IP addresses are processed The default character encoding is set to CP1252 but can be altered by setting the HTT
28. ot split Unicode SMS that are too long 11 7 Raw SMS A raw SMS is an SMS that contains exactly the 1120bits that you want A raw SMS could include an operator logo ringtone contact information aka vCard configuration info calendar event flash message WAPpush or many other things If the handset does not support a particular kind of message it will probably display an error message and delete the message A raw SMS always include an UDH because without an UDH the handset would not know what to do with the Message Payload We normally count the length of a raw SMS in bytes so 1120 8 140 There is 140bytes in 1 raw SMS If you need more than 140bytes you can put a concat inside a raw SMS to send concatenated raw SMS 11 8 WAPpush SMS WAPpush is just a raw SMS with a special The WAPpush is 56bits So we have 1120 56 1064 1064 8 133bytes These 133bytes must WBXML encoded data 11 9 Concatenated WAPpush SMS This kind of SMS must include both an WAPpush UDH and a concat UDH This will take up 96bits So we have 1120 96 1024 1024 8 128bytes These 128bytes must be WBXML encoded data HTTP GatewayHttp Gateway 28 gt wireleSSFaACTORY 11 10 WBXML WAP Binary XML A WAPpush SMS contains some text and a link The text is shown on the screen and the user has the option of downloading whatever the link is pointing to Typically the link points to a soundfile videofile imagefile or similar
29. t when the given timestamp is the reached Our servers are synchronized with GMT 1 format We recommend synchronizing the sending server s YYYYMMDDHH before using this parameter e g with mm Type Alphanumeric If the type is set the message is sent as a Nokia udh string message The following types are supported e ringtone Nokia ringtone e picture Nokia picture message e logo Nokia logo Deprecated Wapurl Alphanumeric If defined the wapurl is sent as a service message to string the handset customerid Alphanumeric If the customer does not have a static IP address string the customerid must be used as identification of the customer If the customer can give an ip range this will still be used as security check We strongly recommend not relying solely on the customerid as security HTTP GatewayHttp Gateway 7 gt wireleSSFaCTORY string donation 1 If donation is set to 1 The message is tried delivered as a donation message paymenttype Alphanumeric Parameter indicating payment type Possible values mpayment e donation Table 2 Parameters MT messaging Code examples and examples of request parameters are provided in the Examples section 2 1 Valid content codes 01 Traditional mobile content 02 Video 03 Erotic and other adult content 04 Music 05 Audio 06 Games 07 C
30. tcode 1220 Messages will be dispatched to the url called MyUrl HTTP GatewayHttp Gateway 22 gt wireleSSFaCTORY 9 3 Delete keyword URL http log wirelessfactory dk keywordhandler stop Parameters customerid The customer ID provided by Wireless Factory servicekey The service key on which the keyword should be stopped keyword The keyword that is to be stopped shortcode The shortcode on which the keyword exists country The country code for the short code The service returns HTTP status 200 OK if the requests is successful i e if all parameters are valid There are two possible return values in a successful request 1 Keyword has been stopped Keyword has not been stopped e g because it was not running 0 Error codes 400 Bad Request One or more parameters are missing 403 001 Invalid Customer ID The provided customer ID is invalid 403 002 Invalid Service Key The customer does not own the specified service key if it exists 403 006 Invalid Keyword Specified The specified customer does not own the keyword to for Customer ID and Service Key be stopped if it exists 500 Internal Server Error An internal error has occurred Please try again later Example http log wirelessfactory dk keywordhandler stop customerid 1 amp servicekey 2 amp keyword test amp short code 1220 amp country 45 Customer with ID 1 on
31. ved in gateway subject Subject of the message content Tag holding content part s of the message presentation Tag holding URL of SMIL presentation file Only available if message is set to SMIL text i Tag holding URL of text file image Tag holding URL of image file sound holding URL of sound file video holding URL of video file Table 2 Tags MO messaging GatewayHttp Gateway 13 gt wireleSSFaACTORY 4 4 Example MO type MMS lt xml version 1 0 encoding iso 8859 1 gt lt mo gt lt msgid gt 654321 lt msgid gt lt mobile gt 4512345678 lt mobile gt lt network gt tdc lt network gt lt channel gt 1220 lt channel gt lt keyword gt wfmms lt keyword gt message type mms gt lt timestamp gt 2005 02 01 12 00 00 lt timestamp gt lt subject gt Check this picture lt subject gt lt content gt lt text gt http mms wirelessfactory dk mms mo 654321 picture txt lt text gt lt image gt http mms wirelessfactory dk mms mo 654321 pix jpg image lt content gt lt message gt lt mo gt 4 5 Example MO type SMIL lt xml version 1 0 encoding iso 8859 1 gt lt mo gt lt msgid gt 654321 lt msgid gt lt mobile gt 4512345678 lt mobile gt lt network gt tdc lt network gt lt channel gt 1220 lt channel gt lt keyword gt wfmms lt keyword gt lt message type smil gt lt subject gt Check this Presentation lt subject gt
32. y check URL http log wirelessfactory dk keywordhandler is available Parameters customerid The customer ID provided by Wireless Factory keyword The keyword which to be checked shortcode The shortcode for the keyword country The country code for the short code The service returns HTTP status 200 OK if the requests is successful i e if all parameters are valid There are two possible return values in a successful request Keyword is available Keyword is unavailable 1 Error codes 400 Bad Request One or more parameters are missing 403 001 Invalid The provided customer ID is invalid 403 003 Illegal The provided shortcode is not allowed to be used 403 004 No The customer has reached its keyword limit on the 500 Internal Server An internal error has occurred Please try again Example http log wirelessfactory dk keywordhandler is available customerid 1 amp keyword test amp shortcode 1 220 amp country 45 Customer with ID 1 checks if the keyword test on the Danish shortcode 1220 is available HTTP GatewayHttp Gateway 21 gt wireleSSFaCTORY 9 2 Order keyword URL http log wirelessfactory dk keywordhandler order Parameters customerid The customer ID provided by Wireless Factory servicekey The service key on which the keyword should be keyword The keyword which to be checked
Download Pdf Manuals
Related Search