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
ReferenceGuidesClick-to-Call
ReferenceGuidesClick-to-Call
  • Core
    • Overview
  • SignalWire Client
    • Overview
    • Notifications
    • Client
      • Address Namespace
      • Chat Namespace
      • Conversation Namespace
        • connect
        • dial
        • disconnect
        • getSubscriberInfo
        • offline
        • online
        • updateToken
    • Utility functions
  • Video
    • Overview
    • LocalOverlay
    • RoomSession
    • RoomSessionDevice
    • RoomSessionPlayback
    • RoomSessionRecording
    • RoomSessionScreenShare
    • RoomSessionStream
    • RoomDevice
    • RoomScreenShare
  • Chat
    • Overview
    • Client
    • ChatMember
    • ChatMemberEntity
    • ChatMessage
    • ChatMessageEntity
  • PubSub
    • Overview
    • Client
    • PubSubMessage
  • WebRTC
    • Overview
LogoLogoSignalWire Docs
Log inSign up
Support
On this page
  • dial
SignalWire ClientClientMethods

dial

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

disconnect

Next
Built with

dial

  • dial(params): Promise<Call>

Dials to the address specified in the to parameter, and returns a Call object if successful.

Parameters

params
objectRequired

Dial parameters

params.to
stringRequired

The address of the subscriber to dial (like /private/user1).

params.rootElement
HTMLElement

The HTML container element to inject the Call into.

params.nodeId
string

Optional node ID.

You can manage the DOM yourself by not specifying a rootElement here and using the buildVideoElement function instead.

Also accepts all CallOptions parameters. Parameters passed when dialing will override any matching parameters passed during instantiation.

Returns

Promise<Call>

A Call object that describes the ongoing call, and provides handles for controlling it.