How to receive SMS from Scala

The most simple way to receive SMS from Scala is to use the built in HTTP/Rest SMS api of Ozeki SMS Gateway. When you use this API, you will receive SMS messages by issuing a HTTP Get request to the SMS gateway. The HTTP Get will contain a folder name which you would like to receive messages from. The SMS gateway will send the all the messages from the folder to your scala client application, and it will return a HTTP 200 OK response to your request.

how to receive sms from scala
Figure 1 - How to receive SMS from Scala

Scala code to receive sms messages to mobile

The Scala sms code sample below demonstrates how you can send a scheduled SMS using the http rest sms api of Ozeki SMS Gateawy using the Scala Ozeki.Libs.Rest library. This library is provided to you free of charge, and you may use it and modify it in any of your projects.

ReceiveSms.scala 
import Ozeki.Libs.Rest.{ Configuration, MessageApi }


object main  {
  def main(args: Array[String]): Unit = {
      
    val configuration = Configuration(
      Username = "http_user",
      Password = "qwe123",
      ApiUrl = "http://127.0.0.1:9509/api"
    )

    val api : MessageApi = MessageApi(configuration)

    val result = api.DownloadIncoming()

    println(result)

    for (message <- result.Messages) {
      println(message)
    }
  }
}

Code 1 - ReceiveSms.scala

How to use the Scala sms example:

This Scala sms example can be used in any Scala application. To use it, you must download the Ozeki.Libs.Rest library. After the library is downloaded, you need to add a reference to it in your Scala source code. This will allow you to use the classes provided by the Ozeki.Libs.Rest library. You can use the Message class to create the SMS. You can use the MessageApi class to receive the SMS to the SMS gateway. The SMS gateway will forward your message to the mobile network either through a wireless connection or through the Internet.

Download ReceiveSms.scala

The source code explained in this article can be downloaded and used and modified free of charge.
Download: ReceiveSms.scala.zip (90.6Kb)

What is in the ReceiveSms.scala.zip file?

In the ReceiveSms.scala.zip you will find the ReceiveSms.scala file, which contains the example code to show you how to send an SMS. This example code is listed below.

Figure 2 - What is inside ReceiveSms.scala.zip

How to receive SMS from Scala (Simple guidelines)

To receive SMS from Scala:

  1. Install a HTTP API user
  2. Enable Log communication events on the Advanced tab
  3. Setup Visual Studio
  4. Download then extract the ReceiveSms.scala.zip file
  5. Open the ReceiveSms.scala project with the InteliJ IDE
  6. Launch Ozeki SMS Gateway app
  7. Run ReceiveSms.scala Scala code by executing it in the IntelliJ IDE
  8. Check the logs to see if the SMS sent

Install Ozeki SMS Gateway and create an HTTP API user

To be able to receive SMS from Scala, first you need to install Ozeki SMS Gateway. The SMS gateway can be installed on the same computer, where you develop your Scala code in any text editor, such as windows notepad. After installation, the next step is to connect Ozeki SMS Gateway to the mobile network. You can send a test sms from the Ozeki GUI to verify, that your mobile network connection works. The final step to prepare your environment is to create a HTTP sms api user. Create a user with a username of "http_user", and with a password of "qwe123" to make the example work without modification.

After the environment is setup, you can run your Scala code.

HTTP API url to use receive sms from Scala

To send SMS from Scala, your Scala will will have to issue an HTTP request to the SMS gateway. The API url is shown below. Note that the IP address (127.0.0.1) should be replaced to the IP address of your SMS gateway. If Ozeki SMS Gateway is installed on the same computer where the R sms application is running, this can be 127.0.0.1. If it is installed on a different computer it should be the IP address of that computer. 

http://127.0.0.1:9509/api?action=rest

HTTP authentication to use receive sms from Scala

To authenticate the Scala sms client, you need to send the username and password in a base64 encoded string to the server in a HTTP request. The format used is: base64(username+":"+password). In Scala you can use the following code to do this encoding: 

val usernamePassword = "%s:%s".format(Username, Password).getBytes()
val usernamePasswordEncoded = Base64.getEncoder.encodeToString(usernamePassword)
"Basic %s".format(usernamePasswordEncoded)

For example if you encode the username 'http_user' and the password 'qwe123', you will get the following base64 encoded string: aHR0cF91c2VyOnF3ZTEyMw==. To send

HTTP request header to receive SMS from Scala

To receive the SMS messages, you need to include the following lines as headers in the HTTP request. Note that we include a content type and an Authorization header. 

Content-Type: application/json
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

HTTP request to receive SMS from Scala

To submit the SMS, your Scala application will send an HTTP request similar to the one below. Note, that this request contains a HTTP header part and a http body part. The HTTP body is a JSON encoded data string. It contains the recipient numbers and the texts for the messages we sent. 

GET /api?action=receivemsg&folder=inbox HTTP/1.1
HTTP2-Settings: AAEAAEAAAAIAAAABAAMAAABkAAQBAAAAAAUAAEAA
Connection: Upgrade, HTTP2-Settings
Upgrade: h2c
Content-Length: 0
Authorization: Basic aHR0cF91c2VyOnF3ZTEyMw==
Host: 127.0.0.1:9509
User-Agent: Java-http-client/16.0.1

HTTP response received by the Scala sms example

Once the SMS gateway receives this request, it will generate a HTTP response. The HTTP response will contain a status code, to indicate whether the SMS submit request was successful or not. It will also return a JSON encoded structure to provide you useful details about the messages submission. 

HTTP/1.1 200 OK
User-Agent: OZEKI 10.3.123 (www.myozeki.com)
Content-Type: application/json; charset=utf8
Last-Modified: Thu, 15 Jul 2021 11:23:02 GMT
Server: 10/10.3.123
Transfer-Encoding: chunked

{
	"http_code": 200,
	"response_code": "SUCCESS",
	"response_msg": "",
	"data": {
	  "folder": "inbox",
	  "limit": "1000",
	  "data": [
	    {
	      "message_id": "bf1960cf-1474-40ac-85aa-5487a6edeb7f",
	      "from_connection": "http_user@localhost",
	      "from_address": "+36202222222",
	      "from_station": "%",
	      "to_connection": "http_user@localhost",
	      "to_address": "http_user",
	      "to_station": "%",
	      "text": "Hello world 2",
	      "create_date": "2021-07-13 11:51:57",
	      "valid_until": "2021-07-20 11:51:57",
	      "time_to_send": "2021-07-13 11:51:57",
	      "submit_report_requested": true,
	      "delivery_report_requested": false,
	      "view_report_requested": false,
	      "tags": [
	        {
	          "name": "Type",
	          "value": "SMS:TEXT"
	        }
	      ]
	    },
	    {
	      "message_id": "df87cdf8-6e8b-4c99-a648-d2f24231bf04",
	      "from_connection": "http_user@localhost",
	      "from_address": "+36201111111",
	      "from_station": "%",
	      "to_connection": "http_user@localhost",
	      "to_address": "http_user",
	      "to_station": "%",
	      "text": "Hello world 1",
	      "create_date": "2021-07-13 11:51:57",
	      "valid_until": "2021-07-20 11:51:57",
	      "time_to_send": "2021-07-13 11:51:57",
	      "submit_report_requested": true,
	      "delivery_report_requested": false,
	      "view_report_requested": false,
	      "tags": [
	        {
	          "name": "Type",
	          "value": "SMS:TEXT"
	        }
	      ]
	    },
	    {
	      "message_id": "7308e035-f92d-4515-9d21-9bb80ef26e74",
	      "from_connection": "http_user@localhost",
	      "from_address": "+36203333333",
	      "from_station": "%",
	      "to_connection": "http_user@localhost",
	      "to_address": "http_user",
	      "to_station": "%",
	      "text": "Hello world 3",
	      "create_date": "2021-07-13 11:51:57",
	      "valid_until": "2021-07-20 11:51:57",
	      "time_to_send": "2021-07-13 11:51:57",
	      "submit_report_requested": true,
	      "delivery_report_requested": false,
	      "view_report_requested": false,
	      "tags": [
	        {
	          "name": "Type",
	          "value": "SMS:TEXT"
	        }
	      ]
	    }
	  ]
	}
}

How to receive SMS from Scala using the Scala sms api (Video tutorial)

This video shows you how to download the ReceiveSms.scala.zip file from this page. If you watch the video, you will notice, that the contents of the ReceiveSms.scala.zip are placed into the Windows desktop. You will also see, that we run the command promt in order to send the SMS.

Video 1 - How to download and extract the example project

Scala sms example: ReceiveSms.scala

The example code below is part of the ReceiveSms.scala.

example code to receive sms using scala
Figure 3 - ReceiveSms.scala file

How to check that the SMS has been accepted by the HTTP user

After the SMS has been submitted, it is a good idea to check your SMS gateway, to see what it has received. You can check the log by opening the HTTP user's details from the Ozeki SMS Gateway managment console. The following video shows you what to look for.

Video 2 - Receiving SMS messages with the Scala code above

Summary

This guide showed the basic steps of SMS receiving in Scala with the help of Ozeki SMS Gateway. If every step were followed carefully, forwarding the incoming messages to a Scala program should be very simple. With this solution, you can make sure that these messages are collected in a place where they should be. Important to note that Ozeki SMS Gateway runs in an environment that you control, so your contact list and data are in safe hands.

Continue reading on Ozeki's tutorial page where more information can be found about topics like SMS deleting and SMS scheduling in Scala.

The only thing to do now is to download Ozeki SMS Gateway and start working!

More information