Enumeration WebRtcRegistrationState

The registration state of the agent's WebRTC voice channel with the media server.

The SDK must successfully register before the agent can participate in voice interactions. Subscribe to WebRtcRegistrationEventType events to track transitions, and call User.getWebRtcRegistrationState to read the current state.

const status = user.getWebRtcRegistrationState();
if (status === WebRtcRegistrationState.REGISTERED) {
  console.log("Voice channel ready");
}

Enumeration Members

UNREGISTERED: "unregistered"

Initial state. The SDK has not yet attempted to register with the media server.

REGISTERING: "registering"

Registration with the media server is in progress.

REGISTERED: "registered"

Registered and ready. The agent can send and receive voice calls.

REGISTRATION_FAILED: "registrationFailed"

Registration failed. Voice calls are not available until registration succeeds.

UNREGISTERING: "unregistering"

The SDK is in the process of unregistering from the media server.

UNREGISTRATION_FAILED: "unregistrationFailed"

Unregistration failed. The voice channel state is uncertain.