How to receive SMS from R

The most simple way to receive SMS from R 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 request will contain a folder. The SMS gateway will send the SMS messages to the client, and it will return a HTTP 200 OK response to your request.

how to receive sms from r
Figure 1 - How to receive SMS from R

R code to receive sms to mobile

The R sms code sample below demonstrates how you can receive an SMS using the http rest sms api of Ozeki SMS Gateawy using the R 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.R 
library(Ozeki.Libs.Rest)


configuration <- Ozeki.Libs.Rest::Configuration$new(
  username = "http_user",
  password = "qwe123",
  api_url = "http://127.0.0.1:9509/api"
)

api <- Ozeki.Libs.Rest::MessageApi$new(configuration)

result <- api$download_incoming()

print(result$to_string())

for (message in result$messages) {
  print(message$to_string())
}

Code 1 - ReceiveSms.R

How to use the R sms example:

This R sms example can be used in any R 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 R 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.R

The source code explained in this article can be downloaded and used and modified free of charge.
Download: ReceiveSms.R.zip (391B)

What is in the ReceiveSms.R.zip file?

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

Figure 2 - What is inside ReceiveSms.R.zip

How to receive SMS from R (Simple guidelines)

To send SMS from R:

  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.R.zip file
  5. Launch Ozeki SMS Gateway app
  6. Run ReceiveSms.R R code using the command prompt
  7. 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 R, first you need to install Ozeki SMS Gateway. The SMS gateway can be installed on the same computer, where you develop your R 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 receive 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 R code.

HTTP API url to use receive sms from R

To send SMS from R, your R 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 R

To authenticate the R 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 R you can use the following code to do this encoding: 

username_password <- paste(username, ":", password, sep="")
username_password_encoded <- base64enc::base64encode(charToRaw(username_password))
return (paste("Basic", username_password_encoded, sep=" "))

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 R

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 R

To submit the SMS, your R application will send an HTTP request similar to the one below. Note, that this request contains a HTTP a header part, which contains all the data we need to receive the messages from a specific folder. 

GET /api?action=receivemsg&folder=inbox HTTP/1.1
Content-Type: application/json
Accept: application/json
Accept-Encoding: deflate, gzip
Authorization: Basic aHR0cF91c2VyOnF3ZTEyMw==
Host: 127.0.0.1:9509
User-Agent: libcurl/7.64.1 r-curl/4.3.2 httr/1.4.2

HTTP response received by the R 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: Tue, 13 Jul 2021 15:29:23 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": "85a57d61-808a-481b-98d7-6136bf87dce0",
	      "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 12:46:23",
	      "valid_until": "2021-07-20 12:46:23",
	      "time_to_send": "2021-07-13 12:46:23",
	      "submit_report_requested": true,
	      "delivery_report_requested": false,
	      "view_report_requested": false,
	      "tags": [
	        {
	          "name": "Type",
	          "value": "SMS:TEXT"
	        }
	      ]
	    },
	    {
	      "message_id": "76d551d6-1096-4943-ae50-1efc71049b6f",
	      "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 12:46:23",
	      "valid_until": "2021-07-20 12:46:23",
	      "time_to_send": "2021-07-13 12:46:23",
	      "submit_report_requested": true,
	      "delivery_report_requested": false,
	      "view_report_requested": false,
	      "tags": [
	        {
	          "name": "Type",
	          "value": "SMS:TEXT"
	        }
	      ]
	    },
	    {
	      "message_id": "52af9742-f533-4056-a9cf-2fb8d4ef0613",
	      "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 12:46:23",
	      "valid_until": "2021-07-20 12:46:23",
	      "time_to_send": "2021-07-13 12:46:23",
	      "submit_report_requested": true,
	      "delivery_report_requested": false,
	      "view_report_requested": false,
	      "tags": [
	        {
	          "name": "Type",
	          "value": "SMS:TEXT"
	        }
	      ]
	    }
	  ]
	}
}

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

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

Video 1 - How to download and extract the example project

R sms example: ReceiveSms.R

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

r source code to receive sms
Figure 3 - ReceiveSms.R 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 with the R code above

Conclusion

The purpose of this guide was to show the steps of SMS receiving in R with Ozeki SMS Gateway. This solution enables you to move the messages from the Inbox folder to your R program, so these messages can be collected in their destined place. Ozeki SMS Gateway can be downloaded from Ozeki's website and can be used in a trial period free of charge.

Make sure to continue reading on Ozeki's tutorial page, where there are articles about similar subjects, like multiple SMS sending and SMS scheduling in R.

The only thing to do now is to download Ozeki SMS Gateway and let the work begin!

More information