Ruby code samples for integration with the LabsMobile SMS API

Below are the examples of programming code in Ruby language to send SMS messages through the LabsMobile platform API.

This documentation is designed for you to connect your applications with the LabsMobile platform and automate the sending of SMS messages. The main objective of the integration of these applications is the sending of SMS messages and related communications.

Advice We recommend using our API SMS http/POST in JSON format for any integration with the LabsMobile platform. But we have other API versions that you can use depending on your environment and requirements.

With these examples you will be able to perform the integration of the following functionalities:

Send SMS messages individually or in bulk.
Check your account balance.
Receive delivery confirmation and/or error notifications corresponding to the messages sent.
Obtain notification and data of the messages received in the virtual numbers contracted.

To be taken into account

The LabsMobile API SMS uses a common base URL for all requests: https://api.labsmobile.com.

It is highly recommended to use a URL that includes the HTTPS protocol in any version of the API.

Authentication is done with the username and an API token, myUsername:myToken. You must create the API token from the API Settings section of your account.

Send SMS with http/POST

Here is an example of code in Ruby language to send SMS messages using the API SMS http/POST that uses the JSON format for the information exchange variables.

As you can see, you need to create a structure in JSON format containing all the necessary parameters for sending and make a HTTP/POST call with this data in the body of the request.

require "uri"
require "json"
require 'base64'
require "net/http"

url = URI("https://api.labsmobile.com/json/send")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Basic " + Base64.strict_encode64("myUsername:myToken")
request.body = JSON.dump({
 "message": "Your verification code is 123",
 "tpoa": "Sender",
 "recipient": [
   {
     "msisdn": "12015550123"
   }
 ]
})

response = https.request(request)
puts response.read_body

require "uri"
require "json"
require 'base64'
require "net/http"

url = URI("https://api.labsmobile.com/json/send")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Basic " + Base64.strict_encode64("myUsername:myToken")
request.body = JSON.dump({
 "message": "Don't miss our Sale! Use code XXXX123 for 20% off.",
 "tpoa": "Sender",
 "recipient": [
   {
     "msisdn": "12015550123"
   },
   {
     "msisdn": "12015550124"
   },
   {
     "msisdn": "12015550125"
   }
 ]
})

response = https.request(request)
puts response.read_body

{
  "subid": "65f33a88ceb3d",
  "code": "0",
  "message": "Message has been successfully sent."
}

{
  "subid": "65f7f7041385d",
  "code": "35",
  "message": "The account has no enough credit for this sending"
}

All error codes can be found in API documentation, error codes.

For more details on the available parameters and configuration options, see the official documentation at:

SMS http/POST API Documentation

Send SMS with http/GET

This is an example of code in Ruby language to send SMS messages using the SMS API http/GET.

As you will see, you must pass a series of GET variables in the same URL and make a HTTP call. It is important to encode all values as URL using the URI.encode_www_form() function.

Important The SMS http/GET API transmits credentials (username and API token) unencrypted and unsecured. We recommend using this API GET only when absolutely essential and use the API SMS http/POST instead.

require "uri"
require "net/http"

url = URI("http://api.labsmobile.com/get/send.php")

data = {
 'username' => 'myUsername',
 'password' => 'myToken',
 'msisdn' => '[12015550123]',
 'message' => 'Your verification code is 123'
}

url.query = URI.encode_www_form(data)
https = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)

response = https.request(request)
puts response.read_body

require "uri"
require "net/http"

url = URI("http://api.labsmobile.com/get/send.php")

data = {
 'username' => 'myUsername',
 'password' => 'myToken',
 'msisdn': '[12015550123,12015550124,12015550125]',
 'message' => "Don't miss our Sale! Use code XXXX123 for 20% off."
}

url.query = URI.encode_www_form(data)
https = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)

response = https.request(request)
puts response.read_body

{
  "subid": "65f33a88ceb3d",
  "code": "0",
  "message": "Message has been successfully sent."
}

{
  "subid": "65f7f7041385d",
  "code": "35",
  "message": "The account has no enough credit for this sending"
}

All error codes can be found in API documentation, error codes.

For more details on the available parameters and configuration options, see the official documentation at:

SMS http/GET API Documentation

Account balance inquiry

With this code example in Ruby you can consult your account balance using LabsMobile's API SMS.

Through a call to this endpoint, you can get information about the amount of credits available in your LabsMobile account. The connection is established through a HTTP/GET request with authentication in the HTTP connection header.

require "uri"
require "json"
require 'base64'
require "net/http"

url = URI("https://api.labsmobile.com/json/balance")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Basic " + Base64.strict_encode64("myUsername:myToken")
request.body = ""

response = https.request(request)
puts response.read_body

{"code":0,"credits":"10"}

See the complete documentation at:

Documentation Balance inquiry

Receive status of sent messages

This example script receives a call from the LabsMobile platform when a sent SMS message changes status. To implement this solution, it is essential to configure the appropriate parameters, the confirmation URL in the ackurl parameter in the request or the default URL in the API Settings of your account.

Therefore, it is necessary to publish a script like this in your system so that our platform calls the URL when a status change occurs in any of the sent messages.

The example code obtains the URL parameters using the global $_GET variable and then assigns these parameters to local variables.

require 'socket'
require 'uri'

server = TCPServer.open(3000)

def parse_request(request)
 params = {}
 URI.decode_www_form(request.split('?')[1]).each do |key, value|
   params[key] = value
 end
 params
end

loop do
 client = server.accept
 request_line = client.gets
 next unless request_line

 method, full_path = request_line.split(' ')
 path, query = full_path.split('?')

 if path == '/'
   params = parse_request(request_line)
   puts "Received parameters:"
   params.each { |key, value| puts "#{key}: #{value}" }
   response = "HTTP/1.1 200 OK\r\nContent-Type: text/plain\r\n\r\nReceived parameters.\r\n"
 else
   response = "HTTP/1.1 404 Not Found\r\nContent-Type: text/plain\r\n\r\n404 Not Found\r\n"
 end

 client.print(response)
 client.close
end

See the complete documentation at:

Documentation Receipt of sent SMS statuses

Receiving SMS messages

Once you have contracted a virtual number, you will be able to receive messages via API on a specific URL via a HTTP/GET call to a script in your system. Each message received will invoke the URL, transmitting all its data in variables in JSON format.

To activate this functionality you must inform the URL for receiving messages in the Settings of your account.

It is necessary to configure an endpoint in your system so that the LabsMobile platform calls this script when an SMS is received on any of the contracted virtual numbers.

The example code obtains the URL parameters using the global variable $_GET and then assigns these parameters to local variables.

require 'socket'
require 'uri'

server = TCPServer.open(3000)
port = server.addr

def parse_request(request)
 params = {}
 URI.decode_www_form(request.split('?')[1]).each do |key, value|
   params[key] = value
 end
 params
end

loop do
 client = server.accept
 request_line = client.gets
 next unless request_line

 method, full_path = request_line.split(' ')
 path, query = full_path.split('?')

 if path == '/'
   params = parse_request(request_line)
   puts "Received parameters:"
   params.each { |key, value| puts "#{key}: #{value}" }
   client.print("HTTP/1.1 200 OK\r\nContent-Type: text/plain\r\n\r\n")
   client.print("Received parameters.\r\n")
 else
   client.print("HTTP/1.1 404 Not Found\r\nContent-Type: text/plain\r\n\r\n")
   client.print("404 Not Found\r\n")
 end

 client.close
end

See the complete documentation at:

Documentation Receipt of SMS messages

Support resources

We recommend that you consult and take into account the following support resources in your integration: