Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-14131427.8 KB

Returns a single PlayerStreamer resource identified by a SID.

get/v1/PlayerStreamers/{Sid}

Path parameters

Sidstring required

The SID of the PlayerStreamer resource to fetch.

Response

OK

account_sidstring nullable

The SID of the Account that created the PlayerStreamer resource.

date_createdstring date-time nullable

The date and time in GMT when the resource was created specified in ISO 8601 format.

date_updatedstring date-time nullable

The date and time in GMT when the resource was last updated specified in ISO 8601 format.

ended_reason'ended-via-api' | 'max-duration-exceeded' | 'stream-disconnected-by-source' | 'unexpected-failure'
linksobject nullable

The URLs of related resources.

max_durationinteger nullable

The maximum time, in seconds, that the PlayerStreamer is active (created or started) before automatically ends. The default value is 300 seconds, and the maximum value is 90000 seconds. Once this maximum duration is reached, Twilio will end the PlayerStreamer, regardless of whether media is still streaming.

sidstring nullable

The unique string generated to identify the PlayerStreamer resource.

status'created' | 'started' | 'ended' | 'failed'
status_callbackstring uri nullable

The URL to which Twilio will send asynchronous webhook requests for every PlayerStreamer event. See Status Callbacks for more details.

status_callback_method'HEAD' | 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE' http-method nullable

The HTTP method Twilio should use to call the status_callback URL. Can be POST or GET and the default is POST.

urlstring uri nullable

The absolute URL of the resource.

videoboolean nullable

Specifies whether the PlayerStreamer is configured to stream video. Defaults to true.