b. Integra Framework

UC_exec

(sqlquery,dsn,callback)

Executes SQL query on the database (INSERT, UPDATE, DELETE), can or cannot have a callback.

sqlquery: INSERT UPDATE or DELETE.

dsn: Name of the data source, empty uses CCREPO Database.

callback: Null or name of the function to execute on completion.

value: If this value is true, the callback will give you the result from the database, otherwise it will give you OK or ERROR

UC_exec_async

Structure: (sqlquery, dsn)

Executes SQL query on the database (INSERT, UPDATE, DELETE)

sqlquery: INSERT UPDATE or DELETE.

dsn: Name of the data source, empty uses CCREPO Database.

value: If this value is true, the callback will give you the result from the database, otherwise it will give you OK or ERROR

UC_Save

(object,table,dsn,callback)

Saves an object of a table in the database.

object: Javascript object to save (identical to destination table).

table: Name of the destination table.

dsn: Name of the data source, empty uses CCREPO Database.

callback: Null or name of the function to execute on completion.

UC_Save_async

Structure: (object, table, dsn)

Saves an object of a table in the database.

object: Javascript object to save (identical to destination table).

table: Name of the destination table.

dsn: Name of the data source, empty uses CCREPO Database.

UC_fullSelect

(solochosen,idSelect,objetoSelect, chosen,atributo,parse)

Fills a comboBox or listBox with data from a query.

solochosen: If this parameter is 0 initialize the chosen with the objects passed in objetoSelect. If 1 use the html values and initlize with .chosen().

idSelect: Id of the html (out comboBox).

objetoSelect: List of values or objects:

Example values: ["ACOMP-BLESS->","campanaParaTestBeto<-"]

Example objects: [{"departamento":"ARTIGAS"},{"departamento":"CANELONES"}]

chosen: If 1 the function .chosen() is applied initialize the comboBox,if 0 loads the html of the select with options of objetoSelect but doesnt apply .chosen(), does not initialize.

attribute: If specified an attibute means that the objetoSelect has the form of a list of objects so the values displayed on our control is the content of the name of that attribute. Example 'departamento' to fill with ARTIGAS, CANELONES.

parse: If 1 JSON.parse is applied to objetoSelect asumes is passed as a String, if 0 assumes that in an array of values or array of objects.

UC_fullTable

(idTabla,datosParaLlenar, stringDatos,onSelected,scroll,dataFormat,bColum,bOrder,bfilter,pagination,multipleSelect,onDeSelected)

Puts all the data into the table.

idTabla: Id of the tag <table> in our html.

datosParaLlenar: List in String format used to load the table.

Example: [{"id":1,"documento":"","nombres":"Casanova Barreiro Rossana Haydee","departamento":""...

 stringDatos: Names of the filed that we want to show int our column table. Separated by coma (,).

onSelected: Function executed when you select a row of the table,has a parameter that returns the objet of the selected row.

Example: function metodoOnSelectedSample(resp){

//Resp has the object in string format as we pass in the datosParaLlenar

}

scroll: Height in pixels of the table. Ej: '100px'.

dataFormat: Format of the Dates so the table can order the datatype correct, example : 'MM/DD/YYYY'.

bColum, bOrder: This parameters are to order via a particular column asc or desc, passing as an integer the number of the column to order and if desc or asc.

Example:

Second column descendent: 1,"desc"

pagination: Boolean. True to make the pagination of a table. 

multipleSelect: null or 1 as integer for multiple row select.

onDeSelected: null or function(a) to return the object of the selected row.

UC_addPagination

(idTabla)

Add pagination to a table.

This method adds two buttons, Previous and Next for pagination porpoises.

The user has to define the methods for the behavior of the buttons: the ids are idTabla_anterior, idTabla_siguiente.

Via javascript and jQuery:

$('#idTabla_anterior').click(function(){...});

and

$('#idTabla_siguiente').click(function(){...});

idTabla: Id of the html table.

UC_update

(json, tablename, column, dsn, callback)

Update Data.

obj: Object with the new data.

tablename: Name of the table to update.

column: Name of the column to update from usually the table PK.

dsn: Name of the data source, empty uses CCREPO Database.

callback: Null or name of the function to execute on completion.

UC_update_async

Structure: (json, tablename, column, dsn)

Update Data.

obj: Object with the new data.

tablename: Name of the table to update.

column: Name of the column to update from usually the table PK.

dsn: Name of the data source, empty uses CCREPO Database.

UC_delete

(tablename, column, value, valuetype, dsn, callback)

Deletes an object.

tablename: Name of the table to delete from.

column: Name of the column that we are going to make the delete usually the PK.

value: Value of the selected column to delete.

valuetype: Datatype of the value of the column to delete: int, string.

dsn: Name of the data source, empty uses CCREPO Database.

callback: Null or name of the function to execute on completion.

UC_delete_async

Structure: (tablename, column, value, valuetype, dsn)

Deletes an object.

tablename: Name of the table to delete from.

column: Name of the column that we are going to make the delete usually the PK.

value: Value of the selected column to delete.

valuetype: Datatype of the value of the column to delete: int, string.

dsn: Name of the data source, empty uses CCREPO Database.

UC_get

(sqlquery,dsn,callback)

Get data from a SQL SELECT query.

sqlquery: SELECT sql.

dsn: Name of the data source, empty uses CCREPO Database.

callback: Null or name of the function to execute on completion.

UC_get_async

Structure: (sqlquery,dsn)

Get data from a SQL SELECT query.

sqlquery: SELECT sql.

dsn: Name of the data source, empty uses CCREPO Database.

UC_makeCall

(campaign,source, destination,callback)

Makes a call.

campaign: Outbound campaign to compute this call to.

source: Oublound DID for this call (number seen by the client).

destination: Number to call.

callback: Null or name of the function to execute on completion.

UC_makeCall_async

Structure: (campaign,source, destination)

Makes a call.

campaign: Outbound campaign to compute this call to.

source: Oublound DID for this call (number seen by the client).

destination: Number to call.

UC_hangUp

(callback)

Hangup the actual call.

callback: Null or name of the function to execute on completion.

UC_hangUp_async

Structure: ()

Hangup the actual call.

Hang up the call, if the caller id passed by argument is the same that the actual call, otherwise nothing will happen

- callerid

- callback

- callerid

UC_pause

(boolean)

Pause or UnPause an agent.

It will not UnPause the agent if it is on a break.

boolean: true or false.

function: callback function

UC_sendSms

(phone,message)

Sends SMS.

phone: Destination.

message: Text.

UC_sendMail

(fromname, to, subject, body)

Sends an Email with the system account.

fromname: Name of the From.

to: Destination email.

subject: Subject.

body: Text can be plain or html.

UC_sendMailCampaignv2

{
    "campaign": "Email",
    "to": "adress@ucontactcloud.com",
	"cc":"example@example.com",
    "cco":"example@example.com,example2@example2.com",
    "subject": "Subject",
    "body": "This is an email body can be HTML",
	"attachments": ["020212/738hbjk-h73894algo.jgp", "020212/738hbjk-h73894algo.jgp"],
    "reports":["<generated_report_guid>.pdf"],
    "schedule": {
        "title": "Date title",
        "organizer": "Myself",
        "from": "2018-08-24 00:00:00",
        "to": "2018-08-24 01:00:00"
    }
	"template": "templateName",
	"variables": {
		"var1":"value",
		"var2":"value2"
	}
}

Attachments are optional. It will be a list of strings. Each string returned by the function addAttachment.

Reports field is optional. It will be an array of guid reports with its extension.

Upload any type of file to the server

file: File object javascript

id (optional): used to recognize the file in the response

Response: ["20190513/a6d9f3c6-9574-44ca-8b6f-ec02e2c977d1.filename.txt", "1234"]

the first string is the file's path on the server.

the second string is the id 

Send message with hey now api. This method uses the provider previously configured

{
	"clientId": "598112321323",
	"message": "Hola",
	"providerName": "HeyNowProviderName"
}

UC_getAgents

(callback)

Get agents in the callback in json format.

UC_getAgents_async

Structue: ()

Get agents in the callback in json format.

UC_getSystemCampaigns

(callback)

Get campaings in the callback in json format.

UC_getSystemCampaigns_async

Structure: ()

Get campaings in the callback in json format.

UC_getMyAgentCampaigns

(callback)

Get agents of my campaings in the callback in json format.

UC_getMyAgentCampaigns_async

Structure: ()

Get agents of my campaings in the callback in json format.

UC_getMySuperCampaigns

(callback)

Get campaigns if Im a supervisor in the callback in json format.

UC_getMySuperCampaigns_async

Structure: ()

Get campaigns if Im a supervisor in the callback in json format.

UC_getAgentForCampaign

(campaign,callback)

Get agents of an specific campaign in the callback in json format.

UC_getAgentForCampaign_async

Structure: (campaign)

Get agents of an specific campaign in the callback in json format.

UC_subirArchivoCSV

(archivo, tabla,sentence,callback)

Upload a CSV file to a database table.

archivo: Obtained from an upload

tabla: Destination table.

sentence: If changes are required (check MYSQL LOAD IN FILE syntax).

callback: Null or name of the function to execute on completion, returns the result.

UC_subirArchivoCSV_async

Structure: (archivo, tabla, sentence)

Upload a CSV file to a database table.

archivo: Obtained from an upload

tabla: Destination table.

sentence: If changes are required (check MYSQL LOAD IN FILE syntax).

UC_generateReport

UC_closeForm

UC_ShowXForm

UC_setChannelVariable

(variable, value, callback)

Sets a variable to an active call.

variable:Name of the value.

value: Value.

callback: Returns.

UC_setChannelVariable_async

Structure: (variable, value)

Sets a variable to an active call.

variable:Name of the value.

value: Value.

UC_TagRecord

(guid, data) 

Tag a recording so we can search for that value on Recordings.

guid: Id of the call from CTI object.

data: Text to tag it.

UC_respool

(objetoRespool, callback)

Respool for a Dialer call when you havent reach the client you wanted. is possible to add the next phone of the contact to the dialer altough was an answered call.

 objetoRespool: Object of the type UC_DialerObject (check function).

callback: Response of the function.

UC_respool_async

Structure: (objetoRespool)

Respool for a Dialer call when you havent reach the client you wanted. is possible to add the next phone of the contact to the dialer altough was an answered call.

 objetoRespool: Object of the type UC_DialerObject (check function).

UC_DialerObject

(dialer)

Returns an object type calls_spool (dialer table), so we can make a respool or dialer schedule.

dialer: String of the attribute Dialer in the CTI object.

UC_replaceAll

(str, find, replace)

Replace all occurrences of a string.

str: Original String.

find: String to find.

replace: What to replace with.

Returns changed String.

UC_generateNamedReport

UC_DialerSchedule

(callDate, objectDialer, callback)

Schedule a call for a Dialer in a determinated date for a campaign and destination.

callDate: Datetime for the schedule call.

objetDialer: Object UC_DialerObject with the Dialer String of the CTI object ,

callback: Response of the function.

UC_DialerSchedule_async

Structure: (callDate, objectDialer)

Schedule a call for a Dialer in a determinated date for a campaign and destination.

callDate: Datetime for the schedule call.

objetDialer: Object UC_DialerObject with the Dialer String of the CTI object.

notification

(title, message, icon, type)

Shows a message to the user.

title: Title of the notification.

message: Message of the notification.

icon: Fontawesome string for icon.

Example:"fa fa-times"(error),"fa fa-check"(success),"fa fa-warning"(warning)

type: Type of the notification.

-Example:"danger"(error),"success"(success),"warning"(warning)

UC_audit

(audit)

Audits actions of the user.

Adds a record to ccrepo.auditory with user and IP.

UC_goToTab

(idTabPane)

Go to other tab of the Form.

idTabPane: Tab-pane id we want to show.

UC_generateGraphic

(idContenedor, datos, tipo,titulo, colores, tamano)

Genete charts.

idContenedor: If of the chart container.

datos: Array of the data for the chart.

tipo: Chart type if lineal null else pie, donut, bars.

titulo: Title for a donut chart else null.

colores: Array of colors in hexadecimal (['#2334','#45454']).

tamaño: Size in pixels of the chart ('240px') else null takes the size of the container.

await UC_Http_proxy({
	url: 'https://api-mirror.herokuapp.com/', 
	method: 'POST', 
	headers:{'authorization': 'header1'}, 
	body: '{}', 
	type: 'application/json'
})

Response example

{
	body: "the body response",
	code: "200", //401, 504 etc
	headers: {
		content-type: ['application/json'],
		server: ['gunicorn/19.7.1']
	}
}

UC_ExecPost

(url, data, callback)

Executes a POST webService from our domain.

url: Pass the url of the web service .

data: If the web service expects parameters, you must pass on data. 

calback : Return.

header: Array containing list of headers

UC_ExecPost_async

Structure: (url, data)

Executes a POST webService from our domain.

url: Pass the url of the web service .

data: If the web service expects parameters, you must pass on data. 

UC_ExecPostSOAP

(url, body, callback)

Executes a SOAP action from a web service

url: URL of the soap action, including the action name

body: XML of the soap request

callback : Return.

headers : Headers to include in the http request

UC_ExecPostSOAP_async

Structure: (url, body)

Executes a SOAP action from a web service

url: URL of the soap action, including the action name

body: XML of the soap request

headers : Headers to include in the http request

UC_GM_LoadActions

(measure, actions, callback)

Executes a Gamification WebService that allows to add points to the agent.

measure: Name of the measure

actions: Ammount of actions to credit (it will be multiplied with the measure to calculate the points)

callback: Return.

UC_GM_LoadActions_async

Structure: (measure, actions)

Executes a Gamification WebService that allows to add points to the agent.

measure: Name of the measure

actions: Ammount of actions to credit (it will be multiplied with the measure to calculate the points)

UC_openForm

(name, ctiObj)

Open new form with the name given 

name: Form name

ctiObj: Null or cti object

UC_Encrypt

text: Text to encrypt

Encrypts the string passed by parameter and returns an object. You can save that object and decrypt it later or you can get the object value by executing obj.toString() 

UD_Decrypt

text: Text or object to decrypt

Decrypts the object returned by the encrypt funcion or the value obtained by excuting obj.toString()

UC_Add_Blacklist

Adds a contact to blacklist

Recibes: Json object with contact data, callback.

UC_Remove_Blacklist

Removes a contact from blacklist

Recibes: Json object with contact data, callback.

UC_RemoveContactDialer

Removes a contact for the dialer of a given campaign

Recibes: Campaign and number

If * is the campaign value, the system will remove the contact for all campaigns.

UC_RemoveContactScheduler

Removes a contact for the scheduler of a given campaign

Recibes: Campaign and number

If * is the campaign value, the system will remove the contact for all campaigns.

Uploads a dialer list

campaign: name of campaign

name: name of list

list: Array[] of Objects{}

callback (optional): response of function

Example of list array:

var list=[{campaign:"campaignTest<-",destination:"099111111",data:"variable1=val1:variable2=val2",alternatives:"099222222:099333333",priority:"9999",agent:"Agent1"},{campaign:"campaignTest<-",destination:"213123",data:"variable1=val1",alternatives:"213213:123123",priority:"1233"}]

Use:

Function download a CSV file is used for files that show the rise format CSV file.

textToWrite: Text that you want to give as an example in the CSV file.

idbtnCSV: Button identifier The same should be written between '', example 'idButton'.

<a id="btnBuscar" class="btn btn-primary" style="width: 100%;height: 100%;color:white;padding:0px;background-color: rgba(0, 0, 0, 0.3);" name="btnBuscar">
       <span data-fa="fa"></span> 
       <span class="btnText">Buscar</span>
</a>

This function mutes or unmute the recording according to the value receive in the parameter

Structure (value)

Value: 0 or 1, 1 for muting, 0 for unmuting

Starts a new mix monitor on the channel

Structure: (complete_path, callback)

callback: retrieves the mix monitor id.

Complete_path: complete path location of the file (including name)

Stops a previously started mix monitor (UC_StartRecording)

Structure: (idMix)

IdMix: Mix monitor id to be stopped. Obtained from UC_StartRecording