openapi: 3.0.0 info: title: 'Webex Admin Address Book Features: Hunt Group 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: Hunt Group' paths: /telephony/config/huntGroups: get: responses: '200': description: OK headers: Link: schema: type: string content: application/json: schema: type: object required: - huntGroups properties: huntGroups: type: array items: $ref: '#/components/schemas/ListHuntGroupObject' description: Array of hunt groups. example: huntGroups: - id: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0 name: '5714328359' locationName: WXCSIVDKCPAPIC4S1 locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx routingPrefix: '123' esn: '1239097' enabled: true - id: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYVhZd2QySTJNbmM1YWtBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0 name: bram locationName: Brampton locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzQwMjgw phoneNumber: '+15558675309' routingPrefix: '123' esn: '1239097' 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 Hunt Groups operationId: listHuntGroups description: 'List all calling Hunt Groups for the organization. Hunt groups can route incoming calls to a group of people or workspaces. You can even configure a pattern to route to a whole group. Retrieving this list requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - 'Features: Hunt Group' parameters: - name: orgId in: query description: List hunt groups for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: locationId in: query description: Only return hunt groups with matching location ID. 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: Only return hunt groups with the matching name. example: Customer Support schema: type: string - name: phoneNumber in: query description: Only return hunt groups with the matching primary phone number or extension. example: '+15558675309' schema: type: string /telephony/config/locations/{locationId}/huntGroups: post: responses: '200': description: OK headers: {} content: application/json: schema: type: object required: - id properties: id: type: string description: ID of the newly created hunt group. 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 Hunt Group operationId: createHuntGroup description: 'Create new Hunt Groups for the given location. Hunt groups can route incoming calls to a group of people, workspaces or virtual lines. You can even configure a pattern to route to a whole group. Creating a hunt group requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - 'Features: Hunt Group' parameters: - name: locationId in: path description: Create the hunt group for the given location. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg5LWVhMzMtNDc1Ny1iMTBmLWQ2MWIyNzFhMDVlZg schema: type: string - name: orgId in: query description: Create the hunt group for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: name: '5714328359' phoneNumber: '+15558675309' extension: '7781' firstName: Hakim lastName: Smith callPolicies: policy: UNIFORM waitingEnabled: false groupBusyEnabled: true allowMembersToControlGroupBusyEnabled: true noAnswer: nextAgentEnabled: false nextAgentRings: 5 forwardEnabled: false numberOfRings: 0 destinationVoicemailEnabled: false busyRedirect: enabled: true destination: '7037344404' destinationVoicemailEnabled: true businessContinuityRedirect: enabled: true destination: '7037344405' destinationVoicemailEnabled: false agents: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS80YTc2ZmVmNC1mZjlmLTExZWItYWYwZC00M2YwZjY1NTdjYWI - id: Y2lzY29zcGFyazovL3VzL1BMQUNFLzU1YjUyZThhLWZmOWYtMTFlYi05ZjRhLTAzZDY1NzdhYzg1Yg - id: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS9kZXRhMXZqeTBsQDY0OTQxMjk3LmludDEwLmJjbGQud2ViZXguY29t enabled: true huntGroupCallerIdForOutgoingCallsEnabled: true directLineCallerIdName: selection: CUSTOM_NAME customName: Hakim Smith dialByName: Hakim Smith schema: $ref: '#/components/schemas/CreateHuntGroupObject' /telephony/config/locations/{locationId}/huntGroups/{huntGroupId}: 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 Hunt Group operationId: deleteHuntGroup description: 'Delete the designated Hunt Group. Hunt groups can route incoming calls to a group of people or workspaces. You can even configure a pattern to route to a whole group. Deleting a hunt group requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - 'Features: Hunt Group' parameters: - name: locationId in: path description: Location from which to delete a hunt group. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx schema: type: string - name: huntGroupId in: path description: Delete the hunt group with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0 schema: type: string - name: orgId in: query description: Delete the hunt group from this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetHuntGroupObject' example: id: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0 name: hgnME3 enabled: true extension: 079999 distinctiveRing: true alternateNumbers: [] language: English languageCode: en-US callingFirstName: . callingLastName: hgnME3 timeZone: America/Los_Angeles callPolicies: policy: UNIFORM waitingEnabled: false groupBusyEnabled: true allowMembersToControlGroupBusyEnabled: true noAnswer: nextAgentEnabled: false nextAgentRings: 5 forwardEnabled: false numberOfRings: 0 systemMaxNumberOfRing: 20 destinationVoicemailEnabled: false busyRedirect: enabled: true destination: '7037344404' destinationVoicemailEnabled: true businessContinuityRedirect: enabled: true destination: '7037344405' destinationVoicemailEnabled: false agents: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS80YTc2ZmVmNC1mZjlmLTExZWItYWYwZC00M2YwZjY1NTdjYWI firstName: John lastName: Doe type: PEOPLE phoneNumber: '+15558675310' extension: '7781' routingPrefix: '123' esn: '1237781' - id: Y2lzY29zcGFyazovL3VzL1BMQUNFLzg0YjQ1OTIyLWZmOWYtMTFlYi1hNGI4LTMzNjI3YmVkNjdiNQ firstName: Alaska Office lastName: Second Floor type: PLACE phoneNumber: '+15558675311' extension: '7781' routingPrefix: '123' esn: '1237781' - id: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS83MGY2MzYzMC1mZjlmLTExZWItODU5YS0xZjhiYjRjNzc3OGg= firstName: Alice lastName: Smith type: VIRTUAL_LINE phoneNumber: '+15558675311' extension: '7782' routingPrefix: '123' esn: '1237781' huntGroupCallerIdForOutgoingCallsEnabled: true 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 Hunt Group operationId: getHuntGroup description: 'Retrieve Hunt Group details. Hunt groups can route incoming calls to a group of people, workspaces or virtual lines. You can even configure a pattern to route to a whole group. Retrieving hunt group details requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - 'Features: Hunt Group' parameters: - name: locationId in: path description: Retrieve settings for a hunt group in this location. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg5LWVhMzMtNDc1Ny1iMTBmLWQ2MWIyNzFhMDVlZg schema: type: string - name: huntGroupId in: path description: Retrieve settings for the hunt group with this identifier. required: true example: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0 schema: type: string - name: orgId in: query description: Retrieve hunt group 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 Hunt Group operationId: updateHuntGroup description: 'Update the designated Hunt Group. Hunt groups can route incoming calls to a group of people, workspaces or virtual lines. You can even configure a pattern to route to a whole group. Updating a hunt group requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - 'Features: Hunt Group' parameters: - name: locationId in: path description: Update the hunt group for this location. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg5LWVhMzMtNDc1Ny1iMTBmLWQ2MWIyNzFhMDVlZg schema: type: string - name: huntGroupId in: path description: Update settings for the hunt group with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0 schema: type: string - name: orgId in: query description: Update hunt group settings from this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: name: '5714328359' phoneNumber: '+15558675309' extension: '7781' firstName: Hakim lastName: Smith callPolicies: policy: UNIFORM waitingEnabled: false groupBusyEnabled: true allowMembersToControlGroupBusyEnabled: true noAnswer: nextAgentEnabled: false nextAgentRings: 5 forwardEnabled: false numberOfRings: 0 destinationVoicemailEnabled: false busyRedirect: enabled: true destination: '7037344404' destinationVoicemailEnabled: false businessContinuityRedirect: enabled: true destination: '7037344405' destinationVoicemailEnabled: false agents: - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82YTUwMDk1YS1mZjlmLTExZWItODA2NS04ZjhkOWIxNmIzOTQ - id: Y2lzY29zcGFyazovL3VzL1BMQUNFLzg0YjQ1OTIyLWZmOWYtMTFlYi1hNGI4LTMzNjI3YmVkNjdiNQ enabled: true huntGroupCallerIdForOutgoingCallsEnabled: true directLineCallerIdName: selection: CUSTOM_NAME customName: Hakim Smith dialByName: Hakim Smith schema: $ref: '#/components/schemas/ModifyHuntGroupObject' /telephony/config/locations/{locationId}/huntGroups/{huntGroupId}/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 Hunt Group operationId: getHuntGroupCallForwardingSettings description: 'Retrieve Call Forwarding settings for the specified Hunt Group 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 hunt group requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - 'Features: Hunt Group' parameters: - name: locationId in: path description: Location in which this hunt group exists. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx schema: type: string - name: huntGroupId in: path description: Read the call forwarding settings for this hunt group. required: true example: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvMzk1ODc4ZGEtZmZmZS00YTI2LWJlOTctMjdhZmZmOTgxYTIy schema: type: string - name: orgId in: query description: Retrieve hunt group 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 Hunt Group operationId: updateHuntGroupCallForwardingSettings description: 'Update Call Forwarding settings for the specified Hunt Group. 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 hunt group requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - 'Features: Hunt Group' parameters: - name: locationId in: path description: Location from which this hunt group exists. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx schema: type: string - name: huntGroupId in: path description: Update call forwarding settings for this hunt group. required: true example: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvMzk1ODc4ZGEtZmZmZS00YTI2LWJlOTctMjdhZmZmOTgxYTIy schema: type: string - name: orgId in: query description: Update hunt group 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}/huntGroups/{huntGroupId}/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 hunt group. 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 Hunt Group operationId: createHuntGroupSelectiveCallForwardingRule description: 'Create a Selective Call Forwarding Rule for the designated Hunt Group. A selective call forwarding rule for a hunt group 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 hunt group''s call forwarding settings. Creating a selective call forwarding rule for a hunt group 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: Hunt Group' parameters: - name: locationId in: path description: Location in which this hunt group exists. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx schema: type: string - name: huntGroupId in: path description: Create the rule for this hunt group. required: true example: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0 schema: type: string - name: orgId in: query description: Create the hunt group 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_SPECIFIED_NUMBER phoneNumber: '+12056350001' enabled: true schema: $ref: '#/components/schemas/CreateForwardingRuleObject' /telephony/config/locations/{locationId}/huntGroups/{huntGroupId}/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 Hunt Group operationId: getHuntGroupSelectiveCallForwardingRule description: 'Retrieve a Selective Call Forwarding Rule''s settings for the designated Hunt Group. A selective call forwarding rule for a hunt group 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 hunt group''s call forwarding settings. Retrieving a selective call forwarding rule''s settings for a hunt group 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: Hunt Group' parameters: - name: locationId in: path description: Location in which this hunt group exists. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx schema: type: string - name: huntGroupId in: path description: Retrieve settings for a rule for this hunt group. required: true example: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0 schema: type: string - name: ruleId in: path description: Hunt group rule you are retrieving settings for. required: true example: Y2lzY29zcGFyazovL3VzL0NBTExfRk9SV0FSRElOR19TRUxFQ1RJVkVfUlVMRS9RbTlp schema: type: string - name: orgId in: query description: Retrieve hunt group 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 Hunt Group operationId: updateHuntGroupSelectiveCallForwardingRule description: 'Update a Selective Call Forwarding Rule''s settings for the designated Hunt Group. A selective call forwarding rule for a hunt group 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 hunt group''s call forwarding settings. Updating a selective call forwarding rule''s settings for a hunt group 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: Hunt Group' parameters: - name: locationId in: path description: Location in which this hunt group exists. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx schema: type: string - name: huntGroupId in: path description: Update settings for a rule for this hunt group. required: true example: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0 schema: type: string - name: ruleId in: path description: Hunt group rule you are updating settings for. required: true example: Y2lzY29zcGFyazovL3VzL0NBTExfRk9SV0FSRElOR19TRUxFQ1RJVkVfUlVMRS9RbTlp schema: type: string - name: orgId in: query description: Update hunt group 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 Hunt Group operationId: deleteHuntGroupSelectiveCallForwardingRule description: 'Delete a Selective Call Forwarding Rule for the designated Hunt Group. A selective call forwarding rule for a hunt group 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 hunt group''s call forwarding settings. Deleting a selective call forwarding rule for a hunt group 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: Hunt Group' parameters: - name: locationId in: path description: Location in which this hunt group exists. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx schema: type: string - name: huntGroupId in: path description: Delete the rule for this hunt group. required: true example: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0 schema: type: string - name: ruleId in: path description: Hunt group rule you are deleting. required: true example: Y2lzY29zcGFyazovL3VzL0NBTExfRk9SV0FSRElOR19TRUxFQ1RJVkVfUlVMRS9RbTlp schema: type: string - name: orgId in: query description: Delete hunt group rule from this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/locations/{locationId}/huntGroups/availableNumbers: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/HuntGroupPrimaryAvailableNumberListGetObject' example: phoneNumbers: - phoneNumber: '+12056350001' state: ACTIVE isMainNumber: false telephonyType: PSTN_NUMBER tollFreeNumber: false isServiceNumber: false - phoneNumber: '+12056350002' state: ACTIVE isMainNumber: true telephonyType: PSTN_NUMBER tollFreeNumber: false isServiceNumber: true - 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 Hunt Group Primary Available Phone Numbers operationId: getHuntGroupPrimaryAvailablePhoneNumbers description: 'List the service and standard PSTN numbers that are available to be assigned as the hunt group''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: Hunt Group' 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}/huntGroups/alternate/availableNumbers: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/HuntGroupAlternateAvailableNumberListGetObject' example: phoneNumbers: - phoneNumber: '+12056350001' state: ACTIVE isMainNumber: false telephonyType: PSTN_NUMBER tollFreeNumber: false isServiceNumber: false - phoneNumber: '+12056350002' state: ACTIVE isMainNumber: true telephonyType: PSTN_NUMBER tollFreeNumber: false isServiceNumber: true - 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 Hunt Group Alternate Available Phone Numbers operationId: getHuntGroupAlternateAvailablePhoneNumbers description: 'List the service and standard PSTN numbers that are available to be assigned as the hunt group''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: Hunt Group' 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}/huntGroups/callForwarding/availableNumbers: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/HuntGroupCallForwardAvailableNumberListGetObject' example: phoneNumbers: - phoneNumber: '+12056350001' state: ACTIVE isMainNumber: false telephonyType: PSTN_NUMBER tollFreeNumber: false isServiceNumber: false owner: id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk type: PEOPLE firstName: Test lastName: Person - phoneNumber: '+12056350002' extension: '1235' state: ACTIVE isMainNumber: true telephonyType: PSTN_NUMBER tollFreeNumber: false isServiceNumber: true 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 Hunt Group Call Forward Available Phone Numbers operationId: getHuntGroupCallForwardAvailablePhoneNumbers description: 'List the service and standard PSTN numbers that are available to be assigned as the hunt group''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: Hunt Group' 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/locations/{locationId}/huntGroups/{huntGroupId}/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 Hunt Group operationId: switchHuntGroupCallForwardingMode description: 'Switches the current operating mode of the `Hunt Group` 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 `hunt group` requires a full, or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - 'Features: Hunt Group' parameters: - name: locationId in: path description: '`Location` in which this `hunt group` exists.' required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA schema: type: string - name: huntGroupId in: path description: Switch operating mode to normal operations for this `hunt group`. required: true example: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvMzk1ODc4ZGEtZmZmZS00YTI2LWJlOTctMjdhZmZmOTgxYTIy schema: type: string - name: orgId in: query description: Switch operating mode as per normal operations for the `hunt group` from this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: {} schema: type: object properties: {} components: schemas: HuntGroupAlternateAvailableNumberListGetObject: type: object required: - phoneNumbers properties: phoneNumbers: type: array items: $ref: '#/components/schemas/HuntGroupAlternateAvailableNumberObject' description: Array of phone numbers. 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" PostPersonPlaceVirtualLineHuntGroupObject: 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`. 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. 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. GetPersonPlaceVirtualLineHuntGroupObject: type: object required: - id properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS80NDVkMzMzMC1mNjE3LTExZWItOWQyZS01NzViODE3ZGE1NmE description: ID of person, workspace or virtual line. firstName: type: string example: Hakim description: First name of person, workspace or virtual line. lastName: type: string example: Smith description: Last name of person, workspace or virtual line. phoneNumber: type: string example: '+15555551234' description: Phone number of person, workspace or virtual line. extension: type: string example: '1234' description: Extension of person, workspace or virtual line. routingPrefix: type: string example: '1234' description: Routing prefix of location. esn: type: string example: '12341234' description: Routing prefix + extension of a person or workspace. weight: type: string example: '50' description: Weight of person, workspace or virtual line. Only applied when call policy is `WEIGHTED`. 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. PostHuntGroupCallPolicyObject: type: object required: - policy - noAnswer properties: policy: $ref: '#/components/schemas/HuntPolicySelection' description: Call routing policy used to dispatch calls to agents. waitingEnabled: type: boolean example: true description: If `false`, then the option is treated as "Advance when busy". The hunt group won't ring agents when they're on a call and advances to the next agent. If a hunt group agent has call waiting enabled and the call is advanced to them, the call waits until that hunt group agent isn't busy. groupBusyEnabled: type: boolean example: true description: If `true`, the hunt group busy status will be set to busy. All new calls will get busy treatment. If `busyRedirect` is enabled, the calls are routed to the destination specified in `busyRedirect`. allowMembersToControlGroupBusyEnabled: type: boolean example: true description: If true, agents can change the hunt group busy status. noAnswer: type: object required: - nextAgentEnabled - nextAgentRings - forwardEnabled - numberOfRings - destinationVoicemailEnabled properties: nextAgentEnabled: type: boolean example: true description: If enabled, advance to next agent after the `nextAgentRings` has occurred. nextAgentRings: type: number example: 3 description: Number of rings before call will be forwarded if unanswered and `nextAgentEnabled` is true. forwardEnabled: type: boolean description: If `true`, forwards unanswered calls to the destination after the number of rings occurs. numberOfRings: type: number example: 15 description: Number of rings before forwarding calls if `forwardEnabled` is true. destination: type: string example: '2225551212' description: Destination if `forwardEnabled` is True. destinationVoicemailEnabled: type: boolean description: If `forwardEnabled` is true, enables and disables sending incoming to destination number's voicemail if the destination is an internal phone number and that number has the voicemail service enabled. If `destinationVoicemailEnabled` is enabled, then *55 is added as a prefix for `destination`. description: Settings for when the call into the hunt group is not answered. busyRedirect: type: object properties: enabled: type: boolean example: true description: If `true`, calls are diverted to a defined phone number when all agents are busy, or when the hunt group busy status is set to busy. destination: type: string example: '2225551212' description: Destination for busy redirect. destinationVoicemailEnabled: type: boolean description: The enabled or disabled state of sending diverted incoming calls to the `destination` number's voicemail if the `destination` is an internal phone number and that number has the voicemail service enabled. If `destinationVoicemailEnabled` is enabled, then *55 is added as a prefix for `destination`. description: Settings for sending calls to a specified destination when all agents are busy or when the hunt group busy status is set to busy. businessContinuityRedirect: type: object properties: enabled: type: boolean example: true description: If `true`, unreachable, unanswered calls are diverted to a defined phone number. For persons with only a mobile device, calls won't be diverted if there is a network outage. destination: type: string example: '2225551212' description: Destination for business continuity redirect. destinationVoicemailEnabled: type: boolean description: The enabled or disabled state of sending diverted incoming calls to the `destination` number's voicemail if the `destination` is an internal phone number and that number has the voicemail service enabled. If `destinationVoicemailEnabled` is enabled, then *55 is added as a prefix for `destination`. description: Settings for sending calls to a specified destination if the phone is not connected to the network for any reason, such as a power outage, failed internet connection, or wiring problem. HuntGroupAlternateAvailableNumberObject: 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. 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. ListHuntGroupObject: type: object required: - id - name - locationName - locationId - enabled properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0 description: A unique identifier for the hunt group. name: type: string example: '5714328359' description: Unique name for the hunt group. locationName: type: string example: WXCSIVDKCPAPIC4S1 description: Name of the location for the hunt group. locationId: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx description: ID of location for hunt group. phoneNumber: type: string example: '+15558675309' description: Primary phone number of the hunt group. extension: type: string example: '7781' description: Primary phone extension of the hunt group. routingPrefix: type: string example: '1234' description: Routing prefix of location. esn: type: string example: '12347781' description: Routing prefix + extension of a person or workspace. enabled: type: boolean example: true description: Whether or not the hunt group is enabled. HuntGroupCallForwardAvailableNumberListGetObject: type: object required: - phoneNumbers properties: phoneNumbers: type: array items: $ref: '#/components/schemas/HuntGroupCallForwardAvailableNumberObject' description: Array of phone numbers. GetHuntGroupObject: type: object required: - id - name - enabled - distinctiveRing - alternateNumbers - callPolicies - agents properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0 description: A unique identifier for the hunt group. name: type: string example: 5558675309-Group description: Unique name for the hunt group. enabled: type: boolean example: true description: Whether or not the hunt group is enabled. phoneNumber: type: string example: '+15558675309' description: Primary phone number of the hunt group. extension: type: string example: '7781' description: Extension of the hunt group. distinctiveRing: type: boolean example: true description: Whether or not the hunt group has the distinctive ring option enabled. alternateNumbers: type: array items: $ref: '#/components/schemas/AlternateNumbersWithPattern' description: The alternate numbers feature allows you to assign multiple phone numbers or extensions to a hunt group. 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 hunt group. language: type: string example: English description: Language for hunt group. languageCode: type: string example: en-US description: Language code for hunt group. firstName: type: string example: Hakim description: First name to be shown when calls are forwarded out of this hunt group. 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 hunt group. Defaults to phone number 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. callPolicies: $ref: '#/components/schemas/GetHuntGroupCallPolicyObject' description: Policy controlling how calls are routed to agents. agents: type: array items: $ref: '#/components/schemas/GetPersonPlaceVirtualLineHuntGroupObject' description: People, workspaces and virtual lines that are eligible to receive calls. huntGroupCallerIdForOutgoingCallsEnabled: type: boolean example: true description: Whether or not the hunt group can be used as the caller ID when the agent places outgoing calls. directLineCallerIdName: $ref: '#/components/schemas/DirectLineCallerIdNameObject' description: Settings for the direct line caller ID name to be shown for this hunt group. dialByName: type: string example: Hakim Smith description: The name to be used for dial by name functions. HuntGroupCallForwardAvailableNumberObject: 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`. GetHuntGroupCallPolicyObject: type: object required: - policy - noAnswer properties: policy: $ref: '#/components/schemas/HuntPolicySelection' description: Call routing policy used to dispatch calls to agents. waitingEnabled: type: boolean example: true description: If `false`, then the option is treated as "Advance when busy". The hunt group won't ring agents when they're on a call and advances to the next agent. If a hunt group agent has call waiting enabled and the call is advanced to them, the call waits until that hunt group agent isn't busy. groupBusyEnabled: type: boolean example: true description: When `true`, the hunt group busy status will be set to busy. All new calls will get busy treatment. If `busyRedirect` is enabled, the calls are routed to the destination specified in `busyRedirect`. allowMembersToControlGroupBusyEnabled: type: boolean example: true description: When `true`, agents can change the hunt group busy status. noAnswer: type: object required: - nextAgentEnabled - nextAgentRings - forwardEnabled - numberOfRings - systemMaxNumberOfRings - destinationVoicemailEnabled properties: nextAgentEnabled: type: boolean example: true description: If enabled, advance to next agent after the `nextAgentRings` has occurred. nextAgentRings: type: number example: 3 description: Number of rings before call will be forwarded if unanswered and `nextAgentEnabled` is true. forwardEnabled: type: boolean description: If `true`, forwards unanswered calls to the destination after the number of rings occurs. destination: type: string example: '2225551212' description: Destination if `forwardEnabled` is True. numberOfRings: type: number example: 15 description: Number of rings before forwarding calls if `forwardEnabled` is true. systemMaxNumberOfRings: type: number example: 15 description: System-wide maximum number of rings allowed for `numberOfRings` setting. destinationVoicemailEnabled: type: boolean description: If `destinationVoicemailEnabled` is true, enables and disables sending incoming to destination number's voicemail if the destination is an internal phone number and that number has the voicemail service enabled. description: Settings for when the call into the hunt group is not answered. busyRedirect: type: object properties: enabled: type: boolean example: true description: If `true`, calls are diverted to a defined phone number when all agents are busy, or when the hunt group busy status is set to busy. destination: type: string example: '2225551212' description: Destination for busy redirect. destinationVoicemailEnabled: type: boolean description: The enabled or disabled state of sending diverted incoming calls to the `destination` number's voicemail if the `destination` is an internal phone number and that number has the voicemail service enabled. description: Settings for sending calls to a specified destination when all agents are busy or when the hunt group busy status is set to busy. businessContinuityRedirect: type: object properties: enabled: type: boolean example: true description: If `true`, unreachable, unanswered calls are diverted to a defined phone number. For persons with only a mobile device, calls won't be diverted if there is a network outage. destination: type: string example: '2225551212' description: Destination for business continuity redirect. destinationVoicemailEnabled: type: boolean description: The enabled or disabled state of sending diverted incoming calls to the `destination` number's voicemail if the `destination` is an internal phone number and that number has the voicemail service enabled. description: Settings for sending calls to a specified destination if the phone is not connected to the network for any reason, such as a power outage, failed internet connection, or wiring problem. ModifyHuntGroupObject: type: object properties: enabled: type: boolean example: true description: Whether or not the hunt group is enabled. name: type: string example: 5558675309-Group description: Unique name for the hunt group. phoneNumber: type: string example: '+15558675309' description: Primary phone number of the hunt group. extension: type: string example: '7781' description: Primary phone extension of the hunt group. distinctiveRing: type: boolean example: true description: Whether or not the hunt group has the distinctive ring option enabled. alternateNumbers: type: array items: $ref: '#/components/schemas/AlternateNumbersWithPattern' description: The alternate numbers feature allows you to assign multiple phone numbers or extensions to a hunt group. 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 hunt group. 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 hunt group. 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 hunt group. Defaults to the phone number 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. callPolicies: $ref: '#/components/schemas/PostHuntGroupCallPolicyObject' description: Policy controlling how calls are routed to agents. agents: type: array items: $ref: '#/components/schemas/PostPersonPlaceVirtualLineHuntGroupObject' description: People, workspaces and virtual lines that are eligible to receive calls. huntGroupCallerIdForOutgoingCallsEnabled: type: boolean example: true description: Enable the hunt group to be used as the caller ID when the agent places outgoing calls. When set to true the hunt group's caller ID will be used. directLineCallerIdName: $ref: '#/components/schemas/DirectLineCallerIdNameObjectForPut' description: Settings for the direct line caller ID name to be shown for this hunt group. 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. 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. 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." HuntGroupPrimaryAvailableNumberListGetObject: type: object required: - phoneNumbers properties: phoneNumbers: type: array items: $ref: '#/components/schemas/HuntGroupPrimaryAvailableNumberObject' description: Array of phone numbers. 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. 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" HuntGroupPrimaryAvailableNumberObject: 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. 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. 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. 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" 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. 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. TelephonyType: type: string enum: - PSTN_NUMBER description: ' * `PSTN_NUMBER` - The object is a PSTN 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. 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. CreateHuntGroupObject: type: object required: - name - callPolicies - agents - enabled properties: name: type: string example: 5558675309-Group description: Unique name for the hunt group. phoneNumber: type: string example: '+15558675309' description: Primary phone number of the hunt group. Either phone number or extension are required. extension: type: string example: '7781' description: Primary phone extension of the hunt group. Either phone number or extension are required. 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 hunt group. 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 hunt group. Defaults to the phone number 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. callPolicies: $ref: '#/components/schemas/PostHuntGroupCallPolicyObject' description: Policy controlling how calls are routed to agents. agents: type: array items: $ref: '#/components/schemas/PostPersonPlaceVirtualLineHuntGroupObject' description: People, workspaces and virtual lines that are eligible to receive calls. enabled: type: boolean example: true description: Whether or not the hunt group is enabled. huntGroupCallerIdForOutgoingCallsEnabled: type: boolean example: true description: Enable the hunt group to be used as the caller ID when the agent places outgoing calls. When set to true the hunt group's caller ID will be used. directLineCallerIdName: $ref: '#/components/schemas/DirectLineCallerIdNameObject' description: Settings for the direct line caller ID name to be shown for this hunt group. 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. 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" 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