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
          • create
          • delete
          • get
          • list
          • startRecording
          • startStream
          • stopStream
          • update
          • updateRecording
        • Conferences
        • 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
  • Response Example
  • Example
REST ClientCompatCalls

stopStream

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

update

Next
Built with

Stop a media stream on a call.

Path parameters

AccountSidstringRequiredformat: "uuid"
The Project ID that uniquely identifies the Account.
CallSidstringRequiredformat: "uuid"
The unique identifier for the call.
SidstringRequiredformat: "uuid"
The unique identifier for the call.

Request

StatusenumRequired
The status of the stream. Only 'stopped' is allowed.
Allowed values:

Response

sidstringRequiredformat: "uuid"
The unique identifier for the stream.
account_sidstringRequiredformat: "uuid"
The unique identifier for the account.
call_sidstringRequiredformat: "uuid"
The unique identifier for the call.
namestringRequired
The name of the stream.
statusenumRequired
The status of the stream.
Allowed values:
date_updatedstringRequired
The date, in RFC 2822 GMT format, this stream was updated.
uristringRequired
The URI for the stream.

Response Example

Response
1{
2  "sid": "b3877c40-da60-4998-90ad-b792e98472st",
3  "account_sid": "b3877c40-da60-4998-90ad-b792e98472af",
4  "call_sid": "b3877c40-da60-4998-90ad-b792e98472ca",
5  "name": "my_first_stream",
6  "status": "queued",
7  "date_updated": "Wed, 19 Sep 2018 21:00:00 +0000",
8  "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Calls/b3877c40-da60-4998-90ad-b792e98472ca/Streams/b3877c40-da60-4998-90ad-b792e98472st.json"
9}

Example

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
9await client.compat.calls.stopStream("CA...", "ST...", { Status: "stopped" });