openapi: 3.0.0 info: title: Webex Admin Address Book Location Call Settings 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: Location Call Settings paths: /telephony/config/premisePstn/dialPlans/{dialPlanId}/dialPatterns: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object required: - dialPatterns properties: dialPatterns: type: array items: type: string description: Array of dial patterns. An enterprise dial pattern is represented by a sequence of digits (1-9), followed by optional wildcard characters. example: dialPatterns: [] '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 Dial Patterns operationId: Read the List of Dial Patterns description: 'List all Dial Patterns for the organization. Dial plans route calls to on-premises destinations by use of trunks or route groups. They are configured globally for an enterprise and apply to all users, regardless of location. A dial plan also specifies the routing choice (trunk or route group) for calls that match any of its dial patterns. Specific dial patterns can be defined as part of your dial plan. Retrieving this list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Location Call Settings parameters: - name: dialPlanId in: path description: ID of the dial plan. required: true example: Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI schema: type: string - name: orgId in: query description: ID of the organization to which the dial patterns belong. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: dialPattern in: query description: 'An enterprise dial pattern is represented by a sequence of digits (1-9), followed by optional wildcard characters. Valid wildcard characters are `!` (matches any sequence of digits) and `X` (matches a single digit, 0-9). The `!` wildcard can only occur once at the end and only in an E.164 pattern ' example: '+5555' 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: order in: query description: 'Order the dial patterns according to the designated fields. Available sort fields: `dialPattern`.' example: dialPattern-desc schema: type: string /telephony/config/locations: get: responses: '200': description: OK headers: Link: schema: type: string content: application/json: schema: type: object required: - locations properties: locations: type: array items: $ref: '#/components/schemas/ListLocationObject' description: Array of locations. example: locations: - id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2YyZmUzOGVkLTNmNGYtNGI1NC04M2YzLTk4MDg3MWQzMjM5Yw name: Denver routingPrefix: '3' outsideDialDigit: '1258' callingLineId: phoneNumber: '+12145556985' e911SetupRequired: false enforceOutsideDialDigit: true - id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzljYzc0NDgxLTk3ZjAtNDA1NS1iYTIxLWE0NDBkMjUzZTc3OA name: Denver-2 routingPrefix: '234' outsideDialDigit: '12' callingLineId: name: Denver Incoming phoneNumber: null e911SetupRequired: false enforceOutsideDialDigit: 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: List Locations Webex Calling Details operationId: List Locations Webex Calling Details description: 'Lists Webex Calling locations for an organization with Webex Calling details. Searching and viewing locations with Webex Calling details in your organization require an administrator auth token with the `spark-admin:telephony_config_read` scope.' tags: - Location Call Settings parameters: - name: orgId in: query description: List locations for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: max in: query description: Limit the maximum number of locations in the response. example: '100' schema: type: number - name: start in: query description: Specify the offset from the first result that you want to fetch. example: '0' schema: type: number - name: name in: query description: List locations whose name contains this string. example: Denver schema: type: string - name: order in: query description: Sort the list of locations based on `name`, either asc or desc. example: name-asc schema: type: string post: responses: '201': description: Created headers: {} content: application/json: schema: $ref: '#/components/schemas/LocationCallingResponseWithId' example: id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzljYTNhZmQ3LTE5MjYtNGQ0ZS05ZDA3LTk5ZDJjMGU4OGFhMA '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: Enable a Location for Webex Calling operationId: Enable a Location for Webex Calling description: 'Enable a location by adding it to Webex Calling. This add Webex Calling support to a location created created using the POST /v1/locations API. Locations are used to support calling features which can be defined at the location level. This API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Location Call Settings parameters: - name: orgId in: query description: ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg5LWVhMzMtNDc1Ny1iMTBmLWQ2MWIyNzFhMDVlZg name: Denver timeZone: America/Chicago announcementLanguage: fr_fr preferredLanguage: en_us address: address1: 771 Alder Drive address2: Cisco Site 5 city: Milpitas state: CA postalCode: '95035' country: US schema: $ref: '#/components/schemas/PostLocationCallingRequest' /telephony/config/locations/{locationId}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetTelephonyLocationObject' example: id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2M5N2VlMDQ5LTM1OWItNGM3OC04NDU0LTA1OGMyZWRlMjU2Mw name: Denver announcementLanguage: fr_fr routingPrefix: '2' callingLineId: name: Denver Incoming phoneNumber: '+12145555698' connection: type: TRUNK id: Y2lzY29zcGFyazovL3VzL1RSVU5LL2M1MGIxZjY2LTRjODMtNDAzNy04NjM1LTg2ZjlkM2VkZDQ5MQ subscriptionId: trial externalCallerIdName: Big Corp-Denver userLimit: 500000 outsideDialDigit: '12' pAccessNetworkInfo: Richardson-TX defaultDomain: 98079822.int10.bcld.webex.com chargeNumber: '+14158952369' enforceOutsideDialDigit: true useChargeNumberForPChargeInfo: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Location Webex Calling Details operationId: Get Location Webex Calling Details description: 'Shows Webex Calling details for a location, by ID. Specifies the location ID in the locationId parameter in the URI. Searching and viewing locations in your organization requires an administrator auth token with the spark-admin:telephony_config_read scope.' tags: - Location Call Settings parameters: - name: locationId in: path description: Retrieve Webex Calling location attributes for this location. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4NjczZDIwLWM0M2EtNDQ5Ni1iYWIxLTNiMjhhZGJjMjViYQ schema: type: string - name: orgId in: query description: Retrieve Webex Calling location attributes for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/LocationPUTResponse' example: batchJobId: Y2lzY29zcGFyazovL3VzL0pPQl9JRC8wOThmNTg5MC05MTA4LTQ0YWMtODIxMy1lYmE4MGI4YzJkMjA '204': description: No Content headers: {} content: {} '206': description: Partial Content headers: {} content: application/json: schema: $ref: '#/components/schemas/LocationPUTResponse' example: failureReason: 'UpdateRoutingPrefix batch job not triggered for Location: c7e4wasdfgjfec5c52. OldRoutingPrefix : 111. NewRoutingPrefix: 212.' '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.' headers: {} content: application/json: schema: $ref: '#/components/schemas/LocationPUTResponse' example: failureReason: UpdateRoutingPrefixJob failed as another one is already in progress. '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 Location Webex Calling Details operationId: Update Location Webex Calling Details description: 'Update Webex Calling details for a location, by ID. Specifies the location ID in the `locationId` parameter in the URI. Modifying the `connection` via API is only supported for the local PSTN types of `TRUNK` and `ROUTE_GROUP`. Updating a location in your organization requires an administrator auth token with the `spark-admin:telephony_config_write` scope.' tags: - Location Call Settings parameters: - name: locationId in: path description: Updating Webex Calling location attributes for this location. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4NjczZDIwLWM0M2EtNDQ5Ni1iYWIxLTNiMjhhZGJjMjViYQ schema: type: string - name: orgId in: query description: Updating Webex Calling location attributes for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: announcementLanguage: fr_fr outsideDialDigit: '12' routingPrefix: '212' callingLineId: name: Denver Incoming phoneNumber: '+12145555698' connection: type: TRUNK id: Y2lzY29zcGFyazovL3VzL1RSVU5LL2M1MGIxZjY2LTRjODMtNDAzNy04NjM1LTg2ZjlkM2VkZDQ5MQ externalCallerIdName: Big Corp-Denver pAccessNetworkInfo: Richardson-TX chargeNumber: '+14158952369' enforceOutsideDialDigit: true schema: $ref: '#/components/schemas/PutTelephonyLocationObject' /telephony/config/jobs/updateRoutingPrefix: get: responses: '200': description: OK headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/BatchResponse' example: items: - id: Y2lzY29zcGFyazovL3VzL0pPQl9JRC81YWE1NWZjNC1lNTYwLTQ3MWQtOGZhZS0yNDc3NDM3MDNkNmI trackingId: NA_e82bec92-7a6c-48e5-9511-bfe4da78396e sourceUserId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I sourceCustomerId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE targetCustomerId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE instanceId: 1 jobExecutionStatus: - id: 1 startTime: '2023-08-16T18:30:20.901Z' endTime: '2023-08-16T18:30:34.793Z' lastUpdated: '2023-08-16T18:30:36.631Z' statusMessage: COMPLETED exitCode: COMPLETED createdTime: '2023-08-16T18:30:20.882Z' stepExecutionStatuses: - id: 2 startTime: '2023-08-16T18:30:20.970Z' endTime: '2023-08-16T18:30:22.801Z' lastUpdated: '2023-08-16T18:30:22.801Z' statusMessage: COMPLETED exitCode: COMPLETED name: updateroutingprefixPreProcessMemberData timeElapsed: PT1.831S - id: 3 startTime: '2023-08-16T18:30:22.811Z' endTime: '2023-08-16T18:30:26.022Z' lastUpdated: '2023-08-16T18:30:26.022Z' statusMessage: COMPLETED exitCode: COMPLETED name: updateroutingprefixGenerateUserReport timeElapsed: PT3.211S - id: 4 startTime: '2023-08-16T18:30:26.032Z' endTime: '2023-08-16T18:30:26.538Z' lastUpdated: '2023-08-16T18:30:26.538Z' statusMessage: COMPLETED exitCode: COMPLETED name: updateroutingprefixPreProcessCiUserData timeElapsed: PT0.506S - id: 5 startTime: '2023-08-16T18:30:26.549Z' endTime: '2023-08-16T18:30:29.907Z' lastUpdated: '2023-08-16T18:30:29.907Z' statusMessage: COMPLETED exitCode: COMPLETED name: updateroutingprefixGenerateMachineAccountReport timeElapsed: PT3.358S - id: 6 startTime: '2023-08-16T18:30:29.916Z' endTime: '2023-08-16T18:30:30.007Z' lastUpdated: '2023-08-16T18:30:30.007Z' statusMessage: COMPLETED exitCode: COMPLETED name: updateroutingprefixPreProcessCiMachineAccountData timeElapsed: PT0.091S - id: 7 startTime: '2023-08-16T18:30:30.018Z' endTime: '2023-08-16T18:30:34.447Z' lastUpdated: '2023-08-16T18:30:34.447Z' statusMessage: COMPLETED exitCode: COMPLETED name: updateroutingprefixFetchVONExtensions timeElapsed: PT4.429S - id: 8 startTime: '2023-08-16T18:30:34.466Z' endTime: '2023-08-16T18:30:34.789Z' lastUpdated: '2023-08-16T18:30:34.789Z' statusMessage: COMPLETED exitCode: COMPLETED name: updateroutingprefixUpdateRoutingPrefix timeElapsed: PT0.323S timeElapsed: PT13.749S latestExecutionStatus: COMPLETED latestExecutionExitCode: COMPLETED counts: routingPrefixFailed: 0 routingPrefixUpdated: 7 - id: Y2lzY29zcGFyazovL3VzL0pPQl9JRC9mZmU3MmVhMS1mMzBhLTQ4MDEtYjA1ZC1mNDQzM2IyZThiZDE trackingId: NA_2688c70a-1887-443d-800b-7efe9cca346f sourceUserId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I sourceCustomerId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE targetCustomerId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE instanceId: 0 jobExecutionStatus: - id: 0 startTime: '2023-08-16T18:27:44.392Z' endTime: '2023-08-16T18:28:00.474Z' lastUpdated: '2023-08-16T18:28:02.621Z' statusMessage: FAILED exitCode: FAILED createdTime: '2023-08-16T18:27:44.341Z' stepExecutionStatuses: - id: 0 startTime: '2023-08-16T18:27:56.083Z' endTime: '2023-08-16T18:27:58.294Z' lastUpdated: '2023-08-16T18:27:58.294Z' statusMessage: COMPLETED exitCode: COMPLETED name: updateroutingprefixPreProcessMemberData timeElapsed: PT2.211S - id: 1 startTime: '2023-08-16T18:27:58.305Z' endTime: '2023-08-16T18:28:00.469Z' lastUpdated: '2023-08-16T18:28:00.469Z' statusMessage: FAILED exitCode: FAILED name: updateroutingprefixGenerateUserReport timeElapsed: PT2.164S timeElapsed: PT4.375S latestExecutionStatus: FAILED latestExecutionExitCode: FAILED counts: routingPrefixFailed: 0 routingPrefixUpdated: 0 '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 a List of Update Routing Prefix jobs operationId: Get a List of Update Routing Prefix jobs description: 'Get the list of all update routing prefix jobs in an organization. The routing prefix is associated with a location and is used to route calls belonging to that location. This API allows users to retrieve all the update routing prefix jobs in an organization. Retrieving the list of update routing prefix jobs in an organization requires a full, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Location Call Settings parameters: - name: orgId in: query description: Retrieve list of update routing prefix jobs in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/jobs/updateRoutingPrefix/{jobId}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/BatchResponse' example: name: updateroutingprefix id: Y2lzY29zcGFyazovL3VzL0pPQl9JRC81YWE1NWZjNC1lNTYwLTQ3MWQtOGZhZS0yNDc3NDM3MDNkNmI trackingId: NA_e82bec92-7a6c-48e5-9511-bfe4da78396e sourceUserId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I sourceCustomerId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE targetCustomerId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE instanceId: 1 jobExecutionStatus: - id: 1 startTime: '2023-08-16T18:30:20.901Z' endTime: '2023-08-16T18:30:34.793Z' lastUpdated: '2023-08-16T18:30:36.631Z' statusMessage: COMPLETED exitCode: COMPLETED createdTime: '2023-08-16T18:30:20.882Z' stepExecutionStatuses: - id: 2 startTime: '2023-08-16T18:30:20.970Z' endTime: '2023-08-16T18:30:22.801Z' lastUpdated: '2023-08-16T18:30:22.801Z' statusMessage: COMPLETED exitCode: COMPLETED name: updateroutingprefixPreProcessMemberData timeElapsed: PT1.831S - id: 3 startTime: '2023-08-16T18:30:22.811Z' endTime: '2023-08-16T18:30:26.022Z' lastUpdated: '2023-08-16T18:30:26.022Z' statusMessage: COMPLETED exitCode: COMPLETED name: updateroutingprefixGenerateUserReport timeElapsed: PT3.211S - id: 4 startTime: '2023-08-16T18:30:26.032Z' endTime: '2023-08-16T18:30:26.538Z' lastUpdated: '2023-08-16T18:30:26.538Z' statusMessage: COMPLETED exitCode: COMPLETED name: updateroutingprefixPreProcessCiUserData timeElapsed: PT0.506S - id: 5 startTime: '2023-08-16T18:30:26.549Z' endTime: '2023-08-16T18:30:29.907Z' lastUpdated: '2023-08-16T18:30:29.907Z' statusMessage: COMPLETED exitCode: COMPLETED name: updateroutingprefixGenerateMachineAccountReport timeElapsed: PT3.358S - id: 6 startTime: '2023-08-16T18:30:29.916Z' endTime: '2023-08-16T18:30:30.007Z' lastUpdated: '2023-08-16T18:30:30.007Z' statusMessage: COMPLETED exitCode: COMPLETED name: updateroutingprefixPreProcessCiMachineAccountData timeElapsed: PT0.091S - id: 7 startTime: '2023-08-16T18:30:30.018Z' endTime: '2023-08-16T18:30:34.447Z' lastUpdated: '2023-08-16T18:30:34.447Z' statusMessage: COMPLETED exitCode: COMPLETED name: updateroutingprefixFetchVONExtensions timeElapsed: PT4.429S - id: 8 startTime: '2023-08-16T18:30:34.466Z' endTime: '2023-08-16T18:30:34.789Z' lastUpdated: '2023-08-16T18:30:34.789Z' statusMessage: COMPLETED exitCode: COMPLETED name: updateroutingprefixUpdateRoutingPrefix timeElapsed: PT0.323S timeElapsed: PT13.749S latestExecutionStatus: COMPLETED latestExecutionExitCode: COMPLETED counts: routingPrefixFailed: 0 routingPrefixUpdated: 7 '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 the job status of Update Routing Prefix job operationId: Get the job status of Update Routing Prefix job description: 'Get the status of the update routing prefix job by its job ID. The routing prefix is associated with a location and is used to route calls belonging to that location. This API allows users to check the status of update routing prefix job by job ID in an organization. Checking the status of the update routing prefix job in an organization requires a full, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Location Call Settings parameters: - name: jobId in: path description: Retrieve job status for this `jobId`. required: true example: Y2lzY29zcGFyazovL3VzL0pPQl9JRC81YWE1NWZjNC1lNTYwLTQ3MWQtOGZhZS0yNDc3NDM3MDNkNmI schema: type: string - name: orgId in: query description: Check update routing prefix job status in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/jobs/updateRoutingPrefix/{jobId}/errors: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/BatchJobError' example: items: - itemNumber: 6 error: key: '500' message: - description: invalid number (id=c5b6ef12-070f-4752-be52-7ae62795ae7f, displayName=Test AutoAttendant, type=Machine, oldExtension=8000081234, newExtension=7000071234) code: null locationId: null trackingId: NA_e82bec92-7a6c-48e5-9511-bfe4da78396e_6 - itemNumber: 7 error: key: '500' message: - description: invalid number (id=296f10e8-ac6e-41d8-ae20-7371c4b6079b, displayName=PagingGroup01, type=Machine, oldExtension=80000855643, newExtension=70000755643) code: null locationId: null trackingId: NA_e82bec92-7a6c-48e5-9511-bfe4da78396e_7 - itemNumber: 8 error: key: '500' message: - description: invalid number (id=41a03fb9-86cd-42c1-a24b-396d9b8d5ac1, displayName=WSwithRP, type=Machine, oldExtension=80000823678, newExtension=70000723678) code: null locationId: null trackingId: NA_e82bec92-7a6c-48e5-9511-bfe4da78396e_8 '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 job errors for update routing prefix job operationId: Get job errors for update routing prefix job description: 'GET job errors for the update routing prefix job in an organization. The routing prefix is associated with a location and is used to route calls belonging to that location. This API allows users to retrieve all the errors of the update routing prefix job by job ID in an organization. Retrieving all the errors of the update routing prefix job in an organization requires a full, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Location Call Settings parameters: - name: jobId in: path description: Retrieve job errors for this `jobId`. required: true example: Y2lzY29zcGFyazovL3VzL0pPQl9JRC81YWE1NWZjNC1lNTYwLTQ3MWQtOGZhZS0yNDc3NDM3MDNkNmI schema: type: string - name: orgId in: query description: Retrieve list of errors for update routing prefix job in this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/locations/{locationId}/actions/modifyAnnouncementLanguage/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: Change Announcement Language operationId: Change Announcement Language description: 'Change announcement language for the given location. Change announcement language for current people/workspaces and/or existing feature configurations. This does not change the default announcement language which is applied to new users/workspaces and new feature configurations. Changing the announcement language for the given location requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Location Call Settings parameters: - name: locationId in: path description: Change announcement language for this location. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx schema: type: string - name: orgId in: query description: Change announcement language for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: agentEnabled: true serviceEnabled: true announcementLanguageCode: en_us schema: $ref: '#/components/schemas/PostLocationAnnouncementLanguageObject' /telephony/config/locations/{locationId}/features/emergencyCallbackNumber: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetLocationCallBackNumberObject' example: locationInfo: phoneNumber: '+12145551767' name: CPAPI_Dev_Test_Location_DND effectiveLevel: LOCATION_NUMBER effectiveValue: '+12145551767' quality: RECOMMENDED locationMemberInfo: phoneNumber: '+12145551767' firstName: cpapiandhydra lastName: cpapiandhydra@gmail.com memberId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82MmQ3YTY3MS00YmVlLTQ2MDItOGVkOC1jOTFmNjU5NjcxZGI memberType: PEOPLE effectiveLevel: LOCATION_MEMBER_NUMBER effectiveValue: '+12145551767' quality: RECOMMENDED selected: LOCATION_MEMBER_NUMBER elinExpiryTimeMinutes: 60 '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 a Location Emergency callback number operationId: Get a Location Emergency callback number description: 'Get location emergency callback number. * To retrieve location callback number requires a full, user or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Location Call Settings parameters: - name: locationId in: path description: Update location attributes for this location. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4NjczZDIwLWM0M2EtNDQ5Ni1iYWIxLTNiMjhhZGJjMjViYQ schema: type: string - name: orgId in: query description: Update location attributes for 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 Location Emergency callback number operationId: Update a Location Emergency callback number description: 'Update details for a location emergency callback number. * Updating a location callback number requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Location Call Settings parameters: - name: locationId in: path description: Update location attributes for this location. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4NjczZDIwLWM0M2EtNDQ5Ni1iYWIxLTNiMjhhZGJjMjViYQ schema: type: string - name: orgId in: query description: Update location attributes for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: selected: LOCATION_MEMBER_NUMBER locationMemberId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9hOTc0MzVjZi0zYTZmLTRmNGYtOWU1OC00OTI2OTQ5MDkwMWY elinExpiryTimeMinutes: 90 schema: $ref: '#/components/schemas/PutLocationCallBackNumberObject' /telephony/config/actions/validateExtensions/invoke: post: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/PostValidateExtensionResponse' example: status: OK | ERRORS extensionStatus: - extension: state: VALID | DUPLICATE | DUPLICATE_IN_LIST | INVALID errorCode: message: '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: Validate the List of Extensions operationId: Validate the List of Extensions description: 'Validates the list of Extensions provided by the customer at the organization level. It checks the extension meets the current extension length limits and does not conflict with the extensions of organization-level entities and settings. To check for extension use across all locations, use the [Get Phone Numbers](/v1/telephony/config/numbers) API. To validate an extension and check for conflicts for a specific location, use the [Validate Extensions](/docs/api/v1/location-call-settings/validate-extensions) API. 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: - Location Call Settings parameters: - name: orgId in: query description: Validate Extension for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: extensions: - '1234' - '3144' schema: $ref: '#/components/schemas/PostValidateExtension' /telephony/config/locations/{locationId}/actions/validateExtensions/invoke: post: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/StatusOfExtensionsObject' example: status: ERRORS extensionStatus: - extension: '407721' state: DUPLICATE errorCode: 9495 message: '[Error 9495] The extension is not available. It is already assigned as a Call Park Extension: 407721.' - extension: '507721' state: VALID - extension: '507721' state: DUPLICATE_IN_LIST errorCode: 9498 - extension: '911' state: INVALID errorCode: 4911 message: '[Error 4911] Invalid extension. The extension cannot be an emergency number.' - extension: a234 state: INVALID errorCode: 4910 message: '[Error 4910] Invalid extension. The extension can only contain characters 0-9.' '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: Validate Extensions operationId: Validate Extensions description: 'Validate extensions for a specific location. Validating extensions requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Location Call Settings parameters: - name: locationId in: path description: Validate extensions for this location. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1 schema: type: string - name: orgId in: query description: Validate extensions for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: extensions: - '407721' - '507721' - '507721' - '9111' - a234 schema: $ref: '#/components/schemas/ArrayOfExtensionsObject' /telephony/config/locations/{locationId}/musicOnHold: 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 Music On Hold operationId: Update Music On Hold description: 'Update the location''s music on hold settings. Location music on hold settings allows you to play music when a call is placed on hold or parked. Updating a location''s music on hold settings requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Location Call Settings parameters: - name: locationId in: path description: Update music on hold settings for this location. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx schema: type: string - name: orgId in: query description: Update music on hold settings for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: callHoldEnabled: true callParkEnabled: true greeting: SYSTEM audioFile: id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI fileName: AUDIO_FILE.wav mediaFileType: WAV level: ORGANIZATION playlistId: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9iYzZjOTYwYi01ZDJjLTRiM2QtYjRlZC0wNWY1ZmFhMTJjZjA schema: $ref: '#/components/schemas/PutMusicOnHoldObject' get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetMusicOnHoldObject' example: callHoldEnabled: true callParkEnabled: true greeting: SYSTEM audioFile: id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jZWRkODcwYS1lMTkzLTQxNmQtYmM3OS1mNzkyYmUyMzlhOGI fileName: AUDIO_FILE.wav mediaFileType: WAV level: ORGANIZATION playlist: id: Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9iYzZjOTYwYi01ZDJjLTRiM2QtYjRlZC0wNWY1ZmFhMTJjZjA name: testingAnnouncementPlaylist '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 Music On Hold operationId: Get Music On Hold description: 'Retrieve the location''s music on hold settings. Location music on hold settings allows you to play music when a call is placed on hold or parked. Retrieving a location''s music on hold settings requires a full, user or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Location Call Settings parameters: - name: locationId in: path description: Retrieve music on hold settings for this location. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0fetchcllrjjejgghbruudtlknjbcleukhihhgFUSU9OLzMxMTYx schema: type: string - name: orgId in: query description: Retrieve music on hold settings for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/locations/{locationId}/privateNetworkConnect: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetPrivateNetworkConnectObject' example: networkConnectionType: PUBLIC_INTERNET '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 Private Network Connect operationId: Get Private Network Connect description: 'Retrieve the location''s network connection type. Network Connection Type determines if the location''s network connection is public or private. Retrieving a location''s network connection type requires a full, user or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Location Call Settings parameters: - name: locationId in: path description: Retrieve the network connection type for this location. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx schema: type: string - name: orgId in: query description: Retrieve the network connection type for 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 Private Network Connect operationId: Update Private Network Connect description: 'Update the location''s network connection type. Network Connection Type determines if the location''s network connection is public or private. Updating a location''s network connection type requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Location Call Settings parameters: - name: locationId in: path description: Update the network connection type for this location. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx schema: type: string - name: orgId in: query description: Update network connection type for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: networkConnectionType: PUBLIC_INTERNET schema: $ref: '#/components/schemas/PutPrivateNetworkConnectObject' /telephony/config/routeChoices: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object required: - routeIdentities properties: routeIdentities: type: array items: $ref: '#/components/schemas/RouteIdentity' description: Array of route identities. example: routeIdentities: - id: Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQLzA1OWEyNzNlLWJiYjAtMTFlYy04NDIyLTAyNDJhYzEyMDAwMg name: route_identity_name type: ROUTE_GROUP '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 Routing Choices operationId: Read the List of Routing Choices description: 'List all Routes for the organization. Trunk and Route Group qualify as Route. Trunks and Route Groups provide you the ability to configure Webex Calling to manage calls between Webex Calling hosted users and premises PBX users. This solution lets you configure users to use Cloud PSTN (CCP or Cisco PSTN) or Premises-based PSTN. 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: - Location Call Settings parameters: - name: orgId in: query description: List route identities for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: routeGroupName in: query description: Return the list of route identities matching the Route group name. example: routeGroupName schema: type: string - name: trunkName in: query description: Return the list of route identities matching the Trunk name. example: trunkName 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: order in: query description: 'Order the route identities according to the designated fields. Available sort fields: `routeName`, `routeType`.' example: my_test_trunk-asc|ROUTE_GROUP-desc schema: type: string /telephony/config/locations/{locationId}/externalCallerId/availableNumbers: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/ExternalCallerIdNumberListGet' example: phoneNumbers: - phoneNumber: '+12036390542' state: ACTIVE isMainNumber: false tollFreeNumber: false isServiceNumber: true location: id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzkzMGMzYTNlLTA3Y2EtNDNmOS1iZjE4LTZlZGM2OGE1Y2Y3Yg name: Bangalore owner: id: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvWkhabFpuQjVhblY2WjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0 type: HUNT_GROUP displayName: testingdemo - phoneNumber: '+447975777966' state: ACTIVE isMainNumber: false tollFreeNumber: false isServiceNumber: false location: id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzkzMGMzYTNlLTA3Y2EtNDNmOS1iZjE4LTZlZGM2OGE1Y2Y3Yg name: Bangalore owner: id: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvWW04MWMyNTVjWFZ6Y1VBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0 type: HUNT_GROUP displayName: CallertestingVeeresh9999te - phoneNumber: '+447975777969' state: INACTIVE isMainNumber: true tollFreeNumber: false isServiceNumber: false location: id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzkzMGMzYTNlLTA3Y2EtNDNmOS1iZjE4LTZlZGM2OGE1Y2Y3Yg name: Bangalore owner: id: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS82MGQxZGJlMC02MmNjLTQxZTEtOWE2MC1mZWQ1YmJkODUxZGQ type: VIRTUAL_LINE firstName: testingssss lastName: dsdsd '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 the List of Phone Numbers Available for External Caller ID operationId: Get the List of Phone Numbers Available for External Caller ID description: 'Get the list of phone numbers available for external caller ID usage by a Webex Calling entity (such as a person, virtual line, or workspace) within the specified location. Numbers from the specified location are returned and cross location numbers are returned as well where the number''s location has the same country, PSTN provider, and zone (only applicable for India locations) as the specified location. When `personId` is specified, and the person belongs to a cisco PSTN location, has a mobile number assigned as primary DN, and does not have a billing plan, only the assigned mobile number is returned as the available number for caller ID. 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 or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Location Call Settings parameters: - name: locationId in: path description: Retrieve available external caller ID numbers for this location. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzkzZmQ1ZDMyLTRmYmItNGNjMS04ZTYxLTE0YTA1ZDhhMTIzMw 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 provided list in the `phoneNumber` array. example: +12056852221,+12056852222 schema: type: array items: type: string example: +12056852221,+12056852222 description: Filter phone numbers based on the provided list 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: personId in: query description: Retrieve available external caller ID numbers for this person. If `personId` is not provided it may result in the unsuccessful assignment of the returned number. This parameter has no effect when workspace or virtual line ID is used. example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8zZmQ1ZDMyLTRmYmItNGNjMS04ZTYxLTE0YTA1ZDhhMTIzMw schema: type: string /telephony/config/locations/{locationId}/availableNumbers: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/LocationAvailableNumberListGetObject' example: phoneNumbers: - phoneNumber: '+12056350001' state: ACTIVE isMainNumber: false telephonyType: PSTN_NUMBER tollFreeNumber: false isServiceNumber: true owner: id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk type: PEOPLE firstName: Test lastName: Person - phoneNumber: '+12056350002' state: ACTIVE isMainNumber: true telephonyType: PSTN_NUMBER tollFreeNumber: false isServiceNumber: false owner: id: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS9lZjJkMjg3Ny1hYTY0LTRkMjQtYTFjNi02OWExMmNhMWI2YTA= type: PLACE displayName: TestWorkSpace - 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 Available Phone Numbers for a Location with Given Criteria operationId: Get Available Phone Numbers for a Location with Given Criteria description: 'List the service and standard PSTN numbers that are available to be assigned as the location''s main number. These numbers are associated with the location specified in the request URL and can be active/inactive and assigned to an owning entity or 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 or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Location Call Settings 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 /telephony/config/locations/{locationId}/webexGo/availableNumbers: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/WebexGoAvailableNumberListGetObject' example: phoneNumbers: - phoneNumber: '+12056350001' state: ACTIVE isMainNumber: false telephonyType: PSTN_NUMBER isServiceNumber: false - phoneNumber: '+12056350002' state: ACTIVE isMainNumber: true telephonyType: PSTN_NUMBER isServiceNumber: false - phoneNumber: '+12056350003' state: INACTIVE isMainNumber: false telephonyType: PSTN_NUMBER 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 Webex Go Available Phone Numbers operationId: Get Webex Go Available Phone Numbers description: 'List standard numbers that are available to be assigned as the webex go 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: - Location Call Settings 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}/emergencyCallbackNumber/availableNumbers: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/LocationECBNAvailableNumberListGetObject' 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: false owner: id: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS9iMzRmZjk3ZC1jMDkzLTRiYTMtOTEyMC0yMDc1M2U3Yjg3YjA= type: PLACE displayName: TestWorkSpace - phoneNumber: '+12056350003' extension: '1236' state: INACTIVE isMainNumber: false telephonyType: PSTN_NUMBER tollFreeNumber: true isServiceNumber: false owner: id: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS82NWQ3MmYwNS00NDYzLTQxYzktYjI0Ni01MDhkMDM2YzJhOTE type: VIRTUAL_LINE displayName: Test VL - phoneNumber: '+12056350004' state: ACTIVE isMainNumber: false telephonyType: PSTN_NUMBER tollFreeNumber: false isServiceNumber: false owner: id: Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvWnpOcmEybHNkalV3ZDBCbWJHVjRNaTVqYVhOamJ5NWpiMjA9 type: HUNT_GROUP displayName: Test HG '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 Location ECBN Available Phone Numbers operationId: Get Location ECBN Available Phone Numbers description: 'List standard numbers that are available to be assigned as the location''s emergency callback 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: - Location Call Settings 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 /telephony/config/locations/{locationId}/callIntercept/availableNumbers: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/LocationCallInterceptAvailableNumberListGetObject' 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 Location Call Intercept Available Phone Numbers operationId: Get Location Call Intercept Available Phone Numbers description: 'List the service and standard PSTN numbers that are available to be assigned as the location''s call intercept 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 or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Location Call Settings 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 phone numbers with the given `extension`. example: '1234' schema: type: string /telephony/config/locations/{locationId}/receptionistContacts/directories: post: responses: '200': description: OK headers: {} content: application/json: schema: type: object required: - id properties: id: type: string description: Receptionist Contact Directory ID. example: id: Y2lzY29zcGFyazovL3VzL1NDSU1fR1JPVVAvZEdWemRGOWthWEpsWTNSdmNuaz06OTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh '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 Receptionist Contact Directory operationId: Create a Receptionist Contact Directory description: 'Create a new Receptionist Contact Directory for a location. Receptionist Contact Directories can be used to create named directories of users and/or location features (Auto Attendant, Call Queue, Hunt Group, Single Number Reach, and Paging Group). Adding a directory requires a full or write-only administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Location Call Settings parameters: - name: locationId in: path description: Add a Receptionist Contact Directory to this location. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA schema: type: string - name: orgId in: query description: Add a Receptionist Contact Directory to this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: name: test_directory contacts: - personId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wNTUyZjY3Yi01OWE5LTQxYmItODczNi0xYjA0MWQxZGRkNWU - featureId: Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5ULzA1NTJmNjdiLTU5YTktNDFiYi04NzM2LTFiMDQxZDFkZGQ1ZQ type: AUTO_ATTENDANT schema: $ref: '#/components/schemas/ContactPayload' get: responses: '200': description: OK headers: {} content: application/json: schema: type: object required: - directories properties: directories: type: array items: $ref: '#/components/schemas/Directory' description: Array of Receptionist Contact Directories. example: directories: - id: Y2lzY29zcGFyazovL3VzL1NDSU1fR1JPVVAvZEdWemRGOWthWEpsWTNSdmNuaz06OTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh name: test_directory '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 list of Receptionist Contact Directories operationId: Read list of Receptionist Contact Directories description: 'List all Receptionist Contact Directories for a location. Receptionist Contact Directories can be used to create named directories of users. Retrieving this list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Location Call Settings parameters: - name: locationId in: path description: List Receptionist Contact Directories for this location. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA schema: type: string - name: orgId in: query description: List Receptionist Contact Directories for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/locations/{locationId}/receptionistContacts/directories/{directoryId}: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object required: - contacts properties: contacts: type: array items: $ref: '#/components/schemas/ContactDetails' description: Array of Receptionist Contact Directories. example: contacts: - personId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS81ZWI3MGUxNi1iYThmLTQzYzgtOWI5Yy1jZjNlNjQyNjEzN2Q firstName: Alex_16 lastName: test_16 phoneNumber: '+14234567895' extension: '582' mobile: '9725554729' title: Engineer featureId: null - personId: null firstName: Group Paging lastName: Alex_pg_1 phoneNumber: null extension: '676' featureId: Y2lzY29zcGFyazovL3VzL0dST1VQX1BBR0lORy8wNTUyZjY3Yi01OWE5LTQxYmItODczNi0xYjA0MWQxZGRkNWU '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 Receptionist Contact Directory operationId: Get details for a Receptionist Contact Directory description: 'Get details for a specific Receptionist Contact Directory from a location. Receptionist Contact Directories are uniquely named per location and contain directories of Persons, Auto Attendants, Call Queues, Hunt Groups, Single Number Reaches, and Paging Groups. This API is currently supported for Webex calling organizations with fewer than 2000 users or location-based calling features. For organizations with more than 2000 users or location features, the API will throw an error 25395. Retrieving details requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Location Call Settings parameters: - name: locationId in: path description: Get a Receptionist Contact Directory from this location. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA schema: type: string - name: directoryId in: path description: Get details for the Receptionist Contact Directory with this identifier. required: true example: Y2lzY29zcGFyazovL3VzL0RFUEFSVE1FTlQvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh schema: type: string - name: orgId in: query description: Get a Receptionist Contact Directory from this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: searchCriteriaModeOr in: query description: When `true`, results matching any one of the search criteria are included. The value can only be `true` or not included in the request. Specifying `searchCriteriaModeOr` without any search criteria, or setting it to `false` results in an `ErrorResponse`. If no search criteria is specified, all results are returned. example: 'true' schema: type: boolean - name: firstName in: query description: Search for directories that contain people with the indicated first name. example: John schema: type: string - name: lastName in: query description: Search for directories that contain people with the indicated last name. example: Doe schema: type: string - name: phoneNumber in: query description: Search for directories that contain people with the indicated phone number. example: '+12225555309' schema: type: string - name: extension in: query description: Search for directories that contain people with the indicated extension. example: '5309' schema: type: string - name: personId in: query description: Search for directories that contain people with the indicated person ID. example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wNTUyZjY3Yi01OWE5LTQxYmItODczNi0xYjA0MWQxZGRkNWU schema: type: string 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 Receptionist Contact Directory operationId: Delete a Receptionist Contact Directory description: 'Delete a Receptionist Contact Directory from a location. Receptionist Contact Directories can be used to create named directories of users. Deleting a directory requires a full or write-only administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Location Call Settings parameters: - name: locationId in: path description: Delete a Receptionist Contact Directory from this location. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA schema: type: string - name: directoryId in: path description: Delete the Receptionist Contact Directory ID with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL1NDSU1fR1JPVVAvUkdseVpXTjBiM0o1VkdWemREY3lNRGMxOjJiOTQzMWIzLWMyYWUtNDhhYi1iMDQxLWE2ZThiMjY1NjJjOQ schema: type: string - name: orgId in: query description: Delete a Receptionist Contact Directory from this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string put: responses: '200': description: OK headers: {} content: application/json: schema: type: object required: - id properties: id: type: string description: ID of the newly created Receptionist directory name. example: name: test_directory contacts: - Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk '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: Modify a Receptionist Contact Directory operationId: Modify a Receptionist Contact Directory description: 'Modify Receptionist Contact Directories attached to a location. This modification will replace the existing list of contacts with the new incoming contacts list from the request body. The API does not support incremental updates. Receptionist Contact Directories can be used to create named groups of Persons, Auto Attendants, Call Queues, Hunt Groups, Single Number Reaches, and Paging Groups. Modifying a directory requires a full or write-only administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Location Call Settings parameters: - name: locationId in: path description: Modify list of Receptionist Contact Directories for this location. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA schema: type: string - name: directoryId in: path description: Get details for the Receptionist Contact Directory with this identifier. required: true example: Y2lzY29zcGFyazovL3VzL0RFUEFSVE1FTlQvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh schema: type: string - name: orgId in: query description: Modify list of Receptionist Contact Directories for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: name: test_directory contacts: - Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk schema: $ref: '#/components/schemas/ContactPayloadForModify' /telephony/config/locations/{locationId}/chargeNumber/availableNumbers: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/LocationAvailableChargeNumberListGetObject' example: phoneNumbers: - phoneNumber: '+12056852221' state: ACTIVE isMainNumber: false tollFreeNumber: false isServiceNumber: false owner: id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk type: PEOPLE firstName: Alex lastName: test_16 displayName: Alex test_16 '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 Available Charge Numbers for a Location with Given Criteria operationId: GetAvailableChargeNumbersList description: 'List the numbers that are available to be assigned as the location''s charge number. These numbers are non-toll-free and non-mobile numbers assigned to the location specified in the request URL. 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: - Location Call Settings parameters: - name: locationId in: path description: Return the list of available charge 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 /telephony/config/jobs/locations/deleteCallingLocation: post: responses: '202': description: Accepted headers: {} content: application/json: schema: $ref: '#/components/schemas/DisableCallingLocationJobStatus' example: name: deletecallinglocation id: Y2lzY29zcGFyazovL3VzL0pPQl9JRC8zZjczYTAyOS1lYWZkLTQ5NzUtYjcyYi1jNzlkYWE1ZTkyZmE trackingId: ROUTERGW_882b1b3b-b247-4d4f-abe9-4ccec7f7e3b0 sourceUserId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kMzg2MjhiYy0zYjk4LTRjMjMtODEwMy0wMzRhMjI0ZmRiNjE sourceCustomerId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM targetCustomerId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM instanceId: 1472955 jobExecutionStatus: - id: 1497186 lastUpdated: '2025-07-27T13:19:39.702Z' statusMessage: STARTING exitCode: UNKNOWN createdTime: '2025-07-27T13:19:39.702Z' timeElapsed: PT0S latestExecutionStatus: STARTING latestExecutionExitCode: UNKNOWN locationName: San Jose HQ '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.' '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.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited.' '500': description: 'Internal Server Error: Something went wrong on the server.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' summary: Disable a Location for Webex Calling operationId: Disable Location For Webex Calling description: 'Disable a Location for Webex Calling. Initiating a disable calling location job requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`. The API returns a jobId that can be used with other job-related APIs to track the status and progress of the disable operation.' tags: - Location Call Settings parameters: - name: orgId in: query description: Organization ID for disabling the location for Webex Calling. schema: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE requestBody: content: application/json: schema: $ref: '#/components/schemas/DisableCallingLocationPostRequest' example: locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2Y1YjFlMWE3LTQ2MWQtNGUwZC1hYmNiLTQwM2IyMzViNDMzMQ locationName: San Jose HQ forceDelete: true required: true get: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/DisableCallingLocationJobStatus' description: List of disable calling location jobs. example: items: - id: Y2lzY29zcGFyazovL3VzL0pPQl9JRC80NGNjYzRjMi00YmUxLTRhNjEtOGM5ZC03OTc3YjU4NTM0MWQ trackingId: ROUTERGW_c4fc3b45-793e-4744-bb08-ee13032112c7 sourceUserId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kMzg2MjhiYy0zYjk4LTRjMjMtODEwMy0wMzRhMjI0ZmRiNjE sourceCustomerId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM targetCustomerId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM instanceId: 1488100 jobExecutionStatus: - id: 1512544 startTime: '2025-07-29T13:37:20.098Z' endTime: '2025-07-29T13:37:27.805Z' lastUpdated: '2025-07-29T13:37:33.441Z' statusMessage: FAILED exitCode: FAILED createdTime: '2025-07-29T13:37:19.995Z' stepExecutionStatuses: - id: 5572963 startTime: '2025-07-29T13:37:25.555Z' endTime: '2025-07-29T13:37:26.283Z' lastUpdated: '2025-07-29T13:37:26.424Z' statusMessage: COMPLETED exitCode: COMPLETED name: deletecallinglocationInitializer timeElapsed: PT0.727654S - id: 5572964 startTime: '2025-07-29T13:37:26.445Z' endTime: '2025-07-29T13:37:27.603Z' lastUpdated: '2025-07-29T13:37:27.795Z' statusMessage: FAILED exitCode: FAILED name: deletecallinglocationSafeDeleteCheck timeElapsed: PT1.158801S timeElapsed: PT1.886455S latestExecutionStatus: FAILED latestExecutionExitCode: FAILED locationName: San Jose HQ '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.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited.' '500': description: 'Internal Server Error: Something went wrong on the server.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' summary: Get a List of Disable Calling Location Jobs operationId: Get List Of Disable Calling Location Jobs description: 'Get a List of Disable Calling Location Jobs for the organization. Retrieving the list of disable calling location jobs requires a full administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Location Call Settings parameters: - name: orgId in: query description: List disable calling location jobs for this organization. schema: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE - name: max in: query description: Maximum number of jobs to return. schema: type: integer default: 20 - name: start in: query description: Offset to start returning records from. schema: type: integer default: 0 /telephony/config/locations/{locationId}/actions/precheckForDeletion/invoke: post: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/SafeDeleteCheckForDisableCallingLocationResponse' example: locationDeleteStatus: FORCE_REQUIRED blocking: lastLocation: false trunksInUseCount: 0 usersInUseCount: 0 workspacesInUseCount: 0 virtualLineInUseCount: 0 numbersOrderPending: false nonBlocking: numbersPresent: true blockingUnlessForced: nonUserEntitiesInUse: true trunksCount: 2 '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.' '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.' '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.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' summary: Safe Delete Check Before Disabling a Location for Webex Calling operationId: Safe Delete Check Before Disabling Calling Location description: 'Performs a safe delete check operation to identify any issues that would prevent the calling location from being disabled. This API helps identify resources that need to be addressed before a calling location can be successfully disabled. This API requires a full administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Location Call Settings parameters: - name: locationId in: path description: Unique identifier for the location to be checked. required: true schema: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzk2ZjA0YjUwLTYxMWItNGViYy05ZGE0LTQwMzU4ODYxZTI4NQ - name: orgId in: query description: Organization ID for which the safe delete check operation is being performed. schema: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE /telephony/config/jobs/locations/deleteCallingLocation/{jobId}/actions/pause/invoke: post: responses: '202': description: Accepted 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.' '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.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited.' '500': description: 'Internal Server Error: Something went wrong on the server.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' summary: Pause a Disable Calling Location Job operationId: Pause Disable Calling Location Job description: 'Pause an in-progress disable calling location job. The job must be in the PROCESSING state to be paused. Pausing a job requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Location Call Settings parameters: - name: jobId in: path description: Unique identifier for the job to pause. required: true schema: type: string example: Y2lzY29zcGFyazovL3VzL0pPQl9JRC85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0 - name: orgId in: query description: Organization ID for which to pause the job. schema: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE /telephony/config/jobs/locations/deleteCallingLocation/{jobId}/actions/resume/invoke: post: responses: '202': description: Accepted 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.' '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.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited.' '500': description: 'Internal Server Error: Something went wrong on the server.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' summary: Resume a Paused Disable Calling Location Job operationId: Resume Paused Disable Calling Location Job description: 'Resume a previously paused disable calling location job. The job must be in the PAUSED state to be resumed. Resuming a job requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Location Call Settings parameters: - name: jobId in: path description: Unique identifier for the job to resume. required: true schema: type: string example: Y2lzY29zcGFyazovL3VzL0pPQl9JRC85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0 - name: orgId in: query description: Organization ID for which to resume the job. schema: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE /telephony/config/jobs/locations/deleteCallingLocation/{jobId}/errors: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/PaginatedResult' example: items: - itemNumber: 1 errorType: ERROR error: key: '500' message: - description: Safe delete checks failed. code: BATCH-1012004 locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzk2ZjA0YjUwLTYxMWItNGViYy05ZGE0LTQwMzU4ODYxZTI4NQ trackingId: ROUTERGW_c4fc3b45-793e-4744-bb08-ee13032112c7 - itemNumber: 2 errorType: ERROR error: key: '400' message: - description: 'Users associated with the location. Count: 5' code: BATCH-1012007 locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzk2ZjA0YjUwLTYxMWItNGViYy05ZGE0LTQwMzU4ODYxZTI4NQ trackingId: ROUTERGW_c4fc3b45-793e-4744-bb08-ee13032112c7 '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.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited.' '500': description: 'Internal Server Error: Something went wrong on the server.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' summary: Retrieve Errors for a Disable Calling Location Job operationId: Retrieve Errors For Disable Calling Location Job description: 'Retrieve detailed error information for a disable calling location job. This is particularly useful for jobs that have failed or encountered errors during processing. Retrieving job errors requires a full administrator auth token with a scope of `spark-admin:telephony_config_read`. Possible error codes include: * `BATCH-1012002` - Unable to delete calling location from Broadworks. * `BATCH-1012004` - Safe delete checks failed. * `BATCH-1012005` - Failed to perform safe delete checks. * `BATCH-1012006` - Trunks in use in the location. Count: {0} * `BATCH-1012007` - Users associated with the location. Count: {0} * `BATCH-1012008` - Workspaces associated with the location. Count: {0} * `BATCH-1012009` - Virtual lines associated with the location. Count: {0} * `BATCH-1012010` - Number order is pending. * `BATCH-1012011` - Features associated with the location. This is a blocking error, use forceDelete to disable the calling location. * `BATCH-1012012` - Not allowed to delete the last calling location. Calling requires at least one active location in the organization, This is a blocking error. * `BATCH-1012013` - Local gateway''s associated with the location. Count: {0}. This is a blocking error, use forceDelete to disable the calling location. * `BATCH-1012014` - Location not found.' tags: - Location Call Settings parameters: - name: jobId in: path description: Unique identifier for the job to get errors for. required: true schema: type: string example: Y2lzY29zcGFyazovL3VzL0pPQl9JRC85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0 - name: orgId in: query description: Organization ID for disable calling location job. schema: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE /telephony/config/jobs/locations/deleteCallingLocation/{jobId}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/DisableCallingLocationJobStatus' example: name: deletecallinglocation id: Y2lzY29zcGFyazovL3VzL0pPQl9JRC8zZjczYTAyOS1lYWZkLTQ5NzUtYjcyYi1jNzlkYWE1ZTkyZmE trackingId: ROUTERGW_882b1b3b-b247-4d4f-abe9-4ccec7f7e3b0 sourceUserId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kMzg2MjhiYy0zYjk4LTRjMjMtODEwMy0wMzRhMjI0ZmRiNjE sourceCustomerId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM targetCustomerId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM instanceId: 1472955 jobExecutionStatus: - id: 1497186 startTime: '2025-07-27T13:19:39.875Z' endTime: '2025-07-27T13:19:51.752Z' lastUpdated: '2025-07-27T13:19:55.413Z' statusMessage: COMPLETED exitCode: COMPLETED createdTime: '2025-07-27T13:19:39.702Z' stepExecutionStatuses: - id: 5543084 startTime: '2025-07-27T13:19:43.449Z' endTime: '2025-07-27T13:19:44.328Z' lastUpdated: '2025-07-27T13:19:44.523Z' statusMessage: COMPLETED exitCode: COMPLETED name: deletecallinglocationInitializer timeElapsed: PT0.878554S - id: 5543085 startTime: '2025-07-27T13:19:44.534Z' endTime: '2025-07-27T13:19:46.029Z' lastUpdated: '2025-07-27T13:19:46.212Z' statusMessage: COMPLETED exitCode: COMPLETED name: deletecallinglocationSafeDeleteCheck timeElapsed: PT1.495006S - id: 5543086 startTime: '2025-07-27T13:19:46.226Z' endTime: '2025-07-27T13:19:46.554Z' lastUpdated: '2025-07-27T13:19:46.753Z' statusMessage: COMPLETED exitCode: COMPLETED name: deletecallinglocationGetLocationuUserDataFromCpApi timeElapsed: PT0.327352S - id: 5543087 startTime: '2025-07-27T13:19:46.229Z' endTime: '2025-07-27T13:19:46.890Z' lastUpdated: '2025-07-27T13:19:47.091Z' statusMessage: COMPLETED exitCode: COMPLETED name: deletecallinglocationGetLocationMachineDataFromCpApi timeElapsed: PT0.660953S - id: 5543088 startTime: '2025-07-27T13:19:47.103Z' endTime: '2025-07-27T13:19:49.752Z' lastUpdated: '2025-07-27T13:19:49.936Z' statusMessage: COMPLETED exitCode: COMPLETED name: deletecallinglocationDelLocFromBifrost timeElapsed: PT2.648411S - id: 5543089 startTime: '2025-07-27T13:19:49.947Z' endTime: '2025-07-27T13:19:50.278Z' lastUpdated: '2025-07-27T13:19:50.466Z' statusMessage: COMPLETED exitCode: COMPLETED name: deletecallinglocationDelUserAsMachineAcctInCI timeElapsed: PT0.330448S - id: 5543090 startTime: '2025-07-27T13:19:49.950Z' endTime: '2025-07-27T13:19:51.536Z' lastUpdated: '2025-07-27T13:19:51.745Z' statusMessage: COMPLETED exitCode: COMPLETED name: deletecallinglocationDelMachineAcctInCI timeElapsed: PT1.586017S timeElapsed: PT7.926741S latestExecutionStatus: COMPLETED latestExecutionExitCode: COMPLETED counts: totalVirtualExtensionsAccount: 0 virtualExtensionsDeleted: 0 virtualExtensionsDeleteFailed: 0 totalFeatureAccounts: 1 featureAccountsDeleted: 1 featureAccountsDeleteFailed: 0 locationName: San Jose HQ '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.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited.' '500': description: 'Internal Server Error: Something went wrong on the server.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' summary: Get Disable Calling Location Job Status operationId: Get Disable Calling Location Job Status description: 'Get the status and details of a specific disable calling location job. Retrieving job status requires a full administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Location Call Settings parameters: - name: jobId in: path description: Unique identifier for the job. required: true schema: type: string example: Y2lzY29zcGFyazovL3VzL0pPQl9JRC85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0 - name: orgId in: query description: Organization ID for which to retrieve the job status. schema: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE /telephony/config/locations/{locationId}/callCaptions: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetLocationCallCaptionsObject' example: locationClosedCaptionsEnabled: true locationTranscriptsEnabled: true orgClosedCaptionsEnabled: true orgTranscriptsEnabled: true useOrgSettingsEnabled: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get the location call captions settings operationId: Get the location call captions settings description: 'Retrieve the location''s call captions settings. **NOTE**: The call captions feature is not supported for locations in India. The call caption feature allows the customer to enable and manage closed captions and transcript functionality (rolling caption panel) in Webex Calling, without requiring the user to escalate the call to a meeting. This API requires a full, read-only, or location administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Location Call Settings parameters: - name: locationId in: path description: Unique identifier for the location. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4NjczZDIwLWM0M2EtNDQ5Ni1iYWIxLTNiMjhhZGJjMjViYQ schema: type: string - name: orgId in: query description: Unique identifier for the 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 the location call captions settings operationId: Update the location call captions settings description: 'Update the location''s call captions settings. **NOTE**: The call captions feature is not supported for locations in India. The call caption feature allows the customer to enable and manage closed captions and transcript functionality (rolling caption panel) in Webex Calling, without requiring the user to escalate the call to a meeting. This API requires a full or location administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Location Call Settings parameters: - name: locationId in: path description: Unique identifier for the location. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4NjczZDIwLWM0M2EtNDQ5Ni1iYWIxLTNiMjhhZGJjMjViYQ schema: type: string - name: orgId in: query description: Unique identifier for the organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: locationClosedCaptionsEnabled: true locationTranscriptsEnabled: true useOrgSettingsEnabled: true schema: $ref: '#/components/schemas/UpdateLocationCallCaptionsObject' components: schemas: LocationCallInterceptAvailableNumberListGetObject: type: object required: - phoneNumbers properties: phoneNumbers: type: array items: $ref: '#/components/schemas/LocationCallInterceptAvailableNumberObject' description: Array of phone numbers. BatchResponse: type: object required: - name - id - trackingId - sourceUserId - sourceCustomerId - targetCustomerId - instanceId - latestExecutionStatus - counts properties: name: type: string description: Job name. id: type: string description: Unique identifier of the job. trackingId: type: string description: Unique identifier to track the flow of HTTP requests. sourceUserId: type: string description: Unique identifier to identify which user has run the job. sourceCustomerId: type: string description: Unique identifier to identify the customer who has run the job. targetCustomerId: type: string description: Unique identifier to identify the customer for which the job was run. instanceId: type: number description: Unique identifier to identify the instance of the job. jobExecutionStatus: type: array items: $ref: '#/components/schemas/JobExecutionStatus' description: Displays the most recent step's execution status. Contains execution statuses of all the steps involved in the execution of the job. latestExecutionStatus: type: string description: Indicates the most recent status (`STARTING`, `STARTED`, `COMPLETED`, `FAILED`) of the job at the time of invocation. latestExecutionExitCode: type: string enum: - UNKNOWN - COMPLETED - FAILED - STOPPED - COMPLETED_WITH_ERRORS description: "Most recent exit code of the job at the time of invocation.\n * `UNKNOWN` - Job is in progress.\n * `COMPLETED` - Job has completed successfully.\n * `FAILED` - Job has failed.\n * `STOPPED` - Job has been stopped.\n * `COMPLETED_WITH_ERRORS` - Job has completed with errors.\n" counts: $ref: '#/components/schemas/Counts' description: Job statistics. 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" WebexGoAvailableNumberObject: type: object required: - phoneNumber - state - isMainNumber - telephonyType - isServiceNumber properties: phoneNumber: type: string example: '+12056350001' description: A unique identifier for the 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. 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. DisableCallingLocationJobStatus: type: object description: Status and details of a disable calling location job. example: name: deletecallinglocation id: Y2lzY29zcGFyazovL3VzL0pPQl9JRC8zZjczYTAyOS1lYWZkLTQ5NzUtYjcyYi1jNzlkYWE1ZTkyZmE trackingId: ROUTERGW_882b1b3b-b247-4d4f-abe9-4ccec7f7e3b0 sourceUserId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9kMzg2MjhiYy0zYjk4LTRjMjMtODEwMy0wMzRhMjI0ZmRiNjE sourceCustomerId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM targetCustomerId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM instanceId: 1472955 jobExecutionStatus: - id: 1497186 lastUpdated: '2025-07-27T13:19:39.702Z' statusMessage: STARTING exitCode: UNKNOWN createdTime: '2025-07-27T13:19:39.702Z' timeElapsed: PT0S latestExecutionStatus: STARTING latestExecutionExitCode: UNKNOWN locationName: San Jose HQ counts: totalVirtualExtensionsAccount: 0 virtualExtensionsDeleted: 0 virtualExtensionsDeleteFailed: 0 totalFeatureAccounts: 1 featureAccountsDeleted: 1 featureAccountsDeleteFailed: 0 properties: name: type: string description: Name of the job id: type: string description: Unique identifier for the job. locationName: type: string description: Name of the calling location being disabled. trackingId: type: string description: Tracking identifier for the job. sourceUserId: type: string description: ID of the user who initiated the job. sourceCustomerId: type: string description: Organization ID of the source customer. targetCustomerId: type: string description: Organization ID of the target customer. instanceId: type: integer format: int64 description: Instance identifier for the job. latestExecutionStatus: type: string description: Latest execution status of the job. latestExecutionExitCode: type: string description: Latest execution exit code. counts: description: Counts of processed accounts during disable calling location operation. allOf: - $ref: '#/components/schemas/DisableCallingLocationCounts' - description: Counts of processed accounts during disable calling location operation. GetMusicOnHoldObject: type: object required: - mohEnabled - mohLocationEnabled - greeting properties: mohEnabled: type: boolean example: true description: Music on hold enabled or disabled for the workspace. mohLocationEnabled: type: boolean example: true description: Music on hold enabled or disabled for the location. The music on hold setting returned in the response is used only when music on hold is enabled at the location level. When `mohLocationEnabled` is false and `mohEnabled` is true, music on hold is disabled for the workspace. When `mohLocationEnabled` is true and `mohEnabled` is false, music on hold is turned off for the workspace. In both cases, music on hold will not be played. greeting: type: string enum: - DEFAULT - CUSTOM description: "Greeting type for the workspace.\n * `DEFAULT` - Play music configured at location level.\n * `CUSTOM` - Play previously uploaded custom music when call is placed on hold or parked.\n" audioAnnouncementFile: $ref: '#/components/schemas/AudioAnnouncementFileGetObject' description: Announcement Audio File details when greeting is selected to be `CUSTOM`. PostValidateExtensionResponse: type: object required: - status - extensionStatus properties: status: type: string enum: - OK - ERRORS description: "OK , ERRORS\n * `OK` - Validated succesfully.\n * `ERRORS` - Validated with errors.\n" extensionStatus: type: array items: $ref: '#/components/schemas/extentionStatusObject' PutMusicOnHoldObject: type: object properties: mohEnabled: type: boolean example: true description: Music on hold is enabled or disabled for the workspace. greeting: type: string enum: - DEFAULT - CUSTOM description: "Greeting type for the workspace.\n * `DEFAULT` - Play music configured at location level.\n * `CUSTOM` - Play custom music when call is placed on hold or parked. An audio file must already have been successfully uploaded to specify this option.\n" audioAnnouncementFile: $ref: '#/components/schemas/AudioAnnouncementFileObject' description: Announcement Audio File details when greeting is selected to be `CUSTOM`. PutTelephonyLocationObject: type: object properties: announcementLanguage: type: string example: fr_fr description: Location's phone announcement language. callingLineId: type: object properties: name: type: string example: Denver Incoming description: Group calling line ID name. By default the org name. phoneNumber: type: string example: '+12145555698' description: Directory Number / Main number in E.164 Format. description: Location calling line information. connection: type: object properties: type: $ref: '#/components/schemas/RouteType' description: Webex Calling location API only supports setting `TRUNK` or `ROUTE_GROUP`. id: type: string example: Y2lzY29zcGFyazovL3VzL1RSVU5LL2M1MGIxZjY2LTRjODMtNDAzNy04NjM1LTg2ZjlkM2VkZDQ5MQ description: A unique identifier of route type. description: Connection details can only be modified to and from local PSTN types of `TRUNK` and `ROUTE_GROUP`. externalCallerIdName: type: string example: Big Corp-Denve description: External caller ID name value. Unicode characters. pAccessNetworkInfo: type: string example: Richardson-TX description: Emergency Location Identifier for a location. The `pAccessNetworkInfo` is set only when the location's country is Belgium(`BE`), Germany(`DE`), or France(`FR`). outsideDialDigit: type: string example: '12' description: Must dial to reach an outside line. Default is none. enforceOutsideDialDigit: type: boolean example: true description: True when enforcing outside dial digit at location level to make PSTN calls. routingPrefix: type: string example: '2' description: Must dial a prefix when calling between locations having same extension within same location, should be numeric. chargeNumber: type: string example: '+14158952369' description: Set the chargeable number for the line placing the call. When set and [useChargeNumberForPChargeInfo field (GET location)](/docs/api/v1/beta-location-call-settings-with-p-charge-info-support/get-location-webex-calling-details) is true for the location, all PSTN calls placed from this location will include a P-Charge-Info header with this specified number in the SIP INVITE. SafeDeleteCheckForDisableCallingLocationResponse: type: object description: Response from safe delete check operation for disabling a calling location. properties: locationDeleteStatus: allOf: - $ref: '#/components/schemas/LocationDeleteStatus' - description: Status of disable calling location safe delete check. blocking: $ref: '#/components/schemas/BlockingDisableCallingLocation' nonBlocking: $ref: '#/components/schemas/NonBlockingDisableCallingLocation' blockingUnlessForced: $ref: '#/components/schemas/BlockingUnlessForcedDisableCallingLocation' GetLocationCallBackNumberObject: type: object required: - locationInfo - locationMemberInfo - selected - elinExpiryTimeMinutes properties: locationInfo: type: object required: - effectiveValue - quality properties: phoneNumber: type: string example: '+12145551767' description: The location DN. name: type: string example: CPAPI_Dev_Test_Location_DND description: The name of the location. effectiveLevel: $ref: '#/components/schemas/CallBackEffectiveLevel' description: The source from which the emergency calling line ID (CLID) is selected for an actual emergency call, applying fallback rules as necessary. effectiveValue: type: string example: '+12145551767' description: Location calling line ID (CLID) number. Avaliable only when number is present and quality would be invalid. quality: $ref: '#/components/schemas/CallBackQuality' description: Used to represent whether a number is a recommended ECBN. description: Data relevant to this location. locationMemberInfo: type: object required: - effectiveValue - quality properties: phoneNumber: type: string example: '+12145551767' description: The member DN. firstName: type: string example: Jim description: The member first name. lastName: type: string example: Grey description: The member last name. Always contains `.` if the member is a place. memberId: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS82MmQ3YTY3MS00YmVlLTQ2MDItOGVkOC1jOTFmNjU5NjcxZGI description: Member ID of user/place/virtual line/hunt group within the location. memberType: $ref: '#/components/schemas/CallBackMemberType' description: Member Type. effectiveLevel: $ref: '#/components/schemas/CallBackEffectiveLevel' description: The source from which the emergency calling line ID (CLID) is selected for an actual emergency call, applying fallback rules as necessary. effectiveValue: type: string example: '+12145551767' description: Location CLID number. Avaliable only when number is present and quality would be invalid. quality: $ref: '#/components/schemas/CallBackQuality' description: Used to represent whether a number is a recommended ECBN. description: Data relevant to the user/place/virtual line/hunt group (member) selected for ECBN. selected: $ref: '#/components/schemas/CallBackSelected' description: Selected number type to configure emergency call back. elinExpiryTimeMinutes: type: integer example: 120 description: ELIN (Emergency Location Identification Number) provides location-specific callback information to emergency responders. This field indicates the time in minutes that the ELIN association remains active after being established. The default value is 60 minutes, and the valid values range from 10 to 1440 minutes. ErrorBean: type: object description: Represents an error that occurred during disable calling location operations. properties: itemNumber: type: integer description: Sequential number of the error item. item: type: string description: The item that caused the error. errorType: allOf: - $ref: '#/components/schemas/ErrorType' - description: Type of the error. error: type: object description: Error details. properties: key: type: string description: Error key or status code. message: type: array items: type: object properties: description: type: string description: Error description. code: type: string description: Error code for disable calling location operations. locationId: type: string description: Related location ID, can be null. nullable: true description: Array of error message details. trackingId: type: string description: Tracking ID for the error. ContactPayloadForModify: type: object required: - name - contacts properties: name: type: string example: My_Directory description: Receptionist Contact Directory name. The directory name should be greater than 0 and less than 41 characters in length. contacts: type: array items: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wNTUyZjY3Yi01OWE5LTQxYmItODczNi0xYjA0MWQxZGRkNWU description: Non-empty array of users or location features assigned to this Receptionist Contact Directory. LocationAvailableNumberObject: 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. owner: type: object required: - id - type properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk description: ID 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 and will only be returned when the owner `type` is `PEOPLE` or `VIRTUAL_LINE`. lastName: type: string example: Person description: Last name of the PSTN phone number's owner and will only be returned 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`. Error: type: object properties: key: type: string description: HTTP error code. message: type: array items: $ref: '#/components/schemas/ErrorMessage' description: Message string with further error information. extentionStatusObject: type: object required: - extension - state properties: extension: type: string example: '1234' description: Indicates the extention ID for the status. state: type: string enum: - VALID - DUPLICATE - DUPLICATE_IN_LIST - INVALID description: Indicates the status for the given extention ID. errorCode: type: number example: 59475 description: Error code. message: type: string example: The extension is not available. It is already assigned to a virtual extension StepExecutionStatuses: type: object required: - id properties: id: type: number description: Unique identifier that identifies each step in a job. startTime: type: string description: Step execution start time in UTC format. endTime: type: string description: Step execution end time in UTC format. lastUpdated: type: string description: Last updated time for a step in UTC format. statusMessage: type: string description: Displays status for a step. exitCode: type: string description: Exit Code for a step. name: type: string description: Step name. timeElapsed: type: string description: Time lapsed since the step execution started. AudioAnnouncementFileObject: type: object properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2QzVjBPWFIxWjJkM2FFQm1iR1Y0TWk1amFYTmpieTVqYjIw description: A unique identifier for the [announcement](/docs/api/v1/features-announcement-repository). `name`, `mediaFileType`, `level` are mandatory if `id` is not provided for uploading an announcement. If all four fields are provided, file with given `id` is used and other fields are ignored. fileName: type: string example: AUDIO_FILE.wav description: Audio announcement file name. mediaFileType: type: string enum: - WAV description: "Audio announcement file type.\n * `WAV` - WAV File Extension.\n" level: type: string enum: - ORGANIZATION - LOCATION description: "Audio announcement file type location.\n * `ORGANIZATION` - Specifies this audio file is configured across the organization.\n * `LOCATION` - Specifies this audio file is configured across the location.\n" RouteType: type: string enum: - ROUTE_GROUP - TRUNK description: " * `ROUTE_GROUP` - Route group must include at least one trunk with a maximum of 10 trunks per route group.\n * `TRUNK` - Connection between Webex Calling and the premises.\n" ListLocationObject: type: object required: - id - name - callingLineId - e911SetupRequired properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzljYTNhZmQ3LTE5MjYtNGQ0ZS05ZDA3LTk5ZDJjMGU4OGFhMA description: A unique identifier for the location. name: type: string example: '''Denver''' description: The name of the location. outsideDialDigit: type: string example: '''12''' description: Must dial to reach an outside line, default is None. enforceOutsideDialDigit: type: boolean example: true description: True when enforcing outside dial digit at location level to make PSTN calls. routingPrefix: type: string example: '''2''' description: Must dial a prefix when calling between locations having the same extension within the same location. callingLineId: type: object required: - phoneNumber properties: name: type: string example: '''Denver Incoming''' description: Group calling line ID name. By default the Org name. phoneNumber: type: string example: '+12145555698' description: Directory Number / Main number in E.164 Format. description: Location calling line information. e911SetupRequired: type: boolean example: true description: True if E911 setup is required. UpdateLocationCallCaptionsObject: type: object properties: locationClosedCaptionsEnabled: type: boolean example: true description: Enable or disable location-level closed captions. locationTranscriptsEnabled: type: boolean example: true description: Enable or disable location-level transcripts. useOrgSettingsEnabled: type: boolean example: true description: If `useOrgSettingsEnabled` is `true`, organization-level settings will control the location's closed captions and transcripts. Otherwise, location-level settings are used. AudioAnnouncementFileGetObject: type: object required: - id - fileName - mediaFileType - level properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2QzVjBPWFIxWjJkM2FFQm1iR1Y0TWk1amFYTmpieTVqYjIw description: A unique identifier for the announcement. fileName: type: string example: AUDIO_FILE.wav description: Audio announcement file name. mediaFileType: type: string enum: - WAV description: "Audio announcement file type.\n * `WAV` - WAV File Extension.\n" level: type: string enum: - ORGANIZATION - LOCATION description: "Audio announcement file type location.\n * `ORGANIZATION` - Specifies this audio file is configured across the organization.\n * `LOCATION` - Specifies this audio file is configured across the location.\n" CallBackSelected: type: string enum: - LOCATION_NUMBER - LOCATION_MEMBER_NUMBER description: " * `LOCATION_NUMBER` - Location TN.\n * `LOCATION_MEMBER_NUMBER` - Assigned number of a user, workspace, virtual line or hunt group in the location.\n" CallBackQuality: type: string enum: - RECOMMENDED - NOT_RECOMMENDED - INVALID description: " * `RECOMMENDED` - An activated number, associated with a User or Workspace.\n * `NOT_RECOMMENDED` - An activated number, associated with anything else, like Auto Attendant or Hunt Group.\n * `INVALID` - An inactive or non-existent number.\n" GetTelephonyLocationObject: type: object required: - id - name - announcementLanguage - callingLineId - connection - externalCallerIdName - userLimit - outsideDialDigit - routingPrefix - defaultDomain properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0NBTExfRk9SV0FSRElOR19TRUxFQ1RJVkVfUlVMRS9kR1Z6ZEZKMWJHVTA description: A unique identifier for the location. name: type: string example: '''Denver''' description: The name of the location. announcementLanguage: type: string example: '''fr_fr''' description: Location's phone announcement language. callingLineId: type: object required: - name - phoneNumber properties: name: type: string example: '''Denver Incoming''' description: Group calling line ID name. By default the Org name. phoneNumber: type: string example: '+12145555698' description: Directory Number / Main number in E.164 Format. description: Location calling line information. connection: type: object required: - type - id properties: type: $ref: '#/components/schemas/RouteType' description: Webex Calling location only suppports `TRUNK` and `ROUTE_GROUP` connection type. id: type: string example: '''Y2lzY29zcGFyazovL3VzL1RSVU5LL2M1MGIxZjY2LTRjODMtNDAzNy04NjM1LTg2ZjlkM2VkZDQ5MQ''' description: A unique identifier of route type. description: Connection details are only returned for local PSTN types of `TRUNK` or `ROUTE_GROUP`. subscriptionId: type: string example: '''trial''' description: PSTN connection ID given for locations with a PSTN subscription. externalCallerIdName: type: string example: '''Big Corp Denver''' description: External Caller ID Name value. Unicode characters. userLimit: type: number example: 500000 description: Limit on the number of people at the location. Read-Only. pAccessNetworkInfo: type: string example: '''Rcdn''' description: Emergency Location Identifier for a location. Set this field to provide the SIP access network information to the provider which will be used to populate the SIP P-Access-Network-Info header. This is helpful to establish the location of a device when you make an emergency call. outsideDialDigit: type: string example: '''Rcdn''' description: Must dial to reach an outside line, default is None. enforceOutsideDialDigit: type: boolean example: true description: True when enforcing outside dial digit at location level to make PSTN calls. routingPrefix: type: string example: '''2''' description: Must dial a prefix when calling between locations having same extension within same location. defaultDomain: type: string example: '''98079822.int10.bcld.webex.com''' description: IP Address, hostname, or domain. Read-Only. chargeNumber: type: string example: '+14158952369' description: Chargeable number for the line placing the call. When set and useChargeNumberForPChargeInfo is true, all PSTN calls placed from this location will include a P-Charge-Info header with this specified number in the SIP INVITE. useChargeNumberForPChargeInfo: type: boolean example: true description: Indicates whether the location's chargeNumber (if set) is enabled for use as the P-Charge-Info header in the SIP INVITE for all PSTN calls placed from this location. The field is returned as true if the location's PSTN allows use of the chargeNumber. StatusOfExtensionsObject: type: object required: - status properties: status: type: string enum: - OK - ERRORS description: "Status of the validated array of extensions.\n * `OK` - Indicates that all extensions were validated.\n * `ERRORS` - Indicates that not all extensions were validated.\n" extensionStatus: type: array items: $ref: '#/components/schemas/ExtensionStatusObject' description: Array of extensions statuses. GetPrivateNetworkConnectObject: type: object required: - networkConnectionType properties: networkConnectionType: type: string enum: - PUBLIC_INTERNET - PRIVATE_NETWORK description: "Network Connection Type for the location.\n * `PUBLIC_INTERNET` - Use public internet for the location's connection type.\n * `PRIVATE_NETWORK` - Use private network connect for the location's connection type.\n" LocationCallInterceptAvailableNumberObject: type: object required: - phoneNumber - state - isMainNumber - tollFreeNumber - telephonyType - isServiceNumber properties: phoneNumber: type: string example: '+12056350001' description: A unique identifier for the phone number. extension: type: string example: '1235' description: Extension for 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: ID of the owner to which PSTN Phone number is assigned. type: $ref: '#/components/schemas/NumberOwnerType' description: Type of the phone number's owner. firstName: type: string example: Test description: First name of the phone number's owner and will only be returned when the owner `type` is `PEOPLE` or `VIRTUAL_LINE`. lastName: type: string example: Person description: Last name of the phone number's owner and will only be returned when the owner `type` is `PEOPLE` or `VIRTUAL_LINE`. displayName: type: string example: TestWorkSpace description: Display name of the phone number's owner. This field will be present except when the owner `type` is `PEOPLE` or `VIRTUAL_LINE`. NumberObject: type: object required: - state - phoneNumberType - mainNumber - includedTelephonyTypes - tollFreeNumber - isServiceNumber properties: phoneNumber: type: string example: '+12056350001' description: A unique identifier for the phone number. extension: type: string example: '000' description: Extension for a phone number. routingPrefix: type: string example: '1234' description: Routing prefix of location. esn: type: string example: '1234000' description: Routing prefix + extension of a person or workspace. state: type: string example: ACTIVE description: Phone number's state. phoneNumberType: type: string enum: - PRIMARY - ALTERNATE - FAX - DNIS - Default description: "Returns the filtered list of phone numbers of the given `phoneNumberType`. Response excludes any extensions without numbers. Possible input values:\n * `PRIMARY` - Filter the results to include only primary phone numbers.\n * `ALTERNATE` - Filter the results to include only alternate phone numbers.\n * `FAX` - Filter the results to include only FAX phone numbers.\n * `DNIS` - Filter the results to include only Dialed Number Identification Service (DNIS) phone numbers.\n * `Default` - Filter the results to include all numbers.\n" mainNumber: type: boolean example: true description: If `true`, the phone number is used as location CLID. includedTelephonyTypes: $ref: '#/components/schemas/TelephonyType' description: The telephony type for the number. mobileNetwork: type: string example: mobileNetwork description: Mobile Network for the number if the number is MOBILE_NUMBER. routingProfile: type: string example: AttRtPf description: Routing Profile for the number if the number is MOBILE_NUMBER. tollFreeNumber: type: boolean example: true description: If `true`, the phone number is a toll-free number. isServiceNumber: type: boolean example: true description: If `true`, the phone number is a service number; otherwise, it is a standard number. location: type: object required: - id - name properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1 description: ID of location in which phone number exists. name: type: string example: Banglore description: Name of the location for phone number. owner: type: object properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk description: ID of the owner to which phone number is assigned. type: $ref: '#/components/schemas/NumberOwnerType' description: Type of the phone number's owner. firstName: type: string example: Mark description: First name of the phone number's owner. lastName: type: string example: Zand description: Last name of the phone number's owner. PostLocationAnnouncementLanguageObject: type: object required: - announcementLanguageCode properties: agentEnabled: type: boolean description: Set to `true` to change announcement language for existing people and workspaces. serviceEnabled: type: boolean description: Set to `true` to change announcement language for existing feature configurations. announcementLanguageCode: type: string example: en_us description: Language code. PaginatedResult: type: object description: Paginated response containing error items for disable calling location operations. properties: items: type: array items: $ref: '#/components/schemas/ErrorBean' description: List of error items. RouteIdentity: type: object required: - id - name - type properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQLzA1OWEyNzNlLWJiYjAtMTFlYy04NDIyLTAyNDJhYzEyMDAwMg description: ID of the route type. name: type: string example: route_identity_name description: A unique name for the route identity. type: $ref: '#/components/schemas/RouteType' description: Type associated with the identity. PostLocationCallingRequest: type: object required: - id - name - timeZone - preferredLanguage - announcementLanguage - address properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzljYTNhZmQ3LTE5MjYtNGQ0ZS05ZDA3LTk5ZDJjMGU4OGFhMA description: A unique identifier for the location. name: type: string example: '''Denver''' description: The name of the location. timeZone: type: string example: '''America/Chicago''' description: Time zone associated with this location. Refer to this link (https://developer.webex.com/docs/api/guides/webex-for-broadworks-developers-guide#webex-meetings-site-timezone) for the format. preferredLanguage: type: string example: '''en_us''' description: Default email language. announcementLanguage: type: string example: '''fr_fr''' description: Location's phone announcement language. address: type: object required: - address1 - city - state - postalCode - country properties: address1: type: string example: 771 Alder Drive description: Address 1 of the location. address2: type: string example: Cisco Site 5 description: Address 2 of the location. city: type: string example: Milpitas description: City of the location. state: type: string example: CA description: State code of the location. postalCode: type: string example: '95035' description: Postal code of the location. country: type: string example: US description: ISO-3166 2-Letter country code of the location. description: The address of the location. CallBackMemberType: type: string enum: - PEOPLE - PLACE - VIRTUAL_LINE - HUNT_GROUP description: " * `PEOPLE` - Associated member is a person.\n * `PLACE` - Associated member is a workspace.\n * `VIRTUAL_LINE` - Associated member is a virtual line.\n * `HUNT_GROUP` - Associated member is a hunt group.\n" BlockingUnlessForcedDisableCallingLocation: type: object description: Reasons that block disabling a calling location properties: nonUserEntitiesInUse: type: boolean description: Indicates if there are non-user entities in use at this location that would block disabling unless force is applied. trunksCount: type: integer description: Total number of trunks at this location. CallBackEffectiveLevel: type: string enum: - LOCATION_NUMBER - LOCATION_MEMBER_NUMBER - NONE description: " * `LOCATION_NUMBER` - Location TN.\n * `LOCATION_MEMBER_NUMBER` - Assigned number of a user, workspace, virtual line or hunt group in the location.\n * `NONE` - When no other option is selected.\n" ArrayOfExtensionsObject: type: object required: - extensions properties: extensions: type: array items: type: string description: Array of extensions that will be validated. LocationAvailableChargeNumberObject: type: object description: A phone number that is available to be assigned as the location's charge number. example: phoneNumber: '+12056852221' state: ACTIVE isMainNumber: false tollFreeNumber: false isServiceNumber: false owner: id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk type: PEOPLE firstName: Alex lastName: test_16 displayName: Alex test_16 required: - phoneNumber - state - isMainNumber - tollFreeNumber - isServiceNumber properties: phoneNumber: type: string example: '+12056350001' description: A unique identifier for the PSTN phone number. state: $ref: '#/components/schemas/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. 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: ID of the owner to which PSTN Phone number is assigned. type: $ref: '#/components/schemas/NumberOwnerType' firstName: type: string example: Test description: First name of the PSTN phone number's owner and will only be returned when the owner `type` is `PEOPLE` or `VIRTUAL_LINE`. lastName: type: string example: Person description: Last name of the PSTN phone number's owner and will only be returned 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`. LocationAvailableNumberListGetObject: type: object required: - phoneNumbers properties: phoneNumbers: type: array items: $ref: '#/components/schemas/LocationAvailableNumberObject' description: Array of phone numbers. WebexGoAvailableNumberListGetObject: type: object required: - phoneNumbers properties: phoneNumbers: type: array items: $ref: '#/components/schemas/WebexGoAvailableNumberObject' description: Array of phone numbers. BatchJobError: type: object properties: trackingId: type: string description: Unique identifier to track the HTTP requests. itemNumber: type: number description: row number of failed record. error: $ref: '#/components/schemas/Error' LocationDeleteStatus: type: string enum: - BLOCKED - UNBLOCKED - FORCE_REQUIRED description: " * `BLOCKED` - Disable Webex Calling location operation is blocked and cannot proceed.\n * `UNBLOCKED` - Disable Webex Calling location operation can proceed without any restrictions.\n * `FORCE_REQUIRED` - Disable Webex Calling location operation requires forceDelete to be set to true." NonBlockingDisableCallingLocation: type: object description: Non blocking reasons for disabling a calling location that do not prevent the operation from proceeding properties: numbersPresent: type: boolean description: Indicates if there are phone numbers at this location. PersonId: type: object properties: personId: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wNTUyZjY3Yi01OWE5LTQxYmItODczNi0xYjA0MWQxZGRkNWU description: Person ID. featureId: type: string example: Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5ULzA1NTJmNjdiLTU5YTktNDFiYi04NzM2LTFiMDQxZDFkZGQ1ZQ description: Location feature ID. type: type: string example: PEOPLE description: Types of users supported in receptionist contacts are People, Auto Attendant, Call Queue, Hunt Group, Single Number Reach, and Paging Group. DisableCallingLocationCounts: type: object description: Counts of various account types processed during disable calling location operation. properties: totalVirtualExtensionsAccount: type: integer minimum: 0 description: Total virtual extensions account. virtualExtensionsDeleted: type: integer minimum: 0 description: Number of virtual extensions deleted. virtualExtensionsDeleteFailed: type: integer minimum: 0 description: Number of virtual extensions that failed to delete. totalFeatureAccounts: type: integer minimum: 0 description: Total feature accounts. featureAccountsDeleted: type: integer minimum: 0 description: Number of feature accounts deleted. featureAccountsDeleteFailed: type: integer minimum: 0 description: Number of feature accounts that failed to delete. ContactPayload: type: object required: - name - contacts properties: name: type: string example: My_Directory description: Receptionist Contact Directory name. The directory name should be greater than 0 and less than 41 characters in length. contacts: type: array items: $ref: '#/components/schemas/PersonId' description: Non-empty array of users or location features assigned to this Receptionist Contact Directory. ErrorMessage: type: object required: - description properties: description: type: string description: Error message. code: type: string description: Internal error code. locationId: type: string description: Error messages describing the location ID in which the error occurs. For a move operation this is the target location ID. LocationECBNAvailableNumberObject: type: object required: - phoneNumber - state - isMainNumber - tollFreeNumber - telephonyType - isServiceNumber properties: phoneNumber: type: string example: '+12056350001' description: A unique identifier for the 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 phone number is assigned. type: type: string enum: - PLACE - PEOPLE - VIRTUAL_LINE - HUNT_GROUP description: "Type of the phone number's owner.\n * `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 Line.\n * `HUNT_GROUP` - PSTN Phone number's owner is a Hunt Group.\n" 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 only when the owner `type` is `PLACE` or `HUNT_GROUP`. ErrorType: type: string enum: - WARN - ERROR example: ERROR description: " * `WARN` - A warning message that doesn't block the operation.\n * `ERROR` - An error message that indicates a failure in the operation." BlockingDisableCallingLocation: type: object description: Factors that completely block disabling a calling location. properties: lastLocation: type: boolean description: Indicates if this is the last calling location in the organization. trunksInUseCount: type: integer description: Number of trunks in use at this location. usersInUseCount: type: integer description: Number of users in use at this location. workspacesInUseCount: type: integer description: Number of workspaces in use at this location. virtualLineInUseCount: type: integer description: Number of virtual lines in use at this location. numbersOrderPending: type: boolean description: Indicates if there are pending number orders for this location. PutLocationCallBackNumberObject: type: object required: - selected - locationMemberId properties: selected: $ref: '#/components/schemas/CallBackSelected' description: Selected number type to configure emergency call back. locationMemberId: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9hOTc0MzVjZi0zYTZmLTRmNGYtOWU1OC00OTI2OTQ5MDkwMWY description: Member ID of user/place/virtual line/hunt group within the location. Required if `LOCATION_MEMBER_NUMBER` is selected. elinExpiryTimeMinutes: type: integer example: 90 description: ELIN (Emergency Location Identification Number) provides location-specific callback information to emergency responders. This field indicates the time in minutes that the ELIN association remains active after being established. Valid values are between 10 and 1440 minutes. 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" LocationECBNAvailableNumberListGetObject: type: object required: - phoneNumbers properties: phoneNumbers: type: array items: $ref: '#/components/schemas/LocationECBNAvailableNumberObject' description: Array of phone numbers. Counts: type: object required: - routingPrefixUpdated - routingPrefixFailed properties: routingPrefixUpdated: type: number description: Indicates the total number of records whose routing prefix update is successful. routingPrefixFailed: type: number description: Indicates the total number of records whose routing prefix update failed. PostValidateExtension: type: object properties: extensions: type: array items: type: string example: 12345,3456 description: Array of Strings of IDs of the Extensions. ContactDetails: type: object required: - personId - firstName - lastName - department - phoneNumber - extension - locationId - featureId properties: personId: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wNTUyZjY3Yi01OWE5LTQxYmItODczNi0xYjA0MWQxZGRkNWU description: ID of person. firstName: type: string example: John description: First name of person. lastName: type: string example: Doe description: Last name of person. department: type: string example: Y2lzY29zcGFyazovL3VzL0RFUEFSVE1FTlQvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh description: Department ID of person. phoneNumber: type: string example: '+12225555309' description: Phone number of person. extension: type: string example: '5309' description: Extension of person. locationId: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA description: Location ID of person. featureId: type: string example: Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5ULzA1NTJmNjdiLTU5YTktNDFiYi04NzM2LTFiMDQxZDFkZGQ1ZQ description: Location feature ID of the contact. Supported location feature types are Auto Attendant, Call Queue, Hunt Group, Single Number Reach, and Paging Group. Directory: type: object required: - id - name properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1NDSU1fR1JPVVAvZEdWemRGOWthWEpsWTNSdmNuaz06OTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh description: ID of Receptionist Contact Directory name: type: string example: test_directory description: Name of Receptionist Contact Directory. JobExecutionStatus: type: object required: - id properties: id: type: number description: Unique identifier that identifies each instance of the job. startTime: type: string description: Job execution start time in UTC format. endTime: type: string description: Job execution end time in UTC format. lastUpdated: type: string description: Last updated time (in UTC format) post one of the step execution completion. statusMessage: type: string description: Displays status for overall steps that are part of the job. exitCode: type: string description: Exit Code for a job. createdTime: type: string description: Job creation time in UTC format. stepExecutionStatuses: type: array items: $ref: '#/components/schemas/StepExecutionStatuses' description: Status of each step within a job. ExternalCallerIdNumberListGet: type: object required: - phoneNumbers properties: phoneNumbers: type: array items: $ref: '#/components/schemas/NumberObject' description: Array of phone numbers. DisableCallingLocationPostRequest: type: object description: Request body for disabling a calling location. example: locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzk2ZjA0YjUwLTYxMWItNGViYy05ZGE0LTQwMzU4ODYxZTI4NQ locationName: San Jose HQ forceDelete: false required: - locationId properties: locationId: type: string description: Unique identifier for the calling location to disable. locationName: type: string description: Name of the calling location to disable. forceDelete: type: boolean description: Force delete is only applicable when calling features like call queues, hunt groups, virtual lines, etc or a trunk that is not in use exists in the calling location and customer still wants to disable the calling location. GetLocationCallCaptionsObject: type: object required: - locationClosedCaptionsEnabled - locationTranscriptsEnabled - orgClosedCaptionsEnabled - orgTranscriptsEnabled - useOrgSettingsEnabled properties: locationClosedCaptionsEnabled: type: boolean example: true description: Location-level closed captions are enabled or disabled. locationTranscriptsEnabled: type: boolean example: true description: Location-level transcripts are enabled or disabled. orgClosedCaptionsEnabled: type: boolean example: true description: Organization closed captions are enabled or disabled. orgTranscriptsEnabled: type: boolean example: true description: Organization transcripts are enabled or disabled. useOrgSettingsEnabled: type: boolean example: true description: If `useOrgSettingsEnabled` is `true`, organization-level settings will control the location's closed captions and transcripts. Otherwise, location-level settings are used. LocationCallingResponseWithId: type: object required: - id properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzljYTNhZmQ3LTE5MjYtNGQ0ZS05ZDA3LTk5ZDJjMGU4OGFhMA description: A unique identifier for the location. LocationAvailableChargeNumberListGetObject: type: object example: phoneNumbers: - phoneNumber: '+12056852221' state: ACTIVE isMainNumber: false tollFreeNumber: false isServiceNumber: false owner: id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk type: PEOPLE firstName: Alex lastName: test_16 displayName: Alex test_16 required: - phoneNumbers properties: phoneNumbers: type: array items: $ref: '#/components/schemas/LocationAvailableChargeNumberObject' description: Array of phone numbers. TelephonyType: type: string enum: - PSTN_NUMBER description: ' * `PSTN_NUMBER` - The object is a PSTN number. ' ExtensionStatusObject: type: object required: - state properties: extension: type: string example: '407721' description: Unique extension which will be validated at the location level. state: type: string enum: - VALID - DUPLICATE - DUPLICATE_IN_LIST - INVALID description: "State of the extension after it was validated.\n * `VALID` - Extension is valid.\n * `DUPLICATE` - Extension already assigned to another group.\n * `DUPLICATE_IN_LIST` - Extension already exists in the request body and was already verified.\n * `INVALID` - Extension is invalid.\n" errorCode: type: number example: 9495 description: Error code of the state in case extension is not valid. message: type: string example: '[Error 9495] The extension is not available. It is already assigned as a Call Park Extension: 407721.' description: Message assigned to the error code. LocationPUTResponse: type: object properties: batchJobId: type: string example: Y2lzY29zcGFyazovL3VzL0pPQl9JRC84MWU3ODFjOC1kMDI3LTQ1ZjMtODIyZi05OTRiMmYzZTA0MzA description: Admin Batch Job ID returned if a routing prefix change occurs. failureReason: type: string example: UpdateRoutingPrefix batch job not triggered for Location description: Error message if the admin batch job is not triggered if a routing prefix change occurs. PutPrivateNetworkConnectObject: type: object required: - networkConnectionType properties: networkConnectionType: type: string enum: - PUBLIC_INTERNET - PRIVATE_NETWORK description: "Network Connection Type for the location.\n * `PUBLIC_INTERNET` - Use public internet for the location's connection type.\n * `PRIVATE_NETWORK` - Use private network connect for the location's connection type.\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