|
|
| FUNÇÕES DISPONÍVEIS |
| Método |
Descrição |
| [ StatusCampanha ] |
| Descrição:[ Altera o status de uma "Campanha". ] |
| Parametro |
Tipo |
Descrição |
| idCampanha | string | [requerido]
Identificador da Campanha. Pode ser passado o "Nome(Identificador textual)" ou "Código(Identificador Númerico)"
| | status | inteiro | [requerido]
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. |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=StatusCampanha&idCampanha=1&status=1
&SIPID=kvckbni2asl6ojqqt3ljfotvf7&tipoRetorno=XML ] |
|
| [ MonitoraChamadas ] |
| Descrição:[ Apresenta as chamadas em curso na central atualizadas em tempo real. ] |
| Parametro |
Tipo |
Descrição |
| Método não possui parametros de entrada! |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=MonitoraChamadas&SIPID=kvckbni2asl6ojqqt3ljfotvf7
&tipoRetorno=XML ] |
|
| [ InfoChamadaAlgar ] |
| Descrição:[ Apresenta informações de uma chamda através do protocolo Algar ] |
| Parametro |
Tipo |
Descrição |
| ProtocoloAlgar | String | [requerido]
Protocolo de chamada Algar Telecom |
| Tipo Retorno: [text/json ] |
url: [ http://192.168.0.218/integracao?method=InfoChamadaAlgar&ProtocoloAlgar=7645272
&SIPID=kvckbni2asl6ojqqt3ljfotvf7&tipoRetorno=JSON ] |
|
| [ AutenticaUsuario ] |
| Descrição:[ Autentica um usuário no servidor! ] |
| Parametro |
Tipo |
Descrição |
| login | string | [requerido]
Login do usuário do servidor | | senha | string | [requerido]
Senha do usuário do servidor |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=AutenticaUsuario&login=admin&senha=0000
&tipoRetorno=XML ] |
|
| [ DisponivelFila ] |
Descrição:[ 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. ] |
| Parametro |
Tipo |
Descrição |
| Método não possui parametros de entrada! |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=DisponivelFila&SIPID=kvckbni2asl6ojqqt3ljfotvf7
&tipoRetorno=XML ] |
|
| [ EntradaPausa ] |
Descrição:[ Coloca o agente em pausa.
Obs: É necessário ter autenticado("ConectaAgente(...)") o agente e informar o "SIPID" na url. ] |
| Parametro |
Tipo |
Descrição |
| codMotivo | Inteiro | [requerido]
Indica o motivo da pausa |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=EntradaPausa&codMotivo=3&SIPID=kvckbni2asl6ojqqt3ljfotvf7
&tipoRetorno=XML ] |
|
| [ ConectaAgente ] |
| Descrição:[ Conecta um agente a um Dac ] |
| Parametro |
Tipo |
Descrição |
| dac | Inteiro | [requerido]
Dac em que o agente vai logar | | nomeDac | String | [opcional]
Nome do Dac em que o agente vai logar | | matriculaAgente | Inteiro | [requerido]
Matrícula do Agente | | apelidoAgente | String | [opcional]
Login do Agente | | ramal | Inteiro | [requerido]
Ramal em que o agente esta logado | | tipoAtende | String | [requerido]
Tipo de Atendimento, possui 2(dois) valores válidos
"**50 Manual" e "**60 Automático" |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=ConectaAgente&dac=3&nomeDac=discador
&matriculaAgente=1001&apelidoAgente=admin&ramal=6008&tipoAtende=**50&SIPID=kvckbni2asl6ojqqt3ljfotvf7
&tipoRetorno=XML ] |
|
| [ DesconectaAgente ] |
Descrição:[ Desconecta o agente.
Obs: É necessário ter autenticado("ConectaAgente(...)") o agente e informar o "SIPID" na url. ] |
| Parametro |
Tipo |
Descrição |
| Método não possui parametros de entrada! |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=DesconectaAgente&SIPID=kvckbni2asl6ojqqt3ljfotvf7
&tipoRetorno=XML ] |
|
| [ DesligarChamada ] |
| Descrição:[ Desliga chamada corrente. ] |
| Parametro |
Tipo |
Descrição |
| Método não possui parametros de entrada! |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=DesligarChamada&SIPID=kvckbni2asl6ojqqt3ljfotvf7
&tipoRetorno=XML ] |
|
| [ LiberaAgente ] |
| Descrição:[ Desliga chamada corrente. ] |
| Parametro |
Tipo |
Descrição |
| Método não possui parametros de entrada! |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=LiberaAgente&SIPID=kvckbni2asl6ojqqt3ljfotvf7
&tipoRetorno=XML ] |
|
| [ Alarme ] |
| Descrição:[ Disca para o número informado, é necessáio passar o Ramal de Origem ] |
| Parametro |
Tipo |
Descrição |
| numeroDiscar | Inteiro | [requerido]
Número de telefone/ramal a discar. | | ramal | Inteiro | [requerido]
Número de um ramal com permissão para discagem, não precisa estar registrado. |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=Alarme&numeroDiscar=36844900&ramal=1001
&SIPID=kvckbni2asl6ojqqt3ljfotvf7&tipoRetorno=XML ] |
|
| [ DiscarDireto ] |
| Descrição:[ Disca para o número informado, é necessáio passar o Ramal de Origem ] |
| Parametro |
Tipo |
Descrição |
| numeroDiscar | Inteiro | [requerido]
Número de telefone/ramal a discar. | | ramal | Inteiro | [requerido]
Número do Ramal de Origem. |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=DiscarDireto&numeroDiscar=36844900
&ramal=1001&SIPID=kvckbni2asl6ojqqt3ljfotvf7&tipoRetorno=XML ] |
|
| [ ChamadaRamal ] |
| Descrição:[ Disca para o número informado, é necessário passar o Ramal de Origem ] |
| Parametro |
Tipo |
Descrição |
| numeroDiscar | Inteiro | [requerido]
Número de telefone/ramal a discar. | | ramal | Inteiro | [requerido]
Número do Ramal de Origem ou Número Fixo/Celular. |
| Tipo Retorno: [text/json ] |
url: [ http://192.168.0.218/integracao?method=ChamadaRamal&numeroDiscar=36844900
&ramal=1001&SIPID=kvckbni2asl6ojqqt3ljfotvf7&tipoRetorno=JSON ] |
|
| [ Discar ] |
Descrição:[ Disca para o número informado.
Obs: É necessário ter autenticado("ConectaAgente(...)") o agente e informar o "SIPID" na url. ] |
| Parametro |
Tipo |
Descrição |
| numeroDiscar | Inteiro | [requerido]
Número de telefone |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=Discar&numeroDiscar=36844900&SIPID=kvckbni2asl6ojqqt3ljfotvf7
&tipoRetorno=XML ] |
|
| [ AlarmeFila ] |
| Descrição:[ Disca para um conjunto de ramais estáticos na fila ] |
| Parametro |
Tipo |
Descrição |
| numeroFila | Inteiro | [requerido]
Número da fila. | | ramal | Inteiro | [requerido]
Número de um ramal com permissão para discagem, não precisa estar registrado. |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=AlarmeFila&numeroFila=1000&ramal=1001
&SIPID=kvckbni2asl6ojqqt3ljfotvf7&tipoRetorno=XML ] |
|
| [ EnviaSMS ] |
| Descrição:[ Envia SMS ] |
| Parametro |
Tipo |
Descrição |
| TroncoSainte | Texto | [requerido]
Tronco de saída. | | NumeroDestino | Integer | [requerido]
Nro do destino. | | Texto | Texto | [requerido]
Mensagem a ser enviada. | | login | Texto | [requerido]
Login. | | senha | Texto | [requerido]
Senha. |
| Tipo Retorno: [xml/stream ] |
url: [ http://192.168.0.218/integracao?method=EnviaSMS&TroncoSainte=b0c5&NumeroDestino=65999893984
&Texto=Envia teste de sms&login=login&senha=1234&SIPID=kvckbni2asl6ojqqt3ljfotvf7
&tipoRetorno=XML/STREAM ] |
|
| [ FinalizarGravacao ] |
| Descrição:[ Finaliza a gravação da chamada. ] |
| Parametro |
Tipo |
Descrição |
| Método não possui parametros de entrada! |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=FinalizarGravacao&SIPID=kvckbni2asl6ojqqt3ljfotvf7
&tipoRetorno=XML ] |
|
| [ FinalizaMute ] |
| Descrição:[ Finaliza o mute durante uma chamada. ] |
| Parametro |
Tipo |
Descrição |
| Método não possui parametros de entrada! |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=FinalizaMute&SIPID=kvckbni2asl6ojqqt3ljfotvf7
&tipoRetorno=XML ] |
|
| [ FinalizaPendulo ] |
| Descrição:[ Finaliza o pêndulo durante uma chamada. ] |
| Parametro |
Tipo |
Descrição |
| Método não possui parametros de entrada! |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=FinalizaPendulo&SIPID=kvckbni2asl6ojqqt3ljfotvf7
&tipoRetorno=XML ] |
|
| [ FinalizaConferencia ] |
| Descrição:[ Finaliza uma conferência. ] |
| Parametro |
Tipo |
Descrição |
| Método não possui parametros de entrada! |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=FinalizaConferencia&SIPID=kvckbni2asl6ojqqt3ljfotvf7
&tipoRetorno=XML ] |
|
| [ FinalizaTransferenciaConsulta ] |
| Descrição:[ Finaliza uma transferencia com consulta. ] |
| Parametro |
Tipo |
Descrição |
| Método não possui parametros de entrada! |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=FinalizaTransferenciaConsulta&SIPID=kvckbni2asl6ojqqt3ljfotvf7
&tipoRetorno=XML ] |
|
| [ Rediscar ] |
Descrição:[ 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. ] |
| Parametro |
Tipo |
Descrição |
| identificador | String | [requerido]
Identificador do Cliente no Sistema de Cobrança! |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=Rediscar&identificador=id_cliente
&SIPID=kvckbni2asl6ojqqt3ljfotvf7&tipoRetorno=XML ] |
|
| [ terminachamada ] |
| Descrição:[ Informa ao Xpro que uma chamada foi encerrada ] |
| Parametro |
Tipo |
Descrição |
| audio | String | [requerido]
Nome do arquivo de áudio da chamada. | | id_chamada | String | [requerido]
Id único da chamada no sistema. | | token | String | [requerido]
Token de segurança. |
| Tipo Retorno: [text/json ] |
url: [ http://192.168.0.218/integracao?method=terminachamada&audio=audio.mp3&id_chamada=12345667.7689
&token=20DBFFE&SIPID=kvckbni2asl6ojqqt3ljfotvf7&tipoRetorno=JSON ] |
|
| [ Ping ] |
| Descrição:[ Informações sobre o servidor de socket. ] |
| Parametro |
Tipo |
Descrição |
| Método não possui parametros de entrada! |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=Ping&SIPID=kvckbni2asl6ojqqt3ljfotvf7
&tipoRetorno=XML ] |
|
| [ IniciarGravacao ] |
| Descrição:[ Inicia a gravação da chamada corrente ao comando do agente ] |
| Parametro |
Tipo |
Descrição |
| nomeArquivo | String | [opcional]
Um nome único para o arquivo.
Se não informado será gerado pelo sistema | | tipoArquivo | String | [opcional]
O formato desejado para o áudio.
O valor padrão é wav49.
Tipos suportados:[gsm,wav,wav49] |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=IniciarGravacao&nomeArquivo=audio01
&tipoArquivo=gsm&SIPID=kvckbni2asl6ojqqt3ljfotvf7&tipoRetorno=XML ] |
|
| [ IniciaConferencia ] |
| Descrição:[ Inicia uma conferência a três. ] |
| Parametro |
Tipo |
Descrição |
| Método não possui parametros de entrada! |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=IniciaConferencia&SIPID=kvckbni2asl6ojqqt3ljfotvf7
&tipoRetorno=XML ] |
|
| [ IniciaTransferenciaConsulta ] |
| Descrição:[ Inicia uma transferencia com consulta. ] |
| Parametro |
Tipo |
Descrição |
| numeroTransferencia | String | [requerido]
Número para o qual será realizada a transferência |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=IniciaTransferenciaConsulta&numeroTransferencia=6533654489
&SIPID=kvckbni2asl6ojqqt3ljfotvf7&tipoRetorno=XML ] |
|
| [ IniciaMute ] |
| Descrição:[ Inicializa o mute durante uma chamada. ] |
| Parametro |
Tipo |
Descrição |
| Método não possui parametros de entrada! |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=IniciaMute&SIPID=kvckbni2asl6ojqqt3ljfotvf7
&tipoRetorno=XML ] |
|
| [ IniciaPendulo ] |
| Descrição:[ Inicializa o pêndulo durante uma chamada. ] |
| Parametro |
Tipo |
Descrição |
| Método não possui parametros de entrada! |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=IniciaPendulo&SIPID=kvckbni2asl6ojqqt3ljfotvf7
&tipoRetorno=XML ] |
|
| [ receberchamada ] |
| Descrição:[ Insere uma solicitação no Xpro a partir de uma chamada. ] |
| Parametro |
Tipo |
Descrição |
| telefone | String | [requerido]
Telefone do cliente que originou a chamada. | | id_chamada | String | [requerido]
Id único da chamada no sistema. | | token | String | [requerido]
Token de segurança. |
| Tipo Retorno: [text/json ] |
url: [ http://192.168.0.218/integracao?method=receberchamada&telefone=36844900
&id_chamada=12345667.7689&token=20DBFFE&SIPID=kvckbni2asl6ojqqt3ljfotvf7
&tipoRetorno=JSON ] |
|
| [ MonitoraRamal ] |
| Descrição:[ Lista os ramais o seus respctivos status. ] |
| Parametro |
Tipo |
Descrição |
| ramal | Integer | [requerido]
Ramal a ser monitorado. |
| Tipo Retorno: [xml/stream ] |
url: [ http://192.168.0.218/integracao?method=MonitoraRamal&ramal=2512&SIPID=kvckbni2asl6ojqqt3ljfotvf7
&tipoRetorno=XML/STREAM ] |
|
| [ MonitorRamais ] |
| Descrição:[ Lista os ramais o seus respctivos status. ] |
| Parametro |
Tipo |
Descrição |
| filtro | Integer | [requerido]
Filtro por "Status" 0-Inativos 1-Ativos 2-Ambos".
Obs.: Retorna o arquivo ou mensagem em xml! |
| Tipo Retorno: [xml/stream ] |
url: [ http://192.168.0.218/integracao?method=MonitorRamais&filtro=2&SIPID=kvckbni2asl6ojqqt3ljfotvf7
&tipoRetorno=XML/STREAM ] |
|
| [ ListaAbandonadas ] |
| Descrição:[ Lista todas as chamadas abandonadas em tempo real da fila informada. ] |
| Parametro |
Tipo |
Descrição |
| Dac | String | [requerido]
Informe um dac a ser monitorado |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=ListaAbandonadas&Dac=suporte&SIPID=kvckbni2asl6ojqqt3ljfotvf7
&tipoRetorno=XML ] |
|
| [ MonitorCampanha ] |
| Descrição:[ Monitora o progresso da "Campanha". ] |
| Parametro |
Tipo |
Descrição |
| idCampanha | string | [requerido]
Identificador da Campanha. Pode ser passado o "Nome(Identificador textual)" ou "Código(Identificador Númerico)"
|
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=MonitorCampanha&idCampanha=1&SIPID=kvckbni2asl6ojqqt3ljfotvf7
&tipoRetorno=XML ] |
|
| [ InvalidaNumeroCampanha ] |
| Descrição:[ Monitora o progresso da "Campanha". ] |
| Parametro |
Tipo |
Descrição |
| idCampanha | string | [requerido]
Identificador da Campanha. Pode ser passado o "Nome(Identificador textual)" ou "Código(Identificador Númerico)"
| | idLista | string | [requerido]
Identificador da Lista. Pode ser passado o "Nome(Identificador textual)" ou "Código(Identificador Númerico)"
| | idCliente | string | [requerido]
Identificador da cliente. Conforme enviado na lista. | | telefone | string | [requerido]
Identificador da Campanha. Pode ser passado o "Nome(Identificador textual)" ou "Código(Identificador Númerico)"
|
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=InvalidaNumeroCampanha&idCampanha=1
&idLista=1&idCliente=1&telefone=6536844908&SIPID=kvckbni2asl6ojqqt3ljfotvf7
&tipoRetorno=XML ] |
|
| [ RecebeAudioAlgar ] |
| Descrição:[ Passe o identificador recebido pela API "InfoChamadaAlgar" ou o "Protocolo Algar" para receber todos os áudios em um arquivo zip. ] |
| Parametro |
Tipo |
Descrição |
| idAudio | String | [requerido]
Identificador do áudio no sistema. |
| Tipo Retorno: [json/stream ] |
url: [ http://192.168.0.218/integracao?method=RecebeAudioAlgar&idAudio=7645272
&SIPID=kvckbni2asl6ojqqt3ljfotvf7&tipoRetorno=JSON/STREAM ] |
|
| [ IntercalarAgente ] |
| Descrição:[ Permite interagir com agente durante o atendimento. ] |
| Parametro |
Tipo |
Descrição |
| fila | String | [requerido]
Nome da fila em que o agente esta logado. | | matriculaAgente | String | [requerido]
Matricula do agente logado. | | ramalAgente | String | [requerido]
Ramal do agente logado. | | ramalIntercalar | String | [requerido]
Ramal usado para interagir durante o atendimento. |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=IntercalarAgente&fila=atendimento
&matriculaAgente=1000&ramalAgente=1001&ramalIntercalar=1005&SIPID=kvckbni2asl6ojqqt3ljfotvf7
&tipoRetorno=XML ] |
|
| [ GerenciaAgenda ] |
| Descrição:[ Permite o gerenciamento da agenda do SimplesIP. ] |
| Parametro |
Tipo |
Descrição |
| telefone | Integer | [requerido]
Telefone/Ramal do contato | | acao | String | [requerido]
Acao a ser desempenhada pela API. As operações padrão são: BUSCAR, INSERIR, EDITAR, EXCLUIR | | identificacao | String | [requerido]
Nome/Empresa do contato. | | DDD | String | [requerido]
DDD da localização do contato. | | teloriginal | String | [opcional]
Telefone original do contato. Somente utilizado na ação EDITAR. | | departamento | String | [opcional]
Indica qual departamento o usuário será inserido. Somente utilizado na ação INSERIR |
| Tipo Retorno: [text/xml || text/json ] |
url: [ http://192.168.0.218/integracao?method=GerenciaAgenda&telefone=36168280
&acao=BUSCAR&identificacao=user&DDD=65&teloriginal=36168280&departamento=simplesip
&SIPID=kvckbni2asl6ojqqt3ljfotvf7&tipoRetorno=JSON ] |
|
| [ GetAudio ] |
| Descrição:[ Permite recuperar o áudio de um atendimento. ] |
| Parametro |
Tipo |
Descrição |
| uniqueid | String | [requerido]
Identificador da chamada retornada por "InformacoesAtendimento".
Obs.: Retorna o arquivo ou mensagem em xml! | | tipo | String | [opcional]
O formato desejado para o áudio.
O valor padrão é wav.
Tipos suportados:[wav, mp3] |
| Tipo Retorno: [json/stream ] |
url: [ http://192.168.0.218/integracao?method=GetAudio&uniqueid=123456666.555&tipo=wav
&SIPID=kvckbni2asl6ojqqt3ljfotvf7&tipoRetorno=JSON/STREAM ] |
|
| [ EnviarDadosCampanha ] |
| Descrição:[ Recebe arquivo com informações de "Campanha" para discagem automática. ] |
| Parametro |
Tipo |
Descrição |
| arquivoCampanha | file | [requerido]
Arquivo de Campanha
Contém informações da campanha e lista para discagem.  |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=EnviarDadosCampanha&arquivoCampanha=file
&SIPID=kvckbni2asl6ojqqt3ljfotvf7&tipoRetorno=XML ] |
|
| [ SaidaPausa ] |
Descrição:[ Retira o agente da pausa.
Obs: É necessário ter autenticado("ConectaAgente(...)") o agente e informar o "SIPID" na url. ] |
| Parametro |
Tipo |
Descrição |
| Método não possui parametros de entrada! |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=SaidaPausa&SIPID=kvckbni2asl6ojqqt3ljfotvf7
&tipoRetorno=XML ] |
|
| [ ListaChamadasDac ] |
| Descrição:[ Retorna lista das chamadas "Entrantes/Saintes" por período. ] |
| Parametro |
Tipo |
Descrição |
| dataInicial | DateTime | [requerido]
Informe um valor no Formato: ddmmaaaa! | | dataFinal | DateTime | [requerido]
Informe um valor no Formato: ddmmaaaa! |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=ListaChamadasDac&dataInicial=06072024
&dataFinal=06072024&SIPID=kvckbni2asl6ojqqt3ljfotvf7&tipoRetorno=XML ] |
|
| [ ListaChamadasGeral ] |
| Descrição:[ Retorna lista das chamadas "Entrantes/Saintes" por período. ] |
| Parametro |
Tipo |
Descrição |
| dataInicial | DateTime | [requerido]
Informe um valor no Formato: ddmmaaaa! | | dataFinal | DateTime | [requerido]
Informe um valor no Formato: ddmmaaaa! |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=ListaChamadasGeral&dataInicial=06072024
&dataFinal=06072024&SIPID=kvckbni2asl6ojqqt3ljfotvf7&tipoRetorno=XML ] |
|
| [ ListaChamadasFila ] |
| Descrição:[ Retorna lista das chamadas "Entrantes/Saintes" por período. ] |
| Parametro |
Tipo |
Descrição |
| dac | Inteiro | [requerido]
Informe o código do DAC ou 0 para todos! | | dataInicial | DateTime | [requerido]
Informe um valor no Formato: ddmmaaaa! | | dataFinal | DateTime | [requerido]
Informe um valor no Formato: ddmmaaaa! |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=ListaChamadasFila&dac=90&dataInicial=06072024
&dataFinal=06072024&SIPID=kvckbni2asl6ojqqt3ljfotvf7&tipoRetorno=XML ] |
|
| [ InfoChamada ] |
| Descrição:[ Retorna as informações sobre uma chamada em específico! ] |
| Parametro |
Tipo |
Descrição |
| Dac | Integer | [requerido
Id da fila que deseja a consulta. | | uniqueid | String | [requerido]
Uniqueid da chamada que deseja visualizar as informações. |
| Tipo Retorno: [ ] |
url: [ http://192.168.0.218/integracao?method=InfoChamada&Dac=90&uniqueid=1536691853.274148
&SIPID=kvckbni2asl6ojqqt3ljfotvf7&tipoRetorno=XML ] |
|
| [ RegNaoPerturbe ] |
| Descrição:[ Retorna com os números a serem incluidos no Não Perturbe Anatel. ] |
| Parametro |
Tipo |
Descrição |
| idCliente | Inteiro | [requerido]
Id do cliente atualizado | | npId | Inteiro | [requerido]
Id da lista atualizada. |
| Tipo Retorno: [text/plain ] |
url: [ http://192.168.0.218/integracao?method=RegNaoPerturbe&idCliente=1&npId=1
&SIPID=kvckbni2asl6ojqqt3ljfotvf7&tipoRetorno=TEXT/PLAIN ] |
|
| [ ListaNaoPerturbe ] |
| Descrição:[ Retorna com os números a serem incluidos no Não Perturbe Anatel. ] |
| Parametro |
Tipo |
Descrição |
| info | Inteiro | [requerido]
Informe 1 para obterinformações do arquivo e 0 para download. | | id | Inteiro | [requerido]
Quando "info = 1" passe o código do cliente(emp_id), quando "info = 0" passe o id do arquivo(np_id). |
| Tipo Retorno: [json/stream ] |
url: [ http://192.168.0.218/integracao?method=ListaNaoPerturbe&info=1&id=1&SIPID=kvckbni2asl6ojqqt3ljfotvf7
&tipoRetorno=JSON/STREAM ] |
|
| [ RelPesquisa ] |
| Descrição:[ Retorna dados das Pesquisas de satisfação por período. ] |
| Parametro |
Tipo |
Descrição |
| dac | String | [requerido]
Informe o Nome do DAC! | | pesquisa | String | Informe o Nome da Pesquisa! | | dataInicial | DateTime | [requerido]
Informe um valor no Formato: ddmmaaaa! | | dataFinal | DateTime | [requerido]
Informe um valor no Formato: ddmmaaaa! |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=RelPesquisa&dac=Atendimento&pesquisa=Pesquisa1
&dataInicial=06072024&dataFinal=06072024&SIPID=kvckbni2asl6ojqqt3ljfotvf7
&tipoRetorno=XML ] |
|
| [ ListaChamadaTelefone ] |
| Descrição:[ Retorna informações de origem/destino da chamada de acordo com o período e o telefone. ] |
| Parametro |
Tipo |
Descrição |
| dataInicial | DateTime | [requerido]
Informe um valor no Formato: ddmmaaaa! | | dataFinal | DateTime | [requerido]
Informe um valor no Formato: ddmmaaaa! | | telefone | String | [requerido]
Informe um telefone! |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=ListaChamadaTelefone&dataInicial=06072024
&dataFinal=06072024&telefone=65123456789&SIPID=kvckbni2asl6ojqqt3ljfotvf7
&tipoRetorno=XML ] |
|
| [ ListaChamadas ] |
| Descrição:[ Retorna informações de origem/destino das chamadas de acordo com o período. ] |
| Parametro |
Tipo |
Descrição |
| dataInicial | DateTime | [requerido]
Informe um valor no Formato: ddmmaaaa! | | dataFinal | DateTime | [requerido]
Informe um valor no Formato: ddmmaaaa! |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=ListaChamadas&dataInicial=06072024
&dataFinal=06072024&SIPID=kvckbni2asl6ojqqt3ljfotvf7&tipoRetorno=XML ] |
|
| [ InformacoesAgentesGeral ] |
| Descrição:[ Retorna informações de todos os agentes logados nas filas ] |
| Parametro |
Tipo |
Descrição |
| Método não possui parametros de entrada! |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=InformacoesAgentesGeral&SIPID=kvckbni2asl6ojqqt3ljfotvf7
&tipoRetorno=XML ] |
|
| [ ProducaoAgente ] |
| Descrição:[ Retorna informações sobre "Agentes/Dac" por período! ] |
| Parametro |
Tipo |
Descrição |
| dac | Inteiro | [requerido]
Número da "Fila(DAC)" usada para atendimento. | | dataInicial | DateTime | [requerido]
Informe um valor no Formato: ddmmaaaa! | | dataFinal | DateTime | [requerido]
Informe um valor no Formato: ddmmaaaa! |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=ProducaoAgente&dac=7&dataInicial=06072024
&dataFinal=06072024&SIPID=kvckbni2asl6ojqqt3ljfotvf7&tipoRetorno=XML ] |
|
| [ InformacoesSupervisor ] |
| Descrição:[ Retorna informações sobre a Fila(DAC) Informada. ] |
| Parametro |
Tipo |
Descrição |
| dac | String | [requerido]
Identificação da Fila a ser monitorada. |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=InformacoesSupervisor&dac=atendimento
&SIPID=kvckbni2asl6ojqqt3ljfotvf7&tipoRetorno=XML ] |
|
| [ InformacoesDacs ] |
| Descrição:[ Retorna informações sobre a produtividade da(s) Fila(s)(DAC) Informada(s). ] |
| Parametro |
Tipo |
Descrição |
| dac | String | Identificação da(s) Fila(s) a ser(em) monitorada(s). |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=InformacoesDacs&dac=atendimento&SIPID=kvckbni2asl6ojqqt3ljfotvf7
&tipoRetorno=XML ] |
|
| [ InformacoesAtendimento ] |
Descrição:[ Retorna informações sobre atendimento.
Obs: É necessário ter autenticado("ConectaAgente(...)") o agente e informar o "SIPID" na url. ] |
| Parametro |
Tipo |
Descrição |
| Método não possui parametros de entrada! |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=InformacoesAtendimento&SIPID=kvckbni2asl6ojqqt3ljfotvf7
&tipoRetorno=XML ] |
|
| [ GetMotivosPausa ] |
| Descrição:[ Retorna lista com motivos de pausa ] |
| Parametro |
Tipo |
Descrição |
| Método não possui parametros de entrada! |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=GetMotivosPausa&SIPID=kvckbni2asl6ojqqt3ljfotvf7
&tipoRetorno=XML ] |
|
| [ GetDadosLogin ] |
| Descrição:[ Retorna o Ip. ] |
| Parametro |
Tipo |
Descrição |
| matricula | String | [requerido]
Retorna informações sobre o agente on-line. |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=GetDadosLogin&matricula=1001&SIPID=kvckbni2asl6ojqqt3ljfotvf7
&tipoRetorno=XML ] |
|
| [ GetOperadora ] |
| Descrição:[ Retorna o Ip. ] |
| Parametro |
Tipo |
Descrição |
| destino | String | [requerido]
Número do telefone de destino com DDD. |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=GetOperadora&destino=6536168282&SIPID=kvckbni2asl6ojqqt3ljfotvf7
&tipoRetorno=XML ] |
|
| [ MeuIP ] |
| Descrição:[ Retorna o Ip. ] |
| Parametro |
Tipo |
Descrição |
| Método não possui parametros de entrada! |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=MeuIP&SIPID=kvckbni2asl6ojqqt3ljfotvf7
&tipoRetorno=XML ] |
|
| [ Callback ] |
| Descrição:[ Retorna para o número informado, é necessário passar o Ramal de Origem ] |
| Parametro |
Tipo |
Descrição |
| numeroDiscar | Inteiro | [requerido]
Número de telefone/ramal a discar. | | ramal | Inteiro | [requerido]
Número do Ramal de Origem. | | destino | String | [requerido]
Destino para qual a ligação vai ser enviada. |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=Callback&numeroDiscar=6536844900
&ramal=1001&destino=5000&SIPID=kvckbni2asl6ojqqt3ljfotvf7&tipoRetorno=XML ] |
|
| [ LigueGratis ] |
| Descrição:[ Retorna para o número informado. ] |
| Parametro |
Tipo |
Descrição |
| numeroDiscar | Inteiro | [requerido]
Número de telefone com DDD. |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=LigueGratis&numeroDiscar=6536844900
&SIPID=kvckbni2asl6ojqqt3ljfotvf7&tipoRetorno=XML ] |
|
| [ ListaDacsAgente ] |
| Descrição:[ Retorna uma lista com os "Dacs" disponíveis para o "Agente Autenticado!" ] |
| Parametro |
Tipo |
Descrição |
| agente | String | [requerido]
Agente autenticado no Sistema |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=ListaDacsAgente&agente=nomeAgente
&SIPID=kvckbni2asl6ojqqt3ljfotvf7&tipoRetorno=XML ] |
|
| [ ListaDacsMatricula ] |
| Descrição:[ Retorna uma lista com os "Dacs" disponíveis para o "Matricula Informada!" ] |
| Parametro |
Tipo |
Descrição |
| matricula | String | [requerido]
Matrícula de um agente |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=ListaDacsMatricula&matricula=1000
&SIPID=kvckbni2asl6ojqqt3ljfotvf7&tipoRetorno=XML ] |
|
| [ ListaAgentes ] |
| Descrição:[ Retorna uma lista com os Agentes Disponíveis!" ] |
| Parametro |
Tipo |
Descrição |
| Método não possui parametros de entrada! |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=ListaAgentes&SIPID=kvckbni2asl6ojqqt3ljfotvf7
&tipoRetorno=XML ] |
|
| [ ListaDacs ] |
| Descrição:[ Retorna uma lista com os Dacs disponíveis. ] |
| Parametro |
Tipo |
Descrição |
| Método não possui parametros de entrada! |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=ListaDacs&SIPID=kvckbni2asl6ojqqt3ljfotvf7
&tipoRetorno=XML ] |
|
| [ ListaAbandonadasPeriodo ] |
| Descrição:[ Retorna uma listagem das chamadas abandonadas por período. ] |
| Parametro |
Tipo |
Descrição |
| dataInicial | DateTime | [requerido]
Informe um valor no formato: ddmmaaaa | | dataFinal | DateTime | [requerido]
Informe um valor no formato: ddmmaaa | | dac | String | [requerido]
Informe a fila que gostaria de consultar |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=ListaAbandonadasPeriodo&dataInicial=06072024
&dataFinal=06072024&dac=suporte&SIPID=kvckbni2asl6ojqqt3ljfotvf7&tipoRetorno=XML ] |
|
| [ tarifaPeriodo ] |
| Descrição:[ Tarifação dos Ramais por periodo! Idenficadores de Registro: [ # - Tarifa Zero ] [ ** - Franquia ] [ * - Franquia Parcial]" ] |
| Parametro |
Tipo |
Descrição |
| dataInicial | DateTime | [requerido]
Informe um valor no Formato: ddmmaaaa! | | dataFinal | DateTime | [requerido]
Informe um valor no Formato: ddmmaaaa! |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=tarifaPeriodo&dataInicial=06072024
&dataFinal=06072024&SIPID=kvckbni2asl6ojqqt3ljfotvf7&tipoRetorno=XML ] |
|
| [ tarifaRamal ] |
| Descrição:[ Tarifação dos Ramais! Idenficadores de Registro: [ # - Tarifa Zero ] [ ** - Franquia ] [ * - Franquia Parcial]" ] |
| Parametro |
Tipo |
Descrição |
| dataInicial | DateTime | [requerido]
Informe um valor no Formato: ddmmaaaa! | | dataFinal | DateTime | [requerido]
Informe um valor no Formato: ddmmaaaa! |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=tarifaRamal&dataInicial=06072024
&dataFinal=06072024&SIPID=kvckbni2asl6ojqqt3ljfotvf7&tipoRetorno=XML ] |
|
| [ Transferir ] |
Descrição:[ Transfere a ligação corrente para o número informado.
Obs: É necessário ter autenticado("ConectaAgente(...)") o agente e informar o "SIPID" na url. ] |
| Parametro |
Tipo |
Descrição |
| numeroDiscar | Inteiro | [requerido]
Número de telefone |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=Transferir&numeroDiscar=36844900
&SIPID=kvckbni2asl6ojqqt3ljfotvf7&tipoRetorno=XML ] |
|
| [ TransferePesquisa ] |
| Descrição:[ Transfere uma chamada para uma pesquisa cadastrada no sistema ] |
| Parametro |
Tipo |
Descrição |
| matricula | String | [requerido]
Matrícula de um agente | | pesquisaId | Integer | [requerido]
Informe o id da pesquisa |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=TransferePesquisa&matricula=1000
&pesquisaId=2&SIPID=kvckbni2asl6ojqqt3ljfotvf7&tipoRetorno=XML ] |
|
| [ ValidaRamal ] |
| Descrição:[ Verifica se o ramal está cadastrado na base de dados ] |
| Parametro |
Tipo |
Descrição |
| ramal | Inteiro | [requerido]
Número do ramal para atendimento no dac. |
| Tipo Retorno: [text/xml ] |
url: [ http://192.168.0.218/integracao?method=ValidaRamal&ramal=1003&SIPID=kvckbni2asl6ojqqt3ljfotvf7
&tipoRetorno=XML ] |
|
|
