A resposta curta: a API é REST, fala JSON e só funciona por HTTPS, em https://api.mozout.com/v1. Crie uma chave na página API do My MozOut com a permissão sms:write, teste na Sandbox (nada é enviado nem cobrado) e, quando funcionar, troque-a por uma chave de Produção: o endereço e as operações são os mesmos.
A API num minuto
É uma só API para toda a conta, com 147 operações em 12 áreas; o SMS é uma delas. Cada pedido leva a chave no cabeçalho Authorization: Bearer <chave>. Se a palavra API ainda lhe soa estranha, comece por o que é uma API, em palavras simples.
Criar a chave
| 1 |
No My MozOut, abra a página API e crie uma chave. Pode ter até 20 por conta, por exemplo uma para cada aplicação.
|
|
| 2 |
Escolha as permissões por área, com leitura e escrita separadas. No SMS: sms:read para consultar (saldo, mensagens, remetentes) e sms:write para enviar. Dê só o que a aplicação precisa.
|
|
| 3 |
Escolha a validade: 30, 90 ou 365 dias, ou sem validade. Pode juntar um limite de gastos e uma lista de IPs autorizados.
|
|
| 4 |
Confirme com a sua senha e com o código de 6 dígitos que enviamos por e-mail. A chave aparece uma vez só: copie-a logo para um lugar seguro no servidor.
|
|
Sandbox e Produção
|
Sandbox |
Produção |
| A chave começa por |
sandbox_ |
prod_ |
| Endereço e operações |
Os mesmos |
Os mesmos |
| O SMS |
É validado, mas não sai |
É enviado |
| Créditos |
Não são cobrados |
Descontados no saldo de SMS |
| Na resposta |
"status": "simulated" e X-API-Simulated: true |
O estado real da mensagem |
O primeiro pedido
curl https://api.mozout.com/v1/sms/messages \
-H "Authorization: Bearer sandbox_..." \
-H "Content-Type: application/json" \
-H "Idempotency-Key: 7d4f2b1e-9c3a-4e8f-b6d2-1a5c3e9f0b7d" \
-d '{"number": "+258841234567", "text": "A sua encomenda está pronta."}'
Se tudo estiver certo, recebe 201 com estes campos:
| Campo |
O que diz |
| id |
O identificador da mensagem, para a consultar depois |
| status |
O estado da mensagem (na Sandbox, simulated) |
| parts |
Em quantas partes a mensagem foi dividida |
| encoding |
O alfabeto usado: o normal ou Unicode, se o texto tem acentos fora dele |
| credits |
Os créditos gastos (1 por parte) |
O campo sender é opcional: sem ele, o SMS sai pelo remetente grátis NETMSG; com ele, use um nome já aprovado, como explicamos em o que é o Sender ID. Os números escrevem-se com ou sem o indicativo, porque o sistema reconhece o país pelo primeiro algarismo: 841234567 vai para Moçambique e 923456789 para Angola. Assim, +258 84 123 4567 e 258841234567 são o mesmo número que 841234567.
As operações de SMS
| Operação |
Para quê |
| POST /v1/sms/messages |
Enviar um SMS (number, text e, se quiser, sender) |
| GET /v1/sms/messages/{id} |
Ver uma mensagem e o seu estado |
| GET /v1/sms/messages |
Listar as mensagens |
| GET /v1/sms/balance |
Saldo em créditos, daily_limit e sent_today |
| GET /v1/sms/senders |
Os remetentes: o grátis primeiro e os seus, com o estado (approved, pending, in_review, rejected) |
| POST /v1/sms/senders |
Pedir um remetente |
| GET e POST /v1/sms/templates |
Ver e criar modelos |
| GET /v1/sms/stats |
Estatísticas de envio |
| GET e POST /v1/sms/opt-outs |
A lista de números da sua conta que não recebem SMS |
Cabeçalhos e parâmetros úteis
| Nome |
Para quê |
| Idempotency-Key |
Repetir um pedido com segurança: a mesma chave com o mesmo corpo devolve a mesma resposta; com outro corpo, dá 409 |
| X-RateLimit-Limit, X-RateLimit-Remaining |
O limite de 300 pedidos por minuto, por conta, e quantos ainda restam |
| Accept-Language |
Mensagens da API em português ou em inglês |
| X-Correlation-ID |
Vem em cada resposta; indique-o ao suporte quando pedir ajuda |
| page, per_page |
Paginação das listas, até 100 por página |
|
Pronto para ligar o seu sistema ao SMS? Veja a página da API e crie a primeira chave Sandbox.
Ver a página da API
|
PRODUTO RECOMENDADO Alojamento de sites com cPanel Domínio e SSL incluídos, cópias diárias e o painel que já conhece. desde 5,94 €/mês (plano de 3 anos, com cupão) Ver planos |
Angola
Brasil
Kenya
Moçambique
Nigeria
Portugal
South Africa
United Kingdom
United States
International
