Documentação SMS

Enviar SMS

Ponto final: 

Parâmetros:

Exemplo:

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:

Parâmetro: 

Exemplo: 

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: 

Parâmetro:

Exemplo:

Lista de SMS enviados do celular

Este endpoint da API é usado para listar as mensagens SMS enviadas do seu dispositivo móvel e sincronizadas com a sua conta SMSMobileAPI.

Importante: Este recurso está disponível a partir da versão do Android 4.1.20.

Importante: Essa funcionalidade é não está habilitado por padrão no aplicativo Android.

Privacidade: Todas as informações sincronizadas são anonimizadas, confidenciais e tratadas com segurança.

Limite de histórico: Esta API sempre retorna dados da última vez 7 dias apenas.

Observação: Se você enviar SMS usando o endpoint da API padrão https://api.smsmobileapi.com/sendsms/Essas mensagens SMS também podem aparecer nesta lista porque são enviadas fisicamente do seu dispositivo móvel.

Ponto final:

Parâmetros: 

Campos retornados: 

Exemplo: 

Exemplo com filtros:

Exemplo com período predefinido:

SMS recebido

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

Ponto final:

Parâmetro: 

Exemplo:

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:

Parâmetro: 

Exemplo:

Atualizar alias de SMS

Este endpoint da API é usado para atualizar o alias de um SMS recebido usando seu GUID.

Observação: O alias O parâmetro pode estar vazio. Nesse caso, o alias será apagado.

Ponto final:

Parâmetros: 

Exemplo: 

Exemplo para limpar o alias:

Apagar SMS

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

Ponto final: 

Parâmetro:

Exemplo:

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

Listar conversas por SMS

Este endpoint da API é usado para listar as conversas por SMS vinculadas à sua conta.

Cada conversa é agrupada por número de telefone e contém as mensagens SMS recebidas e enviadas relacionadas.

Observação: O ponto de partida da conversa é definido por origineConversation parâmetro:

• receivedAs conversas são detectadas inicialmente a partir de SMS recebidos em logsmsreceive
• sentAs conversas são detectadas inicialmente a partir de SMS enviados em logsmssent

Observação: Se numero Se não for fornecido, a API retorna apenas as conversas mais recentes. Por padrão, a última 20 As conversas são respondidas.

Observação: Para SMS de saída, se timearea_of_message está disponível (exemplo: UTC+02), a data exibida é convertida automaticamente usando esse valor. Essa data convertida também é usada para classificação.

Observação: Se resume=1, apenas as mensagens mais recentes de cada conversa são retornadas. Use resume_line_how Para definir quantas mensagens mais recentes devem ser incluídas.

Ponto final:

Parâmetros: 

Detalhes do comportamento: 

Exemplo 1 - Listar as conversas mais recentes recebidas por SMS: 

Exemplo 2 - Listar as conversas mais recentes enviadas por SMS:

Exemplo 3 - Filtrar um número de telefone específico:

Exemplo 4 - Filtrar por intervalo de datas:

Exemplo 5 - Modo de retomada com as últimas 3 mensagens por conversa:

Exemplo de resposta bem-sucedida: 

{ "success": true, "origineConversation": "received", "resume": 0, "resume_line_how": null, "conversations": [ { "phone_number": "+10470000001", "contact_alias": "John Doe", "messages": [ { "direction": "incoming", "message_id": "msg_1001", "date": "2026-03-13 08:45:12", "timestamp_utc": "2026-03-13T08:45:12Z", "message": "Olá, gostaria de mais informações.", "status": "received", "mobile_sid": "device_sid_1" }, { "direction": "outgoing", "message_id": "msg_1002", "date": "2026-03-13 10:46:03", "timestamp_utc": "2026-03-13T08:46:03Z", "message": "Claro, o que você gostaria de saber?", "status": "sent", "mobile_sid": "device_sid_2" } ] } ] }

Campos de resposta:

Exemplo de erro:

{ "success": false, "error": "Parâmetro obrigatório ausente: apikey" }

Notas:

Gateway – Lista de dispositivos móveis conectados

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

Ponto final:

Parâmetros:

Exemplo:

Gateway – Atualizar uma etiqueta móvel

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

Ponto final:

Parâmetros:

Exemplo:

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:

Parâmetros:

Exemplo:

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:

1. Entre na sua conta no Painel de API móvel SMS.
2. Navegue até o Configurações do Webhook seção.
3. Insira a URL do seu webhook (por exemplo, https://example.com/webhook-endpoint).
4. Clique no Salvar Webhook botão. 
5. 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:

• Webhook.site
• SolicitaçãoBin

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

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

Usando o Token de Acesso:

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.