Comece com uma chave de Sandbox, que valida as requisições sem enviar nada nem gastar créditos. Quando estiver pronto, troque pela chave de Produção.
Angola
Brasil
Kenya
Moçambique
Nigeria
Portugal
South Africa
United Kingdom
United States
International
sandbox_ no API Center do My MozOut, com a permissão sms:write.POST /v1/sms/messages com o número e o texto.prod_. A requisição 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."}'<?php
$ch = curl_init('https://api.mozout.com/v1/sms/messages');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer YOUR_API_KEY',
'Content-Type: application/json',
'Idempotency-Key: order-4521-ready',
],
CURLOPT_POSTFIELDS => json_encode([
'number' => '+258841234567',
'text' => 'Your order 4521 is ready for pickup.',
]),
]);
$sms = json_decode(curl_exec($ch), true);
echo $sms['data']['status']; // sent, queued or failedimport requests
r = requests.post(
"https://api.mozout.com/v1/sms/messages",
headers={"Authorization": "Bearer YOUR_API_KEY",
"Idempotency-Key": "order-4521-ready"},
json={"number": "+258841234567",
"text": "Your order 4521 is ready for pickup."},
timeout=30,
)
print(r.json()["data"]["status"]) # sent, queued or failedconst r = await fetch("https://api.mozout.com/v1/sms/messages", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_API_KEY",
"Content-Type": "application/json",
"Idempotency-Key": "order-4521-ready",
},
body: JSON.stringify({
number: "+258841234567",
text: "Your order 4521 is ready for pickup.",
}),
});
console.log((await r.json()).data.status); // sent, queued or failed
Uma requisição HTTPS basta. A API valida, desconta os créditos e entrega a mensagem às operadoras; o seu sistema acompanha o status.
Um pedido, uma fatura ou um agendamento dispara a requisição.
Valida a chave, o número e o saldo, e responde em JSON.
A mensagem segue com o seu Sender ID ou com o NETMSG.
Recebe o SMS em Moçambique e Angola, em qualquer celular.
Os status de uma mensagem:
scheduledqueuedsendingsentfailedcancelledsimulated
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.
Quando alguma coisa acontece no seu sistema, o cliente recebe um SMS na hora. Ninguém precisa se lembrar de avisar.
Avise quando uma fatura é emitida, quando vence ou quando o pedido sai para entrega.
Confirme o pagamento e o pedido assim que o cliente paga, no balcão ou no seu site.
Avise o cliente que o serviço terminou ou lembre a próxima revisão, sem telefonar.
As duas chaves usam o mesmo endereço e as mesmas operações. A diferença está no que acontece ao enviar.
sandbox_prod_simulated: true.sandboxproduction
Cada chave tem as suas permissões e pode ser revogada a qualquer momento. As requisições seguem sempre por HTTPS.
sms:read para consultar e sms:write para enviar e alterar.
Opcional: a chave só funciona a partir dos endereços que você indicar.
30, 90 ou 365 dias, ou sem validade. Revogue quando quiser.
Com Idempotency-Key, a mesma requisição repetida nunca envia duas vezes.
90 requisições por minuto por chave e 300 por conta, nos cabeçalhos X-RateLimit.
As respostas mostram o número como 25884****567, para não ficar nos registros.
Os SMS enviados pela API usam o mesmo saldo de créditos do SMS Center. O preço da faixa vale para toda a quantidade que você comprar.
Mínimo de 1.000 créditos. 1 SMS de até 160 caracteres = 1 crédito. Sender ID: R$ 275,00 por nome e por país.
Artigos para escolher, configurar e tirar o máximo deste serviço
A resposta curta: uma API é a forma combinada de um programa pedir coisas a outro. Em vez de uma pessoa abrir uma página e clicar, o seu site…
Ler o artigo
A resposta curta: se uma chave de API, um token ou o segredo de um webhook apareceu onde não devia (um repositório público, um ficheiro dentro do site, uma…
Ler o artigo
Para falar com uma API a partir do PHP usa-se o cURL: abre-se um pedido, envia-se, lê-se o código de estado (200, 401, 404…) e só depois se descodifica…
Ler o artigo
As perguntas mais frequentes sobre o envio de SMS pela API
Uma conta com o SMS ativo, créditos de SMS e uma chave API com a permissão sms:write. A chave é criada no API Center do My MozOut. Para testar, basta uma chave de Sandbox, sem créditos.
A resposta do envio já traz o status: sent, queued ou failed. Depois, consulte GET /v1/sms/messages/{id} ou o histórico. Os status possíveis são agendada, na fila, enviando, enviada, simulada, falhada e cancelada.
Sim. Informe no campo sender um Sender ID aprovado. Você pode pedi-lo pela API ou no My MozOut: custa R$ 275,00 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 com você, escreva na mensagem um telefone, um e-mail ou o endereço do seu site.
Em qualquer linguagem que faça requisições 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 você envia no cabeçalho da requisição. Se a conexão cair e o seu sistema repetir a mesma requisição com o mesmo código, a API devolve a primeira resposta e o SMS não sai duas vezes.
Até 90 requisições por minuto por chave e 300 por conta, somando todas as chaves. Os cabeçalhos X-RateLimit-Limit e X-RateLimit-Remaining dizem quantas restam. Se passar do 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 ç. Em um envio agendado, os créditos só saem quando a mensagem sair.
