Generic Toolbar Integration

Ameyo Generic Toolbar Integration

Table of Contents
1. Document Versioning............................................................................................................. 4

2. Introduction ............................................................................................................................ 5

2.1 Getting Started................................................................................................................. 5

2.2 Web Toolbar Overview .................................................................................................... 5

3. Integration Approach ............................................................................................................. 7

4. Single Sign-On ......................................................................................................................... 9

4.1 Request Parameters ........................................................................................................ 9

4.1.1 Single Sign-On API.................................................................................................. 10

4.1.2 API Details............................................................................................................... 10

4.1.3 Procedure ............................................................................................................... 10

4.1.3.1 Sample Request XML ......................................................................................... 11

4.1.3.2 Sample 1 (For Successful event)........................................................................ 11

4.1.3.3 Sample Response XML {Sample 2 (For Failure Event)} .................................... 11

4.2 Logout ............................................................................................................................ 12

4.2.1 Sample Request XML ............................................................................................. 12

4.2.2 Sample Response XML .......................................................................................... 13

4.3 Force Login..................................................................................................................... 13

5. Dialing Number from CRM Application .............................................................................. 15

5.1 Request Parameters ...................................................................................................... 15

5.2 Reponse Parameter....................................................................................................... 15

6. Auto-Extension Selection ..................................................................................................... 17

7. Handling Customer Information Pop-up on Call ............................................................... 19

7.1.1 Request Parameters .............................................................................................. 19

Copyright © AMEYO 2020 | Page 2

Ameyo Generic Toolbar Integration

7.2 Sample JS to register showCrm event with other functions defined in CRM ............ 20

8. Call Disposition ..................................................................................................................... 21

9. Dispose and Dial ................................................................................................................... 23

10. Logout ................................................................................................................................ 24

11. Toolbar Event and Handler............................................................................................... 25

Copyright © AMEYO 2020 | Page 3

Ameyo Generic Toolbar Integration

1. Document Versioning

Version Date Purpose Author

GTI-v1 17-June-2020 First Draft Saurabh Goyal

Copyright © AMEYO 2020 | Page 4

Ameyo Generic Toolbar Integration

2. Introduction

This document introduces to the user manual and integrational API uses of Generic Web

Toolbar. The document contains the API and technical details required for the integration of

Ameyo web toolbar with a web-based third-party CRM. It is intended to be used by the

technical team of the customers, partners, or system integrator to gain an in-depth

knowledge of the integration process. The document assumes the basic knowledge of

telephony and CRMs.

2.1 Getting Started

A generic web toolbar is used to integrate into the iframe of a third-party toolbar. For the

integration of it, the customer requires a third-party CRM in which it can be integrated. The

CRM in which Web Toolbar has to be implemented must support for the integration of other

CRM in its iframe; it means that the third-party CRM must support iframe integration in itself.

2.2 Web Toolbar Overview

Ameyo Web toolbar, is a web-based telephony solution that enables third-party CRMs to

integrate with Ameyo. This toolbar opens in an iframe on the third-party web page. The

toolbar is fashioned in the form of an agent telephony palette. It contains basic telephony

operations and displays runtime status of agent and call. Below is the reference screenshot

of embedded Ameyo toolbar in a third-party CRM.

Copyright © AMEYO 2020 | Page 5

Ameyo Generic Toolbar Integration

Figure: First Page of Generic Toolbar

In our test case, we are using the web toolbar integration as Generic only. But it is possible

to integrate it with third-party CRM's as well. For further information on the same, contact

Support team of Ameyo.

Copyright © AMEYO 2020 | Page 6

Ameyo Generic Toolbar Integration

3. Integration Approach

Third-party CRM should include:

<Protocol>://<Domain_of_Ameyo_Application>:<Port_Number>/ameyowebaccess/toolbar/j

s/ameyo-integration-v<file_version>.js

using a script tag in the headers of all web pages. This serves as the glue code for integration.

Third-party CRM should have a div for the iframe with the div id 'ameyoIframeDiv.' This div

must be available in all pages where the iframe needs to be shown.

The iframe should have the source set as

<Protocol>://<Domain_of_Ameyo_Application>:<Port_Number>/ameyowebaccess/toolbar-

crm.htm

Thus the page in this iframe shall be served from Ameyo server, and this will be an

integrated toolbar.

So the integration approach includes that the third-party CRM should include the javascript

provided by Drishti and should invoke the toolbar URL (as mentioned above).

Also include following script in the header of pages where the iframe is present:

<script>
var crmOrigin;
var ameyoBaseUrl="<Protocol>://<Domain_of_Ameyo_Application>:<Port_Number>/";
function initialise(){
crmOrigin=window.location.href;
iframeDiv=document.getElementById("ameyoIframeDiv");
iframeUrl=ameyoBaseUrl + " ameyowebaccess/toolbar-crm.htm?";
iframeUrl = iframeUrl + "origin=" + crmOrigin;
iframeHtml = '<iframe height="400px" width="200px" id="ameyoIframe" src="' + iframeUrl +
'"></iframe>';
iframeDiv.innerHTML=iframeHtml;
}
</script>
Here, <Host_server_IP> is the Ameyo Application Server's IP and <Port_No> is the Ameyo

appserver's port on which the application is running.

The script includes integration.js to facilitate two-way communication between third-party

CRM browser and ameyo-web toolbar.

Copyright © AMEYO 2020 | Page 7

Ameyo Generic Toolbar Integration

Two-way communication is desired in scenarios such as:

1. When an incoming call lands on Ameyo and gets connected, the toolbar must

communicate with the CRM to show the CRM page for the connected customer,

which means the communication is from Ameyo to CRM.

2. When an agent clicks on a number on the CRM page, that number has to be dialed.

The dialing information needs to be communicated to Ameyo, which means the

communication is from CRM to Ameyo.

Figure: Toolbar Workflow

For the two-way communication below APIs will be invoked:

1. Ameyo API to be invoked by third-party CRM (Third-party toolbar communication).

2. Third-party CRM API to be invoked by Ameyo (Default implementation for the third-

party API is present in the mentioned script. Alternatively, the third-party may

override this API (explained in later in the document).

Copyright © AMEYO 2020 | Page 8

Ameyo Generic Toolbar Integration

4. Single Sign-On

For single sign-on below approach needs to be followed:

1. User Id should be same in Ameyo and CRM.

2. User needs to be created manually in Ameyo.

3. Below function needs to be called to login in Ameyo Toolbar.

ameyo.integration.doLogin(username,password,authPolicy);

To login using userId, password, authentication policy.

4.1 Request Parameters

Field Name Description

username User Id of the agent

password password of the agent

authPolicy Authorization policy to the user 'auth.type.crm.http','auth.type.password'

For Example

ameyo.integration.doLogin('agent','agent','auth.type.password')

1. If authpolicy is not provided or it is auth.type.password then Ameyo will check

authentication from Ameyo database.

2. If auth policy is auth.type.crm.http, then ameyo will call CRM API to authenticate user,

according to API response Ameyo will take action. Click here for the API details

Copyright © AMEYO 2020 | Page 9

Ameyo Generic Toolbar Integration

4.1.1 Single Sign-On API

CRM can achieve Single Sign-On (SSO) with Ameyo using CRM's pluggable Authentication

API. To enable SSO, a CRM should provide an HTTP API which Ameyo can use to authenticate

and create session with the CRM server & to send the logout event (API call) to CRM

application when the logout is initiated at Ameyo. For SSO, CRM user should be the same as

Ameyo user-Id to determine the user role in Ameyo application.

4.1.2 API Details

The API will be of format:

<Protocol>://<CRM_SERVER_IP>:<PORT_Number>/<SOME_PATH>/login_logout

The API will be required to accept the Post parameter request XML. The XML encoded data

will be passed in predefined XML formats. The same API will be called in both login and

logout operations.

For Example :

URL :
<Protocol>://<Application_Domain_Name_or_IP><CRM_Port_Number>/crm/l
ogin_logout
Post Data :
requestXml=
<request><command>login</command><userId>agent</userId><password>ag
ent
</password> </request>

4.1.3 Procedure

Users have to login with their user id and CRM login password. CRM should call doLogin

function (know more…). Ameyo Application Server will invoke a login URL with user id and

password as parameters in the request format. In return, the CRM server will respond with

a CRM session Id on successful authentication.

The above-mentioned API will be called with login command along with the user id and

password entered by the user on Ameyo login Interface.

Copyright © AMEYO 2020 | Page 10

Ameyo Generic Toolbar Integration

Once doLogin function is called, then the request will be passed to Application Server for

login. The server will check the user id in Ameyo application. If found, the login request will

be sent to the CRM application using the login_logout API. Only those users who are

authenticated by CRM application will be able to login in Ameyo.

4.1.3.1 Sample Request XML

requestXml=<request>
<command>login</command>
<userId>user</userId>
<password>pass</password>
</request>

Command is a mandatory attribute and rest of the attributes will depend on the command.

4.1.3.2 Sample 1 (For Successful event)

<response>
<status>success</status>
<message>Auth Successful</message>
<crmSessionId>100322323-aaa-32</crmSessionId>
</response>

4.1.3.3 Sample Response XML {Sample 2 (For Failure Event)}

<response>
<status>failed</status>
<message>Incorrect Password</message>
<crmSessionId></crmSessionId>
</response>

Status and Message are mandatory fields. Other fields will depend on the command where:

1. Status: This will indicate the status authentication request. Possible values of status

are success or failure.

2. Message: Can be a string briefly describing the status.

Copyright © AMEYO 2020 | Page 11

Ameyo Generic Toolbar Integration

crmSessionId: This will be the unique session Id if the authentication request is successful.

This session Id will be then passed with other parameters of every web request (CRM /

Knowledge Base) for that user.

Figure: Login Screen

4.2 Logout

Invoked by Ameyo to intimate CRM that the CRM session should be terminated, as the user

has logged out of Ameyo.

Parameters: command, crmSessionId

When the user invokes the logout even on Ameyo Client UI, the same will be processed at

Ameyo Application. On successful logout, the Application server will invoke the login_logout

API with logout event to notify the CRM application about the logout event. The command

attribute will be set to logout in this case.

4.2.1 Sample Request XML

requestXml=<request>
<command>logout</command>

Copyright © AMEYO 2020 | Page 12

Ameyo Generic Toolbar Integration

<crmSessionId>100322323-aaa-32</crmSessionId>
</request>100322323-aaa-32</crmSessionId>
</request>

Command is a mandatory field and rest fields will depend on the command.

4.2.2 Sample Response XML

<response>
<status>success/failed</status>
<message></message>
</response>

Status and Message are mandatory fields. Other fields would depend on the command.

Possible values of status are success and failed

Where,

1. Status: Success or Failed, this will indicate the status authentication request.

2. Message: Can be a string briefly describing the status.

3. crmSessionId: Will be the unique Session-Id for authenticated CRM session received

from login API.

If a user logs out from Ameyo, Ameyo will invoke the SSO-URL with logout command. CRM

should terminate the existing CRM session.

4.3 Force Login

doForceLogin(); To do force login in toolbar.

This will only be called if a login has been failed giving an error as force login.

Example:

ameyo.integration.doForceLogin();

You also have a need of parameters like UserId to pass in it.

Copyright © AMEYO 2020 | Page 13

Ameyo Generic Toolbar Integration

Figure: Agent Availability after campaign Selection

The hidden data with the green line is the phone number of the agent who has logged in to

the toolbar.

Copyright © AMEYO 2020 | Page 14

Ameyo Generic Toolbar Integration

5. Dialing Number from CRM Application

Ameyo will expose a function to dial a number using click to call.

For Example:

ameyo.integration.doDial(phone,customerId, additionalParameters);

5.1 Request Parameters

Field Name Description

phone Caller Id for the customer call

UserId Id of the User.

(Optional) CustomerId Unique identifier for the customer in Ameyo

Additional Parameters in the form of "JSON" to be used by manual dial

AdditionalParameters
API in Ameyo(optional)

For Example:

ameyo.integration.doDial('<Phone_Number>','567', '{}');

Rest all functionalities to transfer, confer, hold etc shall be provided from the toolbar itself.

populateNumberInDialBox(phone);

This function puts the number in dial text box of toolbar.

5.2 Reponse Parameter

Field Name Description

phone Caller Id for the customer call

For Example

Copyright © AMEYO 2020 | Page 15

Ameyo Generic Toolbar Integration

ameyo.integration.populateNumberInDialBox('<Phone_Number>');

Figure: Sending Request to CRM on Dialing the Number

Copyright © AMEYO 2020 | Page 16

Ameyo Generic Toolbar Integration

6. Auto-Extension Selection

ameyo.integration.getExtensionInfo();

This function will be called from Ameyo, and it should return a JSON object containing

extension name and phone as a response of this function. If extension name and phone(in

case extension is not endpoint) are valid then the user's extension will be selected

automatically.

For Example:

function getExtensionInfo(){
var extensionInfo = {
name : '<Extension_Name>',
phone : '1111'
};
return extensionInfo;
}

Here, the "name" is the extension name which is defined in Ameyo for softphone/hard

phone, it can be seen from Ameyo UI.

Copyright © AMEYO 2020 | Page 17

Ameyo Generic Toolbar Integration

Figure: Extension Selection Event

Copyright © AMEYO 2020 | Page 18

Ameyo Generic Toolbar Integration

7. Handling Customer Information Pop-up on Call

Whenever Agent dials/receives the call, showCrm event is sent to CRM along with phone

number and some additional parameters.

showCrm function needs to be defined in CRM to handle the event.

In case the function is defined with a name other than showcrm then it needs to be

registered with registerCustomFunction.

ameyo.integration.showCrm(phone,additionalParameters);

7.1.1 Request Parameters

Field Name Description

Phone Caller Id for the customer call

Additional info in the form of JSON to be provided to CRM such as callId

AdditionalParameters
(optional)

For Example:

ameyo.integration.showCrm('<Phone_Number>',{'customerId':'567'});

The "showCrm" method will be invoked in the following scenarios:

1. Incoming Call:As part of an Inbound campaign, the agent receives a call through ACD

(Automatic Call Distribution system).

2. Auto Dial:As part of an outbound campaign, the agent receives an automated

predictive dialing or progressive dialing call.

3. Manual Dial:Agent dials a call from user interface.

4. Preview Dial:Agent previews the customer details before dialing either as part of a

preview dialing campaign or via the screen.

5. Callback Dial:Agent receives a callback scheduled in the past.

6. Click To Dial:Number clicked from CRM web page is dialed.

Copyright © AMEYO 2020 | Page 19

Ameyo Generic Toolbar Integration

7.2 Sample JS to register showCrm event with other functions

defined in CRM

Following is the Sample JS to register showCrm event with other functions defined in CRM.

var setRecordForShowCrmCallback = function(response) {

if (response.result) {
var crmPage = document.getElementById('crmPage');
var html = "<p>" + "Response : SetRecordShowCrm "
+ response.result.status + "</p>";
crmPage.innerHTML = html + "<br>" + crmPage.innerHTML;
}
};
function customShowCrm(phone, additionalParams, requestId) {
var crmPage = document.getElementById('crmPage');
var html = "Sending request to get CRM data for phone: " + phone
+ " Additional Parameters" + additionalParams
+ "<br> Recieving Response.."
+ "<br> Populating CRM data on the basis of response.."
+ "<br>Done";
crmPage.innerHTML = html + "<br>" + crmPage.innerHTML;
ameyo.integration.api.setRecordInfoForShowCrm(requestId, requestId, phone,
setRecordForShowCrmCallback);
}
customIntegration = {};
customIntegration.showCrm = customShowCrm;
ameyo.integration.registerCustomFunction("showCrm", customIntegration);

Copyright © AMEYO 2020 | Page 20

Ameyo Generic Toolbar Integration

8. Call Disposition

Ameyo will expose the following functions to dispose of a call:

1. Function 1- getDispositionCodes: CRM will call this function to get the two-level

disposition ( Disposition Class and Disposition Code) from function.

• Request Method:

getDispositionCodes(campaignId): In the request, method campaignId

shall be the id of campaign for which we need to get the two-level disposition

(Disposition Class and Disposition Code).

For Example:

ameyo.integration.getDispositionCodes(1)
or
ameyo.integration.getDispositionCodes()

ameyo.integration.getDispositionCodes(campaignId) is usable when user

have selected multiple campaign.

• Handler (Response):

handleDispositionCodes(object): Response of above request method shall

be received in this type of handler. In this handler, the object will contain two-

level disposition codes.

2. Function 2- CallbyDisposition: This function can be used to dispose of the current

call.

• Request Method

disposeCallByDisposition(dispositionCode): In the response of above

method disposition code shall be disposition with which respective call needs

to be disposed of.

For Example

Copyright © AMEYO 2020 | Page 21

Ameyo Generic Toolbar Integration

ameyo.integration.disposeCallByDisposition("'Foreign
Language").

In default release disposition code "Callback" is not allowed, but the same

can be enabled by customizing disposition nodeflow.

And, the callback will not be scheduled for the customer.

• Handler (Response):

handledisposeCallByDispositionCode(object): In response of above

method, the object is the status as success or failure, that is, whether the call

is successfully disposed with requested disposition code or not.

Copyright © AMEYO 2020 | Page 22

Ameyo Generic Toolbar Integration

9. Dispose and Dial

Ameyo will expose the dispose of & dial function to dispose of the current call and dial

another number:

disposeNDial: This function can be used to dispose of a call with a specific disposition code

and dial another number.

1. Request Method:

disposeNDial(dispositionCode,phone): In the request method disposition code

should the user disposition with which current call needs to be disposed of, and the

phone should be the number which has to be dialed after disposing of the current

call.

For Example

ameyo.integration.disposeNDial("Conference voice breakage","<phone_number>").

Disposition code can't be "Callback".

2. Handler (Response):

• handleDispositionCodes(object): In response of above method, object is the

status as success or failure, that is, whether the call is successfully disposed

with requested disposition code or not.

• handledisposeCallByDispositionCode(object):In this response, object is the

status of call dialed on phone number (passed in request method) that is,

whether the call was dialed successfully or not.

Copyright © AMEYO 2020 | Page 23

Ameyo Generic Toolbar Integration

10. Logout

ameyo.integration.doLogout();

When user logs out from CRM then CRM should logout from toolbar using doLogout()

function.

For Example:

ameyo.integration.doLogout();

Figure: Agent Logged Out

Copyright © AMEYO 2020 | Page 24

 Ameyo Generic Toolbar Integration

11. Toolbar Event and Handler

Just like showCrm event, toolbar provides few more events and handlers which are triggered

on the basis of action performed in the toolbar.

Function Parameter
When the event is called Request Data Data Passes / Response Send
Name s

OnSuccess:

Status or force login required

message
Whenever a person first creates a
OnFailure:
session in Server and logins into the

loginHandl loginReaso system. Possible Reasons: one calls

1. “auth.policy.incorrect”
er n doLogin function, someone logins

from the UI, auto relogin. 2. “username.or.password.e

Login Action : Yes mpty”

3. “unknown.error.occured.p

lease.refresh.or.retry”

Whenever a person session is

deleted in Server. Possible Reasons:

one calls doLogout function, OnSuccess:

logoutHand logoutReas
supervisor logs out the user, session "success"
ler on
timeout OnFailure: "Invalid sessionId"

Another Tab -- Yes

Logout -- Yes

Whenever the current page is

completely loaded. This event may

come multiple times because one

onLoadHan
page may get redirected to another
dler
page.

Refresh Page – Yes

Another Tab – Yes

This event will be received

whenever a person opens or

loginStatus refreshes the page. The event will

loginStatus status
Handler come only once

Refresh Page – Yes

Another Tab - Yes

Copyright © AMEYO 2020 | Page 25

 Ameyo Generic Toolbar Integration

Function Parameter
When the event is called Request Data Data Passes / Response Send
Name s

This event will be will received

whenever a person creates session status

forceLogin
reason in server forcefully in case the same forceLoginRequired: +
Handler
user is already login xmlhttp.responseText

Login – Yes

1. currentPhone
phone, This event will be received
2. requested
showCrm additionalP whenever a call arrives, or preview

arams is done to show CRM 3. additionalParamters(Crm

URL)

OnSuccess:

1. success

selectExten This event will be received 2. userCustomerCRTInfo

sionHandle status whenever an agent selects the

r extension OnException:

1. responseText detail

2. userCustomerCRTInfo

OnSuccess:

1. success

modifyExte This event will be received 2. userCustomerCRTInfo

nsionHandl status whenever an agent modifies the

er extension OnException:

1. responseText detail

2. userCustomerCRTInfo

selectCamp This event will be received

aignHandle status whenever an agent selects the campaignNameWithId

r Campaign.

This event will be received

autoCallOn OnSuccess:
status whenever an agent makes an
Handler "success"
AutoCall On

Copyright © AMEYO 2020 | Page 26

 Ameyo Generic Toolbar Integration

Function Parameter
When the event is called Request Data Data Passes / Response Send
Name s

This event will be received

autoCallOff OnSuccess:
status whenever an agent makes an
Handler "success"
AutoCall OFF

readyHandl This event is received whenever an Response status:

status
er agent turn its status to ready "Available"

Response status:

This event will be received 1. Training

breakHandl
status whenever an agent put its status on 2. Snacks
er
break
3. Lunch

4. Unavailable

OnSuccess:
This event will be received
hangupHan
status whenever an agent hang-ups the • "success"
dler
call
• userCustomerCRTInfo

transferToP This event will be received

Transfer.To.Phone.Request.Sent
honeHandl status whenever an agent transfers the call
userCustomerCRTInfo
er to another phone

This event will be received "Transfer.To.Phone.Incall.Request

transferInC
status whenever an agent transfers the call .Sent"
allHandler
to incall agent userCustomerCRTInfo

This event will be received Transfer.To.Agent.Queue.Request.S

transferToA
status whenever an agent transfers the call ent
QHandler
to Agent Queue userCustomerCRTInfo

This event will be received

transferToI Transfer.To.IVR.Request.Sent
status whenever an agent transfers the call
VRHandler userCustomerCRTInfo
to IVR

transferTo This event will be received

Transfer.To.User.Request.Sent
UserHandle status whenever an agent transfers the call
userCustomerCRTInfo
r to another User

transferToC This event will be received

Transfer.To.Campaign.Request.Sent
ampaignHa status whenever an agent transfers the call
userCustomerCRTInfo
ndler to the campaign

Copyright © AMEYO 2020 | Page 27

 Ameyo Generic Toolbar Integration

Function Parameter
When the event is called Request Data Data Passes / Response Send
Name s

conferWith This event will be received

Confer.Phone.Request.Sent
PhoneHand status whenever an agent confers the call
userCustomerCRTInfo
ler with another phone

This event will be received

conferWith Confer.With.TPV.Request.Sent
status whenever an agent confers the call
TPVHandler userCustomerCRTInfo
with TPV

conferWith This event will be received

Confer.With.User.Request.Sent
UserHandle status whenever an agent confers the call
userCustomerCRTInfo
r with another User

conferWith This event will be received

Confer.With.Local.Ivr.Request.Sent
LocalIVRHa status whenever an agent confers the call
userCustomerCRTInfo
ndler with Local IVR

This function can be used to get the

two-level disposition codes. A

getDispositi ArrayList of Disposition class and
campaignId campaign ID is the id of campaign
onCodes their disposition code
for which disposition codes to be

fetched.

handleDisp
Disposition Whenever a request is made for
ositionCod
code disposition codes.
es

disposeCall
disposition This function can be used to dispose call.disposed
ByDispositi
Code of the current call. userCustomerCRTInfo
on

handledisp

oseCallByDi Whenever a request is made to

Status
spositionCo dispose of the current call

de

disposition This function can be used to dispose

disposeNDi
Code,phon of a call with a specific disposition userCustomerCRTInfo
al
e code and dial another number.

handledisp
Whenever a request is made to
oseCallByDi
Status dispose current call and dial a
spositionCo
number.
de

Whenever a request is made to

handleMan
Status dispose current call and dial a
ualDial
number.

Copyright © AMEYO 2020 | Page 28

 Ameyo Generic Toolbar Integration

Function Parameter
When the event is called Request Data Data Passes / Response Send
Name s

handleFaile
When Exception occurs while
dDispositio Reason for failure of call with the
disposing of call or Null value of
nNotifyGen data type of String.
crtObjectId, disposition code.
eric

1. phoneNumber
ameyo.inte
2. selfCallBack
gration.dis
It is Called for setting callback using
poseAndSc 3. callBackTime
Third-Party CRM.
heduleCallb
4. callBackParams
ack
5. additionalParameters

ameyo.inte

gration.get
It is Called for getting disposition
Disposition
class with disposition code using campaignId
CodesWith
Third-Party CRM.
Disposition

Class

ameyo.inte 1. dispositionCode
gration.dis It is Called to schedule callback
2. additionalParameters
poseCallBy using Third-Party CRM.

Disposition 3. crtObjectId

ameyo.inte
It is called to get the list of
gration.get
disposition codes in the specified campaignId
Disposition
campaign
Codes

ameyo.inte 1. dispositionCode
It is Called to dispose of call with
gration.dis
disposition code using Third-Party 2. additionalParameters
poseCallBy
CRM.
Disposition 3. crtObjectId

ameyo.inte
It is Called to Force Login using
gration.doF
Third-Party CRM.
orceLogin

ameyo.inte
This function enables/disables dial
gration.pop
and preview button based on the phone It will populate Number as input
ulateNumb
input text
erInDialBox

Copyright © AMEYO 2020 | Page 29

 Ameyo Generic Toolbar Integration

Function Parameter
When the event is called Request Data Data Passes / Response Send
Name s

1. Phone

2. customerId
ameyo.inte
This function is Called to dial on
gration.do 3. additionalParams
Number using Third-Party CRM.
Dial
4. searchable

5. customerRecords

1. username
ameyo.inte Not working if a failure occurs.
This function is called for login using
gration.doL 2. password Message:
Third-Party CRM
ogin "already logged in"
3. authPolicy

ameyo.inte Not working if a failure occurs.

This function is called for logout
gration.doL Message:
using Third-Party CRM
ogout() "already logged out"

ameyo.inte
This function is used to dispose and 1. dispositionCode
gration.dis doDisposeNDialInCrm not defined.
dial the call. 2. phone
poseNDial

ameyo.inte
This function is used for the callContextId Not method in ameyo-
gration.sele
selection of the extension. phone genericPlugin.js
ctExtension

ameyo.inte

gration.set This function is used for getting the extensionName No method called from ameyo-

ExtensionIn Extension information. extensionPhone genericPlugin.

fo

Not working as userId and

ameyo.inte
It is used to get the Login username password are not passed to ameyo-
gration.setL
information. password toolbar-Web.js
oginInfo
handleLoginGeneric errors.

aameyo.int
This function is used to dispose of
egration.dis object
the chat conversation.
poseChat

ameyo.inte
This function is Called for refreshing
gration.refr
the telephony panel at third-party crtobjectId Not implemented in the toolbar
eshTelepho
CRM.
ny

Copyright © AMEYO 2020 | Page 30

 Ameyo Generic Toolbar Integration

Function Parameter
When the event is called Request Data Data Passes / Response Send
Name s

Not implemented in the toolbar.

This function is Called on Login page
intializeUI (implemented up to ameyo-
load or reload page or logout.
genericPlugin)

Copyright © AMEYO 2020 | Page 31