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.
Português
English
sandbox_ no API Center do Meu Interweb, com a permissão sms:write.POST /v1/sms/messages com o número e o texto.prod_. O pedido não muda.curl https://api.interweb.co.mz/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.interweb.co.mz/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.interweb.co.mz/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.interweb.co.mz/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
Um pedido HTTPS basta. A API valida, desconta os créditos e entrega a mensagem às operadoras; o seu sistema acompanha o estado.
Uma encomenda, uma fatura ou uma marcação dispara o pedido.
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 telemóvel.
Os estados de uma mensagem:
scheduledqueuedsendingsentfailedcancelledsimulated
Todas começam em https://api.interweb.co.mz, com a chave no cabeçalho Authorization: Bearer. A lista completa, com os campos e as respostas, está na documentação.
Quando um pagamento entra, uma encomenda sai ou uma transferência é feita, o cliente recebe logo a confirmação. Ninguém tem de se lembrar de avisar.
Envie o recibo quando o pagamento entra e avise quando uma fatura é emitida ou está a vencer.
Confirme cada pagamento e transferência no momento em que acontece, no balcão, no site ou na aplicação.
Avise que a encomenda saiu, que o serviço terminou ou que está tudo pronto a levantar.
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. Os pedidos 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 indicar.
30, 90 ou 365 dias, ou sem validade. Revogue quando quiser.
Com Idempotency-Key, o mesmo pedido repetido nunca envia duas vezes.
Registe um endereço HTTPS e receba um aviso assinado quando cada SMS é enviado ou falha.
As respostas mostram o número como 25884****567, para não ficar nos registos.
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.
Mínimo de 1.000 créditos. 1 SMS até 160 caracteres = 1 crédito. Sender ID: 4.500,00 MT por nome e por país.
Exemplos de SMS transaccionais por sector. O telemóvel mostra como chegam ao cliente.
Transferencia de 5.000 MT para conta ***4521 concluida em 13/11 as 10:42. Nao foi o senhor? Ligue 21 000 000.
Envie no instante da operação.Pedido N. 8812 confirmado. Vai receber outro SMS quando sair para entrega.
Depois do pagamento.A apolice AU-2231 foi renovada ate 13/11/2027. O recibo esta no seu e-mail.
Na renovação.
Os cuidados que fazem a diferença quando o SMS passa a ser parte do seu sistema.
Idempotency-Key e repetir com o mesmo valor.Retry-After quando a resposta for 429.prod_ no código ou no repositório.Idempotency-Key: o cliente recebe duas vezes.422: dizem qual o campo errado.
Tudo o que precisa para integrar, com exemplos em cURL, PHP, Python e Node.js.
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 SMS transaccional 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 Meu Interweb. 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 Meu Interweb: custa 4.500,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.
Sim. Esta página tem exemplos em cURL, PHP, Python e Node.js, e a documentação tem exemplos para cada operação e um Playground.
Registe um webhook: enviamos um aviso assinado para o seu endereço HTTPS quando cada mensagem é enviada ou falha, e tentamos de novo se o servidor não responder.
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.
Sim. POST /v1/sms/messages/batch recebe muitas mensagens num só pedido, cada uma com o seu número e, se quiser, o seu texto.
Sim. Com uma chave de Sandbox o pedido é validado e a resposta vem completa, mas nenhum SMS sai e nada se cobra.
Obtenha a Hospedagem Rápida e Segura da Interweb com um Domínio GRÁTIS!
