SMS - Agendamento de Mensagens

Endpoint

Método Rota
POST /api/sms/message/schedule

Parâmetros

{
    "sender": "EasyChat",
    "send_at": "2022-01-01 00:00:00",
    "messages": [
        {
            "phone": "+5521992394998",
            "message": "Teste de agendamento de SMS EasyChat"
        }
    ]
}
Campo Obrigatório Descrição
sender Sim Nome ou identificador da aplicação que está enviando a mensagem
send_at Sim Data e hora (em UTC) que deseja que o envio seja feito
messages Sim Array de mensagens a serem agendadas (com telefone e conteúdo de cada mensagem individualmente)

Sucesso

{success} Caso a requisição seja bem sucedida, a resposta terá a seguinte estrutura:

{
    "status": "success",
    "message": "Message successfully scheduled."
}
Campo Descrição
status Em caso de sucesso, irá sempre retornar success
message Mensagem de confirmação de que a requisição foi bem sucedida

Erro

{danger} Caso apresente alguma falha na requisição, a resposta terá a seguinte estrutura:

{
    "status": "error",
    "message": "Error message goes here."
}

Possíveis respostas de erro com respectivos códigos:

Código Erro
403 Não autenticado
404 Não encontrado, verifique se está utilizando o método e a rota corretos
422 Dados inválidos (uma tag errors acompanhará a resposta, relacionando os erros encontrados)
500 Erro de servidor, caso receba este erro, por favor entre em contato com a equipe de suporte

Demo