Skip to main content

@wildix/wim-voicebots-client

wim-voicebots-client package

Classes

Class

Description

CreateVoiceBotCommand

Creates a new voice bot with the specified configuration for the company.

DeleteVoiceBotCommand

Deletes an existing voice bot and all its associated data.

DescribeEventCommand

Utility method to describe available events for websocket and webhook events.

ForbiddenException

GetTraceCommand

Retrieves detailed trace information for a specific voice bot session.

GetVoiceBotCommand

Retrieves details of a specific voice bot by its unique identifier.

ListTracesCommand

Retrieves a list of voice bot trace sessions for the specified company.

ListVoiceBotsCommand

Retrieves a list of all voice bots for the specified company.

ListVoiceBotsNamesCommand

Retrieves a list of voice bot names and basic information for the specified company.

SendHangupCommand

Terminates the voice session and the call.

SendPlayCommand

Plays the specified audio chunk through the audio stream of the voice session.

SendSayCommand

Generates and plays the specified text through the audio stream of the voice session.

SendStopCommand

Stop playing and ongoing audio from the voice bot.

SendTransferCommand

Transfers the call to the specified context and extension, and terminates the voice bot session.

UpdateVoiceBotCommand

Updates the configuration of an existing voice bot with new settings.

ValidationException

VoiceBotNonUniqueNameException

VoiceBotNotFoundException

VoiceBots

VoiceBotsClient

VoiceBotsServiceException

Base exception class for all service exceptions from VoiceBots service.

VoiceSessionNotFoundException

Interfaces

Interface

Description

AudioEvent

AudioWebhookEvent

BotDialogflowCxEndpoint

BotOpenAiAssistantEndpoint

BotSqsEndpoint

BotWebhookEndpoint

ClientDefaults

CompleteEvent

CompleteWebhookEvent

CompleteWebsocketEvent

CreateVoiceBotCommandInput

The input for CreateVoiceBotCommand.

CreateVoiceBotCommandOutput

The output of CreateVoiceBotCommand.

CreateVoiceBotInput

CreateVoiceBotOutput

DeleteVoiceBotCommandInput

The input for DeleteVoiceBotCommand.

DeleteVoiceBotCommandOutput

The output of DeleteVoiceBotCommand.

DeleteVoiceBotInput

DeleteVoiceBotOutput

DescribeEventCommandInput

The input for DescribeEventCommand.

DescribeEventCommandOutput

The output of DescribeEventCommand.

DescribeEventInput

DescribeEventOutput

GetTraceCommandInput

The input for GetTraceCommand.

GetTraceCommandOutput

The output of GetTraceCommand.

GetTraceInput

GetTraceOutput

GetVoiceBotCommandInput

The input for GetVoiceBotCommand.

GetVoiceBotCommandOutput

The output of GetVoiceBotCommand.

GetVoiceBotInput

GetVoiceBotOutput

HangupWebsocketCommand

HangupWebsocketCommandData

InterruptionEvent

InterruptionWebhookEvent

InterruptionWebsocketEvent

ListTracesCommandInput

The input for ListTracesCommand.

ListTracesCommandOutput

The output of ListTracesCommand.

ListTracesInput

ListTracesOutput

ListVoiceBotsCommandInput

The input for ListVoiceBotsCommand.

ListVoiceBotsCommandOutput

The output of ListVoiceBotsCommand.

ListVoiceBotsInput

ListVoiceBotsNamesCommandInput

The input for ListVoiceBotsNamesCommand.

ListVoiceBotsNamesCommandOutput

The output of ListVoiceBotsNamesCommand.

ListVoiceBotsNamesInput

ListVoiceBotsNamesOutput

ListVoiceBotsOutput

PlaybackEvent

PlaybackWebhookEvent

PlaybackWebsocketEvent

PlayWebsocketCommand

PlayWebsocketCommandData

PubSubBroadcastItem

PubSubBroadcastWebsocketEvent

PubSubSubscribedWebsocketEvent

PubSubSubscribeWebsocketCommand

PubSubUnsubscribedWebsocketEvent

PubSubUnsubscribeWebsocketCommand

ReplyEvent

ReplyWebhookEvent

ReplyWebsocketEvent

RuntimeExtension

SayCommandAudioOptions

SayWebsocketCommand

SayWebsocketCommandData

SendHangupCommandInput

The input for SendHangupCommand.

SendHangupCommandOutput

The output of SendHangupCommand.

SendHangupInput

SendHangupOutput

SendPlayCommandInput

The input for SendPlayCommand.

SendPlayCommandOutput

The output of SendPlayCommand.

SendPlayInput

SendPlayOutput

SendSayCommandInput

The input for SendSayCommand.

SendSayCommandOutput

The output of SendSayCommand.

SendSayInput

SendSayOutput

SendStopCommandInput

The input for SendStopCommand.

SendStopCommandOutput

The output of SendStopCommand.

SendStopInput

SendStopOutput

SendTransferCommandInput

The input for SendTransferCommand.

SendTransferCommandOutput

The output of SendTransferCommand.

SendTransferInput

SendTransferOutput

SessionEndedEvent

SessionEndedWebhookEvent

SessionStartedEvent

SessionStartedWebhookEvent

StopWebsocketCommand

StopWebsocketCommandData

Trace

TraceActivity

TraceConnectEventTrigger

TraceDelegationToolCall

TraceDisconnectEventTrigger

TraceDurationTimeoutTaskTrigger

TraceErrorResult

TraceFunctionToolCall

TraceFunctionToolCallRequest

TraceGenerationUsage

TraceGenericInput

TraceGenericInputBlock

TraceHangupToolCall

TraceOAuthInput

TracePlaybackUsage

TraceSegment

TraceSegmentCompletionInput

TraceSegmentCompletionToolMessage

TraceSession

TraceSilenceTimeoutTaskTrigger

TraceTranscribeUsage

TraceTransferToolCall

TraceUsage

TraceWaitToolCall

TranscriptionEvent

TranscriptionWebhookEvent

TranscriptionWebsocketEvent

TransferWebsocketCommand

TransferWebsocketCommandData

UpdateVoiceBotCommandInput

The input for UpdateVoiceBotCommand.

UpdateVoiceBotCommandOutput

The output of UpdateVoiceBotCommand.

UpdateVoiceBotInput

UpdateVoiceBotOutput

VoiceBot

VoiceBotCapabilityTool

VoiceBotCapabilityToolPipeline

VoiceBotEmbeddedTool

VoiceBotFunctionDefinition

VoiceBotFunctionIntegrationWebhook

VoiceBotFunctionIntegrationWebhookAuthorizationBasic

VoiceBotFunctionIntegrationWebhookAuthorizationBearer

VoiceBotFunctionIntegrationWebhookAuthorizationOAuth

VoiceBotFunctionIntegrationWebhookHeader

VoiceBotInfo

VoiceBotKnowledgeBase

VoiceBotLlmEndpoint

VoiceBotPipelineSettings

VoiceBotPromptMetadata

VoiceBotPromptMetadataDisabled

VoiceBotPromptMetadataEnabled

VoiceBotPromptMetadataTime

VoiceBots

VoiceBotsClientConfig

The configuration interface of VoiceBotsClient class constructor that set the region, credentials and other options.

VoiceBotsClientResolvedConfig

The resolved configuration interface of VoiceBotsClient class. This is resolved and normalized from the constructor configuration interface.

VoiceBotTerminateHangupAction

VoiceBotTerminateTransferAction

VoiceBotTool

VoiceBotToolVariable

VoiceBotToolVariableAutoHandler

VoiceBotToolVariableGuidedHandler

VoiceBotToolVariablePredefinedHandler

VoiceBotVariable

Namespaces

Namespace

Description

TraceActivityResult

TraceActivityTrigger

TraceGenericInputBlockContent

TraceSegmentCompletionMessage

TraceSegmentCompletionMessageItem

TraceSegmentInput

TraceSegmentResult

TraceToolCall

VoiceBotCapability

VoiceBotEndpoint

VoiceBotFunctionIntegration

VoiceBotFunctionIntegrationWebhookAuthorization

VoiceBotPipelineTerminateAction

VoiceBotToolVariableHandler

Variables

Variable

Description

TraceActivityStatus

TraceSegmentStatus

TraceSessionStatus

VoiceBotCapabilityToolPipelineType

VoiceBotCommandType

VoiceBotEmbeddedToolType

VoiceBotEventType

VoiceBotFunctionIntegrationMethod

VoiceBotToolType

Type Aliases

Type Alias

Description

ServiceInputTypes

ServiceOutputTypes

TraceActivityResult

TraceActivityStatus

TraceActivityTrigger

TraceGenericInputBlockContent

TraceSegmentCompletionMessage

TraceSegmentCompletionMessageItem

TraceSegmentInput

TraceSegmentResult

TraceSegmentStatus

TraceSessionStatus

TraceToolCall

VoiceBotCapability

VoiceBotCapabilityToolPipelineType

VoiceBotCommandType

VoiceBotEmbeddedToolType

VoiceBotEndpoint

VoiceBotEventType

VoiceBotFunctionIntegration

VoiceBotFunctionIntegrationMethod

VoiceBotFunctionIntegrationWebhookAuthorization

VoiceBotPipelineTerminateAction

VoiceBotsClientConfigType

VoiceBotsClientResolvedConfigType

VoiceBotToolType

VoiceBotToolVariableHandler