| Field
|
Field type
|
Description
|
Usage
|
| botId
|
Mandatory
|
Specifies the bot that should establish communication.
|
Based on the provided bot details, the corresponding configurations, use cases, and settings are applied.
|
| conversationId
|
Mandatory
|
Must be unique and is required to initialize the SDK.
|
The SDK uses this identifier to persist and map agent conversations, fetch conversation logs, and generate dashboard analytics.
|
| domainURL
|
Mandatory
|
Defines the environment where APIs and socket requests should be established.
|
Enables communication between the bot and the application.
|
| token
|
Mandatory
|
Validates whether the end user is authenticated.
|
Essential for establishing communication, generated using the ClientId and Client Secret of the respective bot.
payload = {
sub: <clientId>,
appId: <clientId>,
iss: <clientId>,
}
|
| channel
|
Mandatory
|
Indicates the channel through which the customer communicates with the agent.
|
The selected channel determines specific configurations such as use cases, settings, and preferences (for example, Send and Copy, Transcript Tab, Analytics Usage).
|
| interactiveLanguage
|
Optional
|
Determines the language in which the application is loaded.
|
If no language is provided, English (en) is used by default.
|
| sessionId
|
Optional / Mandatory for voice
|
Optional in general, but mandatory for voice if a customer-bot conversation summary is required.
|
Enables the display of conversation history in the Transcript tab, showing what occurred before escalation to the agent.
|
| isSecure
|
Mandatory
|
Specifies the type of token.
|
The flag determines which authentication API to call. Based on that response, the SDK selects the appropriate service endpoint, initializes the socket connection, and routes all subsequent API requests through that endpoint.
|
| customData
|
Optional
|
Allows passing additional details.
|
These details can be used in the bot context or other areas depending on requirements.
|