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
GuidesReference
GuidesReference
    • Core
      • Overview
    • Agents
      • Overview
      • AgentBase
      • AgentServer
      • Configuration
      • ContextBuilder
      • DataMap
      • FunctionResult
      • Helper Functions & Utilities
      • LiveWire
      • PomBuilder
      • Prefabs
      • SkillBase
      • SkillManager
      • SkillRegistry
      • Skills
      • SwaigFunction
      • SwmlBuilder
      • SWMLService
    • RELAY
      • Overview
      • Actions
      • Call
      • Constants
      • Events
      • Message
      • RelayClient
      • RelayError
    • REST Client
      • Overview
      • Addresses
      • Calling
      • ChatResource
      • Compat
        • Accounts
        • Applications
        • Calls
        • Conferences
          • deleteRecording
          • get
          • getParticipant
          • getRecording
          • list
          • listParticipants
          • listRecordings
          • removeParticipant
          • startStream
          • stopStream
          • update
          • updateParticipant
          • updateRecording
        • Faxes
        • LAML Bins
        • Messages
        • Phone Numbers
        • Queues
        • Recordings
        • Tokens
        • Transcriptions
      • Datasphere
      • Fabric
      • ImportedNumbersResource
      • Logs
      • LookupResource
      • MFA
      • Number Groups
      • Phone Numbers
      • Project
      • PubSubResource
      • Queues
      • Recordings
      • Registry
      • RestClient
      • RestError
      • Short Codes
      • SIP Profile
      • Verified Callers
      • Video
LogoLogoSignalWire Docs
Log inSign up
Support
On this page
  • Methods
  • Conference CRUD
  • Participants
  • Recordings
  • Streaming
REST ClientCompat

Conferences

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

deleteRecording

Next
Built with

Manage conferences with participants, recordings, and streams. Conferences are list/get/update only (they are created implicitly when a participant dials in via LAML).

Access via client.compat.conferences on a RestClient instance.

1import { RestClient } from "@signalwire/sdk";
2
3const client = new RestClient({
4  project: "your-project-id",
5  token: "your-api-token",
6  host: "your-space.signalwire.com"
7});
8
9const conferences = await client.compat.conferences.list();

Methods

Conference CRUD

list

List conferences.

get

Retrieve a single conference by SID.

update

Update a conference (e.g., end it or set an announce URL).

Participants

listParticipants

List participants in a conference.

getParticipant

Retrieve a specific participant in a conference.

updateParticipant

Update a participant in a conference (mute or hold).

removeParticipant

Remove a participant from a conference.

Recordings

listRecordings

List recordings for a conference.

getRecording

Retrieve a specific conference recording.

updateRecording

Update a conference recording (pause, resume, or stop).

deleteRecording

Delete a conference recording.

Streaming

startStream

Start a media stream on a conference.

stopStream

Stop a media stream on a conference.