Document - Business Messaging Services Manuals
Contents
1. GRAPEVINE SMS 2 HTTP User Manual This document is aimed at Grapevine Affiliate administrators and users who have been provisioned to use SMS 2 HTTP Version 2 1 Date 23 April 2010 Support For assistance please contact Grapevine 27 21 702 3333 or email info vine co za Feedback Was this document useful What can we do to make this user guide more useful and informative Please email info vine co za with your comments and feedback Tel 27 21 702 3333 Email info vine co za Web www vine co za SMS 2 HTTP User Manual Table of Contents PDD TEV IARIONS ccecesiiiccectsvtincwdanstindeveduemsacawisincvuhucelncwdaws na dusud unica san eiac cous sumincataannvaneusinetquereuvesesencedeies 3 DE TIAITI ONS arora A E AAEE ET A E E OOTA 3 L VE OCCU OM sisaren oi a aeaa ETATE TEE ET AOE AEREE 4 I What is the purpose of this manual eessssssssesssrressrrrsssrrresrrressrrressrereserressrereserresseereserrreseeee 4 1 2 Introduction to SMS 2 ATIP cresinireosiair E E E weiataeehieeweaes 4 12 is Whati it r senne A E EE 4 122s Way UISC UG eenen a a A 4 1237 HOw does IT WOK snien E A 4 t24 AIS acca atc E E E E E 4 1255 REpleSeos naa a E T 5 126 Process CIA Slain racsareani a E E AE E AEEA thea ea octet 5 Ze GETING started orii a a a a aa 5 2 LT HOW do Treciter eei a E A O AE A Na 5 2 1 2 Where do I get my login information sssssssenseseeessrreresrrrssrrrresrereserereserresrrrreserresene 5 32. Conversion OF SMS TO KIM asavinaiasariowssiwactavcsccrcencuavchawssiwhoonsviecbaundaevionawedsvaudsavvonssueesbaesians 6 The SMS 2 HTTP Home page sesessssessssessssecsssseossssossssossoeoessssesssoesssoesosossssoessssessssssseses 7 4 1 How do oI change my personal details sescscsicen rays an cawaccwsaasbaaesseeneuuz a aa wade 7 4 2 HowadotaccessSMS 2 ATTPTEPDOTTS Paneera tinira enee Ea aaa a aaia 8 Reporunge and analysis aneantir AE U EA TE ENE EAA 9 EA S AE TA PE EEIT T AENA P PEE AE N I N AEA 10 6 1 Under which circumstances would the sent SMS create an error on GVI s server 10 6 2 Wat are standard characters onccion anan a a ec Guak ce sane bacianaddeeaeeesee 11 SUP O ONE siapna i OAE E sae cewacaeceee und onerasavesssuaets aiaa 11 Copyright 2010 Grapevine Interactive Pty Ltd Page 2 of 11 SMS 2 HTTP User Manual Abbreviations CSV Comma Separated Values GVI Grapevine Interactive HTTP Hypertext Transfer Protocol SMPP Short Message Peer to Peer Protocol SMS Short Message Service URL Universal Resource Locator Definitions Affiliate Company that is registered with Grapevine and has been provisioned to use one or more of its products or services Broadcast In SMS 2 HTTP a broadcast is a collection of messages sent out by an Affiliate to mobile phone users and the responses received by an Affiliate from mobile phone users Campaign In SMS 2 HTTP a campaign is a collection of messages sent out by
3. an Affiliate to mobile phone users and the responses received by an Affiliate from mobile phone users CDATA The term CDATA is used to indicate text that should not be parsed interpreted by the XML parser for instance characters like lt and amp Copyright 2010 Grapevine Interactive Pty Ltd Page 3 of 11 SMS 2 HTTP User Manual 1 Introduction 1 1 What is the purpose of this manual The purpose of this manual is to document e SMS 2 HTTP s web based front end which is used to view reports about SMS 2 HTTP campaigns e the XML used by Affiliates to perform HTTP posts to SMS 2 HTTP 1 2 Introduction to SMS 2 HTTP 1 2 1 What is it SMS 2 HTTP is a web based service that enables you to route SMS messages from customers to your company via Grapevine using XML over HTTP You can then use your own application to extract and process the content of the SMS message 1 2 2 Why use it Gathering information in large companies can be time consuming and costly and effective marketing and research campaigns can end up being labour intensive With SMS 2 HTTP you can automatically gather information from customers via SMS and then extract process analyse and store it using your own applications You can use SMS 2 HTTP for a variety of applications for instance voting competition entries surveys account notifications support queries and promotions SMS 2 HTTP is an effective way of coordinating the benefits of super fas
4. may however give an indication of long the message took to be transmitted to your server gatewayldentifier Identifies the network and the rate of the SMS Grapevine has a list of short code rates from which you can choose In the example above you can see that the mobile phone number is a Vodacom number and therefore the network chosen will be for Vodacom The rate in this example is R3 Cell C and MTN will also offer a R3 rate e g ThreeRandCellCRx1 cellNumber The number in international MSISDN format of the mobile phone that sent the SMS smsLocation The short code to which the SMS was sent content The message text of the SMS message e g Unsubscribe Note The content of multiple messages can be repeated by duplicating the tags sandwiched between the gviSMS tags Copyright 2010 Grapevine Interactive Pty Ltd Page 6 of 11 SMS 2 HTTP User Manual 4 The SMS 2 HTTP Home page Using the URL sent to you by Grapevine when you were provisioned on the system log in to the SMS 2 HTTP application Below is an illustration of a demo Affiliate s Home page A Username and password are case sensitive GRAPEVINE I N T E Kk A T eS MESSAGING SERVICES Home iy Profile support Welcome back penny vine co za MY PROFILE MY PRODUCTS sms2http Change your details Figure 2 SMS 2 HTTP Home page The SMS 2 HTTP Home page is a portal for the messaging services for which you are registered On the Ho
5. bile numbers from the XML sent to you by SMS 2 HTTP and respond via AppLink 1 2 6 Process diagram An overview of the SMS 2 HTTP process flow is shown in the figure below GVI Server Client s Server Figure 1 SMS 2 HTTP process flow 2 Getting started To get started you must be registered as a Grapevine Affiliate 2 1 1 How do l register Contact Grapevine at info vine co za When you register as an Affiliate you must e specify the number to which people must send their SMSs This can be a short code premium rated or a long code with two extra digits standard rated e specify the URLon your server to which the SMS 2 HTTP service must post these messages e code your web application to receive the SMSs at the URL that you specified when you registered see 3 Conversion of SMS to XML e open your network s firewall to accept posts from the following IP addresses o 196 37 44 90 o 196 35 76 123 2 1 2 Where do I get my login information Grapevine will send you an email with the following user registration information e your username and password for the SMS 2 HTTP web application where you will view reports e the URL for the SMS 2 HTTP web application e confirmation of the short code you chose to which people must send their SMSs Copyright 2010 Grapevine Interactive Pty Ltd Page 5 of 11 SMS 2 HTTP User Manual You can log in to the SMS 2 HTTP web application using the username and password provided in the
6. e searching for all messages sent this month containing the word subscribe in the message body Copyright 2010 Grapevine Interactive Pty Ltd Page 9 of 11 SMS 2 HTTP User Manual Inbound Message Report eg 27821234567 Message Content subscribe Today This month Last Month C Custom Date Please define your date range with the following format ywyy mm dd hh mm From 2010 03 25 00 00 To 2010 03 25 08 50 Run Report Export to Excel H Figure 5 Inbound Message Report search parameters In the results below you can see all the messages containing the word subscribe in the message body In this example the report extract shows all customers who unsubscribed this month From the data you can see that customers have unsubscribed from different services as the short code is different If customers had subscribed to the service in the specified time period these messages would appear in this report as well Current Status Time Msisdn Message 2010 02 23 14 57 26 27735334293 Unsubscribe 2010 02 14 20 41 47 27827777438 Unsubscribe 2010 02 10 18 49 51 27723077978 Unsubscribe 2010 02 02 17 23 26 27834570151 Unsubscribe Figure 6 Inbound Message Report output 6 FAQs 6 1 Under which circumstances would the sent SMS create an error on GVI s server This could happen if the sender used a non standard character in the SMS In such cases the SMS stop
7. email Note Click on the Forgotten your password link to request a reminder of your login details A reminder will be sent to the email account you used to register with SMS 2 HTTP 3 Conversion of SMS to XML The SMS 2 HTTP service converts an SMS message to XML using Grapevine s gviSms standard The gviSms standard is simply the format of the XML as it will arrive on your server including the tags embedded in the XML and what they mean For instance the lt smsLocation gt tag indicates the short code to which a customer sent an SMS This tag is included because you may have more than one campaign running and therefore may be using more than one short code See the example below of the XML as it will arrive on your server and the explanations of the tags This XML is what you must code your web application to receive and process lt xml version 1 0 encoding UTF 8 gt lt gvisSms gt lt smsDateTime gt 2005 09 08T10 06 03 lt smsDateTime gt lt gatewayldentifier gt ThreeRandVodaRx1 lt gatewayIdentifier gt lt cellNumber gt 27827891099 lt cellNumber gt lt smsLocation gt 35444 lt smsLocation gt lt content gt lt CDATA Lindiwe Sisulu KZN gt lt content gt lt Ov Looms gt Tag Description gviSMS The wrapper tag is mandatory All other tags are enclosed in this tag smsDateTime The date and time when the original SMS arrived at GVI s SMS gateway This is not the time the SMS was sent by the customer It
8. me page you have the options to e change your personal details e email Grapevine support with a query e access SMS 2 HTTP reports At the bottom of the Home page you can see Grapevine s contact details What is a portal A portal is a web site or web page that the owner positions as an entrance to other sites or pages on the internet or other pages in a web application 4 1 How do I change my personal details Tip On your My Profile page you can change your password to something easier to remember than the password originally issued to you by Grapevine To change your personal details Copyright 2010 Grapevine Interactive Pty Ltd Page 7 of 11 SMS 2 HTTP User Manual 1 Onthe Home page click Change your details My Profile Please note indicates mandatory fields First Name Penny Last Name Doe Login Name penny vine co za Mobile Number O73 1234567 Email Address penny vine co za Current Password PTT New Password TILLIT Confirm Password TELLIT Figure 3 Change personal details 2 Under My Profile enter your personal details 3 Click Update A message will be displayed saying your changes have been updated To exit this page click the Back button in your browser Tip If you want to exit the page without saving your changes hit the Back button in your browser instead of clicking Update 4 2 Sending Grapevine a support query To email a support query to Grapevine e Inthe applica
9. s at the GVI server it won t be posted to your web server However you will receive regular reports and Statistics on the status of these messages so you can follow up on them Copyright 2010 Grapevine Interactive Pty Ltd Page 10 of 11 SMS 2 HTTP User Manual 6 2 What are standard characters GVI s server accepts the following characters in incoming SMS messages space 2 D M V _ h q Z 3 E N Ww 7 r 4 F 8 X a j S a 5 gt G P Y b k L 6 H Q Z c 1 u Fi I R d m V amp 8 A J s e n wW i 0 9 B K T f O x C 1 C L U A g p y Figure 7 SMS 2 HTTP Home page Support If you need assistance please ensure you have all the details of what you were doing in SMS 2 HTTP so that a support consultant can help you For assistance please contact Grapevine phone 27 21 702 3333 or email support vine co za Copyright 2010 Grapevine Interactive Pty Ltd Page 11 of 11
10. t easy to use mobile communication with in house applications 1 2 3 How does it work With SMS 2 HTTP your Stand a chance to win diamond earrings company gets a dedicated riena short code e g 34766 to DIADIRECT which SMS messages can be sent This code can then be advertised along with a service or promotion to which you want customers to respond by To enter SMS SMS diamond to 34766 You can select whether you want clients to send their SMS messages to a premium rated short code or to a standard rated long code If you select a premium rated short code you earn revenue share on the service usage Messages are sent to your server via an HTTP Post using Grapevine s SMS 2 HTTP application 1 2 4 Features e Reliable SMS 2 HTTP receiver e Easy to use XML interface e SMS concatenation Copyright 2010 Grapevine Interactive Pty Ltd Page 4 of 11 SMS 2 HTTP User Manual e Standard message format e Automated data collection e Short code revenue share e Lower communication costs e Multiple services from one short code 1 2 5 Replies SMS 2 HTTP cannot send replies to a mobile phone If you need a reply service ask our support desk about the SMS Applink service SMS AppLink is a Grapevine Interactive product that enables the transmission of SMS messages via secure HTTPS Applications can post messages to SMS AppLink and receive receipts and replies via a call back POST In this way you can extract mo
11. tion on the right side of the page click the Support tab From the Home page on the purple Menu bar click Support 4 3 How do I access SMS 2 HTTP reports To view SMS 2 HTTP reports 1 Onthe Home page click SMS 2 HTTP 2 Inthe VIEW REPORTS tab click Inbound Message Report Copyright 2010 Grapevine Interactive Pty Ltd Page 8 of 11 SMS 2 HTTP User Manual Welcome back penny vine co za FIEW REPORTS E Inbound Message Report Figure 4 Inbound Message Report 5 Reporting and analysis To get to this page see 4 3 How do access SMS 2 HTTP reports Reports are useful to monitor the success of campaigns and to troubleshoot errors You can also use them to analyse campaigns by exporting the data to a spreadsheet application like Excel SMS 2 Email allows you to filter data so you can report on specific campaigns mobile numbers and short codes over a specific period of time To view a report 1 On the Home page click SMS 2 HTTP In the VIEW REPORTS tab click Inbound Message Report On the Inbound Message Reports page fill in the report parameters You can filter your results to select all messages o sent toa particular short code o sent toa specific MSISDN o containing specific content o sent between specific dates and times Click Run Report 5 After running the report you can export the results to an Excel spreadsheet to further analyse sort and filter Example In the example below we ar
Download Pdf Manuals
Related Search