Skip to main content

Veritran Docs

[en] Start Engagement

[en] 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.

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

[en] Function ID

[en] Register

[en] Value

110

2

[en] Input Registers

[en] Register

[en] Description

[en] Mandatory

[en] Value

390

[en] 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).

[en] Yes

[en] String

391

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

[en] Yes

[en] String

[en] Output Registers

[en] Register

[en] Description

[en] Value

112

[en] Call Result

000

[en] NO_ERROR

001

[en] GENERIC_ERROR

004

[en] INVALID_ENGAGEMENT_TYPE_PARAMETER

006

[en] MISSING_START_ENGAGEMENT_PARAMETERS

008

[en] START_ENGAGEMENT_INITIALIZATION_ERROR