DOC de desenvolvimento - SMSMobileAPI

Documentação SMS

Documentação do desenvolvedor SMSmobileAPI

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.

.

API REST

cURL

Composer

JavaScript

Pitão

Node.js

Rubi

WSDL

Autenticação

CHAVE API
OAuth2

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	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 (O comprimento da mensagem não está limitado a 160 caracteres; você pode enviar mensagens mais longas)
sendwa	1 = a mensagem deve ser enviada via WhatsApp.
sendsms	1 = a mensagem deve ser enviada via SMS tradicional. (Se envia sms está vazio: enviado por padrão, definido como 0 para bloquear o SMS)
encrypt_message	sim = A mensagem será criptografada quando lida pelo destinatário. O destinatário precisará inserir uma chave exclusiva para descriptografar a mensagem. Saiba mais sobre criptografia de mensagens
schedule_timestamp	Representando o horário a partir do qual o SMS deve ser enviado - Deve ser um Carimbo de data/hora UNIX (GMT 0)

Exemplo:


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

Observação: em caso de erro de entrega causado pela sua operadora, uma função padrão tenta enviar o mesmo SMS até 3 vezes dentro de um intervalo definido.

Reenviar um SMS não enviado

Este ponto de extremidade 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	Abreviação pelo identificador exclusivo da mensagem usada para classificação e filtragem.
before	Recupere mensagens enviadas antes deste registro de data e hora ou GUID específico.
error_api	Digite 1 para listar todos os SMS que encontraram um erro durante a solicitação de API.
error_mobile	Digite 1 para listar todos os SMS que encontraram um erro durante o processamento móvel.
keyword	Uma palavra-chave para filtrar mensagens com base no número do destinatário ou no conteúdo do SMS.

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á.

Exemplo:


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

Apagar SMS

Este ponto de extremidade da API é usado para excluir mensagens SMS do log 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: 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.

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:

{

    "data": "2025-01-20",

    "hora": "10:15:00",

    "time_received": "2025-01-20 10:14:50",

    "message": "Olá, isto é um teste.",

    "número": "+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:

<?php

// Leia a carga útil de entrada

$payload = file_get_contents('php://input');

$data = json_decode($payload, verdadeiro);




// Processar os dados do SMS

se ($data) {

    // Exemplo: Registre os dados do SMS em um arquivo

    file_put_contents('sms_log.txt', print_r($data, true), FILE_APPEND);




    // Responder com status HTTP 200

    http_resposta_código(200);

    echo "Webhook recebido com sucesso.";

} outro {

    // Responder com status HTTP 400 para solicitações inválidas

    http_response_code(400);


    echo "Carga útil inválida.";

}

?>

Testando o Webhook

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

Essas ferramentas permitem que você inspecione a carga enviada pelo sistema e depure quaisquer problemas com a configuração do seu webhook.

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.

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 API Key que pode ser incluída como um parâmetro em uma solicitação GET ou POST. É uma maneira direta de autenticar suas solicitações de API.

2. Autenticação OAuth2

O OAuth2 fornece um método de autenticação mais seguro e escalável.
Você precisará usar um ID de cliente e um segredo de cliente para obter um token de acesso, que deve ser incluído em suas solicitações de API usando o Autorização cabeçalho.

O client_id e o client_secret estão disponíveis no seu painel, acessíveis após instalar o aplicativo e criar uma conta no seu dispositivo móvel.
Baixe o aplicativo móvel agora ou acesse seu painel.

Obtendo um Token de Acesso

Para obter um token de acesso, envie uma solicitação POST ao ponto de extremidade do token com seu ID de cliente e segredo do cliente.


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"

Usando o Token de Acesso:

Depois de ter o token de acesso, inclua-o no Autorização cabeçalho das suas solicitações de API:


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

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

-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 em suas integrações.

Para mais detalhes, consulte a documentação completa.

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. (O comprimento da mensagem não é limitado a 160 caracteres; você pode enviar mensagens mais longas)

- 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

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" 

		
		 -d "sendwa=1"

		 -d "sendsms=1"

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'

		    'sendwa' => '1'

		    'sendsms' => '1'

        );

        

        $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 e WhatsApp

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.

API móvel SMS - PHP SDK (compositor)

O SMS Mobile API PHP SDK está disponível via Composer, facilitando a integração do envio de SMS em seus aplicativos PHP.


		compositor requer smsmobileapi/sdk

Para documentação detalhada, instruções de instalação e exemplos de uso, visite nosso repositório GitHub:

🔗 SDK PHP da API móvel SMS no GitHub: https://github.com/SmsMobileApi/smsmobileapi-php/tree/main

No GitHub, você encontrará:
✔️ Guia completo de instalação
✔️ Exemplo de uso
✔️ Referência de API e melhores práticas

Precisa de ajuda? Sinta-se à vontade para abrir um issue no GitHub! 🎯

Enviar SMS e WhatsApp

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 e WhatsApp

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 e WhatsApp

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.

Você pode enviar mensagens do WhatsApp somente por meio da nossa API. Clique aqui para saber mais.

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

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

Recursos de SMS

Recursos do WhatsApp

Plugins gerais

Plugins de Loja Online

Documentação de API e desenvolvedor

Ferramentas e log de alterações

Documentação SMS

Enviar SMS

Reenviar SMS não enviados

LOG SMS enviado

Obter SMS recebido

Apagar SMS

SMS recebido - Webhook

Autenticação

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:

Apagar SMS

Ponto final:

Parâmetro:

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

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

Exemplo cURL em PHP

Enviar SMS e WhatsApp

Usando a biblioteca `requests`

Usando a biblioteca `http.client`

API móvel SMS - PHP SDK (compositor)

Enviar SMS e WhatsApp

Usando a API `fetch`

Usando `XMLHttpRequest`

Enviar SMS e WhatsApp

Usando a biblioteca `axios`

Enviar SMS e WhatsApp

Usando a biblioteca `Net::HTTP`

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!