Interface INotification

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
  }
});
Copy

Data structure

The notification structure is determined by its type.

callUpdate

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

userMediaError

{
  type: 'userMediaError',
  error: Error
}
Copy

Apialias

Notification