イベント
メンバーやアプリケーションなどの会話やその他のVonageオブジェクトはイベントを生成します。重要なアクティビティが発生するとイベントが生成され、アプリケーションで処理することができます。例えば、ユーザが会話に参加すると member:joined イベントが発生します。
Vonageアプリケーションが rtc のディスパッチされたイベントをケイパビリティとして受け取ります。 rtc event_url ウェブフック
Product deprecation notice
Effective April 30th, 2026, the messaging functionality of the Vonage Conversation API will be discontinued. Access for new users will be closed, and messaging capabilities will no longer be available to existing users after this date.
The voice functionality of the Conversation API will remain available and is not impacted by this change. If you have any questions regarding this partial discontinuation, please contact your account manager or our support team.
| イベントタイプ | 説明 |
|---|---|
| 一般 | |
leg:status:update | |
| オーディオ | |
audio:dtmf | DTMFトーンがレグに受信される。 |
audio:earmuff:off | レッグがムキムキになる。 |
audio:earmuff:on | 脚はイヤーマフ。 |
audio:mute:off | レグはミュート解除。 |
audio:mute:on | 脚はミュート。 |
audio:play:stop | レグにストリーミングされたオーディオが停止する。 |
audio:play:done | レッグにストリーミングされたオーディオの再生が止まる、つまりオーディオデータが終了する。 |
audio:play | オーディオはレッグにストリーミングされる。 |
audio:record:stop | |
audio:record:done | |
audio:record | 通話は録音されています。 |
audio:asr:done | |
audio:asr:record:done | |
audio:say:stop | |
audio:say:done | |
audio:say | |
audio:speaking:on | |
audio:speaking:off | |
| メッセージ | |
message | Message(TextとImageイベントを置き換える)には、Text、Image、Audio、Video、File、Template、Custom、VCard、Location、Randomのサブタイプがあります。参照 APIスペック 詳細はこちら |
message:rejected | メッセージが拒否されました。 |
message:submitted | メッセージが送信されました。 |
message:undeliverable | メッセージが届かない。 |
message:delivered | メッセージが配信されました。 |
message:seen | メッセージは見た。 |
| 会話 | |
conversation:updated | 会話オブジェクトが更新される。 |
| メンバー | |
member:invited | 会員は会話に招かれる。 |
member:joined | メンバーが会話に参加 |
member:left | 会員が会話から離れる。 |
member:media | |
member:message:status | |
| RTC | |
rtc:status | |
rtc:transfer | |
rtc:hangup | |
rtc:terminate | |
rtc:answered | |
rtc:ringing | |
rtc:answer | |
| シップ | |
sip:status | |
sip:answered | SIPコールに応答。 |
sip:machine | SIP呼に応答するエンティティが機械の場合。 |
sip:hangup | SIPコール中のユーザーが電話を切る。 |
sip:ringing | Vonageがアウトバウンドコールを発信した場合など、SIPコールが鳴り始めます。 |
sip:amd_machine | |
| カスタム | |
custom: | カスタムイベントタイプ。 ^custom:[\w\-:]+ 例えば custom:test |
ephemeral | 送信することはできるが、送信後に取得することはできないエフェメラルなイベント。 |
| イベント | |
event:delete | イベントが削除されました |
イベント
次のコード・スニペットは、発生したイベントに基づいてコードを実行できることを示している:
...
events.forEach((value, key) => {
if (conversation.members[value.from]) {
const date = new Date(Date.parse(value.timestamp))
switch (value.type) {
case 'message:seen':
...
break;
case 'message:delivered':
...
break;
case 'message':
...
break;
case 'member:joined':
...
break;
case 'member:left':
...
break;
case 'member:invited':
...
break;
case 'member:media':
...
break;
default:
...
}
}
})
...