API Telefonia
- Carina Soca
- Rodrigo Monteiro (Voice Engineering)
Aqui, podemos encontrar todas as informações relevantes para as ações de telefonia que podem ser executadas por meio de nossa API.
Lembre-se de que, para usar a API, você precisa:
Autenticar e obter um token para a sessão.
Usar o token na autorização do cabeçalho.
Encerrar a sessão.
Conteudo
Chamadas
Com as chamadas, podemos encontrar as seguintes ações disponíveis
Realizar Chamadas
URL relativo: Integra/resources/Agents/AgentCall
Method: POST
content-type:application/x-www-form-urlencoded; charset=UTF-8
Parâmetros: callerid (número do remetente com o qual a chamada será feita)
agent (Nome do agente que gera a chamada)
phone (Telefone do agente que gera a chamada)
tech (Geralmente SIP)
context (Contexto do agente configurado no uContact)
outqueue (Nome da campanha de saída para computar a chamada)
destination (Número de destino)
Result: TEXT (Guia da chamada gerada)
0 se houver erro
Essa é uma chamada em duas etapas, que chamará o agente e, quando for atendida (ou atender automaticamente), a chamada final será gerada,
a chamada final é gerada.
Realizar Chamada via proxy
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/porthole/1.0.0/porthole.js"></script>
<script type="text/javascript">
function Call () {
var windowProxy;
windowProxy.addEventListener(onResponse);
windowProxy = new Porthole.WindowProxy(window.location.protocol + window.location.hostname);
windowProxy.post({'action': 'call', 'campaign' : '<CAMPAIGN>', 'callerid' : '<CALLERID>', 'destination' : '<NUMBER>'});
}
function onResponse(messageEvent) {
response = messageEvent.data.guid; //retorna id único de llamada
}
</script>
Realizar Chamada passando Dados para o Workflow
https://dominio.ucontactcloud.com/Integra/resources/Agents/AgentCallwithData
Método: POST
content-type:application/x-www-form-urlencoded; charset=UTF-8
Parâmetros: callerid (Número com o qual a chamada está sendo feita)
agent (Nome do agente que está gerando a chamada)
phone (Número de telefone do agente)
tech (Geralmente SIP)
context (Contexto do agente configurado no uContact)
outqueue (Nome da campanha para computar a chamada)
destination (Número de destino)
data (dados a serem enviados para o fluxo de trabalho, geralmente um JSON que pode ser passado para variáveis com a atividade JSON dentro do fluxo)
form (Nome do formulário ou URL para o pop-up)
Resultado: TEXTO (Orientação de chamada gerada)
0 Erro
É uma chamada em duas etapas: o agente é chamado e, quando ele atende ou atende automaticamente, a chamada final é gerada.
Realizar Chamada diretamente pelo telefone
Essa função permite que você faça uma chamada diretamente usando o telefone do portal.
A única maneira de usá-la é via proxy, porque a comunicação é com o portal uContact.
HungUp(Encerrar) Chamada
HungUp(Encerrar) via Proxy
Tipificar Chamadas
Respostas de WS
Blacklist
Objeto de blacklist
Adicionar número a Blacklist
Adicionar varios números a Blacklist
Eliminar numero de Blacklist
Eliminar varios numeros de Blacklist
Gravacções
Obter gravações de Chamadas
Objeto Json
Resposta
Converter gravações
Tag de gravação
Vía Proxy
Marcadores/Discadores
Ações do dispositivo
CTI
Esse objeto JSON é encontrado no LocalStorage e criptografado. Ele contém as informações da chamada atendida e, se for de um discador, todas as informações do próximo telefone alternativo para o Respool.
Dialer: Campanha, número principal, status (sempre 1), dados (parâmetros e valores para o Workflow (fluxo de trabalho)), alternativas (com :), novas tentativas (para esse número principal), contato (ID contato) , base de discagem, prioridade, agentphone.
Converta esses dados para o Objet Respool mostrado abaixo.
O que podemos fazer com o Objet Respool?
Alterar o número principal e os alternativos e reordená-los.
Alterar as tentativas para o número principal (por exemplo, se usarmos um número alternativo como principal, definiremos as tentativas como 0).
Alterar prioridades.
Adicionar dados ou alterá-los para o fluxo de trabalho.
agentphone, se progressivo, podemos atribuí-lo a outro agente.
Vía Proxy
Defina em sua página
Chamada Respool
Objeto Json
Via Proxy
Agendar Chamada
Objeto Json
Via Proxy
Tareas Marcadores
Ejemplos para cada modo:
Agregar marcador con prioridad 1
Crear llamada manual en el momento
Agregar llamada al marcador
Agendar llamada para marcador
Borrar Contacto del Dialer
Borrar Agenda del Marcador
Parámetros: campaña, el número, fecha desde y fecha hasta (formato YYYY-MM-DD hh:mm:ss) para poder borrar por fecha.
Subir Bases
La API nos da la posibilidad de subir las listas de marcadores con parámetros o con timezone para que sea utilizada la más adecuada a sus necesidades.
Subir base de llamadas
Formato del archivo
Subir base de llamadas con zona horaria
Formato del archivo
Información de Campañas
También puede obtener la información de las campañas de voz.
Resumen de campañas
Para ver resumido el estado de las campañas del sistema, existe el siguiente método:
Respuesta
Estado de Campañas
En cambio si queremos obtener toda la información de las campañas del sistema, podemos usar este otro método:
Respuesta
Para obtener la información de los agentes junto con las estadísticas de la campaña, para una campaña en específico, existe el siguiente método. Es la misma ruta que el anterior, pero se le especifica el nombre por parámetro.
Además de devolver el objeto con información de la campaña, también se devuelve el objeto de cada agente perteneciente a ella.
Respuesta
Códigos de estado de los agentes
Colección de postman con algunas de las llamadas.
