ActiveXperts SMS Component

Quicklinks

Visual Basic .NET sample - Send SMS text through an HTTP provider

The ActiveXperts SMS Component is a software development kit (SDK) to enhance an application or script with SMS or Pager functionality. SMS messages can be sent/received using a GSM modem, an SMPP provider or an HTTP compliant SMSC.


Introduction

In this example we are going to use Visual Studio 2008 to create a console application project named 'DemoApp' in a solution named 'DemoSolution'. We are going tot store this project in the directory 'C:\MyProjects'. All of these names can be changed according to your preferences. This demo project will ask the user to give a phone number and a message body on the command prompt.

A subscription to an HTTP provider is required. For this demo you can send a limited number of messages through our own gateway.

Step 1: Download and install the ActiveXperts SMS Component

Download the the ActiveXperts SMS Component from the ActiveXperts Download Site and start the installation. The installation guides you through the installation process.

Step 2: Create a new Visual Basic .NET Project

Launch Microsoft Visual Studio from the Start menu. Choose 'New' from the 'File' menu and click on 'Project'. In the 'New Project' dialog, select a Visual Studio template. Select a name for the application and a name for the solution. Also, select the directory where you want to store the project:

Visual Basic .NET

(Click on the picture to enlarge)

Step 3: Refer to the ActiveXperts SMS Component Library

Now that a new project has been created, you must add a reference to the ActiveXperts SMS Component in the project to be able to use the the ActiveXperts SMS Component objects. To do so, choose 'Add Reference...' from the 'Project' menu. In the 'Add Reference' dialog that pops up, select the 'COM' tab and select the ActiveXperts SMS Component Type Library' as shown in the following picture:

Visual Basic .NET

(Click on the picture to enlarge)

Click 'OK' to close the 'Add Reference' dialog.

Step 4: Declare and create the ActiveXperts SMS Component objects

The following code will show you how to declare and create the HTTP and SMS objects. We will use the 'objHttp' object to send the message itself. The 'objSmsMessage' object will be used to store information of the message and the 'objSmsConstants' object containes constant values releated to the SMS objects.

Imports Microsoft.Win32
Imports System.IO
Imports AxSms

Module HttpProgram

  Sub Main()
    Dim objHttp As Http = New Http()
    Dim objSmsMessage As SmsMessage = New SmsMessage()
    Dim objSmsConstants As SmsConstants = New SmsConstants()

Step 5: Gather information

The following code will ask the user for the recipient telephone number and the content of the text message. This data will be stored in the 'objSmsMessage' object.

objSmsMessage.Clear()
objSmsMessage.ToAddress = ReadInput("Enter recipient (recommended to start with a '+')", False)
objSmsMessage.BodyFormat = objSmsConstants.BODYFORMAT_TEXT
objSmsMessage.Body = ReadInput("Enter the message you want to send.", False)

Step 6: Send SMS messages

The following code shows how to send an SMS message using the data that was stored in the 'objSmsMessage' and 'objSmsConstants' objects.

' Send the message !
objHttp.SendSms(objSmsMessage, objSmsConstants.MULTIPART_OK)

Appendix: Full source code

Following you can find the full source code which is also included in the ActiveXperts SMS Component package.

'-----------------------------------------------------------------------
' <copyright file="HttpProgram.vb" company="ActiveXperts">
'     Copyright (c) ActiveXperts Software - www.activexperts.com
' </copyright>
' <author>ActiveXperts</author>
'-----------------------------------------------------------------------

Imports Microsoft.Win32
Imports System.IO
Imports AxSms

Module HttpProgram

  Sub Main()
    Dim objHttp As Http = New Http()
    Dim objSmsMessage As SmsMessage = New SmsMessage()
    Dim objSmsConstants As SmsConstants = New SmsConstants()

    Dim strUrl As String = String.Empty

    ' Set Logfile (optional, for debugging purposes)
    objHttp.LogFile = String.Format("{0}{1}", Path.GetTempPath(), "HttpPostLog.txt")

    Console.WriteLine("SMS Component: Build: " & objHttp.Build & "; " &
                                                "Module: " & objHttp.Module)
    Console.WriteLine(String.Empty)

    Console.WriteLine("Log file can be found here:")
    Console.WriteLine(objHttp.LogFile)
    Console.WriteLine(String.Empty)

    ' Prompt user for an HTTP Post URL. By default, the ActiveXperts HTTP gateway is used
    strUrl = GetHttpURL(objSmsConstants)

    objSmsMessage.Clear()
    objSmsMessage.ToAddress = ReadInput("Enter recipient (start with a '+')", False)
    objSmsMessage.BodyFormat = objSmsConstants.BODYFORMAT_TEXT
    objSmsMessage.Body = ReadInput("Enter the message you want to send.", False)

    objHttp.Url = strUrl

    ' Send the message !
    objHttp.SendSms(objSmsMessage, objSmsConstants.MULTIPART_OK)
    Console.WriteLine("SendSms, result: " & objHttp.LastError.ToString() )
    Console.WriteLine("Response from provider: " & objHttp.LastResponseCode)
    Console.WriteLine("Ready.")
    Console.WriteLine("Press <ENTER> to continue.")
    Console.ReadLine()
  End Sub

  Function GetSmsDemoAccountInfo(ByRef strGwAccount As String, ByRef strGwPassword As String)

    ' NOTE: during installation of SMS Component, a unique login and password is  
    ' created for you. This login and password can be used to send a few SMS messages through the 
    ' smpp.activexperts-labs.com gateway, for free. The 'GetSmsDemoAccountInfo' reads the unique 
    ' account info from a file that was created during installation
    Dim regKey As RegistryKey
    Dim objValue As Object
    Dim strInstallRoot As String = String.Empty
    Dim strAccountFile As String = String.Empty
    Dim srReader As StreamReader

    regKey = 
    Registry.LocalMachine.OpenSubKey("SOFTWARE\\ActiveXperts\\SMS Component", False)

    objValue = regKey.GetValue("InstallRoot")

    If (Not objValue = Nothing) Then

      strInstallRoot = objValue.ToString()

      strAccountFile = strInstallRoot
      strAccountFile += "\\Utilities\\activexperts-labs.txt"
      If (Not File.Exists(strAccountFile)) Then
          Return False
      End If

      srReader = File.OpenText(strAccountFile)
      srReader.ReadLine()                 ' 1st line is a comment line; skip it
      strGwAccount = srReader.ReadLine()  ' 2nd line is the account
      strGwPassword = srReader.ReadLine() ' 3rd line is the password
    End If

    regKey.Close()

    Return True
  End Function

  Function ReadRecipient()
    Dim strInput As String = String.Empty
    Dim strReciepient As String = String.Empty

    Console.WriteLine("Enter recipient (must start with a '+') : ")
    While (strReciepient = String.Empty)

      Console.Write("  > ")
      strInput = Console.ReadLine()

      If (strInput = String.Empty) Then
          Continue While
      End If

      If (strInput.Length > 1 And strInput(0) = "+") Then
          strReciepient = strInput
      End If
    End While
    Console.WriteLine("  Recipient: " & strReciepient & vbCrLf)

    Return strReciepient
  End Function

  Function GetHttpURL(ByVal objSmsConstants As SmsConstants)

    Dim strUrl As String

    Console.WriteLine("Enter HTTP Post provider URL." & vbCrLf & 
      "Type <ENTER> to use the free ActiveXperts SMS gateway: ")
    Console.Write("  > ")
    strUrl = Console.ReadLine()

    If (strUrl = String.Empty) Then
      Dim strUsername As String = String.Empty
      Dim strPassword As String = String.Empty
      GetSmsDemoAccountInfo(strUsername, strPassword)
      strUrl = String.Format("post.activexperts-labs.com:8080/sendsms/default.asp?username={0}" &
                "&password={1}&text={2}&to={3}", strUsername, strPassword, 
                objSmsConstants.HTTP_PLACEHOLDER_BODY, objSmsConstants.HTTP_PLACEHOLDER_TOADDRESS)
      Console.WriteLine(strUrl)
    End If

    Console.WriteLine(String.Empty)
    Return strUrl

  End Function

  Function ReadInput(ByVal strTitle As String, ByVal bAllowEmpty As Boolean)

    Dim strInput As String
    Dim strReturn As String = String.Empty

    Console.WriteLine(strTitle)
    Do
        Console.Write("  > ")
        strInput = Console.ReadLine()
        If (strInput.Length > 1) Then
            strReturn = strInput
        End If
    Loop While (strReturn = String.Empty And Not bAllowEmpty)

    Return strReturn
  End Function
End Module

You can download the full source code of this project from the ActiveXperts FTP site: ftp.activexperts-labs.com/samples/sms-component. There are many other working samples included with the product or on the FTP site.

NOTE: Demo Projects are created with Microsoft Visual Studio 2008

The ActiveXperts SMS Component project ships with a set of Microsoft Visual Studio .NET samples. The projects are created with Microsoft Visual Studio 2008.

Users with a later version of Microsoft Visual Studio can open such a project. The Visual Studio Conversion Wizard will guide you through the process of converting the project to the version used.