API de listagem de grupos de consultores para discador automático

A API de listagem de grupos de consultores para discador automático deve ser utilizada para retornar a lista de grupos de consultores e seus respectivos IDs (códigos) para viabilizar a integração com discadores automáticos e plataformas de omnichannel.


Os grupos de consultores são importantes porque a estratégia de acionamentos (filtragem de devedores para geração da lista de contatos) é feita individualmente para cada grupo de consultor cadastrado. Nas plataformas de discagem automática, o grupo de consultores é semelhante a uma equipe ou uma campanha.


Endpoint: https://app.recuperador.com.br/api/v1DiscadorGrupo/?id_grupoconsultor=XXX

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

{

   id_grupoconsultor: int

}


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

  • ID do grupo de consultores: aceita apenas valores inteiros e é obrigatório. Ele deve ser preenchido com o código do grupo de consultores desejado que aparece em Cadastros > Consultores > Grupos. Informe 0 (zero) caso queira trazer todos os grupos de consultores cadastrados.


Lista de retorno

[

   {
   id_grupoconsultor: string,
   nome: string
   }

]