SDK Reference

Interfaces

Setup

create

▸ create(options): Client

The starting point of the package. Call create to create a Voice+ client.

Parameters

Name

Type

Description

options

Config

configuration options for the client

Returns

Client

a Voice+ client

Example

const client = nlxai.voicePlus.create({
  // hard-coded params
  apiKey: "REPLACE_WITH_API_KEY",
  workspaceId: "REPLACE_WITH_WORKSPACE_ID",
  scriptId: "REPLACE_WITH_SCRIPT_ID",
  // dynamic params
  conversationId: "REPLACE_WITH_CONVERSATION_ID",
  languageCode: "en-US",
});

client.sendStep("REPLACE_WITH_STEP_ID");

Defined in

index.ts:26

Client

Context

Ƭ Context: Record<string, any>

context to send back to the voice bot, for usage later in the intent.

Defined in

index.ts:143

Other

StepInfo

Ƭ StepInfo: string | { stepId: string ; stepTriggerDescription?: string }

Step information, either a step ID as a single string or an object

Defined in

index.ts:95

Interfaces

Interface: Client

The Voice+ client

Properties

sendStep

• sendStep: (step: StepInfo, context?: Context) => Promise<void>

Example

const client = nlxai.voicePlus.create({
  // hard-coded params
  apiKey: "REPLACE_WITH_API_KEY",
  workspaceId: "REPLACE_WITH_WORKSPACE_ID",
  scriptId: "REPLACE_WITH_SCRIPT_ID",
  // dynamic params
  conversationId: "REPLACE_WITH_CONVERSATION_ID",
  languageCode: "en-US",
});

client.sendStep("REPLACE_WITH_STEP_ID", { selectedSeat: "4a" });