Undocumented `device` values when getting list of meeting participants

API and Webhooks
1

API Endpoint(s) and/or Zoom API Event(s)
Dashboards: List meeting participants

Description
The JSON in the response contains a device node for each participant which according to documentation, should contain one of the following values:

    "Phone",
    "H.323/SIP",
    "Windows",
    "Mac",
    "iOS",
    "Android"

(Please note that after searching this forum, I discovered that “Unknown” is also an acceptable value in some scenarios despite the fact that it’s not documented, it would be great if the documentation was updated to reflect this additional value).

Error?
Intermittently, we witness undocumented values in this device node such as:

    win 10
    win 11
    win 10+ 17763
    Web Browser Chrome 129

For reference, here’s a JSON snippet that contains an undocumented device:

{
  "id":"MercKjkyQMCa3eTEXYeObQ",
  "user_id":"16778240",
  "participant_uuid":"1B2551FE-F292-3F4D-756B-1300A102125C",
  "user_name":"iL9",
  "device":"win 10+ 17763", <-- this is the undocumented value
  "ip_address":"31.44.5.60",
  "internal_ip_addresses":["31.44.*.*"],
  "location":"(US)",
  "network_type":"Wired",
  "data_center":"Netherlands (AMS Top)",
  "full_data_center":"Netherlands (AMS Top);",
  "connection_type":"Reliable UDP",
  "join_time":"2024-07-22T20:42:06Z",
  "share_application":false,
  "share_desktop":false,
  "share_whiteboard":false,
  "recording":false,
  "pc_name":"AX-VHOST03",
  "domain":"",
  "mac_addr":"ca02-bf82-a61a",
  "harddisk_id":"VirtIO:BHYVE-CEBF-C97F-EA99;",
  "version":"6.0.11.39959",
  "email":"<... redacted ...>",
  "registrant_id":"",
  "status":"in_meeting",
  "os":"win",
  "os_version":"\\"10+ 17763\\"",
  "device_name":"",
  "groupId":"",
  "customer_key":"",
  "sip_uri":"",
  "from_sip_uri":"",
  "role":"host",
  "participant_user_id":"MercKjkyQMCa3eTEXYeObQ",
  "audio_call":[]
}

My question is: is it normal for the Zoom API to return undocumented values in this JSON node or is this a bug?

How To Reproduce
This problem is intermittent and I haven’t been able to figure out how to reproduce.

2

@ojus.zoom can you please have a look? Either the data in the device node returned from the API is incorrect (because it’s outside of the documented valid values) or the documentation need to be updated to better describe the expected behavior.

Thanks

3

Hi @desautelsj
Thanks for reaching out to us!
Allow me some time to troubleshoot this on my end and I will send you a DM in case I require more information
Cheers,
Elisa

4

I just found a post from 2 years ago where they describe getting undocumented values in the device node. Their situation seems similar to what we are witnessing.

@elisa.zoom You interacted with the person reporting the issue back in September 2022. Do you remember if there was a resolution?

5

Hey @desautelsj
Thanks for reaching out back to us.
It seems like I did not follow up on that old thread.
But I will work with our Engineering team and report back to you. In the meantime could you please reply to the DM I just sent

6

Hi @elisa.zoom

Could you please send me a DM so I can provide you with more information about this issue?

Thanks
Tamas

1 Like
8

Another developer reported a new undocumented returned by the Zoom API in the device node: Windows 10.

So, to recap, we have so far observed the following undocumented values in the device node:

WIN
win 10
win 11
win 10+ 17763
Windows 10
Web Browser Chrome 129
Web Browser Chrome 130

Edit: I went back to my notes and I found one more undocumented value that I forgot to mention: Zoom Rooms

and let’s not forget the 20 or so undocumented values that where reported by someone else in September 2022.

I am starting to think that the behavior of the API has probably changed over the years and the documentation has not be updated accordingly and therefore we should ignore what the documentation says. @elisa.zoom Are you able to confirm whether the documentation is up to date or not?

@elisa.zoom A month ago you said you would troubleshoot on your end. What have you found? Also, I provided you everything you asked for in the private DM but there hasn’t been any progress. What do we need to do to move this case forward?

9

Thanks @desautelsj I currently re-engaging with our Engineering team to get more information about this