Documentation for Meeting Participant QoS requires update

API and Webhooks Meetings
1

API Endpoint(s) and/or Zoom API Event(s)
List Meeting Participant QoS
Accounts APIs

Description
The API returns a number of values that aren’t documented including “participant_uuid” and “user_id”. There are others that are undocumented but self-explanatory like “microphone”, “speaker”, “data_center”, “groupId”, “health”, “issue_list”, “meetingId” and more.

We collect and store the participant QoS data in a database when a meeting ends so we can use it to understand network issues and track where we are seeing them. The “internal_ip_addresses” value was not there when I initially completed this project and would be very helpful to track, but after reviewing I see quite a few others that we would also collect. However, that means I need to understand what the value range is so we can construct additional columns on our DB. I understand that user_id is a numeric value unique only to the particular meeting instance, but assume participant_UUID is unique across all meetings? If that’s always provided, it would change how we setup primary keys in these tables.

How To Reproduce
Steps to reproduce the behavior:
1. Make a call against the endpoint listed above using any valid meetingId
2. Observe that the participants object returned contains more fields than documented

image
image1221×804 41 KB

2

Hi @cofry ,

Thanks or catching this! A request has been made to update (DEVELOPERS-5396).

1 Like
3

Thank you! Are you able to reply back on this thread when they’ve been able to complete the update?

4

Hi @cofry , yes if I am still notified on the process, I will share but it will also be in our changelogs for the API!

6

Hi @cofry , I received further clarity from the engineering team on this. The undocumented values for this endpoint are caused by updating the participant object in code for another API but they only updated that Open API. Unfortunately, the documents of all APIs which use this same participant object in the response should also be updated accordingly. That’s why you see those fields in response of API “List meeting participants” but not in “List meeting participants QoS​”.

The documentation request has been escalated to an engineering request for them to make the changes across the board before re-submitting to public documentation team (ZOOM-942429).

In the interim, you can refer to “List meeting participants” for the comprehensive participant object schema definition. Not sure the timeline of the full comprehensive update at this point.