Streams

Stop a Stream

Changed on

Stops an active WebSocket audio stream on a call by stream SID. This ends media delivery without ending the call. Conference audio streams and Video RTMP streams have separate operations.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice.

Learn more about API scopes.

post/Accounts/{AccountSid}/Calls/{CallSid}/Streams/{Sid}

Request

  • Base URL
    https://YOUR_SPACE.signalwire.com/api/laml/2010-04-01
  • URL
    https://YOUR_SPACE.signalwire.com/api/laml/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Streams/{Sid}
  • Auth
    HTTP basic

Path parameters

AccountSidstring uuid required

Universal Unique Identifier.

The Project ID that uniquely identifies the Account.

CallSidstring uuid required

Universal Unique Identifier.

The unique identifier for the call.

Sidstring uuid required

Universal Unique Identifier.

The unique identifier for the call.

Request body application/x-www-form-urlencoded

Status'stopped' required

The status of the stream. Only 'stopped' is allowed.

Example request

{
  "Status": "stopped"
}

Response

The request has succeeded.

sidstring uuid required

Universal Unique Identifier.

account_sidstring uuid required

Universal Unique Identifier.

call_sidstring uuid required

Universal Unique Identifier.

namestring required

The name of the stream.

status'queued' | 'in-progress' | 'stopped' required

Stream status.

date_updatedstring required

The date, in RFC 2822 GMT format, this stream was updated.

uristring required

The URI for the stream.

Example response

{
  "name": "my_first_stream",
  "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"
}

Changes

  • 2916d5e3072eRevision changes
    • breaking

      the response's property type changed from string to no type, and format from uuid to no format for status

    • breaking

      the response's property type changed from string to no type, and format from uuid to no format for status

    • breaking

      the response's property type changed from string to no type, and format from uuid to no format for status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

  • 5344c0c93a4cRevision changes
    • breaking

      added 'unevaluatedProperties' constraint to the request body

    • info

      added 'unevaluatedProperties' constraint to the response body for the status

    • info

      added 'unevaluatedProperties' constraint to the response body for the status

    • info

      added 'unevaluatedProperties' constraint to the response body for the status

    • info

      added 'unevaluatedProperties' constraint to the response body for the status

    • info

      added 'unevaluatedProperties' constraint to the response body for the status

    • info

      added 'unevaluatedProperties' constraint to the response body for the status