WebRTC JS Notification

An event dispatched by Telnyx to notify the client of changes to the session or call.

The conditions of the event can be identified by the type property.

type	Description	Additional properties
callUpdate	A call has changed state	call
userMediaError	The browser does not have permission to access media devices	error

Examples

Usage with TelnyxRTC Client .on:

client.on('telnyx.notification', (notification) => {
  if (notification.type === 'callUpdate') {
    console.log(notification.call);

    // Do something with the call and update UI accordingly
  } else if (notification.type === 'userMediaError') {
    console.log(notification.error);

    // Handle the error and update UI accordingly
  }
});

The notification structure is determined by its type.

{
  type: 'callUpdate',
  call: Call // current call
}

{
  type: 'userMediaError',
  error: Error
}

Apialias

Notification

• Omit<INotificationEventData, "call">

  ↳ INotification

• call
• error
• type

• Optional call: ICall

The current call. Reference this call state to update your UI. See Call documentation.

---

• Optional error: Error

Error from the userMediaError event. Check your audio and video constraints for browser support.

Omit.error

---

• type: string

Identifies the event case.

Omit.type