Voximplant

エージェントを作成または選択する

ElevenAgentsでエージェントを作成します。通話の接続直後に話し始める必要がある場合は、最初のメッセージを設定してください。 オーディオ形式はインテグレーションによって設定されるため、エージェントに設定された形式は Voximplant通話には使用されません。

通話終了を有効にする

エージェント → ツール → システムツール で 通話終了 を有効にし、エージェントが会話を終了できるようにします。 エージェントが通話終了時に示した理由は、決定とともにシナリオへ送信されます。

Voximplant転送ルールを追加する（任意）

エージェントが発信者を人間の担当者へ転送できるようにするには、プロバイダー設定がvoximplantの 転送ルールとともに 番号へ転送 システムツールを追加します。このルールには転送先がありません。 会話はtransfer-to-agentの決定で終了し、シナリオが発信者をルーティングします。転送ルールは APIで設定します。エージェントにPATCHを送信してツールを追加します。

curl -X PATCH "https://api.elevenlabs.io/v1/convai/agents/agent_7101k5zvyjhmfg983brhmhkd98n6" \
  -H "xi-api-key: $ELEVENLABS_API_KEY" -H "Content-Type: application/json" \
  -d '{
    "conversation_config": {"agent": {"prompt": {"built_in_tools": {
      "end_call": {"type": "system", "name": "end_call", "description": "",
                   "params": {"system_tool_type": "end_call"}},
      "transfer_to_number": {
        "type": "system", "name": "transfer_to_number", "description": "",
        "params": {
          "system_tool_type": "transfer_to_number",
          "transfers": [],
          "transfer_rules": [{
            "condition": "the caller asks to speak with a human",
            "provider_configs": [
              {"type": "voximplant", "config": {"type": "voximplant_handoff"}}
            ]
          }]
        }
      }
    }}}}
  }'

end_callなど、エージェントがすでに持っているツールを含む完全なbuilt_in_toolsオブジェクトを送信します。 エージェントが返す選択肢は固定トークンvoximplantなので、ツールごとにVoximplantルールが1つあれば 十分です。他のプロバイダー向けに設定された電話番号やSIP URIは、Voximplant通話では提示されません。

専用のAPIキーを作成する

エージェントと同じワークスペースでAPIキーを作成し、スコープをElevenAgentsに設定します。 Voximplantからの接続のみを許可するには、キーで許可するIPアドレスをVoximplantのメディアサーバーに制限します。 Voximplantのメディアサーバーは https://api.voximplant.com/getMediaResources?with_mediaserversに掲載されています。

WebSocket URLを確認する

シナリオは、エージェントIDを含むURLに接続します。

エージェントのブランチを固定するには、?branch_id=<branch_id>を追加します。

アプリケーションを作成する

Voximplantコントロールパネルで アプリケーション を開き、 アプリケーションを作成 をクリックします。elevenlabs-agentなどの名前を付け、 作成 をクリックします。

APIキーをシークレットとして保存する

アプリケーションで シークレット を開き、シークレットを追加 をクリックします。名前をELEVENLABS_API_KEYにし、 エージェントのワークスペース用に作成したAPIキーを 値 に貼り付けて、シークレットを追加 をクリックします。 シナリオはVoxEngine.getSecretValue()でAPIキーを読み取るため、シナリオコードにキーが表示されることはありません。

シナリオを作成する

シナリオ を開いて シナリオを作成 をクリックし、elevenlabs_agentという名前を付けます。以下のコードを貼り付け、 ELEVENLABS_URL内のエージェントIDを置き換えて、保存 をクリックします。このシナリオは着信通話に応答し、 エージェントへストリーミングして、会話終了時に決定に従って処理します。発信通話の場合は、発信した通話の CallEvents.Connectedハンドラー内でWebSocketを開きます。

const ELEVENLABS_URL =
  "wss://api.elevenlabs.io/v1/convai/conversation/voximplant/agent_7101k5zvyjhmfg983brhmhkd98n6";
VoxEngine.addEventListener(AppEvents.CallAlerting, ({ call }) => {
  call.answer();
  let decision = null;
  const ws = VoxEngine.createWebSocket(ELEVENLABS_URL, {
    headers: [
      {
        name: "Authorization",
        value: `Bearer ${VoxEngine.getSecretValue("ELEVENLABS_API_KEY")}`,
      },
    ],
  });
  ws.addEventListener(WebSocketEvents.OPEN, () => {
    call.sendMediaTo(ws, {
      encoding: WebSocketAudioEncoding.PCM16_8KHZ,
      customParameters: { customer_name: "Ana", task_id: "task-7" },
    });
    ws.sendMediaTo(call);
  });
  ws.addEventListener(WebSocketEvents.MESSAGE, ({ text }) => {
    const message = JSON.parse(text);
    if (message.customEvent === "elevenlabs-decision") {
      decision = message.payload;
      Logger.write(`ElevenLabs decision: ${JSON.stringify(decision)}`);
    }
  });
  ws.addEventListener(WebSocketEvents.CLOSE, (e) => {
    Logger.write(`ElevenLabs socket closed: code=${e.code} reason=${e.reason}`);
    if (decision?.action === "transfer-to-agent") {
      // Route the caller to a human here, for example with VoxEngine.callPSTN().
      call.say("Connecting you to an agent.", { language: VoiceList.Amazon.en_US_Joanna });
      call.addEventListener(CallEvents.PlaybackFinished, () => call.hangup());
      return;
    }
    call.hangup();
  });
  call.addEventListener(CallEvents.Disconnected, () => {
    ws.close();
    VoxEngine.terminate();
  });
});

通話をシナリオへルーティングする

ルーティング を開き、ルールを作成 をクリックして名前を付け、elevenlabs_agent シナリオを割り当てます。デフォルトのパターン.*では、すべての通話がシナリオ経由でアプリケーションへ送信されます。 アプリケーションが他の通話も処理する場合は、対象を電話番号に絞り込んでください。電話番号をルーティングするには、 番号 でアプリケーションに割り当てます。

テスト通話を発信する

電話番号がなくても、ブラウザからアプリケーションへ発信できます。

1. ユーザー を開き、ユーザーを作成 をクリックして、パスワード付きのユーザーを作成します。

   

2. ルーティング で テストツール、ソフトフォン の順にクリックします。そのユーザーとしてサインインし、 マイクへのアクセスを許可して、任意の宛先を入力して発信します。エージェントが最初のメッセージで応答します。

3. 通話が終了したら、通話履歴 を開きます。各通話には、通話自体の横にWebSocketレッグが表示されます。 ログを表示 をクリックしてセッションを確認します。

   

   ログには、ElevenLabsが送信した決定、WebSocketの切断、その後にシナリオが実行した処理が表示されます。 この例では発信者が人間の担当者を求めたため、決定はtransfer-to-agentとなり、 エージェントが示した理由も含まれています。