Skip to main content


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

Configuring event subscription

Updated on December 28, 2022

The Computer Telephony Integration (CTI) server sends events to the OpenCTI adapter to indicate a change in the status of the extension or of the CSR. Implement the SubscribeForEvents activity to subscribe to events and the UnSubscribeForEvents to stop event subscription.

The following activities are used in the OpenCTI implementation class to manage events:

SubscribeForEvents activity
The SubscribeForEvents activity is called to send a request to start an event subscription for a device when a user tries to monitor an extension.
UnSubscribeForEvents activity
This activity is called to send the request to stop event subscription for a device when a CSR logs out.
  1. In the header of Dev Studio, search for the SubscribeForEvents activity in the OpenCTI adapter class.
  2. Copy the activity into the implementation class and add the Pega Platform version 8.7 integration connector to subscribe to the event for a device.
  3. On the Activity page, add the properties that are required for your adapter to subscribe to events for devices.
    The following table shows the properties of the SubscribeForEvents activity:

    Properties of the SubscribeForEvents activity

    Property NameProperty Name
    DNThe device number on which the event is subscribed
    AgentIDThe agent ID logged into the extension
    AgentPasswordThe password configured for that agent ID
    Some CTI servers do not require AgentID and AgentPassword for monitoring. In such cases, as the OpenCTI developer, you can ignore these properties when subscribing to events.
    Result: If subscribing to events for a device fails, Pega Call displays an error.
  4. In the header of Dev Studio, search for the UnSubscribeForEvents activity in the OpenCTI adapter class.
  5. Copy this activity to the implementation class and add the Pega Platform version 8.7 integration connector to unsubscribe from events for devices.
    The following table shows te properties of the UnSubscribeForEvents activity. You can see these properties on the adapter step page of the clipboard.

    Properties of the UnSubscribeForEvents activity

    Property NameProperty Name
    DNThe device number for which the event is subscribed
    AgentIDThe agent ID logged in to the extension
    AgentPasswordThe password configured for that agent ID
    If unsubscribing from events for a device fails, Pega Call displays an error.

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