Cómo recibir SMS desde Python flask

La forma más sencilla de recibir SMS desde Python es utilizar la API HTTP/REST de SMS integrada de Ozeki SMS Gateway. Cuando uses esta API, recibirás mensajes SMS mediante una solicitud HTTP GET al gateway de SMS. La respuesta HTTP Post contendrá los mensajes en formato JSON. El gateway de SMS enviará los mensajes SMS a la aplicación de consola de Python, y devolverá una respuesta HTTP 200 OK a tu solicitud.

cómo recibir sms desde python flask
Figura 1 - Cómo recibir SMS desde Python flask

Código Python para recibir SMS

El ejemplo de código Python para SMS a continuación demuestra cómo puedes recibir SMS usando la API HTTP REST de SMS de Ozeki SMS Gateway con la biblioteca Python ozekilibsrest. Esta biblioteca se proporciona gratuitamente, y puedes usarla y modificarla en cualquiera de tus proyectos.

ReceiveSms.py 

		from flask import Flask, render_template, request
		from ozekilibsrest import Configuration, MessageApi
		app = Flask(__name__)
		
		configuration = Configuration(
		    username="http_user",
		    password="qwe123",
		    api_url="http://127.0.0.1:9509/api"
		)
		
		api = MessageApi(configuration)
		
		logs = []
		
		
		@app.route('/', methods=['GET', 'POST'])
		def index():
		    if request.method == 'POST':
		        messages = api.download_incoming()
		        message_count_string  = messages.__str__()
		        logs.append(message_count_string)
		        for message in messages.messages:
		            message_string = message.__str__()
		            logs.append(message_string)
		    return render_template('ReceiveSms.html', logs=logs)
		
		
		if __name__ == '__main__':
		    app.run()

Código 1 - ReceiveSms.py

ReceiveSms.html 

		<!DOCTYPE html>
		<html lang="en">
		    <head>
		        <meta charset="UTF-8">
		        <title>Receive SMS with Ozeki SMS Gateway</title>
		        <link rel="stylesheet"
		        href="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css"
		        integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T"
		        crossorigin="anonymous">
		    </head>
		    <body>
		        <form action="/" method="POST" class="form-group" style="width: 40%;
		        margin-top: 10vh; margin-left: 30%;
	            display: flex; flex-direction: column;
	            height: 10vh; justify-content: space-evenly;">
		            <button class="btn btn-primary" style="font-weight: 600;"
		                   type="submit" name="submit" value="download">Download</button>
		        </form>
		        <ul style="width: 40%; margin-left: 30%; height: 70vh; overflow-y: scroll;"
		            class="list-group card">
		            <li class="list-group-item card"><b>Logs:</b></li>
		            {% if logs %}
		                {% for log in logs %}
		                    <li class="list-group-item">{{ log }}</li>
		                {% endfor %}
		            {% endif %}
		        </ul>
		    </body>
		</html>

Código 2 - ReceiveSms.html

Cómo usar el ejemplo de SMS en Python:

Este ejemplo de SMS en Python se puede usar en cualquier aplicación Python. Para usarlo, debes instalar el paquete ozekilibsrest con el comando pip install ozekilibsrest. Después de instalar el paquete, debes poner la directiva from ozekilibsrest import Configuration, Message, MessageApi en la sección de encabezado de tu código fuente Python. Esto te permitirá usar las clases proporcionadas por la biblioteca ozekilibsrest. Puedes usar la clase Message para crear el SMS. Puedes usar la clase MessageApi para enviar el SMS al gateway de SMS. El gateway de SMS reenviará tu mensaje a la red móvil ya sea a través de una conexión inalámbrica o a través de Internet.

Descargar ReceiveSms.py

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

¿Qué hay en la carpeta ReceiveSms.py?

La carpeta ReceiveSms.py contiene el script del ejemplo de SMS en Python que te mostrará cómo recibir mensajes SMS usando Python.

directorio receive sms py
Figura 2 - Qué hay dentro de ReceiveSms.py.zip

Cómo instalar la biblioteca ozekilibsrest

Para instalar la biblioteca ozekilibsrest, debes abrir el símbolo del sistema y usar el siguiente comando. Esto instalará la biblioteca ozekilibsrest y las dependencias que necesita. 

		pip install ozekilibsrest

Código 3 - Comando para instalar la biblioteca ozekilibsrest

Cómo instalar la biblioteca flask

Para instalar la biblioteca flask, debes abrir el símbolo del sistema y usar el siguiente comando. Esto instalará la biblioteca flask y las dependencias que necesita. 

		pip install flask

Código 4 - Comando para instalar la biblioteca flask

Cómo recibir SMS desde Python (Pasos rápidos)

Para recibir SMS desde Python:

  1. Descargar e instalar Python
  2. Instalar la biblioteca ozekilibsrest usando pip o codna
  3. Instalar la biblioteca flask usando pip o codna
  4. Descargar el archivo ReceiveSms.py.zip
  5. Extraer el archivo .zip de la carpeta de descargas
  6. Abrir el archivo ReceiveSms.py en cualquier editor de texto
  7. Iniciar Ozeki SMS Gateway
  8. Crear un usuario HTTP API en Ozeki
  9. Ejecutar el código ReceiveSms.py usando el símbolo del sistema para enviar los mensajes SMS de prueba
  10. Verificar la bandeja de enviados en Ozeki SMS Gateway

Instalar Ozeki SMS Gateway y crear un usuario HTTP API

Para poder enviar SMS desde Python flask, primero necesitas instalar Ozeki SMS Gateway. El gateway de SMS se puede instalar en la misma computadora donde desarrollas tu código Python. 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 funciona. El paso final para preparar tu entorno es crear un usuario HTTP API para SMS. Crea un usuario con el nombre de usuario "http_user" y la contraseña "qwe123" para que el ejemplo funcione sin modificaciones.

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

URL de la API HTTP para enviar SMS desde Python flask

Para enviar SMS desde Python flask, tu código Python tendrá que hacer 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 Python flask, 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 enviar SMS desde Python flask

Para autenticar el cliente de SMS en Python flask, 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 Python puedes usar el siguiente código para hacer esta codificación: 

	    def create_authorization_header(username, password):
	        username_password = f'{ username }:{ password }'
	        return f'Basic { b64encode(username_password.encode()).decode() }'

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

Encabezado de la solicitud HTTP para enviar SMS desde Python flask

Para enviar 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 enviar SMS desde Python flask

Para enviar los mensajes SMS, tu aplicación Python flask enviará una solicitud HTTP similar a la siguiente. Ten en cuenta que esta solicitud contiene una parte de encabezado HTTP, en el encabezado hemos definido la carpeta de la que queremos descargar los mensajes y la acción. También hemos enviado la contraseña y el nombre de usuario codificados en Base64 para autenticar la solicitud. 

GET /api?action=receivemsg&folder=inbox HTTP/1.1
Host: 127.0.0.1:9509
User-Agent: python-requests/2.26.0
Accept-Encoding: gzip, deflate
Accept: */*
Connection: keep-alive
Authorization: Basic aHR0cF91c2VyOnF3ZTEyMw==

Respuesta HTTP recibida por el ejemplo de SMS en Python flask

Una vez que el gateway de SMS recibe esta solicitud, generará una respuesta HTTP. La respuesta HTTP contendrá un código de estado, para indicar si la solicitud de envío de SMS fue exitosa 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
Transfer-Encoding: chunked
Content-Type: application/json; charset=utf8
Last-Modified: Fri, 17 Sep 2021 08:36:07 GMT
Server: 10/10.3.124 Microsoft-HTTPAPI/2.0
User-Agent: OZEKI 10.3.124 (www.myozeki.com)
Access-Control-Allow-Origin: *
Date: Fri, 17 Sep 2021 07:08:11 GMT

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "",
  "data": {
    "folder": "inbox",
    "limit": "1000",
    "data": [
      {
        "message_id": "31bc2fe0-c2a6-4ebe-afcd-6bcd9ea341fb",
        "from_connection": "admin@localhost",
        "from_address": "",
        "from_station": "%",
        "to_connection": "http_user@localhost",
        "to_address": "http_user",
        "to_station": "%",
        "text": "Hello world 1!",
        "create_date": "2021-09-17 09:07:14",
        "valid_until": "2021-09-24 09:07:14",
        "time_to_send": "2021-09-17 09:07:14",
        "submit_report_requested": true,
        "delivery_report_requested": false,
        "view_report_requested": false,
        "tags": []
      },
      {
        "message_id": "b7b8d592-e182-4e96-a375-b4a6aa73e483",
        "from_connection": "admin@localhost",
        "from_address": "",
        "from_station": "%",
        "to_connection": "http_user@localhost",
        "to_address": "http_user",
        "to_station": "%",
        "text": "Hello world 2!",
        "create_date": "2021-09-17 09:07:23",
        "valid_until": "2021-09-24 09:07:23",
        "time_to_send": "2021-09-17 09:07:23",
        "submit_report_requested": true,
        "delivery_report_requested": false,
        "view_report_requested": false,
        "tags": []
      },
      {
        "message_id": "b0308970-a3c9-45c4-bf97-14a914a66f57",
        "from_connection": "admin@localhost",
        "from_address": "",
        "from_station": "%",
        "to_connection": "http_user@localhost",
        "to_address": "http_user",
        "to_station": "%",
        "text": "Hello world 3!",
        "create_date": "2021-09-17 09:07:33",
        "valid_until": "2021-09-24 09:07:33",
        "time_to_send": "2021-09-17 09:07:33",
        "submit_report_requested": true,
        "delivery_report_requested": false,
        "view_report_requested": false,
        "tags": []
      }
    ]
  }
}

Ejemplo de SMS en Python flask: ReceiveSms.py

Cómo descargar el proyecto ReceiveSMS.py (Tutorial en video)

En el siguiente video, aprenderás cómo puedes usar el proyecto ReceiveSms.py en Python flask. El video comenzará con la página de descarga y te llevará hasta el panel del editor de código abierto. Aprenderás cómo descargar y abrir el archivo de código. El video dura solo 54 segundos, pero tiene toda la información necesaria para usar correctamente el archivo de ejemplo.

Video 1 - Cómo descargar y abrir la solución anterior (Tutorial en video)

El código de ejemplo a continuación es parte de la carpeta ReceiveSms.py.zip.

Figura 3 - ReceiveSms.py

Figura 4 - Ejecutando la aplicación de ejemplo en Python flask en el símbolo del sistema

Figura 5 - El resultado del código Python anterior

Cómo usar el proyecto (Tutorial en video)

En el siguiente clip, verás cómo puedes ejecutar el código Python ReceiveSms.py. El video comenzará con el código abierto y te llevará hasta la pestaña de eventos con el registro del mensaje enviado. Verás cómo ejecutar el código y qu

More information