Class: IntegrationAPI

IntegrationAPI()

Component to send or receive data

Constructor

new IntegrationAPI()

Source:

Classes

IntegrationAPI

Methods

addMark()

Mark the call.

Source:
Tutorials:
  • Tutorial: CallControl

assistedDialACD(id)

Make an assisted call to an ACD.

Parameters:
Name Type Description
id string

ACD ID
Source:
Tutorials:
  • Tutorial: AssistedTransfer
Fires:
  • CORE_APIEvents#event:onError invalid status

assistedDialAgent(ext)

Make an assisted call to an agent.

Parameters:
Name Type Description
ext string

Agent extension
Source:
Tutorials:
  • Tutorial: AssistedTransfer
Fires:
  • CORE_APIEvents#event:onError invalid status

assistedDialNumber(phone)

Make an assisted call to an external number.

Parameters:
Name Type Description
phone string

Phone number to call
Source:
Tutorials:
  • Tutorial: AssistedTransfer
Fires:
  • CORE_APIEvents#event:onError invalid status

assistedXFerDropFirstCall()

Hang up the main call.

Source:
Tutorials:
  • Tutorial: AssistedTransfer
Fires:
  • CORE_APIEvents#event:onError invalid status

assistedXFerDropSecondCall()

Hang up the second call.

Source:
Tutorials:
  • Tutorial: AssistedTransfer
Fires:
  • CORE_APIEvents#event:onError invalid status

assistedXFerHangUP()

Hang up the second call.

Source:
Tutorials:
  • Tutorial: AssistedTransfer
Fires:
  • CORE_APIEvents#event:onError invalid status

assistedXFerLeaveConference()

Leave the conference and transfer the call to the main and second call.

Source:
Tutorials:
  • Tutorial: AssistedTransfer
Fires:

assistedXFerMakeConference()

Starts a conference between the main call, the second one and the agent. assistedXFerUseMainCall

Source:
Tutorials:
  • Tutorial: AssistedTransfer
Fires:
  • CORE_APIEvents#event:onError invalid status

assistedXFerTransferCalls()

Transfer main call to the second call.

Source:
Tutorials:
  • Tutorial: AssistedTransfer
Fires:

assistedXFerUseMainCall()

Select the main call, the second call remains on hold.

Source:
Tutorials:
  • Tutorial: AssistedTransfer
Fires:
  • CORE_APIEvents#onMainCall change to main call fires CORE_APIEvents#onError invalid statusevent:

assistedXFerUseSecondCall()

Select the second call and the main call remains on hold.

Source:
Tutorials:
  • Tutorial: AssistedTransfer
Fires:
  • CORE_APIEvents#event:onSecondCall change to the second call
  • CORE_APIEvents#event:onError invalid status

CallBackAcd(id, dispositionId, callId, dateCallback, phone, callKey, data1, data2, data3, data4, data5, existNum, subId)

Save disposition and reschedule call-in.

Parameters:
Name Type Description
id uint

ACD ID
dispositionId int

Disposition ID
callId int

Call ID
dateCallback string

Callback date yyyy/MM/dd HH:mm
phone string

Phone number to callback
callKey string

ID provided by the client
data1 string

Value is saved in the field: data1
data2 string

Value is saved in the field: data2
data3 string

Value is saved in the field: data3
data4 string

Value is saved in the field: data4
data5 string

Value is saved in the field: data5
existNum boolean

Determine which number will be dialed (true:The one assigned in the phone parameter, false:The number already exists in the system).
subId int

Sub disposition ID (If it does not exist, assign the value of zero).
Source:
Tutorials:
  • Tutorial: InboundDispositions
See:
  • getPhoneNumbers
Fires:
Examples
CallBackAcd(1, 1, 1200, "2023-02-01 09:00", "0011223344", "5845", "data1", "data2", "data3", "data4", "data5", false , 1); // Telephone number do not exists in the system.
CallBackAcd(1, 1, 1200, "2023-02-01 09:00", "", "5845", "data1", "data2", "data3", "data4", "data5", true , 1); // Telephone number exists in the system.

cancelManualCallReprogramed()

Cancel a manual call that was rescheduled.

Source:
Tutorials:
  • Tutorial: ManualCall
Fires:
  • CORE_APIEvents#event:onError invalid status
Example
cancelManualCallReprogramed()

ChangePassword(currentPassword, newPassword)

Change agent password.

Parameters:
Name Type Description
currentPassword string

Current password
newPassword string

New password
Source:
Tutorials:
  • Tutorial: DataAgent
Fires:
  • CORE_APIEvents#event:onPasswordUpdated on sucess
  • CORE_APIEvents#event:errorOnPasswordChange on error
  • CORE_APIEvents#event:onErrorPasswordUpdate on error
  • CORE_APIEvents#event:onError invalid status
Example
ChangePassword("passwordCurrent", "NewPassword");

closeSession()

Close session.

Source:
Tutorials:
  • Tutorial: DataAgent
Fires:
  • CORE_APIEvents#event:onLogOut on sucess
  • CORE_APIEvents#event:onError invalid status
Example
closeSession();

connectToServer()

For the websocket connection we have to have access to the token
http://serverNuxibaIPorDomain/AgentKolob/IntegrationToken.html

Source:
Tutorials:
  • Tutorial: index
Fires:
  • CORE_APIEvents#event:onAgentStatus returns SocketClosed o Error

connectToServerAfterToken()

Internal method to make the connection after getting the token from the page: AgentKolob/IntegrationToken.html

Source:

disconnectToServer()

Close the connection between the websocket and the server

Source:
Tutorials:
  • Tutorial: index
Fires:
  • CORE_APIEvents#event:onAgentStatus returns status SocketClosed or Error

disposeACDCall(dispositionId, callID, subDispositionId)

Save disposition (call-in) without callback.

Parameters:
Name Type Description
dispositionId int

Disposition ID
callID int

Call ID
subDispositionId int

Sub disposition ID (If it does not exist, assign the value of zero ).
Source:
Tutorials:
  • Tutorial: InboundDispositions
See:
  • reprogramAcdCall
Fires:
Examples
disposeACDCall(1, 45, 45); // With subdisposition ID.
disposeACDCall(2, 45, 0); // Without sub disposition ID.

disposeCampaingCall(dispositionId, camId, callID, subId)

Save disposition (call-out) without callback.

Parameters:
Name Type Description
dispositionId int

Disposition ID
camId int

Campaign ID
callID int

Call ID
subId int

Sub disposition ID (If it does not exist, assign the value of zero )
Source:
Tutorials:
  • Tutorial: OutboundDispositions
See:
  • reprogramCampaignCall
To Do:
  • The method fails
Fires:
Examples
disposeCampaingCall(1, 1, 123, 0); // Without sub disposition ID.
disposeCampaingCall(1, 1, 123, 1); // With sub disposition ID.

disposeClientChat(chatId, dispId, subDispId)

Save disposition (chat)

Parameters:
Name Type Description
chatId uint

Chat ID
dispId uint

Disposition ID
subDispId uint

Sub disposition ID (If it does not exist, assign the value of zero )
Source:
Tutorials:
  • Tutorial: ChatClient
See:
  • getACDDispositions
Fires:
  • CORE_APIEvents#event:onError invalid status
Examples
disposeClientChat(1, 1, 0); // Without sub disposition
disposeClientChat(2, 2, 45); // With sub disposition

DTMFDigit(digit)

Send dialing tones.

Parameters:
Name Type Description
digit string

Send digits from 0 to 9, * and #
Source:
Tutorials:
  • Tutorial: CallControl
Fires:
Example
DTMFDigit("2");

exitAssistedMode()

Exit assisted mode.

Source:
Tutorials:
  • Tutorial: exitAssistedMode
Fires:
  • CORE_APIEvents#event:onError invalid status

finishClientChatConversation(chatId)

End conversation

Parameters:
Name Type Description
chatId uint

Chat ID
Source:
Tutorials:
  • Tutorial: ChatClient
Fires:
  • CORE_APIEvents#event:onError invalid status
  • CORE_APIEvents#event:onClientChatWrapUpStarted starts wrap up
Example
finishClientChatConversation(1);

getACDDispositions(id)

Get inbound calls dispositions list.

Parameters:
Name Type Description
id int

ACD ID
Source:
Tutorials:
  • Tutorial: InboundDispositions
Fires:
Example
getACDDispositions(1);

GetAgentID()

Retrieves the agent ID.

Source:
Fires:
  • CORE_APIEvents#event:agentId event to retrieve the agent ID

getAuxiliarReadys(None,)

Get Auxiliar Readys list.

Parameters:
Name Type Description
None,

not required
Source:
Example
getAuxiliarReadys();

getAuxiliarReadyStatus(None,)

Get Auxiliar Ready current status.

Parameters:
Name Type Description
None,

not required
Source:
Example
getAuxiliarReadyStatus();

getCallHistory()

Get the calls record of the day.

Source:
Fires:

getCampaignDispositions(id)

Get the dispositions and sub dispositions list.

Parameters:
Name Type Description
id int

Campaign ID
Source:
Tutorials:
  • Tutorial: OutboundDispositions
Fires:
  • CORE_APIEvents#event:onDispositions returns the disposotions and sub dispositions list
  • CORE_APIEvents#event:onError invalid status
Example
getCampaignDispositions(1);

getCampaignDispositionsAndNumbers(id, callOutID)

Get the dispositions, sub dispositions and phone numbers list to make a callback.

Parameters:
Name Type Description
id uint

Campaign ID
callOutID uint

Callout ID
Source:
Tutorials:
  • Tutorial: OutboundDispositions
Fires:
Example
getCampaignDispositionsAndNumbers(1,1520);

getCampaignsRelated()

Get the asigned manual dialing campaigns list.

Source:
Tutorials:
  • Tutorial: ManualCall
Fires:

getChatAnswerTemplates(id)

Get chat templates.

Parameters:
Name Type Description
id uint

ACD ID
Source:
Tutorials:
  • Tutorial: ChatClient
Fires:
  • CORE_APIEvents#event:onChatAnswerTemplates Templates list
  • CORE_APIEvents#event:onError invalid status
Example
getChatAnswerTemplates(1);

getChatHistory()

Get chat history.

Source:
Tutorials:
  • Tutorial: ChatAdminstrator
Fires:

getDispositions()

Get the dispositions and sub dispositions list.

Source:
Tutorials:
  • Tutorial: OutboundDispositions
Fires:
  • CORE_APIEvents#event:onDispositions returns the dispositions and sub dispositions list
  • CORE_APIEvents#event:onError invalid status

GetExtension()

Retrieves the agent extension.

Source:
Fires:
  • CORE_APIEvents#event:extension Event to retrieve the agent's extension

getIVRList()

Get the IVR list.

Source:
Tutorials:
  • Tutorial: IVR
Fires:
  • CORE_APIEvents#event:onIVRList returns the IVR list

GetLastCallData()

Retrieve last call data.

Source:
Tutorials:
  • Tutorial: CallInformation
Fires:
  • CORE_APIEvents#event:onError invalid status
Example
{
CalKey:"new2",
CallId: 275,
CallOutId: 376,
CallType: 2,
DNIS: "",
DataContact: ["Data1","Data2","Data3","Data4","Data5"],
DataKeyValue: "0:0",
Description: "Sales",
EngineId: 1,
HoldTime: "",
Id: 3,
IsACDTransfer: false,
IsQueueCall: false,
Phone: "2012",
Port: 2,
WaitingTime: 0,
WrapUpTime: 600,
allowACDCallBack: true,
holdTime: true,
secondPhone: 0
}

getPhoneNumbers(callOutID)

Get the phone numbers list to make callback.

Parameters:
Name Type Description
callOutID Number

Register ID
Source:
Tutorials:
  • Tutorial: OutboundDispositions
Fires:
  • CORE_APIEvents#event:onPhoneNumbers returns the phone numbers list
  • CORE_APIEvents#event:onError invalid status
Example
getPhoneNumbers(1520);

getSupervisorsToChat()

Get the online admins list.

Source:
Tutorials:
  • Tutorial: ChatAdminstrator
Fires:

getTransfersOptions()

Get the transfer options.

Source:
Tutorials:
  • Tutorial: BlindTransfer
Fires:

getUnavailableHistory()

Get the unavailable status used in the day.

Source:
Fires:

getUnavailables()

Get the unavailable status asigned list.

Source:
Tutorials:
  • Tutorial: Unavailable
Fires:
Example
getUnavailables();

GetUserName()

Retrieves the username.

Source:

hangUpAndLeaveMessage()

Hang up call and leave a message.

Source:
Tutorials:
  • Tutorial: CallControl
Fires:
  • CORE_APIEvents#event:onError invalid status

hangUpCall()

Hang up call.

Source:
Tutorials:
  • Tutorial: CallControl
Fires:
  • CORE_APIEvents#event:onError invalid status

hangUpManualDial()

Cancel the manual dialing before the client answer the phone.

Source:
Tutorials:
  • Tutorial: ManualCall
Fires:

HoldCall()

Put or quit hold during the call.

Source:
Tutorials:
  • Tutorial: CallControl
To Do:
  • event is not implemented
Fires:
  • CORE_APIEvents#event:onError invalid status
  • CORE_APIEvents#event:onHold event is not implemented

idleStart(id)

Starts an IVR block, the agent remains waiting until the IVR stops playing.

Parameters:
Name Type Description
id int

IVR block
Source:
Tutorials:
  • Tutorial: IVR
Fires:
  • CORE_APIEvents#event:onIdleStart starts the IVR block on the client side

login(username, password)

Login.

Parameters:
Name Type Description
username string

Username
password string

Password
Source:
Tutorials:
  • Tutorial: DataAgent
Fires:
Example
login("testAgent","testPassword");

makeManualCall(phone, id, clientName, callKey)

Do manual dialing.

Parameters:
Name Type Description
phone String

Phone number to dial
id int

Campaign ID
clientName String

[clientName= ] client's name
callKey String

[callKey= null] Id asigned by the client
Source:
Tutorials:
  • Tutorial: ManualCall
See:
  • getUnavailables
Fires:
Examples
makeManualCall('11078510',1,'Jesus','4582 3423 4865')  //All the parameters
makeManualCall('11078510',10)  //Only required parameters

recordingStopStart()

Start or stop the recording.

Source:
Tutorials:
  • Tutorial: CallControl

reprogramCampaignCall(camId, dispositionId, callID, dateCallback, phone, existNum, subDispositionId)

Disposition a call with callback.

Parameters:
Name Type Description
camId uint

Campaign ID
dispositionId uint

Disposition ID
callID uint

Call ID
dateCallback String

Call back date yyyy/MM/dd HH:mm
phone String

Phone number to callback
existNum Boolean

Determine which number will be dialed (true:The one assigned in the phone parameter, false:The number already exists in the system).
subDispositionId int

Sub disposition ID (If it does not exist, assign the value of zero ).
Source:
Tutorials:
  • Tutorial: OutboundDispositions
Fires:
Examples
reprogramCampaignCall(1, 1, 123, "2019/04/23 13:35", "11078510", false, 0);
reprogramCampaignCall(1, 1, 123, "2019/04/23 13:35", "", true,0);

saveDisposition()

Save Disposition without callback.

Source:
Tutorials:
  • Tutorial: exitAssistedMode
Fires:

sendChatMessage(administrator, message)

Send message to the admin.

Parameters:
Name Type Description
administrator string

Admin's name
message string

Message
Source:
Tutorials:
  • Tutorial: ChatAdminstrator
See:
  • getSupervisorsToChat
Fires:
  • CORE_APIEvents#event:onError invalid status
Example
sendChatMessage("root","Hola como te va es un mensaje de prueba");

sendClientChatMessage(adminId, message)

Send message to the client.

Parameters:
Name Type Description
adminId uint

Admin ID
message String

Message
Source:
Tutorials:
  • Tutorial: ChatClient
See:
  • onClientChatConnected chat info
Fires:
  • CORE_APIEvents#event:onError invalid status
Example
sendClientChatMessage(1,"Hola buenod dias en que puedo ayudarlo");

setAuxiliarReady(Value)

Set Auxiliar Ready.

Parameters:
Name Type Description
JSON.parse object

value from list Auxiliar Readys
Value string

from supervisor password
Source:
Examples
let auxiliarReadyObj = JSON.parse(document.getElementById("selectAuxiliarReadys").value);
setAuxiliarReady(auxiliarReadyObj, "password1");

setMute()

Mute the microphone.

Source:
Tutorials:
  • Tutorial: CallControl
To Do:
  • event is not implemented
Fires:
  • CORE_APIEvents#event:onError invalid status
  • CORE_APIEvents#event:onMute status microphone muted

setOnUnavailableStatus(unavailableId)

Asign an unavailable status.

Parameters:
Name Type Description
unavailableId int

Unavailable status ID
Source:
See:
  • getUnavailables
Fires:
Examples
setOnUnavailableStatus(1); //Unavailable status ID
setOnUnavailableStatus(0); //When the unavailable status does not exist on the list, execute the event: errorOnUnavailableStatus

SetReady()

Change to available.

Source:
Tutorials:
  • Tutorial: Unavailable
Fires:

setReadyWithPassword(agentPwd, supervisorPwd)

Change to available status with password.

Parameters:
Name Type Description
agentPwd string

Agent password
supervisorPwd string

Supervisor password
Source:
Tutorials:
  • Tutorial: Unavailable
Fires:
Example
setReadyWithPassword("agentPass","adminPass");

transferCallToACD(id)

Transfer the call to an ACD.

Parameters:
Name Type Description
id int

ACD ID
Source:
Tutorials:
  • Tutorial: BlindTransfer
See:
  • getTransfersOptions
Fires:
Example
transferCallToACD(1);

transferCallToAgent(extensionAgent)

Transfer the call to an agent.

Parameters:
Name Type Description
extensionAgent int

Agent extension
Source:
Tutorials:
  • Tutorial: BlindTransfer
See:
  • getTransfersOptions
Fires:
Example
transferCallToAgent(1);

transferCallToPhoneNumber(phone)

Transfer the call to an external phone number.

Parameters:
Name Type Description
phone string

External phone number
Source:
Tutorials:
  • Tutorial: BlindTransfer
See:
  • getTransfersOptions
Fires:
Example
transferCallToPhoneNumber("9988774455");

updateCallData(callOutID, data1, data2, data3, data4, data5)

Update client's contact info.

Parameters:
Name Type Description
callOutID uint

Identificador de la llamada
data1 String

Value is saved in the field: data1
data2 String

Value is saved in the field: data2
data3 String

Value is saved in the field: data3
data4 String

Value is saved in the field: data4
data5 String

Value is saved in the field: data5
Source:
Tutorials:
  • Tutorial: CallInformation
To Do:
  • event is not implemented
Fires:
Example
updateCallData(1520,"data1","data2","data3","data4","data5");

validateTelephony()

Validate telephony.

Source:
Tutorials:
  • Tutorial: DataAgent

volumeControl(deviceType, xVol)

Speakers and microphone volume control.

Parameters:
Name Type Description
deviceType Number

Select the audio (0:speakers,1:microphone)
xVol Number

Turn the volume (value from 0 to 100)
Source:
Tutorials:
  • Tutorial: CallControl
Examples
volumeControl(0,70);
volumeControl(1,70);