@wildix/wilma-voice-client 0.0.40 → 0.0.41

package/dist-types/commands/DescribeVoiceProtocolCommand.d.ts

@@ -27,7 +27,7 @@ declare const DescribeVoiceProtocolCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
 };
 /**
- * Describes the WebSocket connect parameters, events and commands of the voice protocol. Utility method; the generated shapes are the source of truth for building a WebSocket client or server by hand.
+ * Describes the WebSocket connect parameters, events and commands of the voice protocol, and the messages of the PBX media socket. Utility method; the generated shapes are the source of truth for building a WebSocket client or server by hand.
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -302,6 +302,141 @@ declare const DescribeVoiceProtocolCommand_base: {
  * //       reason: "hangup" || "transfer" || "timeout" || "error" || "complete", // required
  * //     },
  * //   },
+ * //   media: { // MediaProtocolFrames
+ * //     pbx: { // MediaPbxFrames
+ * //       start: { // MediaStartFrame
+ * //         type: "start", // required
+ * //         purpose: "agent" || "transcription", // required
+ * //         callId: "STRING_VALUE", // required
+ * //         flowIndex: Number("int"), // required
+ * //         sessionId: "STRING_VALUE", // required
+ * //         resume: true || false, // required
+ * //         resumeAtMs: Number("int"), // required
+ * //         audio: { // MediaAudioFormat
+ * //           encoding: "pcm_s16le", // required
+ * //           sampleRate: Number("int"), // required
+ * //           channels: Number("int"), // required
+ * //         },
+ * //         agent: { // MediaStartAgent
+ * //           id: "STRING_VALUE", // required
+ * //           draft: true || false,
+ * //           version: Number("int"),
+ * //         },
+ * //         languages: [ // MediaStartLanguageList
+ * //           "STRING_VALUE",
+ * //         ],
+ * //         preferredLanguage: "STRING_VALUE",
+ * //         autoDetect: true || false,
+ * //         caller: { // MediaStartCaller
+ * //           name: "STRING_VALUE",
+ * //           number: "STRING_VALUE",
+ * //           email: "STRING_VALUE",
+ * //           company: "STRING_VALUE",
+ * //         },
+ * //         dialedNumber: "STRING_VALUE",
+ * //         variables: "STRING_VALUE",
+ * //       },
+ * //       audio: new Uint8Array(),
+ * //       vad: { // MediaVadFrame
+ * //         type: "vad", // required
+ * //         party: "caller" || "callee", // required
+ * //         speaking: true || false, // required
+ * //         energyDb: Number("double"), // required
+ * //         atMs: Number("int"), // required
+ * //       },
+ * //       dtmf: { // MediaDtmfFrame
+ * //         type: "dtmf", // required
+ * //         id: "STRING_VALUE", // required
+ * //         digits: "STRING_VALUE", // required
+ * //       },
+ * //       playback: { // MediaPlaybackFrame
+ * //         type: "playback", // required
+ * //         replyId: "STRING_VALUE", // required
+ * //         streamId: "STRING_VALUE", // required
+ * //         event: "started" || "finished" || "stopped", // required
+ * //         atMs: Number("int"), // required
+ * //         playedMs: Number("int"),
+ * //         cause: "cloud" || "caller" || "drop",
+ * //       },
+ * //       finish: { // MediaFinishFrame
+ * //         type: "finish", // required
+ * //         reason: "caller-hangup" || "callee-hangup" || "agent-hangup" || "agent-transfer" || "timeout", // required
+ * //       },
+ * //     },
+ * //     cloud: { // MediaCloudFrames
+ * //       started: { // MediaStartedFrame
+ * //         type: "started", // required
+ * //         streamId: "STRING_VALUE", // required
+ * //         agent: { // MediaStartedAgent
+ * //           name: "STRING_VALUE", // required
+ * //         },
+ * //         groupId: "STRING_VALUE",
+ * //         backgroundSound: "STRING_VALUE",
+ * //         voiceDetection: { // MediaVoiceDetection
+ * //           silenceMs: Number("int"), // required
+ * //           silenceLevelDb: Number("int"), // required
+ * //           speechLevelDb: Number("int"), // required
+ * //         },
+ * //       },
+ * //       transcription: { // MediaTranscriptionFrame
+ * //         type: "transcription", // required
+ * //         party: "caller" || "callee", // required
+ * //         id: "STRING_VALUE", // required
+ * //         final: true || false, // required
+ * //         text: "STRING_VALUE", // required
+ * //         startMs: Number("int"), // required
+ * //         endMs: Number("int"), // required
+ * //         language: "STRING_VALUE", // required
+ * //         confidence: Number("double"),
+ * //       },
+ * //       audioBegin: { // MediaAudioBeginFrame
+ * //         type: "audio.begin", // required
+ * //         replyId: "STRING_VALUE", // required
+ * //         streamId: "STRING_VALUE", // required
+ * //         sampleRate: Number("int"), // required
+ * //       },
+ * //       audio: new Uint8Array(),
+ * //       audioEnd: { // MediaAudioEndFrame
+ * //         type: "audio.end", // required
+ * //         streamId: "STRING_VALUE", // required
+ * //       },
+ * //       stop: { // MediaStopFrame
+ * //         type: "stop", // required
+ * //       },
+ * //       duck: { // MediaDuckFrame
+ * //         type: "duck", // required
+ * //         replyId: "STRING_VALUE", // required
+ * //         volumeDb: Number("int"), // required
+ * //         rampMs: Number("int"), // required
+ * //       },
+ * //       restore: { // MediaRestoreFrame
+ * //         type: "restore", // required
+ * //         replyId: "STRING_VALUE", // required
+ * //         rampMs: Number("int"), // required
+ * //       },
+ * //       language: { // MediaLanguageFrame
+ * //         type: "language", // required
+ * //         language: "STRING_VALUE", // required
+ * //       },
+ * //       transfer: { // MediaTransferFrame
+ * //         type: "transfer", // required
+ * //         context: "STRING_VALUE", // required
+ * //         extension: "STRING_VALUE", // required
+ * //       },
+ * //       hangup: { // MediaHangupFrame
+ * //         type: "hangup", // required
+ * //       },
+ * //       error: { // MediaErrorFrame
+ * //         type: "error", // required
+ * //         code: "STRING_VALUE", // required
+ * //         retryable: true || false, // required
+ * //         message: "STRING_VALUE", // required
+ * //       },
+ * //       finished: { // MediaFinishedFrame
+ * //         type: "finished", // required
+ * //       },
+ * //     },
+ * //   },
  * // };
  *
  * ```

package/dist-types/commands/GetVoiceDefaultsCommand.d.ts

@@ -0,0 +1,90 @@
+import { Command as $Command } from "@smithy/core/client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { GetVoiceDefaultsInput, GetVoiceDefaultsOutput } from "../models/models_0";
+import type { ServiceInputTypes, ServiceOutputTypes, WilmaVoiceClientResolvedConfig } from "../WilmaVoiceClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetVoiceDefaultsCommand}.
+ */
+export interface GetVoiceDefaultsCommandInput extends GetVoiceDefaultsInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetVoiceDefaultsCommand}.
+ */
+export interface GetVoiceDefaultsCommandOutput extends GetVoiceDefaultsOutput, __MetadataBearer {
+}
+declare const GetVoiceDefaultsCommand_base: {
+    new (input: GetVoiceDefaultsCommandInput): import("@smithy/core/client").CommandImpl<GetVoiceDefaultsCommandInput, GetVoiceDefaultsCommandOutput, WilmaVoiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [GetVoiceDefaultsCommandInput]): import("@smithy/core/client").CommandImpl<GetVoiceDefaultsCommandInput, GetVoiceDefaultsCommandOutput, WilmaVoiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * Returns the voice channel tuning that applies to a call when the agent sets no value. The values can change without an agent change.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WilmaVoiceClient, GetVoiceDefaultsCommand } from "@wildix/wilma-voice-client"; // ES Modules import
+ * // const { WilmaVoiceClient, GetVoiceDefaultsCommand } = require("@wildix/wilma-voice-client"); // CommonJS import
+ * // import type { WilmaVoiceClientConfig } from "@wildix/wilma-voice-client";
+ * const config = {}; // type is WilmaVoiceClientConfig
+ * const client = new WilmaVoiceClient(config);
+ * const input = {};
+ * const command = new GetVoiceDefaultsCommand(input);
+ * const response = await client.send(command);
+ * // { // GetVoiceDefaultsOutput
+ * //   voiceDetection: { // VoiceDetectionDefaults
+ * //     silenceMs: Number("int"), // required
+ * //     silenceLevelDb: Number("int"), // required
+ * //     speechLevelDb: Number("int"), // required
+ * //   },
+ * //   interruptions: { // VoiceInterruptionDefaults
+ * //     minWords: Number("int"), // required
+ * //     minConfidence: Number("double"), // required
+ * //     duckAfterMs: Number("int"), // required
+ * //     duckVolumeDb: Number("int"), // required
+ * //     restoreAfterMs: Number("int"), // required
+ * //   },
+ * //   turnEnd: { // VoiceTurnEndDefaults
+ * //     holdMs: Number("int"), // required
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param GetVoiceDefaultsCommandInput - {@link GetVoiceDefaultsCommandInput}
+ * @returns {@link GetVoiceDefaultsCommandOutput}
+ * @see {@link GetVoiceDefaultsCommandInput} for command's `input` shape.
+ * @see {@link GetVoiceDefaultsCommandOutput} for command's `response` shape.
+ * @see {@link WilmaVoiceClientResolvedConfig | config} for WilmaVoiceClient's `config` shape.
+ *
+ * @throws {@link ValidationException} (client fault)
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *
+ * @throws {@link WilmaVoiceServiceException}
+ * <p>Base exception class for all service exceptions from WilmaVoice service.</p>
+ *
+ *
+ * @public
+ */
+export declare class GetVoiceDefaultsCommand extends GetVoiceDefaultsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: {};
+            output: GetVoiceDefaultsOutput;
+        };
+        sdk: {
+            input: GetVoiceDefaultsCommandInput;
+            output: GetVoiceDefaultsCommandOutput;
+        };
+    };
+}

package/dist-types/commands/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./DescribeVoiceProtocolCommand";
+export * from "./GetVoiceDefaultsCommand";
 export * from "./ListVoicesCommand";
 export * from "./SendHangupCommand";
 export * from "./SendPlayCommand";

package/dist-types/index.d.ts

@@ -8,11 +8,13 @@
  *     On the WebSocket (transport host `wilma-voice-ws.wildix.com`), PBX clients transcribe caller
  *     speech themselves and send `transcription` / `reply` text, while web/app clients connect with
  *     inputMode=AUDIO and push raw caller `audio` chunks that the service transcribes server-side;
- *     the service returns `say` / `play` / `stop` / `hangup` / `transfer`. Every WebSocket message
- *     shape (connect params, events and commands) is declared as a structure and enumerated by
- *     DescribeVoiceProtocol so the generated SDKs carry the types and (de)serializers; the WebSocket
- *     transport itself is hand-coded. The HTTP Send* operations push the same commands into a live
- *     session out-of-band.
+ *     the service returns `say` / `play` / `stop` / `hangup` / `transfer`. On the PBX media socket
+ *     (`/v2/voice/media/ws`, subprotocol `wilma-media-v2`), the PBX sends raw caller audio and the
+ *     service answers with audio and the text frames listed under DescribeVoiceProtocol `media`.
+ *     Every WebSocket message shape (connect params, events and commands) is declared as a structure
+ *     and enumerated by DescribeVoiceProtocol so the generated SDKs carry the types and
+ *     (de)serializers; the WebSocket transport itself is hand-coded. The HTTP Send* operations push
+ *     the same commands into a live session out-of-band.
  *
  *     Session observability and history are recorded in wilma-traces; this service does not expose
  *     bot configuration, traces or listing.

package/dist-types/models/enums.d.ts

@@ -145,3 +145,305 @@ export declare const VoiceCommandType: {
  * @public
  */
 export type VoiceCommandType = (typeof VoiceCommandType)[keyof typeof VoiceCommandType];
+/**
+ * @public
+ * @enum
+ */
+export declare const MediaAudioBeginFrameType: {
+    readonly AUDIO_BEGIN: "audio.begin";
+};
+/**
+ * @public
+ */
+export type MediaAudioBeginFrameType = (typeof MediaAudioBeginFrameType)[keyof typeof MediaAudioBeginFrameType];
+/**
+ * @public
+ * @enum
+ */
+export declare const MediaAudioEndFrameType: {
+    readonly AUDIO_END: "audio.end";
+};
+/**
+ * @public
+ */
+export type MediaAudioEndFrameType = (typeof MediaAudioEndFrameType)[keyof typeof MediaAudioEndFrameType];
+/**
+ * @public
+ * @enum
+ */
+export declare const MediaDuckFrameType: {
+    readonly DUCK: "duck";
+};
+/**
+ * @public
+ */
+export type MediaDuckFrameType = (typeof MediaDuckFrameType)[keyof typeof MediaDuckFrameType];
+/**
+ * @public
+ * @enum
+ */
+export declare const MediaErrorFrameType: {
+    readonly ERROR: "error";
+};
+/**
+ * @public
+ */
+export type MediaErrorFrameType = (typeof MediaErrorFrameType)[keyof typeof MediaErrorFrameType];
+/**
+ * @public
+ * @enum
+ */
+export declare const MediaFinishedFrameType: {
+    readonly FINISHED: "finished";
+};
+/**
+ * @public
+ */
+export type MediaFinishedFrameType = (typeof MediaFinishedFrameType)[keyof typeof MediaFinishedFrameType];
+/**
+ * @public
+ * @enum
+ */
+export declare const MediaHangupFrameType: {
+    readonly HANGUP: "hangup";
+};
+/**
+ * @public
+ */
+export type MediaHangupFrameType = (typeof MediaHangupFrameType)[keyof typeof MediaHangupFrameType];
+/**
+ * @public
+ * @enum
+ */
+export declare const MediaLanguageFrameType: {
+    readonly LANGUAGE: "language";
+};
+/**
+ * @public
+ */
+export type MediaLanguageFrameType = (typeof MediaLanguageFrameType)[keyof typeof MediaLanguageFrameType];
+/**
+ * @public
+ * @enum
+ */
+export declare const MediaRestoreFrameType: {
+    readonly RESTORE: "restore";
+};
+/**
+ * @public
+ */
+export type MediaRestoreFrameType = (typeof MediaRestoreFrameType)[keyof typeof MediaRestoreFrameType];
+/**
+ * @public
+ * @enum
+ */
+export declare const MediaStartedFrameType: {
+    readonly STARTED: "started";
+};
+/**
+ * @public
+ */
+export type MediaStartedFrameType = (typeof MediaStartedFrameType)[keyof typeof MediaStartedFrameType];
+/**
+ * @public
+ * @enum
+ */
+export declare const MediaStopFrameType: {
+    readonly STOP: "stop";
+};
+/**
+ * @public
+ */
+export type MediaStopFrameType = (typeof MediaStopFrameType)[keyof typeof MediaStopFrameType];
+/**
+ * @public
+ * @enum
+ */
+export declare const MediaParty: {
+    readonly CALLEE: "callee";
+    readonly CALLER: "caller";
+};
+/**
+ * @public
+ */
+export type MediaParty = (typeof MediaParty)[keyof typeof MediaParty];
+/**
+ * @public
+ * @enum
+ */
+export declare const MediaTranscriptionFrameType: {
+    readonly TRANSCRIPTION: "transcription";
+};
+/**
+ * @public
+ */
+export type MediaTranscriptionFrameType = (typeof MediaTranscriptionFrameType)[keyof typeof MediaTranscriptionFrameType];
+/**
+ * @public
+ * @enum
+ */
+export declare const MediaTransferFrameType: {
+    readonly TRANSFER: "transfer";
+};
+/**
+ * @public
+ */
+export type MediaTransferFrameType = (typeof MediaTransferFrameType)[keyof typeof MediaTransferFrameType];
+/**
+ * @public
+ * @enum
+ */
+export declare const MediaDtmfFrameType: {
+    readonly DTMF: "dtmf";
+};
+/**
+ * @public
+ */
+export type MediaDtmfFrameType = (typeof MediaDtmfFrameType)[keyof typeof MediaDtmfFrameType];
+/**
+ * @public
+ * @enum
+ */
+export declare const MediaFinishReason: {
+    /**
+     * The PBX ran the agent's `hangup`.
+     */
+    readonly AGENT_HANGUP: "agent-hangup";
+    /**
+     * The PBX ran the agent's `transfer`, or tried to and the target does not exist.
+     */
+    readonly AGENT_TRANSFER: "agent-transfer";
+    /**
+     * The callee hung up.
+     */
+    readonly CALLEE_HANGUP: "callee-hangup";
+    /**
+     * The caller hung up.
+     */
+    readonly CALLER_HANGUP: "caller-hangup";
+    /**
+     * The PBX got no agent reply in time.
+     */
+    readonly TIMEOUT: "timeout";
+};
+/**
+ * @public
+ */
+export type MediaFinishReason = (typeof MediaFinishReason)[keyof typeof MediaFinishReason];
+/**
+ * @public
+ * @enum
+ */
+export declare const MediaFinishFrameType: {
+    readonly FINISH: "finish";
+};
+/**
+ * @public
+ */
+export type MediaFinishFrameType = (typeof MediaFinishFrameType)[keyof typeof MediaFinishFrameType];
+/**
+ * @public
+ * @enum
+ */
+export declare const MediaPlaybackStopCause: {
+    /**
+     * The caller hung up or the run ended.
+     */
+    readonly CALLER: "caller";
+    /**
+     * A `stop` frame from the cloud.
+     */
+    readonly CLOUD: "cloud";
+    /**
+     * The PBX dropped the stream, for example at its queue limit.
+     */
+    readonly DROP: "drop";
+};
+/**
+ * @public
+ */
+export type MediaPlaybackStopCause = (typeof MediaPlaybackStopCause)[keyof typeof MediaPlaybackStopCause];
+/**
+ * @public
+ * @enum
+ */
+export declare const MediaPlaybackEvent: {
+    /**
+     * The stream played to its end.
+     */
+    readonly FINISHED: "finished";
+    /**
+     * The stream started to play.
+     */
+    readonly STARTED: "started";
+    /**
+     * The stream stopped before its end.
+     */
+    readonly STOPPED: "stopped";
+};
+/**
+ * @public
+ */
+export type MediaPlaybackEvent = (typeof MediaPlaybackEvent)[keyof typeof MediaPlaybackEvent];
+/**
+ * @public
+ * @enum
+ */
+export declare const MediaPlaybackFrameType: {
+    readonly PLAYBACK: "playback";
+};
+/**
+ * @public
+ */
+export type MediaPlaybackFrameType = (typeof MediaPlaybackFrameType)[keyof typeof MediaPlaybackFrameType];
+/**
+ * @public
+ * @enum
+ */
+export declare const MediaAudioEncoding: {
+    readonly PCM_S16LE: "pcm_s16le";
+};
+/**
+ * @public
+ */
+export type MediaAudioEncoding = (typeof MediaAudioEncoding)[keyof typeof MediaAudioEncoding];
+/**
+ * @public
+ * @enum
+ */
+export declare const MediaRunPurpose: {
+    /**
+     * A voice agent answers the call.
+     */
+    readonly AGENT: "agent";
+    /**
+     * The cloud transcribes the call and sends no audio.
+     */
+    readonly TRANSCRIPTION: "transcription";
+};
+/**
+ * @public
+ */
+export type MediaRunPurpose = (typeof MediaRunPurpose)[keyof typeof MediaRunPurpose];
+/**
+ * @public
+ * @enum
+ */
+export declare const MediaStartFrameType: {
+    readonly START: "start";
+};
+/**
+ * @public
+ */
+export type MediaStartFrameType = (typeof MediaStartFrameType)[keyof typeof MediaStartFrameType];
+/**
+ * @public
+ * @enum
+ */
+export declare const MediaVadFrameType: {
+    readonly VAD: "vad";
+};
+/**
+ * @public
+ */
+export type MediaVadFrameType = (typeof MediaVadFrameType)[keyof typeof MediaVadFrameType];