Participant List API

GET

https://api.huddle01.com/api/v2/sdk/rooms/participant-list?sessionId={sessionId}

The Participant List API is a useful tool for retrieving information about a specific meeting room. By passing in the sessionId as a parameter, you can easily access a list of participants who joined the meeting.

This API is especially useful if you need to retrieve information about a room for administrative purposes or if you want to gather a list of participants. Overall, the Participant List API is a valuable resource for accessing participants in your meeting rooms and can be used in a variety of scenarios to enhance your experience with Huddle01.

💡

Retrieve the sessionId by utilizing the Meeting List API and copying the sessionId associated with the particular meeting.

GET
/rooms/participant-list?sessionId={sessionId}

Participant List API

The API supports a GET request with the following required parameters:

  • sessionId - The sessionId of the meeting, for which you need to get the details.
Request
GET • rooms/participant-list?sessionId={sessionId}
const response = await axios.get(
  'https://api.huddle01.com/api/v2/sdk/rooms/participant-list?sessionId={sessionId}',
  {
    headers: {
      'Content-Type': 'application/json',
      'x-api-key': {{API_KEY}},
    },
  }
);
Response

Upon success, the API will return a response with the following fields:

  • participants - The list of participants who joined the meeting.
  • peerId - The peerId of the participant.
  • joinTime - The time when the participant joined the meeting.
  • exitTime - The time when the participant exited the meeting.
  • metadata - The metadata associated with the participant, metadata is the information provided when a new Access Token was generated.

In case of an error, the API will return an error message with a corresponding status code.

Response
{
  "participants": [
    {
      "peerId": "peerId--AmxuhmUBW17kP1FGL2mU",
      "joinTime": 1706810039986,
      "exitTime": 1706811249372,
      "metadata": {
          ...
      }
    },
    ...
  ]
}
💡

metadata is the information provided when a new Access Token was generated. It can be used to store additional information about the participant. To Learn more about the Access Token and how metadata can used, visit the Access Token.

Request

ParamsDefinitionData TypeMandatory
meetingIdThe MeetingId of the room, for which you need to get the list.stringY

Response

FieldsDefinitionData TypeMandatory
roomIdThe RoomId of the room, for which you need to get the list.stringY
hostAddressesThe host wallet address of the room.string[]Y
participantsThe list of participants in the room.{displayName: string, walletAddress: string | null}[]Y
durationThe duration of the meeting.number | nullN
Audio/Video Infrastructure designed for developers to empower them to ship simple yet powerful Audio/Video Apps.
support
company
Copyright © 2024 Graphene 01, Inc. All Rights Reserved.