Earlier this week, there was a change to the Meeting API that affected the responses from the Dashboard and Reporting endpoints. We have compiled a list of questions that will hopefully give everyone a sense of how this change will affect them and what to expect going forward.
What gives?! Why was there no notice on this change?
The nature of this change didn’t trigger Zoom’s regular change protocols, but as we can see, this has had an unexpected impact on our customers. We apologize for the inconvenience and disruption.
What can I, as a developer, expect from now on?
After hearing feedback from you, we have rolled back some of the changes. Developers will be able to access the registrant_id value again. The id and participant_user_id fields will be null for meeting guests (but not the host).
I have application logic that depends on the participant_user_id or id. What field should I use instead?
You should key your logic off of the registrant_id value. This value will be filled in independent of whether the guest is a member of the app’s Zoom account or not. If this doesn’t fulfill your needs, please take a look at the email display rules to get a better understanding of what is available for your use-case.
How will this impact webhooks?
Right now, webhook responses will contain id and participant_user_id but this behavior will be turned off by the end of March 2023. We recommend keying any logic off of the registrant_id value, which is available in the webhook response.
GET /webinars/{webinarId}/registrants/{registrantId}
???
I asked your support several times, and no one had an answer. What do I do now that you have disabled this option? How can I get the reports after the meeting?
Hi @shariq.torres
I’m talking about GET /report/webinars/{webinarId}/participants
I use this API call to get the webinar participants and then with the registrantId I got back from this API call I do another API call - this time GET /webinars/{webinarId}/registrants/{registrantId} in order to get the details on a specific user who has registered for the Webinar/
But now since you removed the registrantId from the GET /report/webinars/{webinarId}/participants API response - how can I do the GET /webinars/{webinarId}/registrants/{registrantId} call?
I checked with the engineers to make sure that something else didn’t break while they were making the change to this endpoint, and they confirmed that the endpoint should still be taking webinar IDs. Can you confirm that this was a webinar ID?
I originally was trying the metrics endpoint when I started setting things up for my org, because zoom said it would allow me to go back more than 90 days (the docs said we could go back 6 months).
Make sure that the History is preserved for a minimum of 12 months for regulatory compliance. The state agency that I do work for requires infrastructure service providers, i.e., Zoom to provide a minimum of 12 months auditable history records from the reporting applications, including those built from API services.
If this does not happen, then we may be forced to switch to another infrastructure provider such as Microsoft Teams or Google Meets to remain in compliance.
@shariq.torres I wanted to confirm that the documentation for the /metrics/meetings/{meetingId}/participants endpoint is incorrect about the following information:
Provide registrant_id as the value for this field if you would like to see the registrant ID attribute in the response of this API call. A registrant ID is a unique identifier of a meeting registrant. This is not supported for live meeting types.
From my understanding, registrant_id is included in the response for all participants, including for live meetings, regardless of whether is explicitly requested. Is this correct? In other words, can we rely on registrant_id to continue to be returned in the response for all meetings, live and past?
