O parceiro, conhecido como Integrador, fornece o envio de \"eventos\" para o lifecycle da ligação e libera acesso a uma API para interação com o sistema ERPVoalle.
\nPara obter o Token desta integração, o cliente deverá acessara rotina \"Configurações / Parâmetros\" menu \"PBX\" em \"Token de Integração\".
\nEvento responsável por buscar informações do cliente através de um telefone (callerid), CPF, CNPJ ou ID do contrato (codigo) no ERPVoalle.
\nObservação:
\nA API por padrão irá retornar apenas clientes que possuem contratos Ativos no ERP. Para que seja identificado ex clientes, que tiveram contratos cancelados ou encerrados, deve ser marcado o parâmetro relativo a essa ação na rotina Configurações / Parâmetros, menu PBX, funcionando apenas para o integrador Default.
\nPara que retorne valores na data_send_billets e data_send)billets all deve ser parametrizado um modelo de e-mail para 2ª via no ERP através da rotina Suíte / Configurações / Parâmetros menu PBX em Configurações para atendimento na URA
\nEvento chamado quando a ligação estiver pronta para ser atendida pelo ramal.
\nRecomenda-se que a requisição CONNECT seja enviada de 03 a 10 segundos antes do ramal tocar.
\nÉ gerado um evento de push notification para o atendente no ERPVoalle, mostrando o cliente identificado no CLIENT_VALIDATE.
\nAtendente precisa de um ramal atribuído ao seu usuário.
\nEvento chamado ao encerrar uma ligação, tanto recebida quanto realizada pelo atendente. O encerramento pode ocorrer de várias formas, como:
\nAo receber o evento, o ERPVoalle guarda o status da ligação e o URL do áudio, caso a chamada tenha sido atendida.
\n","urlObject":{"path":["pbx","pbx","events","{{integrator}}","COMPLETE"],"host":["{{url_do_ERP}}"],"query":[],"variable":[]}},"response":[{"id":"63358409-4df9-47f9-83ec-1112057df71f","name":"COMPLETE","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ramal\": \"1\", //Código do ramal onde está sendo atendido\n \"callid\": \"1\", //Código único da ligação\n \"callerid\": \"xxxxxxxxxxx\", //Número do telefone\n \"dialstatus\": \"ANSWER\", //Recebe os valores a seguir: ANSWER, CANCEL, BUSY, NOANSWER, CHANUNAVAIL\n \"link\": \"000.0.0.0/call/1\", //Caminho para o áudio da gravação da conversa telefônica.\n \"token\": \"000000-00000000-0000000-00000000\" //Token disponibilizado pelo cliente obtido rotina \"Configurações / Parâmetros\" menu \"PBX\" em \"Token de Integração\"\n}","options":{"raw":{"language":"json"}}},"url":"https://erp.cliente.com.br/pbx/pbx/events/new/COMPLETE"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"finished\": true\n}\n"}],"_postman_id":"147d3def-05be-47d6-848d-3accdd2b1f0b"},{"name":"OPEN_PROTOCOL_AUTHENTICATION","id":"4b20bad8-dd25-4b6a-b00e-39d68f7add04","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data_open_protocol_authentication\": \"1\", \n \"token\": \"000000-00000000-0000000-00000000\" \n}"},"url":"{{url_do_ERP}}/pbx/pbx/events/{{integrator}}/OPEN_PROTOCOL_AUTHENTICATION","description":"Evento o qual realiza a abertura do protocolo referente a conexões que estão com o ponto de acesso em manutenção.
\nSomente poderá ser utilizado, caso seja recebido valor na variável \"data_open_protocol_authentication\" na chamada do CLIENT_VALIDATE.
\nA parametrização do tipo da solicitação utilizada para abertura do protocolo, é feita no momento em que incidente massivo é cadastrado na aba Manutenção.
\nEvento o qual realiza a abertura do protocolo referente a tentativa (SEM SUCESSO) de desbloqueio de contrato.
\nRealiza uma tentativa de desbloqueio por confiança em um contrato.
\nSomente poderá ser utilizado, caso seja recebido valor na variável can_unblock_contracts_id da chamada do CLIENT_VALIDATE.
\nA parametrização da quantidade de desbloqueio é realizada na rotina Suíte / Configurações / Parâmetros - Portal.
\nPara que seja registrado o protocolo de desbloqueio, deve ser parametrizado na rotina Suíte / Configurações / Parâmetros - Financeiro - Tipo de Solicitação Desbloqueio o tipo de solicitação desejada.
\nToken obtido pelo cliente na rotina \"Configurações / Parâmetros\" menu \"PBX\" em \"Token de Integração\"
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data_billets_from_contract\": \"xxxxx\",\n \"data_billets_filter\": false,\n \"get_all_billets\": false\n}","options":{"raw":{"language":"json"}}},"url":"{{url_do_ERP}}:443/api/api/events/get_billets_from_contract","description":"Evento responsável por buscar as informações dos títulos em aberto do cliente. Esta solicitação é feita através do número do contrato do cliente, obtido através CLIENT_VALIDATE.
\nOs boletos a serem retornados irão respeitar os seguintes filtros por padrão:
\nNão deletadas;
\nDefinitivos;
\nCom saldo;
\nNão perdidas (baixadas);
\nNão renegociadas;
\nPossuir nosso número;
\nTipo de cobrança seja Boleto.
\n->data_billets_from_contract: Número do contrato do cliente, obtido no método CLIENT_VALIDATE em CONTRATCS_ID ou dentro da CONTRACTS_INFO no campo ID;
\nSendo informado apenas este campo este método tem o seguinte comportamento:
\nSão retornados os títulos a vencer até o mês seguinte, caso este cliente não possua títulos vencidos.
\nPossuindo títulos vencidos, são retornados apenas estes títulos, independente da data de vencimento.
\n-> data_billets_filter: Caso for \"true\", ele verifica o parâmetro \"Boletos poderão ser visualizados quando\", na rotina Suíte / Configurações / Parâmetros menu Portal - Disponibilidade do Financeiro.
\n\"Contrato seja faturado\", é verificado se existe faturamento para o contrato.
\n\"Incluso em Remessa\", é verificado se o boleto possui registro em uma instituição financeira.
\n\"Boleto Seja Registrado\", é verificado se possui integração online com uma instituição financeira ou se possui registro com movimentação de crédito normal.
\n-> get_all_billets: Caso seja informado \"true\" são retornados todos os boletos do cliente (vencidos e a vencer), filtrados ou não de acordo com o parâmetro anterior.
\n","urlObject":{"port":"443","path":["api","api","events","get_billets_from_contract"],"host":["{{url_do_ERP}}"],"query":[],"variable":[]}},"response":[{"id":"816344fa-abc2-4b9e-8855-555792e326c0","name":"GET_BILLETS_FROM_CONTRACT","originalRequest":{"method":"POST","header":[{"key":"Authorization-Token","value":"","description":"Token obtido pelo cliente na rotina \"Configurações / Parâmetros\" menu \"PBX\" em \"Token de Integração\"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data_billets_from_contract\": \"123456\", //ID do contrato\n \"data_billets_filter\": false,\n \"get_all_billets\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://erp.cliente.com:443/api/api/events/get_billets_from_contract"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"title\": \"FAT123456789\",\n \"expiration_date\": \"2021-07-15\",\n \"parcel\": \"2\",\n \"typeful_line\": \"00000.00000 00000.000000 00000.000000 0 00\",\n \"balance\": \"00.00\",\n \"link\": \"https://portal.clt.com/financial_receivable_titles/boletos/a1b2c3\"\n },\n {\n \"title\": \"FAT987654321\",\n \"expiration_date\": \"2021-07-15\",\n \"parcel\": \"3\",\n \"typeful_line\": \"00000.00000 00000.000000 00000.000000 0 00\",\n \"balance\": \"00.00\",\n \"link\": \"https://portal.clt..com/financial_receivable_titles/boletos/a1b2c3\"\n }\n\n]"}],"_postman_id":"1e515115-d595-42d2-9538-03f709cd7fe6"},{"name":"SEND_BILLETS","id":"d066420a-c46a-4593-8f37-8c8ced19f696","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data_send_billets\": \"1234\", \n \"token\": \"000000-00000000-0000000-00000000\" \n}"},"url":"{{url_do_ERP}}/pbx/pbx/events/{{integrator}}/SEND_BILLETS","description":"Evento o qual realiza o envio dos boletos em atraso (caso existir).
\nOs métodos a seguir são disponibilizados para integração de serviços PABX/Omnichannel via API pelo ERPVoalle.
\nO parâmetro {{integrator}} na URL de chamada das API's deve ser substituído conforme o integrador selecionado na rotina Configurações / Parâmetros, menu PABX, campo Nome.
\nRelação Integrador e parâmetro da URL:
\nEx: parâmetro Nome definido como \"Default\"
/pbx/pbx/events/new/CLIENT_VALIDATE
Ex: parâmetro Nome definido como \"Native IP\"
/pbx/pbx/events/native/CLIENT_VALIDATE
Ex: parâmetro Nome definido como \"NeWave\"
/pbx/pbx/events/newave/CLIENT_VALIDATE
É realizado um POST para {URL_API}/login
\n","urlObject":{"path":["login"],"host":["{{URL_API_INTEGRADOR}}"],"query":[],"variable":[]}},"response":[{"id":"f4b80644-089f-4fcb-b210-b329f879eca7","name":"LOGIN","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"login\": \"\", // Usuário para o método login \n \"password\": \"\" // Senha para o método login\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_API_INTEGRADOR}}/login"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"token\": \"xxxxxxxxxxxxxxxxxxxxxxx\"\n}"}],"_postman_id":"398f88d8-d1a2-45fa-9e05-3ca6df8c7bd5"},{"name":"LISTAGEM_DE_RAMAIS","id":"321442bb-39a4-42c0-a9af-556f400db652","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-access-token","value":"","description":"Token informado na resposta o método LOGIN
\n","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"{{URL_API_INTEGRADOR}}/extension/all","description":"É realizado um GET para {URL_API}/extension/all para obter os ramais cadastrados no integrador.
\n","urlObject":{"path":["extension","all"],"host":["{{URL_API_INTEGRADOR}}"],"query":[],"variable":[]}},"response":[{"id":"3b9f00a9-a626-4b99-93de-20f052bd4486","name":"LISTAGEM_DE_RAMAIS","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-access-token","value":"","description":"Token informado na resposta o método LOGIN","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{URL_API_INTEGRADOR}}/extension/all"},"code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"extension\": \"1234\"\n },\n {\n \"extension\": \"4321\"\n },\n {\n \"extension\": \"4567\"\n },\n {\n \"extension\": \"6789\"\n } \n]"}],"_postman_id":"321442bb-39a4-42c0-a9af-556f400db652"},{"name":"PAUSA_DE_RAMAIS","id":"a6e5c04f-c001-416b-b9ea-1950d44059bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-access-token","value":"","description":"Token informado na resposta o método LOGIN
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"username\": \"\", // Ramal a ser pausado\n \"pause\": \"\" // true or false\n}\n\n","options":{"raw":{"language":"json"}}},"url":"{{URL_API_INTEGRADOR}}/api/public/pause","description":"Método não obrigatório. É realizado um POST para {URL_API}/api/public/pause ṕara realizar a pausa do ramal
\n","urlObject":{"path":["api","public","pause"],"host":["{{URL_API_INTEGRADOR}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a6e5c04f-c001-416b-b9ea-1950d44059bd"},{"name":"REALIZAR_LIGACAO","id":"778f7334-5529-4491-95d0-ee5eec97fcc2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-access-token","value":"","description":"Token informado na resposta o método LOGIN
\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{URL_API_INTEGRADOR}}/cdr/originate/{{NUMERO_LIGAÇÃO}}/ext_cli/{{RAMAL_ORIGEM}}","description":"Método utilizado quando o atendente realiza uma ligação.
\n","urlObject":{"path":["cdr","originate","{{NUMERO_LIGAÇÃO}}","ext_cli","{{RAMAL_ORIGEM}}"],"host":["{{URL_API_INTEGRADOR}}"],"query":[],"variable":[]}},"response":[{"id":"9212234c-a668-45ca-8262-d64335bd4766","name":"REALIZAR_LIGACAO","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-access-token","value":"","description":"Token informado na resposta o método LOGIN","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{URL_API_INTEGRADOR}}/cdr/originate/{{NUMERO_LIGAÇÃO}}/ext_cli/{{RAMAL_ORIGEM}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"CALLID\": \"123456789.123456\" //Id da ligação. Similar ao método CONNECT da API PBX da Voalle, porém o parâmetro CALLID deve ser maiúsculo\n}"}],"_postman_id":"778f7334-5529-4491-95d0-ee5eec97fcc2"}],"id":"d7cc02e4-2d5c-4747-bf27-a2238f704089","description":"Esses métodos serão disponibilizados pelo Integrador e consumidos pelo ERPVoalle quando é uma integração de PABX/URA.
\nEsses métodos não são necessários quando é uma integração somente de atendimento via chat (Omnichannel, WhatsApp, etc)
\n","_postman_id":"d7cc02e4-2d5c-4747-bf27-a2238f704089"}]}