Simples IP - Documentação API

[v1.0] Documentação API - Developers

GET	StatusCampanha

Sobre: Altera o status de uma Campanha.

Retornos: XML & JSON

QUERY PARAMS/BODY

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.

Exemplo: http://192.168.115.42/integracao?method=StatusCampanha&idCampanha=1&status=1&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	MonitoraChamadas

Sobre: Apresenta as chamadas em curso na central atualizadas em tempo real.

Retornos: XML & JSON

QUERY PARAMS/BODY

ESTE MÉTODO NÃO POSSUI NENHUM PARAMETRO DE ENTRADA!

Exemplo: http://192.168.115.42/integracao?method=MonitoraChamadas&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	InfoChamadaAlgar

Sobre: Apresenta informações de uma chamda através do protocolo Algar

Retornos: JSON

QUERY PARAMS/BODY

REQUIRED STRING	ProtocoloAlgar	Protocolo de chamada Algar Telecom

Exemplo: http://192.168.115.42/integracao?method=InfoChamadaAlgar&ProtocoloAlgar=7645272&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	AutenticaUsuario

Sobre: Autentica um usuário na Requisição!

Retornos: XML & JSON

QUERY PARAMS/BODY

REQUIRED STRING	login	Login do usuário

REQUIRED STRING	senha	Senha do usuário

Exemplo: http://192.168.115.42/integracao?method=AutenticaUsuario&login=admin&senha=0000&tipoRetorno=XML

GET	DisponivelFila

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.

Retornos: XML & JSON

QUERY PARAMS/BODY

REQUIRED STRING	dac	Identificação da(s) Fila(s) a ser(em) monitorada(s).

Exemplo: http://192.168.115.42/integracao?method=DisponivelFila&dac=atendimento&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	EntradaPausa

Sobre: Coloca o agente em pausa.
Obs: É necessário ter autenticado("ConectaAgente(...)") o agente e informar o "SIPID" na url.

Retornos: XML & JSON

QUERY PARAMS/BODY

OPCIONAL STRING	codMotivo	Indica o motivo da pausa

Exemplo: http://192.168.115.42/integracao?method=EntradaPausa&codMotivo=3&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	ConectaAgente

Sobre: Conecta um agente a um DAC.

Retornos: XML & JSON

QUERY PARAMS/BODY

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

Exemplo: http://192.168.115.42/integracao?method=ConectaAgente&dac=3&nomeDac=discador&matriculaAgente=1001&apelidoAgente=admin&ramal=6008&tipoAtende=**50&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	DesconectaAgente

Sobre: Desconecta o agente.
Obs: É necessário ter autenticado("ConectaAgente(...)") o agente e informar o "SIPID" na url.

Retornos: XML & JSON

QUERY PARAMS/BODY

ESTE MÉTODO NÃO POSSUI NENHUM PARAMETRO DE ENTRADA!

Exemplo: http://192.168.115.42/integracao?method=DesconectaAgente&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	DesligarChamada

Sobre: Desliga chamada corrente.

Retornos: XML & JSON

QUERY PARAMS/BODY

ESTE MÉTODO NÃO POSSUI NENHUM PARAMETRO DE ENTRADA!

Exemplo: http://192.168.115.42/integracao?method=DesligarChamada&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET

Alarme

Sobre: Disca para o número informado, é necessáio passar o Ramal de Origem

Retornos: XML & JSON

QUERY PARAMS/BODY

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.

Exemplo: http://192.168.115.42/integracao?method=Alarme&numeroDiscar=36844900&ramal=1001&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	DiscarDireto

Sobre: Disca para o número informado, é necessáio passar o Ramal de Origem

Retornos: XML & JSON

QUERY PARAMS/BODY

REQUIRED INTEIRO	numeroDiscar	Número de telefone/ramal a discar.

REQUIRED INTEIRO	ramal	Número do Ramal de Origem.

Exemplo: http://192.168.115.42/integracao?method=DiscarDireto&numeroDiscar=36844900&ramal=1001&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	ChamadaRamal

Sobre: Disca para o número informado, é necessário passar o Ramal de Origem

Retornos: JSON

QUERY PARAMS/BODY

REQUIRED INTEIRO	numeroDiscar	Número de telefone/ramal a discar.

REQUIRED INTEIRO	ramal	Número do Ramal de Origem ou Número Fixo/Celular.

Exemplo: http://192.168.115.42/integracao?method=ChamadaRamal&numeroDiscar=36844900&ramal=1001&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET

Discar

Sobre: Disca para o número informado.
Obs: É necessário ter autenticado("ConectaAgente(...)") o agente e informar o "SIPID" na url.

Retornos: XML & JSON

QUERY PARAMS/BODY

REQUIRED INTEIRO	numeroDiscar	Número de telefone

Exemplo: http://192.168.115.42/integracao?method=Discar&numeroDiscar=36844900&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	AlarmeFila

Sobre: Disca para um conjunto de ramais estáticos na fila

Retornos: XML & JSON

QUERY PARAMS/BODY

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.

Exemplo: http://192.168.115.42/integracao?method=AlarmeFila&numeroDiscar=36844900&ramal=1001&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET

EnviaSMS

Sobre: Envia SMS.

Retornos: XML/STREAM

QUERY PARAMS/BODY

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.

Exemplo: http://192.168.115.42/integracao?method=EnviaSMS&TroncoSainte=b0c5&NumeroDestino=65999893984&Texto=Envia teste de sms&login=login&senha=1234&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	FinalizarGravacao

Sobre: Finaliza a gravação da chamada.

Retornos: XML & JSON

QUERY PARAMS/BODY

ESTE MÉTODO NÃO POSSUI NENHUM PARAMETRO DE ENTRADA!

Exemplo: http://192.168.115.42/integracao?method=FinalizarGravacao&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	FinalizaMute

Sobre: Finaliza o mute durante uma chamada.

Retornos: XML & JSON

QUERY PARAMS/BODY

ESTE MÉTODO NÃO POSSUI NENHUM PARAMETRO DE ENTRADA!

Exemplo: http://192.168.115.42/integracao?method=FinalizaMute&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	FinalizaPendulo

Sobre: Finaliza o pêndulo durante uma chamada.

Retornos: XML & JSON

QUERY PARAMS/BODY

ESTE MÉTODO NÃO POSSUI NENHUM PARAMETRO DE ENTRADA!

Exemplo: http://192.168.115.42/integracao?method=FinalizaPendulo&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	FinalizaTransferenciaConsulta

Sobre: Finaliza uma transferencia com consulta.

Retornos: XML & JSON

QUERY PARAMS/BODY

ESTE MÉTODO NÃO POSSUI NENHUM PARAMETRO DE ENTRADA!

Exemplo: http://192.168.115.42/integracao?method=FinalizaTransferenciaConsulta&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET

Rediscar

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.

Retornos: XML & JSON

QUERY PARAMS/BODY

REQUIRED STRING	identificador	Identificador do Cliente no Sistema de Cobrança!

Exemplo: http://192.168.115.42/integracao?method=Rediscar&identificador=id_cliente&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET

Ping

Sobre: Informações sobre o servidor de socket.

Retornos: XML & JSON

QUERY PARAMS/BODY

ESTE MÉTODO NÃO POSSUI NENHUM PARAMETRO DE ENTRADA!

Exemplo: http://192.168.115.42/integracao?method=Ping&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	IniciarGravacao

Sobre: Inicia a gravação da chamada corrente ao comando do agente.

Retornos: XML & JSON

QUERY PARAMS/BODY

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]

Exemplo: http://192.168.115.42/integracao?method=IniciarGravacao&nomeArquivo=audio01&tipoArquivo=gsm&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	IniciaConferencia

Sobre: Inicia uma conferência a três.

Retornos: XML & JSON

QUERY PARAMS/BODY

ESTE MÉTODO NÃO POSSUI NENHUM PARAMETRO DE ENTRADA!

Exemplo: http://192.168.115.42/integracao?method=IniciaConferencia&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	IniciaTransferenciaConsulta

Sobre: Inicia uma transferencia com consulta.

Retornos: XML & JSON

QUERY PARAMS/BODY

REQUIRED STRING	numeroTransferencia	Número para o qual será realizada a transferência

Exemplo: http://192.168.115.42/integracao?method=IniciaTransferenciaConsulta&numeroTransferencia=6533654489&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	IniciaMute

Sobre: Inicializa o mute durante uma chamada.

Retornos: XML & JSON

QUERY PARAMS/BODY

ESTE MÉTODO NÃO POSSUI NENHUM PARAMETRO DE ENTRADA!

Exemplo: http://192.168.115.42/integracao?method=IniciaMute&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	IniciaPendulo

Sobre: Inicializa o pêndulo durante uma chamada.

Retornos: XML & JSON

QUERY PARAMS/BODY

ESTE MÉTODO NÃO POSSUI NENHUM PARAMETRO DE ENTRADA!

Exemplo: http://192.168.115.42/integracao?method=IniciaPendulo&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	LiberaAgente

Sobre: Libera o agente do discador.

Retornos: XML & JSON

QUERY PARAMS/BODY

ESTE MÉTODO NÃO POSSUI NENHUM PARAMETRO DE ENTRADA!

Exemplo: http://192.168.115.42/integracao?method=LiberaAgente&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	MonitorRamais

Sobre: Lista os ramais o seus respctivos status.

Retornos: XML & JSON

QUERY PARAMS/BODY

REQUIRED INTEGER	filtro	Filtro por Status 0-Inativos 1-Ativos 2-Ambos

Exemplo: http://192.168.115.42/integracao?method=MonitorRamais&filtro=2&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	MonitoraRamal

Sobre: Lista os ramais o seus respctivos status.

Retornos: XML/STREAM

QUERY PARAMS/BODY

REQUIRED INTEGER	ramal	Ramal a ser monitorado.

Exemplo: http://192.168.115.42/integracao?method=MonitoraRamal&ramal=2512&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	StatusTroncos

Sobre: Lista os troncos com seus respectivos status.

Retornos: XML & JSON

QUERY PARAMS/BODY

ESTE MÉTODO NÃO POSSUI NENHUM PARAMETRO DE ENTRADA!

Exemplo: http://192.168.115.42/integracao?method=StatusTroncos&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	ListaAbandonadas

Sobre: Lista todas as chamadas abandonadas em tempo real da fila informada.

Retornos: XML & JSON

QUERY PARAMS/BODY

REQUIRED STRING	DAC	Informe um DAC a ser monitorado.

Exemplo: http://192.168.115.42/integracao?method=ListaAbandonadas&DAC=SUPORT&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	MonitorCampanha

Sobre: Monitora o progresso da Campanha.

Retornos: XML & JSON

QUERY PARAMS/BODY

REQUIRED STRING	idCampanha	Identificador da Campanha. Pode ser passado o Nome(Identificador textual) ou Código(Identificador Númerico).

Exemplo: http://192.168.115.42/integracao?method=MonitorCampanha&idCampanha=1&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	InvalidaNumeroCampanha

Sobre: Monitora o progresso da Campanha.

Retornos: XML & JSON

QUERY PARAMS/BODY

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)

Exemplo: http://192.168.115.42/integracao?method=InvalidaNumeroCampanha&idCampanha=1&idLista=1&idCliente=1&telefone=6536844908&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	RecebeAudioAlgar

Sobre: Passe o identificador recebido pela API InfoChamadaAlgar ou o Protocolo Algar para receber todos os áudios em um arquivo zip.

Retornos: JSON/STREAM

QUERY PARAMS/BODY

REQUIRED STRING	idAudio	Identificador do áudio no sistema.

Exemplo: http://192.168.115.42/integracao?method=RecebeAudioAlgar&idAudio=7645272&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	IntercalarAgente

Sobre: Permite interagir com agente durante o atendimento.

Retornos: XML & JSON

QUERY PARAMS/BODY

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.

Exemplo: http://192.168.115.42/integracao?method=IntercalarAgente&fila=atendimento&matriculaAgente=1000&ramalAgente=1001&ramalIntercalar=1005&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	GerenciaAgenda

Sobre: Permite o gerenciamento da agenda do SimplesIP.

Retornos: JSON

QUERY PARAMS/BODY

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.

Exemplo: http://192.168.115.42/integracao?method=GerenciaAgenda&telefone=36168280&acao=BUSCAR&identificacao=user&DDD=65&teloriginal=36168280&departamento=simplesip&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET

GetAudio

Sobre: Permite recuperar o áudio de um atendimento.

Retornos: JSON/STREAM

QUERY PARAMS/BODY

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]

Exemplo: http://192.168.115.42/integracao?method=GetAudio&uniqueid=123456666.555&tipo=wav&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	EnviarDadosCampanha

Sobre: Recebe arquivo com informações de Campanha para discagem automática.

Retornos: XML & JSON

QUERY PARAMS/BODY

REQUIRED FILE	arquivoCampanha	Arquivo de Campanha. Contém informações da campanha e lista para discagem.

Exemplo: http://192.168.115.42/integracao?method=EnviarDadosCampanha&arquivoCampanha=file&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	SaidaPausa

Sobre: Retira o agente da pausa.
Obs: É necessário ter autenticado("ConectaAgente(...)") o agente e informar o "SIPID" na url.

Retornos: XML & JSON

QUERY PARAMS/BODY

ESTE MÉTODO NÃO POSSUI NENHUM PARAMETRO DE ENTRADA!

Exemplo: http://192.168.115.42/integracao?method=SaidaPausa&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	ListaChamadasDac

Sobre: Retorna lista das chamadas \"Entrantes/Saintes\" por período.

Retornos: XML & JSON

QUERY PARAMS/BODY

REQUIRED DATETIME	dataInicial	Informe um valor no formato: ddmmaaaa.

REQUIRED DATETIME	dataFinal	Informe um valor no formato: ddmmaaa

Exemplo: http://192.168.115.42/integracao?method=ListaChamadasDac&dataInicial=05102024&dataFinal=05102024&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	GetDadosLogin

Sobre: Retorna as informações do agente logado pela matricula.

Retornos: XML & JSON

QUERY PARAMS/BODY

REQUIRED STRING	matricula	Retorna informações sobre o agente on-line.

Exemplo: http://192.168.115.42/integracao?method=GetDadosLogin&matricula=1001&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	InfoChamada

Sobre: Retorna as informações sobre uma chamada em específico.

Retornos: XML & JSON

QUERY PARAMS/BODY

REQUIRED STRING	uniqueid	Uniqueid da chamada que deseja visualizar as informações..

REQUIRED INTEIRO	dac	Id da fila que deseja a consulta.

Exemplo: http://192.168.115.42/integracao?method=InfoChamada&uniqueid=1536691853.274148&dac=90&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	RegNaoPerturbe

Sobre: Retorna com os números a serem incluidos no Não Perturbe Anatel.

Retornos: TEXT/PLAIN

QUERY PARAMS/BODY

REQUIRED INTEIRO	idCliente	Id do cliente atualizado.

REQUIRED INTEIRO	npId	Id da lista atualizada.

Exemplo: http://192.168.115.42/integracao?method=RegNaoPerturbe&idCliente=1&npId=1&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	ListaNaoPerturbe

Sobre: Retorna com os números a serem incluidos no Não Perturbe Anatel.

Retornos: JSON/STREAM

QUERY PARAMS/BODY

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).

Exemplo: http://192.168.115.42/integracao?method=ListaNaoPerturbe&info=1&id=1&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	RelPesquisa

Sobre: Retorna dados das Pesquisas de satisfação por período.

Retornos: XML & JSON

QUERY PARAMS/BODY

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.

Exemplo: http://192.168.115.42/integracao?method=RelPesquisa&dac=Atendimento&pesquisa=Pesquisa1&dataInicial=05102024&dataFinal=05102024&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	ListaChamadaTelefone

Sobre: Retorna informações de origem/destino da chamada de acordo com o período e o telefone.

Retornos: XML & JSON

QUERY PARAMS/BODY

REQUIRED DATETIME	dataInicial	Informe um valor no formato: ddmmaaaa.

REQUIRED DATETIME	dataFinal	Informe um valor no formato: ddmmaaa

REQUIRED STRING	telefone	Informe um telefone

Exemplo: http://192.168.115.42/integracao?method=ListaChamadaTelefone&dataInicial=05102024&dataFinal=05102024&telefone=65123456789&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	ListaChamadas

Sobre: Retorna informações de origem/destino das chamadas de acordo com o período.

Retornos: XML & JSON

QUERY PARAMS/BODY

REQUIRED DATETIME	dataInicial	Informe um valor no formato: ddmmaaaa.

REQUIRED DATETIME	dataFinal	Informe um valor no formato: ddmmaaa

Exemplo: http://192.168.115.42/integracao?method=ListaChamadas&dataInicial=05102024&dataFinal=05102024&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	InformacoesAgentesGeral

Sobre: Retorna informações de todos os agentes logados nas filas

Retornos: XML & JSON

QUERY PARAMS/BODY

ESTE MÉTODO NÃO POSSUI NENHUM PARAMETRO DE ENTRADA!

Exemplo: http://192.168.115.42/integracao?method=InformacoesAgentesGeral&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	GetOperadora

Sobre: Retorna informações sobre \"Agentes/Dac\" por período!

Retornos: XML & JSON

QUERY PARAMS/BODY

REQUIRED STRING	destino	Número do telefone de destino com DDD.

Exemplo: http://192.168.115.42/integracao?method=GetOperadora&destino=6536168282&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	ProducaoAgente

Sobre: Retorna informações sobre \"Agentes/Dac\" por período!

Retornos: XML & JSON

QUERY PARAMS/BODY

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.

Exemplo: http://192.168.115.42/integracao?method=ProducaoAgente&dataInicial=05102024&dataFinal=05102024&dac=7&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	InformacoesSupervisor

Sobre: Retorna informações sobre a Fila(DAC) Informada.

Retornos: XML & JSON

QUERY PARAMS/BODY

REQUIRED STRING	dac	Identificação da Fila a ser monitorada.

Exemplo: http://192.168.115.42/integracao?method=InformacoesSupervisor&dac=atendimento&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	InformacoesDacs

Sobre: Retorna informações sobre a produtividade da(s) Fila(s)(DAC) Informada(s).

Retornos: XML & JSON

QUERY PARAMS/BODY

REQUIRED STRING	dac	Identificação da(s) Fila(s) a ser(em) monitorada(s).

Exemplo: http://192.168.115.42/integracao?method=InformacoesDacs&dac=atendimento&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	InformacoesAtendimento

Sobre: Retorna informações sobre atendimento.
Obs: É necessário ter autenticado("ConectaAgente(...)") o agente e informar o "SIPID" na url.

Retornos: XML & JSON

QUERY PARAMS/BODY

ESTE MÉTODO NÃO POSSUI NENHUM PARAMETRO DE ENTRADA!

Exemplo: http://192.168.115.42/integracao?method=InformacoesAtendimento&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	GetMotivosPausa

Sobre: Retorna lista com motivos de pausa.

Retornos: XML & JSON

QUERY PARAMS/BODY

ESTE MÉTODO NÃO POSSUI NENHUM PARAMETRO DE ENTRADA!

Exemplo: http://192.168.115.42/integracao?method=GetMotivosPausa&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	ListaChamadasGeral

Sobre: Retorna lista das chamadas Entrantes/Saintes por período.

Retornos: XML & JSON

QUERY PARAMS/BODY

REQUIRED DATETIME	dataInicial	Informe um valor no formato: ddmmaaaa.

REQUIRED DATETIME	dataFinal	Informe um valor no formato: ddmmaaa.

Exemplo: http://192.168.115.42/integracao?method=ListaChamadasGeral&dataInicial=05102024&dataFinal=05102024&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET

status

Sobre: Retorna lista das chamadas Entrantes/Saintes por período.

Retornos: XML & JSON

QUERY PARAMS/BODY

REQUIRED DATETIME	dataInicial	Informe um valor no formato: ddmmaaaa.

REQUIRED DATETIME	dataFinal	Informe um valor no formato: ddmmaaa.

Exemplo: http://192.168.115.42/integracao?method=status&dataInicial=05102024&dataFinal=05102024&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	ListaChamadasFila

Sobre: Retorna lista das chamadas \"Entrantes/Saintes\" por período.

Retornos: XML & JSON

QUERY PARAMS/BODY

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.

Exemplo: http://192.168.115.42/integracao?method=ListaChamadasFila&dataInicial=05102024&dataFinal=05102024&dac=90&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET

MeuIP

Sobre: Retorna o IP.

Retornos: XML & JSON

QUERY PARAMS/BODY

ESTE MÉTODO NÃO POSSUI NENHUM PARAMETRO DE ENTRADA!

Exemplo: http://192.168.115.42/integracao?method=MeuIP&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET

Callback

Sobre: Retorna para o número informado, é necessário passar o Ramal de Origem

Retornos: XML & JSON

QUERY PARAMS/BODY

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.

Exemplo: http://192.168.115.42/integracao?method=Callback&numeroDiscar=36844900&ramal=1001&destino=5000&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	LigueGratis

Sobre: Retorna para o número informado.

Retornos: XML & JSON

QUERY PARAMS/BODY

REQUIRED INTEIRO	numeroDiscar	Número de telefone com DDD.

Exemplo: http://192.168.115.42/integracao?method=LigueGratis&numeroDiscar=36844900&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	ListaAgentes

Sobre: Retorna uma lista com os Agentes Disponíveis!

Retornos: XML & JSON

QUERY PARAMS/BODY

ESTE MÉTODO NÃO POSSUI NENHUM PARAMETRO DE ENTRADA!

Exemplo: http://192.168.115.42/integracao?method=ListaAgentes&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	ListaDacsAgente

Sobre: Retorna uma lista com os DACS disponíveis para o Agente Autenticado!

Retornos: XML & JSON

QUERY PARAMS/BODY

REQUIRED STRING	agente	Agente autenticado no Sistema.

Exemplo: http://192.168.115.42/integracao?method=ListaDacsAgente&agente=nomeAgente&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	ListaDacsMatricula

Sobre: Retorna uma lista com os DACS disponíveis para o Agente Autenticado!

Retornos: XML & JSON

QUERY PARAMS/BODY

REQUIRED STRING	matricula	Matrícula de um agente.

Exemplo: http://192.168.115.42/integracao?method=ListaDacsMatricula&matricula=1000&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET

ListaDacs

Sobre: Retorna uma lista com os Dacs disponíveis.

Retornos: XML & JSON

QUERY PARAMS/BODY

ESTE MÉTODO NÃO POSSUI NENHUM PARAMETRO DE ENTRADA!

Exemplo: http://192.168.115.42/integracao?method=ListaDacs&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	ListaAbandonadasPeriodo

Sobre: Retorna uma listagem das chamadas abandonadas por período.

Retornos: XML & JSON

QUERY PARAMS/BODY

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

Exemplo: http://192.168.115.42/integracao?method=ListaAbandonadasPeriodo&dataInicial=05102024&dataFinal=05102024&DAC=SUPORT&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	TarifaPeriodo

Sobre: Tarifação dos Ramais por periodo! Idenficadores de Registro: [ # - Tarifa Zero ] [ ** - Franquia ] [ * - Franquia Parcial]

Retornos: XML & JSON

QUERY PARAMS/BODY

REQUIRED DATETIME	dataInicial	Informe um valor no Formato: ddmmaaaa.

REQUIRED DATETIME	dataFinal	Informe um valor no formato: ddmmaaa.

Exemplo: http://192.168.115.42/integracao?method=TarifaPeriodo&dataInicial=05102024&dataFinal=05102024&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	TarifaRamal

Sobre: Tarifação dos Ramais por periodo! Idenficadores de Registro: [ # - Tarifa Zero ] [ ** - Franquia ] [ * - Franquia Parcial]

Retornos: XML & JSON

QUERY PARAMS/BODY

REQUIRED DATETIME	dataInicial	Informe um valor no Formato: ddmmaaaa.

REQUIRED DATETIME	dataFinal	Informe um valor no formato: ddmmaaa.

Exemplo: http://192.168.115.42/integracao?method=TarifaRamal&dataInicial=05102024&dataFinal=05102024&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	Transferir

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.

Retornos: XML & JSON

QUERY PARAMS/BODY

REQUIRED INTEIRO	numeroDiscar	Número de telefone.

Exemplo: http://192.168.115.42/integracao?method=Transferir&numeroDiscar=36844900&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	TransferePesquisa

Sobre: Transfere uma chamada para uma pesquisa cadastrada no sistema!

Retornos: XML & JSON

QUERY PARAMS/BODY

REQUIRED STRING	matricula	Matrícula de um agente.

REQUIRED INTEGER	pesquisaId	Informe o id da pesquisa.

Exemplo: http://192.168.115.42/integracao?method=TransferePesquisa&matricula=1000&pesquisaId=2&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML

GET	ValidaRamal

Sobre: Verifica se o ramal está cadastrado na base de dados.

Retornos: XML & JSON

QUERY PARAMS/BODY

REQUIRED INTEIRO	ramal	Número do ramal para atendimento no dac.

Exemplo: http://192.168.115.42/integracao?method=ValidaRamal&ramal=1003&SIPID=ce7cc417215201504fc759fede2072e4&tipoRetorno=XML