Email - Saldo

Endpoint

Método Rota
GET /api/email/balance

Parâmetros

Esta rota não requer nenhum parâmetro adicional.

Sucesso

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

{
    "status": "success",
    "message": "Balance retrieved succesfully.",
    "balance": 100
}
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
balance Saldo de mensagens do usuário, caso o aplicativo estiver rodando em modo ilimitado, irá retornar 999999

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
500 Erro de servidor, caso receba este erro, por favor entre em contato com a equipe de suporte

Demo