REST ClientCompatConferences

stopStream

View as MarkdownOpen in Claude

Stop a media stream on a conference.

Path parameters

AccountSidstringRequiredformat: "uuid"
The unique identifier for the account that created this conference.
ConferenceSidstringRequiredformat: "uuid"
The unique identifier for the conference this participant is in.
SidstringRequiredformat: "uuid"
The unique identifier for the stream.

Request

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

Response

account_sidstringRequiredformat: "uuid"
The unique identifier for the account.
conference_sidstringRequiredformat: "uuid"
The unique identifier for the conference.
date_updatedstringRequired
The date, in RFC 2822 GMT format, this stream was updated.
namestring or nullRequired
The name of the stream. May be null if not specified when creating the stream.
sidstringRequiredformat: "uuid"
The unique identifier for the stream.
statusenumRequired
The status of the stream.
Allowed values:
uristringRequired
The URI for the stream.

Response Example

Response
1{
2  "account_sid": "b3877c40-da60-4998-90ad-b792e98472af",
3  "conference_sid": "b3877c40-da60-4998-90ad-b792e98472cf",
4  "date_updated": "Tue, 25 Sept 2018 20:00:00 +0000",
5  "name": "my_conference_stream",
6  "sid": "b3877c40-da60-4998-90ad-b792e98472st",
7  "status": "queued",
8  "uri": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472cf/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.conferences.stopStream("CF...", "ST...", { Status: "stopped" });