Skip to main content

Veritran Docs

Start Engagement

This function allows you to start the SDK and enable communication between the end user and an operator. The engagement methods available include chat, voice call and video call.

In this function, you must configure the input register values shown in the Input Registers section.

Function ID

Register

Value

110

2

Input Registers

Register

Description

Mandatory

Value

390

Queued ID (QUEUED_ID): ID of the queue to which the user is directed. For example, you may choose to direct the user to a different queue depending on their category (e.g. platinum or black).

Yes

String

391

Engagement method (ENGAGEMENT_KIND): Way in which communication with the user is initialized. The engagement methods available include: chat, voice_call or audio_call.

Yes

String

Output Registers

Register

Description

Value

112

Call Result

000

NO_ERROR

001

GENERIC_ERROR

004

INVALID_ENGAGEMENT_TYPE_PARAMETER

006

MISSING_START_ENGAGEMENT_PARAMETERS

008

START_ENGAGEMENT_INITIALIZATION_ERROR