Versions Compared

Old Version 16

changes.mady.by.user Test Integra

Saved on

compared with

New Version 17

changes.mady.by.user Luna Gil

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Image RemovedWith Image Added

See the different possibilities that our API offers you can to integrate uContact with other external systems.

Info
To

In order to use the API you need:

  1. Authenticate and get a token for the session.

  2. Use the token in the Authorization Header

AuthorizationEnd session

  1. .

  2. Log out.

Tip

It is recommended to create a user that is exclusively

for

to use with the uContact API.

API Omnichannel

API Telephony

API Other Actions

API Gamification

DataBases

Examples

Image Removed

Prior to making any of the queries to the web services it is necessary to obtain the APIkey through the Login.

To do
Image Added

Foremost, we need to get APIkey. For this, we

will

use the

UserLogin

getUserToken service

and enter

with a valid SuperUser username and

super user

password.

ExpandtitleClick here to expand UserLogin

getUserToken Service

User

Code Block
Relative URL: 
https://dominio.ucontactcloud.com/Integra/resources/auth/
UserLogin
getUserToken
Method: POST
content-type:application/x-www-form-urlencoded; charset=UTF-8
Params
Parameters: user
password
Result:
JSON Code BlockWhere
Md5secret
is
password
the APIKey or if it has no phone will have it on the 3rd item of the List If error Response is 0Supervisor
Answer: JSON

Supervisor without phone

At the end of the list

Code Block
[ ...
    "QWRtaW46OTgzNWM1MjUtMzU2Ny00YjgyLWEwYWYtY2NkMjNlMDhjNzA3"
]
Si
If it
es
is Error
Respuesta
Answer 0
ExpandtitleClick here to expand jQuery example code

Example code for jQuery

Code Block
$.ajax({
  type: 'POST', 
  url: 'https://
<ucontactinstance>
domain.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
Image Added

Once you have your login token

we will see

, let's move on to how to use it in

API

API queries:

JQuery

  • jQuery can be configured to use the token

in each

  • on every request.

  • If not, it can be specified in the headers in each request that is made.

ExpandtitleClick here to expand example configuration in jQuery

jQuery configuration example

Code Block
$.ajaxSetup({
  headers: {
    'Authorization': "Basic " + APIKey
  }
});
ExpandtitleClick here to expand example of token in authorization header

Token example in request headers

Code Block
$.ajax({
    type: 'POST',
    url: 'https://
<ucontactinstance>
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
Image Added

After using the API, it is necessary to end the session.

This

In this way, we will avoid security problems by disabling the token generated

in

at the start login

of the startup

.

Expand
titleClick here to expand and see the method
Code BlockRelative URL:

Method

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
ExpandtitleClick here to expand example 
Example code for jQuery
 code
 Code Block
$.ajax({
    type: 'POST',
    url: 'https://
&lt;ucontactinstance>
domain.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) => {}
});
Aditional Iinformation
Relevant information
 Note
  • All WebServices are REST type.
  • Only uContact uses https by default (http2) is used for security, a valid certificate *.ucontactcloud.com is provided
CrossDomain Connection
With the Windows proxy window , we can handle events of an iframe inserted in a form, to be able , for example, to make do dispositions, hang up the call, close the form, or whatever is desired.
you want, for example. To do this you don't need any plugin.
 ExpandtitlePrevious Steps
, no plugin is needed.
Previous steps
In the form you must put
 this
:
 Code Block
languagejs
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 can be used to identify what type the 
 type of 
 action is.
And the disposition attribute is used as an object to send more information.
expand
title
How to invoke 
 the event
it?
The way to invoke 
 the event would be the following
it is:
 Code Block
languagejs
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}, '*');
You may also be interested 
 ...
in:
 

Upload dialer base
 

Webcallback
 

Recordings
 
Postman collection for the Login and Logoff.
 View file
nameAPI Security.postman_collection.json