Streams

Create a Stream

Starts sending selected audio tracks from an active call to a secure WebSocket endpoint. Use it for live call-audio processing; use Conference Streams for an entire voice conference or Video Room Streams for RTMP video broadcasts.

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

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.

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 8 of the 40 revisions of this API.12428

  • 2916d5e3072e33See the full diff
    • the account_sid response's property type/format changed from string/uuid to / for status 200

      response-property-type-changed

    • the call_sid response's property type/format changed from string/uuid to / for status 200

      response-property-type-changed

    • the sid response's property type/format changed from string/uuid to / for status 200

      response-property-type-changed

    • added uuid to the account_sid response property allOf list for the response status 200

      response-property-all-of-added

    • added uuid to the call_sid response property allOf list for the response status 200

      response-property-all-of-added

    • added uuid to the sid response property allOf list for the response status 200

      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 200

      response-body-unevaluated-properties-added

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

      response-body-unevaluated-properties-added

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

      response-body-unevaluated-properties-added

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

      response-body-unevaluated-properties-added

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

      response-body-unevaluated-properties-added

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

      response-body-unevaluated-properties-added

    • added the non-success response with the status 404

      response-non-success-status-added

    • added the non-success response with the status 422

      response-non-success-status-added

    • added the non-success response with the status 503

      response-non-success-status-added

  • d5fbaaddfa3e338See the full diff
    • the request property Url became required

      request-property-became-required

    • the StatusCallback request property type/format changed from string/ to string/uri

      request-property-type-changed

    • the Url request property type/format changed from string/ to string/uri

      request-property-type-changed

    • removed the optional property api_version from the response with the 200 status

      response-optional-property-removed

    • removed the optional property error_code from the response with the 200 status

      response-optional-property-removed

    • added the new queued enum value to the status/allOf[StreamStatus]/ response property for the response status 200

      response-property-enum-value-added

    • added the new optional request property AuthorizationBearerToken

      new-optional-request-property

    • the response property account_sid became required for the status 200

      response-property-became-required

    • the response property call_sid became required for the status 200

      response-property-became-required

    • the response property date_updated became required for the status 200

      response-property-became-required

    • the response property name became required for the status 200

      response-property-became-required

    • the response property sid became required for the status 200

      response-property-became-required

    • the response property status became required for the status 200

      response-property-became-required

    • the response property uri became required for the status 200

      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

    • removed the optional property date_created from the response with the 200 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 error_code became nullable for the status 200

      response-property-became-nullable

  • 3c88f14db21e37See the full diff
    • removed the media type application/x-www-form-urlencoded from the request body

      request-body-media-type-removed

    • the error_code response's property type/format changed from string/ to integer/int32 for status 200

      response-property-type-changed

    • the status response's property type/format changed from string/ to / for status 200

      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 400

      response-non-success-status-added

    • added the non-success response with the status 401

      response-non-success-status-added

    • added the optional property date_created to the response with the 200 status

      response-optional-property-added

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

      response-property-all-of-added

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

      response-property-enum-value-removed

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

      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