A lista dos tipos de tarefa de contato disponíveis para a assessoria pode ser obtida através do método Ações API - Listar ações de cobrança e, por poder retornar múltiplos registros, é importante observar as questões relativas à Paginação ao fazer chamadas a este método.
Conforme consta na documentação deste método, estão disponíveis parâmetros de entrada que podem ser informados na chamada do método para restringir a lista de tipos de tarefa de contato retornados. O parâmetro nome pode ser utilizado para pesquisar tipos de tarefa de contato cujo nome inicie com um determinado conteúdo e também para pesquisar tipos de tarefa de contato específicos através do nome completo.
Os tipos de tarefa de contato são retornados com o id que, por sua vez, é utilizado para identificar o tipo de tarefa ao incluir novas tarefas de contato, conforme descrito em Incluindo as Tarefas de Contato. Os tipos de tarefa de contato também são retornados com o nome que descreve o tipo de tarefa e com o tipo (ASSESSORIA, CAMPANHA, CARTA, CONTATO, EMAIL, SERASA, SMS e SPC). No entanto, apenas os tipos de tarefa de contato do tipo CONTATO estão disponíveis e são retornados para as assessorias.
Também está disponível o método Ações API - Buscar ação de cobrança que retorna as informações de apenas um tipo de tarefa de contato específico, cuja identificação (id) deve ser informada na URL de chamada do método.
Se a assessoria não possuir permissão para obter um tipo de tarefa de contato específico, um código de erro 400 (Tratamento de Erros) é retornado com a mensagem "Você não tem permissão para visualizar essa ação".
Exemplos de chamadas e de retornos destes métodos constam no arquivo Assessorias - Ações API.postman_collection.json, disponível como anexo em Integrando Assessorias através da API do CobranSaaS.
0 Comentários