Comment envoyer un SMS depuis Kotlin

La manière la plus simple d'envoyer un SMS depuis Kotlin est d'utiliser l'API HTTP/Rest SMS intégrée d'Ozeki SMS Gateway. Lorsque vous utilisez cette API, vous enverrez des SMS en effectuant une requête HTTP Post vers la passerelle SMS. La requête HTTP Post contiendra un message formaté en JSON. La passerelle SMS enverra ce SMS au téléphone du destinataire et renverra une réponse HTTP 200 OK à votre requête. (Figure 1)

comment envoyer un sms depuis kotlin
Figure 1 - Comment envoyer un SMS depuis Kotlin

Code Kotlin pour envoyer un SMS sur mobile

L'exemple de code Kotlin SMS ci-dessous montre comment envoyer un SMS en utilisant l'API REST SMS HTTP d'Ozeki SMS Gateway avec la bibliothèque Kotlin Ozeki.Libs.Rest. Cette bibliothèque vous est fournie gratuitement et vous pouvez l'utiliser et la modifier dans n'importe lequel de vos projets.

Vidéo 1 - Comment télécharger l'exemple SendSms.kt.zip (Tutoriel vidéo)

MainActivity.kt 
package send.sms

import android.os.Build
import androidx.appcompat.app.AppCompatActivity
import android.os.Bundle
import android.text.method.ScrollingMovementMethod
import androidx.annotation.RequiresApi
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.GlobalScope
import kotlinx.coroutines.launch
import Ozeki.Libs.Rest.Configuration
import Ozeki.Libs.Rest.Message
import Ozeki.Libs.Rest.MessageApi

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

        val btnSendRequest:android.widget.Button = findViewById(R.id.btnSendRequest)
        val inputToAddress:android.widget.EditText = findViewById(R.id.inputToAddress)
        val inputMessage:android.widget.EditText = findViewById(R.id.inputMessage)
        val logBox:android.widget.TextView = findViewById(R.id.logBox)
        logBox.movementMethod = ScrollingMovementMethod()

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

        val api = MessageApi(configuration)

        btnSendRequest.setOnClickListener {
            if (inputToAddress.text.toString() != "" && inputMessage.text.toString() != "") {
                GlobalScope.launch(Dispatchers.IO) {
                    val msg = Message()
                    msg.ToAddress = inputToAddress.text.toString()
                    msg.Text = inputMessage.text.toString()
                    inputToAddress.text.clear()
                    inputMessage.text.clear()
                    val response = api.Send(msg)
                    logBox.text = String.format("%s\n%s", logBox.text, response.toString())
                }
            }
        }
    }
}
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="send.sms.MainActivity">

    <Button
        android:id="@+id/btnSendRequest"
        android:layout_width="320dp"
        android:layout_height="50dp"
        android:layout_marginBottom="24dp"
        android:text="Envoyer"
        android:backgroundTint="#FF3F3F"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintHorizontal_bias="0.505"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toBottomOf="@+id/logBox"
        app:layout_constraintVertical_bias="0.776" />

    <EditText
        android:id="@+id/inputMessage"
        android:layout_width="320dp"
        android:layout_height="150dp"
        android:layout_marginTop="32dp"
        android:ems="10"
        android:gravity="start|top"
        android:hint="Bonjour le monde !"
        android:inputType="textMultiLine"
        android:textColorHint="#BFBFBF"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintHorizontal_bias="0.494"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toBottomOf="@+id/textView" />

    <TextView
        android:id="@+id/textView"
        android:layout_width="320dp"
        android:layout_height="wrap_content"
        android:layout_marginTop="20dp"
        android:text="Message :"
        android:textSize="20sp"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintHorizontal_bias="0.505"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toBottomOf="@+id/inputToAddress" />

    <TextView
        android:id="@+id/textView2"
        android:layout_width="320dp"
        android:layout_height="wrap_content"
        android:layout_marginTop="40dp"
        android:text="Destinataire :"
        android:textSize="20sp"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintHorizontal_bias="0.505"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toTopOf="parent" />

    <EditText
        android:id="@+id/inputToAddress"
        android:layout_width="320dp"
        android:layout_height="wrap_content"
        android:layout_marginTop="16dp"
        android:ems="10"
        android:hint="+36201111111"
        android:inputType="textPersonName"
        android:textColorHint="#BFBFBF"
        android:textSize="18sp"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintHorizontal_bias="0.505"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toBottomOf="@+id/textView2" />

    <TextView
        android:id="@+id/logBox"
        android:layout_width="320dp"
        android:layout_height="160dp"
        android:layout_marginTop="36dp"
        android:scrollbars="vertical"
        android:text="Journal :"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintHorizontal_bias="0.505"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toBottomOf="@+id/inputMessage" />

</androidx.constraintlayout.widget.ConstraintLayout>

Comment utiliser l'exemple Kotlin SMS :

Vous pouvez utiliser la classe Message pour créer le SMS et la classe MessageApi pour envoyer le SMS à la passerelle SMS. La passerelle SMS transmettra votre message au réseau mobile soit via une connexion sans fil soit via Internet.

Télécharger SendSms.kt

Le code source expliqué dans cet article peut être téléchargé, utilisé et modifié gratuitement.
Télécharger : SendSms.kt.zip (148 Ko)

Que contient le fichier SendSms.kt.zip ?

Le fichier SendSms.kt.zip contient le projet exemple, qui inclut la bibliothèque Ozeki.Libs.Rest. Avec cette bibliothèque, vous pouvez envoyer, supprimer, marquer et recevoir des SMS en créant un MessageApi et en utilisant les méthodes Send(), Delete(), Mark() et Receive(). (Figure 2)

exemple de projet pour envoyer des sms avec node js
Figure 2 - Répertoire SendSms.kt

Comment envoyer un SMS depuis Kotlin (étapes rapides)

Pour envoyer un SMS depuis Kotlin :

  1. Installer Ozeki SMS Gateway
  2. Connecter Ozeki SMS Gateway au réseau mobile
  3. Envoyer un SMS test depuis l'interface Ozeki
  4. Créer un utilisateur API SMS HTTP
  5. Android Studio
  6. Télécharger le projet exemple ci-dessus
  7. Créer le SMS en créant un nouvel objet Message
  8. Créer une API pour envoyer votre message
  9. Utiliser la méthode Send pour envoyer votre message
  10. Lire le message de réponse sur la console
  11. Vérifier les logs dans la passerelle SMS

Installer Ozeki SMS Gateway et créer un utilisateur API HTTP

Pour pouvoir envoyer des SMS depuis Kotlin, vous devez d'abord installer Ozeki SMS Gateway. La passerelle SMS peut être installée sur le même ordinateur où vous développez votre code Kotlin dans Android Studio. Après l'installation, l'étape suivante consiste à connecter Ozeki SMS Gateway au réseau mobile. Vous pouvez envoyer un SMS test depuis l'interface Ozeki pour vérifier que votre connexion au réseau mobile fonctionne. La dernière étape pour préparer votre environnement est de créer un utilisateur API SMS HTTP. Créez un utilisateur avec le nom d'utilisateur "http_user" et le mot de passe "qwe123" pour que l'exemple fonctionne sans modification.

Une fois l'environnement configuré, vous pouvez exécuter votre code Kotlin.

URL de l'API HTTP pour envoyer un SMS depuis Kotlin

Pour envoyer un SMS depuis Kotlin, votre code Kotlin devra effectuer une requête HTTP vers la passerelle SMS. L'URL de l'API est indiquée ci-dessous. Notez que l'adresse IP (127.0.0.1) doit être remplacée par l'adresse IP de votre passerelle SMS. Si Ozeki SMS Gateway est installé sur le même ordinateur où l'application SMS JavaScript est exécutée, cela peut être 127.0.0.1. S'il est installé sur un autre ordinateur, cela doit être l'adresse IP de cet ordinateur. 

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

Authentification HTTP pour envoyer un SMS depuis Kotlin

Pour authentifier le client SMS Kotlin, vous devez envoyer le nom d'utilisateur et le mot de passe dans une chaîne encodée en base64 au serveur dans une requête HTTP. Le format utilisé est : base64(nom d'utilisateur+":"+mot de passe). En Kotlin, vous pouvez utiliser le code suivant pour effectuer cet encodage : 

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

Par exemple, si vous encodez le nom d'utilisateur 'http_user' et le mot de passe 'qwe123', vous obtiendrez la chaîne encodée en base64 suivante : aHR0cF91c2VyOnF3ZTEyMw==. Pour envoyer

En-tête de requête HTTP pour envoyer un SMS depuis Kotlin

Pour envoyer les SMS, vous devez inclure les lignes suivantes comme en-têtes dans la requête HTTP. Notez que nous incluons un type de contenu et un en-tête d'autorisation. 

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

Requête HTTP pour envoyer un SMS depuis Kotlin

Pour soumettre le SMS, votre application Kotlin enverra une requête HTTP similaire à celle ci-dessous. Notez que cette requête contient une partie d'en-tête HTTP et une partie de corps HTTP. Le corps HTTP est une chaîne de données encodée en JSON. Il contient le numéro du destinataire et le texte des messages. 

POST /api?action=sendmsg HTTP/1.1
Connection: Keep-Alive
Content-Length: 323
Content-Type: application/json; charset=utf-8
Accept-Encoding: gzip
Authorization: Basic aHR0cF91c2VyOnF3ZTEyMw==
Host: 10.0.2.2:9509
User-Agent: okhttp/4.2.2

{
	"messages":	[
		{
			"message_id":	"b686acf6-7420-4a3d-b444-779dcffc652b",
			"to_address":	"+36201111111",
			"text":	"Bonjour le monde !",
			"create_date":	"2021-06-17T09:48:30",
			"valid_until":	"2021-06-24T09:48:30",
			"time_to_send":	"-999999999-01-01T00:00",
			"submit_report_requested":	true,
			"delivery_report_requested":	true,
			"view_report_requested":	true
		}
	]
}

Réponse HTTP reçue par l'exemple Kotlin SMS

Une fois que la passerelle SMS reçoit cette requête, elle générera une réponse HTTP. La réponse HTTP contiendra un code de statut pour indiquer si la soumission du SMS a réussi ou non. Elle renverra également une structure encodée en JSON pour vous fournir des détails utiles sur la soumission du message. 

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

{
	"http_code": 200,
	"response_code": "SUCCESS",
	"response_msg": "Messages en attente de livraison.",
	"data": {
	  "total_count": 1,
	  "success_count": 1,
	  "failed_count": 0,
	  "messages": [
	    {
	      "message_id": "b686acf6-7420-4a3d-b444-779dcffc652b",
	      "from_station": "%",
	      "to_address": "+36201111111",
	      "to_station": "%",
	      "text": "Bonjour le monde !",
	      "create_date": "2021-06-17 09:48:30",
	      "valid_until": "2021-06-24 09:48:30",
	      "time_to_send": "2021-06-17 09:48:30",
	      "submit_report_requested": true,
	      "delivery_report_requested": true,
	      "view_report_requested": false,
	      "tags": [
	        {
	          "name": "Type",
	          "value": "SMS:TEXT"
	        }
	      ],
	      "status": "SUCCESS"
	    }
	  ]
	}
}

Comment envoyer un SMS depuis Kotlin en utilisant l'API SMS et le projet exemple ci-dessus (Tutoriel vidéo)

Cette vidéo vous montre comment télécharger et utiliser le projet SendSms.kt. Une fois que vous aurez ouvert le projet exemple, vous remarquerez peut-être qu'il y a un package appelé Ozeki.Libs.Rest. C'est le package qui contient le MessageApi et tout ce dont vous avez besoin pour envoyer un SMS en utilisant Kotlin.

Vidéo 2 - Comment envoyer un SMS avec le code Kotlin ci-dessus (Tutoriel vidéo)

Comment vérifier que le SMS a été accepté par l'utilisateur HTTP

Après la soumission du SMS, il est bon de vérifier votre passerelle SMS, pour voir ce qu'elle a reçu. Vous pouvez vérifier le journal en ouvrant les détails de l'utilisateur HTTP depuis la console de gestion d'Ozeki SMS Gateway. À la fin de la vidéo ci-dessus vous pouvez voir comment vérifier si la requête a été reçue par http_user. (Figure 3)

projet kotlin pour envoyer un message sms
Figure 3 - Projet SendSms.kt dans Android Studio

À quoi ressemble l'utilisation de l'application

Sur la Figure 4, vous pouvez voir à quoi ressemble l'application après avoir envoyé un message avec elle. Comme vous pouvez le voir, vos messages précédemment envoyés seront stockés sous forme de journal sous la zone de texte 'Message'. Vous pouvez voir toutes les informations sur le message comme l'expéditeur, le texte et le résultat de la procédure d'envoi.

exemple d'application kotlin pour envoyer des sms
Figure 4 - Application exemple SendSms avant et après l'envoi du message

Comment vérifier que le SMS a été envoyé au réseau mobile

La dernière étape pour vérifier la procédure est de consulter les journaux de la connexion au réseau mobile. Vous devrez peut-être activer les journaux dans la configuration de la connexion avant d'envoyer le message pour voir les journaux. Si les journaux sont activés, vous verrez le numéro de téléphone et le texte du message que vous avez envoyé.

Vidéo 3 - Comment tester si le client SMPP a reçu notre requête (Tutoriel vidéo)

Comment ajouter Ozeki.Libs.Rest à votre propre projet

La bibliothèque Ozeki.Libs.Rest peut être téléchargée, utilisée et modifiée gratuitement.
Télécharger : Ozeki.Libs.Rest.kt.zip (7,66 Ko)

Si vous décidez de créer votre application vous-même uniquement avec la bibliothèque Ozeki.Libs.Rest, vous devrez modifier quelques éléments dans votre application de base. Pour utiliser la bibliothèque Ozeki.Libs.Rest, vous devez la placer dans le dossier java du répertoire principal.
Dans la vidéo suivante, je vais vous montrer comment télécharger et ajouter la bibliothèque Ozeki.Libs.Rest à votre propre projet.

Vidéo 4 - Comment ajouter la bibliothèque Ozeki.Libs.Rest à votre propre application (Tutoriel vidéo)

Dépendances

Il est important de mentionner que la bibliothèque Ozeki.Libs.Rest a quelques dépendances. Pour l'utiliser, vous devez ajouter ces dépendances dans les 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'

Code 1 - La liste des dépendances que vous devez inclure.

Ajouter les dépendances (tutoriel vidéo)

Dans la vidéo suivante, vous apprendrez comment ajouter les dépendances mentionnées précédemment. Elle commencera par copier le code et vous guidera jusqu'à l'ajout réussi des dépendances. La vidéo ne dure que 53 secondes, mais elle présente toutes les étapes nécessaires pour terminer le processus. Vous pouvez suivre ce tutoriel sans effort.

Vidéo 5 - Comment ajouter les dépendances nécessaires (Tutoriel vidéo)

Accès à Internet

Pour permettre à votre application d'envoyer une requête HTTP, vous devez activer l'accès à Internet pour votre application.
Dans la vidéo suivante, je vais vous montrer comment activer l'accès à Internet pour votre application Kotlin. 

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

Code 2 - Pour activer l'accès à Internet pour votre application Kotlin.

android:usesCleartextTraffic="true"

Code 3 - Pour permettre l'envoi de requêtes HTTP

Comment activer la connexion Internet pour votre application (Tutoriel vidéo)

Vous devez ajouter ces deux lignes dans le fichier AndroidManifest.xml.
Dans la vidéo suivante, je vais vous montrer où placer les codes ci-dessus. La vidéo commencera par copier le code et vous guidera jusqu'à l'ajout réussi de la connexion Internet. Cette vidéo est détaillée et offre un suivi facile.

Vidéo 6 - Comment autoriser l'accès à Internet pour votre application (Tutoriel vidéo)

Conclusion

Le but de ce guide était de vous montrer comment envoyer des SMS depuis Kotlin avec l'API SMS HTTP d'Ozeki SMS Gateway. Les connaissances que vous avez acquises vous permettent de rester en contact avec vos clients en utilisant un simple code Kotlin. La messagerie internationale est également possible avec Ozeki SMS Gateway, car elle fonctionne dans n'importe quel pays et peut envoyer et recevoir des SMS via diverses connexions mobiles.

Assurez-vous de poursuivre vos études ici, visitez d'autres pages de tutoriels sur le site web d'Ozeki pour plus d'informations. Consultez plus de guides sur l'utilisation de Kotlin, commencez par celui-ci : Comment envoyer plusieurs SMS depuis Kotlin.

Maintenant, la première chose à faire est de télécharger Ozeki SMS Gateway et de commencer à l'utiliser !

More information