Hello Team,
To provide a comprehensive overview of our requirements, we seek to ascertain the availability of an API that provides the aggregation/listing of all agents (or agents for a specific type) within a zoom workspace.
Upon reviewing the documentation for Zoom’s agent support, we have identified three distinct types of agents:
- Human Agents (Zoom Contact Center)
- AI Agents (Zoom Virtual Agent - ZVA)
- Custom Agents
While reviewing the documentation of the Zoom API, we have not identified any available APIs for retrieving or listing these agents. Could you please advise if APIs are currently available or if there are any plans to make them available in the future?
1 Like
Hi @connectivity
Thanks for reaching out to us!
I believe we do not have an endpoint to query the availability of all the different agents.
Hi Elisa,
Thanks for your prompt response!
- I have gone through the API documentation for ZVA: Virtual Agent APIs and I can see the APIs available regarding Knowledge Management and Report of Virtual Agents but I do not see the API to get all Virtual Agents or retrieve a single Virtual Agent.
- Similarly for Zoom contact center: Contact Center APIs , I could only see the Agent Statuses API but not the get all Zoom Contact Center Agents or retrieve a single Zoom Contact Center Agent.
Hi @connectivity
Thanks for clarifying. Let me ask internally to see if we have an endpoint available for what you are trying to accomplish
It will be really helpful @elisa.zoom
Thanks in advance!
Hi @connectivity
Thanks for your patience here.
Agents are called users in ZCC, so you can use the List Users Profile endpoint to get a list of Agents.
https://developers.zoom.us/docs/api/contact-center/#tag/users/get/contact_center/users
You will just need to do some filtering based on the role_name to make sure you are just getting agents.
Let me know if this helps!