Image Removed

Image Added

Vea las diferentes posibilidades que le brinda nuestra API para integrar a uContact con sistemas externos.

Info

Para poder usar la API se necesita.

Autenticarse y obtener un token para la sesión.
Usar el token en el Header Authorization.
Finalizar sesión.

Tip
Se recomienda crear un usuario que sea exclusivamente para utilizar con la API de uContact.

Contenido

Table of Contents

maxLevel	2

Image Removed

Image Added

Ejemplos

Image Removed

, para utilizaremos UserLogin expand

title

Servicio

UserLogin

getUserToken

[ ... { .... "md5secret": "Q2FyaW5hOjI3YzdjNWM5LTkzYzQtNDYyMi1iYzg2LTlkMmNkMGVjNWEzMA==", .... } ]

Code Block

https://dominio.ucontactcloud.com/Integra/resources/auth/

UserLogin

getUserToken
Método: POST
content-type:application/x-www-form-urlencoded; charset=UTF-8
Parámetros: user
            password
Resultado: JSON

Supervisor con teléfono

Md5secret es la APIKey

Code Block

Supervisor sin teléfono

Al final de la lista

Code Block
[ ... "QWRtaW46OTgzNWM1MjUtMzU2Ny00YjgyLWEwYWYtY2NkMjNlMDhjNzA3" ] Si es Error Respuesta 0
Expand
title

Código de ejemplo para jQuery

Code Block

$.ajax({
  type: 'POST', 
  url: 'https://dominio.ucontactcloud.com/Integra/resources/auth/

UserLogin

getUserToken',
  contentType: 'application/x-www-form-urlencoded; charset=UTF-8',
  dataType: 'text',
  data: {
    user: 'ExampleUsername',
    password: 'ExamplePassword'
  },
  success: (resp) => {},
  error: (resp) => {}
});

Image Removed

Expandtitle

Ejemplo de configuración de jQuery

title

Code Block
$.ajaxSetup({ headers: { 'Authorization': "Basic " + APIKey } });
Expand

Ejemplo de token en headers de peticiones

Code Block

$.ajax({
    type: 'POST',
    url: 'https://dominio.ucontactcloud.com/Integra/resources/any/request',
    contentType: 'application/x-www-form-urlencoded; charset=UTF-8',
    dataType: 'text',
    headers:{
        'Authorization': 'Basic <APIKey>'
    },
    data: {
        param1: 'exampleParam1',
        param2: 'exampleParam2'
    },
    success: (resp) => {},
    error: (resp) => {}
});

Image Removed

Expandtitle

Método

Code Block
https://dominio.ucontactcloud.com/Integra/resources/auth/EndSession Method: POST content-type:application/x-www-form-urlencoded; charset=UTF-8 Params: user token Result: 1 OK 0 ERROR
Expand
title

Código de ejemplo para jQuery

Code Block

$.ajax({
    type: 'POST',
    url: 'https://dominio.ucontactcloud.com/Integra/resources/auth/EndSession',
    contentType: 'application/x-www-form-urlencoded; charset=UTF-8',
    dataType: 'text',
    headers:{
        'Authorization': 'Basic <APIKey>'
    },
    data: {
        user: 'ExampleUser',
        token: '<token>'
    },
    success: (resp) => {},
    error: (resp) => {}
});

Información relevante

Note
Todos los WebServices son de tipo REST uContact usa https por defecto (http2)

Image Removed

Image Added

Conexión CrossDomain

Con el window Windows proxy podemos manejar eventos de un iframe insertado en un formulario, para poder por ejemplo hacer tipificaciones, colgar la llamada, cerrar el formulario o cualquier cosa que se desee.
Para realizar esto no se necesita ningún plugin.

Expandtitle

Pasos previos

En el formulario se debe poner

esto

:

Code Block

language	js

window.addEventListener('message', event => {
    if (event.data.action === 'CLOSE_TAB') {
		parent.closeActiveTab(); 
	} else if (event.data.action === 'DISPOSITION_CALL') {
		let dataDisp = event.data.disposition;
		UC_DispositionCall(dataDisp.campaign, dataDisp.callerid, dataDisp.guid, dataDisp.l1, dataDisp.l2, dataDisp.l3, dataDisp.d1, dataDisp.d2, dataDisp.comment, dataDisp.schedule, callbackDiposition, errorDiposition);
	}   
});

event.data se puede usar para identificar de qué tipo es la acción.

Y el atributo disposition se usa como un objeto para mandar más información.

Expand

title	Cómo Invocarlo

¿Cómo invocarlo?

La manera de invocarlo

sería la siguiente

es:

Code Block

language	js

let dataDisp = {
	 campaign: '

CampanaTest

CampañaTest',
	 callerid: '123456Test',
	 guid:'3123-3123-3123-312-3123',
	 l1:'nivel1',
	 l2:'nivel2',
	 l3:'nivel3',
	 d1:'data1',
	 d2:'data2',
	 comment:'ComentarioTest',
	 schedule:'2019-05-04 15:55:55'
};

window.parent.postMessage({ action: 'DISPOSITION_CALL', disposition:dataDisp}, '*');

Creación de tokens

Los usuarios con rol "SuperUsuario" en uContact tienen la funcionalidad de crear tokens para ser utilizados fuera de la aplicación. Para crear un token seguir los siguientes pasos:

Acceder al menú de usuario.
Image Added
Seleccionar la opción de "API tokens" en el menu desplegado y se abrirá un modal para su creación.
Image Added
Ingresar el nombre con el que quiere identificar el token y haga clic en el botón "Agregar" para crear un nuevo token.
Image Added
Una vez que se ha creado un token en uContact, los “SuperUsuario” tienen la posibilidad de compartirlo con otros usuarios. Para hacerlo, es necesario hacer clic en el icono del clip. De esta manera, el token se copiará automáticamente en el portapapeles y podrá ser enviado a cualquier persona con la que se desee compartir.

Links de interés

Image Removed

Image Added

Colección de postman para el inicio y cierre de sesión.

View file

name	API Security.postman_collection.json

Versions Compared

Old Version 67

New Version Current

Key

API Omnicanal

API Telefonía

API Otras acciones

API Gamification

Base de Datos

Ejemplos

Servicio

getUserToken

Supervisor con teléfono

Supervisor sin teléfono

Código de ejemplo para jQuery

Ejemplo de configuración de jQuery

Ejemplo de token en headers de peticiones

Método

Código de ejemplo para jQuery

Información relevante

Conexión CrossDomain

Pasos previos

Creación de tokens

Links de interés

Subir base de llamadas

Webcallback

Uso de las grabaciones

Colección de postman para el inicio y cierre de sesión.

Page Comparison

Versions Compared

Key

Servicio

getUserToken

Supervisor con teléfono

Supervisor sin teléfono

Código de ejemplo para jQuery

Ejemplo de configuración de jQuery

Ejemplo de token en headers de peticiones

Método

Código de ejemplo para jQuery

Información relevante

Conexión CrossDomain

Pasos previos

Creación de tokens

Links de interés

Colección de postman para el inicio y cierre de sesión.