As notificações de agendamento, são notificações disparadas todos os dias em torno das 9:00 AM, para notificar os sacados (pagadores) que os boletos emitidos contra eles estão preste a vencer ou já venceram, funcionando como um processo automatizado de notificações de cobrança.Estas notificações podem ser enviadas via E-mail ou SMS.
POST
Homologação:
https://homologacao.plugboleto.com.br/api/v1/notificacoes/agendamentos
Produção:
https://plugboleto.com.br/api/v1/notificacoes/agendamentos
Headers
| Nome | Descrição | Exemplo |
| Content-Type | Indica o tipo de arquivo | application/json |
| cnpj-cedente | CNPJ do Cedente | 01001001000113 |
| cnpj-sh | CNPJ da Software House | 01001001000113 |
| token-sh | Token da Software House | f22b97c0c9a3d41ac0a3875aba69e5aa |
Headers (Opcional)
Utilizar esses headers em caso de autenticação direto com as credenciais do cedente:
| Nome | Descrição | Exemplo |
| Content-Type | Indica o tipo de arquivo | application/json |
| cnpj-cedente | CNPJ do Cedente | 01001001000113 |
| token-cedente | Token do Cedente | f22b97c0c9a3d41ac0a3875aba69e5aa1 |
Objeto
Para o cadastro da notificação de agendamento o objeto JSON pode ter os seguintes campos:
| Campo | Tipo | Descrição |
| nome | String | O nome serve como uma descrição do agendamento, campo obrigatório. |
| tipo | String | Tipo da notificação, valores aceitos "email" ou "sms", campo obrigatório. |
| dias_para_vencer | Integer |
Quantidade de dias antes do vencimento ou a quantidade de dias após o vencimento, campo obrigatório. -1= Um dia antes do vencimento. 1 = Um dia após o vencimento. 0 = No dia do vencimento. |
| assunto | String | Campo livre para escrever o assunto do e-mail, campo obrigatório caso o tipo seja "email". |
| mensagem | String | Campo livre para escrever uma mensagem que será anexado no corpo do e-mail ou mensagem SMS, campo obrigatório. |
| html | Boolean | Campo para habilitar o envio do corpo do e-mail em formato HTML, campo opcional, valor padrão caso não informado é "false" |
| cco_email: | Objeto |
Nesse campo é informado os recepientes que receberam o e-mail como cópia oculta. Informa nesse formato: cco_email: {email: "teste@gmail.com"} |
| cco | Boolean | Campo para habilitar o envio de cópia oculta para os endereços informados no campo "cco_email" |
Body
Essa rota recebe no (body) da requisição o tipo de notificação, as configurações de agendamento.
Exemplo de JSON:
No exemplo logo abaixo está sendo cadastrado uma notificação de agendamento para um dia antes do vencimento do boleto, ser disparado um email alertando o sacado do vencimento
Mesmo agendamento porém informando o envio da cópia oculta
Agora nesse outro exemplo está sendo cadastrado uma notificação de agendamento via SMS para dois dias após o vencimento
Retorno
Exemplo de retorno:
{
"_status": "sucesso",
"_dados": {
"id": 174,
"id_cedente": 598,
"nome": "Uma dia após o vencimento",
"assunto": null,
"tipo": "sms",
"mensagem": "Olá seu boleto venceu ontem",
"html": false,
"dias_para_vencer": 2,
"protocolo": null,
"criado": "2020-04-15T19:46:41.000Z",
"atualizado": "2020-04-15T19:46:41.000Z",
"cco": false,
"cco_email": null
}
}
Exemplo de retorno com erro:
{
"_status": "erro",
"_mensagem": "Erro de validação.",
"_dados": [
{
"_campo": "Tipo e Dia",
"_erro": "Já existe uma notificação agendada com esta regra."
}
]
}
Comentários
0 comentário
Por favor, entre para comentar.