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}`);
}
}
詳細実装は 受信サンプル を参照してください。
関連ドキュメント
- Payload 仕様 — 全イベント共通の JSON 構造
- callStatus 一覧 —
body.data.callStatusの取り得る値(eventType との対応含む) - リトライ仕様 — 配信失敗時の再送ルール