JSDoc: Global

Methods

onAgentId(id)

Catch the agent ID.

Parameters:

Name	Type	Description
`id`	int	Contains the id of the current agent.

Source:

test/Integration/CORE_APIEvents.js, line 69

Example

{data:10}

onCallRecieved(callData)

Catch the call data once it has been connected.

Parameters:

Name	Type	Description
`callData`	json	Contains the information of the current call.

Source:

test/Integration/CORE_APIEvents.js, line 251

Examples

{
    Agent: {ID: int, userName: string},
    AllowACDCallBack :  bool ,
    CalKey :  string ,
    CallId :  int ,
    CallOutId :  int ,
    CallType :  uint ,
    DNIS: string ,
    DataContact : Array(5) [string, string, string, string, string] ,
    Description :  string ,
    EngineId :  uint ,
    Id :  uint ,
    IsACDTransfer :  false ,
    IsQueueCall :  bool ,
    Phone :  string ,
    Port :  int ,
    WaitingTime :  int ,
    WrapUpTime :  int ,
    holdTime :  bool
    }

{
    Agent: {ID: 94, userName: "daniAgent"},
    AllowACDCallBack :  true ,
    CalKey :  "" ,
    CallId :  1323 ,
    CallOutId :  2438 ,
    CallType :  2 ,
    DNIS :  "" ,
    DataContact : ["Data1", "Data2", "Data3", "Data4", "Data5"] ,
    Description :  "NormalDna" ,
    EngineId :  1 ,
    Id :  3 ,
    IsACDTransfer :  false ,
    IsQueueCall :  false ,
    Phone :  "2025" ,
    Port :  3 ,
    WaitingTime :  0 ,
    WrapUpTime :  600 ,
    holdTime :  true
    }

onExtension(extension)

Catch the agent extension

Parameters:

Name	Type	Description
`extension`	string	Contains the extension of the current agent user.

Source:

test/Integration/CORE_APIEvents.js, line 79

Example

{data:-1}

onUsername(username)

Catch the username

Parameters:

Name	Type	Description
`username`	string	Contains the current agent username.

Source:

test/Integration/CORE_APIEvents.js, line 89

Example

{data:"daniAgent"}

Events

errorOnAvailableStatus

Catch error when trying to get out of an unavailable state.

Parameters:

Name	Type	Description
`data`	json	{message: string}

Source:

test/Integration/CORE_APIEvents.js, line 1265

errorOnCallHistory

Catch error when it comes to getting the call history.

Parameters:

Name	Type	Description
`data`	json	{code:int, message:string}

Source:

test/Integration/CORE_APIEvents.js, line 1275

See:

getCallHistory

errorOnCampaignsRelated

Catch error when trying to get list of available dial campaigns.

Parameters:

Name	Type	Description
`data`	json	{code: int,message: string}

Source:

test/Integration/CORE_APIEvents.js, line 1286

errorOnChatAdministratorsList

Catch error when trying to get list of available admins.

Parameters:

Name	Type	Description
`data`	json	{code: int,message: string}

Source:

test/Integration/CORE_APIEvents.js, line 1296

To Do:

Revisar

errorOnDialProcess

Catch error when trying to perform manual dialing.

Parameters:

Name	Type	Description
`data`	json	{code: int, message: string}

Source:

test/Integration/CORE_APIEvents.js, line 1308

To Do:

Revisar

errorOnDispose

Catch error when trying to dispose a call.

Parameters:

Name	Type	Description
`data`	json	{code:int, message:string}

Source:

test/Integration/CORE_APIEvents.js, line 1319

See:

disposeCampaingCall
reprogramCampaignCall
disposeACDCall
reprogramAcdCall

errorOnDispositionList

Catch error while trying to get list of dispositions.

Parameters:

Name	Type	Description
`data`	json	{code:int, message:string}

Source:

test/Integration/CORE_APIEvents.js, line 1334

See:

getACDDispositions
getCampaignDispositions

errorOnDispositionSelected

Catch error when trying to select unassigned disposition.

Parameters:

Name	Type	Description
`data`	json	{code:int, message:string}

Source:

test/Integration/CORE_APIEvents.js, line 1346

errorOnDispositionsPhonesList

Catch error while trying to get list of dispositions and phone numbers.

Parameters:

Name	Type	Description
`data`	json	{code:int, message:string}

Source:

test/Integration/CORE_APIEvents.js, line 1356

errorOnDTMFJS

Catch error when trying to send DTMF tones.

Parameters:

Name	Type	Description
`data`	json	{code: int, message: string}

Source:

test/Integration/CORE_APIEvents.js, line 1366

See:

DTMFDigit

errorOnIVRTransfer

Catch error while trying to get list of available IVRs.

Parameters:

Name	Type	Description
`data`	json	{code: int,message: string}

Source:

test/Integration/CORE_APIEvents.js, line 1376

To Do:

no implementado

errorOnPhoneNumbersList

Catch error while trying to get list of phone numbers.

Parameters:

Name	Type	Description
`data`	json	{code:int, message:string}

Source:

test/Integration/CORE_APIEvents.js, line 1406

errorOnReadysAuxiliar

Catch error when trying to get list readys auxiliar.

Parameters:

Name	Type	Description
`data`	json

Source:

test/Integration/CORE_APIEvents.js, line 1500

See:

getReadysAuxiliar

Example

{"Error consulting database."}

errorOnUnavailableStatus

Catch error when trying to put agent in unavailable state.

Parameters:

Name	Type	Description
`data`	json	{code:int, message:string}

Source:

test/Integration/CORE_APIEvents.js, line 1416

See:

setOnUnavailableStatus

errorOnUnavailableStatusHistory

Catch error when trying to get unavailable history.

Parameters:

Name	Type	Description
`data`	json	{code:int, message:string}

Source:

test/Integration/CORE_APIEvents.js, line 1427

See:

getUnavailableHistory

errorOnUpdateDataCall

Catch error when trying to update call info.

Parameters:

Name	Type	Description
`data`	json	{code: int, message: string}

Source:

test/Integration/CORE_APIEvents.js, line 1438

See:

UpdateDataCall

To Do:

falta implementar

errorPasswordAuxiliarReady

Catch error when password is incorrect in readys auxiliar.

Parameters:

Name	Type	Description
`string`

Source:

test/Integration/CORE_APIEvents.js, line 1511

See:

setReadysAuxiliar

Example

'Passwords do not match.'

numberOnDoNotCallList

Detect if the phone number is blacklist.

Source:

test/Integration/CORE_APIEvents.js, line 181

onAdministrators

Catch the list of online administrators.

Parameters:

Name	Type	Description
`Administrators`	Array	Contains the list of online administrators (ID,username).

Source:

test/Integration/CORE_APIEvents.js, line 1004

Tutorials:

Tutorial: ChatAdminstrator

See:

getSupervisorsToChat

Examples

[{ID: uint, Username: string},{ID: ID, Username : string}]

[{ID: 1, Username: 'root'},{ID: 16, Username : "daniAdmin"}]

onAgentStatus

Catch the information related to the current state of the agent.

Parameters:

Name	Type	Description
`agentStatus`	json	Each state brings different information, but the currentState property is common for all of them and tells us the name of the current state.

Source:

test/Integration/CORE_APIEvents.js, line 96

Examples

agentStatus =  {agentData: {userExt: "-1",userId: 94,userName: "daniAgent"}, currentState: "Ready"}

agentStatus =  { currentState: "NotReady", description: "Break"}

Agent States
{'Assisted','Callout','Dialog','Login','Logout','NotConnected,'NotReady','Other','Problem','Ready','RECONNECT','RinginFail','Ringing','Unknown','Wrapup','WRAPUP_FAIL','Xfer','XferFail'}

onAlerts

Catch the alert of a scheduled call.

Parameters:

Name	Type	Description
`data`	json	{message: string}

Source:

test/Integration/CORE_APIEvents.js, line 1524

onAlerts

Catch the alert of a state machine disconnection.

Parameters:

Name	Type	Description
`data`	json	{message: string}

Source:

test/Integration/CORE_APIEvents.js, line 1534

onAuxiliarReadyStatus

Catch the current status of Auxiliar Ready.

Parameters:

Name	Type	Description
`auxStatus`	json	Contains the message sent by Agent Kolob.

Source:

test/Integration/CORE_APIEvents.js, line 1250

Examples

{auxStatus: 1. Disponible especial - Atenci�n de WhatsApp}

{auxStatus: Ready}

{auxStatus: Auxiliary Restricted by Supervisor}

onAuxiliarTypes

Catch the list of Auxiliar Readys.

Parameters:

Name	Type	Description
`auxiliarList`	json	Contains the message sent by Agent Kolob.

Source:

test/Integration/CORE_APIEvents.js, line 1224

Example

{auxiliarList:  AdminPasswordRequired: false, AuxiliaryRestricted: false, Color: 1, Description: "Auxiliar1", TipoReadyAuxiliar_Id: 1}

onCallEnds

Catch the end of the call.

Parameters:

Name	Type	Description
`callData`	JSON	Contains the dialog time and the callkey of the finished call.

Source:

test/Integration/CORE_APIEvents.js, line 190

Tutorials:

Tutorial: OnCallEnd

Examples

{dialogTime:int, callKey:string}

{dialogTime:125, callKey:"0000-1"}

onCallHistory

Catch call history.

Parameters:

Name	Type	Description
`HistoryDataCall`	array	Contains the details of each call made.

Source:

test/Integration/CORE_APIEvents.js, line 1050

Tutorials:

Tutorial: HistoricRecords

See:

getCallHistory

Examples

[
    {
        CallId: int,
        CallKey: string,
        CallType: string,
        Description: string,
        Disposition: string,
        Duration: string,
        GraphicID: uint,
        HidePhone: bool,
        Hour: string,
        IDCampEsp: unit,
        Telephone: string,
        selectionActive: bool
    }
]

[
    {
        CallId: 45,
        CallKey: "",
        CallType: "IN",
        Description: "CommonACD",
        Disposition: "Se Corto la Llamada",
        Duration: "00:01:35",
        GraphicID: 1,
        HidePhone: true,
        Hour: "11:10:59",
        IDCampEsp: 1,
        Telephone: "1005",
        selectionActive: false
    },{
        CallId: 96,
        CallKey: "",
        CallType: "OUT",
        Description: "CommonCamp",
        Disposition: "Gesti�n Efectiva",
        Duration: "00:02:23",
        GraphicID: 1,
        HidePhone: true,
        Hour: "11:10:41",
        IDCampEsp: 1,
        Telephone: "2005",
        selectionActive: false
    },{
        CallId: 95,
        CallKey: "",
        CallType: "OUT",
        Description: "CommonCamp",
        Disposition: "Gesti�n Efectiva",
        Duration: "00:05:24",
        GraphicID: 1,
        HidePhone: true,
        Hour: "11:05:01",
        IDCampEsp: 1,
        Telephone: "2005",
        selectionActive: false
    }
]

onCallsOnQueue

Catch the summary of incoming calls in queue.

Parameters:

Name	Type	Description
`CallOnQueue`	Array

Source:

test/Integration/CORE_APIEvents.js, line 280

Examples

[{acdID:int, nQueue:int, secondsOnQueue:int}]

[
    {acdID:1,nQueue:1,secondsOnQueue:75},
    {acdID:3,nQueue:3,secondsOnQueue:125}
]

onCampaigns

Catch a list of assigned campaigns.

Parameters:

Name	Type	Description
`campaignList`	Object	Contains the characteristics of each of the available campaigns.

Source:

test/Integration/CORE_APIEvents.js, line 153

Examples

{Default:boolean, Description:string, GraphicID:uint ,ID:uint}

{{Default:true, Description:"NormalDna", GraphicID:3 ,ID:3},{Default:false, Description:"PredictivaDna", GraphicID :1, ID:5}}

onChatHistory

Catch the chat history of the selected administrador.

Parameters:

Name	Type	Description
`chatHistory`	json	Contains the chat history of the selected administrador.

Source:

test/Integration/CORE_APIEvents.js, line 977

Tutorials:

Tutorial: ChatAdminstrator

Examples

{ type: number, text: string , user: string, hour:string}

{ "type": 2, "text": "Hola", "user": "daniAgent", "hour": "11:30:30"}

{ "type": 1, "text": "Hola, ¿Comó estás?", "user": "daniAdmin", "hour": "11:30:35"}

onChatMessage

Catch the message sent by an administrator.

Parameters:

Name	Type	Description
`chatMessage`	json	Contains the message sent by an administrator.

Source:

test/Integration/CORE_APIEvents.js, line 1033

Tutorials:

Tutorial: ChatAdminstrator

Examples

{administrator: string, message: string }

{administrator:"root", message:"Buenos dias" }

onConference

Capture if the conference between the main call, the second call and the agent was successful.

Source:

test/Integration/CORE_APIEvents.js, line 506

onDataCallUpdated

Catch the new updated information from the agent in the current call.

Parameters:

Name	Type	Description
`callData`	json	Contains updated information of the current call (CalKey,DataContact).

Source:

test/Integration/CORE_APIEvents.js, line 316

See:

UpdateDataCall

Examples

{
    CalKey :  string ,
    DataContact : Array(5) [string, string, string, string, string] ,
    IsSave: bool
    }

{
    CalKey :  "" ,
    DataContact : ["Data1", "Data2", "Data3", "Data4", "Data5"],
    IsSave : true
    }

onDialingNumber

Catch the manual dialing data.

Parameters:

Name	Type	Description
`calloutData`	JSON	Contains the characteristics of the call made manually.

Source:

test/Integration/CORE_APIEvents.js, line 349

Examples

{call_id:int, callout_id:int , camID:uint, phoneNumber:string}

{call_id:1318, callout_id:2430, camID:3, phoneNumber: "2025"}

onDialResult

Catch the dial result if unsuccessful.
2: "Busy",
3: "Not Answer",
4: "Fax/Modem",
5: "NoDialTone",
8: "Other",
10: "NoService",
11: "VoiceMail/Machine",
12: "Circut Busy",
13: "Cancelled",
90: "Rejected by provider"

Parameters:

Name	Type	Description
`callResult`	int	Contains the id of the dial result.

Source:

test/Integration/CORE_APIEvents.js, line 364

Examples

{dialResult:int}

{dialResult:1}

onDisposeApplied

Catch the successful save of the disposition.

Source:

test/Integration/CORE_APIEvents.js, line 675

Tutorials:

Tutorial: OutboundDispositions
Tutorial: InboundDispositions

See:

disposeCampaingCall
reprogramCampaignCall
disposeCampaingCall
disposeCampaingCall

onDispositions

Catch the list of availables dispositions and sub-dispisitions.

Parameters:

Name	Type	Description
`callDisposition`	Array	Contains the characteristics of each disposition and sub-dispisition available.

Source:

test/Integration/CORE_APIEvents.js, line 690

Tutorials:

Tutorial: OutboundDispositions

Examples

[{
        "CanReprogram": boolean,
        "Description": string,
        "EndConversation": boolean,
        "FinishPreview": boolean,
        "Id": uint,
        "Orden": uint,
        "Parent": uint,
        "SubDisposition": object
}]

[
    {
        "CanReprogram": false,
        "Description": "Subcalificaciones",
        "EndConversation": false,
        "FinishPreview": false,
        "Id": 4,
        "Orden": 1,
        "Parent": 0,
        "SubDisposition": {
            "1": {
                "Parent": 1,
                "Id": 1,
                "Description": "Sub1",
                "Orden": 0,
                "EndConversation": false,
                "CanReprogram": false
            },
            "2": {
                "Parent": 1,
                "Id": 2,
                "Description": "Sub2",
                "Orden": 0,
                "EndConversation": false,
                "CanReprogram": false
            }
        }
    },
    {
        "CanReprogram": false,
        "Description": "Gesti�n Efectiva",
        "EndConversation": false,
        "FinishPreview": false,
        "Id": 1,
        "Orden": 7,
        "Parent": 0,
        "SubDisposition": {},
    },
    {
        "CanReprogram": true,
        "Description": "Se deja recado",
        "EndConversation": false,
        "FinishPreview": false,
        "Id": 2,
        "Orden": 8,
        "Parent": 0,
        "SubDisposition": {},
    },
    {
        "CanReprogram": true,
        "Description": "Numero Equivocado",
        "EndConversation": false,
        "FinishPreview": false,
        "Id": 3,
        "Orden": 9,
        "Parent": 0,
        "SubDisposition": {}
    }
]

onDispositionsAndNumbers

Catch the list of dispositions, sub sub-dispositions and the available telephone numbers (to carry out the reprogramming) in the system.

Parameters:

Name	Type	Description
`CallDisposition`	Object	It contains the characteristics of the dispositions and the list of telephone numbers (last three digits) available to reprogram the current call.

Source:

test/Integration/CORE_APIEvents.js, line 806

Tutorials:

Tutorial: OutboundDispositions

See:

getCampaignDispositionsAndNumbers
getCampaignDispositionsAndNumbers

Examples

["dispositions":
        [{
            "CanReprogram": boolean,
            "Description": string,
            "EndConversation": boolean,
            "FinishPreview": boolean,
            "Id": uint,
            "Orden": uint,
            "Parent": uint,
            "SubDisposition": object
        }],
    "phoneNumbers": [
            string,
            string
        ]
    ]

{
    "dispositions": [
        {
            "CanReprogram": false,
            "Description": "Subcalificaciones",
            "EndConversation": false,
            "FinishPreview": false,
            "Id": 4,
            "Orden": 1,
            "Parent": 0,
            "SubDisposition": {
                "1": {
                    "Parent": 1,
                    "Id": 1,
                    "Description": "Sub1",
                    "Orden": 0,
                    "EndConversation": false,
                    "CanReprogram": false
                },
                "2": {
                    "Parent": 1,
                    "Id": 2,
                    "Description": "Sub2",
                    "Orden": 0,
                    "EndConversation": false,
                    "CanReprogram": false
                }
            }
        },
        {
            "CanReprogram": false,
            "Description": "Gesti�n Efectiva",
            "EndConversation": false,
            "FinishPreview": false,
            "Id": 1,
            "Orden": 7,
            "Parent": 0,
            "SubDisposition": {},
        },
        {
            "CanReprogram": true,
            "Description": "Se deja recado",
            "EndConversation": false,
            "FinishPreview": false,
            "Id": 2,
            "Orden": 8,
            "Parent": 0,
            "SubDisposition": {},
        },
        {
            "CanReprogram": true,
            "Description": "Numero Equivocado",
            "EndConversation": false,
            "FinishPreview": false,
            "Id": 3,
            "Orden": 9,
            "Parent": 0,
            "SubDisposition": {}
        }
    ],
    "phoneNumbers": [
        "025",
        "026"
    ]
}

onError

Catch error when attempting to perform some method in an invalid state.

Parameters:

Name	Type	Description
`data`	json	{code: int, message: string}

Source:

test/Integration/CORE_APIEvents.js, line 1449

Example

//var data= {code:7, message:"Estado no valido"}
console.warn("codeError:",data.code,"MessageError:",data.message);

onErrorManualCall

Catch the error on manual calls.

Parameters:

Name	Type	Description
`code`	int	Contains the code of error.
`message`	String	Contains the error.

Source:

test/Integration/CORE_APIEvents.js, line 392

onErrorPasswordUpdate

Catch error when trying to change agent password.

Parameters:

Name	Type	Description
`data`	json	{code: int, message: string}

Source:

test/Integration/CORE_APIEvents.js, line 1386

See:

ChangePassword for (i = 0; i < message.length; i++) { if (message[i].description) { printToConsole(message[i].description); } }

Example

//var message=[{id: 5002, description: "Ingrese al menos 8 caracteres"},
{id: 5006, description: "Ingrese al menos una may�scula, una min�scula y un n�mero"}]

onErrorPasswordUpdate

Catch error when trying to update agent password.

Parameters:

Name	Type	Description
`data`	json	{code: int, message: string}

Source:

test/Integration/CORE_APIEvents.js, line 1461

See:

ChangePassword for (i = 0; i < message.length; i++) { if (message[i].description) { printToConsole(message[i].description); } }

Example

//var message=[{id: 5002, description: "Ingrese al menos 8 caracteres"},
{id: 5006, description: "Ingrese al menos una may�scula, una min�scula y un n�mero"}]

onHold

Catch the hold status.

Parameters:

Name	Type	Description
`status`	boolean	Indicates if the hold is active in the current call.

Source:

test/Integration/CORE_APIEvents.js, line 404

Tutorials:

Tutorial: CallControl

See:

HoldCall

Examples

{true}

{false}

onIdleEnd

Catch client-side IVR completion.

Parameters:

Name	Type	Description
`IVRInput`	string	Contains the digits entered by the customer.

Source:

test/Integration/CORE_APIEvents.js, line 455

Tutorials:

Tutorial: IVR

Examples

{string}

{"1122334455"}

onIdleStart

Catch the start of selected client-side IVR.

Parameters:

Name	Type	Description
`IVRId`	string	Contains the ID of the IVR used.

Source:

test/Integration/CORE_APIEvents.js, line 468

Tutorials:

Tutorial: IVR

See:

idleStart

Examples

{string}

{"1"}

onIVRList

Catch the list of available IVRs.

Parameters:

Name	Type	Description
`IVRList`	Array	Contains the Id and name of each of the IVRs.

Source:

test/Integration/CORE_APIEvents.js, line 482

Tutorials:

Tutorial: IVR

See:

getIVRList

Examples

[{ name: string, id: int }]

[{ name: "Banamex", id: 3 }, { name: "Bancomer", id: 2 }]

onLogin

Catch successful login.

Source:

test/Integration/CORE_APIEvents.js, line 19

Tutorials:

Tutorial: DataAgent

See:

onLogOut

Catch the session ended with the method closeSession.

Source:

test/Integration/CORE_APIEvents.js, line 30

Tutorials:

Tutorial: DataAgent

See:

closeSession

onMainCall

Catch the number of the main call indicating that it is the active call.

Source:

test/Integration/CORE_APIEvents.js, line 515

Examples

{string}

{"2029"}

onMute

Mute status

Parameters:

Name	Type	Description
`status`	boolean	Indicates if the mute is active in the current call.

Source:

test/Integration/CORE_APIEvents.js, line 417

Tutorials:

Tutorial: CallControl

See:

setMute

Examples

{true}

{false}

onNextCall

Catch the new phone number that was added to the conference.

Source:

test/Integration/CORE_APIEvents.js, line 528

onPasswordUpdated

Catch successful password change.

Source:

test/Integration/CORE_APIEvents.js, line 41

Tutorials:

Tutorial: DataAgent

See:

ChangePassword

onPhoneNumbers

Catch the list of numbers registered in the system to reprogram the current call.

Parameters:

Name	Type	Description
`phoneNumbers`	Array	Contains the last 3 digits of the numbers registered and available to carry out the reprogramming of the current call.

Source:

test/Integration/CORE_APIEvents.js, line 903

Tutorials:

Tutorial: OutboundDispositions

See:

getPhoneNumbers

Example

phoneNumbers:["025","026"]

onReprogramCall

Catch the summary of the registered callbacks.

Parameters:

Name	Type	Description
`DispositionResult`	json	Contains a summary (year, month, day, hour) of the callbacks registered to date.

Source:

test/Integration/CORE_APIEvents.js, line 932

Tutorials:

Tutorial: OutboundDispositions

Examples

{
    callBacks: [{a�o:int, mes:int, dia:int, hora:int, callbacks:int},{a�o:int, mes:int, dia:int, hora:int, callbacks:int}],
    endDate: "yyyy-MM-dd",
    hasCallbacks: bool,
    startDate: "yyyy-MM-dd"
}

{
    callBacks: [
        { "a�o": 2023, "mes": 2, "dia": 20, "hora": 14, "callbacks": 1},
        { "a�o": 2023, "mes": 2, "dia": 20, "hora": 15, "callbacks": 5},
        { "a�o": 2023, "mes": 2, "dia": 20, "hora": 16, "callbacks": 1},
        { "a�o": 2023, "mes": 2, "dia": 20, "hora": 17, "callbacks": 9},
        { "a�o": 2023, "mes": 2, "dia": 20, "hora": 18, "callbacks": 3}
    ],
    endDate: "2023/04/21",
    hasCallbacks: true,
    startDate: "2023/02/20"
}

onReprogramSuccess

Catch confirmation of a successful reprogram.

Source:

test/Integration/CORE_APIEvents.js, line 965

onSecondCall

Catch the number of the second call indicating that it is the active call.

Parameters:

Name	Type	Description
`phone`	string	Second call number

Source:

test/Integration/CORE_APIEvents.js, line 537

Examples

{string}

{"2025"}

onSecondCallConected

Catch the successful connection of the second call made in an assisted/blind transfer.

Source:

test/Integration/CORE_APIEvents.js, line 551

onSecondCallHangUp

Catch the hangup on the second call.

Parameters:

Name	Type	Description
`Error`	string	code
`Message`	string	code

Source:

test/Integration/CORE_APIEvents.js, line 560

Examples

{
        Code: string,
        Message: string
    }

{
        Code: "1505",
        Message: "Congestión"
    }

onTelephonyStatus

Catch telephony status.

Parameters:

Name	Type	Description
`status`	string	Telephony status

Source:

test/Integration/CORE_APIEvents.js, line 52

onTransferOptions

Catch the list of transfer options (Blind and Assisted).

Parameters:

Name	Type	Description
`transfersOptions`	Array	Contains ACD campaigns, active agents and active numbers available to make assisted or blind transfers.

Source:

test/Integration/CORE_APIEvents.js, line 584

See:

getTransfersOptions

Examples

{
 0:[{inbound_id:uint, name:string,frame:uint}],
 1:[{id:uint, name:string, number:string}]
 2:[{extid:int, name:string}]
}

{
0:[{inbound_id:1, name:"Verificacion Compra"},{inbound_id:3, name:"Cancelacion Compra", frame:1}]
1:[{id:1, name:"Mesa Ayuda", phone:"2005"},{id:2, name:"Cobranza", phone:"2100"}],
2:[{extid: -6, name : "pacoAgent pacoAgent"},{extid: -87, name : "pacoAgent alanAgent"}],
}

onUnavailableAgent

Capture if an online agent is not available to receive a call transfer.

Parameters:

Name	Type	Description
`unavalableAgent`	Json	Unavailable agent ({agent:string, error:string})

Source:

test/Integration/CORE_APIEvents.js, line 662

Example

{agent:'pacoAgent', error:'AGENT_BUSY'}

onUnavailableHistory

Capture the history of the unavailable status.

Parameters:

Name	Type	Description
`UnavailableStatusHistory`	Array	Contains the details of each use of the unavailable status.

Source:

test/Integration/CORE_APIEvents.js, line 1137

Tutorials:

Tutorial: HistoricRecords

See:

getUnavailableHistory

Examples

[
    {   Description:string,
        Count:int,
        Max:string,
        Time:String,
        Total:String,
        TypeNotReadyId:int,
        Detail:[{time:string,hour:string,"TypeNotReadyId":int}]
    }
]

[
    {
        "Count": 2,
        "Description": "Tocador",
        "Detail": [
            {
                "Hour": "13:35:51",
                "Time": "00:16:44",
                "TypeNotReadyId": 3
            },
            {
                "Hour": "18:44:30",
                "Time": "00:00:11",
                "TypeNotReadyId": 3,
            }
        ],
        "Frame": 3,
        "Max": "00:00:00",
        "Time": "00:16:55",
        "Total": "n",
        "TypeNotReadyId": 3,
    },
    {
        "Count": 1,
        "Description": "Con Cliente",
        "Detail": [
            {
                "Hour": "18:39:39",
                "Time": "00:00:16",
                "TypeNotReadyId": 4,
            }
        ],
        "Frame": 4,
        "Max": "00:00:00",
        "Time": "00:00:16",
        "Total": "n",
        "TypeNotReadyId": 4,
    }
]

onUnavailableTypes

Catch the unavailable list

Parameters:

Name	Type	Description
`unavailableList`	Array	Each Array is composed of a json that contains the characteristics of each not available (description, id, etc).

Source:

test/Integration/CORE_APIEvents.js, line 129

Examples

[{Description: string, Frame: uint, Max: string, NotReadyRestricted: uint, NumberOfEvents: string/uint, TypeNotReadyId: uint}

[{Description: "No Clasificado", Frame: 1, Max: "00:00:00", NotReadyRestricted: 0, NumberOfEvents: "n", TypeNotReadyId: 1},
{Description: "Sistema3", Frame: 8, Max: "01:00:00", NotReadyRestricted: 0, NumberOfEvents: "12", TypeNotReadyId: 14}]

remoteLoginError

Catch error when trying to login.

Parameters:

Name	Type	Description
`data`	json	{ code:int, message:string }

Source:

test/Integration/CORE_APIEvents.js, line 1485

See:

Example

//remoteLoginError { code: 1024, message: "Contrase�a inv�lida" }
function remoteLoginError(data) {
   console.warn("codeError:",data.code,"MessageError:",data.message);
}

timeZoneNumber

Catch the number if it is out of the time zone.

Parameters:

Name	Type	Description
`phone`	string	Phone number

Source:

test/Integration/CORE_APIEvents.js, line 430

See:

makeManualCall

Example

{"558877441"}

wrongNumber

Catch the wrong number.

Parameters:

Name	Type	Description
`phone`	String	It does not meet the dialing rules.

Source:

test/Integration/CORE_APIEvents.js, line 442

Example

{"558877441"}