コール・イベント

呼制御メソッドへの応答で配信されるか、イベントに対するクエリで配信されるか、Webhook経由で配信されるかにかかわらず、電話呼の状態を表すすべてのイベントは、共通のフィールドと意味を持つ。すべての呼イベントは、以下のプロパティを持つ：

プロパティ	説明
`id`	イベントのユニークID
`userId`	イベントに関連するVISユーザーID
`accountId`	イベントに関連付けられたVISアカウントID
`externalId`	外部通信プロバイダーから提供されたイベントのユニークID。
`direction`	INBOUNDまたはOUTBOUNDのいずれか
`phoneNumber`	相手先の電話番号
`callerId`	リモート・パーティーの名前
`state`	コール状態。
`duration`	呼び出しの長さ（ミリ秒単位）
`startTime`	通話が開始されたISO-8601日時。発信の場合、開始時刻は通話が発信された時刻を示し、着信の場合、通話が最初に着信された時刻を示す。
`answerTime`	通話に応答したISO-8601日時
`endTime`	通話が終了したISO-8601日時

イベント開催国

VIS API は、Vonage Business Communications と Vonage Enterprise の違いと複雑さを隠して、電話通話のイベント状態モデルを提示します。これらのイベント・ステートはメソッドAPI(place callやget callsなど)に応答して配信され、Webhookイベント通知に含まれます。イベント・ステート・モデルを理解することは、外部統合を構築する上で非常に重要です。

以下の有限ステートマシンは、許容される状態遷移を記述している：

唯一の初期状態は Initializing.許容される終了状態は次のとおりです。 Answered, Cancelled, Rejectedそして Missed.最終的な終了状態のいずれかにあるコール状態は、常に終了状態に留まる。

州	初回	決勝	ディレクション	許容されるトランジション	説明
初期化	はい	いいえ	インバウンド	呼び出し音、応答あり	通話は発信されたが、相手側にはまだ通知されていない。
呼び出し音	いいえ	いいえ	インバウンド, アウトバウンド	有効、回答済み、キャンセル、拒否、行方不明	リモートパーティにアラート（発信）または着信が発生している
アクティブ	いいえ	いいえ	インバウンド, アウトバウンド	回答済み、保持、リモート保持	通話中で、参加者が話している
開催	いいえ	いいえ	インバウンド, アウトバウンド	アクティブ	現在保留中の通話
遠隔操作	いいえ	いいえ	インバウンド, アウトバウンド	アクティブ	アクティブな通話の相手側が保留中である。
回答済み	いいえ	はい	インバウンド, アウトバウンド		持続時間が0でない通話が終了した
キャンセル	いいえ	はい	アウトバウンド		相手先が応答する前に、発信がキャンセルされた。
欠場	いいえ	はい	インバウンド		着信に応答しない
不採用	いいえ	はい	インバウンド		着信が拒否された、または応答されずにボイスメールに送られた

各州の startTime, answerTime, endTimeそして duration は一定のルールに従う。

すべてのコールステートには有効な startTime.だけである。 Active, Held, Remote Heldそして Answered が有効である。 answerTime.

について endTime プロパティは、呼び出しが最終状態(Answered, Cancelled, Missed, Rejected).

最終的に Answered 状態はゼロでない持続時間を持つ。

コールイベントの取得

APIは、アクティブまたは終了した呼の呼イベントの取得をサポートする。呼イベントレコードの数は多いかもしれないので、応答はページングされるかもしれない。通常、アプリケーションは、特定のクエリパラメータセットのレコードの総数を取得し、次に、同じクエリパラメータセットとコールごとに返すイベントの最大数を使用して、複数のAPIコールのスパンにわたってイベントを取得する。