Skip to main content


         This documentation site is for previous versions. Visit our new documentation site for current releases.      
 

The login function

Updated on October 6, 2021

This function is used to log an agent in to the Automatic Call Distributor (ACD). Once the agent is logged in to the ACD, the agent receives calls from the queue and can set their agent state to either the Ready or Not Ready state.

When the login request is successful, a snapshot event must be generated by the OpenCTI developer and moved to the Pega Call layer by using the Event callback function that is received as a parameter for the login function. The snapshot event is used to synchronize Pega Call's state with the CTI platform for an extension.

If there is an error in the request, handle it as explained in Handling errors.

This function uses the following parameters:

Parameters of the login function

ParameterDescription
agentIDThe agent ID on the Automatic Call Distributor (ACD). This is a required parameter and it is populated during the login request. You can save this parameter in a property that is available throughout a session.
agentPwdThe password for the agent on the ACD or queue. This is a required parameter and it is populated during the login request.
extensionSpecifies the device number of the device that the agent logs in to. You can configure the agents to log in and log out of a specific extension. If this property is left blank, then the agent is logged into the extension specified by the CTI server or Automatic Call Distributor (ACD). This is an optional property. You can save this parameter in a property that is available throughout a session.
linkDefinitionThe CTI link definition that is configured. You can save this parameter in a property that is available throughout a session.
optionsThe parameter that holds optional properties that are implementation specific.
successThe call back function that is invoked on success.
failureThe call back function that is invoked on failure.
fowardEventThe invoked call back function that is used to pass the event into the Pega Call OpenCTI framework to update the CTI toolbar.

To send a login request to the CTI server, copy the function from the interface file and implement it.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us