Documentação SMS

Na SMSmobileAPI, nos esforçamos para tornar nossa API o mais compatível possível com qualquer arquitetura ou plataforma.
Quer você utilize REST, SOAP, cURL ou diversas linguagens de programação como Python, JavaScript, PHP e outras, 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.

Precisar de ajuda? api@smsmobileapi.com

Procurar

Enviar SMS

Este ponto de extremidade permite que você envie um SMS do seu celular.

Ponto final:

PEGAR PUBLICAR https://api.smsmobileapi.com/sendsms/

Parâmetros:

Parâmetro	Descrição
apikey	Obrigatório Sua chave de API exclusiva.
recipients	Obrigatório O número de telefone do destinatário.
message	Obrigatório A mensagem a ser enviada (sem limite de 160 caracteres).
shorturl	1 = Converter URLs em links curtos 0 ou vazio = nenhuma conversão
sIdentifiant	Selecione qual telefone conectado enviará o SMS. Deixe em branco para o primeiro dispositivo disponível. Requer aplicativo versão 3.0.35.3 ou superior.
sendwa	1 = enviar via WhatsApp.
sendsms	1 = enviar por SMS (padrão se estiver vazio). Defina como 0 para bloquear SMS.
encrypt_message	sim = o destinatário precisa de uma chave para descriptografar. Saber mais
schedule_timestamp	Timestamp UNIX (GMT 0) a partir do qual o SMS deve ser enviado.

Exemplo:

GET https://api.smsmobileapi.com/sendsms?apikey=YOUR_API_KEY&recipients=+1234567890&message=HelloWorld

Nota: em caso de erro de entrega causado pela sua operadora, uma função padrão tenta novamente até 3 vezes.

Reenviar um SMS não enviado

Este endpoint da API é usado para reenviar um SMS não enviado (somente se a mensagem tiver um status de erro).

Ponto final:

PEGAR PUBLICAR https://api.smsmobileapi.com/resend/

Parâmetro:

Parâmetro	Descrição
guid	Obrigatório GUID da mensagem a ser reenviada.

Exemplo:

OBTENHA https://api.smsmobileapi.com/resend/?apikey=SUA_CHAVE_API&guid=GUID_DA_MENSAGEM

Log de SMS enviados da API

Este ponto de extremidade da API é usado para recuperar o log de mensagens SMS enviadas via API.

Ponto final:

PEGAR https://api.smsmobileapi.com/log/sent/sms/

Parâmetro:

Parâmetro	Descrição
apikey	Obrigatório Sua chave de API.
guid_message	Filtrar pelo identificador único da mensagem.
before	Recuperar mensagens enviadas antes deste carimbo de data/hora ou GUID.
error_api	1 = lista de SMS com erro na solicitação da API.
error_mobile	1 = lista de SMS com erro de processamento móvel.
keyword	Filtrar por número do destinatário ou conteúdo da mensagem.

Exemplo:

OBTENHA https://api.smsmobileapi.com/log/sent/sms?apikey=SUA_CHAVE_API

SMS recebido

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

Ponto final:

PEGAR https://api.smsmobileapi.com/getsms/

Parâmetro:

Parâmetro	Descrição
apikey	Obrigatório A chave de API que você tem ou receberá.
sIdentifiantPhone	Isole o telefone associado ao SMS recebido.
after_timestamp_unix	Lista de SMS recebidos após um timestamp UNIX.
onlyunread	"sim" = listar apenas SMS não marcados como lidos (status da API).

Exemplo:

OBTENHA https://api.smsmobileapi.com/getsms/?apikey=SUA_CHAVE_API

Marcar mensagens SMS recebidas como lidas

Este endpoint da API é usado para marcar uma mensagem SMS recebida como lida. Somente o status da API.
Isso não altera o status de leitura no smartphone.

Ponto final:

PEGAR https://api.smsmobileapi.com/getsms/set-read/

Parâmetro:

Parâmetro	Descrição
apikey	Obrigatório A chave de API que você tem ou receberá.
guid_message	Obrigatório GUID da mensagem a ser marcada como lida.

Exemplo:

OBTER https://api.smsmobileapi.com/getsms/set-read/?apikey=YOUR_APIKEY&guid_message=GUID_MESSAGE

Apagar SMS

Este endpoint da API é usado para excluir mensagens SMS do registro do servidor da API SMS Mobile.

Ponto final:

PEGAR https://api.smsmobileapi.com/deletesms/

Parâmetro:

Parâmetro	Descrição
apikey	Obrigatório A chave de API que você tem.
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 and date_end	Combinado para excluir mensagens dentro de um período especificado.

Exemplo:

OBTENHA https://api.smsmobileapi.com/deletesms/?apikey=SUA_CHAVE_API

Observação: Apenas os SMS armazenados nos registros do servidor serão apagados. Os SMS presentes no dispositivo não serão apagados.

Gateway – Lista de dispositivos móveis conectados

Liste os celulares conectados à sua rede. Gateway de SMS.

Ponto final:

PEGAR PUBLICAR https://api.smsmobileapi.com/gateway/mobile/list/

Parâmetros:

Parâmetro	Descrição
apikey	Obrigatório Sua chave de API.
sid	Filtrar pelo SID exato (sIdentifiant_pour_check).
search	Pesquisar nos campos (sid, data, bateria, versão, etiqueta...).

Exemplo:

GET https://api.smsmobileapi.com/gateway/mobile/list/?apikey=YOUR_API_KEY

Observação: as estatísticas de SMS recebidos estão disponíveis a partir da versão 3.0.33.3+ do aplicativo móvel.

Gateway – Atualizar uma etiqueta móvel

Atualize o rótulo (nom_reference) de um dispositivo móvel conectado.

Ponto final:

PEGAR PUBLICAR https://api.smsmobileapi.com/gateway/mobile/update/

Parâmetros:

Parâmetro	Descrição
apikey	Obrigatório Sua chave de API.
sid	Obrigatório O SID do dispositivo (sIdentifiant_pour_check).
label	Obrigatório Nova etiqueta (pode estar vazia).

Exemplo:

GET https://api.smsmobileapi.com/gateway/mobile/update/?apikey=YOUR_API_KEY&sid=SID&label=OfficePhone

Importante: O rótulo é obrigatório, mas pode estar vazio. (rótulo=).

Gateway – Excluir um dispositivo móvel conectado

Remover um dispositivo móvel conectado do seu gateway (exclui todas as linhas de histórico para este SID).

Ponto final:

PEGAR PUBLICAR https://api.smsmobileapi.com/gateway/mobile/delete/

Parâmetros:

Parâmetro	Descrição
apikey	Obrigatório Sua chave de API.
sid	Obrigatório O SID do dispositivo (sIdentifiant_pour_check).

Exemplo:

GET https://api.smsmobileapi.com/gateway/mobile/delete/?apikey=YOUR_API_KEY&sid=SID

Webhook – SMS recebido

Este sistema de webhook envia uma solicitação POST para a URL configurada sempre que um SMS é recebido. O sistema garante atualizações em tempo real ao entregar os detalhes do SMS para a URL do webhook especificada.

Como configurar o Webhook no painel

Siga estas etapas para configurar o URL do seu webhook no painel:

Entre na sua conta no Painel de API móvel SMS.
Navegue até o Configurações do Webhook seção.
Insira a URL do seu webhook (por exemplo, https://example.com/webhook-endpoint).
Clique no Salvar Webhook botão.
Depois de salvo, o sistema começará a enviar detalhes por SMS para a URL configurada.

Carga útil do webhook

Quando um SMS é recebido, o sistema envia a seguinte carga JSON para o URL do seu webhook:

{ "date": "2025-01-20", "hour": "10:15:00", "time_received": "2025-01-20 10:14:50", "message": "Olá, isto é um teste.", "number": "+123456789", "guid": "abcde12345" }

Campos de carga útil:

data: Data em que o SMS foi adicionado (AAAA-MM-DD).
hora: Hora em que o SMS foi adicionado (HH:mm:ss).
tempo_recebido: Hora em que o SMS foi recebido.
mensagem: Conteúdo do SMS.
número: Número de telefone do remetente.
guia: Identificador único do SMS.

Exemplo de ponto de extremidade do Webhook

Seu servidor deve estar pronto para lidar com solicitações POST de entrada. Abaixo está um script PHP de exemplo para processar o payload do webhook:

Testando o Webhook

Para testar sua configuração de webhook, use ferramentas como:

Solução de problemas

Certifique-se de que a URL do webhook esteja correta e acessível publicamente.
Verifique se seu servidor está retornando um código de status HTTP 200 para solicitações bem-sucedidas.
Verifique os logs do seu servidor para ver se há erros no processamento da carga útil.

SMS enriquecido

Em breve

Autenticação

A API do SMSMobile oferece suporte a dois métodos de autenticação: usando uma chave de API simples ou o protocolo OAuth2 com um ID de cliente e um segredo de cliente.

1. Autenticação de chave de API

Este método requer uma chave de API que pode ser incluída como parâmetro em uma solicitação GET ou POST.

2. Autenticação OAuth2

O OAuth2 oferece um método de autenticação mais seguro.
Use um ID de cliente e um segredo de cliente para obter um token de acesso e, em seguida, inclua-o no Autorização cabeçalho.

O client_id e o client_secret estão disponíveis no seu painel.
Baixe o aplicativo móvel agora ou Acesse seu painel de controle.

Obtendo um Token de Acesso


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=YOUR_CLIENT_ID" \

-d "client_secret=YOUR_CLIENT_SECRET"

Usando o Token de Acesso:


curl -X POST https://api.smsmobileapi.com/sendsms \

-H "Autorização: Portador SEU_TOKEN_DE_ACESSO" \

-H "Tipo de conteúdo: aplicação/x-www-form-urlencoded" \

-d "destinatários=+1234567890" \

-d "mensagem=Olá"

Qual método você deve usar?

- Usar Autenticação de chave API para integrações rápidas e diretas.

- Usar Autenticação OAuth2 Para maior segurança e escalabilidade.

Enviar SMS

URL do WSDL

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

Parâmetros:

- recipients: O número de celular do destinatário.
- message: 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 e WhatsApp

Comando básico cURL


curl -X POST https://api.smsmobileapi.com/sendsms/ \

-d "recipients=PHONE_NUMBER" \

-d "message=YOUR_MESSAGE" \

-d "apikey=YOUR_API_KEY" 

-d "sendwa=1"

-d "sendsms=1"

Enviar SMS e WhatsApp

Utilize nosso módulo oficial em Python: https://smsmobileapi.com/python/


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)

API móvel SMS - PHP SDK (compositor)

compositor requer smsmobileapi/sdk

GitHub: https://github.com/SmsMobileApi/smsmobileapi-php/tree/main

Enviar SMS e WhatsApp


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(r=>r.text()).then(console.log);

Enviar SMS e WhatsApp


const axios = require("axios");

axios.post("https://api.smsmobileapi.com/sendsms/", {recipients:"PHONE_NUMBER", message:"YOUR_MESSAGE", apikey:"YOUR_API_KEY"})

.then(r=>console.log(r.data));

Enviar SMS e WhatsApp


require "net/http"

require "uri"

uri = URI.parse("https://api.smsmobileapi.com/sendsms/")

req = Net::HTTP::Post.new(uri)

req.set_form_data({"recipients"=>"PHONE_NUMBER","message"=>"YOUR_MESSAGE","apikey"=>"YOUR_API_KEY"})

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true){|http| http.request(req)}

puts res.body

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

Documentação de API e desenvolvedor

Ferramentas e log de alterações

Enviar SMS

Ponto final:

Parâmetros:

Exemplo:

Reenviar um SMS não enviado

Ponto final:

Parâmetro:

Exemplo:

Log de SMS enviados da API

Ponto final:

Parâmetro:

Exemplo:

SMS recebido

Ponto final:

Parâmetro:

Exemplo:

Marcar mensagens SMS recebidas como lidas

Ponto final:

Parâmetro:

Exemplo:

Apagar SMS

Ponto final:

Parâmetro:

Exemplo:

Gateway – Lista de dispositivos móveis conectados

Ponto final:

Parâmetros:

Exemplo:

Gateway – Atualizar uma etiqueta móvel

Ponto final:

Parâmetros:

Exemplo:

Gateway – Excluir um dispositivo móvel conectado

Ponto final:

Parâmetros:

Exemplo:

Webhook – SMS recebido

Como configurar o Webhook no painel

Carga útil do webhook

Campos de carga útil:

Exemplo de ponto de extremidade do Webhook

Testando o Webhook

Solução de problemas

SMS enriquecido

Autenticação

1. Autenticação de chave de API

2. Autenticação OAuth2

Obtendo um Token de Acesso

Usando o Token de Acesso:

Qual método você deve usar?

Enviar SMS

URL do WSDL

Parâmetros:

Exemplo

Enviar SMS e WhatsApp

Comando básico cURL

Enviar SMS e WhatsApp

API móvel SMS - PHP SDK (compositor)

Enviar SMS e WhatsApp

Enviar SMS e WhatsApp

Enviar SMS e WhatsApp

FAQ para Desenvolvedor

Como gerar uma chave de API?

Onde posso sempre encontrar minha chave de API?

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

Comece a usar o SMSmobileAPI hoje mesmo!

💬 Chat ao vivo disponível