Class ZoomCCItem

  • All Implemented Interfaces:

    
    public final class ZoomCCItem
    
                        

    Initialize ZoomCCService with ZoomCCItem. Contains engagement information.

    • Method Detail

      • getEngagementVariables

         final Map<String, String> getEngagementVariables()

        Host application context variables passed to the engagement created by the SDK.

        A developer can create a variable in the Contact Center admin portal at Contact Center Management -> Variables -> System variables or Custom variables, select that its value comes from the application, and configure its attribute name. For example, if the configured attribute name is test_value, pass the application value using the key-value format test_value to value in this map.

        The map key must be the configured attributeName, and the map value is the value supplied by the host application. The SDK compares these values with the variable definitions returned after login and sends only matching variables to the backend. Not passing a variable does not block the main engagement flow, although nodes that depend on that variable may not be displayed or processed correctly.

        This property is optional and defaults to null. It is kept outside the constructor so adding future engagement context values does not change the existing constructor API.

      • setEngagementVariables

         final Unit setEngagementVariables(Map<String, String> engagementVariables)

        Host application context variables passed to the engagement created by the SDK.

        A developer can create a variable in the Contact Center admin portal at Contact Center Management -> Variables -> System variables or Custom variables, select that its value comes from the application, and configure its attribute name. For example, if the configured attribute name is test_value, pass the application value using the key-value format test_value to value in this map.

        The map key must be the configured attributeName, and the map value is the value supplied by the host application. The SDK compares these values with the variable definitions returned after login and sends only matching variables to the backend. Not passing a variable does not block the main engagement flow, although nodes that depend on that variable may not be displayed or processed correctly.

        This property is optional and defaults to null. It is kept outside the constructor so adding future engagement context values does not change the existing constructor API.

      • getEntryId

         final String getEntryId()

        Indicate the entry ID. Start a video, chat or ZVA engagement.

      • getApiKey

         final String getApiKey()

        Indicate the api-key. Start a scheduled callback engagement or web campaign service.

      • getServerType

         final CCServerType getServerType()

        Indicate the server type. CCServerGo, CCServerQA, and CCServerDev are for testing. Default server type is CCServerWWW, which is for official use only.

      • getUseCampaignMode

         final Boolean getUseCampaignMode()

        Indicate whether to use campaign mode to start the engagement. Default value is NO. If set to YES, set the property ZoomCCItem.campaignInfo with a valid value.

      • getCampaignInfo

         final ZoomCCCampaignInfo getCampaignInfo()

        Used for the campaign type engagement start. If this property is set with valid value, it means you are using campaign mode to start a service such as chat, video, or scheduled callbacks.