Cómo recibir un SMS en Kotlin

La forma más sencilla de enviar SMS desde Kotlin es utilizar la API HTTP/Rest de SMS integrada de Ozeki SMS Gateway. Cuando uses esta API, enviarás mensajes SMS mediante una solicitud HTTP Post al gateway de SMS. La solicitud HTTP Post contendrá un mensaje formateado en formato JSON. El gateway de SMS enviará este SMS al teléfono del destinatario y devolverá una respuesta HTTP 200 OK a tu solicitud. (Figura 1)

cómo recibir un sms en kotlin
Figura 1 - Cómo recibir un SMS en Kotlin

Código Kotlin para recibir SMS en un móvil

El ejemplo de código SMS en Kotlin a continuación demuestra cómo puedes recibir mensajes SMS utilizando la API HTTP Rest de SMS de Ozeki SMS Gateway con la biblioteca Kotlin Ozeki.Libs.Rest. Esta biblioteca se te proporciona gratuitamente y puedes usarla y modificarla en cualquiera de tus proyectos.

Video 1 - Cómo descargar el ejemplo ReceiveSms.kt.zip (Tutorial en video)

MainActivity.kt 
package receive.sms

import androidx.appcompat.app.AppCompatActivity
import android.os.Bundle
import Ozeki.Libs.Rest.*
import android.widget.ArrayAdapter
import kotlinx.coroutines.*

class MainActivity : AppCompatActivity() {
    @DelicateCoroutinesApi
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        val listMessages:android.widget.ListView = findViewById(R.id.listMessages)
        val btnSendRequest:android.widget.Button = findViewById(R.id.btnSendRequest)

        val configuration = Configuration(
            username = "http_user",
            password = "qwe123",
            apiurl = "http://10.0.2.2:9509/api"
        )

        val messages_label : ArrayList<Message> = arrayListOf()

        val arrayAdapter = ArrayAdapter<Message>(this, android.R.layout.simple_list_item_1, messages_label)

        listMessages.adapter = arrayAdapter

        val api = MessageApi(configuration)

        btnSendRequest.setOnClickListener {
            GlobalScope.launch(Dispatchers.IO) {
                val result = api.DownloadIncomming()
                val messages = result.Messages
                for (index in 0 until messages.size) {
                    messages_label.add(messages.get(index))
                }
            }
            arrayAdapter.notifyDataSetChanged()
        }
    }
}
main_activity.xml 
<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context=".MainActivity">

    <Button
        android:id="@+id/btnSendRequest"
        android:layout_width="320dp"
        android:layout_height="wrap_content"
        android:layout_marginTop="24dp"
        android:backgroundTint="#FF3F3F"
        android:text="Descargar entrantes"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintHorizontal_bias="0.505"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toBottomOf="@+id/listMessages" />

    <TextView
        android:id="@+id/textMessages"
        android:layout_width="320dp"
        android:layout_height="wrap_content"
        android:layout_marginTop="24dp"
        android:text="Mensajes"
        android:textAlignment="center"
        android:textSize="22sp"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintHorizontal_bias="0.505"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toTopOf="parent" />

    <ListView
        android:id="@+id/listMessages"
        android:layout_width="320dp"
        android:layout_height="500dp"
        android:layout_marginTop="24dp"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toBottomOf="@+id/textMessages" />
</androidx.constraintlayout.widget.ConstraintLayout>

Cómo usar el ejemplo de SMS en Kotlin:

Puedes usar la clase MessageApi para recibir mensajes SMS desde el gateway de SMS. Tu solicitud desde tu dispositivo se enviará al gateway de SMS a través de internet.

Descargar ReceiveSms.kt

El código fuente explicado en este artículo se puede descargar, usar y modificar gratuitamente.
Descargar: ReceiveSms.kt.zip (148Kb)

¿Qué contiene el archivo ReceiveSms.kt.zip?

El archivo ReceiveSms.kt.zip contiene un proyecto de ejemplo, que incluye la biblioteca Ozeki.Libs.Rest. Con esta biblioteca puedes enviar, eliminar, marcar y recibir mensajes SMS creando un MessageApi y usando los métodos Send(), Delete(), Mark() y Receive(). (Figura 2)

proyecto de ejemplo para recibir sms usando kotlin
Figura 2 - Directorio de ReceiveSms.kt

Cómo recibir SMS con Kotlin (Pasos rápidos)

Para recibir SMS con Kotlin:

  1. Instala Ozeki SMS Gateway
  2. Conecta Ozeki SMS Gateway a la red móvil
  3. Envía un SMS de prueba desde la GUI de Ozeki
  4. Crea un usuario de API HTTP de SMS
  5. Android Studio
  6. Descarga el proyecto de ejemplo anterior
  7. Crea una API para descargar tus mensajes entrantes
  8. Usa el método DownloadIncoming() para recibir tus mensajes
  9. Lee el mensaje de respuesta en la consola
  10. Revisa los registros en el gateway de SMS

Instalar Ozeki SMS Gateway y crear un usuario de API HTTP

Para poder recibir SMS con Kotlin, primero necesitas instalar Ozeki SMS Gateway. El gateway de SMS se puede instalar en la misma computadora donde desarrollas tu código Kotlin en Android Studio. Después de la instalación, el siguiente paso es conectar Ozeki SMS Gateway a la red móvil. Puedes enviar un SMS de prueba desde la GUI de Ozeki para verificar que tu conexión a la red móvil funcione. El paso final para preparar tu entorno es crear un usuario de API HTTP de SMS. Crea un usuario con el nombre "http_user" y la contraseña "qwe123" para que el ejemplo funcione sin modificaciones.

Una vez configurado el entorno, puedes ejecutar tu código Kotlin.

URL de la API HTTP para enviar SMS desde Kotlin

Para recibir SMS con Kotlin, tu código Kotlin tendrá que enviar una solicitud HTTP al gateway de SMS. La URL de la API se muestra a continuación. Ten en cuenta que la dirección IP (127.0.0.1) debe ser reemplazada por la dirección IP de tu gateway de SMS. Si Ozeki SMS Gateway está instalado en la misma computadora donde se ejecuta la aplicación de SMS en JavaScript, puede ser 127.0.0.1. Si está instalado en una computadora diferente, debe ser la dirección IP de esa computadora. 

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

Autenticación HTTP para recibir SMS con Kotlin

Para autenticar el cliente de SMS en Kotlin, necesitas enviar el nombre de usuario y la contraseña en una cadena codificada en base64 al servidor en una solicitud HTTP. El formato utilizado es: base64(nombre de usuario+":"+contraseña). En Kotlin puedes usar el siguiente código para hacer esta codificación: 

var usernamePassword = "%s:%s".format(username, password)
return "Basic %s".format(Base64.getEncoder().encodeToString(usernamePassword.toByteArray()))

Por ejemplo, si codificas el nombre de usuario 'http_user' y la contraseña 'qwe123', obtendrás la siguiente cadena codificada en base64: aHR0cF91c2VyOnF3ZTEyMw==. Para enviar

Encabezado de la solicitud HTTP para enviar SMS desde Kotlin

Para recibir los mensajes SMS, necesitas incluir las siguientes líneas como encabezados en la solicitud HTTP. Ten en cuenta que incluimos un tipo de contenido y un encabezado de Autorización. 

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

Solicitud HTTP para recibir SMS con Kotlin

Para recibir los mensajes SMS entrantes, tu aplicación Kotlin enviará una solicitud HTTP similar a la que se muestra a continuación. Ten en cuenta que esta solicitud contiene una parte de encabezado HTTP y una parte de cuerpo HTTP. El cuerpo HTTP es una cadena de datos codificada en JSON. Contiene el número del destinatario y el texto del mensaje. 

GET /api?action=receivemsg&folder=inbox HTTP/1.1
Connection: Keep-Alive
Accept-Encoding: gzip
Authorization: Basic aHR0cF91c2VyOnF3ZTEyMw==
Host: 10.0.2.2:9509
User-Agent: okhttp/4.2.2

Respuesta HTTP recibida por el ejemplo de SMS en Kotlin

Una vez que el gateway de SMS reciba esta solicitud, generará una respuesta HTTP. La respuesta HTTP contendrá un código de estado para indicar si el envío del SMS fue exitoso o no. También devolverá una estructura codificada en JSON para proporcionarte detalles útiles sobre el envío del mensaje. 

HTTP/1.1 200 OK
User-Agent: OZEKI 10.3.120 (www.myozeki.com)
Content-Type: application/json; charset=utf8
Last-Modified: Thu, 17 Jun 2021 16:10:48 GMT
Server: 10/10.3.120
Transfer-Encoding: chunked

{
	"http_code": 200,
	"response_code": "SUCCESS",
	"response_msg": "",
	"data": {
	  "folder": "inbox",
	  "limit": "1000",
	  "data": [
	    {
	      "message_id": "ada7ee44-aefc-e746-9376-b76e3674442a",
	      "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-06-17 16:09:11",
	      "valid_until": "2021-06-24 16:09:11",
	      "time_to_send": "2021-06-17 16:09:11",
	      "submit_report_requested": true,
	      "delivery_report_requested": true,
	      "view_report_requested": true,
	      "tags": [
	        {
	          "name": "Type",
	          "value": "SMS:TEXT"
	        }
	      ]
	    },
	    {
	      "message_id": "fccc6211-c710-c80e-a28f-664ff8b0e964",
	      "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-06-17 16:09:11",
	      "valid_until": "2021-06-24 16:09:11",
	      "time_to_send": "2021-06-17 16:09:11",
	      "submit_report_requested": true,
	      "delivery_report_requested": true,
	      "view_report_requested": true,
	      "tags": [
	        {
	          "name": "Type",
	          "value": "SMS:TEXT"
	        }
	      ]
	    },
	    {
	      "message_id": "ba782a64-05cd-8ba8-9f4c-e8597ca30b59",
	      "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-06-17 16:09:11",
	      "valid_until": "2021-06-24 16:09:11",
	      "time_to_send": "2021-06-17 16:09:11",
	      "submit_report_requested": true,
	      "delivery_report_requested": true,
	      "view_report_requested": true,
	      "tags": [
	        {
	          "name": "Type",
	          "value": "SMS:TEXT"
	        }
	      ]
	    }
	  ]
	}
}

Cómo recibir mensajes SMS con Kotlin usando la API de SMS y el proyecto de ejemplo anterior (Tutorial en video)

Este video te muestra cómo descargar y usar el proyecto ReceiveSms.kt. Una vez que abras el proyecto de ejemplo, puedes notar que hay un paquete llamado Ozeki.Libs.Rest. Este es el paquete que contiene el MessageApi y todo lo que necesitas para recibir mensajes SMS usando Kotlin.

Video 2 - Cómo recibir mensajes SMS con el código Kotlin anterior (Tutorial en video)

Cómo verificar que la solicitud ha sido aceptada por el usuario HTTP

Después de enviar el SMS, es una buena idea revisar tu gateway de SMS, para ver qué ha recibido. Puedes revisar el registro abriendo los detalles del usuario HTTP desde la consola de administración de Ozeki SMS Gateway. Al final del video anterior puedes ver cómo verificar si la solicitud ha sido recibida por el http_user. (Figura 3)

proyecto kotlin para recibir mensajes sms
Figura 3 - Proyecto ReceiveSms.kt en Android Studio

Cómo se ve usar la aplicación en un teléfono (tutorial en video)

En la Figura 4, puedes ver cómo se ve usar la aplicación en un teléfono. Como puedes ver en la imagen Antes, por defecto no tienes mensajes entrantes. Presiona el botón 'Descargar entrantes' para obtener los mensajes enviados para ti. En la foto Después, puedes ver que toda la información sobre un mensaje es visible cuando lo descargas.

ejemplo de aplicación kotlin para recibir mensajes sms

Figura 4 - Aplicación de ejemplo ReceiveSms antes y después de descargar los mensajes

Cómo agregar Ozeki.Libs.Rest a tu propio proyecto

La biblioteca Ozeki.Libs.Rest se puede descargar, usar y modificar gratuitamente.
Descargar: Ozeki.Libs.Rest.kt.zip (7.66Kb)

Si decides crear tu aplicación por tu cuenta solo con la biblioteca Ozeki.Libs.Rest, hay algunas cosas que debes cambiar en tu aplicación base. Para usar la biblioteca Ozeki.Libs.Rest, debes colocarla en la carpeta java del directorio principal.
En el siguiente video te mostraré cómo descargar y agregar la biblioteca Ozeki.Libs.Rest a tu propio proyecto.

Video 3 - Cómo agregar la biblioteca Ozeki.Libs.Rest a tu propia aplicación (Tutorial en video)

Dependencias

Es importante mencionar que la biblioteca Ozeki.Libs.Rest tiene algunas dependencias. Para usarla, debes agregar estas dependencias en los Gradle Scripts. 

implementation "com.squareup.okhttp3:okhttp:4.2.2"
implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.5.0'
implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.5.0'

Código 1 - La lista de dependencias que necesitas incluir.

Agregar las dependencias (Tutorial en video)

En el siguiente video, verás cómo adjuntar las dependencias mencionadas anteriormente. Comenzará copiando el código y te llevará hasta las dependencias agregadas exitosamente. El video solo dura 53 segundos, pero contiene todos los pasos necesarios para completar el método. Puedes seguir este tutorial sin esfuerzo.

Video 4 - Cómo agregar las dependencias necesarias (Tutorial en video)

Acceso a internet

Para que tu aplicación pueda enviar una solicitud HTTP, debes habilitar el acceso a internet.
En el siguiente video te mostraré cómo habilitar el acceso a internet para tu aplicación Kotlin. 

<uses-permission android:name="android.permission.INTERNET" />

Código 2 - Para habilitar el acceso a internet para tu aplicación Kotlin.

android:usesCleartextTraffic="true"

Código 3 - Para permitir el envío de solicitudes HTTP

Cómo agregar conexión a internet a tu proyecto (Tutorial en video)

Necesitas agregar ambas líneas al archivo AndroidManifest.xml.
En el próximo video, te mostraré dónde debes insertar los códigos anteriores. El video comenzará copiando el código y te llevará hasta la conexión a internet agregada exitosamente. Este video es preciso y fácil de seguir.

Video 5 - Cómo permitir acceso a internet para tu aplicación (Tutorial en video)

Conclusión

Esta guía fue escrita para mostrar los pasos de recepción de SMS en Kotlin usando el usuario HTTP de Ozeki SMS Gateway. Esta solución te ayuda a recopilar los mensajes que recibes en la carpeta de entrada y moverlos a tu programa Kotlin. Usar esta solución te da la capacidad de mantener tu sistema de mensajería organizado como lo planeaste.

Esto es solo el comienzo, aprende más sobre cómo gestionar tus mensajes en la página web de Ozeki. Para mantenerte efectivo y actualizado, clasifica los mensajes, lee el siguiente artículo sobre Cómo eliminar un SMS en Kotlin.

¡Manos a la obra, configura Ozeki SMS Gateway ahora!

More information