Angola
Brasil
Kenya
Moçambique
Nigeria
Portugal
South Africa
United Kingdom
United States
International
A resposta curta: envie POST /v1/sms/messages/{id}/cancel com o id do SMS agendado, antes da hora marcada. Só se cancelam mensagens da própria conta que ainda estejam scheduled. Se os créditos já tinham sido descontados, voltam ao saldo.
O caso típico: o cliente pagou antes do lembrete
|
|
|
|
O mesmo serve para uma consulta remarcada, uma entrega que mudou de dia ou uma manutenção adiada: cancela o aviso antigo e agenda um novo. Como agendar: agendar avisos pela API.
As respostas possíveis
| Resposta | O que quer dizer |
| Sucesso | O SMS ficou cancelado. O campo credits_returned diz quantos créditos voltaram; como um agendado normalmente só é cobrado ao sair, muitas vezes é zero. |
| 409 com not_cancellable | Já não dá: a mensagem já saiu, está a sair ou já tinha sido cancelada. |
| 404 | Não há nenhuma mensagem com esse id nesta conta. |
| Não deixe o cancelamento para o último minuto. Quando chega a hora, a mensagem entra no envio e deixa de poder ser cancelada. Cancele logo que o motivo do aviso desaparece. |
Repetir sem medo
Envie o cabeçalho Idempotency-Key também no cancelamento: se a ligação falhar e o seu sistema repetir o pedido, recebe a mesma resposta. Com uma chave sandbox_, a API confere tudo e não muda nada, o que serve para testar o fluxo.
| Para confirmar o estado, consulte GET /v1/sms/messages/{id}: o estado diz se ficou cancelado, e o campo charged diz se os créditos chegaram a ser descontados. |
|
Quer avisos que se desmarcam sozinhos quando já não são precisos? Veja a página da API. 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 |
