Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

Remember that to use the API you need

  1. Authenticate and get a token for the session

  2. Use the token in the Header Authorization

  3. End session

See more here…


Content

Table of Contents
maxLevel1
Image Removed

Expand
titleNotificate Agent

Notificate Agent

Code Block
Relative URL: Integra/resources/api/Notificate

Method: POST
content-type:application/x-www-form-urlencoded; charset=UTF-8

Params:  agent     (agent name)

		 queue     (campaign name)

		 message   (the message to be displayed to an agent)

		 icon      (fontaswome icon example: fa fa-exclamation-triangle)

		 when	  (always-> event if not connected leave the notification to be displayed on next login or online only notify if connected)

Result: OK      -> if agent notificated

		ERROR   -> if agent not notificated

Expand
titleGenerate Report

Generate Report

Code Block
Relative URL: Integra/resources/BI/generatereport

Method: POST
content-type:application/x-www-form-urlencoded; charset=UTF-8

Params:  report   (JSON Object)

         html     (0 or 1)

         excel    (0 or 1 or 2 for csv)

         pdf      (0 or 1)

         doc      (0 or 1 or 2 for txt)    

Result: GUID of the generated report

        Empty on Error

Json Object

Code Block
languagejs
{
"name":"Breaks Totales", //Name of the report 
"file":"TiemposPausaBreakePorAgente.jrxml", //  jrxml file
"description":"Breaks Totales", //Description
"dsn":"Repo", // Data source name
"parameters":"INITIAL_DATE=Timestamp=2015-11-03 00:00:00;FINAL_DATE=Timestamp=2015-11-03 3:59:59;REPORT_LOCALE=Locale=es;AGENT=Agent='Admin',,'Agente1','Agente10','Agente11',",
//Report parameters type and value for generation.
"grouped":"Agentes", //group
"language":"es", //language
"license":"CCS"
}


Report URL

Code Block
languagexml
http://Server/tmp/69d1f895-7f5f-42d6-9d84-dd7dad559304.pdf
 
Or the extension you generated xlsx, docx, pdf, csv, txt, html

Expand
titleClose Form

Close Form

From a uContact Form

Code Block
parent.closeActiveTab();

From Cross Origin iFrame

Note

To use this from a different origin of uContact we must create a proxy between the parent and the iframe. We use porthole, we define a proxy on each iFrame with a message parser, then from the iFrame we send the action close to the parent.

Add in your page

Code Block
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/porthole/1.0.0/porthole.js"></script>
<script type="text/javascript">
//for example on click when you want to close a tab
   function CloseTab () {
       var windowProxy;
       windowProxy = new Porthole.WindowProxy(window.location.protocol + window.location.hostname);
	    windowProxy.post({'action': 'close'});
   }

</script>
Expand
titleWebCallBack

WebCallBack

To make the WebCallBack possible to integrate with any web of any client, it was designed with a GET over HTTP, in this way anyone can invoke it.

Code Block
  URL: http://IP:PORT/Integra/resources/Utils/CallBack/phone={phone}&tecnology={tecnology}&context={context}&destination={destination}&priority={priority}

Method: GET
content-type:application/x-www-form-urlencoded; charset=UTF-8

Parameters:

Change the values between {} for the value.

  phone: client phone
  tecnology: dial string (example: DAHDI/G1/ or SIP/CARRIER/)
  context: context once the call is answered by the client
  destination: exten on the dialplan (usually a DID of a campaign)
  priority: step on the dialplan workflow

         

Result: 1 (Async)
Expand
titleExternal Workflow call

External Workflow call

Info

Allows to call a web servce that injects information into a voice dialplan allowing multiple actions by workflows

Code Block
Relative URL: Integra/resources/admin/CallWorkflow

Method: POST

content-type:application/x-www-form-urlencoded; charset=UTF-8

Params:    context       (incoming context of the flow)

           extension     (incoming extension of the flow) 

           jsonparams    (JSON Object)

Result:  OK

jsonparams object

Code Block
"{"Dato1":"xxxxx","Dato2":"yyyyy"}"