Como enviar SMS a partir de Python

A maneira mais simples de enviar SMS a partir de Python é usar a API HTTP/REST de SMS integrada do Ozeki SMS Gateway. Quando você usa esta API, enviará mensagens SMS fazendo uma requisição HTTP Post para o gateway de SMS. A requisição HTTP Post conterá uma mensagem formatada em JSON. O gateway de SMS enviará este SMS para o telefone do destinatário e retornará uma resposta HTTP 200 OK para a sua requisição.

como enviar sms usando python
Figura 1 - Como enviar um SMS a partir de Python

Código Python para enviar SMS para celular

O exemplo de código Python para SMS abaixo demonstra como você pode enviar SMS usando a API REST HTTP do Ozeki SMS Gateway com a biblioteca Python ozekilibsrest. Esta biblioteca é fornecida gratuitamente, e você pode usá-la e modificá-la em qualquer um dos seus projetos.

SendSms.py 

		from ozekilibsrest import Configuration, Message, MessageApi
		
		configuration = Configuration(
		    username="http_user",
		    password="qwe123",
		    api_url="http://127.0.0.1:9509/api"
		)
		
		msg = Message(
		    to_address="+3620111111",
		    text="Hello world!"
		)
		
		api = MessageApi(configuration)
		
		result = api.send(msg)
		
		print(result)

Como usar o exemplo de SMS em Python:

Este exemplo de SMS em Python pode ser usado em qualquer aplicação Python. Para usá-lo, você deve instalar o pacote ozekilibsrest com o comando pip install ozekilibsrest. Após a instalação do pacote, você deve incluir a diretiva from ozekilibsrest import Configuration, Message, MessageApi no cabeçalho do seu código Python. Isso permitirá que você use as classes fornecidas pela biblioteca ozekilibsrest. Você pode usar a classe Message para criar o SMS. Você pode usar a classe MessageApi para enviar o SMS para o gateway de SMS. O gateway de SMS encaminhará sua mensagem para a rede móvel, seja através de uma conexão sem fio ou pela Internet.

Baixar SendSms.py

O código-fonte explicado neste artigo pode ser baixado, usado e modificado gratuitamente.
Download: SendSms.py.zip (355B)

O que há na pasta SendSms.py?

A pasta SendSms.py contém o script do exemplo de SMS em Python que mostrará como enviar múltiplas mensagens SMS usando Python.

diretório send sms py
Figura 2 - O que está dentro de SendSms.py.zip

Como instalar a biblioteca ozekilibsrest

Para instalar a biblioteca ozekilibsrest, você deve abrir o prompt de comando e usar o seguinte comando. Isso instalará a biblioteca ozekilibsrest e as dependências necessárias. 

		pip install ozekilibsrest

Código 2 - Comando para instalar a biblioteca ozekilibsrest

Como enviar SMS a partir de Python (Passos simples)

Para enviar SMS a partir de Python:

  1. Instale um usuário de API HTTP
  2. Ative "Log communication events" na aba Advanced
  3. Baixe o SendSMS.py
  4. Abra o arquivo SendSMS.py no bloco de notas
  5. Altere os dados para os seus próprios
  6. Inicie o aplicativo Ozeki SMS Gateway
  7. Execute o código Python SendSMS.py abrindo-o
  8. Verifique os logs para ver se o SMS foi enviado
Instale o Ozeki SMS Gateway e crie um usuário de API HTTP

Para poder enviar SMS a partir de Python, primeiro você precisa instalar o Ozeki SMS Gateway. O gateway de SMS pode ser instalado no mesmo computador onde você desenvolve seu código Python no Python IDLE ou Notepad. Após a instalação, o próximo passo é conectar o Ozeki SMS Gateway à rede móvel. Você pode enviar um SMS de teste a partir da interface gráfica do Ozeki para verificar se sua conexão com a rede móvel está funcionando. O passo final para preparar seu ambiente é criar um usuário de API HTTP para SMS. Crie um usuário com o nome "User1" e senha "qwe123" para fazer o exemplo funcionar sem modificações.

Após a configuração do ambiente, você pode executar seu código Python.

URL da API HTTP para enviar SMS a partir de Python

Para enviar SMS a partir de Python, seu código Python terá que fazer uma requisição HTTP para o gateway de SMS. A URL da API é mostrada abaixo. Observe que o endereço IP (127.0.0.1) deve ser substituído pelo endereço IP do seu gateway de SMS. Se o Ozeki SMS Gateway estiver instalado no mesmo computador onde o aplicativo Python está sendo executado, pode ser 127.0.0.1. Se estiver instalado em um computador diferente, deve ser o endereço IP desse computador. 

		http://127.0.0.1:9509/api?action=rest
Autenticação HTTP para enviar SMS a partir de Python

Para autenticar o cliente de SMS em Python, você precisa enviar o nome de usuário e senha em uma string codificada em base64 para o servidor em uma requisição HTTP. O formato usado é: base64(nome de usuário+":"+senha). Em Python, você pode usar o seguinte código para fazer essa codificação: 

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

Por exemplo, se você codificar o nome de usuário 'http_user' e a senha 'qwe123', você obterá a seguinte string codificada em base64: aHR0cF91c2VyOnF3ZTEyMw==. Para enviar

Cabeçalho da requisição HTTP para enviar SMS a partir do Python

Para enviar as mensagens SMS, você precisa incluir as seguintes linhas como cabeçalhos na requisição HTTP. Observe que incluímos um tipo de conteúdo e um cabeçalho de Autorização. 

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

Requisição HTTP para enviar SMS a partir do Python

Para submeter o SMS, sua aplicação Python enviará uma requisição HTTP semelhante à mostrada abaixo. Observe que esta requisição contém uma parte de cabeçalho HTTP e uma parte de corpo HTTP. O corpo HTTP é uma string de dados codificada em JSON. Ela contém o número do destinatário e o texto da mensagem. 

		POST /api?action=sendmsg HTTP/1.1
		Connection: Keep-Alive
		Content-Length: 336
		Content-Type: application/json
		Authorization: Basic aHR0cF91c2VyOnF3ZTEyMw==
		Host: 127.0.0.1:9509
		
		{
		  "messages": [
		    {
		      "message_id": "b570dbae-3a05-456d-9dad-a02161b16f1c",
		      "to_address": "+36201111111",
		      "text": "Olá, Mundo!",
		      "create_date": "2021-06-11 11:20:02",
		      "valid_until": "2021-06-18 11:20:02",
		      "time_to_send": "2021-06-11 11:20:02",
		      "submit_report_requested": true,
		      "delivery_report_requested": true,
		      "view_report_requested": true,
		      "tags": []
		    }
		  ]
		}

Resposta HTTP recebida pelo exemplo de SMS em Python

Assim que o gateway SMS receber esta requisição, ele gerará uma resposta HTTP. A resposta HTTP conterá um código de status, para indicar se a submissão do SMS foi bem-sucedida ou não. Ela também retornará uma estrutura codificada em JSON para fornecer detalhes úteis sobre a submissão da mensagem. 

		HTTP/1.1 200 OK
		User-Agent: OZEKI 10.3.116 (www.myozeki.com)
		Content-Type: application/json; charset=utf8
		Last-Modified: Fri, 11 Jun 2021 11:17:49 GMT
		Server: 10/10.3.116
		Transfer-Encoding: chunked
		
		{
		  "http_code": 200,
		  "response_code": "SUCCESS",
		  "response_msg": "Mensagens enfileiradas para entrega.",
		  "data": {
		    "total_count": 1,
		    "success_count": 1,
		    "failed_count": 0,
		    "messages": [
		      {
		        "message_id": "b570dbae-3a05-456d-9dad-a02161b16f1c",
		        "from_station": "%",
		        "to_address": "+36201111111",
		        "to_station": "%",
		        "text": "Olá, Mundo!",
		        "create_date": "2021-06-11 11:20:02",
		        "valid_until": "2021-06-18 11:20:02",
		        "time_to_send": "2021-06-11 11:20:02",
		        "submit_report_requested": true,
		        "delivery_report_requested": true,
		        "view_report_requested": false,
		        "tags": [
		          {
		            "name": "Type",
		            "value": "SMS:TEXT"
		          }
		        ],
		        "status": "SUCCESS"
		      }
		    ]
		  }
		}

Conecte seu gateway SMS à rede móvel e crie uma conta de usuário HTTP API

Assumimos que você já instalou o Ozeki SMS Gateway, e que você conectou-o à rede móvel. Para poder enviar SMS para um telefone móvel a partir do Python, você precisa configurar uma conta de usuário HTTP API no Ozeki SMS Gateway.

Criar um novo usuário (Tutorial em vídeo)

Este vídeo apresenta como configurar uma nova conta de usuário HTTP API. Ele começa com a página inicial do Ozeki SMS Gateway e termina com a aba de Eventos do novo usuário. O vídeo mostrará como criar e configurar seu novo usuário. O melhor deste vídeo é que ele tem apenas 30 segundos de duração mas contém todas as informações necessárias para criar um novo usuário HTTP API.

Vídeo 1 - Como configurar uma conta de usuário HTTP API (Tutorial em vídeo)

Como enviar SMS a partir do Python usando a API de SMS em Python (Tutorial em vídeo)

Este vídeo mostra como baixar o arquivo SendSms.py.zip desta página e como abrir o conteúdo do arquivo incluído em qualquer editor de texto, como o Bloco de Notas do Windows. Se assistir ao vídeo, você notará que o conteúdo do SendSms.py.zip é colocado na área de trabalho do Windows.

Vídeo 2 - Como baixar e abrir o projeto de exemplo (Tutorial em vídeo)

Exemplo de SMS em Python: SendSms.py

O código de exemplo abaixo faz parte do arquivo SendSms.py.zip.

como enviar sms com script python
Figura 3 - SendSms.py

Como verificar se o SMS foi aceito pelo usuário HTTP (Tutorial em vídeo)

Após o SMS ter sido submetido, é uma boa ideia verificar seu gateway SMS, para ver o que foi recebido. Você pode verificar o log abrindo os detalhes do usuário HTTP a partir do console de gerenciamento do Ozeki SMS Gateway. O vídeo a seguir mostra o que procurar. O vídeo começará com o código aberto e terminará com os detalhes da mensagem enviada. Você aprenderá como iniciar o projeto, como o projeto se parece durante a execução e como o arquivo de log se parece depois. O vídeo tem apenas 42 segundos de duração e é fácil de entender. Você não terá problemas para acompanhá-lo.

Vídeo 3 - Como enviar SMS com o script Python acima (Tutorial em vídeo)

Como verificar se o SMS foi enviado para a rede móvel

O passo final para verificar o procedimento é analisar os logs da conexão com a rede móvel. Pode ser necessário ativar o registro na configuração da conexão antes de enviar a mensagem para visualizar os logs. Se o registro estiver ativado, você verá o número de telefone e o texto da mensagem que enviou.

Testar se a solicitação foi aceita (Tutorial em vídeo)

No vídeo a seguir, você verá como verificar se o cliente SMPP teve sucesso ao enviar sua mensagem. Você aprenderá como abrir a aba de eventos do usuário SMPP e o que procurar. O vídeo tem apenas 18 segundos de duração, mas será muito útil.

Vídeo 4 - Como testar se a solicitação foi aceita pelo cliente SMPP (Tutorial em vídeo)

SMS recebido no telefone (Tutorial em vídeo)

No vídeo a seguir, você verá como é uma mensagem recebida enviada pelo Ozeki SMS Gateway. Ele começará com a tela inicial de um telefone Android e terminará com a mensagem aberta. Tem apenas 18 segundos e você pode ver todo o processo de recebimento de uma mensagem.

Vídeo 5 - Como uma mensagem recebida do Ozeki SMS Gateway se parece (Tutorial em vídeo)

Resumo

O guia acima explicou os passos para enviar SMS a partir do Python. Como pode ser visto, o Ozeki fornece todas as ferramentas necessárias para o envio de mensagens, então, se os passos forem seguidos cuidadosamente, enviar mensagens a partir do Python não será mais um problema. O Ozeki SMS Gateway desempenha um papel enorme no envio, você não conseguiria alcançar os usuários móveis sem este programa. É importante notar que o Ozeki SMS Gateway funciona em qualquer país, portanto, as mensagens podem ser enviadas internacionalmente com esta solução.

Não termine a leitura aqui, navegue pela página de tutoriais do Ozeki e aprenda sobre recebimento de SMS em Python.

Sua próxima tarefa é baixar o Ozeki SMS Gateway e começar a trabalhar!

More information