Wipple CPaaS
メニュー
Function リファレンス / Config

Config

注意

config Function はノンブロッキングです。

{
  "verb": "config",
  "synthesizer": {
    "voice": "Jenny"
  },
  "recognizer": {
    "vendor": "google",
    "language": "de-DE"
  },
  "bargeIn": {
    "enable": true,
    "input" : ["speech"],
    "actionHook: "/userInput"
    }
}

パラメータ

amdboolean

留守番電話検出を有効にします。詳細は dial Function の amd プロパティを参照してください。


actionHookDelayActionobject

アプリケーションのアクションフックへの応答が遅れた場合に適用する動作を記述するオブジェクト(gather Function と同じオプション)。


bargeInobject

このオブジェクトには、「バックグラウンド」の gather Function を生成するために使用されるプロパティが含まれます。


bargeIn.enableboolean

true の場合、セッションが他の Function を実行している間、音声または DTMF 入力の聞き取りを開始します。これは「バックグラウンド gather」と呼ばれ、gather Function の外でユーザー入力を取得するための仕組みです。false の場合、進行中のバックグラウンドの聞き取りタスクを停止します。


bargeIn.stickyboolean

true で、かつ bargeIn.enable が true の場合、バックグラウンド gather が音声または DTMF の検出で完了すると、自動的に別のバックグラウンド gather を開始します。


bargeIn.actionHookstring

バックグラウンド gather でユーザー入力が収集された場合に呼び出す Webhook。


bargeIn.inputarray必須

許可する入力タイプを指定する配列: ['digits']、['speech']、または ['digits', 'speech']。


bargeIn.finishOnKeystring

DTMF 入力の終了を示す DTMF キー。


bargeIn.numDigitsnumber

収集する DTMF 数字の正確な桁数。


bargeIn.minDigitsnumber

収集する DTMF 数字の最小桁数。デフォルトは 1 です。


bargeIn.maxDigitsnumber

収集する DTMF 数字の最大桁数。


bargeIn.interDigitTimeoutnumber

minDigits 桁が入力された後、次の数字を待つ時間。


boostAudioSignalstring | number

発信者/着信側への送出音声信号の強度を増減するデシベル数を示す文字列または整数値。例: "-6 dB"。これはメイントラックにのみ適用され、dub トラックには適用されないことに注意してください。


fillerNoiseobject

リモートアプリケーションが gather の文字起こし結果を処理している間、発信者に音声を再生します。これはセッション全体の設定で、gather Function レベルで上書きできます。


fillerNoise.enableboolean必須

フィラーノイズを有効にするか無効にするか。


fillerNoise.urlstring必須

フィラーノイズとして再生する http(s) 音声。


fillerNoise.startDelaySecsnumber

フィラーノイズを再生する前に、リモートアプリケーションからの応答を待つ秒数を指定する整数値(デフォルト: 結果の送信直後に再生)。


listenobject

ネストされた listen アクション。WebSocket 接続経由でリモートサーバーに音声をストリーミングすることで、この時点以降の通話を録音できます。


notifyEventsboolean

WebSocket 接続でのイベント通知(Function:status メッセージ)を有効にするかどうか。この機能を有効にするには、WebSocket 経由で送信する Function に "id" プロパティも含める必要があります。


onHoldMusicstring

通話が保留されたときに使用するリモートの音楽ソースの URL を指定します。


recognizerobject

セッションレベルのデフォルトの音声認識設定を変更します。recognizer プロパティの詳細は transcribe Function を参照してください。


resetstring | array

'recognizer' および/または 'synthesizer' をアプリケーションのデフォルト設定にリセットします。


recordobject

通話録音を管理するオプション。


record.actionstring必須

"startCallRecording"、"stopCallRecording"、"pauseCallRecording"、または "resumeCallRecording"。


record.typestring

録音タイプを指定します。
指定可能な値:

  • siprec (デフォルト)
  • cloud

record.silenceboolean

action : pauseCallRecording の場合、これを true に設定すると録音が無音で埋められます。 デフォルトは false で、一時停止中は録音ファイルが切り詰められます。


record.siprecServerURLstring

SIPREC サーバーの SIP URI。
注意: action が "startCallRecording" で、かつ type が "cloud" でない場合は必須です。


record.recordingIDstring

録音を識別するためのユーザー指定の文字列。 注意: siprec 録音でのみ使用されます


transcribeobject

ネストされた transcribe アクション。通話の文字起こしをバックグラウンドで送信できます。


transcribe.enableboolean必須

true の場合は文字起こしを開始し、false の場合は停止します。


transcribe.transcriptionHookstring必須

文字起こし結果の送信先となる Webhook/WebSocket の識別子(文字起こしを有効にする場合は必須)。


transcribe.recognizerobject

recognizer のオプション。


sipRequestWithinDialogHookstring | object

ダイアログ内で SIP リクエスト(INFO、NOTIFY、REFER など)を受信したときに呼び出す Webhook。


synthesizerobject

セッションレベルのデフォルトの音声合成設定を変更します。synthesizer プロパティの詳細は say Function を参照してください。


disableTtsCacheboolean

通話セッション全体で TTS キャッシュを無効にします


noiseIsolationobject

通話音声の背景ノイズを低減するサーバーサイドのノイズ除去を有効または無効にします。騒がしい環境での STT 精度の向上に役立ちます。


noiseIsolation.enableboolean

ノイズ除去を有効にするか無効にするか。


noiseIsolation.vendorstring

ノイズ除去ベンダー: "krisp" または "rnnoise"。Krisp が利用できるかどうかはサービスプランによります。RNNoise はオープンソースで、API キーは不要です。


noiseIsolation.levelnumber

抑制レベル 0〜100。値が大きいほど強力に抑制します。デフォルト: 100。


noiseIsolation.modelstring

任意のモデル名の上書き。


turnTakingobject

会話型 AI アプリケーション向けのターンテイキング検出を有効または無効にします。ターンテイキングは、無音検出のみに頼るのではなく、音響モデルを使用してユーザーの発話が終了したかどうかを判定します。


turnTaking.enableboolean

ターンテイキング検出を有効にするか無効にするか。


turnTaking.vendorstring

ターンテイキングベンダー: "krisp"。Krisp が利用できるかどうかはサービスプランによります。


turnTaking.thresholdnumber

信頼度のしきい値 0.0〜1.0。値が小さいほど早くターンが切り替わります(より積極的)。デフォルト: 0.5。


turnTaking.modelstring

任意のモデル名の上書き。