Returns a list of tracks that are subscribed for the participant

GET /v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/SubscribedTracks

TODO: Resource-level docs

Returns a list of tracks that are subscribed for the participant.

Path parameters

  • RoomSid string Required

    The SID of the Room resource with the Track resources to read.

  • ParticipantSid string Required

    The SID of the participant that subscribes to the Track resources to read.

Query parameters

  • PageSize integer

    How many resources to return in each list page. The default is 50, and the maximum is 1000.

    Minimum value is 1, maximum value is 1000.

Responses

  • • 200

    OK

    Hide response attributes Show response attributes object
    • meta object
      Hide meta attributes Show meta attributes
    • subscribed_tracks array[object]
      Hide subscribed_tracks attributes Show subscribed_tracks attributes
      • 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

      • enabled boolean | null

        Whether the track is enabled

      • kind string | null

        The track type

        Values are audio, video, or data.

      • name string | null

        The track name

      • participant_sid string | null

        The SID of the participant that subscribes to the track

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

      • publisher_sid string | null

        The SID of the participant that publishes the track

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

      • room_sid string | null

        The SID of the room where the track is published

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

      • sid string | null

        The unique string that identifies the resource

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

      • url string(uri) | null

        The absolute URL of the resource
GET /v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/SubscribedTracks 
curl \
 -X GET https://video.twilio.com/v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/SubscribedTracks \
 --user "username:password"
Response examples (200) 
{
  "meta": {
    "first_page_url": "https://example.com",
    "key": "string",
    "next_page_url": "https://example.com",
    "page": 42,
    "page_size": 42,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  },
  "subscribed_tracks": [
    {
      "date_created": "2023-05-04T09:42:00+00:00",
      "date_updated": "2023-05-04T09:42:00+00:00",
      "enabled": true,
      "kind": "audio",
      "name": "string",
      "participant_sid": "string",
      "publisher_sid": "string",
      "room_sid": "string",
      "sid": "string",
      "url": "https://example.com"
    }
  ]
}