Send SMS Gateway API – VB6

This command can be used to send text messages to either individual numbers or entire contact groups.

Sample Request

                    
    
                        
  1. Private Sub Command1_Click()
    2. 
                        
  2.  Dim authKey, URL, mobiles, senderId, smsContentType, message, groupId, signature, routeId As String
    3. 
                        
  3.     Dim V_signature, V_groupId, scheduleddate, V_scheduleddate As String
    4. 
                        
  4.     Dim objXML As Object
    5. 
                        
  5.     Dim getDataString As String
    6. 
                        
  6. 	
    7. 
                        
  7.     authKey = "Sample Auth key" 'eg -- 16 digits alphanumeric
    8. 
                        
  8.     URL = "Sample"  'eg-- www.abc.com
    9. 
                        
  9.     mobiles = "Sample" '99999999xx,99999998xx
    10. 
                        
  10.     smsContentType = "english" 'eg - english or unicode
    11.   
                        
  11.     message = "Hello this is test"
    12. 
                        
  12.     senderId = "Sample" 'eg -- Testin'
    13. 
                        
  13.     routeId = “Sample" 'eg 1'
    14. 
                        
  14.     scheduleddate = "" ‘optional if(scheduledate  eg “26/08/2015 17:00”)
    15. 
                        
  15.     signature ="" ‘optional if(signature available  eg “1”)
    16. 
                        
  16.     groupId ="" ‘optional if(groupId available eg “1”)
    17. 
                        
  17. 
                        
  18.     If (Len(signature) > 0) Then
    19. 
                        
  19.         V_signature = "&signature=" & signature
    20. 
                        
  20.     End If
    21. 
                        
  21.     If (Len(groupId) > 0) Then
    22. 
                        
  22.         V_groupId = "&groupId=" & groupId
    23. 
                        
  23.     End If
    24. 
                        
  24.     If (Len(scheduleddate) > 0) Then
    25. 
                        
  25.         V_scheduleddate = "&scheduleddate=" & scheduleddate
    26. 
                        
  26.     End If
    27. 
                        
  27.     URL = "Sample"
    28. 
                        
  28.     'use for API Reference
    29. 
                        
  29.     Set objXML = CreateObject("Microsoft.XMLHTTP")
    30. 
                        
  30.     'creating data for url
    31. 
                        
  31.     getDataString = URL + "AUTH_KEY=" + authKey + "&smsContent=" + message + "&mobileNos=" + mobiles + "&senderId=" + senderId + "&routeId=" + routeId + 
    32. 
                        
  32.     "&smsContentType=" + smsContentType + V_scheduleddate + V_groupId + V_signature
    33. 
                        
  33.     objXML.Open "GET", getDataString, False
    34. 
                        
  34.     objXML.Send
    35. 
                        
  35.      If Len(objXML.ResponseText) > 0 Then
    36. 
                        
  36.             MsgBox objXML.ResponseText
    37. 
                        
  37.      End If
    38. 
                        
  38. End Sub
    39. 
                        
  39. 
                        
  40. Function URLEncode(ByVal Text As String) As String
    41. 
                        
  41.     Dim i As Integer
    42. 
                        
  42.     Dim acode As Integer
    43. 
                        
  43.     Dim char As String
    44. 
                        
  44.     
                        
  45.     URLEncode = Text
    46. 
                        
  46.     
                        
  47.     For i = Len(URLEncode) To 1 Step -1
    48. 
                        
  48.         acode = Asc(Mid$(URLEncode, i, 1))
    49. 
                        
  49.         Select Case acode
    50. 
                        
  50.             Case 48 To 57, 65 To 90, 97 To 122
    51. 
                        
  51.                 ' don't touch alphanumeric chars
    52. 
                        
  52.             Case 32
    53. 
                        
  53.                 ' replace space with "+"
    54. 
                        
  54.                 Mid$(URLEncode, i, 1) = "+"
    55. 
                        
  55.             Case Else
    56. 
                        
  56.                 ' replace punctuation chars with "%hex"
    57. 
                        
  57.                 URLEncode = Left$(URLEncode, i - 1) & "%" & Hex$(acode) & Mid$ _
    58. 
                        
  58.                     (URLEncode, i + 1)
    59. 
                        
  59.         End Select
    60. 
                        
  60.     Next
    61. 
                        
  61.     
                        
  62. End Function
    63. 
                    

              
                    
    
                        
  1. Private Sub Command1_Click()
    2. 
                        
  2. 
                        
  3.     Dim As Object
    4. 
                        
  4.     Dim message As String
    5. 
                        
  5.     Dim authKey As String
    6. 
                        
  6.     Dim mobileNos As String
    7. 
                        
  7.     Dim senderId As String
    8. 
                        
  8.     Dim routeId As String
    9. 
                        
  9.     Dim groupId As String
    10. 
                        
  10.     Dim sURL, URL As String
    11. 
                        
  11.     Dim smsContentType As String
    12. 
                        
  12.     Dim signature As String
    13. 
                        
  13.     Dim returnData As String
    14. 
                        
  14.     'Set these variables
    15. 
                        
  15. 
	                    
  16.     authKey = "Sample Auth key"'eg -- 16 digits alphanumeric
    17. 
                        
  17.     URL = "Sample"'eg-- www.abc.com
    18. 
                        
  18.     mobileNos = "Sample"'99999999xx,99999998xx
    19. 
                        
  19.     smsContentType = "english"'eg - english or unicode
    20.   
                        
  20.     message = "Hello this is test"
    21. 
                        
  21.     senderId = "Sample" 'eg -- Testin'
    22. 
                        
  22.     routeId = “Sample" 'eg 1'
    23. 
                        
  23.     scheduleddate = "" ‘optional if(scheduledate  eg “26/08/2015 17:00”)
    24. 
                        
  24.     signature ="" ‘optional if(signature available  eg “1”)
    25. 
                        
  25.     groupId ="" ‘optional if(groupId available eg “1”)
    26.     
                        
  26.  
    27. 	
	                    
  27.     'adding URL + AuthKey
    28. 
                        
  28.     sURL = URL & "?AUTH_KEY=" & authKey
    29. 
                        
  29.     Set objXML = CreateObject("Microsoft.XMLHTTP")
    30. 
                        
  30.     objXML.Open "POST", sURL, False
    31. 
                        
  31.     objXML.SetRequestHeader "Content-Type", "application/json"
    32. 
                        
  32.  
    33.        
                        
  33.             returnData = SendSMSPostData(message, senderId, routeId, mobileNos, smsContentType, signature, groupId, scheduleddate)
    34. 
                        
  34.  
    35.        
                        
  35.       '  Text1.Text = returnData
    36. 
                        
  36.  
    37. 
                        
  37.     objXML.Send returnData
    38. 
                        
  38.     MsgBox returnData
    39. 
                        
  39.  
    40.  
                        
  40.  ' objXML.Send (returnData)
    41. 
                        
  41.  
    42.    
                        
  42.     '"AUTH_KEY=" + authKey + "smsContent=" + message + "&mobileNumbers=" + mobiles + "&senderId=" + sender + "&routeId=" + route + "&smsContentType=" + smsContent
    43. 
                        
  43.      If Len(objXML.ResponseText) > 0 Then
    44. 
                        
  44.             MsgBox objXML.ResponseText
    45. 
                        
  45.  
    46.            
                        
  46.      End If
    47. 
                       
  47.  End Sub
    48. 
                       
  48. 
                       
  49.  Function SendSMSPostData(smsContent As String, senderId As String, routeId As String,
    50. 
                       
  50.  mobileNos As String, smsContentType As String, signature As String, groupId As String, scheduleddate As String) As String
    51. 
                       
  51.  Dim data, V_groupId, V_mobileNos, V_senderId, V_smsContentType, V_signature, V_routeId, V_authKey, V_smsContent, V_scheduleddate As String
    52. 
                       
  52. 
                       
  53.  'V_authKey = "AUTH_KEY=" & authKey
    54. 
                       
  54.  'sURL = "Sample"
    55. 
                       
  55. 
                       
  56.  V_smsContent = "{""smsContent""" & ":""" & smsContent & ""","
    57. 
                       
  57. 
                       
  58.  V_routeId = """routeId""" & ":""" & routeId & ""","
    59. 
                       
  59. 
                       
  60.  V_groupId = """groupId""" & ":""" & groupId & ""","
    61. 
                       
  61.  V_mobileNos = """mobileNumbers""" & ":""" & mobileNos & ""","
    62. 
                       
  62.  V_senderId = """senderId""" & ":""" & senderId & ""","
    63. 
                       
  63.  V_smsContentType = """smsContentType""" & ":""" & smsContentType & """"
    64. 
                       
  64.  data = V_smsContent & V_senderId & V_routeId & V_mobileNos & V_smsContentType & V_signature
    65. 
                       
  65. 
                       
  66.  If (Len(signature) > 0) Then
    67. 
                       
  67.      V_signature = ",""signature""" & ":""" & signature & """"
    68. 
                       
  68.      data = data + V_signature
    69. 
                       
  69.     
                       
  70.     ' MsgBox V_signature
    71. 
                       
  71.     
                       
  72.  End If
    73. 
                       
  73.  If (Len(groupId) > 0) Then
    74. 
                       
  74.      V_groupId = ",""groupId""" & ":" & """ groupId & """""
    75. 
                       
  75.      data = data + V_groupId
    76. 
                       
  76.      'MsgBox V_signature
    77. 
                       
  77.     
                       
  78.  End If
    79. 
                       
  79.  If (Len(scheduleddate) > 0) Then
    80. 
                       
  80.      V_scheduleddate = ",""scheduleddate""" & ":" & """ scheduleddate & """""
    81. 
                       
  81.     ' data = data + V_scheduleddatev
                       
  82.     
                       
  83.    
                       
  84.  End If
    85. 
                       
  85. 
                       
  86.  data = data + "}"
    87. 
                       
  87. 
                       
  88.   SendSMSPostData = data
    89. 
                       
  89. 
                       
  90.  End Function
    91. 
                       
  91.  Function URLEncode(ByVal Text >As String) As String
    92. 
                       
  92.      Dim i As Integer
    93. 
                       
  93.      Dim acode As Integer
    94. 
                       
  94.      Dim char As String
    95. 
                       
  95.     
                       
  96.      URLEncode = Text
    97. 
                       
  97.     
                       
  98.      For i = Len(URLEncode) To 1 Step -1
    99. 
                       
  99.          acode = Asc(Mid$(URLEncode, i, 1))
    100. 
                       
  100.          Select Case acode
    101. 
                       
  101.              Case 48 To 57, 65 To 90, 97 To 122
    102. 
                       
  102.                  ' don't touch alphanumeric chars
    103. 
                       
  103.              Case 32
    104. 
                       
  104.                  ' replace space with "+"
    105. 
                       
  105.                  Mid$(URLEncode, i, 1) = "+"
    106. 
                       
  106.              Case Else
    107. 
                       
  107.                  ' replace punctuation chars with "%hex"
    108. 
                       
  108.                  URLEncode = Left$(URLEncode, i - 1) & "%" & Hex$(acode) & Mid$ _
    109. 
                       
  109.                      (URLEncode, i + 1)
    110. 
                       
  110.          End Select
    111. 
                       
  111.      Next
    112. 
                       
  112. 
                       
  113. Function
    114. 
                    

              
                    
    
                        
  1. Private Sub Command1_Click()
    2. 
                        
  2.      Dim objXML As Object
    3. 
                        
  3.      Dim message As String
    4. 
                        
  4.      Dim authKey As String
    5. 
                        
  5.      Dim mobileNos As String
    6. 
                        
  6.      Dim senderId As String
    7. 
                        
  7.      Dim routeId As String
    8. 
                        
  8.      Dim groupId As String
    9. 
                        
  9.      Dim sURL, URL As String
    10. 
                        
  10.      Dim smsContentType As String
    11. 
                        
  11.      Dim signature As String
    12. 
                        
  12.      Dim returnData As String
    13. 
                        
  13.       'Set these variables
    14. 
                        
  14. 
	                    
  15.      authKey = "Sample Auth key" 'eg -- 16 digits alphanumeric
    16. 
                        
  16.      URL = "Sample"  'eg-- www.abc.com
    17. 
                        
  17.      mobileNos = "Sample" '99999999xx,99999998xx
    18. 
                        
  18.      smsContentType = "english" 'eg - english or unicode
    19.   
                        
  19.      message = "Hello this is test"
    20. 
                        
  20.      senderId = "Sample" 'eg -- Testin'
    21. 
                        
  21.      routeId = “Sample" 'eg 1'
    22. 
                         
  22.      scheduleddate = "" ‘optional if(scheduledate  eg “26/08/2015 17:00”)
    23. 
                         
  23.      signature ="" ‘optional if(signature available  eg “1”)
    24. 
                         
  24.      groupId ="" ‘optional if(groupId available eg “1”)
    25.     
                         
  25.    
    26. 
                         
  26.    'adding URL + AuthKey
    27. 
                         
  27.     sURL = URL & "?AUTH_KEY=" & authKey
    28. 
                         
  28.     Set objXML = CreateObject("Microsoft.XMLHTTP")
    29. 
                         
  29.     objXML.Open "POST", sURL, False
    30. 
                         
  30.     objXML.SetRequestHeader "Content-Type", "application/xml"
    31. 
                         
  31.        
    32. 
                         
  32.        returnData = SendSMSXMLData(authKey, message, senderId, routeId, mobileNos, smsContentType, signature, groupId, "")
    33. 
                         
  33.        
    34. 
                         
  34.      '  Text1.Text = returnData
    35. 
                         
  35.     objXML.Send (returnData)
    36. 
                         
  36.    
    37. 
                         
  37.    '"AUTH_KEY=" + authKey + "smsContent=" + message + "&mobileNumbers=" + mobiles + "&senderId=" + sender + "&routeId=" + route + "&smsContentType=" + smsContent
    38. 
                         
  38.     If Len(objXML.ResponseText) > 0 Then
    39. 
                         
  39.            MsgBox objXML.ResponseText
    40. 
                         
  40.            
    41. 
                         
  41.     End If
    42. 
                       
  42.  End Sub
    43. 
                        
  43. 
                        
  44. Function URLEncode(ByVal Text As String) As String
    45. 
                        
  45.          Dim i As Integer
    46. 
                        
  46.          Dim acode As Integer
    47. 
                        
  47.          Dim char As String
    48. 
                        
  48.     
    49. 
                        
  49.     URLEncode = Text
    50. 
                        
  50.     
    51. 
                        
  51.     For i = Len(URLEncode) To 1 Step -1
    52. 
                        
  52.         acode = Asc(Mid$(URLEncode, i, 1))
    53. 
                        
  53.         Select Case acode
    54. 
                        
  54.             Case 48 To 57, 65 To 90, 97 To 122
    55. 
                        
  55.                 ' don't touch alphanumeric chars
    56. 
                        
  56.             Case 32
    57. 
                        
  57.                 ' replace space with "+"
    58. 
                        
  58.                 Mid$(URLEncode, i, 1) = "+"
    59. 
                        
  59.             Case Else
    60. 
                        
  60.                 ' replace punctuation chars with "%hex"
    61. 
                        
  61.                 URLEncode = Left$(URLEncode, i - 1) & "%" & Hex$(acode) & Mid$ _
    62. 
                        
  62.                     (URLEncode, i + 1)
    63. 
                        
  63.         End Select
    64. 
                        
  64.     Next
    65. 
                        
  65.     
    66. 
                        
  66. End Function
    67. 
                        
  67. 
                        
  68. Function SendSMSXMLData(authKey As String, smsContent As String, senderId As String, routeId As String, mobileNos As String, 
    69. 
                        
  69. smsContentType As String, signature As String, groupId As String, scheduleddate As String) As String
    70. 
                        
  70. Dim data, V_groupId, V_mobileNos, V_senderId, V_smsContentType, V_signature, V_routeId, V_authKey, V_smsContent, V_scheduleddate As String
    71. 
                        
  71. 
                        
  72. 'V_authKey = "AUTH_KEY=" & authKey
    73. 
                        
  73. 'sURL = "http://167.114.186.70/rest/services/sendSMS/sendGroupSms" 
    74. 
                        
  74. 
                        
  75. V_smsContent = "<smsContent>" & smsContent & "</smsContent>"
    76. 
                        
  76. 
                        
  77. V_routeId = "<routeId>" & routeId & "</routeId>"
    78. 
                        
  78. 
                        
  79. V_mobileNos = "<mobileNumbers>" & mobileNos & "</mobileNumbers>" '"""mobileNumbers""" & ":""" & mobileNos & ""","
    80. 
                        
  80. V_senderId = "<senderId>" & senderId & "</senderId>" '"""senderId""" & ":""" & senderId & ""","
    81. 
                        
  81. V_smsContentType = "<smsContentType>" & smsContentType & "</smsContentType>" '"""smsContentType""" & ":""" & smsContentType & """"
    82. 
                        
  82. 
                        
  83. If (Len(signature) > 0) Then
    84. 
                        
  84.     V_signature = "<signature>" & signature & "</signature>" ' ",""signature""" & ":""" & signature & """"
    85. 
                        
  85.     
                        
  86. End If
    87. 
                        
  87. If (Len(groupId) > 0) Then
    88. 
                        
  88.     V_groupId = ",""groupId""" & ":" & """ groupId & """""
    89. 
                        
  89.     
                        
  90. End If
    91. 
                        
  91. If (Len(scheduleddate) > 0) Then
    92. 
                        
  92.     V_scheduleddate = ",""scheduleddate""" & ":" & """ scheduleddate & """""
    93. 
                        
  93.     
                        
  94. End If
    95. 
                        
  95. 
                        
  96. 'data = data + "</SMS>"
    97. 
                        
  97. 
                        
  98. data = "<Sms>" + "<AUTH_KEY>" + authKey + "</AUTH_KEY>" + V_smsContent & V_senderId & V_routeId & V_mobileNos & V_smsContentType & V_signature + "</Sms>"
    99. 
                        
  99.  SendSMSXMLData = data
    100. 
                        
  100. 
                        
  101. End Function
    102.

Caution: Some users opt to place their request inside a code loop, while testing we highly recommend setting the test parameter to true , as occasionally an infinite loop can occur and users can consume all their credits very quickly.

Parameters

sender If you have a promotional account, do not send this parameter. If you have a transactional account, use this field to specify the sender name for your message. Sender name must be 6 alpha characters and should be pre-approved by Textlocal. In the absence of approved sender names, use the default 'TXTLCL'
message The message content. This parameter should be no longer than 766 characters. See Helpful Information for message length details. The message also must be URL Encoded to support symbols like &.
Login Parameters (Additional Information)
username The email address used to log into Textlocal.
hash Your secure hash can be found within Messenger in the main navigation under "Help->All Documentation". Alternatively you can use the password parameter instead and use your Textlocal password in plain text.
Optional Parameters
apiKey This can be used instead of the username/hash/password. You can create them in your Messenger Control Panel (click here) for each application, and limit the usage of them by host IP Address.
numbers Comma-delimited list of mobile numbers in international format (i.e. 918123456789).
group_id This parameter can be used in place of the numbers parameter in order to send to an entire contact group. This parameter should contain the ID of the relevant group, which can found either within Messenger (in the "Reports" - "Advanced Reports" - "List of Group ID's" section) or by running the get_groups command. Additionally group 5 contains "contacts" and group 6 contains "opt-outs".
schedule_time This parameter can be used to specify a schedule date/time for your message, which should be provided in Unix timestamp format. Times should be provided in GMT.
receipt_url Use this field to specify an alternative URL to which the delivery receipt(s) will be sent. See handling receipts documentation.
custom This value will be set against the message batch and will passed back in the delivery receipts. This allows you to match delivery receipts to their corresponding messages.
optouts Can be set to true in order to check against your own opt-outs list and Textlocal's global opt-outs database. Your message will not be sent to numbers within these lists. If not provided defaults to false.
unicode Set this value to true to specify that your message body will contain unicode characters. See Encoding/Decoding Unicode Documentation
test Set this field to true to enable test mode, no messages will be sent and your credit balance will be unaffected. If not provided defaults to false
Note 51: Error Code's for Missing Parameters:

Errors

Error Codes Description
3001 * for Success
3002 * Invalid URL
3003 * Invalid User/Password
3004 * Invalid Message Type
3005 * Invalid Message
3006 * Invalid Destination
3007 * Invalid Source
3008 * Invalid DLR Field
3009 * Authentication Failed
3010 * Internal Error
3011 * Insufficient Balance
3012 * Responce Time Out
3013 * Invalid Request Content Type
3014 * Missing Mobile Number
3015 * SMs Content for Approval
3016 * Missing Required Parameter
3017 * FAIL
3018 * Expired Account
3019 * Null Pointer Exception code
3020 * Empty User Name
3021 * Empty Password
3022 * User Name not Available
3023 * Session Expired
3024 * Already Exist
3025 * Empty Group Name
3026 * Empty Contact Name
3027 * Empty Mobile Number
3028 * Empty Group Id
3029 * Empty City Name
3030 * Empty Occupation
3041 * Empty E-Mail Id
3042 * Group not Exist
3043 * Empty Message
3044 * Empty Route Id
3045 * Empty Sender Id
3047 * Empty Draft Id
3048 * Empty First Name
3049 * Empty Last Name
3050 * Empty Balance
3051 * Empty Role Id
3052 * For User Name Length
3053 * Empty Expiry Date/td>
3054 * Invalid Date
3055 * Empty Client Id
3056 * Invalid Status
3057 * Empty Country Name
3058 * Empty State Name
3059 * Session Expired
3060 * Empty Date
3061 * Access Denied
3062 * Empty Old Password
3063 * Password not Maching
3064 * Empty SMS
3065 * Empty Amount
3066 * Empty Address
3067 * Empty RequestId
3068 * Empty Group and MobileNo
3069 * Empty Description
3070 * Fail to Change RoleId
3071 * Empty CallerId
3072 * Empty File URL and Draft
3073 * Empty Duration
3074 * Invalid Request
3075 * Invalid Aoudio file
3076 * Missing Upload File

Warnings

Warning Codes
3 Invalid number.
For Any Help Call Us Anywhere Anytime On   +91-94068-11127
Call Us +91-94068-11127
Login Sign Up