Dev DOC - SMSMobileAPI

SMSmobileAPI Developer Documentation

Na SMSmobileAPI, nos esforçamos para tornar nossa API o mais compatível possível com qualquer arquitetura ou plataforma.
Quer você esteja usando REST, SOAP, cURL ou várias linguagens de programação como Python, JavaScript, PHP e mais, nossa API foi projetada para se integrar perfeitamente aos seus projetos.

Também temos plugins prontos para uso para soluções e software de comércio eletrônico. Clique aqui para descobri-los.

Se você tiver alguma dúvida, sugestão ou precisar de ajuda, nossa equipe está aqui para ajudar.
Sinta-se à vontade para entrar em contato conosco em api@smsmobileapi.com

API REST

enrolar

JavaScript

Pitão

Node.js

Rubi

WSDL

API de envio de SMS

The SMSMobile API supports two authentication methods: using a simple API Key or the OAuth2 protocol with a client ID and client secret.

1. API Key Authentication for Send SMS

This method requires an API Key that can be included as a parameter in either a GET or POST request. It is a straightforward way to authenticate your API requests.

https://api.smsmobileapi.com/sendsms?apikey=YOUR_API_KEY&recipients=PHONE_NUMBER&message=MESSAGE_TO_SEND

Parâmetros:

- apikey: Your unique API key.

- recipients: The recipient's phone number.

- message: The message to send.

Example:

GET https://api.smsmobileapi.com/sendsms?apikey=YOUR_API_KEY&recipients=+1234567890&message=Hello%20World

2. OAuth2 Authentication for Send SMS

OAuth2 provides a more secure and scalable authentication method.
You will need to use a client ID and client secret to obtain an access token, which should then be included in your API requests using the Authorization header.

The client_id and client_secret are available in your dashboard, accessible after installing the app and creating an account on your mobile device.
Download the mobile app now ou access your dashboard.

Obtaining an Access Token

To get an access token, send a POST request to the token endpoint with your client ID and client secret.

 curl -X POST https://api.smsmobileapi.com/oauth2/token \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d "grant_type=client_credentials" \
 -d "client_id=1ab0ex4b4c1ef2c800690d" \
 -d "client_secret=3ed108a93d0414074b94364290b6a7348475e93a0567005"

Using the Access Token:

Once you have the access token, include it in the Authorization header of your API requests:

 curl -X POST https://api.smsmobileapi.com/sendsms \
 -H "Authorization: Bearer abc123xyz456" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d "recipients=+1234567890" \
 -d "message=Hello"

Which Method Should You Use?

- Use API Key Authentication for quick and straightforward integrations.

- Use OAuth2 Authentication for enhanced security and scalability in your integrations.

For more details, please refer to the full documentation.

Obter API SMS

Este ponto de extremidade da API é usado para recuperar mensagens SMS recebidas no smartphone.

https://api.smsmobileapi.com/getsms/?apikey=YOUR_API_KEY

Parâmetro:

- destinatários: O número de celular do destinatário.

- mensagem: A mensagem a ser enviada.

- apikey: A chave de API que você tem ou receberá.

Excluir API de SMS

Este ponto de extremidade da API é usado para excluir mensagens SMS do log do servidor da API SMS Mobile

https://api.smsmobileapi.com/deletesms/?apikey=YOUR_API_KEY

Parâmetro:

- apikey: A chave de API que você possui.

- guid_message: O ID exclusivo da mensagem a ser excluída.

- date_start: Se usado sozinho, exclui todas as mensagens do dia especificado.

- date_start e date_end: combinados para excluir mensagens dentro de um período especificado.

Observação: os SMS excluídos são apenas aqueles armazenados nos logs da sua conta do aplicativo móvel. Os SMS no próprio dispositivo móvel não serão excluídos, pois não temos acesso a eles.

Enviar SMS

URL do WSDL

https://api.smsmobileapi.com/sendsms/wsdl/sendsms.wsdl

Parâmetros:

- destinatários: O número de celular do destinatário.

- mensagem: A mensagem a ser enviada.

- apikey: A chave de API que você tem ou receberá.

Exemplo

 require_once "lib/nusoap.php";
 
 $client = new nusoap_client("https://api.smsmobileapi.com/sendsms/wsdl/sendsms.wsdl", true);
 $error  = $client->getError();
 
 $result = $client->call("sendSms", array("recipients" =>$_GET['recipients'],"message" =>$_GET['message'],"apikey" =>$_GET['apikey']));
 
 print_r($result);

Enviar SMS

Comando básico cURL

Você pode usar o seguinte comando cURL para enviar um SMS via SMSmobileAPI:

 curl -X POST https://api.smsmobileapi.com/sendsms/ \
 -d "recipients=PHONE_NUMBER" \
 -d "message=YOUR_MESSAGE" \
 -d "apikey=YOUR_API_KEY"

Exemplo cURL em PHP

Se você estiver usando PHP, veja como enviar um SMS usando cURL:

 <?php
 
 $url = 'https://api.smsmobileapi.com/sendsms/';
 $data = array(
     'recipients' => 'PHONE_NUMBER',
     'message' => 'YOUR_MESSAGE',
     'apikey' => 'YOUR_API_KEY'
 );
 
 $options = array(
     CURLOPT_URL => $url,
     CURLOPT_POST => true,
     CURLOPT_POSTFIELDS => http_build_query($data),
     CURLOPT_RETURNTRANSFER => true,
 );
 
 $ch = curl_init();
 curl_setopt_array($ch, $options);
 $response = curl_exec($ch);
 curl_close($ch);
 
 echo $response;
 
 ?>

Este exemplo PHP demonstra como enviar uma solicitação POST usando cURL para o SMSmobileAPI, passando os parâmetros necessários como uma matriz associativa.

Enviar SMS

Use nosso módulo Python oficial: https://smsmobileapi.com/python/
ou use o método manual...

Usando a biblioteca `requests`

A biblioteca `requests` é uma biblioteca HTTP popular e simples para Python. Veja como você pode usá-la para enviar um SMS via SMSmobileAPI:

 import requests

 url = "https://api.smsmobileapi.com/sendsms/"

 payload = {
     "recipients": "PHONE_NUMBER",
     "message": "YOUR_MESSAGE",
     "apikey": "YOUR_API_KEY"
 }

 response = requests.post(url, data=payload)

 print(response.text)

Este exemplo demonstra uma solicitação POST simples para o SMSmobileAPI, enviando uma mensagem para um número de telefone específico.

Usando a biblioteca `http.client`

A biblioteca `http.client` está incluída na biblioteca padrão do Python e também pode ser usada para interagir com sua API:

 import http.client
 import urllib.parse

 conn = http.client.HTTPSConnection("api.smsmobileapi.com")

 params = urllib.parse.urlencode({
     "recipients": "PHONE_NUMBER",
     "message": "YOUR_MESSAGE",
     "apikey": "YOUR_API_KEY"
 })

 headers = { "Content-type": "application/x-www-form-urlencoded" }

 conn.request("POST", "/sendsms/", params, headers)
 response = conn.getresponse()
 data = response.read()

 print(data.decode("utf-8"))
 conn.close()

Este exemplo mostra como usar a biblioteca `http.client` para enviar uma solicitação POST para a API. Os parâmetros são codificados em URL e enviados com os cabeçalhos apropriados.

Enviar SMS

Usando a API `fetch`

A API `fetch` é uma maneira moderna e versátil de fazer solicitações HTTP em JavaScript. Veja como você pode usá-la para enviar um SMS via SMSmobileAPI:

 const url = "https://api.smsmobileapi.com/sendsms/";

 const data = {
     recipients: "PHONE_NUMBER",
     message: "YOUR_MESSAGE",
     apikey: "YOUR_API_KEY"
 };

 fetch(url, {
     method: "POST",
     headers: {
         "Content-Type": "application/x-www-form-urlencoded"
     },
     body: new URLSearchParams(data)
 })
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.error("Error:", error));

Este exemplo demonstra como enviar uma solicitação POST usando a API `fetch`, que é suportada na maioria dos navegadores modernos.

Usando `XMLHttpRequest`

Se precisar de suporte a navegadores mais antigos, você pode usar o objeto `XMLHttpRequest`:

 const xhr = new XMLHttpRequest();
 const url = "https://api.smsmobileapi.com/sendsms/";

 const data = "recipients=PHONE_NUMBER&message=YOUR_MESSAGE&apikey=YOUR_API_KEY";

 xhr.open("POST", url, true);
 xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");

 xhr.onreadystatechange = function() {
     if (xhr.readyState === 4 && xhr.status === 200) {
         console.log(xhr.responseText);
     }
 };

 xhr.send(data);

Este exemplo mostra como usar `XMLHttpRequest` para enviar uma solicitação POST, fornecendo compatibilidade com navegadores mais antigos que podem não suportar `fetch`.

Enviar SMS

Usando a biblioteca `axios`

A biblioteca `axios` é um cliente HTTP popular para Node.js. Veja como você pode usá-la para enviar um SMS via SMSmobileAPI:

 const axios = require('axios');

 const url = 'https://api.smsmobileapi.com/sendsms/';
 const data = {
     recipients: 'PHONE_NUMBER',
     message: 'YOUR_MESSAGE',
     apikey: 'YOUR_API_KEY'
 };

 axios.post(url, data)
 .then(response => {
     console.log(response.data);
 })
 .catch(error => {
     console.error('Error:', error);
 });

Este exemplo demonstra como enviar uma solicitação POST usando `axios` no Node.js para interagir com o SMSmobileAPI.

Enviar SMS

Usando a biblioteca `Net::HTTP`

Você pode usar a biblioteca `Net::HTTP` em Ruby para enviar um SMS via SMSmobileAPI:

 require 'net/http'
 require 'uri'

 uri = URI.parse("https://api.smsmobileapi.com/sendsms/")
 request = Net::HTTP::Post.new(uri)
 request.set_form_data(
     "recipients" => "PHONE_NUMBER",
     "message" => "YOUR_MESSAGE",
     "apikey" => "YOUR_API_KEY"
 )

 req_options = {
     use_ssl: uri.scheme == "https",
 }

 response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
     http.request(request)
 end

 puts response.body

Este exemplo demonstra como enviar uma solicitação POST usando `Net::HTTP` em Ruby para o SMSmobileAPI.

Clique aqui para testar a chave API e o serviço com o formulário simples

Dependendo da versão do Android instalada em um celular, o sistema operacional pode dificultar o funcionamento adequado do envio e recebimento automático de mensagens SMS quando o aplicativo SmsMobileApi não estiver em primeiro plano.
Esse problema surge de um processo que tenta ser executado em segundo plano quando o aplicativo não é iniciado ativamente. No entanto, devido às medidas de otimização de bateria do Android, que variam entre versões diferentes, esse processo em segundo plano pode não iniciar corretamente. A otimização de bateria do Android foi projetada para limitar a atividade em segundo plano de aplicativos para conservar a vida útil da bateria, o que pode afetar inadvertidamente aplicativos que exigem processos em segundo plano para funcionar corretamente.

Para resolver esse problema, os usuários podem configurar manualmente as configurações do Android para permitir que o SmsMobileApi use recursos sem restrições.
Isso envolve ajustar as configurações de otimização da bateria para o aplicativo específico, essencialmente instruindo o Android que o SmsMobileApi tem permissão para rodar em segundo plano e usar recursos conforme necessário. Ao fazer isso, o aplicativo deve ser capaz de enviar e receber mensagens SMS automaticamente, mesmo quando não for o aplicativo ativo em primeiro plano. Esse ajuste garante que o processo de segundo plano necessário possa operar ininterruptamente, contornando os recursos de otimização da bateria que poderiam impedir sua execução adequada.

FAQ para Desenvolvedor

Como gerar uma chave de API?

Descrição de amostra do AccordionPara gerar uma chave de API, baixe nosso aplicativo em seu celular e crie uma conta sem custo. Uma chave de API será gerada automaticamente e vinculada ao seu celular. Você também receberá um e-mail com todas as informações necessárias. Esse processo garante que você possa começar a usar nossos serviços de forma rápida e fácil com configuração mínima.

Onde posso sempre encontrar minha chave de API?

No seu aplicativo móvel, navegue até o menu SETTINGS ou HELP, onde sua chave de API fica visível o tempo todo. Isso garante que você possa acessar facilmente sua chave de API sempre que precisar dela para integrar ou usar nossos serviços.

A criação de uma chave de API pode ser anônima?

Sim, não exigimos nenhuma prova de identidade para criar uma chave de API. A comunicação entre nossa API e seu celular é, portanto, 100% anônima. Essa abordagem permite que os usuários mantenham sua privacidade enquanto utilizam nossos serviços.

Comece a usar o SMSmobileAPI hoje mesmo!

Experimente a liberdade e a flexibilidade de gerenciar seus serviços de SMS em qualquer lugar. Baixe nosso aplicativo móvel agora e dê o primeiro passo em direção à integração perfeita de SMS.

Baixe o aplicativo