通話の更新

認証

• Authorization ヘッダー (ベアラートークン, 必須) — Bearer <token> 形式のベアラー認証です。token にはご自身の認証トークンを指定します。

リクエスト

パスパラメータ

• AccountSidstring必須
• CallSidstring必須

ボディ (application/json)

このエンドポイントはオブジェクトを受け取ります。

• call_hookWebhook任意
• child_call_hookWebhook任意
• call_statusenum任意
• 指定可能な値: completed, no-answer
• conf_mute_statusenum任意
• 指定可能な値: mute, unmute
• conf_hold_statusenum任意
• 指定可能な値: hold, unhold
• listen_statusenum任意
• 指定可能な値: pause, silence, resume
• mute_statusenum任意
• 指定可能な値: mute, unmute
• transcribe_statusenum任意
• 指定可能な値: pause, resume
• whisperobject任意
• sip_requestsip_request任意
• recordrecord任意
• conferenceParticipantActionconference_participant_action任意
• dtmfdtmf任意
• stream_statusenum任意アクティブな stream Function を一時停止または再開します。
• 指定可能な値: pause, silence, resume
• tagmap from string to any任意通話に顧客データタグを設定します。自由形式のキーと値のオブジェクトです。
• dubdub任意通話に追加のオーディオトラックを追加または削除します。
• boostAudioSignalobject任意指定したデシベル分だけ音声信号を増幅します (例: 6 または "6dB")。
• media_pathenum任意アクティブな Dial Function の実行中にメディアパスを更新します。
• 指定可能な値: no-media, partial-media, full-media
• noise_isolation_statusenum任意通話のノイズ除去を有効または無効にします。
• 指定可能な値: enable, disable
• noise_isolation_vendorstring任意ノイズ除去のベンダー。デフォルトは krisp です。
• noise_isolation_leveldouble任意ノイズ除去レベル (0〜100)。デフォルトは 100 です。
• noise_isolation_modelstring任意ノイズ除去モデルの識別子。
• agent_updateagent_update任意アクティブな agent Function を会話の途中で更新します。

レスポンス

200

受理されました

202

受理されました

エラー

400 Bad Request Error

不正なリクエスト

• any

404 Not Found Error

通話が見つかりません

• any

422 Unprocessable Entity Error

処理できないエンティティ

• msgstring必須

500 Internal Server Error

システムエラー

• msgstring必須

型定義

Webhook

• urlstring必須
• webhook_sidstring任意
• methodenum任意
• 指定可能な値: get, post
• usernamestring任意
• passwordstring任意

sip_request

• methodstring任意
• content_typestring任意
• contentstring任意
• headersobject任意

record

• actionenum任意
• 指定可能な値: startCallRecording, stopCallRecording, pauseCallRecording, resumeCallRecording
• typeenum任意デフォルト: siprec
• 指定可能な値: cloud, siprec
• recordingIDstring任意startCallRecording および SIPREC で使用します
• siprecServerURLstring任意startCallRecording および SIPREC で使用します
• silenceboolean任意デフォルト: false録音を一時停止した際、ファイルを無音でパディングします

conference_participant_action

• actionenum任意
• 指定可能な値: tag, untag, coach, uncoach, mute, unmute, hold, unhold
• tagstring任意

dtmf

• digitenum必須送信する 1 桁の数字
• 指定可能な値: 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, *, #
• durationinteger任意デフォルト: 250トーンの長さ (ミリ秒)

dub

通話に追加のオーディオトラックを追加または削除します。

• actionenum必須
• 指定可能な値: startDub, stopDub
• trackstring必須トラック名の識別子。
• playstring任意再生する音声の URL。
• sayobject任意TTS の設定。
• loopboolean任意再生をループするかどうか。
• gaindouble任意ゲイン (デシベル)。

agent_update

アクティブな agent Function を会話の途中で更新します。

• typeenum必須実行するエージェント更新の種類。
• 指定可能な値: update_instructions, inject_context, update_tools, generate_reply
• instructionsstring任意新しいシステムプロンプト (update_instructions 用)。
• messageslist of agent_update_messages_items任意会話履歴に追加するメッセージ (inject_context 用)。
• toolslist of agent_update_tools_items任意置き換え後のツール定義 (update_tools 用)。
• user_inputstring任意LLM に与えるプロンプトのテキスト (generate_reply 用)。
• interruptboolean任意デフォルト: false現在のアシスタントの発話を中断するかどうか (generate_reply 用)。

whisper

• verbenum任意各プロパティの詳細は Say または Play を参照してください
• 指定可能な値: say, play

agent_update_messages_items

• roleenum必須
• 指定可能な値: user, assistant
• contentstring必須

agent_update_tools_items

• namestring任意
• descriptionstring任意
• parametersobject任意

例

例 1

リクエスト

{}

レスポンス

{}

cURL

curl -X PUT "https://{API_ENDPOINT}/v1/Accounts/AccountSid/Calls/CallSid" \
  -H "Authorization: Bearer <token>"

Python

import requests

url = "https://{API_ENDPOINT}/v1/Accounts/AccountSid/Calls/CallSid"

headers = {
    "Authorization": "Bearer <token>"
}

response = requests.put(url, headers=headers)

print(response.json())

JavaScript

const url = 'https://{API_ENDPOINT}/v1/Accounts/AccountSid/Calls/CallSid';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

リクエスト

{}

レスポンス

{}

cURL

curl -X PUT "https://{API_ENDPOINT}/v1/Accounts/AccountSid/Calls/CallSid" \
  -H "Authorization: Bearer <token>"

Python

import requests

url = "https://{API_ENDPOINT}/v1/Accounts/AccountSid/Calls/CallSid"

headers = {
    "Authorization": "Bearer <token>"
}

response = requests.put(url, headers=headers)

print(response.json())

JavaScript

const url = 'https://{API_ENDPOINT}/v1/Accounts/AccountSid/Calls/CallSid';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}