API de SMS para Programadores | MozOut - Moçambique

O primeiro SMS em minutos

Comece com uma chave de Sandbox, que valida os pedidos sem enviar nada nem gastar créditos. Quando estiver pronto, troque pela chave de Produção.

  1. Crie uma chave sandbox_ no API Center do My MozOut, com a permissão sms:write.
  2. Envie o pedido POST /v1/sms/messages com o número e o texto.
  3. Passe para Produção com a chave prod_. O pedido não muda.
curl https://api.mozout.com/v1/sms/messages \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: order-4521-ready" \
  -d '{"number": "+258841234567",
       "text": "Your order 4521 is ready for pickup."}'

Do seu sistema ao telemóvel do cliente

Um pedido HTTPS basta. A API valida, desconta os créditos e entrega a mensagem às operadoras; o seu sistema acompanha o estado.

  1. O seu sistema

    Uma encomenda, uma fatura ou uma marcação dispara o pedido.

  2. A nossa API

    Valida a chave, o número e o saldo, e responde em JSON.

  3. As operadoras

    A mensagem segue com o seu Sender ID ou com o NETMSG.

  4. O cliente

    Recebe o SMS em Moçambique e Angola, em qualquer telemóvel.

Os estados de uma mensagem:

  • scheduled
  • queued
  • sending
  • sent
  • failed
  • cancelled
  • simulated

26 operações, arrumadas por área

Todas começam em https://api.mozout.com, com a chave no cabeçalho Authorization: Bearer. A lista completa, com os campos e as respostas, está na documentação.

  • Mensagens

    • POST/v1/sms/messages
    • GET/v1/sms/messages
    • GET/v1/sms/messages/{id}
    • POST/v1/sms/messages/{id}/cancel
  • Conta

    • GET/v1/sms/balance
    • GET/v1/sms/stats
  • Modelos

    • GET/v1/sms/templates
    • POST/v1/sms/templates
    • GET/v1/sms/templates/{id}
    • PATCH/v1/sms/templates/{id}
    • DELETE/v1/sms/templates/{id}
  • Contactos e grupos

    • GET/v1/sms/contacts
    • POST/v1/sms/contacts
    • PATCH/v1/sms/contacts/{id}
    • GET/v1/sms/groups
    • POST/v1/sms/groups
    • DELETE/v1/sms/groups/{id}
  • Remetentes

    • GET/v1/sms/senders
    • POST/v1/sms/senders
    • GET/v1/sms/senders/{sender}
  • Exclusão e verificação

    • GET/v1/sms/opt-outs
    • POST/v1/sms/opt-outs
    • POST/v1/sms/otp
    • POST/v1/sms/otp/{id}/verify

SMS automáticos para o seu negócio

Quando alguma coisa acontece no seu sistema, o cliente recebe logo um SMS. Ninguém tem de se lembrar de avisar.

Sandbox ou Produção: carregue e compare

As duas chaves usam o mesmo endereço e as mesmas operações. A diferença está no que acontece ao enviar.

Prefixo da chave
sandbox_
O SMS sai?
Não: o pedido é validado e a resposta vem completa, com simulated: true.
Créditos
Nenhum é gasto.
Cabeçalho X-API-Mode
sandbox
Para que serve
Desenvolver e testar sem risco.

Chaves seguras, regras à sua medida

Cada chave tem as suas permissões e pode ser revogada a qualquer momento. Os pedidos seguem sempre por HTTPS.

  • Permissões separadas

    sms:read para consultar e sms:write para enviar e alterar.

  • Lista de IPs

    Opcional: a chave só funciona a partir dos endereços que indicar.

  • Validade e revogação

    30, 90 ou 365 dias, ou sem validade. Revogue quando quiser.

  • Repetições seguras

    Com Idempotency-Key, o mesmo pedido repetido nunca envia duas vezes.

  • Limites à vista

    90 pedidos por minuto por chave e 300 por conta, nos cabeçalhos X-RateLimit.

  • Números mascarados

    As respostas mostram o número como 25884****567, para não ficar nos registos.

Preços do SMS, sem pacotes

Os SMS enviados pela API usam o mesmo saldo de créditos do SMS Center. O preço do escalão vale para toda a quantidade que comprar.

  • Até 1.0001,00 MT
  • 1.001 a 5.0000,90 MT
  • 5.001 a 10.0000,85 MT
  • 10.001 a 25.0000,75 MT
  • 25.001 a 50.0000,70 MT
  • 50.001 a 100.0000,60 MT
  • Mais de 100.0000,55 MT

Mínimo de 1.000 créditos. 1 SMS até 160 caracteres = 1 crédito. Sender ID: 3.000,00 MT por nome e por país.

F.A.Q API de SMS

MozOut

As perguntas mais frequentes sobre o envio de SMS pela API

Uma conta com o SMS activo, créditos de SMS e uma chave API com a permissão sms:write. A chave cria-se no API Center do My MozOut. Para testar, basta uma chave de Sandbox, sem créditos.

A resposta do envio já traz o estado: sent, queued ou failed. Depois, consulte GET /v1/sms/messages/{id} ou o histórico. Os estados possíveis são agendada, na fila, a enviar, enviada, simulada, falhada e cancelada.

Sim. Indique no campo sender um Sender ID aprovado. Pode pedi-lo pela API ou no My MozOut: custa 3.000,00 MT por nome e por país, e a análise leva até 48 horas úteis. Sem sender, sai o NETMSG, grátis.

Não. Os remetentes com nome, incluindo o NETMSG, não recebem respostas. Se precisar que o cliente fale consigo, escreva na mensagem um telefone, um e-mail ou o endereço do seu site.

Em qualquer linguagem que faça pedidos HTTPS: PHP, Python, JavaScript, Java, C# e outras. A documentação tem exemplos em cURL, PHP, Python e JavaScript, e um Playground para experimentar.

É um código à sua escolha que envia no cabeçalho do pedido. Se a ligação cair e o seu sistema repetir o mesmo pedido com o mesmo código, a API devolve a primeira resposta e o SMS não sai duas vezes.

Até 90 pedidos por minuto por chave e 300 por conta, somando todas as chaves. Os cabeçalhos X-RateLimit-Limit e X-RateLimit-Remaining dizem quantos restam. Se passar o limite, a API responde 429 com o tempo de espera.

São descontados do mesmo saldo de créditos do SMS Center. Cada parte de SMS gasta um crédito: até 160 caracteres é uma parte, ou até 70 com letras como ã ou ç. Num envio agendado, os créditos só saem quando a mensagem sair.

OFERTA Relâmpago

Hospedagem de Sites + Domínio GRÁTIS **

:
:
:
Fique Online!
keyboard_arrow_up Arraste para cima
Logo MozOut

OFERTA Premium

Hospedagem de Sites + Domínio GRÁTIS**

A oferta termina em:
:
:
:
Fique Online!
Fechar