API de régua de cobrança para discador automático

A API de listagem de régua de cobrança para discador automático deve ser utilizada para retornar a lista de mensagens e seus respectivos tipos da régua de cobrança de uma data para viabilizar a integração com discadores automáticos e plataformas de omnichannel.

A régua de cobrança permite a configuração de condições de disparo, mensagens e escolha de meios de comunicação. Exemplo: é possível criar uma mensagem de e-mail com variáveis (dados do devedor, da dívida etc) para ser disparado para devedores com dívidas atrasadas há 5 dias.

Dessa forma, este endpoint permitirá verificar todas as mensagens de régua de cobrança a serem enviadas na data e permitirá que uma plataforma de omnichannel por exemplo, faça tais disparos.

Endpoint: https://app.recuperador.com.br/api/v1DiscadorRegua/?dataeq=YYYY-MM-DD

Ação: GET

Formato: JSON

Autenticação: enviar o token da API no campo username da autenticação Basic Auth. Deixe o campo password em branco.

Importante: por questões de segurança, este token será diferente do token utilizado em outras APIs, pois será consumido pela equipe da empresa de telecom. Logo, este token não permitirá acesso a outros endpoints. O token para discador deverá ser gerado na tela User > Perfil > API > Gerar novo token para discador.

Parâmetros de entrada

{

   dataeq: date

}

Seguem informações complementares sobre cada parâmetro de entrada:

• Data: data no formato americano (YYYY-MM-DD) e é obrigatória. Ela é usada para filtrar as mensagens que devem ser disparadas naquela data.

Lista de retorno

[

   {
       id_credor: int,
       nome_credor: string,
       contatos_devedor: {
           id_credor: int,
           id_cliente: int,
           nome: string,
           email: string,
           email2: string,
           email3: string,
           email4: string,
           telefone: string,
           telefone2: string,
           telefone3: string,
           telefone4: string,
           telefone5: string,
           telefone6: string,
           telefone7: string,
           telefone8: string
       },
       data: date,
       titulo: string,
       mensagem_sms: string,
       mensagem_apiwhatsapp: string,
       whatsappapi_template_nome: string,
       receber_notificacao_sistema: string,
       destino: string,
       contatos_responsavel: object,
       nome_evento: string
   }

]

Observações: a coluna destino retornará D ou R, sendo D para devedor e R para responsável. Quando o destino for o próprio devedor, então o objeto contatos_devedor apresentará informações de contato deste devedor e o objeto contatos_responsavel será nulo. E vice-versa, ou seja, quando o destino for o responsável, o objeto contatos_devedor ficará nulo e o objeto contatos_responsável conterá os dados de contato do responsável pelo devedor (fiador, responsável financeiro etc).