Streams

Stop a Stream

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}

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.

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

Changed in 10 of the 40 revisions of this API.12428

  • 2916d5e3072e33See the full diff
    • the response's property type changed from string to no type, and format from uuid to no format for status

      response-property-type-changed

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

      response-property-type-changed

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

      response-property-type-changed

    • added to the response property allOf list for the response status

      response-property-all-of-added

    • added to the response property allOf list for the response status

      response-property-all-of-added

    • added to the response property allOf list for the response status

      response-property-all-of-added

  • 5344c0c93a4c16See the full diff
    • added 'unevaluatedProperties' constraint to the request body

      request-body-unevaluated-properties-added

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

      response-body-unevaluated-properties-added

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

      response-body-unevaluated-properties-added

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

      response-body-unevaluated-properties-added

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

      response-body-unevaluated-properties-added

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

      response-body-unevaluated-properties-added

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

      response-body-unevaluated-properties-added

    • added the non-success response with the status

      response-non-success-status-added

    • added the non-success response with the status

      response-non-success-status-added

    • added the non-success response with the status

      response-non-success-status-added

  • d5fbaaddfa3e137See the full diff
    • removed the enum value in-progress of the request property

      request-property-enum-value-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • added the new queued enum value to the //// response property for the response status

      response-property-enum-value-added

    • the response property became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • request body became required

      request-body-became-required

    • request body became optional

      request-body-became-optional

    • removed the optional property from the response with the status

      response-optional-property-removed

  • 07f73f74a61d11See the full diff
    • removed the media type application/json from the request body

      request-body-media-type-removed

    • added the media type application/x-www-form-urlencoded to the request body

      request-body-media-type-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • the response property became nullable for the status

      response-property-became-nullable

  • 3c88f14db21e47See the full diff
    • request body became required

      request-body-became-required

    • removed the media type application/x-www-form-urlencoded from the request body

      request-body-media-type-removed

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

      response-property-type-changed

    • the response's property type changed from string to no type for status

      response-property-type-changed

    • added the media type application/json to the request body

      request-body-media-type-added

    • added the non-success response with the status

      response-non-success-status-added

    • added the non-success response with the status

      response-non-success-status-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added to the response property allOf list for the response status

      response-property-all-of-added

    • removed the in-progress enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the stopped enum value from the response property for the response status

      response-property-enum-value-removed

    This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog