メインコンテンツまでスキップ

Events 一覧

eventType の取り得る値は全 18 種類(発信通話 12 + 着信通話 6)です。本ページは各 eventTypeいつ発火するか をまとめたリファレンスです。

備考

全イベントは 同一の payload 構造 で配信されます(Payload 仕様 参照)。差分は eventType の値 + エラー時の body.errors[] の有無のみで、ペイロードの形は共通です。

発信通話イベント (OUTBOUND, 12 種類)

eventType表記発火条件
OUTBOUND_CALL_PENDING保留中発信通話がキューに入った直後
OUTBOUND_CALL_REQUESTEDリクエスト受付通話実行のリクエストを受信し、電話回線プロバイダへ発信指示を出した状態
OUTBOUND_CALL_CALLING発信中相手に呼び出しが進行中、または通話接続中
OUTBOUND_CALL_CLOSING発信終了処理中通話切断後の後処理フェーズ
OUTBOUND_CALL_COMPLETED発信通話完了通話が正常に完了。errors が空でなければエラー有り完了
OUTBOUND_CALL_EXPIRED期限切れ発信予約時間ウィンドウを超過
OUTBOUND_CALL_NO_RESPONSE応答なし相手の呼び出しに応答がなかった
OUTBOUND_CALL_CANCELEDキャンセルユーザー操作で PENDING からキャンセル
OUTBOUND_CALL_BUSY話し中相手回線が話し中
OUTBOUND_CALL_UNREACHABLE到達不可電波圏外・電源 OFF など、到達できなかった
OUTBOUND_CALL_MAX_ATTEMPTS_REACHED最大試行回数到達再発信を含む試行回数が上限到達
OUTBOUND_CALL_ERROR発信エラー発信通話でエラー発生(body.errors[] に詳細)

着信通話イベント (INBOUND, 6 種類)

eventType表記発火条件
INBOUND_CALL_CONNECTING接続中着信を受け、内部処理を開始した状態
INBOUND_CALL_CALLING着信通話中着信通話が成立し対話進行中
INBOUND_CALL_CLOSING着信終了処理中通話切断後の後処理フェーズ
INBOUND_CALL_COMPLETED着信通話完了着信通話が正常に完了
INBOUND_CALL_CONCURRENCY_LIMIT_EXCEEDED同時実行制限超過プロジェクトの同時通話数上限に到達
INBOUND_CALL_ERROR着信エラー着信通話でエラー発生(body.errors[] に詳細)

配信されるか / されないか

ダッシュボードの 「通知トリガー」セクション で個別に ON/OFF 可能です。OFF にしたイベントは配信されません。

受信側実装の基本パターン

function onWebhook(payload: WebhookPayload) {
const { eventType, body } = payload;

// ① エラー判定は body.errors の有無で
if (body.errors?.length) {
handleError(eventType, body);
return;
}

// ② eventType で分岐
switch (eventType) {
case 'OUTBOUND_CALL_COMPLETED':
case 'INBOUND_CALL_COMPLETED':
onCompleted(body);
break;
case 'OUTBOUND_CALL_NO_RESPONSE':
case 'OUTBOUND_CALL_BUSY':
case 'OUTBOUND_CALL_UNREACHABLE':
onUnreachable(body);
break;
// ... 他の eventType も同様
default:
// 未知の eventType でも落ちないように
console.log(`Unknown eventType: ${eventType}`);
}
}

詳細実装は 受信サンプル を参照してください。

関連ドキュメント