Skip to main content
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.
typeDescriptionAdditional properties
callUpdateA call has changed statecall
userMediaErrorThe browser does not have permission to access media deviceserror
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
  }
});

​
Data structure

The notification structure is determined by its type.

​
callUpdate

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

​
userMediaError

{
  type: 'userMediaError',
  error: Error
}
Apialias Notification

​
Hierarchy

  • Omit<INotificationEventData, "call"> ↳ INotification

​
Table of contents

​
Properties

​
Properties

​
call

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

​
error

• Optional error: Error Error from the userMediaError event. Check your audio and video constraints for browser support.

​
Overrides

Omit.error

​
type

• type: string Identifies the event case.

​
Overrides

Omit.type