SMS - Respostas

Endpoint

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

Parâmetros

{
    "start_date": "2021-01-01",
    "end_date": "2021-01-02"
}
Campo Obrigatório Descrição
start_date Sim Data inicial para busca de mensagens respondidas
end_date Sim Data final para busca de mensagens respondidas

Sucesso

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

{
    "status": "success",
    "message": "Responses successfully retrieved.",
    "responses": [
        {
            "original": "Mensagem de SMS original",
            "phone": "+5521992394998",
            "response": "Resposta recebida",
            "received_at": "2021-01-01T00:00:00.130000Z"
        }
    ]
}
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
original Mensagem de SMS original que foi respondida (se disponível, caso contrário retorna null)
phone Telefone do usuário que recebeu e respondeu o SMS
response Conteúdo da mensagem de resposta
received_at Data e hora em que a resposta foi recebida

Erro

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

{
    "status": "error",
    "message": "Responses successfully retrieved."
}

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)
429 Muitas requisições, é necessário aguardar alguns segundos para tentar novamente
499 Saldo insuficiente para enviar mensagem
500 Erro de servidor, caso receba este erro, por favor entre em contato com a equipe de suporte

Demo