Veranstaltung

Konversationen und andere Vonage-Objekte wie Mitglieder und Applications erzeugen Ereignisse. Wenn wichtige Aktivitäten stattfinden, wird ein Ereignis generiert, das von der Anwendung verarbeitet werden kann. Wenn zum Beispiel ein Benutzer einer Konversation beitritt, wird ein member:joined Ereignis ausgelöst wird. Wenn eine Vonage Application über rtc als Fähigkeit, erhält sie das ausgelöste Ereignis auf der rtc event_url Webhook.

Product deprecation notice

Effective April 30th, 2026, Vonage In-App Messaging will no longer be available. Access for new users will be closed, and the service will be discontinued for all existing users.

If you have any questions regarding this product’s discontinuation, please contact your account manager or our support team.

Art der Veranstaltung Beschreibung
Allgemein
leg:status:update
Audio
audio:dtmf Der DTMF-Ton wird im Leg empfangen.
audio:earmuff:off Das Bein ist entmüffelt.
audio:earmuff:on Das Bein ist mit Ohrenschützern versehen.
audio:mute:off Das Bein ist entstummt.
audio:mute:on Das Bein ist gedämpft.
audio:play:stop Das in ein Bein gestreamte Audio wird gestoppt.
audio:play:done In ein Leg gestreamtes Audio wird nicht mehr abgespielt, d. h. die Audiodaten werden beendet.
audio:play Audio wird in ein Bein gestreamt.
audio:record:stop
audio:record:done
audio:record Der Anruf wird aufgezeichnet.
audio:asr:done
audio:asr:record:done
audio:say:stop
audio:say:done
audio:say
audio:speaking:on
audio:speaking:off
Nachricht
message Nachricht (ersetzt Text- und Bild-Ereignisse), haben die Untertypen Text, Bild, Audio, Video, Datei, Vorlage, Benutzerdefiniert, VCard, Ort, Zufall. Siehe API-Spezifikation für weitere Einzelheiten
message:rejected Die Nachricht wurde abgelehnt.
message:submitted Die Nachricht wurde übermittelt.
message:undeliverable Die Nachricht kann nicht zugestellt werden.
message:delivered Die Nachricht wurde zugestellt.
message:seen Die Nachricht wurde gesehen.
Konversation
conversation:updated Das Gesprächsobjekt wird aktualisiert.
Mitglied
member:invited Das Mitglied wird zu einer Konversation eingeladen.
member:joined Mitglied nimmt an einer Konversation teil.
member:left Mitglied verlässt eine Konversation.
member:media
member:message:status
RTC
rtc:status
rtc:transfer
rtc:hangup
rtc:terminate
rtc:answered
rtc:ringing
rtc:answer
SIP
sip:status
sip:answered SIP-Anruf wird angenommen.
sip:machine Wenn die Einheit, die den SIP-Anruf entgegennimmt, eine Maschine ist.
sip:hangup Benutzer legt bei einem SIP-Anruf auf.
sip:ringing Der SIP-Anruf beginnt zu klingeln, z. B. wenn Vonage einen ausgehenden Anruf tätigt.
sip:amd_machine
Benutzerdefiniert
custom: Benutzerdefinierte Ereignistypen, die beliebig benannt werden können ^custom:[\w\-:]+ zum Beispiel custom:test
ephemeral Kurzlebige Ereignisse, die gesendet werden können, aber nach dem Senden nicht mehr abgerufen werden können.
Veranstaltung
event:delete Ein Ereignis wurde gelöscht

Handhabung von Ereignissen

Der folgende Codeschnipsel zeigt, dass Code auf der Grundlage des ausgelösten Ereignisses ausgeführt werden kann:

...
    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:
                ...
            }
        }
    })
...