REST ClientCompatCalls

stopStream

View as MarkdownOpen in Claude

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.

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.
date_updatedstringRequired
The date, in RFC 2822 GMT format, this stream was updated.
uristringRequired
The URI for the stream.

Response Example

Response
{
  "sid": "b3877c40-da60-4998-90ad-b792e98472st",
  "account_sid": "b3877c40-da60-4998-90ad-b792e98472af",
  "call_sid": "b3877c40-da60-4998-90ad-b792e98472ca",
  "name": "my_first_stream",
  "status": "queued",
  "date_updated": "Wed, 19 Sep 2018 21:00:00 +0000",
  "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"
}

Example

import { RestClient } from "@signalwire/sdk";
const client = new RestClient({
  project: "your-project-id",
  token: "your-api-token",
  host: "your-space.signalwire.com",
});
await client.compat.calls.stopStream("CA...", "ST...", { Status: "stopped" });