For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
GuidesReferenceClick-to-Call
GuidesReferenceClick-to-Call
  • Core
    • Overview
  • Entities
    • SignalWire
      • applySelectedAudioOutputDevice
      • audioInputDevices$
      • audioInputDisabled$
      • audioOutputDevices$
      • clearDeviceState
      • connect
      • destroy
      • destroyed$
      • deviceInfoToConstraints
      • deviceRecovered$
      • dial
      • directory$
      • disableAudioInput
      • disableDeviceMonitoring
      • disableVideoInput
      • disconnect
      • enableAudioInput
      • enableDeviceMonitoring
      • enableVideoInput
      • enumerateDevices
      • errors$
      • exportDiagnostics
      • getDeviceCapabilities
      • isConnected$
      • isRegistered$
      • isValidDevice
      • platformCapabilities
      • preflight
      • ready$
      • register
      • requestMediaPermissions
      • resetToDefaults
      • selectAudioInputDevice
      • selectAudioOutputDevice
      • selectedAudioInputDevice$
      • selectedAudioInputDeviceConstraints
      • selectedAudioOutputDevice$
      • selectedVideoInputDevice$
      • selectedVideoInputDeviceConstraints
      • selectVideoInputDevice
      • session
      • setStorageManager
      • unregister
      • user$
      • videoInputDevices$
      • videoInputDisabled$
      • warnings$
    • Address
    • Participant
    • ClientPreferences
    • SelfCapabilities
    • SelfParticipant
    • User
    • WebRTCCall
  • Web Components
    • Overview
    • sw-audio-level
    • sw-call-controls
    • sw-call-dialpad
    • sw-call-media
    • sw-call-provider
    • sw-call-status
    • sw-call-widget
    • sw-click-to-call
    • sw-device-selector
    • sw-directory
    • sw-local-camera
    • sw-participant-controls
    • sw-participants
    • sw-self-media
    • sw-ui-alert
    • sw-ui-background
    • sw-ui-call-layout
    • sw-ui-content-drawer
    • sw-ui-control-bar
    • sw-ui-dialpad
    • sw-ui-dropup
    • sw-ui-icon
    • sw-ui-modal
    • sw-ui-responsive-container
    • sw-ui-split-button
    • sw-ui-transcript-view
LogoLogoSignalWire Docs
Log inSign up
Support
On this page
  • Returns
  • Throws
  • Examples
  • Register and watch for inbound calls
  • Track registration state reactively
  • See
EntitiesSignalWire

register

|View as Markdown|Open in Claude|
Was this page helpful?
Edit this page
Previous

requestMediaPermissions

Next
Built with
1register(): Promise<void>

Registers the user as online to receive inbound calls and events.

Waits for authentication to complete before sending the registration. If the initial attempt fails, reauthentication is attempted automatically.

After register() resolves, inbound calls addressed to this user surface through session.incomingCalls$. Call unregister to stop receiving calls without disconnecting the client.

Returns

Promise<void>

Throws

If registration and reauthentication both fail.

Examples

Register and watch for inbound calls

1await client.register();
2
3client.session.incomingCalls$.subscribe((calls) => {
4 const ringing = calls.find((c) => c.status === 'ringing');
5 if (ringing) {
6 ringing.answer({ audio: true, video: true });
7 }
8});

Track registration state reactively

1client.isRegistered$.subscribe((registered) => {
2 console.log('registered:', registered);
3});

See

  • session — exposes incomingCalls$.
  • unregister — reverse this.
  • isRegistered$ — reactive state.
  • Inbound Calls guide.