Documentação da API de Envio de SMS

Bem-vindo à documentação oficial da nossa API de Envio de SMS, que utiliza o protocolo SMPP (Short Message Peer-to-Peer) para fornecer uma solução robusta, confiável e escalável de envio de mensagens de texto. Nossa API foi projetada para facilitar a integração de sistemas e aplicativos, permitindo o envio de SMS de forma eficiente e com suporte para caracteres especiais.

1. Visão Geral do Serviço

Nosso serviço de envio de SMS via API permite que você integre a funcionalidade de envio de mensagens diretamente em seus sistemas, aplicativos móveis ou plataformas web. Com o uso do protocolo SMPP, garantimos alta performance, baixa latência e segurança nas transmissões de mensagens. O serviço é perfeito para empresas que precisam de uma solução confiável para enviar notificações, alertas, OTPs (códigos de verificação) e mensagens em massa.

2. Arquitetura e Conexão com o Servidor

A API se conecta a nossos servidores através do protocolo SMPP, amplamente utilizado para comunicação entre sistemas de envio de SMS. O SMPP permite comunicação de alta velocidade e baixa latência, essencial para empresas que precisam enviar grandes volumes de mensagens em tempo real.

Fluxo de Funcionamento:

• Estabelecimento da Conexão SMPP: Sua aplicação realiza a autenticação utilizando o username e password cadastrados no banco de dados.
• Envio da Solicitação de SMS: A mensagem é enviada para o nosso servidor através de um conjunto de parâmetros (detalhados abaixo).
• Roteamento e Entrega da Mensagem: A mensagem é roteada e entregue ao provedor de SMS adequado.
• Resposta de Status: Após a entrega, um status de resposta é enviado de volta para confirmar o sucesso ou falha do envio.

3. Parâmetros da API

A seguir estão os parâmetros que você usará para interagir com a nossa API de envio de SMS:

https://tacsms.co.ao/smshttpvpn/sendsms?username=USERNAME&password=PASSWORD&from=EMISSOR&to=123456789&text=OLÁ+MUNDO

• username (String): Nome de usuário cadastrado no banco de dados para autenticação. Exemplo: "usuario_tac"
• password (String): Senha correspondente ao nome de usuário para autenticação. Exemplo: "senha123"
• to (String): O número do destinatário já é validado no backend começando com +244. Logo, basta enviares o número sem a codificaçãoExemplo:912345678
• from (String): Número de telefone ou identificador alfanumérico de onde a mensagem será enviada. Exemplo: TAC_SMS
• message (String): O conteúdo da mensagem a ser enviada e deve respeitar o Limite de caracteres por mensagens (200 caracteres). Exemplo: "Olá! Seu código de verificação é 123456."
• coding (Integer): O tipo de codificação do texto. Valor padrão: 2 (UTF-16).

4. Resposta da API

Após a solicitação, nossa API retorna uma resposta via HTTP GET. O status do envio de SMS será informado diretamente na URL de resposta.

Estrutura de Resposta:

• status (String)
  • Descrição: O status da operação de envio de SMS. Pode ser:
  • Success: Mensagem enviada com sucesso.
  • Failed: Falha ao enviar a mensagem (detalhes adicionais podem ser fornecidos na resposta).
• message_id (String)
  • Descrição: Identificador único gerado para rastrear a mensagem.
  • Exemplo: "abc123456789"
• error_message (String, se falha)
  • Descrição: Mensagem de erro em caso de falha ao tentar enviar a mensagem.
  • Exemplo: "Número inválido ou formato incorreto"

5. Como Integrar com a Sua Aplicação

A integração com a API de envio de SMS é simples e direta, utilizando o método HTTP GET. Aqui está um guia rápido sobre como fazer isso:

Passo 1: Obtenção da Chave de Acesso
Primeiro, você precisa de um nome de nome de usuário e password para acessar a API. Esses dados são fornecidos ao registrar sua conta no sistema.

Passo 2: Enviar uma Solicitação de SMS
Você pode enviar SMS utilizando a URL de requisição descrita acima. A URL deve conter os parâmetros obrigatórios, incluindo:
username
password
from
to
text .

Exemplo de Requizição

https://tacsms.co.ao/smshttpvpn/sendsms?username=seu_usuario&password=sua_senha&from=TAC_SMS&to=912345678&text=Seu+Código+é+123456

Passo 3: Recebendo a Resposta
A API retornará uma resposta contendo o status do envio, o identificador da mensagem e, em caso de erro, uma mensagem descritiva.

6. Exemplos de Casos de Uso

Aqui estão alguns exemplos de como você pode utilizar a API de envio de SMS:

Caso de Uso 1: Envio de OTP (One Time Password)
Ideal para autenticação de usuários via SMS, a API permite o envio de códigos de verificação em tempo real.

Caso de Uso 2: Notificações e Alertas
Enviando notificações automáticas, lembretes ou alertas para seus clientes.

7. Conclusão

Nossa API de Envio de SMS via SMPP oferece uma solução simples e eficaz para integração de SMS em seus sistemas. Com suporte completo para caracteres especiais e alta confiabilidade, você pode facilmente enviar mensagens para seus usuários, seja para alertas, promoções ou verificações de segurança.

Benefícios:

• Alta taxa de entrega e velocidade.
• Suporte a caracteres especiais (UTF-16).
• Conexão segura via protocolo HTTPS.
• Suporte a envio em lote.
• Rastreamento de envio e entrega.
• Integração simples e direta.

Entre em contato com nossa equipe de suporte para mais informações sobre como integrar nossa API com seu sistema e começar a enviar SMS de forma rápida e eficiente.