[v1.0] Documentação API - Developers
|
|
|
|
|
Sobre: Altera o status de uma Campanha.
|
|
|
|
|
|
|
| REQUIRED STRING | idCampanha | Identificador da Campanha. Pode ser passado o Nome(Identificador textual) ou C digo(Identificador N merico) |
| | REQUIRED INTEGER | status | Opera o a ser Realizada. 1-\"Exclui\", exclui a campanha. N o pode ser desfeito. 1-\"Ativa\", inicia o discador para a lista ativa. 3 - \"Suspende\", para a discagem temporariamente. 4 - \"Cancela\", cancela a lista atual. N o pode ser reativada. |
|
|
|
|
|
|
|
|
Sobre: Apresenta as chamadas em curso na central atualizadas em tempo real.
|
|
|
|
|
|
|
ESTE M TODO N O POSSUI NENHUM PARAMETRO DE ENTRADA! | |
|
|
|
|
|
|
|
Sobre: Apresenta informa es de uma chamda atrav s do protocolo Algar
|
|
|
|
|
|
|
| REQUIRED STRING | ProtocoloAlgar | Protocolo de chamada Algar Telecom |
|
|
|
|
|
|
|
|
Sobre: Autentica um usu rio na Requisi o!
|
|
|
|
|
|
|
| REQUIRED STRING | login | Login do usu rio |
| | REQUIRED STRING | senha | Senha do usu rio |
|
|
|
|
|
|
|
|
Sobre: Bloqueia o recebimento de chamadas pela Fila(Dac), mas permite que o agente fa a liga oes. Utilize o parametro disponivel_atendimento retornado em InformacoesAtendimento para controlar o status.
Obs: necess rio ter autenticado("ConectaAgente(...)") o agente e informar o "SIPID" na url.
|
|
|
|
|
|
|
| REQUIRED STRING | dac | Identifica o da(s) Fila(s) a ser(em) monitorada(s). |
|
|
|
|
|
|
|
|
Sobre: Coloca o agente em pausa.
Obs: necess rio ter autenticado("ConectaAgente(...)") o agente e informar o "SIPID" na url.
|
|
|
|
|
|
|
| OPCIONAL STRING | codMotivo | Indica o motivo da pausa |
|
|
|
|
|
|
|
|
Sobre: Conecta um agente a um DAC.
|
|
|
|
|
|
|
| REQUIRED STRING | dac | Dac em que o agente vai logar. |
| | OPCIONAL STRING | nomeDac | Nome do Dac em que o agente vai logar. |
| | REQUIRED INTEIRO | matriculaAgente | Matr cula do Agente. |
| | OPCIONAL STRING | apelidoAgente | Login do Agente |
| | REQUIRED STRING | ramal | Ramal em que o agente esta logado |
| | REQUIRED STRING | tipoAtende | Tipo de Atendimento, possui 2(dois) valores v lidos. **50 Manual e **60 Autom tico |
|
|
|
|
|
|
|
|
Sobre: Desconecta o agente.
Obs: necess rio ter autenticado("ConectaAgente(...)") o agente e informar o "SIPID" na url.
|
|
|
|
|
|
|
ESTE M TODO N O POSSUI NENHUM PARAMETRO DE ENTRADA! | |
|
|
|
|
|
|
|
Sobre: Desliga chamada corrente.
|
|
|
|
|
|
|
ESTE M TODO N O POSSUI NENHUM PARAMETRO DE ENTRADA! | |
|
|
|
|
|
|
|
Sobre: Disca para o n mero informado, necess io passar o Ramal de Origem
|
|
|
|
|
|
|
| REQUIRED INTEIRO | numeroDiscar | N mero de telefone/ramal a discar. |
| | REQUIRED INTEIRO | ramal | N mero de um ramal com permiss o para discagem, n o precisa estar registrado. |
|
|
|
|
|
|
|
|
Sobre: Disca para o n mero informado, necess io passar o Ramal de Origem
|
|
|
|
|
|
|
| REQUIRED INTEIRO | numeroDiscar | N mero de telefone/ramal a discar. |
| | REQUIRED INTEIRO | ramal | N mero do Ramal de Origem. |
|
|
|
|
|
|
|
|
Sobre: Disca para o n mero informado, necess rio passar o Ramal de Origem
|
|
|
|
|
|
|
| REQUIRED INTEIRO | numeroDiscar | N mero de telefone/ramal a discar. |
| | REQUIRED INTEIRO | ramal | N mero do Ramal de Origem ou N mero Fixo/Celular. |
|
|
|
|
|
|
|
|
Sobre: Disca para o n mero informado.
Obs: necess rio ter autenticado("ConectaAgente(...)") o agente e informar o "SIPID" na url.
|
|
|
|
|
|
|
| REQUIRED INTEIRO | numeroDiscar | N mero de telefone |
|
|
|
|
|
|
|
|
Sobre: Disca para um conjunto de ramais est ticos na fila
|
|
|
|
|
|
|
| REQUIRED INTEIRO | numeroDiscar | N mero da fila. |
| | REQUIRED INTEIRO | ramal | N mero de um ramal com permiss o para discagem, n o precisa estar registrado. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| REQUIRED TEXTO | TroncoSainte | Tronco de sa da. |
| | REQUIRED INTEGER | NumeroDestino | N mero do destino. |
| | REQUIRED TEXTO | Texto | Mensagem a ser enviada. |
| | REQUIRED TEXTO | login | Login. |
| | REQUIRED TEXTO | senha | Senha. |
|
|
|
|
|
|
|
|
Sobre: Finaliza a grava o da chamada.
|
|
|
|
|
|
|
ESTE M TODO N O POSSUI NENHUM PARAMETRO DE ENTRADA! | |
|
|
|
|
|
|
|
Sobre: Finaliza o mute durante uma chamada.
|
|
|
|
|
|
|
ESTE M TODO N O POSSUI NENHUM PARAMETRO DE ENTRADA! | |
|
|
|
|
|
|
|
Sobre: Finaliza o p ndulo durante uma chamada.
|
|
|
|
|
|
|
ESTE M TODO N O POSSUI NENHUM PARAMETRO DE ENTRADA! | |
|
|
|
|
|
GET
|
FinalizaTransferenciaConsulta
|
|
|
Sobre: Finaliza uma transferencia com consulta.
|
|
|
|
|
|
|
ESTE M TODO N O POSSUI NENHUM PARAMETRO DE ENTRADA! | |
|
|
|
|
|
|
|
Sobre: Indica que um contato dever ser incluido novamente na campanha para rediscagem!.
Obs: necess rio ter autenticado("ConectaAgente(...)") o agente e informar o "SIPID" na url.
|
|
|
|
|
|
|
| REQUIRED STRING | identificador | Identificador do Cliente no Sistema de Cobran a! |
|
|
|
|
|
|
|
|
Sobre: Informa es sobre o servidor de socket.
|
|
|
|
|
|
|
ESTE M TODO N O POSSUI NENHUM PARAMETRO DE ENTRADA! | |
|
|
|
|
|
|
|
Sobre: Inicia a grava o da chamada corrente ao comando do agente.
|
|
|
|
|
|
|
| OPCIONAL STRING | nomeArquivo | Um nome nico para o arquivo. Se n o informado ser gerado pelo sistema. |
| | OPCIONAL STRING | tipoArquivo | O formato desejado para o udio. O valor padr o wav49. Tipos suportados:[gsm,wav,wav49] |
|
|
|
|
|
|
|
|
Sobre: Inicia uma confer ncia a tr s.
|
|
|
|
|
|
|
ESTE M TODO N O POSSUI NENHUM PARAMETRO DE ENTRADA! | |
|
|
|
|
|
GET
|
IniciaTransferenciaConsulta
|
|
|
Sobre: Inicia uma transferencia com consulta.
|
|
|
|
|
|
|
| REQUIRED STRING | numeroTransferencia | N mero para o qual ser realizada a transfer ncia |
|
|
|
|
|
|
|
|
Sobre: Inicializa o mute durante uma chamada.
|
|
|
|
|
|
|
ESTE M TODO N O POSSUI NENHUM PARAMETRO DE ENTRADA! | |
|
|
|
|
|
|
|
Sobre: Inicializa o p ndulo durante uma chamada.
|
|
|
|
|
|
|
ESTE M TODO N O POSSUI NENHUM PARAMETRO DE ENTRADA! | |
|
|
|
|
|
|
|
Sobre: Libera o agente do discador.
|
|
|
|
|
|
|
ESTE M TODO N O POSSUI NENHUM PARAMETRO DE ENTRADA! | |
|
|
|
|
|
GET
|
ListaCampanhaContatos
|
|
|
Sobre: Lista campanhas / contatos com paginação e resumo
|
|
|
|
|
|
|
| OPCIONAL INTEGER | cmp_id | ID da campanha (detalhes) |
| | OPCIONAL VARCHAR | campanha | Filtro nome campanha |
| | OPCIONAL DATE | data_inicio | YYYY-MM-DD |
| | OPCIONAL DATE | data_fim | YYYY-MM-DD |
| | OPCIONAL CHAR | somente_campanhas | S = listar somente campanhas |
| | OPCIONAL INTEGER | page | Página |
| | OPCIONAL INTEGER | limit | Qtd registros por página |
| | OPCIONAL INTEGER | id_dac | ID da fila/DAC para filtrar campanhas |
| | OPCIONAL CHAR | somente_filas | S = listar somente as filas/DACs ativas |
| | OPCIONAL CHAR | somente_listas | S = listar somente as listas/reciclagens de uma campanha (requer cmp_id) |
| | OPCIONAL INTEGER | list_id | ID da lista para filtrar contatos (reciclagem) |
| | OPCIONAL CHAR | resumo_lista | S = retornar resumo estatÃstico de classificações da lista (requer cmp_id e list_id) |
| | OPCIONAL VARCHAR | busca | Filtro por nome do contato (ILIKE) |
|
|
|
|
|
|
GET
|
ListaChamadasTelefone
|
|
|
Sobre: Lista chamadas para telefones com status de atendimento (S/N)
|
|
|
|
|
|
|
| OPCIONAL VARCHAR | ramal | Filtrar por ramal de origem |
| | OPCIONAL DATE | data_inicio | Data inÃcio (YYYY-MM-DD). Padrão: hoje |
| | OPCIONAL DATE | data_fim | Data fim (YYYY-MM-DD). Padrão: hoje |
| | OPCIONAL INT | limite | Máximo de registros retornados. Padrão: 150. Máx: 500 |
|
|
|
|
|
|
|
|
Sobre: Lista os ramais o seus respctivos status.
|
|
|
|
|
|
|
| REQUIRED INTEGER | filtro | Filtro por Status 0-Inativos 1-Ativos 2-Ambos |
|
|
|
|
|
|
|
|
Sobre: Lista os ramais o seus respctivos status.
|
|
|
|
|
|
|
| REQUIRED INTEGER | ramal | Ramal a ser monitorado. |
|
|
|
|
|
|
|
|
Sobre: Lista todas as chamadas abandonadas em tempo real da fila informada.
|
|
|
|
|
|
|
| REQUIRED STRING | DAC | Informe um DAC a ser monitorado. |
|
|
|
|
|
|
|
|
Sobre: Monitora o progresso da Campanha.
|
|
|
|
|
|
|
| REQUIRED STRING | idCampanha | Identificador da Campanha. Pode ser passado o Nome(Identificador textual) ou C digo(Identificador N merico). |
|
|
|
|
|
|
GET
|
InvalidaNumeroCampanha
|
|
|
Sobre: Monitora o progresso da Campanha.
|
|
|
|
|
|
|
| REQUIRED STRING | idCampanha | Identificador da Campanha. Pode ser passado o Nome(Identificador textual) ou C digo(Identificador N merico). |
| | REQUIRED STRING | idLista | Identificador da Lista. Pode ser passado o Nome(Identificador textual) ou C digo(Identificador N merico). |
| | REQUIRED STRING | idCliente | Identificador da cliente. Conforme enviado na lista. |
| | REQUIRED STRING | telefone | Identificador da Campanha. Pode ser passado o Nome(Identificador textual) ou C digo(Identificador N merico) |
|
|
|
|
|
|
|
|
Sobre: Passe o identificador recebido pela API InfoChamadaAlgar ou o Protocolo Algar para receber todos os udios em um arquivo zip.
|
|
|
|
|
|
|
| REQUIRED STRING | idAudio | Identificador do udio no sistema. |
|
|
|
|
|
|
|
|
Sobre: Permite interagir com agente durante o atendimento.
|
|
|
|
|
|
|
| REQUIRED STRING | fila | Nome da fila em que o agente esta logado. |
| | REQUIRED STRING | matriculaAgente | Matricula do agente logado. |
| | REQUIRED STRING | ramalAgente | Ramal do agente logado. |
| | REQUIRED STRING | ramalIntercalar | Ramal usado para interagir durante o atendimento. |
|
|
|
|
|
|
|
|
Sobre: Permite o gerenciamento da agenda do SimplesIP.
|
|
|
|
|
|
|
| REQUIRED INTEGER | telefone | Telefone/Ramal do contato |
| | REQUIRED STRING | acao | Acao a ser desempenhada pela API. As opera es padr o s o: BUSCAR, INSERIR, EDITAR, EXCLUIR |
| | REQUIRED STRING | identificacao | Nome/Empresa do contato. |
| | REQUIRED STRING | DDD | DDD da localiza o do contato. |
| | OPCIONAL STRING | teloriginal | Telefone original do contato. Somente utilizado na a o EDITAR. |
| | OPCIONAL STRING | departamento | Indica qual departamento o usu rio ser inserido. Somente utilizado na a o INSERIR. |
|
|
|
|
|
|
|
|
Sobre: Permite recuperar o udio de um atendimento.
|
|
|
|
|
|
|
| REQUIRED STRING | uniqueid | Identificador da chamada retornada por InformacoesAtendimento. Obs.: Retorna o arquivo ou mensagem em xml! |
| | OPCIONAL STRING | tipo | O formato desejado para o udio. O valor padr o wav. Tipos suportados: [wav, mp3] |
|
|
|
|
|
|
|
|
Sobre: Recebe arquivo com informa es de Campanha para discagem autom tica.
|
|
|
|
|
|
|
| REQUIRED FILE | arquivoCampanha | Arquivo de Campanha. Cont m informa es da campanha e lista para discagem.  |
|
|
|
|
|
|
|
|
Sobre: Retira o agente da pausa.
Obs: necess rio ter autenticado("ConectaAgente(...)") o agente e informar o "SIPID" na url.
|
|
|
|
|
|
|
ESTE M TODO N O POSSUI NENHUM PARAMETRO DE ENTRADA! | |
|
|
|
|
|
|
|
Sobre: Retorna lista das chamadas \"Entrantes/Saintes\" por per odo.
|
|
|
|
|
|
|
| REQUIRED DATETIME | dataInicial | Informe um valor no formato: ddmmaaaa. |
| | REQUIRED DATETIME | dataFinal | Informe um valor no formato: ddmmaaa |
|
|
|
|
|
|
|
|
Sobre: Retorna as informa es do agente logado pela matricula.
|
|
|
|
|
|
|
| REQUIRED STRING | matricula | Retorna informa es sobre o agente on-line. |
|
|
|
|
|
|
|
|
Sobre: Retorna as informa es sobre uma chamada em espec fico.
|
|
|
|
|
|
|
| REQUIRED STRING | uniqueid | Uniqueid da chamada que deseja visualizar as informa es.. |
| | REQUIRED INTEIRO | dac | Id da fila que deseja a consulta. |
|
|
|
|
|
|
|
|
Sobre: Retorna chamadas de um ramal ou todos os ramais em determinado perÃodo
|
|
|
|
|
|
|
| OPCIONAL STRING | ramal | Ramal de origem (opcional) |
| | REQUIRED STRING | data_inicio | Data inicial YYYY-MM-DD |
| | REQUIRED STRING | data_fim | Data final YYYY-MM-DD |
|
|
|
|
|
|
|
|
Sobre: Retorna com os n meros a serem incluidos no N o Perturbe Anatel.
|
|
|
|
|
|
|
| REQUIRED INTEIRO | idCliente | Id do cliente atualizado. |
| | REQUIRED INTEIRO | npId | Id da lista atualizada. |
|
|
|
|
|
|
|
|
Sobre: Retorna com os n meros a serem incluidos no N o Perturbe Anatel.
|
|
|
|
|
|
|
| REQUIRED INTEIRO | info | Informe 1 para obterinforma es do arquivo e 0 para download. |
| | REQUIRED INTEIRO | id | Quando "info = 1" passe o c digo do cliente(emp_id), quando "info = 0" passe o id do arquivo(np_id). |
|
|
|
|
|
|
|
|
Sobre: Retorna dados das Pesquisas de satisfa o por per odo.
|
|
|
|
|
|
|
| REQUIRED STRING | dac | Informe o Nome do DAC. |
| | OPCIONAL INTEGER | pesquisa | Informe o Nome da Pesquisa! |
| | REQUIRED DATETIME | dataInicial | Informe um valor no Formato: ddmmaaaa. |
| | REQUIRED DATETIME | dataFinal | Informe um valor no formato: ddmmaaa. |
|
|
|
|
|
|
|
|
Sobre: Retorna informa es de origem/destino da chamada de acordo com o per odo e o telefone.
|
|
|
|
|
|
|
| REQUIRED DATETIME | dataInicial | Informe um valor no formato: ddmmaaaa. |
| | REQUIRED DATETIME | dataFinal | Informe um valor no formato: ddmmaaa |
| | REQUIRED STRING | telefone | Informe um telefone |
|
|
|
|
|
|
|
|
Sobre: Retorna informa es de origem/destino das chamadas de acordo com o per odo.
|
|
|
|
|
|
|
| REQUIRED DATETIME | dataInicial | Informe um valor no formato: ddmmaaaa. |
| | REQUIRED DATETIME | dataFinal | Informe um valor no formato: ddmmaaa |
|
|
|
|
|
|
GET
|
InformacoesAgentesGeral
|
|
|
Sobre: Retorna informa es de todos os agentes logados nas filas
|
|
|
|
|
|
|
ESTE M TODO N O POSSUI NENHUM PARAMETRO DE ENTRADA! | |
|
|
|
|
|
|
|
Sobre: Retorna informa es sobre \"Agentes/Dac\" por per odo!
|
|
|
|
|
|
|
| REQUIRED STRING | destino | N mero do telefone de destino com DDD. |
|
|
|
|
|
|
|
|
Sobre: Retorna informa es sobre \"Agentes/Dac\" por per odo!
|
|
|
|
|
|
|
| REQUIRED DATETIME | dataInicial | Informe um valor no Formato: ddmmaaaa. |
| | REQUIRED DATETIME | dataFinal | Informe um valor no formato: ddmmaaa. |
| | REQUIRED INTEIRO | dac | N mero da "Fila(DAC)" usada para atendimento. |
|
|
|
|
|
|
GET
|
InformacoesSupervisor
|
|
|
Sobre: Retorna informa es sobre a Fila(DAC) Informada.
|
|
|
|
|
|
|
| REQUIRED STRING | dac | Identifica o da Fila a ser monitorada. |
|
|
|
|
|
|
|
|
Sobre: Retorna informa es sobre a produtividade da(s) Fila(s)(DAC) Informada(s).
|
|
|
|
|
|
|
| REQUIRED STRING | dac | Identifica o da(s) Fila(s) a ser(em) monitorada(s). |
|
|
|
|
|
|
GET
|
InformacoesAtendimento
|
|
|
Sobre: Retorna informa es sobre atendimento.
Obs: necess rio ter autenticado("ConectaAgente(...)") o agente e informar o "SIPID" na url.
|
|
|
|
|
|
|
ESTE M TODO N O POSSUI NENHUM PARAMETRO DE ENTRADA! | |
|
|
|
|
|
|
|
Sobre: Retorna lista com motivos de pausa.
|
|
|
|
|
|
|
ESTE M TODO N O POSSUI NENHUM PARAMETRO DE ENTRADA! | |
|
|
|
|
|
|
|
Sobre: Retorna lista das chamadas Entrantes/Saintes por per odo.
|
|
|
|
|
|
|
| REQUIRED DATETIME | dataInicial | Informe um valor no formato: ddmmaaaa. |
| | REQUIRED DATETIME | dataFinal | Informe um valor no formato: ddmmaaa. |
|
|
|
|
|
|
|
|
Sobre: Retorna lista das chamadas \"Entrantes/Saintes\" por per odo.
|
|
|
|
|
|
|
| REQUIRED DATETIME | dataInicial | Informe um valor no formato: ddmmaaa |
| | REQUIRED DATETIME | dataFinal | Informe um valor no formato: ddmmaaa |
| | REQUIRED INTEIRO | dac | Informe o c digo do DAC ou 0 para todos. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
ESTE M TODO N O POSSUI NENHUM PARAMETRO DE ENTRADA! | |
|
|
|
|
|
|
|
Sobre: Retorna para o n mero informado, necess rio passar o Ramal de Origem
|
|
|
|
|
|
|
| REQUIRED INTEIRO | numeroDiscar | N mero de telefone/ramal a discar. |
| | REQUIRED INTEIRO | ramal | N mero do Ramal de Origem. |
| | REQUIRED STRING | destino | Destino para qual a liga o vai ser enviada. |
|
|
|
|
|
|
|
|
Sobre: Retorna para o n mero informado.
|
|
|
|
|
|
|
| REQUIRED INTEIRO | numeroDiscar | N mero de telefone com DDD. |
|
|
|
|
|
|
|
|
Sobre: Retorna uma lista com os Agentes Dispon veis!
|
|
|
|
|
|
|
ESTE M TODO N O POSSUI NENHUM PARAMETRO DE ENTRADA! | |
|
|
|
|
|
|
|
Sobre: Retorna uma lista com os DACS dispon veis para o Agente Autenticado!
|
|
|
|
|
|
|
| REQUIRED STRING | agente | Agente autenticado no Sistema. |
|
|
|
|
|
|
|
|
Sobre: Retorna uma lista com os DACS dispon veis para o Agente Autenticado!
|
|
|
|
|
|
|
| REQUIRED STRING | matricula | Matr cula de um agente. |
|
|
|
|
|
|
|
|
Sobre: Retorna uma lista com os Dacs dispon veis.
|
|
|
|
|
|
|
ESTE M TODO N O POSSUI NENHUM PARAMETRO DE ENTRADA! | |
|
|
|
|
|
GET
|
ListaAbandonadasPeriodo
|
|
|
Sobre: Retorna uma listagem das chamadas abandonadas por per odo.
|
|
|
|
|
|
|
| REQUIRED DATETIME | dataInicial | Informe um valor no formato: ddmmaaaa. |
| | REQUIRED DATETIME | dataFinal | Informe um valor no formato: ddmmaaa |
| | REQUIRED STRING | DAC | Informe a fila que gostaria de consultar |
|
|
|
|
|
|
|
|
Sobre: Tarifa o dos Ramais por periodo! Idenficadores de Registro: [ # - Tarifa Zero ] [ ** - Franquia ] [ * - Franquia Parcial]
|
|
|
|
|
|
|
| REQUIRED DATETIME | dataInicial | Informe um valor no Formato: ddmmaaaa. |
| | REQUIRED DATETIME | dataFinal | Informe um valor no formato: ddmmaaa. |
|
|
|
|
|
|
|
|
Sobre: Tarifa o dos Ramais por periodo! Idenficadores de Registro: [ # - Tarifa Zero ] [ ** - Franquia ] [ * - Franquia Parcial]
|
|
|
|
|
|
|
| REQUIRED DATETIME | dataInicial | Informe um valor no Formato: ddmmaaaa. |
| | REQUIRED DATETIME | dataFinal | Informe um valor no formato: ddmmaaa. |
|
|
|
|
|
|
|
|
Sobre: Transfere a liga o corrente para o n mero informado.
Obs: necess rio ter autenticado("ConectaAgente(...)") o agente e informar o "SIPID" na url.
|
|
|
|
|
|
|
| REQUIRED INTEIRO | numeroDiscar | N mero de telefone. |
|
|
|
|
|
|
|
|
Sobre: Transfere uma chamada para uma pesquisa cadastrada no sistema!
|
|
|
|
|
|
|
| REQUIRED STRING | matricula | Matr cula de um agente. |
| | REQUIRED INTEGER | pesquisaId | Informe o id da pesquisa. |
|
|
|
|
|
|
|
|
Sobre: Verifica se o ramal est cadastrado na base de dados.
|
|
|
|
|
|
|
| REQUIRED INTEIRO | ramal | N mero do ramal para atendimento no dac. |
|
|
|
|
|
|