A resposta curta: os textos dos avisos não precisam de estar escritos no código. Pela API, POST /v1/sms/templates guarda um texto como modelo, PATCH /v1/sms/templates/{id} altera-o e GET /v1/sms/templates/{id} lê-o. São os mesmos modelos da página de SMS do My MozOut: quem trata da comunicação muda a frase lá, e o seu sistema passa a enviar a frase nova sem ninguém mexer no código.
As operações
| Operação |
Para que serve |
Permissão |
| GET /v1/sms/templates |
Lista os modelos da conta. |
sms:read |
| GET /v1/sms/templates/{id} |
Mostra um modelo. |
sms:read |
| POST /v1/sms/templates |
Cria um modelo. |
sms:write |
| PATCH /v1/sms/templates/{id} |
Altera um modelo. |
sms:write |
| DELETE /v1/sms/templates/{id} |
Apaga um modelo. |
sms:write |
|
Um modelo não envia nada. Serve só para guardar o texto. O envio continua a ser POST /v1/sms/messages, com o texto já pronto no campo text.
|
As variáveis que um modelo aceita
Pela API, o texto de um modelo aceita as variáveis de quem envia: {$client_name}, {$client_first_name}, {$client_last_name}, {$client_company_name}, {$remetente} e {$data}. Outra variável faz a API responder 422. Os dados do evento (o número da encomenda, o valor, a hora) não são variáveis da API: é o seu sistema que os põe no texto.
Uma forma simples de trabalhar
| 1 |
Crie um modelo por evento (pagamento recebido, encomenda enviada, marcação confirmada) e guarde o id de cada um na configuração do seu sistema.
|
|
| 2 |
Marque no texto os sítios dos dados do evento com algo que o seu sistema reconheça e troque, por exemplo [N. PEDIDO].
|
|
| 3 |
No momento do evento, o sistema lê o modelo (ou usa uma cópia guardada há pouco), troca as marcas pelos dados e envia com POST /v1/sms/messages.
|
|
| 4 |
Antes de enviar, confirma que não ficou nenhuma marca por trocar. Se ficou, não envia e avisa alguém: um SMS com [N. PEDIDO] à vista parece descuido.
|
|
Os modelos contam para o mesmo limite da conta que os da página de SMS, até 100. Um modelo apagado não volta, por isso o seu sistema deve saber o que fazer se o id deixar de existir: usar um texto de reserva e avisar a equipa.
|
Ler o modelo a cada SMS gasta pedidos. Guarde uma cópia por alguns minutos e leia de novo depois. Assim, uma alteração feita no My MozOut chega ao sistema depressa, sem gastar o limite de pedidos.
|
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
