Zoom Phone Roles API

The Phone Roles API from Zoom Phone — 4 operation(s) for phone roles.

Documentation GitHub OpenAPI

Business capability

Operations 11

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /phone/roles List phone roles · List phone roles #

Ask an LLM

“Which phone admin roles exist in our account?”

“Is there a list of every Zoom Phone role?”

Tell an agent

List all phone roles.

Show me every phone role we have defined.

POST /phone/roles Duplicate a phone role · Duplicate a phone role #

Ask an LLM

“Can I create a new phone role by copying an existing one?”

“How do I clone a role and give the copy its own name?”

Tell an agent

Duplicate phone role {role_id}.

Copy phone role {role_id} as a new role called {name}.

GET /phone/roles/{roleId} Get a phone role's details · Get role information #

Ask an LLM

“What does a particular phone role include?”

“Where can I see the name and description of one role?”

Tell an agent

Show details for phone role {roleId}.

Look up phone role {roleId}.

DELETE /phone/roles/{roleId} Delete a phone role · Delete a phone role #

Ask an LLM

“Can I delete a phone role we no longer use?”

“What removes a custom phone role from the account?”

Tell an agent destructive · confirm first

Delete phone role {roleId}.

Remove the phone role {roleId} permanently.

PATCH /phone/roles/{roleId} Rename or redescribe a phone role · Update a phone role #

Ask an LLM

“How do I rename a phone role?”

“Can I change a role's description?”

Tell an agent

Rename phone role {roleId} to {name}.

Set the description of phone role {roleId} to {description}.

GET /phone/roles/{roleId}/members List users in or not in a phone role · List members in a role #

Ask an LLM

“Who is assigned to a given phone role?”

“Can I list users who are NOT in a role yet?”

Tell an agent

List the members of phone role {roleId}.

List users with in-role status {in_role} for role {roleId}.

POST /phone/roles/{roleId}/members Add users to a phone role · Add members to roles #

Ask an LLM

“How do I assign users to a phone role?”

“Can I copy all the members of one role into another?”

Tell an agent

Add users {user_ids} to phone role {roleId}.

Add members to role {roleId} by copying from role {role_id}.

DELETE /phone/roles/{roleId}/members Remove users from a phone role · Delete members in a role #

Ask an LLM

“Can I take users out of a phone role?”

“What removes several members from a role at once?”

Tell an agent destructive · confirm first

Remove users {user_ids} from phone role {roleId}.

Take {user_ids} out of role {roleId}.

GET /phone/roles/{roleId}/targets List the targets a phone role manages · List phone role targets #

Ask an LLM

“Which sites or users does a phone role apply to?”

“Can I filter a role's targets by target type or site?”

Tell an agent

List the targets of phone role {roleId}.

List role {roleId} targets of type {target_type}.

POST /phone/roles/{roleId}/targets Add targets to a phone role · Add phone role targets #

Ask an LLM

“How do I scope a phone role to specific sites or users?”

“Can I add targets for one member of a role rather than the default?”

Tell an agent

Add targets {targets} to phone role {roleId}.

Add targets {targets} to role {roleId} for user {user_id}.

DELETE /phone/roles/{roleId}/targets Remove targets from a phone role · Delete phone role targets #

Ask an LLM

“Can I narrow a phone role by removing some of its targets?”

“What deletes targets from a role for a specific user?”

Tell an agent destructive · confirm first

Remove targets {targets} from phone role {roleId}.

Delete role {roleId} targets {targets} for user {user_id}.

Zoom Phone Roles API

Operations 11

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification