How to send sms from Scala

The most simple way to send SMS from Scala is to use the built in HTTP/Rest SMS api of Ozeki SMS Gateway. When you use this API, you will send SMS messages by issuing a HTTP Post request to the SMS gateway. The HTTP Post request will contain a message formatted in json format. The SMS gateway will send this SMS to the recipient phone, and it will return a HTTP 200 OK response to your request.

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

Scala code to send sms to mobile

The Scala sms code sample below demonstrates how you can send SMS using the http rest sms api of Ozeki SMS Gateawy with 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.

SendSms.scala 
import Ozeki.Libs.Rest.{ Configuration, Message, 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 msg = Message(
        ToAddress = "+36201111111",
        Text = "Hello world!"
    )

    val api = MessageApi(configuration)

    val result = api.Send(msg)

    println(result)
  }
}

Code 1 - SendSms.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 send 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 SendSms.scala

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

What is in the SendSms.scala.zip file?

In the SendSms.scala.zip you will find an InteliJ project with a source folder and in the source (src) folder you can find the Ozeki.Libs.Rest library and the main.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 SendSms.scala.zip

How to send SMS from Scala (Simple guidelines)

To send 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 SendSms.scala.zip file
  5. Open the SendSms.scala project with the InteliJ IDE
  6. Launch Ozeki SMS Gateway app
  7. Run SendSend.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 send 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 send 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 Scala 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 send 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 send SMS from Scala

To send 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 send SMS from Scala

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

POST /api?action=sendmsg HTTP/1.1
HTTP2-Settings: AAEAAEAAAAIAAAABAAMAAABkAAQBAAAAAAUAAEAA
Connection: Upgrade, HTTP2-Settings
Upgrade: h2c
Content-Length: 327
Content-Type: application/json
Accept: application/json
Authorization: Basic aHR0cF91c2VyOnF3ZTEyMw==
Host: 127.0.0.1:9509
User-Agent: Java-http-client/16.0.1

{
	"messages": [
		{
			"message_id":"2f8aa62a-bdad-436b-a824-2aba0a79c39f",
			"to_address":"+36201111111",
			"text":"Hello world!",
			"create_date":"2021-07-15T08:59:28",
			"valid_until":"2021-07-22T08:59:28",
			"time_to_send":"+1000000000-01-01T00:00:00",
			"submit_report_requested":true,
			"view_report_requested":true,
			"delivery_report_requested":true
		}
	]
}

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 08:08:03 GMT
Server: 10/10.3.123
Transfer-Encoding: chunked

{
	"http_code": 200,
	"response_code": "SUCCESS",
	"response_msg": "Messages queued for delivery.",
	"data": {
	  "total_count": 1,
	  "success_count": 1,
	  "failed_count": 0,
	  "messages": [
	    {
	      "message_id": "2f8aa62a-bdad-436b-a824-2aba0a79c39f",
	      "from_station": "%",
	      "to_address": "+36201111111",
	      "to_station": "%",
	      "text": "Hello world!",
	      "create_date": "2021-07-15 08:59:28",
	      "valid_until": "2021-07-22 08:59:28",
	      "time_to_send": "2021-07-15 08:59:28",
	      "submit_report_requested": true,
	      "delivery_report_requested": true,
	      "view_report_requested": false,
	      "tags": [
	        {
	          "name": "Type",
	          "value": "SMS:TEXT"
	        }
	      ],
	      "status": "SUCCESS"
	    }
	  ]
	}
}

Connect your SMS gateway to the mobile network and create an HTTP API user account

We assume, you have already installed Ozeki SMS Gateway, and you have connected it to the mobile network. In order to be able to send SMS to a mobile phone from Scala, you need to setup an HTTP API user account in Ozeki SMS Gateway.

Video 1 - How to setup an HTTP API user account

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

This video shows you how to download the SendSms.scala.zip file from this page. If watch the video, you will notice, that the contents of the SendSms.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 2 - How to download and extract the example project

Scala sms example: SendSms.scala

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

example code to send sms using scala
Figure 3 - SendSms.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 3 - Sending SMS with the Scala code above

How to check that the SMS has been sent to the mobile network

The final step in verifying the procedure is to take a look at the logs of the mobile network connection. You might have to turn on logging in the configuration of the connection before you send the message to see the logs. If logging is enabled you will see the phone number and the text of the message you have sent.

Video 4 - How to test if the request was accepted by the SMPP client

Receiving an SMS message on an Android phone

In this video, you will see how receiving an SMS on an Android phone looks like. The video will start with an ordinary Android home page, and you will see how an SMS notification pops up and how you can open the full SMS. The video is only 18 seconds long and it is worth watching because you will see the whole SMS receiving process.

Video 5 - SMS message received on the mobile phone

Summary

This article was meant the show the steps of SMS sending in Scala with the help of Ozeki SMS Gateway. If the steps were followed carefully, messaging with Scala codes and Ozeki SMS Gateway should not be a problem. Ozeki SMS Gateway allows you to log SMS messages into a database and offers several reporting functions to give you more information about the SMS communication.

Continue reading on Ozeki's tutorial page, where more interesting article can be found about topics like multiple SMS sending and SMS scheduling in Scala.

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

More information