ZoomCCItem Class Reference

Used to initialize [ZoomCCService]. Contains engagement information. More...

#include <ZoomCCInterface.h>

Inheritance diagram for ZoomCCItem:

Properties
NSString *	entryId
	Used to start a video or chat engagement.
NSString *	apiKey
	Used to start a scheduled callback.
ZoomCCIInterfaceType	sdkType
	Indicates the channel type, either chat or video.
BOOL	useCampaignMode
	Indicate whether to use campaign mode to start the engagement. Default value is NO. If set to YES, set the property campaignInfo with valid value.
ZoomCCCampaignInfo *	campaignInfo
	Used for the campaign type engagement start. If this property is set with a valid value, it means you are using campaign mode to start a servce, such as chat, video, or scheduled callbacks.
NSDictionary< NSString *, NSString * > *	engagementVariables
	Application-provided values for variables configured in Contact Center.

Detailed Description

Used to initialize [ZoomCCService]. Contains engagement information.

Property Documentation

engagementVariables

- (NSDictionary<NSString *, NSString *>*) engagementVariables

readwritenonatomiccopy

Application-provided values for variables configured in Contact Center.

Discussion:

Configure a System variable or Custom variable in Contact Center Management > Variables and select the option that allows the application to provide its value. Use the configured attribute name as the dictionary key, not the variable name. For example, if the attribute name is "customer_type", pass"customer_type": @"premium"}.

Only string values are supported. The SDK matches the supplied attributes with the variables returned by the server after login and sends the matching values when it creates a chat, ZVA, or video engagement. Values for variables that are not required by the current engagement are ignored.

Passing no value does not block engagement creation, but UI elements or flow nodes that depend on a missing variable may not be displayed or behave as expected. Do not pass secrets, access tokens, passwords, or other sensitive data as engagement variables.

---

The documentation for this class was generated from the following file:

• ZoomCCInterface.h