API de listagem de follow-ups
A API de consulta de follow-ups deve ser utilizada para retornar a lista de ocorrências (histórico de negociações) no Recuperador CRM. É importante destacar que essa API pode retornar um grande volume de linhas. Portanto, use os parâmetros para filtrar corretamente os dados a serem retornados.
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.
Parâmetros de entrada
{
id_credor: int, cpf_cnpj_formatado: string, id_consultor: int, id_evento: int, reagendar: string, datagte: string, datalte: string
}
Seguem informações complementares sobre cada parâmetro de entrada:
- ID do credor: aceita apenas valores inteiros e é obrigatório. Ele deve ser preenchido com o código do credor que aparece em Cadastros > Credores.
- CPF/CNPJ do devedor: aceita no máximo de 18 caracteres e é obrigatório. Somente números preferencialmente.
- ID do consultor: aceita apenas valores inteiros e não é obrigatório. Ele deve ser preenchido com o código do consultor que aparece em Cadastros > Consultores.
- ID do evento: aceita apenas valores inteiros e não é obrigatório. Ele deve ser preenchido com o código do evento que aparece em Financeiro > Negociações > Eventos.
- Reagendar: aceita no máximo um caractere e não é obrigatório. Ele deve ser preenchido com S (maiúsculo) para filtrar apenas reagendamentos ou N (maiúsculo) para não exibir reagendamentos. Deixe em branco para desconsiderar o filtro pelo reagendamento;
- Data de: filtro pela data do follow-up (maior ou igual) e não é obrigatório. A data deve ser preenchida no formato aaaa-mm-dd;
- Data até: filtro pela data do follow-up (menor ou igual) e não é obrigatório. A data deve ser preenchida no formato aaaa-mm-dd;
Lista de retorno
[
{ int id_followup, int id_credor, int id_cliente, int? id_consultor, int? id_evento, string nome_credor, string nome_cliente, string cpf_cnpj, string nome_consultor, string nome_evento, string tipo_evento, DateTime data, string interacao, string tipo_contato, string reagendar, DateTime? data_reagendamento, TimeSpan? horario_reagendamento, string reagendar_para, string visivel_cliente, string reagendado_por }
]
Seguem informações complementares sobre cada coluna da lista de retorno:
- ID do follow-up retornará um valor inteiro que representa o identificador do follow-up.
- ID credor: retornará um inteiro que representa o código do credor.
- ID cliente: retornará um inteiro que representa o código do cliente (devedor).
- ID consultor: retornará um inteiro que representa o código do consultor (operador).
- ID evento: retornará um inteiro que representa o código do evento definido no follow-up.
- Nome credor: retornará uma string que representa o nome do credor.
- Nome cliente: retornará uma string que representa o nome do cliente (devedor).
- CPF/CNPJ: retornará uma string que representa o CPF ou CNPJ do devedor.
- Nome consultor: retornará uma string que representa o nome do consultor (operador).
- Nome evento: retornará uma string que representa o nome do evento definido no follow-up.
- Tipo do evento: retornará P para evento produtivo ou I para evento improdutivo.
- Data: retornará uma string que representa a data de registro do follow-up. Ela estará no formato YYYY-MM-DDT00:00:00.
- Interação: retornará o conteúdo do follow-up formato string.
- Tipo de contato: retornará um caractere que representa o meio de comunicação utilizado no follow-up: Atendimento Presencial = A, E-mail = E, Notificação automática (Recuperador) = R, SMS = S, Telefonema = T, Telegram = G, WhatsApp = W, Outros = O.
- Reagendar: retornará S para reagendamento sim ou N para reagendamento não.
- Data do reagendamento: retornará uma string que representa a data de reagendamento do follow-up. Ela estará no formato YYYY-MM-DDT00:00:00.
- Horário do reagendamento: retornará uma string que representa o horário do reagendamento. Ela estará no formato hh:mm:ss.
- Reagendar para: retornará C para reagendamento para o consultor, G para reagendamento para o grupo de consultores ou O para reagendamento para outro consultor.
- Visível para cliente: retorna S para visível sim ou N para não visível para o cliente;
- Reagendado por: retorna uma string com o login do responsável pelo reagendamento.