Zoom Contact Center API
Number of APIs: 158
1. contact_center-voice_calls - List voice call logs
GET {{baseUrl}}/contact_center/voice_calls?next_page_token=<string>&page_size=10&from=<date>&to=<date>&types=external_conference_call&types=external_call&distribution=non_acd&consumer_number=<string>&direction=outbound&user_ids=<string>&user_ids=<string>&engagement_id=<string>&queue_ids=<string>&queue_ids=<string>&country_iso_codes=<string>&country_iso_codes=<string>&number_types=byoc_number&number_types=byoc_number
Returns a list of voice call logs.
Scopes: contact_center_voice_call:read:admin
Rate Limit Label: HEAVY
2. contact_center-variables-{variableId} - Get a variable
GET {{baseUrl}}/contact_center/variables/:variableId
3. contact_center-variables-{variableId} - Delete a variable
DELETE {{baseUrl}}/contact_center/variables/:variableId
4. contact_center-variables-{variableId} - Update a variable
PATCH {{baseUrl}}/contact_center/variables/:variableId
5. contact_center-variables-groups-{variableGroupId} - Get a variable group
GET {{baseUrl}}/contact_center/variables/groups/:variableGroupId
Get information about a variable group.
Scopes: contact_center_variable:read:admin
Rate Limit Label: Light
6. contact_center-variables-groups-{variableGroupId} - Delete a variable group
DELETE {{baseUrl}}/contact_center/variables/groups/:variableGroupId
Delete a specified variable group.
Scopes: contact_center_variable:write:admin
Rate Limit Label: Light
7. contact_center-variables-groups-{variableGroupId} - Update a variable group
PATCH {{baseUrl}}/contact_center/variables/groups/:variableGroupId
8. contact_center-variables-groups - List variable groups
GET {{baseUrl}}/contact_center/variables/groups?next_page_token=<string>&page_size=30&variable_group_type=system
Use thi API to return a list of variable groups.
Scopes: contact_center_variable:read:admin
Rate Limit Label: Medium
9. contact_center-variables-groups - Create a variable group
POST {{baseUrl}}/contact_center/variables/groups
10. contact_center-variables - List variables
GET {{baseUrl}}/contact_center/variables?variable_group_id=<string>&data_type=currency&variable_type=global_variable&next_page_token=<string>&page_size=30
Returns a list of variables for a specific variable group.
Scopes: contact_center_variable:read:admin
Rate Limit Label: Medium
11. contact_center-variables - Create a variable
POST {{baseUrl}}/contact_center/variables
12. contact_center-variable_logs-{variableLogId} - Get a variable log
GET {{baseUrl}}/contact_center/variable_logs/:variableLogId
Get information about a variable log.
Scopes: contact_center_variable_log:read:admin
Rate Limit Label: Light
13. contact_center-variable_logs-{variableLogId} - Delete a variable log
DELETE {{baseUrl}}/contact_center/variable_logs/:variableLogId
14. contact_center-variable_logs - List variable logs
GET {{baseUrl}}/contact_center/variable_logs?next_page_token=<string>&page_size=30&from=<date>&to=<date>&group_type=system&data_type=boolean&engagement_id=<string>&flow_id=<string>&widget_name=<string>&variable_name=<string>&variable_value=<string>
Return a list of variable logs.
Scopes: contact_center_variable_log:read:admin
Rate Limit Label: Heavy
15. contact_center-users-{userId}-skills-{skillId} - Unassign user's skill
DELETE {{baseUrl}}/contact_center/users/:userId/skills/:skillId
Delete a skill assigned to a given user.
Scopes: contact_center_skill:write:admin
Rate Limit Label: Light
16. contact_center-users-{userId}-skills - List user's skills
GET {{baseUrl}}/contact_center/users/:userId/skills?skill_category_id=<string>&skill_type=text
Get a list of skills assigned to a given user.
Scopes: contact_center_skill:read:admin
Rate Limit Label: Medium
17. contact_center-users-{userId}-skills - Assign user's skills
POST {{baseUrl}}/contact_center/users/:userId/skills
Assign skills to a user. Skills are user traits that ensure that a given agent is the best person to handle a given customer interaction. Proficiency ratings indicate the user's level of expertise or knowledge of that skill.
Scopes: contact_center_skill:write:admin
Rate Limit Label: Medium
18. contact_center-users-{userId}-recordings - List user's recordings
GET {{baseUrl}}/contact_center/users/:userId/recordings?channel_type=voice&from=<string>&to=<string>&next_page_token=<string>&page_size=30
Get a user's recordings.
Note: Use recording-related APIs to manipulate data whose recording creation time is after 2022-07-18.
Scopes: contact_center_recording:readcontact_center_recording:read:admin
Rate Limit Label: Medium
19. contact_center-users-{userId}-recordings - Delete user's recordings
DELETE {{baseUrl}}/contact_center/users/:userId/recordings?delete_all_recordings=true
Delete all of a given user's recordings.
Note: Use recording-related APIs to manipulate data whose recording creation time is after 2022-07-18.
Scopes: contact_center_recording:write:admin
Rate Limit Label: Light
20. contact_center-users-{userId}-queues - List user's queues
GET {{baseUrl}}/contact_center/users/:userId/queues?next_page_token=<string>&page_size=30
21. contact_center-users-{userId} - Get a user's profile
GET {{baseUrl}}/contact_center/users/:userId
Retrieve a user's profile information.
Scopes: contact_center_user:write:admin
Rate Limit Label: LIGHT
22. contact_center-users-{userId} - Delete a user's profile
DELETE {{baseUrl}}/contact_center/users/:userId
Delete the specified user's profile.
Scopes: contact_center_user:write:admin
Rate Limit Label: Light
23. contact_center-users-{userId} - Update a user's profile
PATCH {{baseUrl}}/contact_center/users/:userId
Update information in a user's profile.
Scopes: contact_center_user:write:admin
Rate Limit Label: LIGHT
24. contact_center-users-batch - Batch create user profiles
POST {{baseUrl}}/contact_center/users/batch
25. contact_center-users - List users' profiles
GET {{baseUrl}}/contact_center/users?search_key=<string>&next_page_token=<string>&page_size=30®ion_id=<string>&user_access=inactive
Returns a list of users and their information.
Scopes: contact_center_user:read:admin
Rate Limit Label: MEDIUM
26. contact_center-users - Create a user's profile
POST {{baseUrl}}/contact_center/users
27. contact_center-users - Batch delete user profiles
DELETE {{baseUrl}}/contact_center/users?user_ids=<string>&user_ids=<string>&user_emails=<string>&user_emails=<string>
Batch delete users.
Note: Either user_ids or user_emails needs to be provided. If both user_ids and user_emails are provided, only user_ids will be used, while user_emails will be ignored.
Scopes: contact_center_user:write:admin
Rate Limit Label: Medium
28. contact_center-users - Batch update user profiles
PATCH {{baseUrl}}/contact_center/users
29. contact_center-tasks-{taskId} - Get a task
GET {{baseUrl}}/contact_center/tasks/:taskId
Use this API to return information about a task.
Scopes: contact_center_task:read:admin
Rate Limit Label: Light
30. contact_center-tasks-{taskId} - Update a task
PATCH {{baseUrl}}/contact_center/tasks/:taskId
Use this API to:
1) update a task's priority level or
2) manually assign or unassign a task to an agent.
Scopes: contact_center_task:write:admin
Rate Limit Label: Light
31. contact_center-tasks - List tasks
GET {{baseUrl}}/contact_center/tasks?task_status=wrapping&queue_id=<string>&engagement_id=<string>&next_page_token=<string>
Use this API to return a list of tasks.
Scopes: contact_center_task:read:admin
Rate Limit Label: Medium
32. contact_center-system_statuses-{statusId} - Get a system status
GET {{baseUrl}}/contact_center/system_statuses/:statusId
Display information about a system status.
Scopes: contact_center_preference:read:admin
Rate Limit Label: Light
33. contact_center-system_statuses-{statusId} - Delete a system status
DELETE {{baseUrl}}/contact_center/system_statuses/:statusId
Delete a custom status for the agentstatus and queueoptoutandnotready_status categories.
34. contact_center-system_statuses-{statusId} - Update a system status
PATCH {{baseUrl}}/contact_center/system_statuses/:statusId
Update a custom status for the agentstatus and queueoptoutandnotready_status categories.
Scopes: contact_center_preference:write:admin
Rate Limit Label: Light
35. contact_center-system_statuses - List system statuses
GET {{baseUrl}}/contact_center/system_statuses?next_page_token=<string>&page_size=30&status_category=queue_opt_out_and_not_ready_status
Get a list of system statuses. Admins can create system statuses, such as "Maintenance".
Scopes: contact_center_preference:read:admin
Rate Limit Label: MEDIUM
36. contact_center-system_statuses - Create a system status
POST {{baseUrl}}/contact_center/system_statuses
Create custom statuses for the agentstatus and queueoptoutandnotready_status categories.
Scopes: contact_center_preference:write:admin
Rate Limit Label: Light
37. contact_center-sms - List SMS logs
GET {{baseUrl}}/contact_center/sms?next_page_token=<string>&page_size=10&from=<date>&to=<date>&country_iso_codes=<string>&country_iso_codes=<string>&direction=outbound&user_id=<string>&engagement_id=<string>&consumer_number=<string>
38. contact_center-skills-{skillId}-users-{userId} - Get a skill's user
GET {{baseUrl}}/contact_center/skills/:skillId/users/:userId
Retrieve information for a particular skill's user.
Scopes: contact_center_user:read:admin
Rate Limit Label: Medium
39. contact_center-skills-{skillId}-users - List users of a skill
GET {{baseUrl}}/contact_center/skills/:skillId/users?next_page_token=<string>&page_size=30
List all users who have been assigned to a skill.
Scopes: contact_center_user:read:admin
Rate Limit Label: Medium
40. contact_center-skills-{skillId} - Get a skill
GET {{baseUrl}}/contact_center/skills/:skillId
Return a skill's information and its usage.
Scopes: contact_center_skill:read:admin
Rate Limit Label: Light
41. contact_center-skills-{skillId} - Delete a skill
DELETE {{baseUrl}}/contact_center/skills/:skillId
42. contact_center-skills-{skillId} - Update a skill
PATCH {{baseUrl}}/contact_center/skills/:skillId
Use this API to update a skill's name.
Scopes: contact_center_skill:write:admin
Rate Limit Label: Light
43. contact_center-skills-categories-{skillCategoryId} - Get a skill category
GET {{baseUrl}}/contact_center/skills/categories/:skillCategoryId
Return information about a specific skill category.
Scopes: contact_center_skill:read:admin
Rate Limit Label: Light
44. contact_center-skills-categories-{skillCategoryId} - Delete a skill category
DELETE {{baseUrl}}/contact_center/skills/categories/:skillCategoryId
45. contact_center-skills-categories-{skillCategoryId} - Update a skill category
PATCH {{baseUrl}}/contact_center/skills/categories/:skillCategoryId
46. contact_center-skills-categories - List skill categories
GET {{baseUrl}}/contact_center/skills/categories?next_page_token=<string>&page_size=30
List all available skill categories and their information.
Scopes: contact_center_skill:read:admin
Rate Limit Label: Medium
47. contact_center-skills-categories - Create a skill category
POST {{baseUrl}}/contact_center/skills/categories
Create a new skill category. Skill categories let you assign several similar skills to a category, such as language skills. You can then route French-speaking callers to contact center agents that have the highest proficiency with French.
Scopes: contact_center_skill:write:admin
Rate Limit Label: Light
48. contact_center-skills - List skills
GET {{baseUrl}}/contact_center/skills?skill_category_id=<string>&skill_id=<string>&skill_type=text&next_page_token=<string>&page_size=30
Return a list of a skills or a skill category's assigned skills.
Scopes: contact_center_skill:read:admin
Rate Limit Label: Medium
49. contact_center-skills - Create a skill
POST {{baseUrl}}/contact_center/skills
Create a skill for skill-based routing. Skills are agent traits that ensure they are the right person to handle a customer interaction.
Scopes: contact_center_skill:write:admin
Rate Limit Label: Light
50. contact_center-roles-{roleId}-users-{userId} - Unassign a role
DELETE {{baseUrl}}/contact_center/roles/:roleId/users/:userId
Use this API to unassign a user from a role.
Scopes: contact_center_role:write:admin
Rate Limit Label: Light
51. contact_center-roles-{roleId}-users - List users of a role
GET {{baseUrl}}/contact_center/roles/:roleId/users?next_page_token=<string>&page_size=30
Use this API to get information about the users assigned to a specific role.
Scopes: contact_center_role:read:admin
Rate Limit Label: Medium
52. contact_center-roles-{roleId}-users - Assign a role
POST {{baseUrl}}/contact_center/roles/:roleId/users
Use this API to assign users to a role. Roles have unique privileges that assigned users have access to. For example, an Administrator or Agent role.
Scopes: contact_center_role:write:admin
Rate Limit Label: Medium
53. contact_center-roles-{roleId} - Get a role
GET {{baseUrl}}/contact_center/roles/:roleId
Use this API to get information about a role.
Scopes: contact_center_role:read:admin
Rate Limit Label: Light
54. contact_center-roles-{roleId} - Delete a role
DELETE {{baseUrl}}/contact_center/roles/:roleId?transfer_role_id=<string>
55. contact_center-roles-{roleId} - Update a role
PATCH {{baseUrl}}/contact_center/roles/:roleId
56. contact_center-roles - List roles
GET {{baseUrl}}/contact_center/roles?next_page_token=<string>&page_size=30
Use this API to return a list of roles.
Scopes: contact_center_role:read:admin
Rate Limit Label: Medium
57. contact_center-roles - Create a role
POST {{baseUrl}}/contact_center/roles
Use this API to create a new role. Admins can use the role management feature to control access to features and settings in the Zoom web portal.
Scopes: contact_center_role:write:admin
Rate Limit Label: Light
58. contact_center-regions-{regionId}-users - List region's users
GET {{baseUrl}}/contact_center/regions/:regionId/users?role_id=<string>
Retrieve the list of a region's assigned agents.
Scopes: contact_center_region:read:admin
Rate Limit Label: MEDIUM
59. contact_center-regions-{regionId}-users - Assign users to a region
POST {{baseUrl}}/contact_center/regions/:regionId/users
60. contact_center-regions-{regionId} - Get a region
GET {{baseUrl}}/contact_center/regions/:regionId
61. contact_center-regions-{regionId} - Delete a region
DELETE {{baseUrl}}/contact_center/regions/:regionId?move_users_to_region_id=<string>
Delete a site and move its members to another region.
Scopes: contact_center_region:write:admin
Rate Limit Label: LIGHT
62. contact_center-regions-{regionId} - Update a region
PATCH {{baseUrl}}/contact_center/regions/:regionId
63. contact_center-regions - List regions
GET {{baseUrl}}/contact_center/regions?next_page_token=<string>&page_size=30
Get information about all available regions.
Scopes: contact_center_region:read:admin
Rate Limit Label: MEDIUM
64. contact_center-regions - Create a region
POST {{baseUrl}}/contact_center/regions
65. contact_center-recordings-{recordingId} - Delete a recording
DELETE {{baseUrl}}/contact_center/recordings/:recordingId
Delete a selected recording.
Note: Use recording-related APIs to manipulate data whose recording creation time is after 2022-07-18.
Scopes: contact_center_recording:write:admin
Rate Limit Label: Light
66. contact_center-recordings - List recordings
GET {{baseUrl}}/contact_center/recordings?query_date_type=recording_start_time&from=<string>&to=<string>&recording_type=automatic&owner_type=user&channel_type=voice&next_page_token=<string>&page_size=30
Return a list of available recordings.
Note: Use recording-related APIs to manipulate data whose recording creation time is after 2022-07-18.
Scopes: contact_center_recording:read:admin
Rate Limit Label: Medium
67. contact_center-queues-{queueId}-supervisors-{userId} - Unassign a queue supervisor
DELETE {{baseUrl}}/contact_center/queues/:queueId/supervisors/:userId
Unassign a supervisor from a queue.
Scopes: contact_center_queue:write:admin
Rate Limit Label: Light
68. contact_center-queues-{queueId}-supervisors - List queue supervisors
GET {{baseUrl}}/contact_center/queues/:queueId/supervisors
Return a list of a queue's assigned supervisors.
Scopes: contact_center_queue:read:admin
Rate Limit Label: Medium
69. contact_center-queues-{queueId}-supervisors - Assign queue supervisors
POST {{baseUrl}}/contact_center/queues/:queueId/supervisors
70. contact_center-queues-{queueId}-recordings - List queue recordings
GET {{baseUrl}}/contact_center/queues/:queueId/recordings?channel_type=voice&from=<string>&to=<string>&next_page_token=<string>&page_size=30
Return a list of all recordings in a queue.
Note: Use recording-related APIs to manipulate data whose recording creation time is after 2022-07-18.
Scopes: contact_center_recording:read:admin
Rate Limit Label: Medium
71. contact_center-queues-{queueId}-recordings - Delete queue recordings
DELETE {{baseUrl}}/contact_center/queues/:queueId/recordings?delete_all_recordings=true
Delete all recordings in a queue.
Note: Use recording-related APIs to manipulate data whose recording creation time is after 2022-07-18.
Scopes: contact_center_recording:write:admin
Rate Limit Label: Light
72. contact_center-queues-{queueId}-operating_hours - Get a queue's operating hours
GET {{baseUrl}}/contact_center/queues/:queueId/operating_hours
Get information about a queue's operating hours.
Scopes: contact_center_queue:read:admin
Rate Limit Label: LIGHT
73. contact_center-queues-{queueId}-operating_hours - Update a queue's operating hours
PATCH {{baseUrl}}/contact_center/queues/:queueId/operating_hours
74. contact_center-queues-{queueId}-dispositions-{dispositionId} - Unassign a queue disposition
DELETE {{baseUrl}}/contact_center/queues/:queueId/dispositions/:dispositionId
DELETE {{baseUrl}}/contact_center/queues/:queueId/dispositions/sets/:dispositionSetId
Delete a disposition set from a queue.
Scopes: contact_center_queue:write:admin
Rate Limit Label: Light
76. contact_center-queues-{queueId}-dispositions-sets - List queue disposition sets
GET {{baseUrl}}/contact_center/queues/:queueId/dispositions/sets
Return a list of queue's disposition sets(https://support.zoom.us/hc/en-us/articles/4470153057549-Managing-dispositions).
Scopes: contact_center_queue:read:admin
Rate Limit Label: Medium
77. contact_center-queues-{queueId}-dispositions-sets - Assign a queue disposition set
POST {{baseUrl}}/contact_center/queues/:queueId/dispositions/sets
78. contact_center-queues-{queueId}-dispositions - List queue dispositions
GET {{baseUrl}}/contact_center/queues/:queueId/dispositions
Return a list of queue's dispositions.
Scopes: contact_center_queue:read:admin
Rate Limit Label: Medium
79. contact_center-queues-{queueId}-dispositions - Assign queue dispositions
POST {{baseUrl}}/contact_center/queues/:queueId/dispositions
80. contact_center-queues-{queueId}-agents-{userId} - Unassign a queue agent
DELETE {{baseUrl}}/contact_center/queues/:queueId/agents/:userId
81. contact_center-queues-{queueId}-agents-{userId} - Update a queue agent
PATCH {{baseUrl}}/contact_center/queues/:queueId/agents/:userId
Update the list of agents in a queue.
Scopes: contact_center_queue:write:admin
Rate Limit Label: Light
82. contact_center-queues-{queueId}-agents - List queue agents
GET {{baseUrl}}/contact_center/queues/:queueId/agents
Retrieve the list of a queue's assigned agents.
Scopes: contact_center_queue:read:admin
Rate Limit Label: Medium
83. contact_center-queues-{queueId}-agents - Assign queue agents
POST {{baseUrl}}/contact_center/queues/:queueId/agents
84. contact_center-queues-{queueId} - Get a queue
GET {{baseUrl}}/contact_center/queues/:queueId
85. contact_center-queues-{queueId} - Delete a queue
DELETE {{baseUrl}}/contact_center/queues/:queueId
86. contact_center-queues-{queueId} - Update a queue
PATCH {{baseUrl}}/contact_center/queues/:queueId
Update a queue's description or agent list.
Scopes: contact_center_queue:write:admin
Rate Limit Label: LIGHT
87. contact_center-queues - List queues
GET {{baseUrl}}/contact_center/queues?channel_type=sms&next_page_token=<string>&page_size=30
Get information about all available queues.
Scopes: contact_center_queue:read:admin
Rate Limit Label: MEDIUM
88. contact_center-queues - Create a queue
POST {{baseUrl}}/contact_center/queues
Create an agent queue to determine which agents calls are routed to. Queues also link to an existing routing profile to determine how calls are routed.
Scopes: contact_center_queue:write:admin
Rate Limit Label: LIGHT
89. contact_center-inboxes-{inboxId}-users - Get an inbox's users
GET {{baseUrl}}/contact_center/inboxes/:inboxId/users
Retrieve a list of users assigned to an inbox.
Scopes: contact_center_user:read:admin
Rate Limit Label: Medium
90. contact_center-inboxes-{inboxId}-users - Assign inbox access users
POST {{baseUrl}}/contact_center/inboxes/:inboxId/users
Assign a user's access to an inbox.
Scopes: contact_center_user:write:admin
Rate Limit Label: Medium
91. contact_center-inboxes-{inboxId}-users - Unassign inbox access users
DELETE {{baseUrl}}/contact_center/inboxes/:inboxId/users?user_ids=<string>&user_ids=<string>
92. contact_center-inboxes-{inboxId}-queues - Get inbox access queues
GET {{baseUrl}}/contact_center/inboxes/:inboxId/queues
Retrieve a list of queues that have access to an inbox.
Scopes: contact_center_queue:read:admin
Rate Limit Label: Medium
93. contact_center-inboxes-{inboxId}-queues - Assign inbox access queues
POST {{baseUrl}}/contact_center/inboxes/:inboxId/queues
94. contact_center-inboxes-{inboxId}-queues - Unassign inbox access queues
DELETE {{baseUrl}}/contact_center/inboxes/:inboxId/queues?queue_ids=<string>&queue_ids=<string>
Remove queues' access to an inbox.
Scopes: contact_center_queue:write:admin
Rate Limit Label: Medium
95. contact_center-inboxes-{inboxId}-messages-{messageId} - Delete an inbox message
DELETE {{baseUrl}}/contact_center/inboxes/:inboxId/messages/:messageId
Delete a single message in an inbox.
Scopes: contact_center_inbox:write:admin
Rate Limit Label: Light
96. contact_center-inboxes-{inboxId}-messages - List an inbox's messages
GET {{baseUrl}}/contact_center/inboxes/:inboxId/messages?queue_ids=<string>&queue_ids=<string>&message_type=voicemail&flow_id=<string>&from=<date>&to=<date>&next_page_token=<string>&page_size=30
Return a list of all messages in an inbox.
Scopes: contact_center_inbox:read:admin
Rate Limit Label: MEDIUM
97. contact_center-inboxes-{inboxId}-messages - Delete an inbox's messages
DELETE {{baseUrl}}/contact_center/inboxes/:inboxId/messages?delete_all_messages=true
98. contact_center-inboxes-{inboxId} - Get an inbox
GET {{baseUrl}}/contact_center/inboxes/:inboxId
99. contact_center-inboxes-{inboxId} - Update an inbox
PATCH {{baseUrl}}/contact_center/inboxes/:inboxId
100. contact_center-inboxes-messages - List an account's inbox messages
GET {{baseUrl}}/contact_center/inboxes/messages?queue_ids=<string>&queue_ids=<string>&inbox_id=<string>&flow_id=<string>&minimum_duration=<integer>&maximum_duration=<integer>&message_type=voicemail&from=<date>&to=<date>&engagement_id=<string>&consumer_number=<string>&status=normal&next_page_token=<string>&page_size=30
101. contact_center-inboxes-messages - Delete inbox messages
DELETE {{baseUrl}}/contact_center/inboxes/messages?delete_all_messages=<boolean>&queue_ids=<string>&queue_ids=<string>&flow_ids=<string>&flow_ids=<string>
102. contact_center-inboxes - List inboxes
GET {{baseUrl}}/contact_center/inboxes?next_page_token=<string>&page_size=30
103. contact_center-inboxes - Create an inbox
POST {{baseUrl}}/contact_center/inboxes
104. contact_center-inboxes - Delete inboxes
DELETE {{baseUrl}}/contact_center/inboxes?inbox_ids=<string>&inbox_ids=<string>&delete_all_messages_and_inboxes=<boolean>&move_to_inbox_id=<string>
105. contact_center-flows-{flowId} - Get a flow
GET {{baseUrl}}/contact_center/flows/:flowId
106. contact_center-flows - List flows
GET {{baseUrl}}/contact_center/flows?next_page_token=<string>&page_size=30&status=draft&channel_type=chat
107. contact_center-engagements-{engagementId}-recordings - List engagement recordings
GET {{baseUrl}}/contact_center/engagements/:engagementId/recordings?channel_type=voice&from=<string>&to=<string>&next_page_token=<string>&page_size=30
Return a list of all recordings in an engagement.
Note: Use recording-related APIs to manipulate data whose recording creation time is after 2022-07-18.
Scopes: contact_center_recording:read:admin
Rate Limit Label: Medium
108. contact_center-engagements-{engagementId}-recordings - Delete engagement recordings
DELETE {{baseUrl}}/contact_center/engagements/:engagementId/recordings?delete_all_recordings=true
Delete all recordings in a given engagement.
Note: Use recording-related APIs to manipulate data whose recording creation time is after 2022-07-18.
Scopes: contact_center_recording:write:admin
Rate Limit Label: Light
109. contact_center-engagements-{engagementId}-notes-{noteId} - Get a note
GET {{baseUrl}}/contact_center/engagements/:engagementId/notes/:noteId
110. contact_center-engagements-{engagementId}-notes-{noteId} - Update a note
PATCH {{baseUrl}}/contact_center/engagements/:engagementId/notes/:noteId
111. contact_center-engagements-{engagementId}-notes - List engagement notes
GET {{baseUrl}}/contact_center/engagements/:engagementId/notes?next_page_token=<string>&page_size=30
Return a list of notes under an engagement.
Scopes: contact_center_note:read:admin
Rate Limit Label: Medium
112. contact_center-engagements-{engagementId} - Get an engagement
GET {{baseUrl}}/contact_center/engagements/:engagementId
Get information about an engagement.
Scopes: contact_center_engagement:read:admin
Rate Limit Label: LIGHT
113. contact_center-engagements-notes - List notes
GET {{baseUrl}}/contact_center/engagements/notes?next_page_token=<string>&page_size=30
114. contact_center-engagements - List engagements
GET {{baseUrl}}/contact_center/engagements?next_page_token=<string>&page_size=10&timezone=<string>&from=<date>&to=<date>&queue_id=<string>&user_id=<string>&consumer_number=<string>&channel_types=in_app_video&channel_types=video
Returns a list of engagements.
Scopes: contact_center_engagement:read:admin
Rate Limit Label: MEDIUM
115. contact_center-dispositions-{dispositionId} - Get a disposition
GET {{baseUrl}}/contact_center/dispositions/:dispositionId
Retrieve information about a disposition.
Scopes: contact_center_disposition:read:admin
Rate Limit Label: Light
116. contact_center-dispositions-{dispositionId} - Delete a disposition
DELETE {{baseUrl}}/contact_center/dispositions/:dispositionId
Delete an existing disposition.
Scopes: contact_center_disposition:write:admin
Rate Limit Label: Light
117. contact_center-dispositions-{dispositionId} - Update a disposition
PATCH {{baseUrl}}/contact_center/dispositions/:dispositionId
Update an existing disposition.
Scopes: contact_center_disposition:write:admin
Rate Limit Label: Light
118. contact_center-dispositions-sets-{dispositionSetId} - Get a disposition set
GET {{baseUrl}}/contact_center/dispositions/sets/:dispositionSetId
Retrieve information about a disposition set.
Scopes: contact_center_disposition:read:admin
Rate Limit Label: Light
119. contact_center-dispositions-sets-{dispositionSetId} - Delete a disposition set
DELETE {{baseUrl}}/contact_center/dispositions/sets/:dispositionSetId
120. contact_center-dispositions-sets-{dispositionSetId} - Update a disposition set
PATCH {{baseUrl}}/contact_center/dispositions/sets/:dispositionSetId
Update an existing disposition set.
Scopes: contact_center_disposition:write:admin
Rate Limit Label: Light
121. contact_center-dispositions-sets - List disposition sets
GET {{baseUrl}}/contact_center/dispositions/sets?next_page_token=<string>&page_size=30
Return a list of available disposition sets. You can use sets to organize dispositions into groups.
Scopes: contact_center_disposition:read:admin
Rate Limit Label: Medium
122. contact_center-dispositions-sets - Create a disposition set
POST {{baseUrl}}/contact_center/dispositions/sets
Create a new disposition set.
Scopes: contact_center_disposition:write:admin
Rate Limit Label: Light
123. contact_center-dispositions - List dispositions
GET {{baseUrl}}/contact_center/dispositions?next_page_token=<string>&page_size=30
Return a list of available dispositions.
Scopes: contact_center_disposition:read:admin
Rate Limit Label: Medium
124. contact_center-dispositions - Create a disposition
POST {{baseUrl}}/contact_center/dispositions
Create a new disposition. Dispositions let agents assign an outcome or topic to each engagement. After creating dispositions, add them to queues.
Scopes: contact_center_disposition:write:admin
Rate Limit Label: Light
125. contact_center-closures-{closureSetId}-queues - List the closures' queues
GET {{baseUrl}}/contact_center/closures/:closureSetId/queues?next_page_token=<string>&page_size=30
Show a list of queues using closures.
Scopes: contact_center_queue:read:admin
Rate Limit Label: LIGHT
126. contact_center-closures-{closureSetId}-flows - List the closures' flows
GET {{baseUrl}}/contact_center/closures/:closureSetId/flows?next_page_token=<string>&page_size=30
127. contact_center-closures-{closureSetId} - Get a closure set
GET {{baseUrl}}/contact_center/closures/:closureSetId
Get information about a closure set.
Scopes: contact_center_queue:read:admincontact_center_operating_hours:read:admin
Rate Limit Label: LIGHT
128. contact_center-closures-{closureSetId} - Delete a closure set
DELETE {{baseUrl}}/contact_center/closures/:closureSetId
129. contact_center-closures-{closureSetId} - Update a closure set
PATCH {{baseUrl}}/contact_center/closures/:closureSetId
Update information about a closure set.
Scopes: contact_center_operating_hours:write:admin
Rate Limit Label: LIGHT
130. contact_center-closures - List closures
GET {{baseUrl}}/contact_center/closures?next_page_token=<string>&page_size=30&account_default=<boolean>
Get a list of closures. Admins can create closures to select.
Scopes: contact_center_queue:read:admincontact_center_operating_hours:read:admin
Rate Limit Label: MEDIUM
131. contact_center-closures - Create a closure set
POST {{baseUrl}}/contact_center/closures
Create a new closure set.
Scopes: contact_center_queue:write:admincontact_center_operating_hours:write:admin
Rate Limit Label: LIGHT
132. contact_center-business_hours-{businessHourId}-queues - List the business hours' queues
GET {{baseUrl}}/contact_center/business_hours/:businessHourId/queues?next_page_token=<string>&page_size=30
Show a list of queues using business hours.
Scopes: contact_center_queue:read:admin
Rate Limit Label: LIGHT
133. contact_center-business_hours-{businessHourId}-flows - List the business hours' flows
GET {{baseUrl}}/contact_center/business_hours/:businessHourId/flows?next_page_token=<string>&page_size=30
Show a list of flows using business hours.
Scopes: contact_center_flow:read:admin
Rate Limit Label: LIGHT
134. contact_center-business_hours-{businessHourId} - Get business hours
GET {{baseUrl}}/contact_center/business_hours/:businessHourId
Get information about business hours.
Scopes: contact_center_operating_hours:read:admincontact_center_queue:read:admin
Rate Limit Label: Light
135. contact_center-business_hours-{businessHourId} - Delete business hours
DELETE {{baseUrl}}/contact_center/business_hours/:businessHourId
136. contact_center-business_hours-{businessHourId} - Update business hours
PATCH {{baseUrl}}/contact_center/business_hours/:businessHourId
137. contact_center-business_hours - List business hours
GET {{baseUrl}}/contact_center/business_hours?next_page_token=<string>&page_size=30&account_default=<boolean>
Get a list of business hours. Admins can create business hours to select, such as the business hours "Default Hours".
Scopes: contact_center_operating_hours:read:admincontact_center_queue:read:admin
Rate Limit Label: Medium
138. contact_center-business_hours - Create business hours
POST {{baseUrl}}/contact_center/business_hours
Create new business hours.
Scopes: contact_center_operating_hours:write:admincontact_center_queue:write:admin
Rate Limit Label: Light
GET {{baseUrl}}/contact_center/analytics/historical/queues/:queueId/agents/metrics?next_page_token=<string>&page_size=10&timezone=<string>&from=<date>&to=<date>&channel_types=chat&channel_types=video&interval=1_week
Generate a list of a historical queue's agents reports.
Scopes: contact_center_report:read:admin
Rate Limit Label: Heavy
140. contact_center-analytics-historical-queues-metrics - List historical queue reports
GET {{baseUrl}}/contact_center/analytics/historical/queues/metrics?next_page_token=<string>&page_size=10&timezone=<string>&from=<date>&to=<date>&queue_ids=<string>&queue_ids=<string>&channel_types=chat&channel_types=video&interval=1_week
Generate a list of historical queue reports.
Scopes: contact_center_report:read:admin
Rate Limit Label: Heavy
141. contact_center-analytics-historical-details-metrics - List historical detail reports
GET {{baseUrl}}/contact_center/analytics/historical/details/metrics?next_page_token=<string>&page_size=10&timezone=<string>&from=<date>&to=<date>&queue_ids=<string>&queue_ids=<string>&user_id=<string>&consumer_number=<string>&consumer_id=<string>&direction=outbound&results=<string>&results=<string>&channel_types=chat&channel_types=video&queue_wait_type=live_waiting&required_skill_ids=<string>&required_skill_ids=<string>
Generate a list of historical detail reports.
Scopes: contact_center_report:read:admin
Rate Limit Label: Heavy
142. contact_center-analytics-agents-time_sheets - List agent's time sheet reports
GET {{baseUrl}}/contact_center/analytics/agents/time_sheets?next_page_token=<string>&page_size=10&timezone=<string>&from=<date>&to=<date>&queueId=<string>&user_id=<string>&interval=1_week
Generate a list of an agent's time sheet reports.
Scopes: contact_center_report:read:admin
Rate Limit Label: Heavy
143. contact_center-analytics-agents-status_history - List agent's status history reports
GET {{baseUrl}}/contact_center/analytics/agents/status_history?next_page_token=<string>&page_size=10&timezone=<string>&from=<date>&to=<date>&queueId=<string>&user_id=<string>&status_id=<string>&sub_status_id=<string>
Generate a list of an agent's status history reports.
Scopes: contact_center_report:read:admin
Rate Limit Label: Heavy
144. contact_center-address_books-{addressBookId}-contacts-{contactId} - Get an address book contact
GET {{baseUrl}}/contact_center/address_books/:addressBookId/contacts/:contactId
Use this API to get information about an address book's contact.
Scopes: contact_center_contact:read:admin
Rate Limit Label: Light
145. contact_center-address_books-{addressBookId}-contacts-{contactId} - Delete an address book contact
DELETE {{baseUrl}}/contact_center/address_books/:addressBookId/contacts/:contactId
Use this API to delete an address book's contact.
Scopes: contact_center_contact:write:admin
Rate Limit Label: Light
146. contact_center-address_books-{addressBookId}-contacts-{contactId} - Update an address book contact
PATCH {{baseUrl}}/contact_center/address_books/:addressBookId/contacts/:contactId
Use this API to update an address book's contact.
Scopes: contact_center_contact:write:admin
Rate Limit Label: Light
147. contact_center-address_books-{addressBookId}-contacts - List address book contacts
GET {{baseUrl}}/contact_center/address_books/:addressBookId/contacts?next_page_token=<string>&page_size=30
Return all contacts in an address book.
Scopes: contact_center_contact:read:admin
Rate Limit Label: MEDIUM
148. contact_center-address_books-{addressBookId}-contacts - Create an address book contact
POST {{baseUrl}}/contact_center/address_books/:addressBookId/contacts
Use this API to create a new contact in an address book. During an active engagement, the Zoom desktop client will display information from the address book if that customer is a contact in the address book. If the consumer is not in the address book, agents can add a new contact and choose which address book the contact belongs to.
Scopes: contact_center_contact:write:admin
Rate Limit Label: Light
149. contact_center-address_books-{addressBookId} - Get an address book
GET {{baseUrl}}/contact_center/address_books/:addressBookId
Use this API to get information about an address book.
Scopes: contact_center_contact:read:admin
Rate Limit Label: Light
150. contact_center-address_books-{addressBookId} - Delete an address book
DELETE {{baseUrl}}/contact_center/address_books/:addressBookId
Use this API to delete an address book.
Scopes: contact_center_contact:write:admin
Rate Limit Label: Light
151. contact_center-address_books-{addressBookId} - Update an address book
PATCH {{baseUrl}}/contact_center/address_books/:addressBookId
Use this API to update an address book's information.
Scopes: contact_center_contact:write:admin
Rate Limit Label: Light
152. contact_center-address_books-units-{unitId} - Get an address book unit
GET {{baseUrl}}/contact_center/address_books/units/:unitId
Use this API to get information about an address book unit.
Scopes: contact_center_contact:read:admin
Rate Limit Label: Light
153. contact_center-address_books-units-{unitId} - Delete an address book unit
DELETE {{baseUrl}}/contact_center/address_books/units/:unitId
Use this API to delete an address book unit.
Scopes: contact_center_contact:write:admin
Rate Limit Label: Light
154. contact_center-address_books-units-{unitId} - Update an address book unit
PATCH {{baseUrl}}/contact_center/address_books/units/:unitId
Use this API to update an address book unit.
Scopes: contact_center_contact:write:admin
Rate Limit Label: Light
155. contact_center-address_books-units - List address book units
GET {{baseUrl}}/contact_center/address_books/units?next_page_token=<string>&page_size=30
Use this API to return all address book units.
Scopes: contact_center_contact:read:admin
Rate Limit Label: Medium
156. contact_center-address_books-units - Create an address book unit
POST {{baseUrl}}/contact_center/address_books/units
Use this API to create an address book unit. Admins can use address book units to organize several address books.
Scopes: contact_center_contact:write:admin
Rate Limit Label: Light
157. contact_center-address_books - List address books
GET {{baseUrl}}/contact_center/address_books?next_page_token=<string>&page_size=30&unit_id=<string>
Use this API to return all address books.
Scopes: contact_center_contact:read:admin
Rate Limit Label: Medium
158. contact_center-address_books - Create an address book
POST {{baseUrl}}/contact_center/address_books
Use this API to create an address book. An address book is a collection of consumer information like display names, phone numbers, and locations.
Scopes: contact_center_contact:write:admin
Rate Limit Label: Light
ENDPOINTS