Notification

A notification is an event that SignalWire dispatches to notify the Client about different cases. A notification can refer to the JWT expiration, Call changes or Conference updates.

Types

Every notification has a property type that identify the case and the structure of the data.
The available type are:

refreshToken

Your JWT is going to expire. Refresh it or your session will be disconnected.

Anatomy of a refreshToken notification.

1
{
2
  type: 'refreshToken',
3
  session: RelayInstance
4
}

callUpdate

A Call’s state has been changed. It is useful to update the UI of your application.s

Anatomy of a callUpdate notification.

1
{
2
  type: 'callUpdate',
3
  call: CallObject
4
}

participantData

This notification contains the participant data for the current Call. This is useful when updating the UI.

Anatomy of a participantData notification.

1
{
2
  type: 'participantData',
3
  call: CallObject,
4
  displayName: 'David Roe',
5
  displayNumber: '1777888800'
6
  displayDirection: 'inbound'
7
}

userMediaError

The browser lacks of permissions to access microphone or webcam. You should check which audio/video constraints you are using and make sure they are supported by the browser.

Anatomy of a userMediaError notification.

1
{
2
  type: 'userMediaError',
3
  error: error
4
}