openapi: 3.0.0 info: title: 'Webex Admin Address Book Features: Call Queue API' version: 1.0.0 description: The Webex Admin APIs provide comprehensive programmatic access to administrative functions for managing Webex organizations, users, licenses, and settings. These APIs enable automation of user provisioning, license assignment, compliance management, and audit event retrieval. Administrators can integrate with enterprise identity systems, enforce security policies, monitor usage, and streamline onboarding/offboarding processes. The APIs support granular control over organizational resources, making them ideal for large-scale deployments and custom admin tooling. tags: - name: 'Features: Call Queue' paths: /telephony/config/queues: get: responses: '200': description: OK headers: Link: schema: type: string content: application/json: schema: type: object required: - queues properties: queues: type: array items: $ref: '#/components/schemas/ListCallQueueEssentialsObject' description: Array of call queues. example: queues: - id: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvNTg0Y2Y0Y2QtZWVhNy00YzhjLTgzZWUtNjdkODhmYzZlYWE1 name: '5714328359' hasCxEssentials: 'true' locationName: WXCSIVDKCPAPIC4S1 locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx enabled: true extension: '8000' department: id: Y2lzY29zcGFyazovL3VzL1NDSU1fR1JPVVAvZjA2ZWRiOGMtMjMxNC00ZTcxLWIzNzgtZTdiMmQwNjk3OTliOjk2YWJjMmFhLTNkY2MtMTFlNS1hMTUyLWZlMzQ4MTljZGM5YQ name: HR - id: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvNmU1NTVjZDAtNjM0MS00MmI4LWEyMWMtZTc1ZjIxNDQ4Mjc0 name: bram hasCxEssentials: 'true' locationName: Brampton locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzQwMjgw phoneNumber: '+15558675309' enabled: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Read the List of Call Queues with Customer Assist operationId: listCallQueues description: "List all Call Queues for the organization.\n\nCall queues temporarily hold calls in the cloud, when all agents\nassigned to receive calls from the queue are unavailable. Queued calls are routed to \nan available agent, when not on an active call. Each call queue is assigned a lead number, which is a telephone\nnumber that external callers can dial to reach the users assigned to the call queue.\nCall queues are also assigned an internal extension, which can be dialed\ninternally to reach the users assigned to the call queue.\n\nRetrieving this list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." tags: - 'Features: Call Queue' parameters: - name: orgId in: query description: Returns the list of call queues in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: locationId in: query description: Returns the list of call queues in this location. example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx schema: type: string - name: max in: query description: Limit the number of objects returned to this maximum count. example: '5' schema: type: number - name: start in: query description: Start at the zero-based offset in the list of matching objects. example: '0' schema: type: number - name: name in: query description: Returns only the call queues matching the given name. example: Customer Support schema: type: string - name: phoneNumber in: query description: Returns only the call queues matching the given primary phone number or extension. example: '+15558675309' schema: type: string - name: departmentId in: query description: Returns only call queues matching the given department ID. example: Y2lzY29zcGFyazovL3VzL1NDSU1fR1JPVVAvZjA2ZWRiOGMtMjMxNC00ZTcxLWIzNzgtZTdiMmQwNjk3OTliOjk2YWJjMmFhLTNkY2MtMTFlNS1hMTUyLWZlMzQ4MTljZGM5YQ schema: type: string - name: departmentName in: query description: Returns only call queues matching the given department name. example: HR schema: type: string - name: hasCxEssentials in: query description: Returns only the list of call queues with Customer Assist license when `true`, otherwise returns the list of Customer Experience Basic call queues. example: 'true' schema: type: boolean /telephony/config/locations/{locationId}/queues: post: responses: '200': description: OK headers: {} content: application/json: schema: type: object required: - id properties: id: type: string description: ID of the newly created call queue. example: id: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Create a Call Queue with Customer Assist operationId: createCallQueue description: 'Create new Call Queues for the given location. Call queues temporarily hold calls in the cloud, when all agents assigned to receive calls from the queue are unavailable. Queued calls are routed to an available agent, when not on an active call. Each call queue is assigned a lead number, which is a telephone number that external callers can dial to reach the users assigned to the call queue. Call queues are also assigned an internal extension, which can be dialed internally to reach the users assigned to the call queue. Creating a call queue requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - 'Features: Call Queue' parameters: - name: locationId in: path description: The location ID where the call queue needs to be created. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg5LWVhMzMtNDc1Ny1iMTBmLWQ2MWIyNzFhMDVlZg schema: type: string - name: orgId in: query description: The organization ID where the call queue needs to be created. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: hasCxEssentials in: query description: Creates a Customer Assist call queue, when `true`. This requires Customer Assist licensed agents. example: 'true' schema: type: boolean requestBody: content: application/json: example: name: CallQueue-1 phoneNumber: '+12225555309' extension: '5309' firstName: Hakim lastName: Smith callPolicies: policy: CIRCULAR routingType: SKILL_BASED waitingEnabled: false noAnswer: nextAgentEnabled: false nextAgentRings: 5 forwardEnabled: false numberOfRings: 0 destinationVoicemailEnabled: false businessContinuity: enabled: false destinationVoicemailEnabled: false queueSettings: queueSize: 10 callOfferToneEnabled: true resetCallStatisticsEnabled: true overflow: action: PERFORM_BUSY_TREATMENT overflowAfterWaitEnabled: false overflowAfterWaitTime: 30 playOverflowGreetingEnabled: false greeting: DEFAULT audioAnnouncementFiles: - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI fileName: announcement.wav mediaFileType: WAV level: LOCATION welcomeMessage: enabled: true alwaysEnabled: false greeting: DEFAULT audioAnnouncementFiles: - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI fileName: announcement.wav mediaFileType: WAV level: LOCATION waitMessage: enabled: true waitMode: POSITION handlingTime: 100 defaultHandlingTime: 100 queuePosition: 100 highVolumeMessageEnabled: false estimatedWaitingTime: 600 playUpdatedEstimatedWaitMessage: true comfortMessage: enabled: true timeBetweenMessages: 10 greeting: DEFAULT audioAnnouncementFiles: - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI fileName: announcement.wav mediaFileType: WAV level: LOCATION mohMessage: normalSource: enabled: true greeting: DEFAULT audioAnnouncementFiles: - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI fileName: announcement.wav mediaFileType: WAV level: LOCATION alternateSource: enabled: true greeting: DEFAULT audioAnnouncementFiles: - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI fileName: announcement.wav mediaFileType: WAV level: LOCATION comfortMessageBypass: enabled: true callWaitingAgeThreshold: 30 greeting: CUSTOM audioAnnouncementFiles: - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI fileName: announcement.wav mediaFileType: WAV level: LOCATION whisperMessage: enabled: true greeting: DEFAULT audioAnnouncementFiles: - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI fileName: announcement.wav mediaFileType: WAV level: LOCATION agents: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MGU3MjYzMC1mZjlmLTExZWItODU5YS0xZjhiYjRjNzc1MWQ skillLevel: 7 - id: Y2lzY29zcGFyazovL3VzL1BMQUNFLzgzYjQ0OTIyLWZlOWYtMTFlYi1hNGI4LTMzNjI3YmVkNjdiNQ skillLevel: 1 enabled: true phoneNumberForOutgoingCallsEnabled: true callingLineIdPolicy: DIRECT_LINE callingLineIdPhoneNumber: '+12072342368' allowAgentJoinEnabled: true directLineCallerIdName: selection: CUSTOM_NAME customName: Hakim Smith dialByName: Hakim Smith schema: $ref: '#/components/schemas/CreateCallQueueEssentialsObject' /telephony/config/locations/{locationId}/queues/{queueId}: delete: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Delete a Call Queue operationId: deleteCallQueue description: 'Delete the designated Call Queue. Call queues temporarily hold calls in the cloud when all agents, which can be users or agents, assigned to receive calls from the queue are unavailable. Queued calls are routed to an available agent when not on an active call. Each call queue is assigned a Lead Number, which is a telephone number outside callers can dial to reach users assigned to the call queue. Call queues are also assigned an internal extension, which can be dialed internally to reach users assigned to the call queue. Deleting a call queue requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - 'Features: Call Queue' parameters: - name: locationId in: path description: Location from which to delete a call queue. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx schema: type: string - name: queueId in: path description: Delete the call queue with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0 schema: type: string - name: orgId in: query description: Delete the call queue from this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetCallQueueEssentialsObject' example: id: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvNTU1MzY4Y2QtZDg5Mi00YzFlLTk0YjYtNzdjNjRiYWQ3NWMx name: CallQueue-1 hasCxEssentials: true enabled: true language: English languageCode: en-US firstName: Hakim lastName: Smith timeZone: Central/Chicago alternateNumberSettings: distinctiveRingEnabled: true alternateNumbers: - phoneNumber: '9725554726' ringPattern: NORMAL - phoneNumber: '9725554729' ringPattern: NORMAL callPolicies: policy: REGULAR callBounce: callBounceEnabled: true callBounceMaxRings: 8 agentUnavailableEnabled: false alertAgentEnabled: false alertAgentMaxSeconds: 30 callBounceOnHoldEnabled: false callBounceOnHoldMaxSeconds: 60 distinctiveRing: enabled: false ringPattern: NORMAL queueSettings: queueSize: 10 callOfferToneEnabled: false resetCallStatisticsEnabled: false overflow: action: PERFORM_BUSY_TREATMENT sendToVoicemail: false overflowAfterWaitEnabled: false overflowAfterWaitTime: 30 playOverflowGreetingEnabled: false greeting: DEFAULT isTransferNumberSet: false waitMessage: enabled: false waitMode: TIME handlingTime: 100 queuePosition: 100 highVolumeMessageEnabled: true defaultHandlingTime: 5 welcomeMessage: enabled: true alwaysEnabled: false greeting: DEFAULT comfortMessage: enabled: true timeBetweenMessages: 10 greeting: DEFAULT mohMessage: normalSource: enabled: false greeting: DEFAULT alternateSource: enabled: false greeting: DEFAULT allowCallWaitingForAgentsEnabled: false agents: [] department: id: Y2lzY29zcGFyazovL3VzL1NDSU1fR1JPVVAvZjA2ZWRiOGMtMjMxNC00ZTcxLWIzNzgtZTdiMmQwNjk3OTliOjk2YWJjMmFhLTNkY2MtMTFlNS1hMTUyLWZlMzQ4MTljZGM5YQ name: HR directLineCallerIdName: selection: CUSTOM_NAME customName: Hakim Smith dialByName: Hakim Smith '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Details for a Call Queue with Customer Assist operationId: getCallQueueWithCustomerAssist description: 'Retrieve Call Queue details. Call queues temporarily hold calls in the cloud, when all agents assigned to receive calls from the queue are unavailable. Queued calls are routed to an available agent, when not on an active call. Each call queue is assigned a lead number, which is a telephone number that external callers can dial to reach the users assigned to the call queue. Call queues are also assigned an internal extension, which can be dialed internally to reach the users assigned to the call queue. Retrieving call queue details requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - 'Features: Call Queue' parameters: - name: locationId in: path description: Retrieves the details of a call queue in this location. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx schema: type: string - name: queueId in: path description: Retrieves the details of call queue with this identifier. required: true example: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvNTU1MzY4Y2QtZDg5Mi00YzFlLTk0YjYtNzdjNjRiYWQ3NWMx schema: type: string - name: orgId in: query description: Retrieves the details of a call queue in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: hasCxEssentials in: query description: Must be set to `true`, to view the details of a call queue with Customer Assist license. This can otherwise be ommited or set to `false`. example: 'true' schema: type: boolean put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Update a Call Queue operationId: updateCallQueue description: 'Update the designated Call Queue. Call queues temporarily hold calls in the cloud when all agents, which can be users or agents, assigned to receive calls from the queue are unavailable. Queued calls are routed to an available agent when not on an active call. Each call queue is assigned a Lead Number, which is a telephone number outside callers can dial to reach users assigned to the call queue. Call queues are also assigned an internal extension, which can be dialed internally to reach users assigned to the call queue. Updating a call queue requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - 'Features: Call Queue' parameters: - name: locationId in: path description: Location in which this call queue exists. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg5LWVhMzMtNDc1Ny1iMTBmLWQ2MWIyNzFhMDVlZg schema: type: string - name: queueId in: path description: Update setting for the call queue with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0 schema: type: string - name: orgId in: query description: Update call queue settings from this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ModifyCallQueueObject' /telephony/config/locations/{locationId}/queues/{queueId}/announcements: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object required: - announcements properties: announcements: type: array items: $ref: '#/components/schemas/GetAnnouncementFileInfo' description: Array of announcements for this call queue. example: announcements: - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9kODc5YWZlZC1jNTRhLTQyOTctOGY0Mi02ZmEyMDJjN2E1M2E fileName: Greeting-1.wav fileSize: '33456' mediaFileType: WAV level: ORGANIZATION isTextToSpeech: false - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8zMjAxNjRmNC1lNWEzLTQxZmYtYTMyNi02N2MwOThlNDFrMWY fileName: Greeting-2.wav fileSize: '32356' mediaFileType: WAV level: LOCATION isTextToSpeech: false - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8zMjAxNjRmNC1lNWEzLTQxZmYtYTMyNi02N2MwOThlNDFoNmc fileName: Greeting-3.wav fileSize: '31237' mediaFileType: WAV level: ORGANIZATION isTextToSpeech: false '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Read the List of Call Queue Announcement Files operationId: listCallQueueAnnouncementFiles description: 'List file info for all Call Queue announcement files associated with this Call Queue. Call Queue announcement files contain messages and music that callers hear while waiting in the queue. A call queue can be configured to play whatever subset of these announcement files is desired. Retrieving this list of files requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`. Note that uploading of announcement files via API is not currently supported, but is available via Webex Control Hub.' tags: - 'Features: Call Queue' parameters: - name: locationId in: path description: Location in which this call queue exists. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx schema: type: string - name: queueId in: path description: Retrieve anouncement files for the call queue with this identifier. required: true example: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0 schema: type: string - name: orgId in: query description: Retrieve announcement files for a call queue from this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/locations/{locationId}/queues/{queueId}/announcements/{fileName}: delete: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Delete a Call Queue Announcement File operationId: deleteCallQueueAnnouncementFile description: 'Delete an announcement file for the designated Call Queue. Call Queue announcement files contain messages and music that callers hear while waiting in the queue. A call queue can be configured to play whatever subset of these announcement files is desired. Deleting an announcement file for a call queue requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - 'Features: Call Queue' parameters: - name: locationId in: path description: Delete an announcement for a call queue in this location. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx schema: type: string - name: queueId in: path description: Delete an announcement for the call queue with this identifier. required: true example: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0 schema: type: string - name: fileName in: path description: '' required: true example: Greeting-2.wav schema: type: string - name: orgId in: query description: Delete call queue announcement from this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/locations/{locationId}/queues/{queueId}/callForwarding: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/CallForwardSettingsGet' '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Call Forwarding Settings for a Call Queue operationId: getCallQueueCallForwardingSettings description: 'Retrieve Call Forwarding settings for the specified Call Queue, including the list of call forwarding rules. The call forwarding feature allows you to direct all incoming calls based on specific criteria that you define. Below are the available options for configuring your call forwarding: 1. Always forward calls to a designated number. 2. Forward calls to a designated number based on certain criteria. 3. Forward calls using different modes. Retrieving call forwarding settings for a call queue requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - 'Features: Call Queue' parameters: - name: locationId in: path description: Location in which this call queue exists. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx schema: type: string - name: queueId in: path description: Retrieve the call forwarding settings for this call queue. required: true example: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvNDI0OTlmZjUtYWI1ZC00NzU4LTliMWItZjg3MTVhM2UwNmVh schema: type: string - name: orgId in: query description: Retrieve call queue forwarding settings from this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Update Call Forwarding Settings for a Call Queue operationId: updateCallQueueCallForwardingSettings description: 'Update Call Forwarding settings for the designated Call Queue. The call forwarding feature allows you to direct all incoming calls based on specific criteria that you define. Below are the available options for configuring your call forwarding: 1. Always forward calls to a designated number. 2. Forward calls to a designated number based on certain criteria. 3. Forward calls using different modes. Updating call forwarding settings for a call queue requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - 'Features: Call Queue' parameters: - name: locationId in: path description: Location in which this call queue exists. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx schema: type: string - name: queueId in: path description: Update call forwarding settings for this call queue. required: true example: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvNDI0OTlmZjUtYWI1ZC00NzU4LTliMWItZjg3MTVhM2UwNmVh schema: type: string - name: orgId in: query description: Update call queue forwarding settings from this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: callForwarding: always: enabled: false destination: '' selective: enabled: true destination: '35556' destinationVoicemailEnabled: true rules: - id: Y2lzY29zcGFyazovL3VzL0NBTExfRk9SV0FSRElOR19TRUxFQ1RJVkVfUlVMRS9RbTlpVW1WdVlXMWw enabled: true - id: Y2lzY29zcGFyazovL3VzL0NBTExfRk9SV0FSRElOR19TRUxFQ1RJVkVfUlVMRS9WMmhsYmxSdg enabled: false operatingModes: enabled: true modes: - normalOperationEnabled: true id: Y2lzY29zcGFyazovL3VzL09QRVJBVElOR19NT0RFL2JiOTc1OTcxLTBjZWYtNDdhNi05Yzc5LTliZWFjY2IwYjg4Mg forwardTo: selection: FORWARD_TO_SPECIFIED_NUMBER destination: '00000' destinationVoicemailEnabled: false schema: $ref: '#/components/schemas/ModifyCallForwardingObject' /telephony/config/locations/{locationId}/queues/{queueId}/callForwarding/selectiveRules: post: responses: '201': description: Created headers: {} content: application/json: schema: type: object required: - id properties: id: type: string description: ID of the newly created call queue. example: id: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Create a Selective Call Forwarding Rule for a Call Queue operationId: createCallQueueSelectiveCallForwardingRule description: 'Create a Selective Call Forwarding Rule for the designated Call Queue. A selective call forwarding rule for a call queue allows calls to be forwarded or not forwarded to the designated number, based on the defined criteria. Note that the list of existing call forward rules is available in the call queue''s call forwarding settings. Creating a selective call forwarding rule for a call queue requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`. **NOTE**: The Call Forwarding Rule ID will change upon modification of the Call Forwarding Rule name.' tags: - 'Features: Call Queue' parameters: - name: locationId in: path description: Location in which the call queue exists. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx schema: type: string - name: queueId in: path description: Create the rule for this call queue. required: true example: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0 schema: type: string - name: orgId in: query description: Create the call queue rule for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: name: New Selective Rule holidaySchedule: HolidayScheduleOne businessSchedule: BusinessScheduleTwo callsFrom: selection: CUSTOM customNumbers: privateNumberEnabled: true unavailableNumberEnabled: true numbers: - '2025551212' callsTo: numbers: [] forwardTo: selection: FORWARD_TO_DEFAULT_NUMBER enabled: true schema: $ref: '#/components/schemas/CreateForwardingRuleObject' /telephony/config/locations/{locationId}/queues/{queueId}/callForwarding/selectiveRules/{ruleId}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetForwardingRuleObject' example: name: My Rule id: Y2lzY29zcGFyazovL3VzL0NBTExfRk9SV0FSRElOR19TRUxFQ1RJVkVfUlVMRS9WMmhsYmxSdg enabled: true businessSchedule: BusiSched1 holidaySchedule: HolSched1 forwardTo: selection: FORWARD_TO_DEFAULT_NUMBER callsFrom: selection: CUSTOM customNumbers: privateNumberEnabled: true unavailableNumberEnabled: true numbers: - '2025551212' callsTo: numbers: [] '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Selective Call Forwarding Rule for a Call Queue operationId: getCallQueueSelectiveCallForwardingRule description: 'Retrieve a Selective Call Forwarding Rule''s settings for the designated Call Queue. A selective call forwarding rule for a call queue allows calls to be forwarded or not forwarded to the designated number, based on the defined criteria. Note that the list of existing call forward rules is available in the call queue''s call forwarding settings. Retrieving a selective call forwarding rule''s settings for a call queue requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`. **NOTE**: The Call Forwarding Rule ID will change upon modification of the Call Forwarding Rule name.' tags: - 'Features: Call Queue' parameters: - name: locationId in: path description: Location in which to call queue exists. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx schema: type: string - name: queueId in: path description: Retrieve setting for a rule for this call queue. required: true example: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0 schema: type: string - name: ruleId in: path description: Call queue rule you are retrieving settings for. required: true example: Y2lzY29zcGFyazovL3VzL0NBTExfRk9SV0FSRElOR19TRUxFQ1RJVkVfUlVMRS9RbTlp schema: type: string - name: orgId in: query description: Retrieve call queue rule settings for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '201': description: Created headers: {} content: application/json: schema: type: object required: - id properties: id: type: string description: New ID for the modified rule. example: id: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Update a Selective Call Forwarding Rule for a Call Queue operationId: updateCallQueueSelectiveCallForwardingRule description: 'Update a Selective Call Forwarding Rule''s settings for the designated Call Queue. A selective call forwarding rule for a call queue allows calls to be forwarded or not forwarded to the designated number, based on the defined criteria. Note that the list of existing call forward rules is available in the call queue''s call forwarding settings. Updating a selective call forwarding rule''s settings for a call queue requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`. **NOTE**: The Call Forwarding Rule ID will change upon modification of the Call Forwarding Rule name.' tags: - 'Features: Call Queue' parameters: - name: locationId in: path description: Location in which this call queue exists. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx schema: type: string - name: queueId in: path description: Update settings for a rule for this call queue. required: true example: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0 schema: type: string - name: ruleId in: path description: Call queue rule you are updating settings for. required: true example: Y2lzY29zcGFyazovL3VzL0NBTExfRk9SV0FSRElOR19TRUxFQ1RJVkVfUlVMRS9RbTlp schema: type: string - name: orgId in: query description: Update call queue rule settings for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: name: My Rule enabled: true businessSchedule: BusiSched1 holidaySchedule: HolSched1 forwardTo: selection: FORWARD_TO_DEFAULT_NUMBER callsFrom: selection: CUSTOM customNumbers: privateNumberEnabled: true unavailableNumberEnabled: true numbers: - '2025551212' callsTo: numbers: [] schema: $ref: '#/components/schemas/ModifyForwardingRuleObject' delete: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Delete a Selective Call Forwarding Rule for a Call Queue operationId: deleteCallQueueSelectiveCallForwardingRule description: 'Delete a Selective Call Forwarding Rule for the designated Call Queue. A selective call forwarding rule for a call queue allows calls to be forwarded or not forwarded to the designated number, based on the defined criteria. Note that the list of existing call forward rules is available in the call queue''s call forwarding settings. Deleting a selective call forwarding rule for a call queue requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`. **NOTE**: The Call Forwarding Rule ID will change upon modification of the Call Forwarding Rule name.' tags: - 'Features: Call Queue' parameters: - name: locationId in: path description: Location in which this call queue exists. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx schema: type: string - name: queueId in: path description: Delete the rule for this call queue. required: true example: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0 schema: type: string - name: ruleId in: path description: Call queue rule you are deleting. required: true example: Y2lzY29zcGFyazovL3VzL0NBTExfRk9SV0FSRElOR19TRUxFQ1RJVkVfUlVMRS9RbTlp schema: type: string - name: orgId in: query description: Delete call queue rule from this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/locations/{locationId}/queues/{queueId}/holidayService: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetCallQueueHolidayObject' example: holidayServiceEnabled: true action: BUSY holidayScheduleLevel: LOCATION holidayScheduleName: 2022 Holidays Period transferPhoneNumber: '1234' playAnnouncementBeforeEnabled: true audioMessageSelection: DEFAULT audioFiles: - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI fileName: AUDIO_FILE.wav mediaFileType: WAV level: ORGANIZATION isTextToSpeech: false - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8zMjAxNjRmNC1lNWEzLTQxZmYtYTMyNi02N2MwOThlNDFoNmc fileName: AUDIO_FILE_1.wav mediaFileType: WAV level: LOCATION isTextToSpeech: false - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8zMjAxNjRmNC1lNWEzLTQxZmYtYTMyNi02N2MwOThlNDFrMWY fileName: AUDIO_FILE_3.wav mediaFileType: WAV level: ORGANIZATION isTextToSpeech: false holidaySchedules: - scheduleName: 2022 All Holidays scheduleLevel: LOCATION - scheduleName: 2022 Holiday Schedule scheduleLevel: LOCATION - scheduleName: 2022 Holidays Period scheduleLevel: LOCATION '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Details for a Call Queue Holiday Service operationId: getCallQueueHolidayService description: 'Retrieve Call Queue Holiday Service details. Configure the call queue to route calls differently during the holidays. Retrieving call queue holiday service details requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - 'Features: Call Queue' parameters: - name: locationId in: path description: Retrieve settings for a call queue in this location. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx schema: type: string - name: queueId in: path description: Retrieve settings for the call queue with this identifier. required: true example: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0 schema: type: string - name: orgId in: query description: Retrieve call queue settings from this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Update a Call Queue Holiday Service operationId: updateCallQueueHolidayService description: 'Update the designated Call Queue Holiday Service. Configure the call queue to route calls differently during the holidays. Updating a call queue holiday service requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - 'Features: Call Queue' parameters: - name: locationId in: path description: Location in which this call queue exists. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx schema: type: string - name: queueId in: path description: Update setting for the call queue with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0 schema: type: string - name: orgId in: query description: Update call queue settings from this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: holidayServiceEnabled: true action: BUSY holidayScheduleLevel: LOCATION holidayScheduleName: 2022 Holidays Period transferPhoneNumber: '1234' playAnnouncementBeforeEnabled: true audioMessageSelection: DEFAULT audioFiles: - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI fileName: AUDIO_FILE.wav mediaFileType: WAV level: ORGANIZATION - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8zMjAxNjRmNC1lNWEzLTQxZmYtYTMyNi02N2MwOThlNDFoNmc fileName: AUDIO_FILE_1.wav mediaFileType: WAV level: LOCATION - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8zMjAxNjRmNC1lNWEzLTQxZmYtYTMyNi02N2MwOThlNDFrMWY fileName: AUDIO_FILE_3.wav mediaFileType: WAV level: ORGANIZATION schema: $ref: '#/components/schemas/ModifyCallQueueHolidayObject' /telephony/config/locations/{locationId}/queues/{queueId}/nightService: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetCallQueueNightServiceObject' example: nightServiceEnabled: true action: TRANSFER transferPhoneNumber: '1234' playAnnouncementBeforeEnabled: true announcementMode: NORMAL audioMessageSelection: DEFAULT audioFiles: - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI fileName: AUDIO_FILE.wav mediaFileType: WAV level: ORGANIZATION isTextToSpeech: false - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8zMjAxNjRmNC1lNWEzLTQxZmYtYTMyNi02N2MwOThlNDFoNmc fileName: AUDIO_FILE_1.wav mediaFileType: WAV level: LOCATION isTextToSpeech: false - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8zMjAxNjRmNC1lNWEzLTQxZmYtYTMyNi02N2MwOThlNDFrMWY fileName: AUDIO_FILE_3.wav mediaFileType: WAV level: ORGANIZATION isTextToSpeech: false businessHourSchedules: - scheduleName: Working Hour scheduleLevel: LOCATION businessHoursLevel: LOCATION businessHoursName: Working Hour forceNightServiceEnabled: true manualAudioMessageSelection: DEFAULT manualAudioFiles: - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI fileName: AUDIO_FILE.wav mediaFileType: WAV level: ORGANIZATION isTextToSpeech: false - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8zMjAxNjRmNC1lNWEzLTQxZmYtYTMyNi02N2MwOThlNDFoNmc fileName: AUDIO_FILE_1.wav mediaFileType: WAV level: LOCATION isTextToSpeech: false - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8zMjAxNjRmNC1lNWEzLTQxZmYtYTMyNi02N2MwOThlNDFrMWY fileName: AUDIO_FILE_3.wav mediaFileType: WAV level: ORGANIZATION isTextToSpeech: false '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Details for a Call Queue Night Service operationId: getCallQueueNightService description: 'Retrieve Call Queue Night service details. Configure the call queue to route calls differently during the hours when the queue is not in service. This is determined by a schedule that defines the business hours of the queue. Retrieving call queue details requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - 'Features: Call Queue' parameters: - name: locationId in: path description: Retrieve settings for a call queue in this location. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx schema: type: string - name: queueId in: path description: Retrieve settings for the call queue night service with this identifier. required: true example: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0 schema: type: string - name: orgId in: query description: Retrieve call queue night service settings from this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Update a Call Queue Night Service operationId: updateCallQueueNightService description: 'Update Call Queue Night Service details. Configure the call queue to route calls differently during the hours when the queue is not in service. This is determined by a schedule that defines the business hours of the queue. Updating call queue night service details requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - 'Features: Call Queue' parameters: - name: locationId in: path description: Update settings for a call queue in this location. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx schema: type: string - name: queueId in: path description: Update settings for the call queue night service with this identifier. required: true example: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0 schema: type: string - name: orgId in: query description: Update call queue night service settings from this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: nightServiceEnabled: true action: TRANSFER transferPhoneNumber: '1234' playAnnouncementBeforeEnabled: true announcementMode: NORMAL audioMessageSelection: DEFAULT audioFiles: - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI fileName: AUDIO_FILE.wav mediaFileType: WAV level: ORGANIZATION - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8zMjAxNjRmNC1lNWEzLTQxZmYtYTMyNi02N2MwOThlNDFoNmc fileName: AUDIO_FILE_1.wav mediaFileType: WAV level: LOCATION - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8zMjAxNjRmNC1lNWEzLTQxZmYtYTMyNi02N2MwOThlNDFrMWY fileName: AUDIO_FILE_3.wav mediaFileType: WAV level: ORGANIZATION businessHourSchedules: - scheduleName: Working Hour scheduleLevel: LOCATION businessHoursLevel: LOCATION businessHoursName: Working Hour forceNightServiceEnabled: true manualAudioMessageSelection: DEFAULT manualAudioFiles: - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI fileName: AUDIO_FILE.wav mediaFileType: WAV level: ORGANIZATION - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8zMjAxNjRmNC1lNWEzLTQxZmYtYTMyNi02N2MwOThlNDFoNmc fileName: AUDIO_FILE_1.wav mediaFileType: WAV level: LOCATION - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8zMjAxNjRmNC1lNWEzLTQxZmYtYTMyNi02N2MwOThlNDFrMWY fileName: AUDIO_FILE_3.wav mediaFileType: WAV level: ORGANIZATION schema: $ref: '#/components/schemas/PatchCallQueueNightServiceObject' /telephony/config/locations/{locationId}/queues/{queueId}/forcedForward: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetCallQueueForcedForwardObject' example: forcedForwardEnabled: true transferPhoneNumber: '+911235557890' playAnnouncementBeforeEnabled: true audioMessageSelection: DEFAULT audioFiles: - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI fileName: AUDIO_FILE.wav mediaFileType: WAV level: ORGANIZATION isTextToSpeech: false - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8zMjAxNjRmNC1lNWEzLTQxZmYtYTMyNi02N2MwOThlNDFoNmc fileName: AUDIO_FILE_1.wav mediaFileType: WAV level: LOCATION isTextToSpeech: false - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8zMjAxNjRmNC1lNWEzLTQxZmYtYTMyNi02N2MwOThlNDFrMWY fileName: AUDIO_FILE_3.wav mediaFileType: WAV level: ORGANIZATION isTextToSpeech: false '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Details for a Call Queue Forced Forward operationId: getCallQueueForcedForward description: 'Retrieve Call Queue policy Forced Forward details. This policy allows calls to be temporarily diverted to a configured destination. Retrieving call queue Forced Forward details requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - 'Features: Call Queue' parameters: - name: locationId in: path description: Retrieve settings for a call queue in this location. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx schema: type: string - name: queueId in: path description: Retrieve settings for the call queue with this identifier. required: true example: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0 schema: type: string - name: orgId in: query description: Retrieve call queue settings from this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Update a Call Queue Forced Forward Service operationId: updateCallQueueForcedForward description: 'Update the designated Forced Forward Service. If the option is enabled, then incoming calls to the queue are forwarded to the configured destination. Calls that are already in the queue remain queued. The policy can be configured to play an announcement prior to proceeding with the forward. Updating a call queue Forced Forward service requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - 'Features: Call Queue' parameters: - name: locationId in: path description: Location in which this call queue exists. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx schema: type: string - name: queueId in: path description: Update setting for the call queue with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0 schema: type: string - name: orgId in: query description: Update call queue settings from this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: forcedForwardEnabled: true transferPhoneNumber: '+911235557890' playAnnouncementBeforeEnabled: true audioMessageSelection: DEFAULT audioFiles: - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI fileName: AUDIO_FILE.wav mediaFileType: WAV level: ORGANIZATION - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8zMjAxNjRmNC1lNWEzLTQxZmYtYTMyNi02N2MwOThlNDFoNmc fileName: AUDIO_FILE_1.wav mediaFileType: WAV level: LOCATION - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8zMjAxNjRmNC1lNWEzLTQxZmYtYTMyNi02N2MwOThlNDFrMWY fileName: AUDIO_FILE_3.wav mediaFileType: WAV level: ORGANIZATION schema: $ref: '#/components/schemas/ModifyCallQueueForcedForwardObject' /telephony/config/locations/{locationId}/queues/{queueId}/strandedCalls: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetCallQueueStrandedCallsObject' example: action: NONE transferPhoneNumber: '+911235557890' audioMessageSelection: DEFAULT audioFiles: - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI fileName: AUDIO_FILE.wav mediaFileType: WAV level: ORGANIZATION isTextToSpeech: false - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8zMjAxNjRmNC1lNWEzLTQxZmYtYTMyNi02N2MwOThlNDFoNmc fileName: AUDIO_FILE_1.wav mediaFileType: WAV level: LOCATION isTextToSpeech: false - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8zMjAxNjRmNC1lNWEzLTQxZmYtYTMyNi02N2MwOThlNDFrMWY fileName: AUDIO_FILE_3.wav mediaFileType: WAV level: ORGANIZATION isTextToSpeech: false '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Details for a Call Queue Stranded Calls operationId: getCallQueueStrandedCalls description: 'Allow admin to view default/configured Stranded Calls settings. Stranded-All agents logoff Policy: If the last agent staffing a queue “unjoins” the queue or signs out, then all calls in the queue become stranded. Stranded-Unavailable Policy: This policy allows for the configuration of the processing of calls that are in a staffed queue when all agents are unavailable. Retrieving call queue Stranded Calls details requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - 'Features: Call Queue' parameters: - name: locationId in: path description: Retrieve settings for a call queue in this location. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx schema: type: string - name: queueId in: path description: Retrieve settings for the call queue with this identifier. required: true example: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0 schema: type: string - name: orgId in: query description: Retrieve call queue settings from this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Update a Call Queue Stranded Calls Service operationId: updateCallQueueStrandedCalls description: 'Update the designated Call Stranded Calls Service. Allow admin to modify configured Stranded Calls settings. Updating a call queue stranded calls requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - 'Features: Call Queue' parameters: - name: locationId in: path description: Location in which this call queue exists. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx schema: type: string - name: queueId in: path description: Update setting for the call queue with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0 schema: type: string - name: orgId in: query description: Update call queue settings from this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: action: NONE transferPhoneNumber: '+911235557890' audioMessageSelection: DEFAULT audioFiles: - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI fileName: AUDIO_FILE.wav mediaFileType: WAV level: ORGANIZATION - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8zMjAxNjRmNC1lNWEzLTQxZmYtYTMyNi02N2MwOThlNDFoNmc fileName: AUDIO_FILE_1.wav mediaFileType: WAV level: LOCATION - id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8zMjAxNjRmNC1lNWEzLTQxZmYtYTMyNi02N2MwOThlNDFrMWY fileName: AUDIO_FILE_3.wav mediaFileType: WAV level: ORGANIZATION schema: $ref: '#/components/schemas/ModifyCallQueueStrandedCallsObject' /telephony/config/locations/{locationId}/queues/availableNumbers: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/CallQueuePrimaryAvailableNumberListGetObject' example: phoneNumbers: - phoneNumber: '+12056350001' state: ACTIVE isMainNumber: false telephonyType: PSTN_NUMBER tollFreeNumber: false isServiceNumber: true - phoneNumber: '+12056350002' state: ACTIVE isMainNumber: true telephonyType: PSTN_NUMBER tollFreeNumber: false isServiceNumber: false - phoneNumber: '+12056350003' state: INACTIVE isMainNumber: false telephonyType: PSTN_NUMBER tollFreeNumber: true isServiceNumber: false '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Call Queue Primary Available Phone Numbers operationId: getCallQueuePrimaryAvailablePhoneNumbers description: 'List the service and standard PSTN numbers that are available to be assigned as the call queue''s primary phone number. These numbers are associated with the location specified in the request URL, can be active or inactive, and are unassigned. The available numbers APIs help identify candidate numbers and their owning entities to simplify the assignment or association of these numbers to members or features. Retrieving this list requires a full, read-only or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - 'Features: Call Queue' parameters: - name: locationId in: path description: Return the list of phone numbers for this location within the given organization. The maximum length is 36. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2YwYzRhOTcyLWIxNjQtMTFlZS05MWVhLWZiYjliMTkwMjI2Yg schema: type: string - name: orgId in: query description: List numbers for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: max in: query description: Limit the number of phone numbers returned to this maximum count. The default is 2000. example: '5' schema: type: number - name: start in: query description: Start at the zero-based offset in the list of matching phone numbers. The default is 0. example: '0' schema: type: number - name: phoneNumber in: query description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array. example: +12056852221,+12056852222 schema: type: array items: type: string example: +12056852221,+12056852222 description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array. /telephony/config/locations/{locationId}/queues/alternate/availableNumbers: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/CallQueueAlternateAvailableNumberListGetObject' example: phoneNumbers: - phoneNumber: '+12056350001' state: ACTIVE isMainNumber: false telephonyType: PSTN_NUMBER tollFreeNumber: false isServiceNumber: true - phoneNumber: '+12056350002' state: ACTIVE isMainNumber: true telephonyType: PSTN_NUMBER tollFreeNumber: false isServiceNumber: false - phoneNumber: '+12056350003' state: INACTIVE isMainNumber: false telephonyType: PSTN_NUMBER tollFreeNumber: true isServiceNumber: false '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Call Queue Alternate Available Phone Numbers operationId: getCallQueueAlternateAvailablePhoneNumbers description: 'List the service and standard PSTN numbers that are available to be assigned as the call queue''s alternate phone number. These numbers are associated with the location specified in the request URL, can be active or inactive, and are unassigned. The available numbers APIs help identify candidate numbers and their owning entities to simplify the assignment or association of these numbers to members or features. Retrieving this list requires a full, read-only or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - 'Features: Call Queue' parameters: - name: locationId in: path description: Return the list of phone numbers for this location within the given organization. The maximum length is 36. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2YwYzRhOTcyLWIxNjQtMTFlZS05MWVhLWZiYjliMTkwMjI2Yg schema: type: string - name: orgId in: query description: List numbers for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: max in: query description: Limit the number of phone numbers returned to this maximum count. The default is 2000. example: '5' schema: type: number - name: start in: query description: Start at the zero-based offset in the list of matching phone numbers. The default is 0. example: '0' schema: type: number - name: phoneNumber in: query description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array. example: +12056852221,+12056852222 schema: type: array items: type: string example: +12056852221,+12056852222 description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array. /telephony/config/locations/{locationId}/queues/callForwarding/availableNumbers: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/CallQueueCallForwardAvailableNumberListGetObject' example: phoneNumbers: - phoneNumber: '+12056350001' state: ACTIVE isMainNumber: false telephonyType: PSTN_NUMBER tollFreeNumber: false isServiceNumber: true owner: id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk type: PEOPLE firstName: Test lastName: Person - phoneNumber: '+12056350002' extension: '1235' state: ACTIVE isMainNumber: true telephonyType: PSTN_NUMBER tollFreeNumber: false isServiceNumber: false owner: id: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS9lZjJkMjg3Ny1hYTY0LTRkMjQtYTFjNi02OWExMmNhMWI2YTA= type: PLACE displayName: TestWorkSpace - phoneNumber: '+12056350003' extension: '1236' state: INACTIVE isMainNumber: false telephonyType: PSTN_NUMBER tollFreeNumber: true isServiceNumber: false owner: id: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvYm1kMmVIcHNabTgwWVVBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0 type: CALL_QUEUE displayName: Test call queue '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Call Queue Call Forward Available Phone Numbers operationId: getCallQueueCallForwardAvailablePhoneNumbers description: 'List the service and standard PSTN numbers that are available to be assigned as the call queue''s call forward number. These numbers are associated with the location specified in the request URL, can be active or inactive, and are assigned to an owning entity. The available numbers APIs help identify candidate numbers and their owning entities to simplify the assignment or association of these numbers to members or features. Retrieving this list requires a full, read-only or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - 'Features: Call Queue' parameters: - name: locationId in: path description: Return the list of phone numbers for this location within the given organization. The maximum length is 36. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2YwYzRhOTcyLWIxNjQtMTFlZS05MWVhLWZiYjliMTkwMjI2Yg schema: type: string - name: orgId in: query description: List numbers for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: max in: query description: Limit the number of phone numbers returned to this maximum count. The default is 2000. example: '5' schema: type: number - name: start in: query description: Start at the zero-based offset in the list of matching phone numbers. The default is 0. example: '0' schema: type: number - name: phoneNumber in: query description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array. example: +12056852221,+12056852222 schema: type: array items: type: string example: +12056852221,+12056852222 description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array. - name: ownerName in: query description: Return the list of phone numbers that are owned by the given `ownerName`. Maximum length is 255. example: Test schema: type: string - name: extension in: query description: Returns the list of PSTN phone numbers with the given `extension`. example: '1234' schema: type: string /telephony/config/queues/agents/availableAgents: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/AvailableAgentListGetObject' example: agents: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS80NDVkMzMzMC1mNjE3LTExZWItOWQyZS01NzViODE3ZGE1NmE lastName: Brown firstName: John displayName: John Brown type: PEOPLE email: john.brown@example.com hasCxEssentials: false phoneNumbers: - external: '+19075552859' extension: '8080' '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Call Queue Available Agents operationId: getCallQueueAvailableAgents description: "List all available users, workspaces, or virtual lines that can be assigned as call queue agents.\n\nAvailable agents are users (excluding users with Webex Calling Standard license), workspaces, or virtual lines that can be assigned to a call queue. \nCalls from the call queue are routed to assigned agents based on configuration. \nAn agent can be assigned to one or more call queues and can be managed by supervisors.\n\nRetrieving this list requires a full, read-only or location administrator auth token with a scope of `spark-admin:telephony_config_read`." tags: - 'Features: Call Queue' parameters: - name: locationId in: query description: The location ID of the call queue. Temporary mandatory query parameter, used for performance reasons only and not a filter. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx schema: type: string - name: orgId in: query description: List available agents for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: max in: query description: Limit the number of objects returned to this maximum count. example: '5' schema: type: number - name: start in: query description: Start at the zero-based offset in the list of matching objects. example: '0' schema: type: number - name: name in: query description: Search based on name (user first and last name combination). example: Customer Support schema: type: string - name: phoneNumber in: query description: Search based on number or extension. example: '+15558675309' schema: type: string - name: order in: query description: 'Order the available agents according to the designated fields. Up to three comma-separated sort order fields may be specified. Available sort fields are: `userId`, `fname`, `firstname`, `lname`, `lastname`, `dn`, and `extension`. Sort order can be added together with each field using a hyphen, `-`. Available sort orders are: `asc`, and `desc`.' example: lname-asc,fname-desc,extension schema: type: string /telephony/config/supervisors: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object required: - supervisors properties: supervisors: type: array items: $ref: '#/components/schemas/ListSupervisorObject' description: Array of supervisors. example: supervisors: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS81OGVkZTIwNi0yNTM5LTQ1ZjQtODg4Ny05M2E3ZWIwZWI3ZDI firstName: John lastName: Smith phoneNumber: '+19845550186' extension: '12554' routingPrefix: '34' esn: '3412554' agentCount: 2 hasCxEssentials: true - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mOWUyZjE5Zi1mMDYwLTQ1MjktYTA4OC05YmUzM2RiOTU3MDE firstName: Tom lastName: Addison phoneNumber: '+19845550185' extension: '5160' routingPrefix: '34543' esn: '345435160' agentCount: 1 hasCxEssentials: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get List of Supervisors with Customer Assist operationId: listCallQueueSupervisors description: 'Get list of supervisors for an organization. Agents in a call queue can be associated with a supervisor who can silently monitor, coach, barge in or to take over calls that their assigned agents are currently handling. Requires a full, location, user or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - 'Features: Call Queue' parameters: - name: orgId in: query description: List the supervisors in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: max in: query description: Limit the number of objects returned to this maximum count. example: '5' schema: type: number - name: start in: query description: Start at the zero-based offset in the list of matching objects. example: '0' schema: type: number - name: name in: query description: Only return the supervisors that match the given name. example: John schema: type: string - name: phoneNumber in: query description: Only return the supervisors that match the given phone number, extension, or ESN. example: '+19845550186' schema: type: string - name: order in: query description: Sort results alphabetically by supervisor name, in ascending or descending order. example: firstName|lastName|firstName-desc|lastName-desc schema: type: string - name: hasCxEssentials in: query description: Returns only the list of supervisors with Customer Assist license, when `true`. Otherwise returns the list of supervisors with Customer Experience Basic license. example: 'true' schema: type: boolean post: responses: '201': description: Created headers: {} content: {} '206': description: Partial Content headers: {} content: application/json: schema: type: object required: - supervisorAgentStatus properties: supervisorAgentStatus: type: array items: $ref: '#/components/schemas/ListSupervisorAgentStatusObject' description: Array of supervisor agents status. example: supervisorAgentStatus: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85NTA4OTc4ZC05YmFkLTRmYWEtYTljNC0wOWQ4NWQ4ZmRjZTY status: NOT_AVAILABLE message: '[Error 6612] Agent 9508978d-9bad-4faa-a9c4-09d85d8fdce6 is not available.' '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Create a Supervisor with Customer Assist operationId: createCallQueueSupervisor description: 'Create a new supervisor. The supervisor must be created with at least one agent. Agents in a call queue can be associated with a supervisor who can silently monitor, coach, barge in or to take over calls that their assigned agents are currently handling. This operation requires a full or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - 'Features: Call Queue' parameters: - name: orgId in: query description: The organization ID where the supervisor needs to be created. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: hasCxEssentials in: query description: Creates a Customer Assist queue supervisor, when `true`. Customer Assist queue supervisors must have a Customer Assist license. example: 'true' schema: type: boolean requestBody: content: application/json: example: id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTFlNWQ5NS0zODQyLTRmOGItOGZjNy00NGY5YjA0N2MyZTc agents: - id: Y2lzY29zcGFyazovL3VzL1BMQUNFLzE3NzczMWRiLWE1YzEtNGI2MC05ZTMwLTNhM2MxMGFiM2IxMQ - id: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS9hM2NjOTVhNC0zNzBjLTQyZmQtYWYzOS00MDE0MmE1YjMzMWU schema: $ref: '#/components/schemas/CreateSupervisorObject' delete: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Delete Bulk Supervisors operationId: deleteBulkCallQueueSupervisors description: 'Deletes supervisors in bulk from an organization. Supervisors are users who manage agents and who perform functions including monitoring, coaching, and more. Requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - 'Features: Call Queue' parameters: - name: orgId in: query description: Delete supervisors in bulk for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: supervisorIds: - Y2lzY29zcGFyazovL3VzL1BFT1BMRS80Y2I1M2ZmMy01NWViLTQ2MzYtYTE4ZC05NWVjZmFhM2E4NmY - Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wNzY2ZDNjNC0xZTg1LTQ4YzgtYTFkZi1mMWUzYTAyMDg1MWE deleteAll: false schema: $ref: '#/components/schemas/BulkSupervisorsDelete' /telephony/config/supervisors/{supervisorId}: delete: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Delete a Supervisor operationId: deleteCallQueueSupervisor description: 'Deletes the supervisor from an organization. Supervisors are users who manage agents and who perform functions including monitoring, coaching, and more. Requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - 'Features: Call Queue' parameters: - name: supervisorId in: path description: Delete the specified supervisor. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9lNWI2NjIyMi1jZTE2LTQ0ZTAtOGY1MS05NzU2ZGE0MDhiZWU schema: type: string - name: orgId in: query description: Delete the supervisor in the specified organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string get: responses: '200': description: OK headers: {} content: application/json: schema: type: object required: - agents properties: id: type: string description: unique identifier of the supervisor agents: type: array items: $ref: '#/components/schemas/ListSupervisorAgentObject' description: Array of agents assigned to a specific supervisor. example: id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85M2JlNTgxNi01YTIyLTQ5MzgtOWNmMy0wODIwODhiNDkxOGU agents: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wNzViMGE4Mi1jNzM5LTRlMDktYWQ5NC0zNTc2YTBlMjYwZDA lastName: . firstName: Barn61 extension: '1060' esn: '1060' - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85NTA4OTc4ZC05YmFkLTRmYWEtYTljNC0wOWQ4NWQ4ZmRjZTY lastName: user firstName: test extension: '892827' esn: '892827' - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9iZjE5YWQzMC00NzAyLTQ3NWMtOTg0Ni1lM2M0M2Y1NGFlYzk lastName: . firstName: Test9 routingPrefix: '34543' phoneNumber: '+19729989982' '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Supervisor Detail with Customer Assist operationId: getCallQueueSupervisor description: 'Get details of a specific supervisor, which includes the agents associated agents with the supervisor, in an organization. Agents in a call queue can be associated with a supervisor who can silently monitor, coach, barge in or to take over calls that their assigned agents are currently handling. This operation requires a full, user or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - 'Features: Call Queue' parameters: - name: supervisorId in: path description: List the agents assigned to this supervisor. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9lNWI2NjIyMi1jZTE2LTQ0ZTAtOGY1MS05NzU2ZGE0MDhiZWU schema: type: string - name: orgId in: query description: List the agents assigned to a supervisor in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: max in: query description: Limit the number of objects returned to this maximum count. example: '5' schema: type: number - name: start in: query description: Start at the zero-based offset in the list of matching objects. example: '0' schema: type: number - name: name in: query description: Only return the agents that match the given name. example: John schema: type: string - name: phoneNumber in: query description: Only return agents that match the given phone number, extension, or ESN. example: '+19845550186' schema: type: string - name: order in: query description: Sort results alphabetically by supervisor name, in ascending or descending order. example: firstName\lastName\firstName-desc\lastName-desc schema: type: string - name: hasCxEssentials in: query description: Must be set to `true`, to view the details of a supervisor with Customer Assist license. This can otherwise be ommited or set to `false`. example: 'true' schema: type: boolean put: responses: '204': description: No Content headers: {} content: {} '206': description: Partial Content headers: {} content: application/json: schema: type: object required: - supervisorAgentStatus properties: supervisorAgentStatus: type: array items: $ref: '#/components/schemas/ListSupervisorAgentStatusObject' description: Array of supervisor agents status. example: supervisorAgentStatus: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85NTA4OTc4ZC05YmFkLTRmYWEtYTljNC0wOWQ4NWQ4ZmRjZTY status: DUPLICATE message: '[Error 6612] Agent 9508978d-9bad-4faa-a9c4-09d85d8fdce6 is already assigned to the supervisor.' '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Assign or Unassign Agents to Supervisor with Customer Assist operationId: updateCallQueueSupervisorAgents description: 'Assign or unassign agents to the supervisor for an organization. Agents in a call queue can be associated with a supervisor who can silently monitor, coach, barge in or to take over calls that their assigned agents are currently handling. This operation requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - 'Features: Call Queue' parameters: - name: supervisorId in: path description: Identifier of the supervisor to be updated. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9lNWI2NjIyMi1jZTE2LTQ0ZTAtOGY1MS05NzU2ZGE0MDhiZWU schema: type: string - name: orgId in: query description: Assign or unassign agents to a supervisor in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: hasCxEssentials in: query description: Must be set to `true` to modify a supervisor with Customer Assist license. This can otherwise be ommited or set to `false`. example: 'true' schema: type: boolean requestBody: content: application/json: example: agents: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85NTA4OTc4ZC05YmFkLTRmYWEtYTljNC0wOWQ4NWQ4ZmRjZTY action: ADD - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9iYzIyMTRlNi0zYzdlLTRkZDAtOTc3Yy0zNzRlOWE2ZDk4MWM action: ADD schema: $ref: '#/components/schemas/CreateAgentObject' /telephony/config/supervisors/availableSupervisors: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object required: - supervisors properties: supervisors: type: array items: $ref: '#/components/schemas/AvailableSupervisorsListObject' description: Array of available supervisors. example: supervisors: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS80YzVlODRhMS0wZmEwLTQzNDAtODVkZC1mMzM1ZGQ4MTkxMmI lastName: Adam firstName: Sandler displayName: Adam Sandler extension: '0200' routingPrefix: '34543' esn: '345430200' phoneNumber: '+19845550200' hasCxEssentials: true - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82ZmYyYTkxNi1hYWRhLTQwZTYtOTkzMC0xZmFmYmNiMzQwODU lastName: Steven firstName: Robert displayName: Steven Robert extension: '9906' routingPrefix: '34' esn: '349906' hasCxEssentials: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: List Available Supervisors with Customer Assist operationId: listAvailableCallQueueSupervisors description: 'Get list of available supervisors for an organization. Agents in a call queue can be associated with a supervisor who can silently monitor, coach, barge in or to take over calls that their assigned agents are currently handling. This operation requires a full, user or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - 'Features: Call Queue' parameters: - name: orgId in: query description: List the available supervisors in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: max in: query description: Limit the number of objects returned to this maximum count. example: '5' schema: type: number - name: start in: query description: Start at the zero-based offset in the list of matching objects. example: '0' schema: type: number - name: name in: query description: Only return the supervisors that match the given name. example: Adam schema: type: string - name: phoneNumber in: query description: Only return the supervisors that match the given phone number, extension, or ESN. example: '+19845550186' schema: type: string - name: order in: query description: Sort results alphabetically by supervisor name, in ascending or descending order. example: firstName|lastName|firstName-desc|lastName-desc schema: type: string - name: hasCxEssentials in: query description: Returns only the list of available supervisors with Customer Assist license, when `true`. When ommited or set to 'false', will return the list of available supervisors with Customer Experience Basic license. example: 'true' schema: type: boolean /telephony/config/supervisors/availableAgents: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object required: - agents properties: agents: type: array items: $ref: '#/components/schemas/AvailableAgentListObject' description: Array of agents assigned to a specific supervisor. example: agents: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jZGUzZWU0YS02ZDI5LTQ3OGItOGU5MC00MmE3YWFlNWIzNTE lastName: CP-WS firstName: CP-WS-1 displayName: CP-WS-1 . extension: '1248' esn: '1248' type: PLACE - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9hZWRlNmE0OS00NmNkLTQ4NWQtODQyZC1kY2ZmNTg4ZmQyMTU lastName: CP-WS firstName: CP-WS-6 displayName: CP-WS-6 . extension: '7539' esn: '7539' routingPrefix: '34543' phoneNumber: '+19729989982' type: PEOPLE '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: List Available Agents with Customer Assist operationId: listAvailableCallQueueAgents description: 'Get list of available agents for an organization. Agents in a call queue can be associated with a supervisor who can silently monitor, coach, barge in or to take over calls that their assigned agents are currently handling. This operation requires a full, user or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - 'Features: Call Queue' parameters: - name: orgId in: query description: List of available agents in a supervisor's list for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: max in: query description: Limit the number of objects returned to this maximum count. example: '5' schema: type: number - name: start in: query description: Start at the zero-based offset in the list of matching objects. example: '0' schema: type: number - name: name in: query description: Returns only the agents that match the given name. example: Adam schema: type: string - name: phoneNumber in: query description: Returns only the agents that match the phone number, extension, or ESN. example: '+19845550186' schema: type: string - name: order in: query description: Sort results alphabetically by supervisor name, in ascending or descending order. example: firstName|lastName|firstName-desc|lastName-desc schema: type: string - name: hasCxEssentials in: query description: Returns only the list of available agents with Customer Assist license, when `true`. When ommited or set to `false`, will return the list of available agents with Customer Experience Basic license. example: 'true' schema: type: boolean /telephony/config/queues/agents: get: responses: '200': description: OK headers: Link: schema: type: string content: application/json: schema: type: object required: - agents properties: agents: type: array items: $ref: '#/components/schemas/ListCallQueueAgentObject' description: Array of call queue agents. example: agents: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS81NzJjNWMwZS1jMDY4LTQ0NmItOWM0Ny04MjYwYTIzZTY0NmI firstName: Lobby lastName: . phoneNumber: '+19458880334' routingPrefix: '8002' queueCount: 1 locationCount: 1 joinCount: 1 unjoinCount: 0 location: name: Location1 id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzU5OWM3ZGFkLTEyMGQtNDgyNy05ZmMyLTk4OTUxYTQzNzIzOA type: PEOPLE - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWYxNTg1YS03MWM2LTQyZGEtYmRkNC1iMzYzYzlhYzQwZGI firstName: Quiet Room lastName: . phoneNumber: '+19458880338' routingPrefix: '8003' queueCount: 1 locationCount: 1 joinCount: 1 unjoinCount: 0 location: name: Location1 id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzU5OWM3ZGFkLTEyMGQtNDgyNy05ZmMyLTk4OTUxYTQzNzIzOA type: PEOPLE - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8zYjY4Yjg2YS1hMTZiLTRmNzItOTlmZi01ZDlhZjgyZWNmNTE firstName: test_301_person_phone_extnsion lastName: last_name phoneNumber: '+14084279811' extension: '4498' routingPrefix: '8004' esn: '4498' queueCount: 1 locationCount: 1 joinCount: 1 unjoinCount: 0 location: name: Location2 id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVmMDI3OGZlLWU4OGMtNDMzNy04MGViLWRjY2NiM2VlMDU1MA type: PEOPLE - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85YjBmMWY2OS0wNWE3LTRkZDUtYTg2OS03Mzg5NjdjNTI2YWI firstName: test_essentials lastName: ES extension: '23234' routingPrefix: '8005' esn: '23234' queueCount: 1 locationCount: 1 joinCount: 1 unjoinCount: 0 location: name: Location1 id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzU5OWM3ZGFkLTEyMGQtNDgyNy05ZmMyLTk4OTUxYTQzNzIzOA type: PEOPLE - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS84OTEyYTUwNi02ZDU2LTRiMjUtOTNiMC1lZGM5ZDFiYmQwNTU firstName: vl_t401cbn lastName: ecbn_01cbn phoneNumber: '+14084269811' routingPrefix: '8007' queueCount: 2 locationCount: 2 joinCount: 2 unjoinCount: 0 location: name: Location1 id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzU5OWM3ZGFkLTEyMGQtNDgyNy05ZmMyLTk4OTUxYTQzNzIzOA type: PEOPLE '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Read the List of Call Queue Agents with Customer Assist operationId: listCallQueueAgents description: "List all Call Queues Agents for the organization.\n\nAgents can be users, workplace or virtual lines assigned to a call queue. Calls from the call queue are routed to agents based on configuration. \nAn agent can be assigned to one or more call queues and can be managed by supervisors.\n\nRetrieving this list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.\n\n**Note**: The decoded value of the agent's `id`, and the `type` returned in the response, are always returned as `PEOPLE`, even when the agent is a workspace or virtual line. This will be addressed in a future release." tags: - 'Features: Call Queue' parameters: - name: orgId in: query description: List call queues agents in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: locationId in: query description: Return only the call queue agents in this location. example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx schema: type: string - name: queueId in: query description: Only return call queue agents with the matching queue ID. example: '``' schema: type: string - name: max in: query description: Limit the number of objects returned to this maximum count. example: '5' schema: type: number - name: start in: query description: Start at the zero-based offset in the list of matching objects. example: '0' schema: type: number - name: name in: query description: Returns only the list of call queue agents that match the given name. example: Customer Support schema: type: string - name: phoneNumber in: query description: Returns only the list of call queue agents that match the given phone number or extension. example: '+15558675309' schema: type: string - name: joinEnabled in: query description: Returns only the list of call queue agents that match the given `joinEnabled` value. example: 'true' schema: type: boolean - name: hasCxEssentials in: query description: Returns only the list of call queues with Customer Assist license when `true`, otherwise returns the list of Customer Experience Basic call queues. example: 'true' schema: type: boolean - name: order in: query description: Sort results alphabetically by call queue agent's name, in ascending or descending order. example: firstName|lastName|firstName-desc|lastName-desc schema: type: string /telephony/config/queues/agents/{id}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetCallQueueAgentObject' example: agent: id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xZmNiMjczZS0wYzdmLTQ1ZGUtYmNlOC0yMWE3YzFlYjVjYmY firstName: Arthur lastName: Murray phoneNumber: '+19728881234' extension: '180' routingPrefix: '34543' esn: '34543180' location: name: RCDN id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzZhZjk4ZGViLWVlZGItNGFmYi1hMDAzLTEzNzgyYjdjODAxYw type: PEOPLE queues: - id: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvZjM4NDIxZGYtN2MxOC00NGI1LThlNmQtNDFmZTEyMTFlZDFk name: YU7 phoneNumber: '+12144184002' routingPrefix: '34543' locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzZhZjk4ZGViLWVlZGItNGFmYi1hMDAzLTEzNzgyYjdjODAxYw locationName: RCDN joinEnabled: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Details for a Call Queue Agent with Customer Assist operationId: getCallQueueAgent description: "Retrieve details of a particular Call queue agent based on the agent ID.\n\nAgents can be users, workplace or virtual lines assigned to a call queue. Calls from the call queue are routed to agents based on configuration. \nAn agent can be assigned to one or more call queues and can be managed by supervisors.\n\nRetrieving a call queue agent's details require a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.\n\n**Note**: The agent's `type` returned in the response and in the decoded value of the agent's `id`, is always of type `PEOPLE`, even if the agent is a workspace or virtual line. This` will be corrected in a future release." tags: - 'Features: Call Queue' parameters: - name: id in: path description: Retrieve call queue agents with this identifier. required: true example: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvNTU1MzY4Y2QtZDg5Mi00YzFlLTk0YjYtNzdjNjRiYWQ3NWMx schema: type: string - name: orgId in: query description: Retrieve call queue agents from this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: hasCxEssentials in: query description: Must be set to `true` to view the details of an agent with Customer Assist license. This can otherwise be ommited or set to `false`. example: 'true' schema: type: boolean - name: max in: query description: Limit the number of objects returned to this maximum count. required: true example: '5' schema: type: number - name: start in: query description: Start at the zero-based offset in the list of matching objects. required: true example: '0' schema: type: number /telephony/config/queues/agents/{id}/settings: put: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Update an Agent's Settings of One or More Call Queues with Customer Assist operationId: updateAgentCallQueueSettings description: "Modify an agent's call queue settings for an organization.\n\nCalls from the call queue are routed to agents based on configuration. \nAn agent can be assigned to one or more call queues and can be managed by supervisors.\n\nThis operation requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`." tags: - 'Features: Call Queue' parameters: - name: id in: path description: Identifier of the agent to be updated. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9lNWI2NjIyMi1jZTE2LTQ0ZTAtOGY1MS05NzU2ZGE0MDhiZWU schema: type: string - name: orgId in: query description: Update the settings of an agent in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: hasCxEssentials in: query description: Must be set to `true` to modify an agent that has Customer Assist license. This can otherwise be ommited or set to `false`. example: 'true' schema: type: boolean requestBody: content: application/json: example: settings: - queueId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85NTA4OTc4ZC05YmFkLTRmYWEtYTljNC0wOWQ4NWQ4ZmRjZTY joinEnabled: true - queueId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9iYzIyMTRlNi0zYzdlLTRkZDAtOTc3Yy0zNzRlOWE2ZDk4MWM joinEnabled: false schema: $ref: '#/components/schemas/ModifyAgentsForCallQueueObject' /telephony/config/locations/{locationId}/queues/{queueId}/callForwarding/actions/switchMode/invoke: post: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Switch Mode for Call Forwarding Settings for a Call Queue operationId: switchCallQueueCallForwardingMode description: 'Switches the current operating mode of the `Call Queue` to the mode as per normal operations. Operating modes allow call forwarding to be configured based on predefined schedules, enabling different routing behaviors during business hours, after hours, or holidays. Switching operating mode for a `call queue` requires a full, or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - 'Features: Call Queue' parameters: - name: locationId in: path description: '`Location` in which this `call queue` exists.' required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA schema: type: string - name: queueId in: path description: Switch operating mode to normal operations for this `call queue`. required: true example: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvNDI0OTlmZjUtYWI1ZC00NzU4LTliMWItZjg3MTVhM2UwNmVh schema: type: string - name: orgId in: query description: Switch operating mode as per normal operations for the `call queue` from this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: {} schema: type: object properties: {} components: schemas: CallQueueCallForwardAvailableNumberObject: type: object required: - state - isMainNumber - tollFreeNumber - telephonyType - isServiceNumber properties: phoneNumber: type: string example: '+12056350001' description: A unique identifier for the PSTN phone number. extension: type: string example: '1235' description: Extension for a PSTN phone number. state: $ref: '#/components/schemas/STATE' description: Phone number's state. isMainNumber: type: boolean example: true description: If `true`, the phone number is used as a location CLID. tollFreeNumber: type: boolean example: true description: If `true`, the phone number is a toll-free number. telephonyType: $ref: '#/components/schemas/TelephonyType' description: The telephony type for the number. isServiceNumber: type: boolean example: true description: If `true`, the phone number is a service number; otherwise, it is a standard number. Service numbers are high-utilization or high-concurrency PSTN phone numbers that are neither mobile nor toll-free. owner: type: object required: - id - type properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk description: Unique identifier of the owner to which PSTN Phone number is assigned. type: $ref: '#/components/schemas/NumberOwnerType' description: Type of the PSTN phone number's owner. firstName: type: string example: Test description: First name of the PSTN phone number's owner. This field will be present only when the owner `type` is `PEOPLE` or `VIRTUAL_LINE`. lastName: type: string example: Person description: Last name of the PSTN phone number's owner. This field will be present only when the owner `type` is `PEOPLE` or `VIRTUAL_LINE`. displayName: type: string example: TestWorkSpace description: Display name of the PSTN phone number's owner. This field will be present except when the owner `type` is `PEOPLE` or `VIRTUAL_LINE`. ListCallQueueEssentialsObject: type: object required: - id - name - hasCxEssentials - locationName - locationId - enabled properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvNTU1MzY4Y2QtZDg5Mi00YzFlLTk0YjYtNzdjNjRiYWQ3NWMx description: A unique identifier for the call queue. name: type: string example: '5714328359' description: Unique name for the call queue. hasCxEssentials: type: boolean example: true description: Denotes if the call queue has Customer Assist license. locationName: type: string example: WXCSIVDKCPAPIC4S1 description: Name of location for call queue. locationId: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx description: ID of location for call queue. phoneNumber: type: string example: '+15558675309' description: Primary phone number of the call queue. extension: type: string example: '7781' description: Primary phone extension of the call queue. enabled: type: boolean example: true description: Whether or not the call queue is enabled. department: type: object properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1NDSU1fR1JPVVAvZjA2ZWRiOGMtMjMxNC00ZTcxLWIzNzgtZTdiMmQwNjk3OTliOjk2YWJjMmFhLTNkY2MtMTFlNS1hMTUyLWZlMzQ4MTljZGM5YQ description: Unique identifier of the department. name: type: string example: HR description: Name of the department. description: The department information. ModifyPersonPlaceVirtualLineCallQueueObject: type: object required: - id properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BMQUNFLzgzYjQ0OTIyLWZlOWYtMTFlYi1hNGI4LTMzNjI3YmVkNjdiNQ description: ID of person, workspace or virtual line. weight: type: string example: '50' description: Weight of person, workspace or virtual line. Only applied when call policy is `WEIGHTED`. skillLevel: type: number example: 1 description: Skill level of person, workspace or virtual line. Only applied when call routing type is `SKILL_BASED`. joinEnabled: type: boolean example: true description: Indicates the join status of the agent for this queue. The default value for newly added agents is `true`. AnnouncementAudioFile: type: object properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8zMjAxNjRmNC1lNWEzLTQxZmYtYTMyNi02N2MwOThlNDFkMWQ description: Unique identifier of the Announcement file. name: type: string example: Public_Announcement.wav description: Name of the announcement file. `name`, `mediaFileType`, `level` are mandatory if `id` is not provided for uploading an announcement. mediaFileType: type: string example: WAV description: Media file type of announcement file. level: type: string enum: - LOCATION - ORGANIZATION - ENTITY description: The level at which this announcement exists. PostCallQueueEssentialCallPolicyObject: type: object required: - routingType - policy - callBounce - distinctiveRing properties: routingType: $ref: '#/components/schemas/HuntRoutingTypeSelection' description: Call routing type to use to dispatch calls to agents. The routing type should be `SKILL_BASED` if you want to assign skill level to `agents`. Only certain `policy` are allowed in `SKILL_BASED` type. policy: $ref: '#/components/schemas/HuntPolicyEssentialSelection' description: Call routing policy to use to dispatch calls to `agents`. callBounce: type: object properties: callBounceEnabled: type: boolean example: true description: If enabled, bounce calls after the set number of rings. callBounceMaxRings: type: number example: 5 description: Number of rings after which to bounce call, if `callBounce` is enabled. agentUnavailableEnabled: type: boolean example: true description: Bounce if agent becomes unavailable. alertAgentEnabled: type: boolean example: true description: Alert agent if call on hold more than `alertAgentMaxSeconds`. alertAgentMaxSeconds: type: number example: 20 description: Number of second after which to alert agent if `alertAgentEnabled`. callBounceOnHoldEnabled: type: boolean example: true description: Bounce if call on hold more than `callBounceMaxSeconds`. callBounceOnHoldMaxSeconds: type: number example: 20 description: Number of second after which to bounce if `callBounceEnabled`. description: Settings for when the call into the hunt group is not answered. distinctiveRing: type: object required: - enabled properties: enabled: type: boolean example: true description: Whether or not the `distinctiveRing` is enabled. ringPattern: $ref: '#/components/schemas/RingPatternObject' description: Ring pattern for when this call queue is called. Only available when `distinctiveRing` is enabled for the call queue. description: Whether or not the call queue has the `distinctiveRing` option enabled. CallQueueAlternateAvailableNumberObject: type: object required: - phoneNumber - state - isMainNumber - tollFreeNumber - telephonyType - isServiceNumber properties: phoneNumber: type: string example: '+12056350001' description: A unique identifier for the PSTN phone number. state: $ref: '#/components/schemas/STATE' description: Phone number's state. isMainNumber: type: boolean example: true description: If `true`, the phone number is used as a location CLID. tollFreeNumber: type: boolean example: true description: If `true`, the phone number is a toll-free number. telephonyType: $ref: '#/components/schemas/TelephonyType' description: The telephony type for the number. isServiceNumber: type: boolean example: true description: If `true`, the phone number is a service number; otherwise, it is a standard number. Service numbers are high-utilization or high-concurrency PSTN phone numbers that are neither mobile nor toll-free. NumberOwnerType: type: string enum: - PLACE - PEOPLE - VIRTUAL_LINE - AUTO_ATTENDANT - CALL_QUEUE - GROUP_PAGING - HUNT_GROUP - VOICE_MESSAGING - OFFICE_ANYWHERE - CONTACT_CENTER_LINK - CONTACT_CENTER_ADAPTER - ROUTE_LIST - VOICEMAIL_GROUP - COLLABORATE_BRIDGE description: " * `PLACE` - PSTN phone number's owner is a workspace.\n * `PEOPLE` - PSTN phone number's owner is a person.\n * `VIRTUAL_LINE` - PSTN phone number's owner is a Virtual Profile.\n * `AUTO_ATTENDANT` - PSTN phone number's owner is an auto-attendant.\n * `CALL_QUEUE` - PSTN phone number's owner is a call queue.\n * `GROUP_PAGING` - PSTN phone number's owner is a group paging.\n * `HUNT_GROUP` - PSTN phone number's owner is a hunt group.\n * `VOICE_MESSAGING` - PSTN phone number's owner is a voice messaging.\n * `OFFICE_ANYWHERE` - PSTN phone number's owner is a Single Number Reach.\n * `CONTACT_CENTER_LINK` - PSTN phone number's owner is a Contact Center link.\n * `CONTACT_CENTER_ADAPTER` - PSTN phone number's owner is a Contact Center adapter.\n * `ROUTE_LIST` - PSTN phone number's owner is a route list.\n * `VOICEMAIL_GROUP` - PSTN phone number's owner is a voicemail group.\n * `COLLABORATE_BRIDGE` - PSTN phone number's owner is a collaborate bridge.\n" UserType: type: string enum: - PEOPLE - PLACE - VIRTUAL_LINE description: " * `PEOPLE` - The associated member is a person.\n * `PLACE` - The associated member is a workspace.\n * `VIRTUAL_LINE` - The associated member is a virtual line.\n" DirectLineCallerIdNameObject: type: object properties: selection: $ref: '#/components/schemas/SelectionObject' description: The selection of the direct line caller ID name. Defaults to `DISPLAY_NAME`. customName: type: string example: Hakim Smith description: The custom direct line caller ID name. Required if `selection` is set to `CUSTOM_NAME`. description: Settings for the direct line caller ID name to be shown for this workspace. ModesGet: type: object required: - normalOperationEnabled - id - name - type - level - forwardTo properties: normalOperationEnabled: type: boolean example: true description: Normal operation is enabled or disabled. id: type: string example: Y2lzY29zcGFyazovL3VzL09QRVJBVElOR19NT0RFL2JiOTc1OTcxLTBjZWYtNDdhNi05Yzc5LTliZWFjY2IwYjg4Mg description: The ID of the operating mode. name: type: string example: Day description: The name of the operating mode. type: type: string enum: - NONE - SAME_HOURS_DAILY - DIFFERENT_HOURS_DAILY - HOLIDAY description: "The type of the operating mode.\n * `NONE` - The operating mode is not scheduled.\n * `SAME_HOURS_DAILY` - Single time duration for Monday-Friday and single time duration for Saturday-Sunday.\n * `DIFFERENT_HOURS_DAILY` - Individual time durations for every day of the week.\n * `HOLIDAY` - Holidays which have date durations spanning multiple days, as well as an optional yearly recurrence by day or date.\n" level: type: string enum: - LOCATION - ORGANIZATION description: "The level of the operating mode.\n * `LOCATION` - The operating mode is at the location level.\n * `ORGANIZATION` - The operating mode is at the organization level.\n" forwardTo: type: object required: - selection - destination - destinationVoicemailEnabled - defaultDestination - defaultDestinationVoicemailEnabled - defaultForwardToSelection properties: selection: type: string enum: - FORWARD_TO_DEFAULT_NUMBER - FORWARD_TO_SPECIFIED_NUMBER - DO_NOT_FORWARD description: "The selection for forwarding.\n * `FORWARD_TO_DEFAULT_NUMBER` - When the rule matches, the mode's own default forwarding selection is to be applied.\n * `FORWARD_TO_SPECIFIED_NUMBER` - When the rule matches, forward to the destination.\n * `DO_NOT_FORWARD` - When the rule matches, do not forward to another number.\n" destination: type: string example: '+19705550006' description: The destination for forwarding. Required when the selection is set to `FORWARD_TO_SPECIFIED_NUMBER`. destinationVoicemailEnabled: type: boolean description: Sending incoming calls to voicemail is enabled/disabled when the destination is an internal phone number and that number has the voicemail service enabled. defaultDestination: type: string example: '00000' description: The operating mode's destination. defaultDestinationVoicemailEnabled: type: boolean description: The operating mode's destination voicemail enabled. defaultForwardToSelection: type: string enum: - FORWARD_TO_SPECIFIED_NUMBER - DO_NOT_FORWARD description: "The operating mode's forward to selection.\n * `FORWARD_TO_SPECIFIED_NUMBER` - When the rule matches, forward to the destination.\n * `DO_NOT_FORWARD` - When the rule matches, do not forward to another number.\n" description: Forward to settings. ModifyCallQueueStrandedCallsObject: type: object required: - action - audioMessageSelection properties: action: type: string enum: - NONE - BUSY - TRANSFER - NIGHT_SERVICE - RINGING - ANNOUNCEMENT description: "The call processing action type.\n * `NONE` - Call remains in the queue.\n * `BUSY` - Calls are removed from the queue and are provided with the Busy treatment. If the queue is configured with the Call Forwarding Busy or the Voice Messaging service, then the call is handled accordingly.\n * `TRANSFER` - Calls are removed from the queue and are transferred to the configured `transferPhoneNumber`.\n * `NIGHT_SERVICE` - Calls are handled according to the Night Service configuration. If the Night Service action is set to `none`, then this is equivalent to this policy being set to `none` (that is, calls remain in the queue).\n * `RINGING` - Calls are removed from the queue and are provided with ringing until the caller releases the call. The ringback tone played to the caller is localized according to the country code of the caller.\n * `ANNOUNCEMENT` - Calls are removed from the queue and are provided with an announcement that is played in a loop until the caller releases the call.\n" transferPhoneNumber: type: string example: '1235557890' description: Call gets transferred to this number when action is set to `TRANSFER`. This can also be an extension. audioMessageSelection: type: string enum: - DEFAULT - CUSTOM description: "The type of announcement to be played.\n * `DEFAULT` - Default Audio Message Selection.\n * `CUSTOM` - Custom Audio Message Selection.\n" audioFiles: type: array items: $ref: '#/components/schemas/AudioAnnouncementFileFeatureObject' description: List of pre-configured Announcement Audio Files when `audioMessageSelection` is `CUSTOM`. mediaType: type: string enum: - WMA - WAV - GP - MOV description: " * `WMA` - WMA File Extension.\n * `WAV` - WAV File Extension.\n * `GP` - 3GP File Extension.\n * `MOV` - MOV File Extension.\n" CallQueueCallForwardAvailableNumberListGetObject: type: object required: - phoneNumbers properties: phoneNumbers: type: array items: $ref: '#/components/schemas/CallQueueCallForwardAvailableNumberObject' description: Array of phone numbers. GetPersonPlaceObject: type: object required: - id properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS80NDVkMzMzMC1mNjE3LTExZWItOWQyZS01NzViODE3ZGE1NmE description: ID of person or workspace. firstName: type: string example: Hakim description: First name of person or workspace. lastName: type: string example: Smith description: First name of person or workspace. phoneNumber: type: string example: '+15555551234' description: Phone number of person or workspace. extension: type: string example: '1234' description: Extension of person or workspace. weight: type: string example: '50' description: Weight of person or workspace. Only applied when call policy is `WEIGHTED`. GetCallQueueEssentialsCallPolicyObject: type: object required: - policy - callBounce - distinctiveRing properties: policy: $ref: '#/components/schemas/HuntPolicyEssentialSelection' description: Call routing policy to use to dispatch calls to agents. callBounce: type: object required: - callBounceEnabled - callBounceMaxRings - agentUnavailableEnabled - alertAgentEnabled - alertAgentMaxSeconds - callBounceOnHoldEnabled - callBounceOnHoldMaxSeconds properties: callBounceEnabled: type: boolean example: true description: If enabled, bounce calls after the set number of rings. callBounceMaxRings: type: number example: 5 description: Number of rings after which to bounce call, if call bounce is enabled. agentUnavailableEnabled: type: boolean example: true description: Bounce if agent becomes unavailable. alertAgentEnabled: type: boolean example: true description: Alert agent if call on hold more than alertAgentMaxSeconds. alertAgentMaxSeconds: type: number example: 20 description: Number of second after which to alert agent if alertAgentEnabled. callBounceOnHoldEnabled: type: boolean example: true description: Bounce if call on hold more than callBounceMaxSeconds. callBounceOnHoldMaxSeconds: type: number example: 20 description: Number of second after which to bounce if callBounceEnabled. description: Settings for when the call into the call queue is not answered. distinctiveRing: type: object required: - enabled properties: enabled: type: boolean example: true description: Whether or not the distinctive ring is enabled. ringPattern: $ref: '#/components/schemas/RingPatternObject' description: Ring pattern for when this callqueue is called. Only available when `distinctiveRing` is enabled for the call queue. description: Whether or not the call queue has the distinctive ring option enabled. CallQueueAlternateAvailableNumberListGetObject: type: object required: - phoneNumbers properties: phoneNumbers: type: array items: $ref: '#/components/schemas/CallQueueAlternateAvailableNumberObject' description: Array of phone numbers. HuntRoutingTypeSelection: type: string enum: - PRIORITY_BASED - SKILL_BASED description: " * `PRIORITY_BASED` - Default routing type which directly uses the routing policy to dispatch calls to the agents.\n * `SKILL_BASED` - This option uses skill level as the criteria to route calls to agents. When there is more than one agent with the same skill level, the selected `policy` helps dispatch the calls to the agents.\n" ModifyCallQueueForcedForwardObject: type: object required: - forcedForwardEnabled - playAnnouncementBeforeEnabled - audioMessageSelection properties: forcedForwardEnabled: type: boolean example: true description: Enable or disable call forced forward service routing policy. transferPhoneNumber: type: string example: '1235557890' description: Call gets transferred to this number when action is set to `TRANSFER`. This can also be an extension. playAnnouncementBeforeEnabled: type: boolean example: true description: Indicates whether an announcement plays to callers before the action is applied. audioMessageSelection: type: string enum: - DEFAULT - CUSTOM description: "The type of announcement to be played.\n * `DEFAULT` - Default Audio Message Selection.\n * `CUSTOM` - Custom Audio Message Selection.\n" audioFiles: type: array items: $ref: '#/components/schemas/AudioAnnouncementFileFeatureObject' description: List of pre-configured Announcement Audio Files when `audioMessageSelection` is `CUSTOM`. CallForwardSettingsGet: type: object required: - callForwarding properties: callForwarding: type: object required: - always - selective properties: always: type: object required: - enabled - ringReminderEnabled - destinationVoicemailEnabled properties: enabled: type: boolean example: true description: '`Always` call forwarding is enabled or disabled.' destination: type: string example: '2225551212' description: Destination for "Always" call forwarding. ringReminderEnabled: type: boolean description: If `true`, a brief tone will be played on the person's phone when a call has been forwarded. destinationVoicemailEnabled: type: boolean description: Indicates enabled or disabled state of sending incoming calls to voicemail when the destination is an internal phone number and that number has the voicemail service enabled. description: Settings for forwarding all incoming calls to the destination you choose. selective: type: object required: - enabled - ringReminderEnabled - destinationVoicemailEnabled properties: enabled: type: boolean example: true description: '`Busy` call forwarding is enabled or disabled.' destination: type: string example: '2225551212' description: Destination for `Busy` call forwarding. ringReminderEnabled: type: boolean description: If `true`, a brief tone will be played on the person's phone when a call has been forwarded. destinationVoicemailEnabled: type: boolean description: Indicates enabled or disabled state of sending incoming calls to voicemail when the destination is an internal phone number and that number has the voicemail service enabled. description: Selectively forward calls to a designated number, depending on criteria rules. You'll need to have at least one rule for forwarding applied for call forwarding to be active. rules: type: array items: $ref: '#/components/schemas/CallForwardRulesGet' description: Rules for selectively forwarding calls. operatingModes: type: object required: - enabled - currentOperatingModeId - exceptionType properties: enabled: type: boolean example: true description: Operating modes are enabled or disabled. currentOperatingModeId: type: string example: Y2lzY29zcGFyazovL3VzL09QRVJBVElOR19NT0RFL2JiOTc1OTcxLTBjZWYtNDdhNi05Yzc5LTliZWFjY2IwYjg4Mg description: The ID of the current operating mode. exceptionType: type: string enum: - MANUAL_SWITCH_BACK - AUTOMATIC_SWITCH_BACK_EARLY_START - AUTOMATIC_SWITCH_BACK_EXTENSION - AUTOMATIC_SWITCH_BACK_STANDARD description: "The exception type.\n * `MANUAL_SWITCH_BACK` - The mode was switched to or extended by the user for manual switch back and runs as an exception until the user manual switches the feature back to normal operation or a different mode.\n * `AUTOMATIC_SWITCH_BACK_EARLY_START` - The mode was switched to by the user before its start time and runs as an exception until its end time is reached at which point it automatically switches the feature back to normal operation.\n * `AUTOMATIC_SWITCH_BACK_EXTENSION` - The current mode was extended by the user before its end time and runs as an exception until the extension end time (mode's end time + extension of up to 12 hours) is reached at which point it automatically switches the feature back to normal operation.\n * `AUTOMATIC_SWITCH_BACK_STANDARD` - The mode will remain the current operating mode for the feature until its normal end time is reached.\n" modes: type: array items: $ref: '#/components/schemas/ModesGet' description: Operating modes. description: Settings related to operating modes. description: Settings related to `Always`, `Busy`, and `No Answer` call forwarding. ModifyCallQueueHolidayObject: type: object required: - holidayServiceEnabled - action - holidayScheduleLevel - playAnnouncementBeforeEnabled - audioMessageSelection properties: holidayServiceEnabled: type: boolean example: true description: Enable or Disable the call queue holiday service routing policy. action: type: string enum: - BUSY - TRANSFER description: "The call processing action type.\n * `BUSY` - The caller hears a fast-busy tone.\n * `TRANSFER` - Transfers the call to number specified in `transferPhoneNumber`.\n" holidayScheduleLevel: type: string enum: - LOCATION - ORGANIZATION description: "The schedule mentioned in `holidayScheduleName` is org or location specific. (Must be from `holidaySchedules` list)\n * `LOCATION` - Schedule is configured across a location.\n * `ORGANIZATION` - Schedule is configured across an organization.\n" holidayScheduleName: type: string example: 2022 Holidays Period description: Name of the schedule configured for a holiday service as one of from `holidaySchedules` list. transferPhoneNumber: type: string example: '1235557890' description: Call gets transferred to this number when action is set to `TRANSFER`. This can also be an extension. playAnnouncementBeforeEnabled: type: boolean example: true description: Indicates whether an announcement plays to callers before the action is applied. audioMessageSelection: type: string enum: - DEFAULT - CUSTOM description: "The type of announcement to be played.\n * `DEFAULT` - Default Audio Message Selection.\n * `CUSTOM` - Custom Audio Message Selection.\n" audioFiles: type: array items: $ref: '#/components/schemas/AudioAnnouncementFileFeatureObject' description: List of pre-configured Announcement Audio Files when `audioMessageSelection` is `CUSTOM`. PostPersonPlaceVirtualLineSupervisorObject: type: object required: - id properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BMQUNFLzE3NzczMWRiLWE1YzEtNGI2MC05ZTMwLTNhM2MxMGFiM2IxMQ description: Identifier of the person, workspace or virtual line. CallQueueHolidaySchedulesObject: type: object required: - scheduleName - scheduleLevel properties: scheduleName: type: string example: 2022 All Holidays description: Name of the schedule configured for a holiday service. scheduleLevel: type: string enum: - LOCATION - ORGANIZATION description: "Indicates whether the schedule in scheduleName is specific to the organization or location.\n * `LOCATION` - Schedule is configured across a location.\n * `ORGANIZATION` - Schedule is configured across an organization.\n" GetCallQueueAgentObject: type: object required: - agent - queues properties: agent: type: object required: - id - firstName - lastName - location - type properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xZmNiMjczZS0wYzdmLTQ1ZGUtYmNlOC0yMWE3YzFlYjVjYmY description: A unique identifier for the call queue agent. firstName: type: string example: Arthur description: First name for the call queue agent. lastName: type: string example: Murray description: last name for the call queue agent. phoneNumber: type: string example: '19728881234' description: Primary phone number of the call queue agent. extension: type: string example: '34543' description: Primary phone extension of the call queue agent. esn: type: string example: '34543180' description: Routing prefix + extension of a agent. location: type: object required: - name - id properties: name: type: string example: RCDN description: The location name where the call queue agent resides. id: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzZhZjk4ZGViLWVlZGItNGFmYi1hMDAzLTEzNzgyYjdjODAxYw description: ID of location for call queue agent. description: The location information. type: type: string example: PEOPLE description: TIMEhe type of the call queue agent. queues: type: array items: type: object required: - id - name - routingPrefix - locationId - locationName - joinEnabled properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvZjM4NDIxZGYtN2MxOC00NGI1LThlNmQtNDFmZTEyMTFlZDFk description: Unique identifier of the call queue. name: type: string example: YU7 description: Unique name for the call queue. phoneNumber: type: string example: '12144184002' description: Primary phone number of the call queue. routingPrefix: type: string example: '34543' description: The routing prefix for the call queue. locationId: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzZhZjk4ZGViLWVlZGItNGFmYi1hMDAzLTEzNzgyYjdjODAxYw description: The location identifier of the call queue. locationName: type: string example: RCDN description: The location name where the call queue resides. joinEnabled: type: boolean example: true description: Whether or not the call queue is enabled. ModifyCallQueueCallPolicyObject: type: object required: - routingType properties: routingType: $ref: '#/components/schemas/HuntRoutingTypeSelection' description: Call routing type to use to dispatch calls to agents. policy: $ref: '#/components/schemas/HuntPolicySelection' description: Call routing policy to use to dispatch calls to agents. callBounce: type: object properties: callBounceEnabled: type: boolean example: true description: If enabled, bounce calls after the set number of rings. callBounceMaxRings: type: number example: 5 description: Number of rings after which to bounce call, if call bounce is enabled. agentUnavailableEnabled: type: boolean example: true description: Bounce if agent becomes unavailable. alertAgentEnabled: type: boolean example: true description: Alert agent if call on hold more than `alertAgentMaxSeconds`. alertAgentMaxSeconds: type: number example: 20 description: Number of second after which to alert agent if `alertAgentEnabled.` callBounceOnHoldEnabled: type: boolean example: true description: Bounce if call on hold more than `callBounceMaxSeconds`. callBounceOnHoldMaxSeconds: type: number example: 20 description: Number of second after which to bounce if `callBounceEnabled`. description: Settings for when the call is not answered. distinctiveRing: type: object properties: enabled: type: boolean example: true description: Whether or not the `distinctiveRing` is enabled. ringPattern: $ref: '#/components/schemas/RingPatternObject' description: Ring pattern for when this call queue is called. Only available when `distinctiveRing` is enabled for the call queue. description: Whether or not the call queue has the `distinctiveRing` option enabled. BulkSupervisorsDelete: type: object required: - supervisorIds properties: supervisorIds: type: array items: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS80Y2I1M2ZmMy01NWViLTQ2MzYtYTE4ZC05NWVjZmFhM2E4NmY,Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wNzY2ZDNjNC0xZTg1LTQ4YzgtYTFkZi1mMWUzYTAyMDg1MWE description: Array of supervisors IDs to be deleted. deleteAll: type: boolean description: 'If present the `supervisorIds` array is ignored, and all supervisors in the context are deleted. **WARNING**: This will remove all supervisors from the organization.' ListCallQueueAgentObject: type: object required: - id - firstName - lastName - queueCount - locationCount - joinCount - unjoinCount - location - type properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8zYjY4Yjg2YS1hMTZiLTRmNzItOTlmZi01ZDlhZjgyZWNmNTE description: Unique call queue agent identifier. firstName: type: string example: test_301_person_phone_extnsion description: First name for the call queue agent. lastName: type: string example: last_nam description: Last name for the call queue agent. phoneNumber: type: string example: '+15558675309' description: Primary phone number of the call queue agent. extension: type: string example: '23234' description: Primary phone extension of the call queue agent. routingPrefix: type: string example: '8002' description: Routing prefix of the call queue agent. esn: type: string example: '23234' description: Routing prefix + extension of a agent. queueCount: type: number example: 1 description: Denotes the queue count for call queue agent. locationCount: type: number example: 1 description: Denotes the location count for call queue agent. joinCount: type: number example: 1 description: Denotes the join count for call queue agent. unjoinCount: type: number description: Denotes unjoin count for call queue agent. location: type: object required: - name - id properties: name: type: string example: Location2 description: The location name where the call queue agent resides. id: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVmMDI3OGZlLWU4OGMtNDMzNy04MGViLWRjY2NiM2VlMDU1MA description: ID of location for call queue agent. description: The location information. type: type: string example: PEOPLE description: The type of the call queue agent. CallForwardRulesGet: type: object required: - id properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0NBTExfRk9SV0FSRElOR19TRUxFQ1RJVkVfUlVMRS9kR1Z6ZEZKMWJHVTA description: Unique ID for the rule. name: type: string example: My Rule description: Unique name of rule. callFrom: type: string example: Any private Number,2025551212 description: Comma-separated list of incoming call numbers that, when matched, will not be forwarded. A Limit of 12 numbers is allowed. Use `Any private Number` in the comma-separated value to indicate rules that match incoming calls from a private number. Use `Any unavailable number` in the comma-separated value to match incoming calls from an unavailable number. callsTo: type: string example: Primary description: Comma-separated list of the types of numbers being matched for incoming call destination. forwardTo: type: string example: '2025557736' description: Number to which calls will be forwarded if the rule is of type "Forward To" and the incoming call is matched. enabled: type: boolean example: true description: Reflects if rule is enabled. GetCallQueueHolidayObject: type: object required: - holidayServiceEnabled - action - holidayScheduleLevel - playAnnouncementBeforeEnabled - audioMessageSelection properties: holidayServiceEnabled: type: boolean example: true description: Whether or not the call queue holiday service routing policy is enabled. action: type: string enum: - BUSY - TRANSFER description: "The call processing action type.\n * `BUSY` - The caller hears a fast-busy tone.\n * `TRANSFER` - Transfers the call to number specified in `transferPhoneNumber`.\n" holidayScheduleLevel: type: string enum: - LOCATION - ORGANIZATION description: "The schedule mentioned in `holidayScheduleName` is org or location specific. (Must be from `holidaySchedules` list)\n * `LOCATION` - Schedule is configured across a location.\n * `ORGANIZATION` - Schedule is configured across an organization.\n" holidayScheduleName: type: string example: 2022 Holidays Period description: Name of the schedule configured for a holiday service as one of from `holidaySchedules` list. transferPhoneNumber: type: string example: '1235557890' description: Call gets transferred to this number when action is set to `TRANSFER`. This can also be an extension. playAnnouncementBeforeEnabled: type: boolean example: true description: Indicates whether an announcement plays to callers before the action is applied. audioMessageSelection: type: string enum: - DEFAULT - CUSTOM description: "The type of announcement to be played.\n * `DEFAULT` - Default Audio Message Selection.\n * `CUSTOM` - Custom Audio Message Selection.\n" audioFiles: type: array items: $ref: '#/components/schemas/AudioAnnouncementFileFeatureGetObject' description: List of Announcement Audio Files when `audioMessageSelection` is `CUSTOM`. holidaySchedules: type: array items: $ref: '#/components/schemas/CallQueueHolidaySchedulesObject' description: Lists the pre-configured holiday schedules. CallQueueNightSchedulesObject: type: object required: - scheduleName - scheduleLevel properties: scheduleName: type: string example: Working Hours description: Name of the schedule configured for a night service. scheduleLevel: type: string enum: - LOCATION - ORGANIZATION description: "Indicates whether the schedule in scheduleName is specific to the organization or location.\n * `LOCATION` - Schedule is configured across a location.\n * `ORGANIZATION` - Schedule is configured across an organization.\n" AudioAnnouncementFileFeatureObject: type: object properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2QzVjBPWFIxWjJkM2FFQm1iR1Y0TWk1amFYTmpieTVqYjIw description: A unique identifier for the announcement. `name`, `mediaFileType`, `level` are mandatory if `id` is not provided for uploading an announcement. fileName: type: string example: AUDIO_FILE.wav description: Audio announcement file name. mediaFileType: type: string enum: - WAV - WMA - 3GP description: "Audio announcement file type.\n * `WAV` - WAV File Extension.\n * `WMA` - WMA File Extension.\n * `3GP` - 3GP File Extension.\n" level: type: string enum: - ORGANIZATION - LOCATION - ENTITY description: "Audio announcement file type location.\n * `ORGANIZATION` - Audio file is configured across organisation.\n * `LOCATION` - Audio file is configured across location.\n * `ENTITY` - Audio file is configured on instance level.\n" CreateSupervisorObject: type: object required: - id - agents properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS81OGVkZTIwNi0yNTM5LTQ1ZjQtODg4Ny05M2E3ZWIwZWI3ZDI description: A unique identifier for the supervisor. agents: type: array items: $ref: '#/components/schemas/PostPersonPlaceVirtualLineSupervisorObject' description: People, workspaces and virtual lines that are eligible to receive calls. AudioAnnouncementFileFeatureGetObject: type: object required: - id - fileName - mediaFileType - level - isTextToSpeech properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2QzVjBPWFIxWjJkM2FFQm1iR1Y0TWk1amFYTmpieTVqYjIw description: A unique identifier for the announcement. fileName: type: string example: AUDIO_FILE.wav description: Audio announcement file name. mediaFileType: type: string enum: - WAV - WMA - 3GP description: "Audio announcement file type.\n * `WAV` - WAV File Extension.\n * `WMA` - WMA File Extension.\n * `3GP` - 3GP File Extension.\n" level: type: string enum: - ORGANIZATION - LOCATION - ENTITY description: "Audio announcement file type location.\n * `ORGANIZATION` - Audio file is configured across organization.\n * `LOCATION` - Audio file is configured across location.\n * `ENTITY` - Audio file is configured on instance level.\n" isTextToSpeech: type: boolean description: Indicates whether the announcement is a text-to-speech file. CreateCallQueueEssentialsObject: type: object required: - name - callPolicies - queueSettings - agents properties: name: type: string example: CallQueue-1 description: Unique name for the call queue. phoneNumber: type: string example: '+12225555309' description: Primary phone number of the call queue. Either a `phoneNumber` or `extension` is mandatory. extension: type: string example: '5309' description: Primary phone extension of the call queue. Either a `phoneNumber` or extension is mandatory. languageCode: type: string example: en-US description: Language code. firstName: type: string example: Hakim description: First name to be shown when calls are forwarded out of this call queue. Defaults to ".". This field has been deprecated. Please use `directLineCallerIdName` and `dialByName` instead. lastName: type: string example: Smith description: Last name to be shown when calls are forwarded out of this call queue. Defaults to `phoneNumber` if set, otherwise defaults to call group name. This field has been deprecated. Please use `directLineCallerIdName` and `dialByName` instead. timeZone: type: string example: America/Chicago description: Time zone for the call queue. callPolicies: $ref: '#/components/schemas/PostCallQueueEssentialCallPolicyObject' description: Policy controlling how calls are routed to `agents`. queueSettings: $ref: '#/components/schemas/CallQueueQueueSettingsObject' description: Overall call queue settings. agents: type: array items: $ref: '#/components/schemas/PostPersonPlaceVirtualLineCallQueueObject' description: People, workspaces and virtual lines that are eligible to receive calls. callingLineIdPolicy: type: string enum: - DIRECT_LINE - LOCATION_NUMBER - CUSTOM description: "Which type of Calling Line ID Policy Selected for Call Queue.\n * `DIRECT_LINE` - Calling Line ID Policy will show the caller's direct line number.\n * `LOCATION_NUMBER` - Calling Line ID Policy will show the main number for the location.\n * `CUSTOM` - Calling Line ID Policy will show the value from the `callingLineIdPhoneNumber` field.\n" callingLineIdPhoneNumber: type: string example: '+12072342368' description: Calling line ID Phone number which will be shown if CUSTOM is selected. allowAgentJoinEnabled: type: boolean description: Whether or not to allow agents to join or unjoin a queue. phoneNumberForOutgoingCallsEnabled: type: boolean example: true description: When `true`, indicates that the agent's configuration allows them to use the queue's Caller ID for outgoing calls. directLineCallerIdName: $ref: '#/components/schemas/DirectLineCallerIdNameObject' description: Settings for the direct line caller ID name to be shown for this call queue. dialByName: type: string example: Hakim Smith description: The name to be used for dial by name functions. Characters of `%`, `+`, `\`, `"` and Unicode characters are not allowed. PostPersonPlaceVirtualLineCallQueueObject: type: object required: - id properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS80NDVkMzMzMC1mNjE3LTExZWItOWQyZS01NzViODE3ZGE1NmE description: ID of person, workspace or virtual line. weight: type: string example: '50' description: Weight of person, workspace or virtual line. Only applied when call policy is `WEIGHTED`. skillLevel: type: number example: 1 description: Skill level of person, workspace or virtual line. Only applied when call routing type is `SKILL_BASED`. GetCallQueueEssentialsObject: type: object required: - id - name - hasCxEssentials - enabled - alternateNumberSettings - callPolicies - queueSettings - agents properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvNTU1MzY4Y2QtZDg5Mi00YzFlLTk0YjYtNzdjNjRiYWQ3NWMx description: A unique identifier for the call queue. name: type: string example: CallQueue-1 description: Unique name for the call queue. hasCxEssentials: type: boolean example: true description: Denotes if the call queue has Customer Assist license. enabled: type: boolean example: true description: Whether or not the call queue is enabled. language: type: string example: English description: Language for call queue. languageCode: type: string example: en-US description: Language code for call queue. firstName: type: string example: Hakim description: First name to be shown when calls are forwarded out of this call queue. Defaults to ".". lastName: type: string example: Smith description: Last name to be shown when calls are forwarded out of this call queue. Defaults to the phone number if set, otherwise defaults to call group name. timeZone: type: string example: America/Chicago description: Time zone for the call queue. phoneNumber: type: string example: '+15558675309' description: Primary phone number of the call queue. extension: type: string example: '7781' description: Extension of the call queue. alternateNumberSettings: type: object required: - distinctiveRingEnabled - alternateNumbers properties: distinctiveRingEnabled: type: boolean example: true description: Distinctive Ringing selected for the alternate numbers in the call queue overrides the normal ringing patterns set for Alternate Number. alternateNumbers: type: array items: $ref: '#/components/schemas/AlternateNumbersWithPattern' description: Allows up to 10 numbers, each with an optional distinctive ring setting override. description: The alternate numbers feature allows you to assign multiple phone numbers or extensions to a call queue. Each number will reach the same greeting and each menu will function identically to the main number. The alternate numbers option enables you to have up to ten (10) phone numbers ring into the call queue. callPolicies: $ref: '#/components/schemas/GetCallQueueEssentialsCallPolicyObject' description: Policy controlling how calls are routed to agents. queueSettings: $ref: '#/components/schemas/CallQueueQueueEssentialsSettingsObject' description: Overall call queue settings. allowCallWaitingForAgentsEnabled: type: boolean description: Flag to indicate whether call waiting is enabled for agents. agents: type: array items: $ref: '#/components/schemas/GetPersonPlaceObject' description: People, including workspaces, that are eligible to receive calls. department: type: object properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1NDSU1fR1JPVVAvZjA2ZWRiOGMtMjMxNC00ZTcxLWIzNzgtZTdiMmQwNjk3OTliOjk2YWJjMmFhLTNkY2MtMTFlNS1hMTUyLWZlMzQ4MTljZGM5YQ description: Unique identifier of the department. name: type: string example: HR description: Name of the department. description: The department information. directLineCallerIdName: $ref: '#/components/schemas/DirectLineCallerIdNameObject' description: Settings for the direct line caller ID name to be shown for this call queue. dialByName: type: string example: Hakim Smith description: The name to be used for dial by name functions. CallQueueQueueEssentialsSettingsObject: type: object required: - queueSize - overflow properties: queueSize: type: number example: 50 description: The maximum number of calls for this call queue. Once this number is reached, the overflow settings are triggered. callOfferToneEnabled `true`: type: boolean description: Play ringing tone to callers when their call is set to an available agent. resetCallStatisticsEnabled: type: boolean description: Reset caller statistics upon queue entry. overflow: type: object required: - action - greeting properties: action: type: string enum: - PERFORM_BUSY_TREATMENT - PLAY_RINGING_UNTIL_CALLER_HANGS_UP - TRANSFER_TO_PHONE_NUMBER description: "Indicates how to handle new calls when the queue is full.\n * `PERFORM_BUSY_TREATMENT` - The caller hears a fast-busy tone.\n * `PLAY_RINGING_UNTIL_CALLER_HANGS_UP` - The caller hears ringing until they disconnect.\n * `TRANSFER_TO_PHONE_NUMBER` - Number where you want to transfer overflow calls.\n" sendToVoicemail: type: boolean description: When `true`, forwards all calls to a voicemail service of an internal number. This option is ignored when an external `transferNumber` is entered. transferNumber: type: string example: '+15553331212' description: Destination number for overflow calls when `action` is set to `TRANSFER_TO_PHONE_NUMBER`. overflowAfterWaitEnabled: type: boolean example: true description: After calls wait for the configured number of seconds and no agent is available, the overflow treatment is triggered. overflowAfterWaitTime: type: number example: 20 description: Number of seconds to wait before the overflow treatment is triggered when no agent is available. playOverflowGreetingEnabled: type: boolean example: true description: Indicate overflow audio to be played, otherwise callers will hear the hold music until the call is answered by a user. greeting: type: string enum: - CUSTOM - DEFAULT description: "Indicates how to handle new calls when the queue is full.\n * `CUSTOM` - Play the custom announcement specified by the `fileName` field.\n * `DEFAULT` - Play default announcement.\n" audioFiles: type: array items: type: string description: Array of announcement file name strings to be played as overflow greetings. These files are from the list of announcements files associated with this call queue. description: Settings for incoming calls exceed queueSize. CallForwardRulesSet: type: object required: - id properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0NBTExfRk9SV0FSRElOR19TRUxFQ1RJVkVfUlVMRS9kR1Z6ZEZKMWJHVTA description: Unique ID for the rule. enabled: type: boolean example: true description: Reflects if rule is enabled. ListSupervisorAgentObject: type: object required: - id properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85NTA4OTc4ZC05YmFkLTRmYWEtYTljNC0wOWQ4NWQ4ZmRjZTY description: ID of person, workspace or virtual line. lastName: type: string example: user description: Last name of the agent. firstName: type: string example: test description: First name of the agent. extension: type: string example: '0020' description: Primary phone extension of the agent. esn: type: string example: '0020' description: Routing prefix + extension of a agent. phoneNumber: type: string example: '+1972998998' description: Primary phone number of the agent. AvailableAgentObject: type: object required: - id - lastName - firstName - displayName - type - email - hasCxEssentials properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS80NDVkMzMzMC1mNjE3LTExZWItOWQyZS01NzViODE3ZGE1NmE description: ID of a person, workspace or virtual line. lastName: type: string example: Brown description: Last name of a person, workspace or virtual line. firstName: type: string example: John description: First name of a person, workspace or virtual line. displayName: type: string example: johnBrown description: Display name of a person, workspace or virtual line. type: type: string enum: - PEOPLE - PLACE - VIRTUAL_LINE description: "Type of the person, workspace or virtual line.\n * `PEOPLE` - Object is a user.\n * `PLACE` - Object is a place.\n * `VIRTUAL_LINE` - Object is a virtual line.\n" email: type: string example: john.brown@example.com description: Email of a person, workspace or virtual line. hasCxEssentials: type: boolean example: true description: Person has the CX Essentials license. phoneNumbers: type: array items: $ref: '#/components/schemas/GetUserNumberItemObject' description: List of phone numbers of a person, workspace or virtual line. ListSupervisorAgentStatusObject: type: object required: - id - status - message properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85NTA4OTc4ZC05YmFkLTRmYWEtYTljNC0wOWQ4NWQ4ZmRjZTY description: 'ID of person, workspace or virtual line. **WARNING**: The `id` returned is in UUID format, since we don''t have agentType from OCI response. This will be converting to Hydra type in future release.' status: type: string example: DUPLICATE description: status of the agent. message: type: string example: '[Error 6612] Agent 9508978d-9bad-4faa-a9c4-09d85d8fdce6 is already assigned to the supervisor.' description: Detailed message for the status. PatchCallQueueNightServiceObject: type: object required: - nightServiceEnabled - playAnnouncementBeforeEnabled - announcementMode - audioMessageSelection - forceNightServiceEnabled - manualAudioMessageSelection properties: nightServiceEnabled: type: boolean example: true description: Enable or disable call queue night service routing policy. action: type: string enum: - BUSY - TRANSFER description: "The call processing action type.\n * `BUSY` - The caller hears a fast busy tone.\n * `TRANSFER` - Transfers the call to number specified in `transferPhoneNumber`.\n" transferPhoneNumber: type: string example: '1234' description: Call gets transferred to this number when action is set to `TRANSFER`. This can also be an extension. playAnnouncementBeforeEnabled: type: boolean example: true description: Indicates whether an announcement plays to callers before the action is applied. announcementMode: type: string enum: - NORMAL - MANUAL description: "The type of announcements to played.\n * `NORMAL` - Plays announcement as per `audioMessageSelection`.\n * `MANUAL` - Plays announcement as per `manualAudioMessageSelection`.\n" audioMessageSelection: type: string enum: - DEFAULT - CUSTOM description: "The type of announcements to be played when announcementMode is set to `NORMAL`.\n * `DEFAULT` - Default Audio Message Selection.\n * `CUSTOM` - Custom Audio Message Selection.\n" audioFiles: type: array items: $ref: '#/components/schemas/AudioAnnouncementFileFeatureObject' description: List of pre-configured Announcement Audio Files when `audioMessageSelection` is `CUSTOM`. businessHoursName: type: string example: Working Hour description: Name of the schedule configured for a night service as one of from `businessHourSchedules` list. businessHoursLevel: type: string enum: - ORGANIZATION - LOCATION description: "The above mentioned schedule is org or location specific. (Must be from `businessHourSchedules` list)\n * `ORGANIZATION` - Schedule is configured across an organization.\n * `LOCATION` - Schedule is configured across a location.\n" forceNightServiceEnabled: type: boolean example: true description: Force night service regardless of business hour schedule. manualAudioMessageSelection: type: string enum: - DEFAULT - CUSTOM description: "The type of announcements to be played when announcementMode is set to `MANUAL`.\n * `DEFAULT` - Default Audio Message Selection.\n * `CUSTOM` - Custom Audio Message Selection.\n" manualAudioFiles: type: array items: $ref: '#/components/schemas/AudioAnnouncementFileFeatureObject' description: List Of pre-configured Audio Files. CallQueuePrimaryAvailableNumberObject: type: object required: - phoneNumber - state - isMainNumber - tollFreeNumber - telephonyType - isServiceNumber properties: phoneNumber: type: string example: '+12056350001' description: A unique identifier for the PSTN phone number. state: $ref: '#/components/schemas/STATE' description: Phone number's state. isMainNumber: type: boolean example: true description: If `true`, the phone number is used as a location CLID. tollFreeNumber: type: boolean example: true description: If `true`, the phone number is a toll-free number. telephonyType: $ref: '#/components/schemas/TelephonyType' description: The telephony type for the number. isServiceNumber: type: boolean example: true description: If `true`, the phone number is a service number; otherwise, it is a standard number. Service numbers are high-utilization or high-concurrency PSTN phone numbers that are neither mobile nor toll-free. GetCallQueueForcedForwardObject: type: object required: - forcedForwardEnabled - playAnnouncementBeforeEnabled - audioMessageSelection properties: forcedForwardEnabled: type: boolean example: true description: Whether or not the call queue forced forward routing policy setting is enabled. transferPhoneNumber: type: string example: '1235557890' description: Call gets transferred to this number when action is set to `TRANSFER`. This can also be an extension. playAnnouncementBeforeEnabled: type: boolean example: true description: Indicates whether an announcement plays to callers before the action is applied. audioMessageSelection: type: string enum: - DEFAULT - CUSTOM description: "The type of announcement to be played.\n * `DEFAULT` - Default Audio Message Selection.\n * `CUSTOM` - Custom Audio Message Selection.\n" audioFiles: type: array items: $ref: '#/components/schemas/AudioAnnouncementFileFeatureGetObject' description: List of Announcement Audio Files when `audioMessageSelection` is `CUSTOM`. SelectionObject: type: string enum: - CUSTOM_NAME - DISPLAY_NAME description: " * `DISPLAY_NAME` - When this option is selected, `displayName` is to be shown for this workspace.\n * `CUSTOM_NAME` - When this option is selected, `customName` is to be shown for this workspace." ModesPatch: type: object required: - normalOperationEnabled - id - forwardTo properties: normalOperationEnabled: type: boolean example: true description: Normal operation is enabled or disabled. id: type: string example: Y2lzY29zcGFyazovL3VzL09QRVJBVElOR19NT0RFL2JiOTc1OTcxLTBjZWYtNDdhNi05Yzc5LTliZWFjY2IwYjg4Mg description: The ID of the operating mode. forwardTo: type: object required: - selection properties: selection: type: string enum: - FORWARD_TO_DEFAULT_NUMBER - FORWARD_TO_SPECIFIED_NUMBER - DO_NOT_FORWARD description: "The selection for forwarding.\n * `FORWARD_TO_DEFAULT_NUMBER` - When the rule matches, forward to the destination for the hunt group.\n * `FORWARD_TO_SPECIFIED_NUMBER` - When the rule matches, forward to the destination for this rule.\n * `DO_NOT_FORWARD` - When the rule matches, do not forward to another number.\n" destination: type: string example: '+19705550006' description: The destination for forwarding. Required when the selection is set to `FORWARD_TO_SPECIFIED_NUMBER`. destinationVoicemailEnabled: type: boolean description: Sending incoming calls to voicemail is enabled/disabled when the destination is an internal phone number and that number has the voicemail service enabled. description: Forward to settings. ModifyCallForwardingObject: type: object properties: callForwarding: type: object properties: always: type: object properties: enabled: type: boolean example: true description: '`Always` call forwarding is enabled or disabled.' destination: type: string example: '2225551212' description: Destination for `Always` call forwarding. ringReminderEnabled: type: boolean description: If `true`, a brief tone will be played on the person's phone when a call has been forwarded. destinationVoicemailEnabled: type: boolean description: Sending incoming calls to voicemail is enabled/disabled when the destination is an internal phone number and that number has the voicemail service enabled. description: Settings for forwarding all incoming calls to the destination you choose. selective: type: object properties: enabled: type: boolean example: true description: '`Busy` call forwarding is enabled or disabled.' destination: type: string example: '2225551212' description: Destination for `Busy` call forwarding. ringReminderEnabled: type: boolean description: If `true`, a brief tone will be played on the person's phone when a call has been forwarded. destinationVoicemailEnabled: type: boolean description: Sending incoming calls to voicemail is enabled/disabled when the destination is an internal phone number and that number has the voicemail service enabled. description: Selectively forward calls to a designated number, depending on criteria rules. You'll need to have at least one rule for forwarding applied for call forwarding to be active. rules: type: array items: $ref: '#/components/schemas/CallForwardRulesSet' description: Rules for selectively forwarding calls. operatingModes: type: object description: Configuration for forwarding via Operating modes (Schedule Based Routing). required: - enabled - modes properties: enabled: type: boolean description: Indicates whether operating modes forwarding is enabled. modes: type: array items: $ref: '#/components/schemas/ModesPatch' description: List of operating mode configurations. description: Settings related to `Always`, `Busy`, and `No Answer` call forwarding. AvailableAgentListGetObject: type: object required: - agents properties: agents: type: array items: $ref: '#/components/schemas/AvailableAgentObject' description: Array of available agents. STATE: type: string enum: - ACTIVE - INACTIVE description: " * `ACTIVE` - Phone number is in the active state.\n * `INACTIVE` - Phone number is in the inactive state.\n" ModifyAgentsForCallQueueObject: type: object required: - settings properties: settings: type: array items: type: object required: - queueId - joinEnabled properties: queueId: type: string example: Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvZjM4NDIxZGYtN2MxOC00NGI1LThlNmQtNDFmZTEyMTFlZDFk description: Unique call queue identifier. joinEnabled: type: boolean example: true description: Whether or not the call queue is enabled. GetUserNumberItemObject: type: object properties: external: type: string example: '+19075552859' description: Phone number of a person, workspace or virtual line. extension: type: string example: '8080' description: Extension of a person, workspace or virtual line. AvailableAgentListObject: type: object required: - id - type properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS80YzVlODRhMS0wZmEwLTQzNDAtODVkZC1mMzM1ZGQ4MTkxMmI description: A unique identifier for the agent. firstName: type: string example: Adam description: First name of the agent. lastName: type: string example: Sandler description: Last name of the agent. displayName: type: string example: Adam Sandler description: (string, optional) - Display name of the agent. phoneNumber: type: string example: '+19845550200' description: Primary phone number of the agent. extension: type: string example: '0020' description: Primary phone extension of the agent. routingPrefix: type: string example: '34543' description: Routing prefix of location. esn: type: string example: '345430020' description: Routing prefix + extension of a person. type: $ref: '#/components/schemas/UserType' description: Type of the person, workspace or virtual line. AlternateNumbersWithPattern: type: object required: - phoneNumber properties: phoneNumber: type: string example: '+12225555309' description: Alternate phone number for the hunt group. ringPattern: $ref: '#/components/schemas/RingPatternObject' description: Ring pattern for when this alternate number is called. Only available when `distinctiveRing` is enabled for the hunt group. level: type: string enum: - ORGANIZATION - LOCATION - ENTITY description: " * `ORGANIZATION` - Organization level.\n * `LOCATION` - Location level.\n * `ENTITY` - Entity level.\n" AgentAction: type: string enum: - ADD - DELETE description: " * `ADD` - Assign an agent to a supervisor.\n * `DELETE` - Remove an agent from a supervisor.\n" HuntPolicyEssentialSelection: type: string enum: - CIRCULAR - REGULAR - SIMULTANEOUS - UNIFORM - WEIGHTED description: " * `CIRCULAR` - This option cycles through all agents after the last agent that took a call. It sends calls to the next available agent.\n * `REGULAR` - Send the call through the queue of agents in order, starting from the top each time.\n * `SIMULTANEOUS` - Sends calls to all agents at once\n * `UNIFORM` - Sends calls to the agent that has been idle the longest. If they don't answer, proceed to the next agent who has been idle the second longest, and so on until the call is answered.\n * `WEIGHTED` - Sends call to idle agents based on percentages you assign to each agent (up to 100%).\n" CreateForwardingRuleObject: type: object required: - name - callsFrom - callsTo properties: name: type: string example: New Selective Rule description: Unique name for the selective rule in the hunt group. enabled: type: boolean example: true description: Reflects if rule is enabled. holidaySchedule: type: string example: HolidayScheduleOne description: Name of the location's holiday schedule which determines when this selective call forwarding rule is in effect. businessSchedule: type: string example: BusinessScheduleTwo description: Name of the location's business schedule which determines when this selective call forwarding rule is in effect. forwardTo: type: object required: - selection properties: selection: type: string enum: - FORWARD_TO_DEFAULT_NUMBER - FORWARD_TO_SPECIFIED_NUMBER - DO_NOT_FORWARD description: "Controls what happens when the rule matches.\n * `FORWARD_TO_DEFAULT_NUMBER` - When the rule matches, forward to the destination for the hunt group.\n * `FORWARD_TO_SPECIFIED_NUMBER` - When the rule matches, forward to the destination for this rule.\n * `DO_NOT_FORWARD` - When the rule matches, do not forward to another number.\n" phoneNumber: type: string example: '+15558675309' description: Phone number to forward calls to. Required when selection is `FORWARD_TO_SPECIFIED_NUMBER`. description: Controls what happens when the rule matches including the destination number for the call forwarding. callsFrom: type: object required: - selection - customNumbers properties: selection: type: string enum: - ANY - CUSTOM description: "If `CUSTOM`, use `customNumbers` to specify which incoming caller ID values cause this rule to match. `ANY` means any incoming call matches assuming the rule is in effect based on the associated schedules.\n * `ANY` - Rule matches for calls from any number.\n * `CUSTOM` - Rule matches based on the numbers and options in `customNumbers`.\n" customNumbers: type: object required: - privateNumberEnabled - unavailableNumberEnabled properties: privateNumberEnabled: type: boolean description: Match if caller ID indicates the call is from a private number. unavailableNumberEnabled: type: boolean description: Match if caller ID is unavailable. numbers: type: array items: type: string description: Array of number strings to be matched against incoming caller ID. description: Custom rules for matching incoming caller ID information. description: Settings related to the rule matching based on incoming caller ID. callsTo: type: object properties: numbers: type: array items: $ref: '#/components/schemas/CallForwardingNumbers' description: Array of numbers to be matched against the calling destination number. description: Settings related to the rule matching based on the destination number. GetForwardingRuleObject: type: object required: - name - id - callsFrom - callsTo properties: name: type: string example: New Selective Rule description: Unique name for the selective rule in the hunt group. id: type: string example: Y2lzY29zcGFyazovL3VzL0NBTExfRk9SV0FSRElOR19TRUxFQ1RJVkVfUlVMRS9kR1Z6ZEZKMWJHVTA description: Unique ID for the rule. enabled: type: boolean example: true description: Reflects if rule is enabled. holidaySchedule: type: string example: HolidayScheduleOne description: Name of the location's holiday schedule which determines when this selective call forwarding rule is in effect. businessSchedule: type: string example: BusinessScheduleTwo description: Name of the location's business schedule which determines when this selective call forwarding rule is in effect. forwardTo: type: object required: - selection properties: selection: type: string enum: - FORWARD_TO_DEFAULT_NUMBER - FORWARD_TO_SPECIFIED_NUMBER - DO_NOT_FORWARD description: "Controls what happens when the rule matches.\n * `FORWARD_TO_DEFAULT_NUMBER` - When the rule matches, forward to the destination for the hunt group.\n * `FORWARD_TO_SPECIFIED_NUMBER` - When the rule matches, forward to the destination for this rule.\n * `DO_NOT_FORWARD` - When the rule matches, do not forward to another number.\n" phoneNumber: type: string example: '+15558675309' description: Phone number used if selection is `FORWARD_TO_SPECIFIED_NUMBER`. description: Controls what happens when the rule matches including the destination number for the call forwarding. callsFrom: type: object required: - selection - customNumbers properties: selection: type: string enum: - ANY - CUSTOM description: "If `CUSTOM`, use `customNumbers` to specify which incoming caller ID values cause this rule to match. `ANY` means any incoming call matches assuming the rule is in effect based on the associated schedules.\n * `ANY` - Rule matches for calls from any number.\n * `CUSTOM` - Rule matches based on the numbers and options in `customNumbers`.\n" customNumbers: type: object required: - privateNumberEnabled - unavailableNumberEnabled properties: privateNumberEnabled: type: boolean description: Match if caller ID indicates the call is from a private number. unavailableNumberEnabled: type: boolean description: Match if caller ID is unavailable. numbers: type: array items: type: string description: Array of number strings to be matched against incoming caller ID. description: Custom rules for matching incoming caller ID information. description: Settings related to the rule matching based on incoming caller ID. callsTo: type: object properties: numbers: type: array items: $ref: '#/components/schemas/CallForwardingNumbers' description: Array of numbers to be matched against the calling destination number. description: Settings related to the rule matching based on the destination number. CreateAgentObject: type: object required: - agents properties: agents: type: array items: $ref: '#/components/schemas/PutPersonPlaceVirtualLineAgentObject' description: 'People, workspaces and virtual lines that are eligible to receive calls. **WARNING**: The `id` returned is in UUID format, since we don''t have agentType from OCI response. This will be converting to Hydra type in future release.' HuntPolicySelection: type: string enum: - CIRCULAR - REGULAR - SIMULTANEOUS - UNIFORM - WEIGHTED description: " * `CIRCULAR` - This option cycles through all agents after the last agent that took a call. It sends calls to the next available agent. This is supported for `SKILL_BASED`.\n * `REGULAR` - Send the call through the queue of agents in order, starting from the top each time. This is supported for `SKILL_BASED`.\n * `SIMULTANEOUS` - Sends calls to all agents at once\n * `UNIFORM` - Sends calls to the agent that has been idle the longest. If they don't answer, proceed to the next agent who has been idle the second longest, and so on until the call is answered. This is supported for `SKILL_BASED`.\n * `WEIGHTED` - Sends calls to idle agents based on percentages you assign to each agent (up to 100%).\n" AvailableSupervisorsListObject: type: object required: - id properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS80YzVlODRhMS0wZmEwLTQzNDAtODVkZC1mMzM1ZGQ4MTkxMmI description: A unique identifier for the supervisor. firstName: type: string example: Adam description: First name of the supervisor. lastName: type: string example: Sandler description: Last name of the supervisor. displayName: type: string example: Adam Sandler description: (string, optional) - Display name of the supervisor. phoneNumber: type: string example: '+19845550200' description: Primary phone number of the supervisor. extension: type: string example: '0020' description: Primary phone extension of the supervisor. routingPrefix: type: string example: '34543' description: Routing prefix of location. esn: type: string example: '345430020' description: Routing prefix + extension of a person. CallQueuePrimaryAvailableNumberListGetObject: type: object required: - phoneNumbers properties: phoneNumbers: type: array items: $ref: '#/components/schemas/CallQueuePrimaryAvailableNumberObject' description: Array of phone numbers. CallQueueQueueSettingsObject: type: object required: - queueSize - overflow properties: queueSize: type: number example: 50 description: The maximum number of calls for this call queue. Once this number is reached, the `overflow` settings are triggered. callOfferToneEnabled: type: boolean example: true description: Play ringing tone to callers when their call is set to an available agent. resetCallStatisticsEnabled: type: boolean description: Reset caller statistics upon queue entry. overflow: type: object required: - action - greeting properties: action: type: string enum: - PERFORM_BUSY_TREATMENT - PLAY_RINGING_UNTIL_CALLER_HANGS_UP - TRANSFER_TO_PHONE_NUMBER description: "Indicates how to handle new calls when the queue is full.\n * `PERFORM_BUSY_TREATMENT` - The caller hears a fast-busy tone.\n * `PLAY_RINGING_UNTIL_CALLER_HANGS_UP` - The caller hears ringing until they disconnect.\n * `TRANSFER_TO_PHONE_NUMBER` - Number where you want to transfer overflow calls.\n" sendToVoicemail: type: boolean description: When `true`, forwards all calls to a voicemail service of an internal number. This option is ignored when an external `transferNumber` is entered. transferNumber: type: string example: '+15555551212' description: Destination number for overflow calls when `action` is set to `TRANSFER_TO_PHONE_NUMBER`. overflowAfterWaitEnabled: type: boolean example: true description: After calls wait for the configured number of seconds and no agent is available, the overflow treatment is triggered. overflowAfterWaitTime: type: number example: 20 description: Number of seconds to wait before the overflow treatment is triggered when no agent is available. The minimum value 0, The maximum value is 7200 seconds. playOverflowGreetingEnabled: type: boolean example: true description: Indicate overflow audio to be played, otherwise, callers will hear the hold music until the call is answered by a user. greeting: type: string enum: - CUSTOM - DEFAULT description: "Indicates how to handle new calls when the queue is full.\n * `CUSTOM` - Play the custom announcement specified by the `fileName` field.\n * `DEFAULT` - Play default announcement.\n" audioAnnouncementFiles: type: array items: $ref: '#/components/schemas/AnnouncementAudioFile' description: Array of announcement files to be played as `overflow` greetings. These files are from the list of announcement files associated with this call queue. For `CUSTOM` announcement, a minimum of 1 file is mandatory, and the maximum is 4. description: Settings for incoming calls exceed queueSize. welcomeMessage: type: object required: - greeting properties: enabled: type: boolean example: true description: If enabled play entrance message. The default value is `true`. alwaysEnabled: type: boolean description: Mandatory entrance message. The default value is `false`. greeting: type: string enum: - CUSTOM - DEFAULT description: "Indicates how to handle new calls when the queue is full.\n * `CUSTOM` - Play the custom announcement specified by the `fileName` field.\n * `DEFAULT` - Play default announcement.\n" audioAnnouncementFiles: type: array items: $ref: '#/components/schemas/AnnouncementAudioFile' description: Array of announcement files to be played as `welcomeMessage` greetings. These files are from the list of announcement files associated with this call queue. For `CUSTOM` announcement, a minimum of 1 file is mandatory, and the maximum is 4. description: Play a message when callers first reach the queue. For example, “Thank you for calling. An agent will be with you shortly.” It can be set as mandatory. If the mandatory option is not selected and a caller reaches the call queue while there is an available agent, the caller will not hear this announcement and is transferred to an agent. The welcome message feature is enabled by default. waitMessage: type: object required: - waitMode properties: enabled: type: boolean example: true description: If enabled play Wait Message. waitMode: type: string enum: - TIME - POSITION description: "Estimated wait message operating mode. Supported values `TIME` and `POSITION`.\n * `TIME` - Announce the waiting time.\n * `POSITION` - Announce queue position.\n" handlingTime: type: number example: 100 description: The number of minutes for which the estimated wait is played. The minimum time is 10 minutes. The maximum time is 100 minutes. defaultHandlingTime: type: number example: 100 description: The default number of call handling minutes. The minimum time is 1 minutes, The maximum time is 100 minutes. queuePosition: type: number example: 100 description: The number of the position for which the estimated wait is played. The minimum positions are 10, The maximum positions are 100. highVolumeMessageEnabled: type: boolean description: Play time / Play position High Volume. estimatedWaitingTime: type: number example: 600 description: The number of estimated waiting times in seconds. The minimum time is 10 seconds. The maximum time is 600 seconds. callbackOptionEnabled: type: boolean description: Callback options enabled/disabled. Default value is false. minimumEstimatedCallbackTime: type: number example: 10 description: The minimum estimated callback times in minutes. The default value is 30. internationalCallbackEnabled: type: boolean description: The international numbers for callback is enabled/disabled. The default value is `false`. playUpdatedEstimatedWaitMessage: type: boolean example: true description: Play updated estimated wait message. description: Notify the caller with either their estimated wait time or position in the queue. If this option is enabled, it plays after the welcome message and before the comfort message. By default, it is not enabled. comfortMessage: type: object required: - greeting properties: enabled: type: boolean example: true description: If enabled play periodic comfort message. timeBetweenMessages: type: number example: 10 description: The interval in seconds between each repetition of the comfort message played to queued users. The minimum time is 10 seconds.The maximum time is 600 seconds. greeting: type: string enum: - CUSTOM - DEFAULT description: "Indicates how to handle new calls when the queue is full.\n * `CUSTOM` - Play the custom announcement specified by the `fileName` field.\n * `DEFAULT` - Play default announcement.\n" audioAnnouncementFiles: type: array items: $ref: '#/components/schemas/AnnouncementAudioFile' description: Array of announcement files to be played as `comfortMessage` greetings. These files are from the list of announcement files associated with this call queue. For `CUSTOM` announcement, a minimum of 1 file is mandatory, and the maximum is 4. description: Play a message after the welcome message and before hold music. This is typically a `CUSTOM` announcement that plays information, such as current promotions or information about products and services. comfortMessageBypass: type: object required: - greeting properties: enabled: type: boolean example: true description: If enabled play comfort bypass message. callWaitingAgeThreshold: type: number example: 10 description: The interval in seconds between each repetition of the comfort bypass message played to queued users. The minimum time is 1 seconds. The maximum time is 120 seconds. greeting: type: string enum: - CUSTOM - DEFAULT description: "Indicates how to handle new calls when the queue is full.\n * `CUSTOM` - Play the custom announcement specified by the `fileName` field.\n * `DEFAULT` - Play default announcement.\n" audioAnnouncementFiles: type: array items: $ref: '#/components/schemas/AnnouncementAudioFile' description: Array of announcement files to be played as `comfortMessageBypass` greetings. These files are from the list of announcements files associated with this call queue. For `CUSTOM` announcement, a minimum of 1 file is mandatory, and the maximum is 4. description: Play a shorter comfort message instead of the usual Comfort or Music On Hold announcement to all the calls that should be answered quickly. This feature prevents a caller from hearing a short portion of the standard comfort message that abruptly ends when they are connected to an agent. mohMessage: type: object required: - normalSource - alternateSource properties: normalSource: type: object required: - greeting properties: enabled: type: boolean example: true description: Enable media on hold for queued calls. greeting: type: string enum: - CUSTOM - DEFAULT description: "Indicates how to handle new calls when the queue is full.\n * `CUSTOM` - Play the custom announcement specified by the `fileName` field.\n * `DEFAULT` - Play default announcement.\n" audioAnnouncementFiles: type: array items: $ref: '#/components/schemas/AnnouncementAudioFile' description: Array of announcement files to be played as `mohMessage` greetings. These files are from the list of announcement files associated with this call queue. For `CUSTOM` announcement, a minimum of 1 file is mandatory, and the maximum is 4. audioPlaylistId: type: string description: Identifier of the playlist used for this MOH source. alternateSource: type: object required: - greeting properties: enabled: type: boolean example: true description: Enable media on hold for queued calls. greeting: type: string enum: - CUSTOM - DEFAULT description: "Indicates how to handle new calls when the queue is full.\n * `CUSTOM` - Play the custom announcement specified by the `fileName` field.\n * `DEFAULT` - Play default announcement.\n" audioAnnouncementFiles: type: array items: $ref: '#/components/schemas/AnnouncementAudioFile' description: Array of announcement files to be played as `mohMessage` greetings. These files are from the list of announcement files associated with this call queue. For `CUSTOM` announcement, a minimum of 1 file is mandatory, and the maximum is 4. audioPlaylistId: type: string description: Identifier of the playlist used for this MOH source. description: Play music after the comforting message in a repetitive loop. whisperMessage: type: object required: - greeting properties: enabled: type: boolean example: true description: If enabled play the Whisper Message. greeting: type: string enum: - CUSTOM - DEFAULT description: "Indicates how to handle new calls when the queue is full.\n * `CUSTOM` - Play the custom announcement specified by the `fileName` field.\n * `DEFAULT` - Play default announcement.\n" audioAnnouncementFiles: type: array items: $ref: '#/components/schemas/AnnouncementAudioFile' description: Array of announcement files to be played as `whisperMessage` greetings. These files are from the list of announcement files associated with this call queue. For `CUSTOM` announcement, a minimum of 1 file is mandatory, and the maximum is 4. description: Play a message to the agent immediately before the incoming call is connected. The message typically announces the identity of the call queue from which the call is coming. GetAnnouncementFileInfo: type: object required: - id - fileName - fileSize - mediaFileType - level - isTextToSpeech properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9kODc5YWZlZC1jNTRhLTQyOTctOGY0Mi02ZmEyMDJjN2E1M2E description: ID of the announcement. fileName: type: string example: Greeting-1.wav description: Name of greeting file. fileSize: type: string example: '33456' description: Size of greeting file in kilo-bytes. mediaFileType: $ref: '#/components/schemas/mediaType' description: Media file type of the announcement. level: $ref: '#/components/schemas/level' description: Level where the announcement is created. isTextToSpeech: type: boolean description: Indicates whether the announcement is a text-to-speech file. ListSupervisorObject: type: object required: - id - agentCount properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS81OGVkZTIwNi0yNTM5LTQ1ZjQtODg4Ny05M2E3ZWIwZWI3ZDI description: A unique identifier for the supervisor. firstName: type: string example: John description: First name of the supervisor. lastName: type: string example: Smith description: Last name of the supervisor. phoneNumber: type: string example: '+19845550186' description: Primary phone number of the supervisor. extension: type: string example: '12554' description: Primary phone extension of the supervisor. routingPrefix: type: string example: '34' description: Routing prefix of location. esn: type: string example: '3412554' description: Routing prefix + extension of a person. agentCount: type: integer example: 2 description: Number of agents managed by supervisor. A supervisor must manage at least one agent. GetCallQueueStrandedCallsObject: type: object required: - action - audioMessageSelection properties: action: type: string enum: - NONE - BUSY - TRANSFER - NIGHT_SERVICE - RINGING - ANNOUNCEMENT description: "The call processing action type.\n * `NONE` - Call remains in the queue.\n * `BUSY` - Calls are removed from the queue and are provided with the Busy treatment. If the queue is configured with the Call Forwarding Busy or the Voice Messaging service, then the call is handled accordingly.\n * `TRANSFER` - Calls are removed from the queue and are transferred to the configured `transferPhoneNumber`.\n * `NIGHT_SERVICE` - Calls are handled according to the Night Service configuration. If the Night Service action is set to `none`, then this is equivalent to this policy being set to `none` (that is, calls remain in the queue).\n * `RINGING` - Calls are removed from the queue and are provided with ringing until the caller releases the call. The ringback tone played to the caller is localized according to the country code of the caller.\n * `ANNOUNCEMENT` - Calls are removed from the queue and are provided with an announcement that is played in a loop until the caller releases the call.\n" transferPhoneNumber: type: string example: '1235557890' description: Call gets transferred to this number when action is set to `TRANSFER`. This can also be an extension. audioMessageSelection: type: string enum: - DEFAULT - CUSTOM description: "The type of announcement to be played.\n * `DEFAULT` - Default Audio Message Selection.\n * `CUSTOM` - Custom Audio Message Selection.\n" audioFiles: type: array items: $ref: '#/components/schemas/AudioAnnouncementFileFeatureGetObject' description: List of Announcement Audio Files when `audioMessageSelection` is `CUSTOM`. GetCallQueueNightServiceObject: type: object required: - nightServiceEnabled - playAnnouncementBeforeEnabled - announcementMode - audioMessageSelection - forceNightServiceEnabled - manualAudioMessageSelection properties: nightServiceEnabled: type: boolean example: true description: Whether or not the call queue night service routing policy is enabled. action: type: string enum: - BUSY - TRANSFER description: "The call processing action type.\n * `BUSY` - The caller hears a fast busy tone.\n * `TRANSFER` - Transfers the call to number specified in `transferPhoneNumber`.\n" transferPhoneNumber: type: string example: '1234' description: Call gets transferred to this number when action is set to `TRANSFER`. This can also be an extension. playAnnouncementBeforeEnabled: type: boolean example: true description: Indicates whether an announcement plays to callers before the action is applied. announcementMode: type: string enum: - NORMAL - MANUAL description: "The type of announcements to played.\n * `NORMAL` - Plays announcement as per `audioMessageSelection`.\n * `MANUAL` - Plays announcement as per `manualAudioMessageSelection`.\n" audioMessageSelection: type: string enum: - DEFAULT - CUSTOM description: "The type of announcements to be played when announcementMode is set to `NORMAL`.\n * `DEFAULT` - Default Audio Message Selection.\n * `CUSTOM` - Custom Audio Message Selection.\n" audioFiles: type: array items: $ref: '#/components/schemas/AudioAnnouncementFileFeatureGetObject' description: List of Announcement Audio Files when `audioMessageSelection` is `CUSTOM`. businessHoursName: type: string example: Working Hour description: Name of the schedule configured for a night service as one of from `businessHourSchedules` list. businessHoursLevel: type: string enum: - ORGANIZATION - LOCATION description: "The above mentioned schedule is org or location specific. (Must be from `businessHourSchedules` list).\n * `ORGANIZATION` - Schedule is configured across an organization.\n * `LOCATION` - Schedule is configured across a location.\n" businessHourSchedules: type: array items: $ref: '#/components/schemas/CallQueueNightSchedulesObject' description: Lists the pre-configured business hour schedules. forceNightServiceEnabled: type: boolean example: true description: Force night service regardless of business hour schedule. manualAudioMessageSelection: type: string enum: - DEFAULT - CUSTOM description: "The type of announcements to be played when announcementMode is set to NORMAL.`MANUAL`.\n * `DEFAULT` - Default Audio Message Selection.\n * `CUSTOM` - Custom Audio Message Selection.\n" manualAudioFiles: type: array items: $ref: '#/components/schemas/AudioAnnouncementFileFeatureGetObject' description: List Of Audio Files. ModifyCallQueueObject: type: object required: - queueSettings properties: enabled: type: boolean example: true description: Whether or not the call queue is enabled. name: type: string example: CallQueue-1 description: Unique name for the call queue. languageCode: type: string example: en-US description: Language code. firstName: type: string example: Hakim description: First name to be shown when calls are forwarded out of this call queue. Defaults to `.`. This field has been deprecated. Please use `directLineCallerIdName` and `dialByName` instead. lastName: type: string example: Smith description: Last name to be shown when calls are forwarded out of this call queue. Defaults to the `phoneNumber` if set, otherwise defaults to call group name. This field has been deprecated. Please use `directLineCallerIdName` and `dialByName` instead. timeZone: type: string example: America/Chicago description: Time zone for the hunt group. phoneNumber: type: string example: '+12225555309' description: Primary phone number of the call queue. extension: type: string example: '5309' description: Extension of the call queue. alternateNumberSettings: type: object properties: distinctiveRingEnabled: type: boolean example: true description: Distinctive Ringing selected for the alternate numbers in the call queue overrides the normal ringing patterns set for Alternate Numbers. alternateNumbers: type: array items: $ref: '#/components/schemas/AlternateNumbersWithPattern' description: Allows up to 10 numbers, each with an optional distinctive ring setting override. description: The alternate numbers feature allows you to assign multiple phone numbers or extensions to a call queue. Each number will reach the same greeting and each menu will function identically to the main number. The alternate numbers option enables you to have up to ten (10) phone numbers ring into the call queue. callPolicies: $ref: '#/components/schemas/ModifyCallQueueCallPolicyObject' description: Policy controlling how calls are routed to agents. callingLineIdPolicy: type: string enum: - DIRECT_LINE - LOCATION_NUMBER - CUSTOM description: "Which type of Calling Line ID Policy Selected for Call Queue.\n * `DIRECT_LINE` - Calling Line ID Policy will show the caller's direct line number.\n * `LOCATION_NUMBER` - Calling Line ID Policy will show the main number for the location.\n * `CUSTOM` - Calling Line ID Policy will show the value from the `callingLineIdPhoneNumber` field.\n" callingLineIdPhoneNumber: type: string example: '+12072342368' description: Calling line ID Phone number which will be shown if CUSTOM is selected. queueSettings: $ref: '#/components/schemas/CallQueueQueueSettingsObject' description: Overall call queue settings. allowCallWaitingForAgentsEnabled: type: boolean description: Flag to indicate whether call waiting is enabled for agents. agents: type: array items: $ref: '#/components/schemas/ModifyPersonPlaceVirtualLineCallQueueObject' description: People, workspaces and virtual lines that are eligible to receive calls. allowAgentJoinEnabled: type: boolean description: Whether or not to allow agents to join or unjoin a queue. phoneNumberForOutgoingCallsEnabled: type: boolean example: true description: When `true`, indicates that the agent's configuration allows them to use the queue's Caller ID for outgoing calls. directLineCallerIdName: $ref: '#/components/schemas/DirectLineCallerIdNameObjectForPut' description: Settings for the direct line caller ID name to be shown for this call queue. dialByName: type: string example: Hakim Smith description: Sets or clears the name to be used for dial by name functions. To clear the `dialByName`, the attribute must be set to null or empty string. Characters of `%`, `+`, `\`, `"` and Unicode characters are not allowed. ModifyForwardingRuleObject: type: object properties: name: type: string example: New Selective Rule description: Unique name for the selective rule in the hunt group. enabled: type: boolean example: true description: Reflects if rule is enabled. holidaySchedule: type: string example: HolidayScheduleOne description: Name of the location's holiday schedule which determines when this selective call forwarding rule is in effect. businessSchedule: type: string example: BusinessScheduleTwo description: Name of the location's business schedule which determines when this selective call forwarding rule is in effect. forwardTo: type: object properties: selection: type: string enum: - FORWARD_TO_DEFAULT_NUMBER - FORWARD_TO_SPECIFIED_NUMBER - DO_NOT_FORWARD description: "Controls what happens when the rule matches.\n * `FORWARD_TO_DEFAULT_NUMBER` - When the rule matches, forward to the destination for the hunt group.\n * `FORWARD_TO_SPECIFIED_NUMBER` - When the rule matches, forward to the destination for this rule.\n * `DO_NOT_FORWARD` - When the rule matches, do not forward to another number.\n" phoneNumber: type: string example: '+15558675309' description: Phone number used if selection is `FORWARD_TO_SPECIFIED_NUMBER`. description: Controls what happens when the rule matches including the destination number for the call forwarding. callsFrom: type: object properties: selection: type: string enum: - ANY - CUSTOM description: "If `CUSTOM`, use `customNumbers` to specific which incoming caller ID values cause this rule to match. `ANY` means any incoming call matches assuming the rule is in effect based on the associated schedules.\n * `ANY` - Rule matches for calls from any number.\n * `CUSTOM` - Rule matches based on the numbers and options in `customNumbers`.\n" customNumbers: type: object properties: privateNumberEnabled: type: boolean description: Match if caller ID indicates the call is from a private number. unavailableNumberEnabled: type: boolean description: Match if caller ID is unavailable. numbers: type: array items: type: string description: Array of number strings to be matched against incoming caller ID. description: Custom rules for matching incoming caller ID information. description: Settings related the rule matching based on incoming caller ID. callsTo: type: object properties: numbers: type: array items: $ref: '#/components/schemas/CallForwardingNumbers' description: Array of numbers to be matched against the calling destination number. description: Settings related to the rule matching based on the destination number. DirectLineCallerIdNameObjectForPut: type: object properties: selection: $ref: '#/components/schemas/SelectionObject' description: The selection of the direct line caller ID name. customName: type: string example: Hakim Smith description: Sets or clears the custom direct line caller ID name. To clear the `customName`, the attribute must be set to null or empty string. Required if `selection` is set to `CUSTOM_NAME`. description: Settings for the direct line caller ID name to be shown for this workspace. TelephonyType: type: string enum: - PSTN_NUMBER description: ' * `PSTN_NUMBER` - The object is a PSTN number. ' RingPatternObject: type: string enum: - NORMAL - LONG_LONG - SHORT_SHORT_LONG - SHORT_LONG_SHORT description: " * `NORMAL` - Normal incoming ring pattern.\n * `LONG_LONG` - Incoming ring pattern of two long rings.\n * `SHORT_SHORT_LONG` - Incoming ring pattern of two short rings, followed by a short ring.\n * `SHORT_LONG_SHORT` - Incoming ring pattern of a short ring, followed by a long ring, followed by a short ring.\n" CallForwardingNumbers: type: object required: - type properties: phoneNumber: type: string example: '+15558675309' description: Only return call queues with matching primary phone number or extension. extension: type: string example: '7781' description: Primary phone extension of the call queue. type: type: string enum: - PRIMARY - ALTERNATE description: "Type of\n * `PRIMARY` - Indicates that the given `phoneNumber` or `extension` associated with this rule's containing object is a primary number or extension.\n * `ALTERNATE` - Indicates that the given `phoneNumber` or `extension` associated with this rule's containing object is an alternate number or extension.\n" PutPersonPlaceVirtualLineAgentObject: type: object required: - id - action properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS81OGVkZTIwNi0yNTM5LTQ1ZjQtODg4Ny05M2E3ZWIwZWI3ZDI description: 'ID of person, workspace or virtual line. **WARNING**: The `id` returned is always of type `PEOPLE` even if the agent is a workspace or virtual line. The `type` of the agent `id` will be corrected in a future release.' action: $ref: '#/components/schemas/AgentAction' description: Enumeration that indicates whether an agent needs to be added (`ADD`) or deleted (`DELETE`) from a supervisor. securitySchemes: oauth2: flows: authorizationCode: authorizationUrl: / scopes: {} tokenUrl: / type: oauth2 bearer-key: type: http description: e.g. Bearer YOUR_AUTHORIZATION_TOKEN scheme: bearer bearerFormat: JWT bearerAuth: type: oauth2 description: OAuth 2.0 Bearer token authentication flows: authorizationCode: authorizationUrl: https://webexapis.com/v1/authorize tokenUrl: https://webexapis.com/v1/access_token scopes: spark:applications_token: Create access tokens for Service Apps