EN

Ejemplos de código en Kotlin para la API SMS de LabsMobile

A continuación se presentan los ejemplos de código de programación en lenguaje Kotlin para enviar mensajes SMS a través de la API de la plataforma LabsMobile.

Esta documentación está diseñada para que puedas conectar tus aplicaciones con la plataforma LabsMobile y automatizar el envío de mensajes SMS. El principal objetivo de la integración de estas aplicaciones es el envío de mensajes SMS y comunicaciones relacionadas.

Consejo Recomendamos utilizar nuestra API SMS http/POST en formato JSON para cualquier integración con la plataforma LabsMobile. Pero tenemos otras versiones API que puedes utilizar según tu entorno y requisitos.

Con estos ejemplos podrás realizar la integración de las siguientes funcionalidades:

  • Enviar mensajes SMS de forma individual o masiva.
  • Consultar el saldo de tu cuenta.
  • Recibir las notificaciones de confirmaciones de entrega y/o error que corresponden a los mensajes enviados.
  • Obtener notificación y datos de los mensajes recibidos en los números virtuales contratados.

A tener en cuenta

La API SMS de LabsMobile utiliza una URL base común para todas las peticiones: https://api.labsmobile.com.

Es altamente recomendable emplear una URL que incluya el protocolo HTTPS en cualquier versión de la API.

La autenticación se realiza con el nombre de usuario y un token API, myUsername:myToken. Debes crear el token API desde la sección Configuración API de tu cuenta.


Enviar SMS con http/POST

Aquí tienes un ejemplo de código en lenguaje Kotlin para enviar mensajes SMS utilizando la API SMS http/POST que utiliza el formato JSON para las variables de intercambio de información.

Como puedes observar, necesitas crear una estructura en formato JSON que contenga todos los parámetros necesarios para el envío y realizar una llamada HTTP/POST con estos datos en el cuerpo de la solicitud.

Envío simple a un único destinatario con http/POST (Kotlin)
package org.example

import okhttp3.MediaType.Companion.toMediaType
import okhttp3.OkHttpClient
import okhttp3.Request
import okhttp3.RequestBody.Companion.toRequestBody
import java.util.Base64

class App {
   fun sendSMS() {
       val userToken = "myUsername:myToken"
       val credentials = Base64.getEncoder().encodeToString(userToken.toByteArray())
       val client = OkHttpClient()
       val mediaType = "application/json".toMediaType()
       val body = """
           {
             "message":"Your verification code is 123",
             "tpoa":"Sender",
             "recipient":
               [
                 {
                   "msisdn":"12015550123"
                 }
               ]
           }
       """.trimIndent().toRequestBody(mediaType)
      
       val request = Request.Builder()
           .url("https://api.labsmobile.com/json/send")
           .post(body)
           .addHeader("Content-Type", "application/json")
           .addHeader("Authorization", "Basic $credentials")
           .build()
      
       val response = client.newCall(request).execute()
       println(response.body?.string())
   }
}

fun main() {
   App().sendSMS()
}
              

Envío masivo a múltiples destinatarios con http/POST (Kotlin)
package org.example

import okhttp3.MediaType.Companion.toMediaType
import okhttp3.OkHttpClient
import okhttp3.Request
import okhttp3.RequestBody.Companion.toRequestBody
import java.util.Base64

class App {
   fun sendSMS() {
       val userToken = "myUsername:myToken"
       val credentials = Base64.getEncoder().encodeToString(userToken.toByteArray())
       val client = OkHttpClient()
       val mediaType = "application/json".toMediaType()
       val body = """
           {
             "message":"Don't miss our Sale! Use code XXXX123 for 20% off.",
             "tpoa":"Sender",
             "recipient":
               [
                 {
                   "msisdn":"12015550123"
                 },
                 {
                   "msisdn":"12015550124"
                 },
                 {
                   "msisdn":"12015550125"
                 }
               ]
           }
       """.trimIndent().toRequestBody(mediaType)
      
       val request = Request.Builder()
           .url("https://api.labsmobile.com/json/send")
           .post(body)
           .addHeader("Content-Type", "application/json")
           .addHeader("Authorization", "Basic $credentials")
           .build()
      
       val response = client.newCall(request).execute()
       println(response.body?.string())
   }
}

fun main() {
   App().sendSMS()
}
                

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

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

Es posible consultar todos los códigos de error en Documentación API, códigos de error.

Para obtener más detalles sobre los parámetros disponibles y las opciones de configuración, consulta la documentación oficial en:


Enviar SMS con http/GET

Este es un ejemplo de código en lenguaje Kotlin para enviar mensajes SMS utilizando la API SMS http/GET.

Como podrás observar, debes pasar una serie de variables GET en la misma URL y realizar una llamada HTTP. Es importante codificar todos los valores como URL utilizando la función URLEncoder.encode().

Importante La API SMS http/GET transmite las credenciales (username y token API) sin cifrar y de forma no segura. Recomendamos utilizar esta API GET sólo cuando sea totalmente imprescindible y utilizar en su lugar la API SMS http/POST.

Envío simple a un único destinatario con http/GET (Kotlin)
package org.example

import okhttp3.OkHttpClient
import okhttp3.Request
import java.net.URLEncoder
                  
class App {
    fun sendSMS() {
       val client = OkHttpClient()
       val username = "myUsername"
       val token = "myToken"
       val msisdn = "[12015550123]"
       val message = "Your verification code is 123"

       val encodedUsername = URLEncoder.encode(username, "UTF-8")
       val encodedToken = URLEncoder.encode(token, "UTF-8")
       val encodedMsisdn = URLEncoder.encode(msisdn, "UTF-8")
       val encodedMessage = URLEncoder.encode(message, "UTF-8")

       val url = "http://api.labsmobile.com/get/send.php?" +
                "username=$encodedUsername&password=$encodedToken&msisdn=$encodedMsisdn&message=$encodedMessage"

       val request = Request.Builder()
           .url(url)
           .build()

       val response = client.newCall(request).execute()
       println(response.body?.string())
   }
}

fun main() {
   App().sendSMS()
}
                

Envío masivo a múltiples destinatarios con http/GET (Kotlin)
package org.example

import okhttp3.OkHttpClient
import okhttp3.Request
import java.net.URLEncoder

class App {

   fun sendSMS() {
       val client = OkHttpClient()
       val username = "myUsername"
       val token = "myToken"
       val msisdn = "[12015550123,12015550124,12015550125]"
       val message = "Don't miss our Sale! Use code XXXX123 for 20% off."

       val encodedUsername = URLEncoder.encode(username, "UTF-8")
       val encodedToken = URLEncoder.encode(token, "UTF-8")
       val encodedMsisdn = URLEncoder.encode(msisdn, "UTF-8")
       val encodedMessage = URLEncoder.encode(message, "UTF-8")

       val url = "http://api.labsmobile.com/get/send.php?" +
                "username=$encodedUsername&password=$encodedToken&msisdn=$encodedMsisdn&message=$encodedMessage"


       val request = Request.Builder()
           .url(url)
           .build()

       val response = client.newCall(request).execute()
       println(response.body?.string())
   }
}

fun main() {
   App().sendSMS()
}
                

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

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

Es posible consultar todos los códigos de error en Documentación API, códigos de error.

Para obtener más detalles sobre los parámetros disponibles y las opciones de configuración, consulta la documentación oficial en:


Consulta de saldo de una cuenta

Con este ejemplo de código en Kotlin se puede consultar el saldo de la cuenta utilizando la API SMS de LabsMobile

Mediante una llamada a este endpoint, puedes obtener información sobre la cantidad de créditos disponibles en tu cuenta de LabsMobile. La conexión se establece a través de una solicitud HTTP/GET con autenticación en el encabezado de la conexión HTTP.

Consulta de saldo de una cuenta (Kotlin)
package org.example

import okhttp3.MediaType.Companion.toMediaType
import okhttp3.OkHttpClient
import okhttp3.Request
import java.util.Base64

class App {
   fun balance() {
       val userToken = "myUsername:myToken"
       val credentials = Base64.getEncoder().encodeToString(userToken.toByteArray())
       val client = OkHttpClient()
      
       val request = Request.Builder()
           .url("https://api.labsmobile.com/json/balance")
           .get()
           .addHeader("Content-Type", "application/json")
           .addHeader("Authorization", "Basic $credentials")
           .build()
      
       val response = client.newCall(request).execute()
       println(response.body?.string())
   }
}

fun main() {
   App().balance()
}
                

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

  

Consulta la documentación completa en:


Recibir estado de mensajes enviados

Este script de ejemplo recibe una llamada por parte de la plataforma LabsMobile cuando un mensaje SMS enviado cambia de estado. Para implementar esta solución, es esencial configurar los parámetros adecuados, la URL de confirmación en el parámetro ackurl en la petición o la URL por defecto en la Configuración API de tu cuenta.

Por tanto, es necesario publicar un script como este en tu sistema para que nuestra plataforma llame a la URL cuando ocurra un cambio de estado en cualquiera de los mensajes enviados.

El código de ejemplo obtiene los parámetros de la URL utilizando la variable global $_GET y luego asigna estos parámetros a variables locales.

Script de recepción de estados de mensajes enviados (Kotlin)
package org.example

import io.javalin.Javalin

class App {
 fun server() {
   
   val app = Javalin.create().start(3000)

   app.get("/") { ctx ->
       val queryParams = ctx.queryParamMap()
       println("Received query parameters: $queryParams")
       queryParams.forEach { key, values ->
         values.forEach { value ->
             println("Variable: $key = $value")
         }
     }
     ctx.result("Received parameters.")
   }
   println("Server running on port 3000")
 }
}

fun main() {
 App().server()
}
                

Consulta la documentación completa en:


Recepción de mensajes SMS

Una vez contratado un número virtual, podrás recibir mensajes vía API en una URL específica mediante una llamada HTTP/GET a un script de tu sistema. Cada mensaje recibido invocará la URL, transmitiendo todos sus datos en variables en formato JSON

Para activar esta funcionalidad se debe informar la URL de recepción de mensajes en la Configuración de tu cuenta.

Es necesario configurar un endpoint en tu sistema para que la plataforma LabsMobile llame a este script cuando se reciba un SMS en cualquiera de los números virtuales contratados.

El código de ejemplo obtiene los parámetros de la URL utilizando la variable global $_GET y luego asigna estos parámetros a variables locales

Script de recepción de mensajes recibidos (Kotlin)
package org.example

import io.javalin.Javalin

class App {
 fun server() {
   
   val app = Javalin.create().start(3000)

   app.get("/") { ctx ->
       val queryParams = ctx.queryParamMap()
       println("Received query parameters: $queryParams")
       queryParams.forEach { key, values ->
         values.forEach { value ->
             println("Variable: $key = $value")
         }
     }
     ctx.result("Received parameters.")
   }
   println("Server running on port 3000")
 }
}

fun main() {
 App().server()
}
                

Consulta la documentación completa en: