Zoom Phone Call Queues API
The Call Queues API from Zoom Phone — 18 operation(s) for call queues.
Operations 32
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/call_queue_analytics
Report call queue analytics for a date range · List call queue analytics
#
Ask an LLM
“What does the call queue analytics overview show for last month?”
“Can I narrow call queue analytics to one site, department or cost center?”
Tell an agent
Show call queue analytics from {from} to {to}.
Pull call queue analytics from {from} to {to} for site {site_id} only.
Ask an LLM
“Which call queues are set up in our Zoom Phone account?”
“Can I list only the call queues that belong to one department?”
Tell an agent
List all call queues on the account.
List the call queues at site {site_id}.
Ask an LLM
“How do I set up a new call queue for our sales team?”
“Can I give a new call queue its own extension number when I create it?”
Tell an agent
Create a call queue named {name} at site {site_id}.
Create call queue {name} at site {site_id} with extension {extension_number}.
Ask an LLM
“What extension and members does a specific call queue have?”
“Where can I look up the full configuration of one call queue?”
Tell an agent
Show details for call queue {callQueueId}.
Look up call queue {callQueueId} and tell me its extension number.
Ask an LLM
“Can I permanently remove a call queue we no longer use?”
“What happens when I delete a call queue entirely?”
Tell an agent destructive · confirm first
Delete call queue {callQueueId}.
Remove the call queue {callQueueId} from the account.
Ask an LLM
“How do I rename a call queue or change its extension?”
“Can I change a call queue's time zone or set it inactive?”
Tell an agent
Rename call queue {callQueueId} to {name}.
Set the status of call queue {callQueueId} to {status}.
GET
/phone/call_queues/{callQueueId}/call_handling/settings
Get a call queue's call handling for an hour type · Get call queue call handling setting
#
Ask an LLM
“What happens to calls into a queue after business hours?”
“Can I see a call queue's greeting and call distribution for holiday hours?”
Tell an agent
Show the call handling setting of call queue {callQueueId}.
Show call queue {callQueueId}'s call handling for {hour_type} hours.
PATCH
/phone/call_queues/{callQueueId}/call_handling/settings/{hourType}
Change a call queue's call handling for an hour type · Update call queue call handling setting
#
Ask an LLM
“How do I change the way a call queue distributes calls during business hours?”
“Can I update a queue's greeting for closed hours without touching other fields?”
Tell an agent
Update call queue {callQueueId}'s call handling for {hourType} hours.
Change the call distribution of call queue {callQueueId} during {hourType} hours to {call_distribution_setting}.
GET
/phone/call_queues/{callQueueId}/custom_groups
List a call queue's custom groups · List custom groups of a call queue
#
Ask an LLM
“Which custom groups have been defined inside a call queue?”
“Can I see the subgroups of agents set up in one queue?”
Tell an agent
List the custom groups in call queue {callQueueId}.
Show me every custom group set up under queue {callQueueId}.
POST
/phone/call_queues/{callQueueId}/custom_groups
Create a custom group in a call queue · Create a custom group in a call queue
#
Ask an LLM
“How do I split a call queue's members into a named custom group?”
“Can I add queue members to a custom group at the moment I create it?”
Tell an agent
Create a custom group named {name} in call queue {callQueueId}.
Create custom group {name} in call queue {callQueueId} with members {member_extension_ids}.
GET
/phone/call_queues/{callQueueId}/custom_groups/{customGroupId}
Get a call queue custom group · Get call queue custom group detail
#
Ask an LLM
“What does a particular custom group in a call queue contain?”
“Where do I see the name and members of one queue custom group?”
Tell an agent
Show custom group {customGroupId} in call queue {callQueueId}.
Get the name and members of queue {callQueueId} custom group {customGroupId}.
DELETE
/phone/call_queues/{callQueueId}/custom_groups/{customGroupId}
Delete a call queue custom group · Delete a custom group
#
Ask an LLM
“Can I remove a custom group from a call queue altogether?”
“Does deleting a queue custom group get rid of the whole group, not just a member?”
Tell an agent destructive · confirm first
Delete custom group {customGroupId} from call queue {callQueueId}.
Remove the whole custom group {customGroupId} from queue {callQueueId}.
PATCH
/phone/call_queues/{callQueueId}/custom_groups/{customGroupId}
Rename or redescribe a queue custom group · Update a custom group
#
Ask an LLM
“How do I rename a custom group inside a call queue?”
“Can I change the description of an existing queue custom group?”
Tell an agent
Rename custom group {customGroupId} in call queue {callQueueId} to {name}.
Set the description of custom group {customGroupId} in queue {callQueueId} to {description}.
POST
/phone/call_queues/{callQueueId}/custom_groups/{customGroupId}/members
Add queue members to a custom group · Add members to a custom group
#
Ask an LLM
“Can I add more queue members to an existing custom group?”
“How are agents added to a custom group after it already exists?”
Tell an agent
Add extensions {member_extension_ids} to custom group {customGroupId} in call queue {callQueueId}.
Put queue {callQueueId} members {member_extension_ids} into existing custom group {customGroupId}.
DELETE
/phone/call_queues/{callQueueId}/custom_groups/{customGroupId}/members/{extensionId}
Remove a member from a queue custom group · Remove a member from a custom group
#
Ask an LLM
“Can I take one agent out of a custom group without removing them from the queue?”
“What removes a single extension from a call queue's custom group?”
Tell an agent destructive · confirm first
Remove extension {extensionId} from custom group {customGroupId} in call queue {callQueueId}.
Take extension {extensionId} out of queue {callQueueId} custom group {customGroupId} but keep it in the queue.
GET
/phone/call_queues/{callQueueId}/members
List a call queue's members · List call queue members
#
Ask an LLM
“Who are the agents answering calls in a given call queue?”
“Can I see which users and common areas belong to a queue?”
Tell an agent
List the members of call queue {callQueueId}.
Who answers calls in queue {callQueueId}? List its users and common areas.
POST
/phone/call_queues/{callQueueId}/members
Add users or common areas to a call queue · Add members to a call queue
#
Ask an LLM
“How do I add phone users to an existing call queue?”
“Can a common area phone be made a member of a call queue?”
Tell an agent
Add {members} as members of call queue {callQueueId}.
Add common area {members} to call queue {callQueueId} as a member.
DELETE
/phone/call_queues/{callQueueId}/members
Remove every member from a call queue · Unassign all members
#
Ask an LLM
“Is there a way to clear out all members of a call queue at once?”
“Can I empty a queue of every user and common area in one call?”
Tell an agent destructive · confirm first
Unassign all members from call queue {callQueueId}.
Clear every user and common area out of queue {callQueueId}.
DELETE
/phone/call_queues/{callQueueId}/members/{memberId}
Remove one member from a call queue · Unassign a member
#
Ask an LLM
“How do I take a single user out of a call queue?”
“Can I remove a queue manager with the single-member unassign?”
Tell an agent destructive · confirm first
Remove member {memberId} from call queue {callQueueId}.
Take user {memberId} out of queue {callQueueId}.
POST
/phone/call_queues/{callQueueId}/phone_numbers
Assign phone numbers to a call queue · Assign numbers to a call queue
#
Ask an LLM
“Can callers dial a direct number that rings a call queue?”
“What do I do after buying numbers to point them at a queue?”
Tell an agent
Assign phone numbers {phone_numbers} to call queue {callQueueId}.
Give call queue {callQueueId} the direct number {phone_numbers} so callers can dial it.
DELETE
/phone/call_queues/{callQueueId}/phone_numbers
Unassign all phone numbers from a call queue · Unassign all phone numbers
#
Ask an LLM
“How do I unbind every direct number from a call queue at once?”
“Where do numbers go after I strip them all off a queue?”
Tell an agent destructive · confirm first
Unassign all phone numbers from call queue {callQueueId}.
Unbind every direct number from queue {callQueueId} and return them to unassigned.
DELETE
/phone/call_queues/{callQueueId}/phone_numbers/{phoneNumberId}
Unassign one phone number from a call queue · Unassign a phone number
#
Ask an LLM
“Can I unbind just one of the numbers assigned to a call queue?”
“How do I move a single queue number back to the unassigned list?”
Tell an agent destructive · confirm first
Unassign phone number {phoneNumberId} from call queue {callQueueId}.
Unbind just number {phoneNumberId} from queue {callQueueId}, leaving its other numbers.
GET
/phone/call_queues/{callQueueId}/policies
Get a call queue's policy settings · Get call queue policy
#
Ask an LLM
“Is voicemail transcription or auto call recording turned on for a queue?”
“What policy settings, like SMS or call screening, apply to one call queue?”
Tell an agent
Check whether voicemail transcription and auto recording are on for queue {callQueueId}.
Get the policy (SMS, call screening, recording) for call queue {callQueueId}.
PATCH
/phone/call_queues/{callQueueId}/policies
Update a call queue's policy settings · Update call queue policy
#
Ask an LLM
“How do I turn on voicemail transcription for a call queue?”
“Can I block callers without caller ID on one queue?”
Tell an agent
Turn on voicemail transcription for call queue {callQueueId} with {voicemail_transcription}.
Set auto call recording on call queue {callQueueId} to {auto_call_recording}.
POST
/phone/call_queues/{callQueueId}/policies/{policyType}
Add shared voicemail access to a call queue · Add a policy subsetting to a call queue
#
Ask an LLM
“How do I give extra people shared access to a call queue's voicemail?”
“Can I add voicemail access members under a queue policy type?”
Tell an agent
Add voicemail access members {voicemail_access_members} to call queue {callQueueId} under policy {policyType}.
Grant new shared access to queue {callQueueId} voicemail via policy {policyType}.
DELETE
/phone/call_queues/{callQueueId}/policies/{policyType}
Remove shared access members from a queue policy · Delete a CQ policy setting
#
Ask an LLM
“Can I revoke someone's shared voicemail access on a call queue?”
“Which IDs do I pass to remove shared access members from a queue policy?”
Tell an agent destructive · confirm first
Remove shared access {shared_ids} from call queue {callQueueId} policy {policyType}.
Revoke shared voicemail access {shared_ids} on queue {callQueueId} for policy {policyType}.
PATCH
/phone/call_queues/{callQueueId}/policies/{policyType}
Change shared voicemail access on a call queue · Update a call queue's policy subsetting
#
Ask an LLM
“How do I change the permissions of people who already share a queue's voicemail?”
“Can I edit existing voicemail access members on a call queue policy?”
Tell an agent
Update voicemail access members on call queue {callQueueId} policy {policyType} to {voicemail_access_members}.
Change permissions of existing shared voicemail members on queue {callQueueId} policy {policyType}.
GET
/phone/call_queues/{callQueueId}/recordings
List a call queue's call recordings · Get call queue recordings
#
Ask an LLM
“Where can I find recordings of calls handled by a call queue?”
“Can I fetch queue recordings for a specific date range?”
Tell an agent
List call recordings for call queue {callQueueId}.
List call queue {callQueueId} recordings from {from} to {to}.
GET
/phone/call_queues/{callQueueId}/settings
Get a call queue's settings · Get call queue settings
#
Ask an LLM
“What settings are configured on a call queue, by setting type?”
“Can I read just one type of setting for a queue?”
Tell an agent
Get all typed settings configured on call queue {callQueueId}.
Show call queue {callQueueId}'s {setting_type} settings.
POST
/phone/call_queues/{callQueueId}/settings/{settingType}
Add a setting to a call queue by type · Add call queue setting
#
Ask an LLM
“Can I add a new setting entry of a given type to a call queue?”
“How is a setting type, like a holiday entry, added to a queue?”
Tell an agent
Add a {settingType} setting to call queue {callQueueId}.
Create a new {settingType} entry on queue {callQueueId}.
DELETE
/phone/call_queues/{callQueueId}/settings/{settingType}
Delete a call queue setting by type · Delete call queue setting
#
Ask an LLM
“How do I remove a holiday or break hour setting from a call queue?”
“Can I delete one setting type from a queue's configuration?”
Tell an agent destructive · confirm first
Delete the {settingType} setting from call queue {callQueueId}.
Delete holiday {holiday_hour_id} from call queue {callQueueId}'s {settingType} setting.
PATCH
/phone/call_queues/{callQueueId}/settings/{settingType}
Update a call queue setting by type · Update call queue setting
#
Ask an LLM
“Can I modify an existing setting of a particular type on a call queue?”
“How do I edit a queue setting that was added earlier?”
Tell an agent
Update the {settingType} setting on call queue {callQueueId}.
Modify the existing {settingType} entry on queue {callQueueId}.
Documentation
📖
Documentation
https://developers.zoom.us/docs/api/phone/
📖
APIReference
https://developers.zoom.us/docs/api/phone/
📖
Documentation
https://developers.zoom.us/docs/integrations/oauth/
📖
Documentation
https://developers.zoom.us/docs/api/phone/events/
📖
APIReference
https://developers.zoom.us/docs/api/phone/events/
📖
Documentation
https://developers.zoom.us/docs/api/number-management/
📖
APIReference
https://developers.zoom.us/docs/api/number-management/