Skip to contentSkip to navigationSkip to topbar
Twilio Docs
Page tools
On this page
Looking for more inspiration?Visit the

PublishedTrack

The Published Track resource is a subresource of a Participant instance resource. It represents the Tracks a Participant is currently publishing to the Room.

Using the Published Track resource, you can query tracks published to a Room. You can also get a list of Tracks associated with a given Participant.

Published Track Instance Resource

published-track-instance-resource page anchor

Resource URI

resource-uri page anchor
1
/v1/Rooms/{RoomNameOrSid}/Participants/{ParticipantIdentityOrSid}/PublishedTracks/{TrackNameOrSid}

2

Resource Properties

resource-properties page anchor
Property nameTypeRequiredPIIDescriptionChild properties
sidSID<MT>

Optional

Not PII

The unique string that we created to identify the RoomParticipantPublishedTrack resource.

Pattern: ^MT[0-9a-fA-F]{32}$Min length: 34Max length: 34
participantSidSID<PA>

Optional

Not PII

The SID of the Participant resource with the published track.

Pattern: ^PA[0-9a-fA-F]{32}$Min length: 34Max length: 34
roomSidSID<RM>

Optional

Not PII

The SID of the Room resource where the track is published.

Pattern: ^RM[0-9a-fA-F]{32}$Min length: 34Max length: 34
namestring

Optional

Not PII

The track name. Must be no more than 128 characters, and be unique among the participant's published tracks.

dateCreatedstring<date-time>

Optional

Not PII

The date and time in GMT when the resource was created specified in ISO 8601(link takes you to an external page) format.

dateUpdatedstring<date-time>

Optional

Not PII

The date and time in GMT when the resource was last updated specified in ISO 8601(link takes you to an external page) format.

enabledboolean

Optional

Not PII

Whether the track is enabled.

kindenum<string>

Optional

Not PII

The track type. Can be: audio, video or data.

Possible values:
audiovideodata
urlstring<uri>

Optional

Not PII

The absolute URL of the resource.

HTTP GET

http-get page anchor

Returns a single Track resource represented by TrackNameOrSid.

Retrieve a Track published to the Room by a Participant by TrackNameOrSid

retrieve-a-track-published-to-the-room-by-a-participant-by-tracknameorsid page anchor
Retrieve Track Published by a ParticipantLink to code sample: Retrieve Track Published by a Participant
1
// Download the helper library from https://www.twilio.com/docs/node/install

2
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";

3


4
// Find your Account SID at twilio.com/console

5
// Provision API Keys at twilio.com/console/runtime/api-keys

6
// and set the environment variables. See http://twil.io/secure

7
// For local testing, you can use your Account SID and Auth token

8
const accountSid = process.env.TWILIO_ACCOUNT_SID;

9
const apiKey = process.env.TWILIO_API_KEY;

10
const apiSecret = process.env.TWILIO_API_SECRET;

11
const client = twilio(apiKey, apiSecret, { accountSid: accountSid });

12


13
async function fetchRoomParticipantPublishedTrack() {

14
  const publishedTrack = await client.video.v1

15
    .rooms("DailyStandup")

16
    .participants("Alice")

17
    .publishedTracks("Camera")

18
    .fetch();

19


20
  console.log(publishedTrack.sid);

21
}

22


23
fetchRoomParticipantPublishedTrack();

Response

Note about this response
1
{

2
  "room_sid": "DailyStandup",

3
  "date_created": "2015-07-30T20:00:00Z",

4
  "date_updated": "2015-07-30T20:00:00Z",

5
  "participant_sid": "Alice",

6
  "sid": "Camera",

7
  "name": "bob-track",

8
  "kind": "data",

9
  "enabled": true,

10
  "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PublishedTracks/MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

11
}

HTTP POST

http-post page anchor

Not supported.

Published Track List Resource

published-track-list-resource page anchor

Resource URI

resource-uri-2 page anchor
1
/v1/Rooms/{RoomNameOrSid}/Participants/{ParticipantIdentityOrSid}/PublishedTracks/

2

HTTP GET

http-get-2 page anchor

Returns a list of tracks associated with a given Participant. The list includes paging information. Only currently Published Tracks are in the list resource.

Note: No filters supported.

Retrieve Tracks published to the Room by a Participant

retrieve-tracks-published-to-the-room-by-a-participant page anchor
Retrieve Tracks Published by a ParticipantLink to code sample: Retrieve Tracks Published by a Participant
1
// Download the helper library from https://www.twilio.com/docs/node/install

2
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";

3


4
// Find your Account SID at twilio.com/console

5
// Provision API Keys at twilio.com/console/runtime/api-keys

6
// and set the environment variables. See http://twil.io/secure

7
// For local testing, you can use your Account SID and Auth token

8
const accountSid = process.env.TWILIO_ACCOUNT_SID;

9
const apiKey = process.env.TWILIO_API_KEY;

10
const apiSecret = process.env.TWILIO_API_SECRET;

11
const client = twilio(apiKey, apiSecret, { accountSid: accountSid });

12


13
async function listRoomParticipantPublishedTrack() {

14
  const publishedTracks = await client.video.v1

15
    .rooms("DailyStandup")

16
    .participants("Alice")

17
    .publishedTracks.list({ limit: 20 });

18


19
  publishedTracks.forEach((p) => console.log(p.sid));

20
}

21


22
listRoomParticipantPublishedTrack();

Response

Note about this response
1
{

2
  "published_tracks": [],

3
  "meta": {

4
    "page": 0,

5
    "page_size": 50,

6
    "first_page_url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PublishedTracks?PageSize=50&Page=0",

7
    "previous_page_url": null,

8
    "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PublishedTracks?PageSize=50&Page=0",

9
    "next_page_url": null,

10
    "key": "published_tracks"

11
  }

12
}