@wildix/wim-voicebots-client > DescribeEventCommand
DescribeEventCommand class
Utility method to describe available events for websocket and webhook events.
Signature:
export declare class DescribeEventCommand extends DescribeEventCommand_base
Extends: DescribeEventCommand_base
Example
Use a bare-bones client and the command you need to make an API call.
import { VoiceBotsClient, DescribeEventCommand } from "@wildix/wim-voicebots-client"; // ES Modules import
// const { VoiceBotsClient, DescribeEventCommand } = require("@wildix/wim-voicebots-client"); // CommonJS import
const client = new VoiceBotsClient(config);
const input = {};
const command = new DescribeEventCommand(input);
const response = await client.send(command);
// { // DescribeEventOutput
// TranscriptionWebsocketEvent: { // TranscriptionWebsocketEvent
// type: "STRING_VALUE", // required
// event: { // TranscriptionEvent
// type: "started" || "ended" || "reply" || "playback" || "transcription" || "interruption" || "complete", // required
// id: "STRING_VALUE", // required
// text: "STRING_VALUE", // required
// final: true || false,
// time: Number("long"), // required
// },
// },
// ReplyWebsocketEvent: { // ReplyWebsocketEvent
// type: "STRING_VALUE", // required
// event: { // ReplyEvent
// type: "started" || "ended" || "reply" || "playback" || "transcription" || "interruption" || "complete", // required
// id: "STRING_VALUE", // required
// text: "STRING_VALUE", // required
// startTime: Number("long"), // required
// endTime: Number("long"), // required
// },
// },
// PlaybackWebsocketEvent: { // PlaybackWebsocketEvent
// type: "STRING_VALUE", // required
// event: { // PlaybackEvent
// type: "started" || "ended" || "reply" || "playback" || "transcription" || "interruption" || "complete", // required
// replyId: "STRING_VALUE", // required
// text: "STRING_VALUE", // required
// complete: true || false, // required
// startTime: Number("long"), // required
// endTime: Number("long"),
// },
// },
// InterruptionWebsocketEvent: { // InterruptionWebsocketEvent
// type: "STRING_VALUE", // required
// event: { // InterruptionEvent
// type: "started" || "ended" || "reply" || "playback" || "transcription" || "interruption" || "complete", // required
// replyId: "STRING_VALUE", // required
// playedText: "STRING_VALUE", // required
// originalText: "STRING_VALUE", // required
// time: Number("long"), // required
// },
// },
// CompleteWebsocketEvent: { // CompleteWebsocketEvent
// type: "STRING_VALUE", // required
// event: { // CompleteEvent
// type: "started" || "ended" || "reply" || "playback" || "transcription" || "interruption" || "complete", // required
// reason: "STRING_VALUE", // required
// time: Number("long"), // required
// },
// },
// SayWebsocketCommand: { // SayWebsocketCommand
// type: "STRING_VALUE", // required
// command: { // SayWebsocketCommandData
// text: "STRING_VALUE", // required
// replyId: "STRING_VALUE", // required
// interruptible: true || false,
// type: "say" || "hangup" || "transfer", // required
// },
// },
// HangupWebsocketCommand: { // HangupWebsocketCommand
// type: "STRING_VALUE", // required
// command: { // HangupWebsocketCommandData
// reason: "STRING_VALUE",
// type: "say" || "hangup" || "transfer", // required
// },
// },
// TransferWebsocketCommand: { // TransferWebsocketCommand
// type: "STRING_VALUE", // required
// command: { // TransferWebsocketCommandData
// context: "STRING_VALUE", // required
// extension: "STRING_VALUE", // required
// type: "say" || "hangup" || "transfer", // required
// },
// },
// SessionStartedWebhookEvent: { // SessionStartedWebhookEvent
// sessionId: "STRING_VALUE", // required
// botId: "STRING_VALUE", // required
// callId: "STRING_VALUE", // required
// flowIndex: Number("int"), // required
// event: { // SessionStartedEvent
// type: "started" || "ended" || "reply" || "playback" || "transcription" || "interruption" || "complete", // required
// language: "STRING_VALUE", // required
// time: Number("long"), // required
// },
// },
// SessionEndedWebhookEvent: { // SessionEndedWebhookEvent
// sessionId: "STRING_VALUE", // required
// botId: "STRING_VALUE", // required
// callId: "STRING_VALUE", // required
// flowIndex: Number("int"), // required
// event: { // SessionEndedEvent
// type: "started" || "ended" || "reply" || "playback" || "transcription" || "interruption" || "complete", // required
// error: "STRING_VALUE",
// time: Number("long"), // required
// },
// },
// TranscriptionWebhookEvent: { // TranscriptionWebhookEvent
// sessionId: "STRING_VALUE", // required
// botId: "STRING_VALUE", // required
// callId: "STRING_VALUE", // required
// flowIndex: Number("int"), // required
// event: {
// type: "started" || "ended" || "reply" || "playback" || "transcription" || "interruption" || "complete", // required
// id: "STRING_VALUE", // required
// text: "STRING_VALUE", // required
// final: true || false,
// time: Number("long"), // required
// },
// },
// ReplyWebhookEvent: { // ReplyWebhookEvent
// sessionId: "STRING_VALUE", // required
// botId: "STRING_VALUE", // required
// callId: "STRING_VALUE", // required
// flowIndex: Number("int"), // required
// event: {
// type: "started" || "ended" || "reply" || "playback" || "transcription" || "interruption" || "complete", // required
// id: "STRING_VALUE", // required
// text: "STRING_VALUE", // required
// startTime: Number("long"), // required
// endTime: Number("long"), // required
// },
// },
// PlaybackWebhookEvent: { // PlaybackWebhookEvent
// sessionId: "STRING_VALUE", // required
// botId: "STRING_VALUE", // required
// callId: "STRING_VALUE", // required
// flowIndex: Number("int"), // required
// event: {
// type: "started" || "ended" || "reply" || "playback" || "transcription" || "interruption" || "complete", // required
// replyId: "STRING_VALUE", // required
// text: "STRING_VALUE", // required
// complete: true || false, // required
// startTime: Number("long"), // required
// endTime: Number("long"),
// },
// },
// InterruptionWebhookEvent: { // InterruptionWebhookEvent
// sessionId: "STRING_VALUE", // required
// botId: "STRING_VALUE", // required
// callId: "STRING_VALUE", // required
// flowIndex: Number("int"), // required
// event: {
// type: "started" || "ended" || "reply" || "playback" || "transcription" || "interruption" || "complete", // required
// replyId: "STRING_VALUE", // required
// playedText: "STRING_VALUE", // required
// originalText: "STRING_VALUE", // required
// time: Number("long"), // required
// },
// },
// CompleteWebhookEvent: { // CompleteWebhookEvent
// sessionId: "STRING_VALUE", // required
// botId: "STRING_VALUE", // required
// callId: "STRING_VALUE", // required
// flowIndex: Number("int"), // required
// },
// PubSubBroadcastWebsocketEvent: { // PubSubBroadcastWebsocketEvent
// event: "STRING_VALUE", // required
// topic: "STRING_VALUE", // required
// items: [ // PubSubBroadcastItems // required
// { // PubSubBroadcastItem
// session: { // TraceSession
// sessionId: "STRING_VALUE", // required
// connectionId: "STRING_VALUE", // required
// company: "STRING_VALUE", // required
// botId: "STRING_VALUE", // required
// botName: "STRING_VALUE", // required
// callId: "STRING_VALUE", // required
// flowIndex: Number("int"), // required
// language: "STRING_VALUE",
// callerName: "STRING_VALUE",
// callerNumber: "STRING_VALUE",
// status: "complete" || "complete_with_error" || "pending", // required
// start: Number("double"), // required
// duration: Number("int"),
// },
// sessionId: "STRING_VALUE",
// activity: { // TraceActivity
// id: "STRING_VALUE", // required
// version: Number("int"), // required
// status: "pending" || "error" || "complete" || "cancelled", // required
// trigger: { // TraceActivityTrigger Union: only one key present
// connectEvent: { // TraceConnectEventTrigger
// parameters: "DOCUMENT_VALUE",
// },
// disconnectEvent: { // TraceDisconnectEventTrigger
// parameters: "DOCUMENT_VALUE",
// },
// replyEvent: {
// type: "STRING_VALUE", // required
// event: {
// type: "started" || "ended" || "reply" || "playback" || "transcription" || "interruption" || "complete", // required
// id: "STRING_VALUE", // required
// text: "STRING_VALUE", // required
// startTime: Number("long"), // required
// endTime: Number("long"), // required
// },
// },
// completeEvent: {
// type: "STRING_VALUE", // required
// event: {
// type: "started" || "ended" || "reply" || "playback" || "transcription" || "interruption" || "complete", // required
// reason: "STRING_VALUE", // required
// time: Number("long"), // required
// },
// },
// interruptionEvent: {
// type: "STRING_VALUE", // required
// event: {
// type: "started" || "ended" || "reply" || "playback" || "transcription" || "interruption" || "complete", // required
// replyId: "STRING_VALUE", // required
// playedText: "STRING_VALUE", // required
// originalText: "STRING_VALUE", // required
// time: Number("long"), // required
// },
// },
// playbackEvent: {
// type: "STRING_VALUE", // required
// event: {
// type: "started" || "ended" || "reply" || "playback" || "transcription" || "interruption" || "complete", // required
// replyId: "STRING_VALUE", // required
// text: "STRING_VALUE", // required
// complete: true || false, // required
// startTime: Number("long"), // required
// endTime: Number("long"),
// },
// },
// transcriptionEvent: {
// type: "STRING_VALUE", // required
// event: {
// type: "started" || "ended" || "reply" || "playback" || "transcription" || "interruption" || "complete", // required
// id: "STRING_VALUE", // required
// text: "STRING_VALUE", // required
// final: true || false,
// time: Number("long"), // required
// },
// },
// sayCommand: {
// type: "STRING_VALUE", // required
// command: {
// text: "STRING_VALUE", // required
// replyId: "STRING_VALUE", // required
// interruptible: true || false,
// type: "say" || "hangup" || "transfer", // required
// },
// },
// hangupCommand: {
// type: "STRING_VALUE", // required
// command: {
// reason: "STRING_VALUE",
// type: "say" || "hangup" || "transfer", // required
// },
// },
// transferCommand: {
// type: "STRING_VALUE", // required
// command: {
// context: "STRING_VALUE", // required
// extension: "STRING_VALUE", // required
// type: "say" || "hangup" || "transfer", // required
// },
// },
// silenceTimeoutTask: { // TraceSilenceTimeoutTaskTrigger
// parameters: "DOCUMENT_VALUE",
// },
// durationTimeoutTask: { // TraceDurationTimeoutTaskTrigger
// parameters: "DOCUMENT_VALUE",
// },
// },
// result: { // TraceActivityResult Union: only one key present
// error: { // TraceErrorResult
// internal: true || false, // required
// message: "STRING_VALUE", // required
// },
// text: "STRING_VALUE",
// },
// start: Number("double"), // required
// duration: Number("int"),
// usage: { // TraceUsage
// generation: { // TraceGenerationUsage
// tokens: Number("int"),
// outputTokens: Number("int"),
// inputTokens: Number("int"),
// },
// transcribe: { // TraceTranscribeUsage
// seconds: Number("int"),
// },
// playback: { // TracePlaybackUsage
// chars: Number("int"),
// },
// },
// },
// segment: { // TraceSegment
// id: "STRING_VALUE", // required
// activityId: "STRING_VALUE", // required
// version: Number("int"), // required
// status: "pending" || "error" || "complete", // required
// input: { // TraceSegmentInput Union: only one key present
// completion: { // TraceSegmentCompletionInput
// instructions: "STRING_VALUE", // required
// messages: [ // TraceSegmentCompletionMessagesList // required
// { // TraceSegmentCompletionMessageItem Union: only one key present
// user: { // TraceSegmentCompletionMessage Union: only one key present
// text: "STRING_VALUE",
// tools: [ // TraceSegmentCompletionToolMessagesList
// { // TraceSegmentCompletionToolMessage
// call: { // TraceToolCall Union: only one key present
// transfer: { // TraceTransferToolCall
// context: "STRING_VALUE",
// extension: "STRING_VALUE",
// },
// hangup: {},
// wait: {},
// delegation: { // TraceDelegationToolCall
// id: "STRING_VALUE",
// },
// function: { // TraceFunctionToolCall
// name: "STRING_VALUE",
// args: "STRING_VALUE",
// request: { // TraceFunctionToolCallRequest
// url: "STRING_VALUE",
// method: "STRING_VALUE",
// headers: { // TraceSegmentRequestInputHeaders
// "<keys>": "STRING_VALUE",
// },
// body: "STRING_VALUE",
// },
// },
// },
// result: "STRING_VALUE",
// },
// ],
// },
// bot: {// Union: only one key present
// text: "STRING_VALUE",
// tools: [
// {
// call: {// Union: only one key present
// transfer: {
// context: "STRING_VALUE",
// extension: "STRING_VALUE",
// },
// hangup: {},
// wait: {},
// delegation: {
// id: "STRING_VALUE",
// },
// function: {
// name: "STRING_VALUE",
// args: "STRING_VALUE",
// request: {
// url: "STRING_VALUE",
// method: "STRING_VALUE",
// headers: {
// "<keys>": "STRING_VALUE",
// },
// body: "STRING_VALUE",
// },
// },
// },
// result: "STRING_VALUE",
// },
// ],
// },
// },
// ],
// },
// tool: {// Union: only one key present
// transfer: {
// context: "STRING_VALUE",
// extension: "STRING_VALUE",
// },
// hangup: {},
// wait: {},
// delegation: {
// id: "STRING_VALUE",
// },
// function: {
// name: "STRING_VALUE",
// args: "STRING_VALUE",
// request: {
// url: "STRING_VALUE",
// method: "STRING_VALUE",
// headers: {
// "<keys>": "STRING_VALUE",
// },
// body: "STRING_VALUE",
// },
// },
// },
// oauth: { // TraceOAuthInput
// clientId: "STRING_VALUE",
// clientSecret: "STRING_VALUE",
// endpointUrl: "STRING_VALUE",
// scope: "STRING_VALUE",
// },
// generic: { // TraceGenericInput
// title: "STRING_VALUE", // required
// blocks: [ // TraceGenericInputBlocksList
// { // TraceGenericInputBlock
// title: "STRING_VALUE", // required
// content: { // TraceGenericInputBlockContent Union: only one key present
// text: "STRING_VALUE",
// json: "DOCUMENT_VALUE",
// },
// },
// ],
// },
// },
// result: { // TraceSegmentResult Union: only one key present
// error: {
// internal: true || false, // required
// message: "STRING_VALUE", // required
// },
// tools: [ // TraceSegmentToolsResult
// "<TraceToolCall>",
// ],
// text: "STRING_VALUE",
// json: "DOCUMENT_VALUE",
// },
// start: Number("double"), // required
// duration: Number("int"),
// },
// },
// ],
// },
// PubSubSubscribeWebsocketCommand: { // PubSubSubscribeWebsocketCommand
// action: "STRING_VALUE", // required
// topic: "STRING_VALUE", // required
// },
// PubSubSubscribedWebsocketEvent: { // PubSubSubscribedWebsocketEvent
// event: "STRING_VALUE", // required
// topic: "STRING_VALUE", // required
// },
// PubSubUnsubscribeWebsocketCommand: { // PubSubUnsubscribeWebsocketCommand
// action: "STRING_VALUE", // required
// topic: "STRING_VALUE", // required
// },
// PubSubUnsubscribedWebsocketEvent: { // PubSubUnsubscribedWebsocketEvent
// event: "STRING_VALUE", // required
// topic: "STRING_VALUE", // required
// },
// };