Documentação da API SMS: envi…receber e gerenciar SMS

Comece aqui

Sua primeira solicitação em quatro etapas

Crie uma conta e copie a chave de API do painel.

Instale o aplicativo móvel e confirme se o dispositivo está on-line.

Envie um SMS de teste com o endpoint /sendsms/.

Armazene o ID da mensagem retornada para correlacionar registros e status de entrega.

The secure SMSMobileAPI mobile app connecting a phone to the web dashboard and REST API for SMS and call operations — Encrypted mobile-to-platform connection

Official mobile application

The secure bridge between your phone, dashboard and API.

SMS and call operations pass through the official SMSMobileAPI app installed on your connected phone. The app securely pairs the device with your account, synchronizes authorized events and links the mobile network to the dashboard and REST API.

1Mobile appPairs the phone and its SIM 2Encrypted linkAuthenticates and protects data in transit 3Dashboard & APIControls workflows and activity

Signed releases distributed through the official Google Play and Apple App Store listings
Google and Apple platform review, signing and distribution controls
Secure device pairing, HTTPS transport and authenticated API access
Only the permissions required for the mobile features you enable

Get the official SMSMobileAPI app on Google Play

Download the official SMSMobileAPI app on the Apple App Store

Capabilities depend on the permissions and background access allowed by Android or iOS.

Autenticação

Mantenha as credenciais no seu servidor

Cada solicitação aceita uma chave de API por meio do parâmetro apikey. As credenciais do cliente OAuth2 também estão disponíveis para integrações entre servidores. Nunca exponha uma chave de produção no código do navegador, repositórios públicos ou mensagens de suporte.

POST · GET

Envie um SMS

ENDPOINThttps://api.smsmobileapi.com/sendsms/

Enfileira uma mensagem em um telefone conectado. POST é recomendado quando a mensagem é longa ou contém caracteres especiais.

Quando usá-lo

Use para mensagens transacionais, lembretes, alertas e SMS gerados por aplicativos.

Parâmetros

Nome	Tipo	Requisito	Descrição
`apikey`	corda	Obrigatório	Chave de API da sua conta.
`recipients`	telefone	Obrigatório	Número de destino em formato internacional.
`message`	corda	Obrigatório	Corpo da mensagem. Codifique-o em URL ao usar GET.
`port`	1 \| 2	Opcional	Porta SIM em dispositivos Android compatíveis; deixe em branco para seleção automática.
`sIdentifiant`	corda	Opcional	SID específico do telefone conectado; deixe em branco para o primeiro dispositivo disponível.
`shorturl`	0 \| 1	Opcional	Defina como 1 para encurtar URLs encontrados na mensagem.
`sendsms`	0 \| 1	Opcional	Sinalizador de canal SMS. O padrão é 1 quando omitido.
`sendwa`	0 \| 1	Opcional	Solicite também a entrega do WhatsApp quando a conta suportar.
`encrypt_message`	sim	Opcional	Criptografe a mensagem para leitura protegida pelo destinatário.
`schedule_timestamp`	Segundos Unix	Opcional	Hora UTC a partir da qual a mensagem pode ser enviado.

Exemplo de solicitação

enrolar

curl -X POST "https://api.smsmobileapi.com/sendsms/" \
  -d "apikey=YOUR_API_KEY" \
  -d "recipients=+1234567890" \
  --data-urlencode "message=Your appointment is confirmed for tomorrow."

Exemplo de resposta

JSON

{
  "result": {
    "error": 0,
    "sent": "1",
    "id": "c319d3b35e8f8712cde20dae39ac3c19f86eda25",
    "note": "sent by mobile",
    "datetime": "2026-03-20T21:07:44Z",
    "port": null,
    "send_with_whatsapp": "0"
  }
}

Deseja executar esta solicitação?Conecte sua chave de API na parte superior da página para desbloquear o interativo testador.

Chave de conexão ↑

É bom saber

Uma resposta da API bem-sucedida significa que a mensagem foi aceita pela plataforma; mantenha o ID retornado para rastreamento posterior.
A entrega pela operadora e o processamento móvel podem ocorrer após a resposta HTTP.

POST · GET

Reenviar um SMS não enviado

ENDPOINThttps://api.smsmobileapi.com/resend/

Tenta novamente uma mensagem que está atualmente em estado de erro.

Quando usá-lo

Use isto depois de verificar o log enviado e confirmar que uma mensagem com falha está qualificada para outra tentativa.

Parâmetros

Nome	Tipo	Requisito	Descrição
`apikey`	corda	Obrigatório	Chave de API da sua conta.
`guid`	corda	Obrigatório	O GUID da mensagem retornado pelo endpoint de envio ou registro.

Exemplo de solicitação

enrolar

curl "https://api.smsmobileapi.com/resend/?apikey=YOUR_API_KEY&guid=GUID_OF_THE_MESSAGE"

Exemplo de resposta

JSON

{
  "result": {
    "error": "0",
    "sms": "resent with successfully",
    "attempt": 1
  }
}

Deseja executar esta solicitação?Conecte sua chave de API na parte superior da página para desbloquear o interativo testador.

Chave de conexão ↑

É bom saber

Somente mensagens com status de erro podem ser reenviadas.

PEGAR

Liste os SMS enviados da API

ENDPOINThttps://api.smsmobileapi.com/log/sent/sms/

Retorna mensagens enviadas por meio da API SMS com informações de fila, celular e erro.

Quando usá-lo

Use-o para monitoramento de entrega, diagnóstico de suporte e reconciliação.

Parâmetros

Nome	Tipo	Requisito	Descrição
`apikey`	corda	Obrigatório	Chave de API da sua conta.
`guid_message`	corda	Opcional	Retorne uma mensagem por seu GUID exclusivo.
`before`	carimbo de data e hora ou referência	Opcional	Retorne mensagens antes do cursor ou carimbo de data/hora fornecido.
`error_api`	0 \| 1	Opcional	Defina como 1 para retornar apenas erros de processamento de API.
`error_mobile`	0 \| 1	Opcional	Defina como 1 para retornar apenas erros de envio de celular.
`keyword`	corda	Opcional	Pesquise o número do destinatário ou o texto da mensagem.

Exemplo de solicitação

enrolar

curl "https://api.smsmobileapi.com/log/sent/sms/?apikey=YOUR_API_KEY&guid_message=MESSAGE_GUID"

Exemplo de resposta

JSON

{
  "result": {
    "error": "0",
    "sms": [{
      "sIdentifiantPhone": "508b004b4aadacc4",
      "recipients": "+1234567890",
      "sms": "Test message",
      "guid_message": "MESSAGE_GUID",
      "send_from_mobile": 1,
      "error_api": "",
      "send_from_mobile_erreur": ""
    }]
  }
}

Deseja executar esta solicitação?Conecte sua chave de API na parte superior da página para desbloquear o interativo testador.

Chave de conexão ↑

PEGAR

Listar SMS sincronizados de um telefone

ENDPOINThttps://api.smsmobileapi.com/log/sent/frommobile/

Lista os SMS enviados fisicamente por um celular e sincronizados com a plataforma.

Quando usá-lo

Use-o quando as mensagens puderem ser originadas no telefone, bem como através do API.

Parâmetros

Nome	Tipo	Requisito	Descrição
`apikey`	corda	Obrigatório	Chave de API da sua conta.
`date`	AAAA-MM-DD	Opcional	Filtre uma data exata.
`date_from`	AAAA-MM-DD	Opcional	Início de um período.
`date_to`	AAAA-MM-DD	Opcional	Fim de um período.
`period`	enum	Opcional	hoje, ontem, last_24h, last_3days ou last_7days.
`number`	telefone	Opcional	Filtrar por destinatário.
`sIdentifiant`	corda	Opcional	Filtrar por SID móvel conectado.
`message`	corda	Opcional	Filtrar por conteúdo da mensagem.
`search`	corda	Opcional	Pesquisa global em celular, número, mensagem e carimbos de data/hora.
`sort_by`	enum	Opcional	sIdentifiant, número, mensagem, mobile_date_ms, mobile_date_formatted ou synchro_time.
`sort_order`	ASC \| DESC	Opcional	Direção da classificação.
`limit`	inteiro	Opcional	Máximo de 200 registros.

Exemplo de solicitação

enrolar

curl "https://api.smsmobileapi.com/log/sent/frommobile/?apikey=YOUR_API_KEY&period=last_7days&limit=200"

Exemplo de resposta

JSON

{
  "result": {
    "error": "0",
    "count": 1,
    "history_limit_days": 7,
    "sms": [{
      "sIdentifiant": "508b004b4aadacc4",
      "number": "+15551234567",
      "message": "Appointment confirmed.",
      "mobile_date_ms": 1774041004692,
      "synchro_time": "2026-03-20 21:10:05"
    }]
  }
}

Deseja executar esta solicitação?Conecte sua chave de API na parte superior da página para desbloquear o interativo testador.

Chave de conexão ↑

É bom saber

Requer aplicativo Android 4.1.20 ou mais recente e deve estar ativado no aplicativo.
Este endpoint retorna no máximo sete dias de histórico sincronizado.

PEGAR

Listar SMS recebidos

ENDPOINThttps://api.smsmobileapi.com/getsms/

Retorna SMS recebidos sincronizados de telefones conectados.

Quando usá-lo

Use-o para criar uma caixa de entrada, pesquisar respostas ou recuperar mensagens após uma interrupção do webhook.

Parâmetros

Nome	Tipo	Requisito	Descrição
`apikey`	corda	Obrigatório	Chave de API da sua conta.
`sIdentifiantPhone`	corda	Opcional	Filtrar pelo telefone que recebeu o SMS.
`after_timestamp_unix`	Segundos Unix	Opcional	Retorna mensagens recebidas após esse carimbo de data/hora.
`onlyunread`	sim	Opcional	Retorna apenas mensagens não marcadas como lidas no estado da API.

Exemplo de solicitação

enrolar

curl "https://api.smsmobileapi.com/getsms/?apikey=YOUR_API_KEY&onlyunread=yes"

Exemplo de resposta

JSON

{
  "result": {
    "error": "",
    "sms": [{
      "id": 466340,
      "sIdentifiantPhone": "508b004b4aadacc4",
      "timestamp_unix": 1774041814,
      "message": "Please call us back.",
      "number": "+15551234567",
      "guid": "6BFD7DC7-3492-422D-8D02-4AF4E614F122",
      "alias": null
    }]
  }
}

Deseja executar esta solicitação?Conecte sua chave de API na parte superior da página para desbloquear o interativo testador.

Chave de conexão ↑

POST · GET

Marcar um SMS recebido como lido

ENDPOINThttps://api.smsmobileapi.com/getsms/set-read/

Marca uma mensagem recebida como lida no estado da API SMSMobileAPI.

Quando usá-lo

Use isto depois que seu aplicativo tiver processado uma entrada. mensagem.

Parâmetros

Nome	Tipo	Requisito	Descrição
`apikey`	corda	Obrigatório	Chave de API da sua conta.
`guid_message`	corda	Obrigatório	GUID do SMS recebido.

Exemplo de solicitação

enrolar

curl "https://api.smsmobileapi.com/getsms/set-read/?apikey=YOUR_API_KEY&guid_message=MESSAGE_GUID"

Deseja executar esta solicitação?Conecte sua chave de API na parte superior da página para desbloquear o interativo testador.

Chave de conexão ↑

É bom saber

Isso não altera o estado de leitura dentro do aplicativo de mensagens telefônicas.

POST · GET

Atualizar um alias de SMS recebido

ENDPOINThttps://api.smsmobileapi.com/getsms/update/

Adiciona, altera ou limpa o alias associado a um SMS recebido.

Quando usá-lo

Use aliases para anexar um nome de contato. ou rótulo de aplicativo para uma mensagem.

Parâmetros

Nome	Tipo	Requisito	Descrição
`apikey`	corda	Obrigatório	Chave de API da sua conta.
`guid`	corda	Obrigatório	GUID do SMS recebido.
`alias`	corda	Obrigatório	Novo alias. Envie um valor vazio para limpá-lo.

Exemplo de solicitação

enrolar

curl "https://api.smsmobileapi.com/getsms/update/?apikey=YOUR_API_KEY&guid=MESSAGE_GUID&alias=John%20Doe"

Deseja executar esta solicitação?Conecte sua chave de API na parte superior da página para desbloquear o interativo testador.

Chave de conexão ↑

POST · GET

Excluir logs do servidor SMS

ENDPOINThttps://api.smsmobileapi.com/deletesms/

Exclui registros SMS do log do servidor SMSMobileAPI.

Quando usá-lo

Use-o para fluxos de trabalho de retenção ou remoção de uma mensagem registrada específica.

Parâmetros

Nome	Tipo	Requisito	Descrição
`apikey`	corda	Obrigatório	Chave de API da sua conta.
`guid_message`	corda	Opcional	Exclua uma mensagem por GUID.
`date_start`	AAAA-MM-DD	Opcional	Exclua registros desta data.
`date_end`	AAAA-MM-DD	Opcional	Com date_start, limita o intervalo de exclusão.

Exemplo de solicitação

enrolar

curl "https://api.smsmobileapi.com/deletesms/?apikey=YOUR_API_KEY&guid_message=MESSAGE_GUID"

Exemplo de resposta

JSON

{
  "result": {
    "error": null,
    "count_delete": 1
  }
}

Deseja executar esta solicitação?Conecte sua chave de API na parte superior da página para desbloquear o interativo testador.

Chave de conexão ↑

É bom saber

Isso exclui apenas as entradas de log do servidor. Ele não exclui mensagens armazenadas no dispositivo móvel.
Trate esta operação como destrutiva e verifique os filtros antes de chamá-la.

PEGAR

Listar conversas por SMS

ENDPOINThttps://api.smsmobileapi.com/conversation/sms/list/

Agrupa mensagens recebidas e enviadas em conversas por número de telefone.

Quando usá-lo

Use-o para visualizações de bate-papo, widgets de conversas recentes e cronogramas de suporte.

Parâmetros

Nome	Tipo	Requisito	Descrição
`apikey`	corda	Obrigatório	Chave de API da sua conta.
`origineConversation`	received \| sent	Obrigatório	Conjunto de dados usado para identificar as conversas iniciais.
`numero`	telefone	Opcional	Retorna uma conversa de número de telefone.
`date_from`	data ou datahora	Opcional	Início do intervalo de mensagens.
`date_to`	data ou datahora	Opcional	Fim do intervalo de mensagens. intervalo de mensagens.
`sort`	ASC \| DESC	Opcional	Ordem da conversa; DESC padrão.
`limit`	inteiro	Opcional	Limite de conversação quando numero é omitido; padrão 20.
`resume`	0 \| 1	Opcional	Defina como 1 para retornar apenas as mensagens mais recentes por conversa.
`resume_line_how`	inteiro	Opcional	Número de mensagens por conversa quando retomada=1.

Exemplo de solicitação

enrolar

curl "https://api.smsmobileapi.com/conversation/sms/list/?apikey=YOUR_API_KEY&origineConversation=received&resume=1&resume_line_how=3"

Exemplo de resposta

JSON

{
  "success": true,
  "origineConversation": "received",
  "conversations": [{
    "phone_number": "+15551234567",
    "contact_alias": "John Doe",
    "messages": [{
      "direction": "incoming",
      "message_id": "msg_1001",
      "timestamp_utc": "2026-03-13T08:45:12Z",
      "message": "I need more information.",
      "status": "received",
      "mobile_sid": "device_sid_1"
    }]
  }]
}

Deseja executar esta solicitação?Conecte sua chave de API na parte superior da página para desbloquear o interativo testador.

Chave de conexão ↑

PEGAR

Lista de celulares conectados

ENDPOINThttps://api.smsmobileapi.com/gateway/mobile/list/

Lista os telefones conectados à conta de gateway de SMS.

Quando usá-lo

Use-o para selecionar um remetente, exibir o status do dispositivo ou auditar uma frota de gateway.

Parâmetros

Nome	Tipo	Requisito	Descrição
`apikey`	corda	Obrigatório	Chave de API da sua conta.
`sid`	corda	Opcional	Retornar um SID móvel exato.
`search`	corda	Opcional	Pesquisar SID, data, bateria, versão, etiqueta e campos relacionados.

Exemplo de solicitação

enrolar

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

Deseja executar esta solicitação?Conecte sua chave de API na parte superior da página para desbloquear o interativo testador.

Chave de conexão ↑

POST · GET

Atualizar um celular conectado

ENDPOINThttps://api.smsmobileapi.com/gateway/mobile/update/

Atualiza a etiqueta legível por humanos ou o número de telefone de um dispositivo conectado.

Quando usá-lo

Use-o para manter os rótulos dos dispositivos significativos em instalações com vários telefones.

Parâmetros

Nome	Tipo	Requisito	Descrição
`apikey`	corda	Obrigatório	Chave de API da sua conta.
`sid`	corda	Obrigatório	O SID do dispositivo.
`label`	corda	Obrigatório	Novo rótulo; ele pode estar intencionalmente vazio.
`phone_number`	telefone	Opcional	Novos metadados de número de telefone.

Exemplo de solicitação

enrolar

curl "https://api.smsmobileapi.com/gateway/mobile/update/?apikey=YOUR_API_KEY&sid=DEVICE_SID&label=OfficePhone"

Deseja executar esta solicitação?Conecte sua chave de API na parte superior da página para desbloquear o interativo testador.

Chave de conexão ↑

POST · GET

Excluir um dispositivo móvel conectado

ENDPOINThttps://api.smsmobileapi.com/gateway/mobile/delete/

Remove um celular conectado e suas linhas de histórico de gateway.

Quando usá-lo

Use apenas quando um telefone precisar ser removido permanentemente da conta.

Parâmetros

Nome	Tipo	Requisito	Descrição
`apikey`	corda	Obrigatório	Chave de API da sua conta.
`sid`	corda	Obrigatório	SID do dispositivo para remover.

Exemplo de solicitação

enrolar

curl "https://api.smsmobileapi.com/gateway/mobile/delete/?apikey=YOUR_API_KEY&sid=DEVICE_SID"

Deseja executar esta solicitação?Conecte sua chave de API na parte superior da página para desbloquear o interativo testador.

Chave de conexão ↑

É bom saber

Esta operação remove o histórico do dispositivo associado ao SID. Confirme o dispositivo antes de ligar para ele.

INBOUND POST

Receber SMS por webhook

DESTINOYour HTTPS endpoint

SMSMobileAPI envia uma solicitação JSON para seu URL configurado sempre que um SMS é recebido.

Quando usá-lo

Use webhooks para processamento em tempo real em vez de processamento frequente. polling.

Exemplo de receptor

PHP 8

<?php
$payload = json_decode(file_get_contents('php://input'), true);
if (!is_array($payload) || empty($payload['guid'])) {
    http_response_code(400);
    exit('Invalid payload');
}
// Queue the event, then acknowledge quickly.
http_response_code(200);
echo 'OK';

Exemplo de resposta

JSON

{
  "date": "2026-03-20",
  "hour": "10:15:00",
  "time_received": "2026-03-20 10:14:50",
  "message": "Hello, this is a test.",
  "number": "+123456789",
  "guid": "abcde12345"
}

Endpoint de entrada

Este endpoint recebe eventos em seu próprio URL HTTPS. Use o exemplo de receptor acima e envie um SMS para seu telefone conectado para testá-lo.

É bom saber

Configure o URL HTTPS público em Painel → Configurações do Webhook.
Retorne HTTP 200 rapidamente e processe o evento de forma assíncrona.
Desduplicar novas tentativas usando guid.

Solução de problemas

Erros e novas tentativas seguras

Leia o status HTTP e o campo de erro JSON antes de tentar novamente. Não tente novamente falhas de validação ou autenticação sem primeiro corrigir a solicitação.

HTTP	Código	O que fazer
400	`missing_parameter`	Um parâmetro obrigatório está vazio ou ausente. Verifique a tabela de parâmetros do endpoint.
403	`invalid_apikey`	A chave de API é desconhecida, expirou ou não está autorizada para o recurso solicitado.
429	`too_many_requests`	As solicitações estão chegando muito rapidamente. Aguarde e tente novamente com espera exponencial.
500	`server_error`	O serviço não pôde concluir a solicitação. Mantenha a resposta e entre em contato com o suporte se ela persistir.

Regra de nova tentativaTente novamente apenas respostas transitórias 429 e 5xx. Comece após 1 segundo e depois volte para 2, 4 e 8 segundos.

Precisar de ajuda?

Traga o contexto da solicitação, não seus segredos.

Compartilhe o endpoint, o carimbo de data/hora, o status HTTP e a resposta limpa. Nunca inclua chaves de API, tokens ou conteúdo de mensagens privadas.

Entre em contato com o suporte da API →