Returns a single PlayerStreamer resource identified by a SID

GET /v1/PlayerStreamers/{Sid}

A PlayerStreamer resource provides the ability to send a livestream to a JavaScript, iOS, or Android Player SDK.

Returns a single PlayerStreamer resource identified by a SID.

Path parameters

  • Sid string Required

    The SID of the PlayerStreamer resource to fetch.

Responses

  • 200

    OK

    Hide response attributes Show response attributes object
    • account_sid string | null

      The SID of the Account that created the resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • date_created string(date-time) | null

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

    • date_updated string(date-time) | null

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

    • ended_reason string | null

      The reason why a PlayerStreamer ended

      Values are ended-via-api, max-duration-exceeded, stream-disconnected-by-source, or unexpected-failure.

    • links object(uri-map) | null

      The URLs of related resources

    • max_duration integer | null

      Maximum PlayerStreamer duration in seconds

    • sid string | null

      The unique string that identifies the resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^VJ[0-9a-fA-F]{32}$.

    • status string | null

      The status of the PlayerStreamer

      Values are created, started, ended, or failed.

    • status_callback string(uri) | null

      The URL to which Twilio will send PlayerStreamer event updates

    • status_callback_method string(http-method) | null

      The HTTP method Twilio should use to call the status_callback URL

      Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

    • url string(uri) | null

      The absolute URL of the resource

    • video boolean | null

      Whether the PlayerStreamer is configured to stream video
GET /v1/PlayerStreamers/{Sid} 
curl \
 -X GET https://media.twilio.com/v1/PlayerStreamers/{Sid} \
 --user "username:password"
Response examples (200) 
{
  "account_sid": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "ended_reason": "ended-via-api",
  "links": {},
  "max_duration": 42,
  "sid": "string",
  "status": "created",
  "status_callback": "https://example.com",
  "status_callback_method": "HEAD",
  "url": "https://example.com",
  "video": true
}
Response examples (200) 
{
  "account_sid": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "ended_reason": "ended-via-api",
  "links": {},
  "max_duration": 42,
  "sid": "string",
  "status": "created",
  "status_callback": "https://example.com",
  "status_callback_method": "HEAD",
  "url": "https://example.com",
  "video": true
}