openapi: 3.0.0 info: title: Webex Admin Address Book Call Routing 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: Call Routing paths: /telephony/config/actions/testCallRouting/invoke: post: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/TestCallRoutingPostResponse' example: callSourceInfo: callSourceType: DIAL_PATTERN routeListName: routeList1 routeListId: Y2lzY29zcGFyazovL3VzL1JPVVRFX0xJU1QvZDA2YWQ5M2QtY2NkOC00MzI1LTg0YzUtMDA2NThhYTdhMDBj dialPlanName: dialPlan1 dialPattern: '*888' dialPlanId: Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI destinationType: HOSTED_AGENT routingAddress: '007' outsideAccessCode: '1234' isRejected: false hostedAgent: id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mMjU4YjhmZi1lODIxLTQ3MDktYTI2My1mMmI4OWZjN2FlYmQ type: PEOPLE firstName: firstName lastName: lastName locationName: locationName locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA phoneNumber: '9874531287' extension: '111' hostedFeature: type: AUTO_ATTENDANT name: name1 id: Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2QyRXdhV2R5TVRCamIwQTJORGswTVRJNU55NXBiblF4TUM1aVkyeGtMbmRsWW1WNExtTnZiUT09 locationName: locationName1 locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA phoneNumber: '9874531287' extension: '111' pbxUser: dialPlanName: dialPlan1 dialPlanId: Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI dialPattern: 442xxx trunkName: trunkName1 trunkId: Y2lzY29zcGFyazovL3VzL1RSVU5LLzA4Yjc2MmZlLWJmYWItNGFmYi04ODQ1LTNhNzJjNGQ0NjZiOQ routeGroupName: routeGroupName1 routeGroupId: Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2YyODkyMTc0LWYxM2YtNDhjYy1iMmJhLWQ4ZmM4Yzg4MzJhYg trunkLocationName: trunkLocationName1 trunkLocationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA pstnNumber: trunkName: trunkName1 trunkId: Y2lzY29zcGFyazovL3VzL1RSVU5LLzA4Yjc2MmZlLWJmYWItNGFmYi04ODQ1LTNhNzJjNGQ0NjZiOQ routeGroupName: routeGroupName1 routeGroupId: Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2YyODkyMTc0LWYxM2YtNDhjYy1iMmJhLWQ4ZmM4Yzg4MzJhYg trunkLocationName: trunkLocationName1 trunkLocationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA virtualExtension: id: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfRVhURU5TSU9OL2U4NTU0MGJjLWFiNDMtNGZjOS05ZThlLTkxZjRkN2E3ZjU5Ng firstName: firstName1 lastName: lastName1 displayName: displayName1 extension: '0007' phoneNumber: '8701278963' locationName: locationName1 locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA trunkName: trunkName1 trunkId: Y2lzY29zcGFyazovL3VzL1RSVU5LLzA4Yjc2MmZlLWJmYWItNGFmYi04ODQ1LTNhNzJjNGQ0NjZiOQ routeGroupName: routeGroupName1 routeGroupId: Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2YyODkyMTc0LWYxM2YtNDhjYy1iMmJhLWQ4ZmM4Yzg4MzJhYg trunkLocationName: trunkLocationName1 trunkLocationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA virtualExtensionRange: id: OTI0NzM1OTQtZGU1Mi00ZjViLTk0YjItN2Y5MzRmY2Y2NDk3 name: firstName1 prefix: '+1214555' pattern: 2XXX locationName: locationName1 locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA trunkName: trunkName1 trunkId: Y2lzY29zcGFyazovL3VzL1RSVU5LLzA4Yjc2MmZlLWJmYWItNGFmYi04ODQ1LTNhNzJjNGQ0NjZiOQ routeGroupName: routeGroupName1 routeGroupId: Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2YyODkyMTc0LWYxM2YtNDhjYy1iMmJhLWQ4ZmM4Yzg4MzJhYg trunkLocationName: trunkLocationName1 trunkLocationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA routeList: id: Y2lzY29zcGFyazovL3VzL1JPVVRFX0xJU1QvZDA2YWQ5M2QtY2NkOC00MzI1LTg0YzUtMDA2NThhYTdhMDBj name: routeListName1 routeGroupName: routeGroupName1 routeGroupId: Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2YyODkyMTc0LWYxM2YtNDhjYy1iMmJhLWQ4ZmM4Yzg4MzJhYg locationName: locationName1 locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA featureAccessCode: code: '*70' name: Cancel Call Waiting emergency: isRedSky: true trunkName: trunkName1 trunkId: Y2lzY29zcGFyazovL3VzL1RSVU5LLzA4Yjc2MmZlLWJmYWItNGFmYi04ODQ1LTNhNzJjNGQ0NjZiOQ routeGroupName: routeGroupName1 routeGroupId: Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2YyODkyMTc0LWYxM2YtNDhjYy1iMmJhLWQ4ZmM4Yzg4MzJhYg trunkLocationName: trunkLocationName1 trunkLocationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA repair: trunkName: trunkName1 trunkId: Y2lzY29zcGFyazovL3VzL1RSVU5LLzA4Yjc2MmZlLWJmYWItNGFmYi04ODQ1LTNhNzJjNGQ0NjZiOQ routeGroupName: routeGroupName1 routeGroupId: Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2YyODkyMTc0LWYxM2YtNDhjYy1iMmJhLWQ4ZmM4Yzg4MzJhYg trunkLocationName: trunkLocationName1 trunkLocationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA unknownExtension: trunkName: trunkName1 trunkId: Y2lzY29zcGFyazovL3VzL1RSVU5LLzA4Yjc2MmZlLWJmYWItNGFmYi04ODQ1LTNhNzJjNGQ0NjZiOQ routeGroupName: routeGroupName1 routeGroupId: Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2YyODkyMTc0LWYxM2YtNDhjYy1iMmJhLWQ4ZmM4Yzg4MzJhYg trunkLocationName: trunkLocationName1 trunkLocationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA unknownNumber: trunkName: trunkName1 trunkId: Y2lzY29zcGFyazovL3VzL1RSVU5LLzA4Yjc2MmZlLWJmYWItNGFmYi04ODQ1LTNhNzJjNGQ0NjZiOQ routeGroupName: routeGroupName1 routeGroupId: Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2YyODkyMTc0LWYxM2YtNDhjYy1iMmJhLWQ4ZmM4Yzg4MzJhYg trunkLocationName: trunkLocationName1 trunkLocationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA appliedServices: - translationPattern: configurationLevel: ORGANIZATION name: TP1 matchingPattern: +91XXX replacementPattern: '+91234' matchedNumber: '+91236' translatedNumber: '+91234' interceptDetails: configurationLevel: USER permission: TRANSFER transferNumber: '+14157279300' outgoingCallingPlanPermissionsByType: configurationLevel: PEOPLE callType: INTERNAL_CALL permission: ALLOW transferNumber: '+14157279300' reason: FRAUD_CONTAINMENT number: '+14157279300' outgoingCallingPlanPermissionsByDigitPattern: configurationLevel: USER name: DPattern permission: ALLOW transferNumber: '+14157279300' pattern: +91! reason: FRAUD_CONTAINMENT number: '+14157279300' '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: Test Call Routing operationId: Test Call Routing description: 'Validates that an incoming call can be routed. 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. Test call routing requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Call Routing parameters: - name: orgId in: query description: Organization in which we are validating a call routing. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: originatorId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI originatorType: PEOPLE destination: '0007' includeAppliedServices: true schema: type: object required: - originatorId - originatorType - destination properties: originatorId: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI description: This element is used to identify the originating party. It can be a person ID or a trunk ID. originatorType: $ref: '#/components/schemas/OriginatorType' description: This element is used to identify if the `originatorId` is of type `PEOPLE` or `TRUNK`. originatorNumber: type: string example: '9871568630' description: Only used when `originatorType` is `TRUNK`. The `originatorNumber` can be a phone number or URI. destination: type: string example: '0007' description: This element specifies the called party. It can be any dialable string, for example, an ESN number, E.164 number, hosted user DN, extension, extension with location code, URL, or FAC code. includeAppliedServices: type: boolean example: true description: This element is used to retrieve if any translation pattern, call intercept, permission by type or permission by digit pattern is present for the called party. /telephony/config/premisePstn/trunks/{trunkId}/usageDialPlan: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object required: - dialPlans properties: dialPlans: type: array items: $ref: '#/components/schemas/DialPlanUsageGetResponse' description: Array of dial Plans. example: dialPlans: - id: Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI name: dialPlanName '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 Local Gateway Dial Plan Usage for a Trunk operationId: Get Local Gateway Dial Plan Usage for a Trunk description: 'Get Local Gateway Dial Plan Usage for a Trunk. A trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device. The trunk can be assigned to a Route Group which is a group of trunks that allow Webex Calling to distribute calls over multiple trunks or to provide redundancy. Retrieving this information requires a full administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Call Routing parameters: - name: trunkId in: path description: ID of the trunk. required: true example: Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI schema: type: string - name: orgId in: query description: Organization to which the trunk belongs. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: start in: query description: Start at the zero-based offset in the list of matching objects. example: '0' schema: type: number - name: max in: query description: Limit the number of objects returned to this maximum count. example: '5' schema: type: number - name: order in: query description: Order the trunks according to the designated fields. Available sort fields are `name`, and `locationName`. Sort order is ascending by default example: name-asc|locationName-desc schema: type: string - name: name in: query description: Return the list of trunks matching the local gateway names example: LG1,LG2 schema: type: array items: type: string example: LG1,LG2 description: Return the list of trunks matching the local gateway names /telephony/config/premisePstn/trunks/{trunkId}/usagePstnConnection: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object required: - locations properties: locations: type: array items: $ref: '#/components/schemas/Location' description: Array of locations. example: locations: - id: Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI name: locationName '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 Locations Using the Local Gateway as PSTN Connection Routing operationId: Get Locations Using the Local Gateway as PSTN Connection Routing description: 'Get Locations Using the Local Gateway as PSTN Connection Routing. A trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device. The trunk can be assigned to a Route Group which is a group of trunks that allow Webex Calling to distribute calls over multiple trunks or to provide redundancy. Retrieving this information requires a full administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Call Routing parameters: - name: trunkId in: path description: ID of the trunk. required: true example: Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI schema: type: string - name: orgId in: query description: Organization to which the trunk belongs. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/premisePstn/trunks/{trunkId}/usageRouteGroup: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object required: - routeGroup properties: routeGroup: type: array items: $ref: '#/components/schemas/RouteGroupUsageGetResponse' description: Array of route Groups. example: routeGroup: - id: NTJiZmUxNDAtYjIwMS00NTUzLWI1OGQtMmVkNDU1NTFmYTUy name: RouteGroup01 inUse: 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 Route Groups Using the Local Gateway operationId: Get Route Groups Using the Local Gateway description: 'Get Route Groups Using the Local Gateway. A trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device. The trunk can be assigned to a Route Group which is a group of trunks that allow Webex Calling to distribute calls over multiple trunks or to provide redundancy. Retrieving this information requires a full administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Call Routing parameters: - name: trunkId in: path description: ID of the trunk. required: true example: Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI schema: type: string - name: orgId in: query description: Organization to which the trunk belongs. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/premisePstn/trunks/{trunkId}/usage: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/LocalGatewayUsageCount' example: pstnConnectionCount: 1 callToExtensionCount: 1 dialPlanCount: 1 routeGroupCount: 1 '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 Local Gateway Usage Count operationId: Get Local Gateway Usage Count description: 'Get Local Gateway Usage Count A trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device. The trunk can be assigned to a Route Group which is a group of trunks that allow Webex Calling to distribute calls over multiple trunks or to provide redundancy. Retrieving this information requires a full administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Call Routing parameters: - name: trunkId in: path description: ID of the trunk. required: true example: Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI schema: type: string - name: orgId in: query description: Organization to which the trunk belongs. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/premisePstn/dialPlans/{dialPlanId}/dialPatterns: 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: Modify Dial Patterns operationId: Modify Dial Patterns description: 'Modify dial patterns for the Dial Plan. 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. Modifying a dial pattern requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Call Routing parameters: - name: dialPlanId in: path description: ID of the dial plan being modified. required: true example: Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI schema: type: string - name: orgId in: query description: Organization to which dial plan belongs. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DialPatternPut' /telephony/config/premisePstn/actions/validateDialPatterns/invoke: post: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/DialPatternValidateResult' example: status: ERRORS dialPatternStatus: - dialPattern: '+4555' patternStatus: INVALID message: invalid format for premises dial pattern +4555 '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 a Dial Pattern operationId: Validate a Dial Pattern description: 'Validate a Dial Pattern. 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. Validating a dial pattern requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Call Routing parameters: - name: orgId in: query description: Organization to which dial plan belongs. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: schema: type: object required: - dialPatterns properties: dialPatterns: type: array items: type: string example: +5555,7777 description: Array of dial patterns. /telephony/config/premisePstn/dialPlans: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object required: - dialPlans properties: dialPlans: type: array items: $ref: '#/components/schemas/DialPlan' description: Array of dial plans. example: dialPlans: - id: Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI name: dialPlanName routeId: Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQLzA1OWEyNzNlLWJiYjAtMTFlYy04NDIyLTAyNDJhYzEyMDAwMg routeName: routeName routeType: 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 Dial Plans operationId: Read the List of Dial Plans description: 'List all Dial Plans for the organization. Dial plans route calls to on-premises destinations by use of the trunks or route groups with which the dial plan is associated. Multiple dial patterns can be defined as part of your dial plan. Dial plans are configured globally for an enterprise and apply to all users, regardless of location. Retrieving this list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Call Routing parameters: - name: orgId in: query description: List dial plans for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: dialPlanName in: query description: Return the list of dial plans matching the dial plan name. example: dialPlanName schema: type: string - name: routeGroupName in: query description: Return the list of dial plans matching the Route group name.. example: routeGroupName schema: type: string - name: trunkName in: query description: Return the list of dial plans 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 dial plans according to the designated fields. Available sort fields: `name`, `routeName`, `routeType`. Sort order is ascending by default' example: dpName-asc|rnTest-desc|TRUNK-desc schema: type: string post: responses: '201': description: Created headers: {} content: application/json: schema: type: object required: - id properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQLzA1OWEyNzNlLWJiYjAtMTFlYy04NDIyLTAyNDJhYzEyMDAwMg description: ID of the newly created dial plan. example: id: Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQLzA1OWEyNzNlLWJiYjAtMTFlYy04NDIyLTAyNDJhYzEyMDAwMg '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 Dial Plan operationId: Create a Dial Plan description: 'Create a Dial Plan 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. Creating a dial plan requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Call Routing parameters: - name: orgId in: query description: Organization to which dial plan belongs. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DialPlanPost' /telephony/config/premisePstn/dialPlans/{dialPlanId}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/DialPlanGet' example: id: Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI name: dialPlanName routeId: Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQLzA1OWEyNzNlLWJiYjAtMTFlYy04NDIyLTAyNDJhYzEyMDAwMg routeName: routeName routeType: ROUTE_GROUP customer: id: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE name: test_org '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 Dial Plan operationId: Get a Dial Plan description: 'Get a Dial Plan 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 a dial plan requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Call Routing parameters: - name: dialPlanId in: path description: ID of the dial plan. required: true example: Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI schema: type: string - name: orgId in: query description: Organization to which dial plan belongs. 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: Modify a Dial Plan operationId: Modify a Dial Plan description: 'Modify a Dial Plan 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. Modifying a dial plan requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Call Routing parameters: - name: dialPlanId in: path description: ID of the dial plan being modified. required: true example: Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI schema: type: string - name: orgId in: query description: Organization to which dial plan belongs. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DialPlanPut' 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 Dial Plan operationId: Delete a Dial Plan description: 'Delete a Dial Plan 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. Deleting a dial plan requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Call Routing parameters: - name: dialPlanId in: path description: ID of the dial plan. required: true example: Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI schema: type: string - name: orgId in: query description: Organization to which dial plan belongs. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/premisePstn/trunks/actions/fqdnValidation/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: Validate Local Gateway FQDN and Domain for a Trunk operationId: Validate Local Gateway FQDN and Domain for a Trunk description: 'Validate Local Gateway FQDN and Domain for the organization trunks. A Trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device. The trunk can be assigned to a Route Group - a group of trunks that allow Webex Calling to distribute calls over multiple trunks or to provide redundancy. Validating Local Gateway FQDN and Domain requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Call Routing parameters: - name: orgId in: query description: Organization to which trunk types belongs. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/TrunkFQDNValidatePost' /telephony/config/premisePstn/trunks: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object required: - trunks properties: trunks: type: array items: $ref: '#/components/schemas/Trunk' description: Array of trunks. example: trunks: - id: Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI name: trunkName location: id: Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI name: locationName inUse: true trunkType: REGISTERING isRestrictedToDedicatedInstance: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Read the List of Trunks operationId: Read the List of Trunks description: 'List all Trunks for the organization. A Trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device. The trunk can be assigned to a Route Group - a group of trunks that allow Webex Calling to distribute calls over multiple trunks or to provide redundancy. Retrieving this list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Call Routing parameters: - name: orgId in: query description: List trunks for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: name in: query description: Return the list of trunks matching the local gateway names. example: LG1,LG2 schema: type: array items: type: string example: LG1,LG2 description: Return the list of trunks matching the local gateway names. - name: locationName in: query description: Return the list of trunks matching the location names. example: Boston,SJ-1 schema: type: array items: type: string example: Boston,SJ-1 description: Return the list of trunks matching the location names. - name: trunkType in: query description: Return the list of trunks matching the trunk type. example: REGISTERING 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 trunks according to the designated fields. Available sort fields: name, locationName. Sort order is ascending by default' example: name-asc|locationName-desc schema: type: string post: responses: '201': description: Created headers: {} content: application/json: schema: type: object required: - id properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQLzA1OWEyNzNlLWJiYjAtMTFlYy04NDIyLTAyNDJhYzEyMDAwMg description: ID of the newly created trunk. example: id: Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQLzA1OWEyNzNlLWJiYjAtMTFlYy04NDIyLTAyNDJhYzEyMDAwMg '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 Trunk operationId: Create a Trunk description: 'Create a Trunk for the organization. A Trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device. The trunk can be assigned to a Route Group which is a group of trunks that allow Webex Calling to distribute calls over multiple trunks or to provide redundancy. Creating a trunk requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Call Routing parameters: - name: orgId in: query description: Organization to which the trunk belongs. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/TrunkPost' /telephony/config/premisePstn/trunks/{trunkId}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/TrunkGet' example: name: trunkName customer: id: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE name: test_org location: id: Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI name: locationName otgDtgId: lg1_sias10_cpapi12446_lgu linePort: lg1_sias10_cpapi16004_LGU@64941297.int10.bcld.webex.com locationsUsingTrunk: - id: Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI name: locationName pilotUserId: lg1_sias10_cpapi12446_LGU@64941297.int10.bcld.webex.com sipAuthenticationUserName: lg1_sias10_cpapi12446_LGU status: ONLINE errorCodes: - errorCodes responseStatus: code: 25013 type: ERROR summaryEnglish: 'CPAPI: Error retrieving outboundproxy.' detail: - 'OCI-P GroupOutboundProxyGetRequest: [Error 26088] Cloud PBX Console is not configured properly., OCI-P Error code: [Error 26088] Cloud PBX Console is not configured properly.' trackingId: CPAPI_2da34568-1e72-4196-b613-905ce45ec592_0 dualIdentitySupportEnabled: true trunkType: REGISTERING deviceType: Cisco Unified Border Element address: lgw1.london domain: acme.corp port: 5000 maxConcurrentCalls: 1000 isRestrictedToDedicatedInstance: true pChargeInfoSupportPolicy: DISABLED '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 Trunk operationId: Get a Trunk description: 'Get a Trunk for the organization. A Trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device. The trunk can be assigned to a Route Group - a group of trunks that allow Webex Calling to distribute calls over multiple trunks or to provide redundancy. Retrieving a trunk requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Call Routing parameters: - name: trunkId in: path description: ID of the trunk. required: true example: Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI schema: type: string - name: orgId in: query description: Organization to which trunk belongs. 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: Modify a Trunk operationId: Modify a Trunk description: 'Modify a Trunk for the organization. A Trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device. The trunk can be assigned to a Route Group - a group of trunks that allow Webex Calling to distribute calls over multiple trunks or to provide redundancy. Modifying a trunk requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Call Routing parameters: - name: trunkId in: path description: ID of the trunk being modified. required: true example: Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI schema: type: string - name: orgId in: query description: Organization to which trunk belongs. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/TrunkPut' 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 Trunk operationId: Delete a Trunk description: 'Delete a Trunk for the organization. A Trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device. The trunk can be assigned to a Route Group - a group of trunks that allow Webex Calling to distribute calls over multiple trunks or to provide redundancy. Deleting a trunk requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Call Routing parameters: - name: trunkId in: path description: ID of the trunk. required: true example: Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI schema: type: string - name: orgId in: query description: Organization to which trunk belongs. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/premisePstn/trunks/trunkTypes: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/TrunkTypeGetList' example: trunkTypes: - trunkType: REGISTERING deviceTypes: - deviceType: Cisco Unified Border Element minConcurrentCalls: 250 maxConcurrentCalls: 1000 '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 Trunk Types operationId: Read the List of Trunk Types description: 'List all Trunk Types with Device Types for the organization. A Trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device. The trunk can be assigned to a Route Group which is a group of trunks that allow Webex Calling to distribute calls over multiple trunks or to provide redundancy. Trunk Types are Registering or Certificate Based and are configured in Call Manager. Retrieving trunk types requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Call Routing parameters: - name: orgId in: query description: Organization to which the trunk types belong. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/premisePstn/routeGroups: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object required: - routeGroups properties: routeGroups: type: array items: $ref: '#/components/schemas/RouteGroup' description: Array of route groups. example: routeGroups: - id: Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2ZjN2EzZDU2LTg1OGMtNDVkZC1iZDA1LTE2OWM2NGU1OTRmMQ name: Route Group 01 inUse: true '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Read the List of Routing Groups operationId: Read the List of Routing Groups description: 'List all Route Groups for an organization. A Route Group is a group of trunks that allows further scale and redundancy with the connection to the premises. Retrieving this route group list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Call Routing parameters: - name: orgId in: query description: List route groups for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: name in: query description: Return the list of route groups matching the Route group name.. example: routeGroupName 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 groups according to designated fields. Available sort orders are `asc` and `desc`. example: name-asc|ROUTE_GROUP-desc schema: type: string post: responses: '201': description: Created headers: {} content: application/json: schema: $ref: '#/components/schemas/PostResponse' example: id: Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQLzE4YzFhMGRkLWJhMjctNDkwMS1hNGUxLTBlNWIyNzM1YzlkZg '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 Route Group for a Organization operationId: Create Route Group for a Organization description: 'Creates a Route Group for the organization. A Route Group is a collection of trunks that allows further scale and redundancy with the connection to the premises. Route groups can include up to 10 trunks from different locations. Creating a Route Group requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Call Routing parameters: - name: orgId in: query description: Organization to which the Route Group belongs. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: name: hydra2 localGateways: - id: Y2lzY29zcGFyazovL3VzL1RSVU5LLzY1Zjc4YzgxLTcwMTYtNDc0Ny05M2EyLWIxMGVlZjBhMWI1Ng name: Route List Trunk locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL1dTV1laMjEyODA2TDIxMjg0MQ priority: 1 schema: $ref: '#/components/schemas/RouteGroupPost' /telephony/config/premisePstn/routeGroups/{routeGroupId}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/RouteGroupGet' example: name: hydra2 organization: name: ATLAS_TEST_LIEM_RL id: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi80MWQxNDNiYi1hMjEwLTQ5YTQtOGNkZC1hYzc2YzYxMmE0YzM localGateways: - id: Y2lzY29zcGFyazovL3VzL1RSVU5LLzc3MDY3YjcyLTk4NzEtNDJmNi1iMzdhLTQ3ZWZmMjUyNjdjNg name: Route List Trunk 2 locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL1dTV1laMjEyODA2TDIxMjgwNw priority: 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.' '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 a Route Group for a Organization operationId: Read a Route Group for a Organization description: 'Reads a Route Group for the organization based on id. A Route Group is a collection of trunks that allows further scale and redundancy with the connection to the premises. Route groups can include up to 10 trunks from different locations. Reading a Route Group requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Call Routing parameters: - name: routeGroupId in: path description: Route Group for which details are being requested. required: true example: Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQLzE4YzFhMGRkLWJhMjctNDkwMS1hNGUxLTBlNWIyNzM1YzlkZg schema: type: string - name: orgId in: query description: Organization of the Route Group. 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: Modify a Route Group for a Organization operationId: Modify a Route Group for a Organization description: 'Modifies an existing Route Group for an organization based on id. A Route Group is a collection of trunks that allows further scale and redundancy with the connection to the premises. Route groups can include up to 10 trunks from different locations. Modifying a Route Group requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Call Routing parameters: - name: routeGroupId in: path description: Route Group for which details are being requested. required: true example: Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQLzE4YzFhMGRkLWJhMjctNDkwMS1hNGUxLTBlNWIyNzM1YzlkZg schema: type: string - name: orgId in: query description: Organization of the Route Group. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: name: hydra4 localGateways: - id: Y2lzY29zcGFyazovL3VzL1RSVU5LLzY1Zjc4YzgxLTcwMTYtNDc0Ny05M2EyLWIxMGVlZjBhMWI1Ng name: Route List Trunk locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL1dTV1laMjEyODA2TDIxMjg0MQ priority: 2 schema: $ref: '#/components/schemas/RouteGroupPatch' 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: Remove a Route Group from an Organization operationId: Remove a Route Group from an Organization description: 'Remove a Route Group from an Organization based on id. A Route Group is a collection of trunks that allows further scale and redundancy with the connection to the premises. Route groups can include up to 10 trunks from different locations. Removing a Route Group requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Call Routing parameters: - name: routeGroupId in: path description: Route Group for which details are being requested. required: true example: Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQLzE4YzFhMGRkLWJhMjctNDkwMS1hNGUxLTBlNWIyNzM1YzlkZg schema: type: string - name: orgId in: query description: Organization of the Route Group. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/premisePstn/routeGroups/{routeGroupId}/usage: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object required: - pstnConnectionCount - callToExtensionCount - dialPlanCount - routeListCount properties: pstnConnectionCount: type: string example: '1' description: Number of PSTN connection locations associated to this route group. callToExtensionCount: type: string example: '1' description: Number of call to extension locations associated to this route group. dialPlanCount: type: string example: '1' description: Number of dial plan locations associated to this route group. routeListCount: type: string example: '1' description: Number of route list locations associated to this route group. example: pstnConnectionCount: '1' callToExtensionCount: '1' dialPlanCount: '1' routeListCount: '1' '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 Usage of a Routing Group operationId: Read the Usage of a Routing Group description: 'List the number of "Call to" on-premises Extensions, Dial Plans, PSTN Connections, and Route Lists used by a specific Route Group. Users within Call to Extension locations are registered to a PBX which allows you to route unknown extensions (calling number length of 2-6 digits) to the PBX using an existing Trunk or Route Group. PSTN Connections may be a Cisco PSTN, a cloud-connected PSTN, or a premises-based PSTN (local gateway). Dial Plans allow you to route calls to on-premises extensions via your trunk or route group. Route Lists are a list of numbers that can be reached via a route group and can be used to provide cloud PSTN connectivity to Webex Calling Dedicated Instance. Retrieving usage information requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Call Routing parameters: - name: routeGroupId in: path description: ID of the requested Route group. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzUyOTA4Mg schema: type: string - name: orgId in: query description: Organization associated with the specific route group. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string /telephony/config/premisePstn/routeGroups/{routeGroupId}/usageCallToExtension: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object required: - locations properties: locations: type: array items: $ref: '#/components/schemas/Location' description: Array of locations. example: locations: - id: Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI name: locationName '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 Call to Extension Locations of a Routing Group operationId: Read the Call to Extension Locations of a Routing Group description: 'List "Call to" on-premises Extension Locations for a specific route group. Users within these locations are registered to a PBX which allows you to route unknown extensions (calling number length of 2-6 digits) to the PBX using an existing trunk or route group. Retrieving this location list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Call Routing parameters: - name: routeGroupId in: path description: ID of the requested Route group. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzUyOTA4Mg schema: type: string - name: orgId in: query description: Organization associated with specific route group. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: locationName in: query description: Return the list of locations matching the location name. example: locationName 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 locations according to designated fields. Available sort orders are `asc`, and `desc`. example: name-asc|locationName-desc schema: type: string /telephony/config/premisePstn/routeGroups/{routeGroupId}/usageDialPlan: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object required: - locations properties: locations: type: array items: $ref: '#/components/schemas/Location' description: Array of locations. example: locations: - id: Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI name: locationName '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 Dial Plan Locations of a Routing Group operationId: Read the Dial Plan Locations of a Routing Group description: 'List Dial Plan Locations for a specific route group. Dial Plans allow you to 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 location list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Call Routing parameters: - name: routeGroupId in: path description: ID of the requested Route group. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzUyOTA4Mg schema: type: string - name: orgId in: query description: Organization associated with specific route group. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: locationName in: query description: Return the list of locations matching the location name. example: locationName 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 locations according to designated fields. Available sort orders are `asc`, and `desc`. example: name-asc|locationName-desc schema: type: string /telephony/config/premisePstn/routeGroups/{routeGroupId}/usagePstnConnection: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object required: - locations properties: locations: type: array items: $ref: '#/components/schemas/Location' description: Array of locations. example: locations: - id: Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI name: locationName '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 PSTN Connection Locations of a Routing Group operationId: Read the PSTN Connection Locations of a Routing Group description: 'List PSTN Connection Locations for a specific route group. This solution lets you configure users to use Cloud PSTN (CCP or Cisco PSTN) or Premises-based PSTN. Retrieving this Location list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Call Routing parameters: - name: routeGroupId in: path description: ID of the requested Route group. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzUyOTA4Mg schema: type: string - name: orgId in: query description: Organization associated with specific route group. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: locationName in: query description: Return the list of locations matching the location name. example: locationName 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 locations according to designated fields. Available sort orders are `asc`, and `desc`. example: name-asc|locationName-desc schema: type: string /telephony/config/premisePstn/routeGroups/{routeGroupId}/usageRouteList: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object required: - routeGroupUsageRouteListGet properties: routeGroupUsageRouteListGet: type: array items: $ref: '#/components/schemas/RouteGroupUsageRouteListGet' description: Array of route lists. example: routeGroupUsageRouteListGet: - routeLists: - id: Y2lzY29zcGFyazovL3VzL1JPVVRFX0xJU1QvOTljNjJkMGQtNmFhYi00NGQ0LWE0ZTctZjk0MjQ4OWVhMWJj name: routeListName locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2JjNWUwNWFjLTI5ZmEtNGY0NS05MmM1LWUxZTExMDc0OTIwZg locationName: locationName '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 Route Lists of a Routing Group operationId: Read the Route Lists of a Routing Group description: 'List Route Lists for a specific route group. Route Lists are a list of numbers that can be reached via a Route Group. It can be used to provide cloud PSTN connectivity to Webex Calling Dedicated Instance. Retrieving this list of Route Lists requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Call Routing parameters: - name: routeGroupId in: path description: ID of the requested Route group. required: true example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzUyOTA4Mg schema: type: string - name: orgId in: query description: Organization associated with specific route group. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: name in: query description: Return the list of locations matching the location name. example: locationName 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 locations according to designated fields. Available sort orders are `asc`, and `desc`. example: name-asc|locationName-desc schema: type: string /telephony/config/premisePstn/routeLists: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object required: - routeLists properties: routeLists: type: array items: $ref: '#/components/schemas/RouteListListGet' description: Array of route lists. example: routeLists: - id: Y2lzY29zcGFyazovL3VzL1JPVVRFX0xJU1QvOTljNjJkMGQtNmFhYi00NGQ0LWE0ZTctZjk0MjQ4OWVhMWJj name: RouteList Name locationId: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2JjNWUwNWFjLTI5ZmEtNGY0NS05MmM1LWUxZTExMDc0OTIwZg locationName: locationName routeGroupId: Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2ZjN2EzZDU2LTg1OGMtNDVkZC1iZDA1LTE2OWM2NGU1OTRmMQ routeGroupName: RouteGroup01 '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 Route Lists operationId: Read the List of Route Lists description: 'List all Route Lists for the organization. A Route List is a list of numbers that can be reached via a Route Group. It can be used to provide cloud PSTN connectivity to Webex Calling Dedicated Instance. Retrieving the Route List requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Call Routing parameters: - name: orgId in: query description: List all Route List for this organization. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: start in: query description: Start at the zero-based offset in the list of matching objects. example: '0' schema: type: number - name: max in: query description: Limit the number of objects returned to this maximum count. example: '5' schema: type: number - name: order in: query description: Order the Route List according to the designated fields. Available sort fields are `name`, and `locationId`. Sort order is ascending by default example: name-asc|locationName-desc schema: type: string - name: name in: query description: Return the list of Route List matching the route list name. example: LG1,LG2 schema: type: array items: type: string example: LG1,LG2 description: Return the list of Route List matching the route list name. - name: locationId in: query description: Return the list of Route Lists matching the location id. example: 36e1e3f5-ba81-44b4-9dd5-b22ee4f5022d schema: type: array items: type: string example: 36e1e3f5-ba81-44b4-9dd5-b22ee4f5022d description: Return the list of Route Lists matching the location id. post: responses: '201': description: Created headers: {} content: application/json: schema: type: object required: - id properties: id: type: string example: NjA1MDA2YzMtYjQxNy00YmIxLTg4ZDItMDRjYThkNThiYjYy description: ID of the newly route list created. example: id: NjA1MDA2YzMtYjQxNy00YmIxLTg4ZDItMDRjYThkNThiYjYy '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 Route List operationId: Create a Route List description: 'Create a Route List for the organization. A Route List is a list of numbers that can be reached via a Route Group. It can be used to provide cloud PSTN connectivity to Webex Calling Dedicated Instance. Creating a Route List requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Call Routing parameters: - name: orgId in: query description: Organization to which the Route List belongs. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/RouteListPost' /telephony/config/premisePstn/routeLists/{routeListId}: 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 Route List operationId: Delete a Route List description: 'Delete a route list for a customer. A Route List is a list of numbers that can be reached via a Route Group. It can be used to provide cloud PSTN connectivity to Webex Calling Dedicated Instance. Deleting a Route List requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Call Routing parameters: - name: routeListId in: path description: ID of the Route List. required: true example: cbd93770-e6a3-448b-9bdf-86dbad3918c2 schema: type: string - name: orgId in: query description: Organization to which the Route List belongs. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/RouteListGet' example: name: Route List 01 location: id: Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI name: locationName routeGroup: id: Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2ZjN2EzZDU2LTg1OGMtNDVkZC1iZDA1LTE2OWM2NGU1OTRmMQ name: Route Group 01 inUse: 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 a Route List operationId: Get a Route List description: 'Get a rout list details. A Route List is a list of numbers that can be reached via a Route Group. It can be used to provide cloud PSTN connectivity to Webex Calling Dedicated Instance. Retrieving a Route List requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Call Routing parameters: - name: routeListId in: path description: ID of the Route List. required: true example: Y2JkOTM3NzAtZTZhMy00NDhiLTliZGYtODZkYmFkMzkxOGMy schema: type: string - name: orgId in: query description: Organization to which the Route List belongs. 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: Modify a Route List operationId: Modify a Route List description: 'Modify the details for a Route List. A Route List is a list of numbers that can be reached via a Route Group. It can be used to provide cloud PSTN connectivity to Webex Calling Dedicated Instance. Retrieving a Route List requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Call Routing parameters: - name: routeListId in: path description: ID of the Route List. required: true example: Y2JkOTM3NzAtZTZhMy00NDhiLTliZGYtODZkYmFkMzkxOGMy schema: type: string - name: orgId in: query description: Organization to which the Route List belongs. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/RouteListPatch' /telephony/config/premisePstn/routeLists/{routeListId}/numbers: put: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: numberStatus: type: array items: $ref: '#/components/schemas/RouteListNumberPatchResponse' description: Array of number statuses. example: numberStatus: - phoneNumber: '+2147891122' numberStatus: DUPLICATE message: Invalid Number '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 Numbers for Route List operationId: Modify Numbers for Route List description: 'Modify numbers for a specific Route List of a Customer. A Route List is a list of numbers that can be reached via a Route Group. It can be used to provide cloud PSTN connectivity to Webex Calling Dedicated Instance. Retrieving a Route List requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Call Routing parameters: - name: routeListId in: path description: ID of the Route List. required: true example: cbd93770-e6a3-448b-9bdf-86dbad3918c2 schema: type: string - name: orgId in: query description: Organization to which the Route List belongs. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: schema: type: object properties: numbers: type: array items: $ref: '#/components/schemas/RouteListNumberPatch' description: Array of the numbers to be deleted/added. deleteAllNumbers: type: boolean example: true description: If present, the numbers array is ignored and all numbers in the route list are deleted. get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/RouteListNumberListGet' example: numbers: [] '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.' '405': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.' '410': description: 'Gone: The requested resource is no longer available.' '415': description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.' '423': description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.' '428': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.' '500': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get Numbers assigned to a Route List operationId: Get Numbers assigned to a Route List description: 'Get numbers assigned to a Route List A Route List is a list of numbers that can be reached via a Route Group. It can be used to provide cloud PSTN connectivity to Webex Calling Dedicated Instance. Retrieving a Route List requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_write`.' tags: - Call Routing parameters: - name: routeListId in: path description: ID of the Route List. required: true example: cbd93770-e6a3-448b-9bdf-86dbad3918c2 schema: type: string - name: orgId in: query description: Organization to which the Route List belongs. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: start in: query description: Start at the zero-based offset in the list of matching objects. example: '0' schema: type: number - name: max in: query description: Limit the number of objects returned to this maximum count. example: '5' schema: type: number - name: number in: query description: Number assigned to the route list. example: '+2147891122' schema: type: string - name: order in: query description: Order the Route Lists according to number, ascending or descending. example: number-asc|number-desc schema: type: string /telephony/config/premisePstn/trunks/{trunkId}/usageCallToExtension: get: responses: '200': description: OK headers: {} content: application/json: schema: type: object required: - locations properties: locations: type: array items: $ref: '#/components/schemas/Location' description: Array of locations associated with the trunk. example: locations: - id: Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI name: locationName '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 Local Gateway Call to On-Premises Extension Usage for a Trunk operationId: Get Local Gateway Call to On-Premises Extension Usage for a Trunk description: 'Get local gateway call to on-premises extension usage for a trunk. A trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device. The trunk can be assigned to a Route Group which is a group of trunks that allow Webex Calling to distribute calls over multiple trunks or to provide redundancy. Retrieving this information requires a full administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Call Routing parameters: - name: trunkId in: path description: ID of the trunk. required: true example: Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI schema: type: string - name: orgId in: query description: Organization to which the trunk belongs. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: start in: query description: Start at the zero-based offset in the list of matching objects. example: '0' schema: type: number - name: max in: query description: Limit the number of objects returned to this maximum count. example: '5' schema: type: number - name: order in: query description: Order the trunks according to the designated fields. Available sort fields are `name`, and `locationName`. Sort order is ascending by default example: name-asc|locationName-desc schema: type: string - name: name in: query description: Return the list of trunks matching the local gateway names example: LG1,LG2 schema: type: array items: type: string example: LG1,LG2 description: Return the list of trunks matching the local gateway names /telephony/config/callRouting/translationPatterns: post: responses: '201': description: Created headers: {} content: application/json: schema: $ref: '#/components/schemas/ResponseId' example: id: Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3 '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 Translation Pattern for an Organization operationId: Create a Translation Pattern for an Organization description: 'Create a translation pattern for a given organization. A translation pattern lets you manipulate dialed digits before routing a call and applies to outbound calls only. See [this article](https://help.webex.com/en-us/article/nib9o6h/Translation-patterns-for-outbound-calls) for details about the translation pattern syntax. Requires a full administrator auth token with the `spark-admin:telephony_config_write` scope.' tags: - Call Routing parameters: - name: orgId in: query description: ID of the organization containing the translation pattern. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: name: CHNHelpDesk matchingPattern: +91[2-7]XX21 replacementPattern: '+91352133' schema: $ref: '#/components/schemas/TranslationPatternCreateRequest' get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/TranslationPatternGetList' example: translationPatterns: - id: Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3 name: TranslationPattern1 matchingPattern: '781' replacementPattern: '+91348781' level: Organization - id: Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V5 name: TranslationPattern2 matchingPattern: 2XXX replacementPattern: '2013' level: Location location: name: CHN11 id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzc4YzU5NDE2LTQ5YWQtNDVlMy04NmIyLTFkZjU5M2IyZDdhYQ '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: Retrieve the list of Translation Patterns operationId: Retrieve the list of Translation Patterns description: 'Retrieve a list of translation patterns for a given organization. A translation pattern lets you manipulate dialed digits before routing a call and applies to outbound calls only. See [this article](https://help.webex.com/en-us/article/nib9o6h/Translation-patterns-for-outbound-calls) for details about the translation pattern syntax. Requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Call Routing parameters: - name: orgId in: query description: ID of the organization containing the translation patterns. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: limitToLocationId in: query description: When a location ID is passed, then return only the corresponding location level translation patterns. example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx schema: type: string - name: limitToOrgLevelEnabled in: query description: When set to be `true`, then return only the organization-level translation patterns. example: 'true' 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: Sort the list of translation patterns according to translation pattern name, ascending or descending. example: name-asc|name-desc schema: type: string - name: name in: query description: Only return translation patterns with the matching `name`. example: Pattern1 schema: type: string - name: matchingPattern in: query description: Only return translation patterns with the matching `matchingPattern`. example: '+2323' schema: type: string /telephony/config/callRouting/translationPatterns/{translationId}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/TranslationPatternGet' example: id: Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3 name: TranslationPattern1 matchingPattern: '781' replacementPattern: '+91348781' '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: Retrieve a specific Translation Pattern for an Organization operationId: Retrieve a specific Translation Pattern for an Organization description: 'Retrieve the details of a translation pattern for a given organization. A translation pattern lets you manipulate dialed digits before routing a call and applies to outbound calls only. See [this article](https://help.webex.com/en-us/article/nib9o6h/Translation-patterns-for-outbound-calls) for details about the translation pattern syntax. Requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Call Routing parameters: - name: orgId in: query description: ID of the organization containing the translation pattern. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: translationId in: path description: Retrieve the translation pattern with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL0RJR0lUX1BBVFRFUk5TLzg3NGRjMjM1LTgwNTktNGM4OC05ZjU5LTRiNjdkZDJhZTZjMg 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: Modify a specific Translation Pattern for an Organization operationId: Modify a specific Translation Pattern for an Organization description: 'Modify a translation pattern for a given organization. A translation pattern lets you manipulate dialed digits before routing a call and applies to outbound calls only. See [this article](https://help.webex.com/en-us/article/nib9o6h/Translation-patterns-for-outbound-calls) for details about the translation pattern syntax. Requires a full administrator auth token with the `spark-admin:telephony_config_write` scope.' tags: - Call Routing parameters: - name: orgId in: query description: ID of the organization containing the translation pattern. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: translationId in: path description: Modify translation pattern with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL0RJR0lUX1BBVFRFUk5TLzg3NGRjMjM1LTgwNTktNGM4OC05ZjU5LTRiNjdkZDJhZTZjMg schema: type: string requestBody: content: application/json: example: name: CHNHelpDesk matchingPattern: +91[2-7]XX21 replacementPattern: '+91352133' schema: $ref: '#/components/schemas/TranslationPatternModifyRequest' 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 specific Translation Pattern operationId: Delete a specific Translation Pattern description: 'Delete a translation pattern for a given organization. A translation pattern lets you manipulate dialed digits before routing a call and applies to outbound calls only. See [this article](https://help.webex.com/en-us/article/nib9o6h/Translation-patterns-for-outbound-calls) for details about the translation pattern syntax. Requires a full administrator auth token with the `spark-admin:telephony_config_write` scope.' tags: - Call Routing parameters: - name: orgId in: query description: ID of the organization containing the translation pattern. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: translationId in: path description: Delete a translation pattern with the matching ID. required: true example: Y2lzY29zcGFyazovL3VzL0RJR0lUX1BBVFRFUk5TLzg3NGRjMjM1LTgwNTktNGM4OC05ZjU5LTRiNjdkZDJhZTZjMg schema: type: string /telephony/config/locations/{locationId}/callRouting/translationPatterns: post: responses: '201': description: Created headers: {} content: application/json: schema: $ref: '#/components/schemas/ResponseId' example: id: Y2lzY29zcGFyazovL3VzL0RJR0lUX1BBVFRFUk5TLzg3NGRjMjM1LTgwNTktNGM4OC05ZjU5LTRiNjdkZDJhZTZjMg '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 Translation Pattern for a Location operationId: Create a Translation Pattern for a Location description: 'Create a translation pattern for a given location. A translation pattern lets you manipulate dialed digits before routing a call and applies to outbound calls only. See [this article](https://help.webex.com/en-us/article/nib9o6h/Translation-patterns-for-outbound-calls) for details about the translation pattern syntax. Requires a full administrator auth token with the `spark-admin:telephony_config_write` scope.' tags: - Call Routing parameters: - name: locationId in: path description: Unique identifier for the location. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: Only admin users of another organization (such as partners) may use this parameter since the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string requestBody: content: application/json: example: name: CHNHelpDesk matchingPattern: +91[2-7]XX21 replacementPattern: '+91352133' schema: $ref: '#/components/schemas/LocationTranslationPatternCreateRequest' /telephony/config/locations/{locationId}/callRouting/translationPatterns/{translationId}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/LocationTranslationPatternGet' '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: Retrieve a specific Translation Pattern for a Location operationId: Retrieve a specific Translation Pattern for a Location description: 'Retrieve a specific translation pattern for a given location. A translation pattern lets you manipulate dialed digits before routing a call and applies to outbound calls only. See [this article](https://help.webex.com/en-us/article/nib9o6h/Translation-patterns-for-outbound-calls) for details about the translation pattern syntax. Requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.' tags: - Call Routing parameters: - name: locationId in: path description: Unique identifier for the location. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: Only admin users of another organization (such as partners) may use this parameter since the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: translationId in: path description: Unique identifier for the translation pattern. required: true example: Y2lzY29zcGFyazovL3VzL0RJR0lUX1BBVFRFUk5TLzg3NGRjMjM1LTgwNTktNGM4OC05ZjU5LTRiNjdkZDJhZTZjMg 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: Modify a specific Translation Pattern for a Location operationId: Modify a specific Translation Pattern for a Location description: 'Modify a specific translation pattern for a given location. A translation pattern lets you manipulate dialed digits before routing a call and applies to outbound calls only. See [this article](https://help.webex.com/en-us/article/nib9o6h/Translation-patterns-for-outbound-calls) for details about the translation pattern syntax. Requires a full administrator auth token with the `spark-admin:telephony_config_write` scope.' tags: - Call Routing parameters: - name: locationId in: path description: Unique identifier for the location. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: Only admin users of another organization (such as partners) may use this parameter since the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: translationId in: path description: Unique identifier for the translation pattern. required: true example: Y2lzY29zcGFyazovL3VzL0RJR0lUX1BBVFRFUk5TLzg3NGRjMjM1LTgwNTktNGM4OC05ZjU5LTRiNjdkZDJhZTZjMg schema: type: string requestBody: content: application/json: example: name: CHNHelpDesk matchingPattern: +91[2-7]XX21 replacementPattern: '+91352133' schema: $ref: '#/components/schemas/LocationTranslationPatternModifyRequest' 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 specific Translation Pattern for a Location operationId: Delete a specific Translation Pattern for a Location description: 'Delete a specific translation pattern for a given location. A translation pattern lets you manipulate dialed digits before routing a call and applies to outbound calls only. See [this article](https://help.webex.com/en-us/article/nib9o6h/Translation-patterns-for-outbound-calls) for details about the translation pattern syntax. Requires a full administrator auth token with the `spark-admin:telephony_config_write` scope.' tags: - Call Routing parameters: - name: locationId in: path description: Unique identifier for the location. required: true example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI schema: type: string - name: orgId in: query description: Only admin users of another organization (such as partners) may use this parameter since the default is the same organization as the token used to access API. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: translationId in: path description: Unique identifier for the translation pattern. required: true example: Y2lzY29zcGFyazovL3VzL0RJR0lUX1BBVFRFUk5TLzg3NGRjMjM1LTgwNTktNGM4OC05ZjU5LTRiNjdkZDJhZTZjMg schema: type: string components: schemas: FeatureAccessCode: type: object description: Details of a feature access code configured for services that are assigned to the authenticated user. example: name: Call Forwarding Busy Interrogation code: '*67*' alternateCode: '*18' required: - name - code properties: name: type: string example: Call Forwarding Busy Interrogation description: Feature Access Code name. code: type: string example: '*67*' description: Feature Access Code. alternateCode: type: string example: '*18' description: Alternate Code for the Feature Access Code. CallInterceptDetails: type: object required: - configurationLevel - permission properties: configurationLevel: $ref: '#/components/schemas/ConfigurationLevelType' description: The level from which the configuration is applied. permission: type: string enum: - DISALLOW - TRANSFER description: "The choices that indicate call intercept permissions.\n * `DISALLOW` - Call intercept is disabled.\n * `TRANSFER` - Call intercept is transferred to a number.\n" transferNumber: type: string example: '+14157279300' description: The number to which the outgoing permission by type is to be transferred. DialPatternValidationStatus: type: string enum: - ERRORS - OK description: " * `ERRORS` - In case one or more dial pattern validation failed\n * `OK` - If all the patterns are validated successfully\n" DialPlan: type: object required: - id - name - routeId - routeName - routeType properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI description: Unique identifier for the dial plan. name: type: string example: dialPlanName description: A unique name for the dial plan. routeId: type: string example: Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQLzA1OWEyNzNlLWJiYjAtMTFlYy04NDIyLTAyNDJhYzEyMDAwMg description: ID of route type associated with the dial plan. routeName: type: string example: routeName description: Name of route type associated with the dial plan. routeType: $ref: '#/components/schemas/RouteType' description: Route Type associated with the dial plan. TranslationPatternItem: type: object required: - id - name - matchingPattern - replacementPattern - level properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0RJR0lUX1BBVFRFUk5TLzg3NGRjMjM1LTgwNTktNGM4OC05ZjU5LTRiNjdkZDJhZTZjMg description: Unique identifier for a translation pattern. name: type: string example: CHNHelpDesk description: Name given to a translation pattern for an organization. matchingPattern: type: string example: +91[2-7]XX21 description: Matching pattern given to a translation pattern for an organization. replacementPattern: type: string example: '+91352133' description: Replacement pattern given to a translation pattern for an organization. level: type: string example: Location description: Level at which the translation pattern is created. The level can either be `Organization` or `Location`. location: $ref: '#/components/schemas/Location' description: Location details for the translation pattern when the level is `Location`. Trunk: type: object required: - id - name properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI description: Unique identifier for the trunk. name: type: string example: trunkName description: A unique name for the trunk. location: $ref: '#/components/schemas/Location' description: Location associated with the trunk. inUse: type: boolean example: true description: Trunk in use flag. trunkType: $ref: '#/components/schemas/TrunkType' description: Trunk Type associated with the trunk. isRestrictedToDedicatedInstance: type: boolean example: true description: Flag to indicate if the trunk is restricted to a dedicated instance. OutgoingCallingPlanPermissionsByDigitPattern: type: object required: - name - transferNumber - pattern - number properties: configurationLevel: $ref: '#/components/schemas/ConfigurationLevelType' description: The level from which the configuration is applied. name: type: string example: DPattern description: Name given to a digit pattern. permission: $ref: '#/components/schemas/CallingPermissionAction' description: Action to be performed on the input number that matches with the digit pattern. transferNumber: type: string example: '+14157279300' pattern: type: string example: +91! description: Pattern for the digit pattern. reason: $ref: '#/components/schemas/CallingPlanReason' description: The reason for the result reported for a non-standard OCP service. number: type: string example: '+14157279300' description: A transfer number is present in case of a transfer to another number. TrunkGet: type: object required: - name - customer - status - trunkType - port - pChargeInfoSupportPolicy properties: name: type: string example: trunkName description: A unique name for the trunk. customer: $ref: '#/components/schemas/Customer' description: Customer associated with the trunk. location: $ref: '#/components/schemas/Location' description: Location associated with the trunk. otgDtgId: type: string example: lg1_sias10_cpapi12446_lgu description: Unique Outgoing and Destination trunk group associated with the dial plan. linePort: type: string example: lg1_sias10_cpapi16004_LGU@64941297.int10.bcld.webex.com description: The Line/Port identifies a device endpoint in standalone mode or a SIP URI public identity in IMS mode. locationsUsingTrunk: type: array items: $ref: '#/components/schemas/Location' description: Locations using trunk. pilotUserId: type: string example: lg1_sias10_cpapi12446_LGU@64941297.int10.bcld.webex.com description: User ID. outboundProxy: type: object properties: {} description: Contains the body of the HTTP response received following the request to Console API and will not be set if the response has no body. sipAuthenticationUserName: type: string example: lg1_sias10_cpapi12446_LGU description: User's authentication service information. status: $ref: '#/components/schemas/DeviceStatus' description: Device status. errorCodes: type: array items: type: string example: errorCodes description: Error codes. responseStatus: $ref: '#/components/schemas/ResponseStatus' description: Present partial error/warning status information included when the http response is 206. dualIdentitySupportEnabled: type: boolean example: true description: Determines the behavior of the From and PAI headers on outbound calls. trunkType: $ref: '#/components/schemas/TrunkType' description: Trunk Type associated with the trunk. deviceType: type: string example: Cisco Unified Border Element description: Device type assosiated with trunk. address: type: string example: lgw1.london description: FQDN or SRV address. Required to create a static certificate-based trunk. domain: type: string example: acme.corp description: Domain name. Required to create a static certificate based trunk. port: type: number example: 5000 description: FQDN port. Required to create a static certificate-based trunk. maxConcurrentCalls: type: number example: 1000 description: Max Concurrent call. Required to create a static certificate based trunk. isRestrictedToDedicatedInstance: type: boolean example: true description: Flag to indicate if the trunk is restricted to a dedicated instance. pChargeInfoSupportPolicy: $ref: '#/components/schemas/PChargeInfoSupportPolicyType' RouteList: type: object required: - id - name - routeGroupName - routeGroupId - locationName - locationId properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1JPVVRFX0xJU1QvZDA2YWQ5M2QtY2NkOC00MzI1LTg0YzUtMDA2NThhYTdhMDBj description: Unique identifier of the route list. name: type: string example: routeListName1 description: Name of the route list. routeGroupName: type: string example: routeGroupName1 description: Name of the route group the route list is associated with. routeGroupId: type: string example: Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2YyODkyMTc0LWYxM2YtNDhjYy1iMmJhLWQ4ZmM4Yzg4MzJhYg description: Unique identifier of the route group the route list is associated with. locationName: type: string example: locationName1 description: Location name of the route list. locationId: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA description: Location ID of the route list. RouteGroupUsageRouteListItem: type: object required: - id - name - locationId - locationName properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1JPVVRFX0xJU1QvOTljNjJkMGQtNmFhYi00NGQ0LWE0ZTctZjk0MjQ4OWVhMWJj description: Route list ID. name: type: string example: routeListName description: Route list name. locationId: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2JjNWUwNWFjLTI5ZmEtNGY0NS05MmM1LWUxZTExMDc0OTIwZg description: Location ID for route list. locationName: type: string example: locationName description: Location name for route list. ResponseStatusType: type: string enum: - ERROR - WARNING description: " * `ERROR` - Error\n * `WARNING` - Warning\n" TrunkFQDNValidatePost: type: object properties: address: type: string example: lgw1.london description: FQDN or SRV address of the trunk. domain: type: string example: acme.corp description: Domain name of the trunk. port: type: number example: 5000 description: FQDN port of the trunk. TranslationPatternGetList: type: object required: - translationPatterns properties: translationPatterns: type: array items: $ref: '#/components/schemas/TranslationPatternItem' description: List of translation pattern information. ResponseStatus: type: object required: - code - type - summaryEnglish - detail - trackingId properties: code: type: number example: 25013 description: Error Code. 25013 for error retrieving the outbound proxy. 25014 for error retrieving the status type: $ref: '#/components/schemas/ResponseStatusType' description: Status type. summaryEnglish: type: string example: 'CPAPI: Error retrieving outboundproxy.' description: Error summary in English. detail: type: array items: type: string example: 'OCI-P GroupOutboundProxyGetRequest: [Error 26088] Cloud PBX Console is not configured properly., OCI-P Error code: [Error 26088] Cloud PBX Console is not configured properly.' description: Error Details. trackingId: type: string example: CPAPI_2da34568-1e72-4196-b613-905ce45ec592_0 description: Error Tracking ID. TrunkType: type: string enum: - REGISTERING - CERTIFICATE_BASED description: " * `REGISTERING` - For Cisco CUBE Local Gateway.\n * `CERTIFICATE_BASED` - For Cisco Unified Border Element, Oracle ACME Session Border Controller, AudioCodes Session Border Controller, Ribbon Session Border Controller.\n" LocationTranslationPatternCreateRequest: type: object required: - name - matchingPattern - replacementPattern properties: name: type: string example: CHNHelpDesk description: A name given to a translation pattern for a location. matchingPattern: type: string example: +91[2-7]XX21 description: A matching pattern given to a translation pattern for a location. replacementPattern: type: string example: '+91352133' description: A replacement pattern given to a translation pattern for a location. Organization: type: object required: - name - id properties: name: type: string example: '''ATLAS_TEST_LIEM_RL''' description: Name of the organization. id: type: string example: '''Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi80MWQxNDNiYi1hMjEwLTQ5YTQtOGNkZC1hYzc2YzYxMmE0YzM''' description: ID of the organization. TranslationPatternCreateRequest: type: object required: - name - matchingPattern - replacementPattern properties: name: type: string example: CHNHelpDesk description: Name given to a translation pattern for an organization. matchingPattern: type: string example: +91[2-7]XX21 description: Matching pattern given to a translation pattern for an organization. replacementPattern: type: string example: '+91352133' description: Replacement pattern given to a translation pattern for an organization. DialPatternValidateResult: type: object properties: status: $ref: '#/components/schemas/DialPatternValidationStatus' description: Overall validation result status. dialPatternStatus: type: array items: $ref: '#/components/schemas/DialPatternValidate' description: Patterns validation result. OutgoingCallingPlanPermissionsByType: type: object required: - number properties: configurationLevel: $ref: '#/components/schemas/ConfigurationLevelType' description: The level from which the configuration is applied. callType: type: string enum: - INTERNAL_CALL - TOLL_FREE - INTERNATIONAL - OPERATOR_ASSISTED - CHARGEABLE_DIRECTORY_ASSISTED - SPECIAL_SERVICES_I - SPECIAL_SERVICES_II - PREMIUM_SERVICES_I - PREMIUM_SERVICES_II - NATIONAL description: "Designates the action to be taken for each call type and if transferring the call type is allowed.\n * `INTERNAL_CALL` - Controls calls within your own company.\n * `TOLL_FREE` - Controls calls to a telephone number that is billed for all arriving calls instead of incurring charges to the originating caller, usually free of charge from a landline.\n * `INTERNATIONAL` - Controls calls to locations outside of the long-distance areas that require an international calling code before the number is dialed.\n * `OPERATOR_ASSISTED` - Controls calls requiring Operator Assistance.\n * `CHARGEABLE_DIRECTORY_ASSISTED` - Controls calls to Directory Assistant companies that require a charge to connect the call.\n * `SPECIAL_SERVICES_I` - Controls calls to carrier-specific number assignments to special services or destinations.\n * `SPECIAL_SERVICES_II` - Controls calls to carrier-specific number assignments to special services or destinations.\n * `PREMIUM_SERVICES_I` - Controls calls used to provide information or entertainment for a fee charged directly to the caller.\n * `PREMIUM_SERVICES_II` - Controls calls used to provide information or entertainment for a fee charged directly to the caller.\n * `NATIONAL` - Controls calls that are within your country of origin, both within and outside of your local area code.\n" permission: $ref: '#/components/schemas/CallingPermissionAction' description: Action to be performed on the input number that matches with the OCP. transferNumber: type: string example: '+14157279300' description: The number to which the outgoing permission by type is to be transferred. reason: $ref: '#/components/schemas/CallingPlanReason' description: The reason for the result reported for non-standard OCP service. number: type: string example: '+14157279300' description: A transfer number is present in case it gets transferred to some other number. TrunkTypeWithDeviceType: type: object required: - trunkType - deviceTypes properties: trunkType: $ref: '#/components/schemas/TrunkType' description: Trunk Type associated with the trunk. deviceTypes: type: array items: $ref: '#/components/schemas/DeviceType' description: Device types for trunk configuration. DeviceType: type: string enum: - DEVICE - APPLICATION description: " * `DEVICE` - The endpoint is a device.\n * `APPLICATION` - The endpoint is a application.\n" RouteGroupGet: type: object required: - name - organization - localGateways properties: name: type: string example: '''Route Group One''' description: Name of the route group. organization: $ref: '#/components/schemas/Organization' description: Organization details. localGateways: type: array items: $ref: '#/components/schemas/LocalGateways' description: Local Gateways that are part of this Route Group. CallDestinationType: type: string enum: - HOSTED_AGENT - HOSTED_FEATURE - PBX_USER - PSTN_NUMBER - VIRTUAL_EXTENSION - VIRTUAL_EXTENSION_RANGE - ROUTE_LIST - FAC - EMERGENCY - REPAIR - UNKNOWN_EXTENSION - UNKNOWN_NUMBER description: " * `HOSTED_AGENT` - A destination is a person or workspace with details in the `hostedAgent` field.\n * `HOSTED_FEATURE` - Destination is a calling feature like auto-attendant or hunt group with details in the `hostedFeature` field.\n * `PBX_USER` - Destination routes into a separate PBX with details in the `pbxUser` field.\n * `PSTN_NUMBER` - Destination routes into a PSTN phone number with details in the `pstnNumber` field.\n * `VIRTUAL_EXTENSION` - Destination routes into a virtual extension with details in the `virtualExtension` field.\n * `VIRTUAL_EXTENSION_RANGE` - Destination routes into a virtual extension range with details in the `virtualExtensionRange` field.\n * `ROUTE_LIST` - Destination routes into a route list with details in the `routeList` field.\n * `FAC` - Destination routes into a feature access code (FAC) with details in the `featureAccessCode` field.\n * `EMERGENCY` - Destination routes into an emergency service like Red Sky, with details in the `emergency` field.\n * `REPAIR` - The route is in a repair state with routing choice details in the `repair` field.\n * `UNKNOWN_EXTENSION` - Target extension is unknown with routing choice details in the `unknownExtension` field.\n * `UNKNOWN_NUMBER` - The target phone number is unknown with routing choice details in the `unknownNumber` field.\n" HostedFeature: type: object required: - type - name - id - locationName - locationId properties: type: $ref: '#/components/schemas/ServiceType' description: Type of the service identified as call destination. name: type: string example: name1 description: Name of the service identified as call destination. id: type: string example: Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2QyRXdhV2R5TVRCamIwQTJORGswTVRJNU55NXBiblF4TUM1aVkyeGtMbmRsWW1WNExtTnZiUT09 description: Unique identifier of the service identified as call destination. locationName: type: string example: locationName1 description: Name of the location with which the service is associated. locationId: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA description: Unique identifier for the location of the service. phoneNumber: type: string example: '9874531287' description: Phone number of the service. extension: type: string example: '111' description: Extension of the service. VirtualExtensionRange: type: object required: - id - prefix - pattern properties: id: type: string example: OTI0NzM1OTQtZGU1Mi00ZjViLTk0YjItN2Y5MzRmY2Y2NDk3 description: Unique identifier for virtual extension range. name: type: string example: firstName1 description: Name of the virtual extension range. prefix: type: string example: '+1214555' description: 'Prefix that the virtual extension range is associated with (Note: Standard mode must have leading ''+'' in prefix; BCD/Enhanced mode can have any valid prefix).' pattern: type: string example: 2XXX description: Pattern associated with the virtual extension range. locationName: type: string example: locationName1 description: Location name if the virtual extension range is at the location level, empty if it is at the customer level. locationId: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA description: Location ID if the virtual extension range is at the location level, empty if it is at customer level. trunkName: type: string example: trunkName1 description: Name of the trunk. trunkId: type: string example: Y2lzY29zcGFyazovL3VzL1RSVU5LLzA4Yjc2MmZlLWJmYWItNGFmYi04ODQ1LTNhNzJjNGQ0NjZiOQ description: Unique identifier of the trunk. routeGroupName: type: string example: routeGroupName1 description: Name of the route group. routeGroupId: type: string example: Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2YyODkyMTc0LWYxM2YtNDhjYy1iMmJhLWQ4ZmM4Yzg4MzJhYg description: Unique identifier of the route group. trunkLocationName: type: string example: trunkLocationName1 description: Location of the trunk; required if `trunkName` is returned. trunkLocationId: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA description: Location ID of the trunk; required if `trunkName` is returned. UnknownExtension: type: object properties: trunkName: type: string example: trunkName1 description: Name of the trunk. trunkId: type: string example: Y2lzY29zcGFyazovL3VzL1RSVU5LLzA4Yjc2MmZlLWJmYWItNGFmYi04ODQ1LTNhNzJjNGQ0NjZiOQ description: Unique identifier of the trunk. routeGroupName: type: string example: routeGroupName1 description: Name of the route group. routeGroupId: type: string example: Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2YyODkyMTc0LWYxM2YtNDhjYy1iMmJhLWQ4ZmM4Yzg4MzJhYg description: Unique identifier of the route group. trunkLocationName: type: string example: trunkLocationName1 description: Location of the trunk; required if `trunkName` is returned. trunkLocationId: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA description: Location ID of the trunk; required if `trunkName` is returned. PstnNumber: type: object properties: trunkName: type: string example: trunkName1 description: Name of the trunk. trunkId: type: string example: Y2lzY29zcGFyazovL3VzL1RSVU5LLzA4Yjc2MmZlLWJmYWItNGFmYi04ODQ1LTNhNzJjNGQ0NjZiOQ description: Unique identifier of the trunk. routeGroupName: type: string example: routeGroupName1 description: Name of the route group. routeGroupId: type: string example: Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2YyODkyMTc0LWYxM2YtNDhjYy1iMmJhLWQ4ZmM4Yzg4MzJhYg description: Unique identifier of the route group. trunkLocationName: type: string example: trunkLocationName1 description: Location of the trunk; required if `trunkName` is returned. trunkLocationId: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA description: Location ID of the trunk; required if `trunkName` is returned. RouteListGet: type: object required: - name - location properties: name: type: string example: Route List 01 description: Route list name. location: $ref: '#/components/schemas/Location' description: Location associated with the Route List. routeGroup: $ref: '#/components/schemas/RouteGroup' description: Route group associated with the Route list. TranslationPatternGet: type: object required: - id - name - matchingPattern - replacementPattern properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0RJR0lUX1BBVFRFUk5TLzg3NGRjMjM1LTgwNTktNGM4OC05ZjU5LTRiNjdkZDJhZTZjMg description: Unique identifier for a translation pattern. name: type: string example: CHNHelpDesk description: Name given to a translation pattern for an organization. matchingPattern: type: string example: +91[2-7]XX21 description: Matching pattern given to a translation pattern for an organization. replacementPattern: type: string example: '+91352133' description: Replacement pattern given to a translation pattern for an organization. RouteGroupPost: type: object required: - name - localGateways properties: name: type: string example: routeGroupName description: A unique name for the Route Group. localGateways: type: array items: $ref: '#/components/schemas/LocalGateways' description: Local Gateways that are part of this Route Group. PbxUser: type: object required: - dialPlanName - dialPlanId - dialPattern properties: dialPlanName: type: string example: dialPlan1 description: Dial plan name that the called string matches. dialPlanId: type: string example: Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI description: Unique identifier for the dial plan. dialPattern: type: string example: 442xxx description: Dial pattern that the called string matches. trunkName: type: string example: trunkName1 description: Name of the trunk. trunkId: type: string example: Y2lzY29zcGFyazovL3VzL1RSVU5LLzA4Yjc2MmZlLWJmYWItNGFmYi04ODQ1LTNhNzJjNGQ0NjZiOQ description: Unique identifier of the trunk. routeGroupName: type: string example: routeGroupName1 description: Name of the route group. routeGroupId: type: string example: Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2YyODkyMTc0LWYxM2YtNDhjYy1iMmJhLWQ4ZmM4Yzg4MzJhYg description: Unique identifier of the route group. trunkLocationName: type: string example: trunkLocationName1 description: Location of the trunk; required if `trunkName` is returned. trunkLocationId: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA description: Location ID of the trunk; required if `trunkName` is returned. RouteListPost: type: object required: - name - locationId - routeGroupId properties: name: type: string example: RouteList01 description: Name of the Route List locationId: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2JjNWUwNWFjLTI5ZmEtNGY0NS05MmM1LWUxZTExMDc0OTIwZg description: Location associated with the Route List. routeGroupId: type: string example: Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2ZjN2EzZDU2LTg1OGMtNDVkZC1iZDA1LTE2OWM2NGU1OTRmMQ description: ID of the route group associated with Route List. CallingPermissionAction: type: string enum: - ALLOW - BLOCK - AUTH_CODE - TRANSFER_NUMBER_1 - TRANSFER_NUMBER_2 - TRANSFER_NUMBER_3 description: " * `ALLOW` - Allow the designated call type.\n * `BLOCK` - Block the designated call type.\n * `AUTH_CODE` - Allow only via Authorization Code.\n * `TRANSFER_NUMBER_1` - Transfer to Auto Transfer Number 1. The answering person can then approve the call and send it through or reject the call.\n * `TRANSFER_NUMBER_2` - Transfer to Auto Transfer Number 2. The answering person can then approve the call and send it through or reject the call.\n * `TRANSFER_NUMBER_3` - Transfer to Auto Transfer Number 3. The answering person can then approve the call and send it through or reject the call.\n" RouteGroup: type: object required: - id - name - inUse properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2ZjN2EzZDU2LTg1OGMtNDVkZC1iZDA1LTE2OWM2NGU1OTRmMQ description: Route group ID the Route list is associated with. name: type: string example: Route Group 01 description: Name of the Route group the Route list associated with. inUse: type: boolean example: true description: Flag to indicate if the route group is used. OriginatorType: type: string enum: - PEOPLE - TRUNK description: " * `PEOPLE` - The originator type object is a person.\n * `TRUNK` - Connection between Webex Calling and the premises.\n" NumberStatus: type: string enum: - INVALID - DUPLICATE - DUPLICATE_IN_LIST - UNAVAILABLE RouteGroupUsageRouteListGet: type: object properties: routeLists: type: array items: $ref: '#/components/schemas/RouteGroupUsageRouteListItem' description: List of route lists for this route group. RouteListNumberPatchResponse: type: object required: - phoneNumber - numberStatus - message properties: phoneNumber: type: string example: '+2147891122' description: Phone Number whose status is being reported. numberStatus: $ref: '#/components/schemas/NumberStatus' description: Status of the number. Possible values are `INVALID`, `DUPLICATE`, `DUPLICATE_IN_LIST`, or `UNAVAILABLE`. message: type: string example: Invalid Number description: Message of the number add status. Location: type: object description: Details of the location for the assigned assistant. example: id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzkzMGMzYTNlLTA3Y2EtNDNmOS1iZjE4LTZlZGM2OGE1Y2Y3Yg name: Bangalore required: - name - id properties: name: type: string example: Bangalore description: Name of the location. id: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzkzMGMzYTNlLTA3Y2EtNDNmOS1iZjE4LTZlZGM2OGE1Y2Y3Yg description: Unique identifier of the location. TrunkTypeGetList: type: object required: - trunkTypes properties: trunkTypes: type: array items: $ref: '#/components/schemas/TrunkTypeWithDeviceType' description: Trunk type with device types. Emergency: type: object required: - isRedSky properties: isRedSky: type: boolean example: true description: If `RedSky` is in use. trunkName: type: string example: trunkName1 description: Name of the trunk. trunkId: type: string example: Y2lzY29zcGFyazovL3VzL1RSVU5LLzA4Yjc2MmZlLWJmYWItNGFmYi04ODQ1LTNhNzJjNGQ0NjZiOQ description: Unique identifier of the trunk. routeGroupName: type: string example: routeGroupName1 description: Name of the route group that is associated with trunk specified by `trunkId`. routeGroupId: type: string example: Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2YyODkyMTc0LWYxM2YtNDhjYy1iMmJhLWQ4ZmM4Yzg4MzJhYg description: Unique identifier of the route group. trunkLocationName: type: string example: trunkLocationName1 description: Location of the trunk; required if `trunkName` is returned. trunkLocationId: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA description: Unique identifier of the location of the trunk; required if `trunkName` is returned. RouteListNumberPatch: type: object required: - number - action properties: number: type: string example: '+2147891122' description: Number to be deleted/added. action: $ref: '#/components/schemas/ActionOnRouteList' description: Possible value, `ADD` or `DELETE`. DialPatternStatus: type: string enum: - INVALID - DUPLICATE - DUPLICATE_IN_LIST description: " * `INVALID` - Invalid pattern\n * `DUPLICATE` - Duplicate pattern\n * `DUPLICATE_IN_LIST` - Duplicate in input\n" RouteListPatch: type: object properties: name: type: string example: New Route List description: Route List new name. routeGroupId: type: string example: NTJiZmUxNDAtYjIwMS00NTUzLWI1OGQtMmVkNDU1NTFmYTUy description: New route group ID. DialPlanGet: type: object required: - id - name - routeId - routeName - routeType - customer properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI description: Unique identifier for the dial plan. name: type: string example: dialPlanName description: A unique name for the dial plan. routeId: type: string example: Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQLzA1OWEyNzNlLWJiYjAtMTFlYy04NDIyLTAyNDJhYzEyMDAwMg description: ID of route type associated with the dial plan. routeName: type: string example: routeName description: Name of route type associated with the dial plan. routeType: $ref: '#/components/schemas/RouteType' description: Route Type associated with the dial plan. customer: $ref: '#/components/schemas/Customer' description: Customer information. TranslationPatternModifyRequest: type: object properties: name: type: string example: CHNHelpDesk description: Name given to a translation pattern for an organization. matchingPattern: type: string example: +91[2-7]XX21 description: Matching pattern given to a translation pattern for an organization. replacementPattern: type: string example: '+91352133' description: Replacement pattern given to a translation pattern for an organization. DialPatternValidate: type: object properties: dialPattern: type: string example: '+4555' description: Input dial pattern that is being validated. patternStatus: $ref: '#/components/schemas/DialPatternStatus' description: Validation status. message: type: string example: invalid format for premises dial pattern +4555 description: Failure details. DialPlanUsageGetResponse: type: object required: - id - name properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI description: Unique identifier for the dial plan. name: type: string example: dialPlanName description: Name of a dial plan. TestCallRoutingPostResponse: type: object required: - destinationType - routingAddress - isRejected properties: callSourceInfo: $ref: '#/components/schemas/CallSourceInfo' description: Only returned when `originatorNumber` is specified in the request. destinationType: $ref: '#/components/schemas/CallDestinationType' description: Destination type for the call. routingAddress: type: string example: '007' description: FAC code if `destinationType` is FAC. The routing address will be returned for all other destination types. outsideAccessCode: type: string example: '1234' description: Outside access code. isRejected: type: boolean description: '`true` if the call would be rejected.' hostedAgent: $ref: '#/components/schemas/HostedAgent' description: Returned when `destinationType` is `HOSTED_AGENT`. hostedFeature: $ref: '#/components/schemas/HostedFeature' description: Returned when `destinationType` is `HOSTED_FEATURE`. pbxUser: $ref: '#/components/schemas/PbxUser' description: Returned when `destinationType` is `PBX_USER`. pstnNumber: $ref: '#/components/schemas/PstnNumber' description: Returned when `destinationType` is `PSTN_NUMBER`. virtualExtension: $ref: '#/components/schemas/VirtualExtension' description: Returned when `destinationType` is `VIRTUAL_EXTENSION`. virtualExtensionRange: $ref: '#/components/schemas/VirtualExtensionRange' description: Returned when `destinationType` is `VIRTUAL_EXTENSION_RANGE`. routeList: $ref: '#/components/schemas/RouteList' description: Returned when `destinationType` is `ROUTE_LIST`. featureAccessCode: $ref: '#/components/schemas/FeatureAccessCode' description: Returned when `destinationType` is `FAC`. emergency: $ref: '#/components/schemas/Emergency' description: Returned when `destinationType` is `EMERGENCY`. repair: $ref: '#/components/schemas/Repair' description: Returned when `destinationType` is `REPAIR`. unknownExtension: $ref: '#/components/schemas/UnknownExtension' description: Returned when `destinationType` is `UNKNOWN_EXTENSION`. unknownNumber: $ref: '#/components/schemas/UnknownNumber' description: Returned when `destinationType` is `UNKNOWN_NUMBER`. appliedServices: type: array items: $ref: '#/components/schemas/AppliedServices' description: Returned if any origin is configured with intercept details, outgoing permissions by type, or translation pattern. RouteListNumberListGet: type: object required: - numbers properties: numbers: type: array items: type: string description: Numbers assigned to the Route list. TrunkPut: type: object required: - name - password properties: name: type: string example: dialPlanName description: A unique name for the dial plan. password: type: string example: password description: A password to use on the trunk. dualIdentitySupportEnabled: type: boolean example: true description: Determines the behavior of the From and PAI headers on outbound calls. maxConcurrentCalls: type: number example: 1000 description: Max Concurrent call. Required to create a static certificate-based trunk. pChargeInfoSupportPolicy: $ref: '#/components/schemas/PChargeInfoSupportPolicyType' VirtualExtension: type: object required: - id - displayName - extension - phoneNumber properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfRVhURU5TSU9OL2U4NTU0MGJjLWFiNDMtNGZjOS05ZThlLTkxZjRkN2E3ZjU5Ng description: Unique identifier for the virtual extension. firstName: type: string example: firstName1 description: First name of the virtual extension. lastName: type: string example: lastName1 description: Last name of the virtual extension. displayName: type: string example: displayName1 description: Full name of the virtual extension. extension: type: string example: '0007' description: Extension that the virtual extension is associated with. phoneNumber: type: string example: '8701278963' description: Phone number that the virtual extension is associated with. locationName: type: string example: locationName1 description: Location name if the virtual extension is at the location level, empty if it is at the customer level. locationId: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA description: Location ID if the virtual extension is at the location level, empty if it is at the customer level. trunkName: type: string example: trunkName1 description: Name of the trunk. trunkId: type: string example: Y2lzY29zcGFyazovL3VzL1RSVU5LLzA4Yjc2MmZlLWJmYWItNGFmYi04ODQ1LTNhNzJjNGQ0NjZiOQ description: Unique identifier of the trunk. routeGroupName: type: string example: routeGroupName1 description: Name of the route group. routeGroupId: type: string example: Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2YyODkyMTc0LWYxM2YtNDhjYy1iMmJhLWQ4ZmM4Yzg4MzJhYg description: Unique identifier of the route group. trunkLocationName: type: string example: trunkLocationName1 description: Location of the trunk; required if `trunkName` is returned. trunkLocationId: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA description: Location ID of the trunk; required if `trunkName` is returned. LocationTranslationPatternModifyRequest: type: object properties: name: type: string example: CHNHelpDesk description: A name given to a translation pattern for a location. matchingPattern: type: string example: +91[2-7]XX21 description: A matching pattern given to a translation pattern for a location. replacementPattern: type: string example: '+91352133' description: A replacement pattern given to a translation pattern for a location. DialPatternAction: type: string enum: - ADD - DELETE description: " * `ADD` - Add action, when adding a new dial pattern\n * `DELETE` - Delete action, when deleting an existing dial pattern\n" LocalGateways: type: object required: - id - priority properties: id: type: string example: '''Y2lzY29zcGFyazovL3VzL1RSVU5LLzY1Zjc4YzgxLTcwMTYtNDc0Ny05M2EyLWIxMGVlZjBhMWI1Ng''' description: ID of type local gateway. name: type: string example: '''localGatewayName''' description: Name of the local gateway. locationId: type: string example: '''Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL1dTV1laMjEyODA2TDIxMjgwNw''' description: Location ID to which local gateway belongs. priority: type: number example: 1 description: Prioritizes local gateways based on these numbers; the lowest number gets the highest priority. Customer: type: object required: - id - name properties: id: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE description: ID of the customer/organization. name: type: string example: test_org description: Name of the customer/organization. PostResponse: type: object required: - id properties: id: type: string example: '''Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQLzE4YzFhMGRkLWJhMjctNDkwMS1hNGUxLTBlNWIyNzM1YzlkZg''' description: ID of the Route Group. ConfigurationLevelType: type: string enum: - LOCATION - PEOPLE - PLACE - VIRTUAL_LINE description: " * `LOCATION` - The applied services at the location level.\n * `PEOPLE` - The applied services at the people level.\n * `PLACE` - The applied services at the place level.\n * `VIRTUAL_LINE` - The applied services at the virtual line level.\n" ActionOnRouteList: type: string enum: - ADD - DELETE description: " * `ADD` - Add a phone number to the Route List.\n * `DELETE` - Delete a phone number from the Route List.\n" DialPattern: type: object properties: dialPattern: type: string example: '+5555' description: A unique dial pattern. action: $ref: '#/components/schemas/DialPatternAction' description: Action to add or delete a pattern. DeviceStatus: type: string enum: - ONLINE - OFFLINE - UNKNOWN description: " * `ONLINE` - Device is online\n * `OFFLINE` - Device is offline\n * `UNKNOWN` - Unknown. Default\n" CallingPlanReason: type: string enum: - FRAUD_CONTAINMENT - CISCO_CALLING_PLAN - TRANSFER_NUMBER_1_NOT_CONFIGURED - TRANSFER_NUMBER_2_NOT_CONFIGURED - TRANSFER_NUMBER_3_NOT_CONFIGURED - WEBEX_MOBILE_PREMIUM_INTERNATIONAL_TRANSFER_FORWARD description: " * `FRAUD_CONTAINMENT` - Calling plan gives the Fraud Containment reason.\n * `CISCO_CALLING_PLAN` - The Cisco calling plan reason.\n * `TRANSFER_NUMBER_1_NOT_CONFIGURED` - The reason if the transfer number 1 is not configured.\n * `TRANSFER_NUMBER_2_NOT_CONFIGURED` - The reason if the transfer number 2 is not configured.\n * `TRANSFER_NUMBER_3_NOT_CONFIGURED` - The reason if the transfer number 3 is not configured.\n * `WEBEX_MOBILE_PREMIUM_INTERNATIONAL_TRANSFER_FORWARD` - The reason for Webex mobile international transfer forward.\n" ServiceType: type: string enum: - AUTO_ATTENDANT - BROADWORKS_ANYWHERE - CALL_QUEUE - CONTACT_CENTER_LINK - GROUP_PAGING - HUNT_GROUP - VOICE_MESSAGING - VOICE_MAIL_GROUP description: " * `AUTO_ATTENDANT` - The destination is an auto attendant.\n * `BROADWORKS_ANYWHERE` - The destination is the Office (Broadworks) Anywhere feature.\n * `CALL_QUEUE` - The destination is the Call Queue feature.\n * `CONTACT_CENTER_LINK` - The destination is the Contact Center Link feature.\n * `GROUP_PAGING` - The destination is the Group Paging feature.\n * `HUNT_GROUP` - The destination is the Hunt Group feature.\n * `VOICE_MESSAGING` - The destination is the Voice Messaging feature.\n * `VOICE_MAIL_GROUP` - The destination is the Voice Mail Group feature.\n" CallSourceInfo: type: object required: - callSourceType properties: callSourceType: $ref: '#/components/schemas/CallSourceType' description: Type of call source. routeListName: type: string example: routeList1 description: Name of a route list. When `originatorType` is `trunk`, `originatorId` is a valid trunk and the trunk belongs to a route group which is assigned to a route list with the name `routeListA` and also `originatorNumber` is a number assigned to `routeListA`, then `routeListA` is returned here. This element is returned when `callSourceType` is `ROUTE_LIST`. routeListId: type: string example: Y2lzY29zcGFyazovL3VzL1JPVVRFX0xJU1QvZDA2YWQ5M2QtY2NkOC00MzI1LTg0YzUtMDA2NThhYTdhMDBj description: Unique identifier for the route list. dialPlanName: type: string example: dialPlan1 description: Name of a dial plan. When `originatorType` is `trunk`, `originatorId` is a valid trunk with the name `trunkA`, `trunkA` belongs to a route group which is assigned to a route list with the name `routeListA`, `trunkA` is also assigned to `dialPlanA` as routing choice, `dialPlanA` has `dialPattern` xxxx assigned. If the `originatorNumber` matches the `dialPattern` `xxxx`, `dialPlanA` is returned. This element is returned when `callSourceType` is `DIAL_PATTERN`. dialPattern: type: string example: '*888' description: Pattern given to a dial plan. When `originatorType` is `trunk`, `originatorId` is a valid trunk with the name `trunkA`, `trunkA` belongs to a route group which is assigned to a route list with the name `routeListA`, `trunkA` is also assigned to `dialPlanA` as routing choice, `dialPlanA` has `dialPattern` `xxxx` assigned. If the `originatorNumber` matches the `dialPattern` `xxxx`, `dialPattern` `xxxx` is returned. This element is returned when `callSourceType` is `DIAL_PATTERN`. dialPlanId: type: string example: Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI description: Unique identifier for dial plan. AppliedServices: type: object properties: translationPattern: $ref: '#/components/schemas/TranslationPattern' description: Returns the details of the Translation Pattern if applied. interceptDetails: $ref: '#/components/schemas/CallInterceptDetails' description: Returns the details of call intercept if applied. outgoingCallingPlanPermissionsByType: $ref: '#/components/schemas/OutgoingCallingPlanPermissionsByType' description: Returns the details of permissions by type configuration if applied under OCP. outgoingCallingPlanPermissionsByDigitPattern: $ref: '#/components/schemas/OutgoingCallingPlanPermissionsByDigitPattern' description: Returns the details of the digit pattern configuration if applied under OCP. TrunkPost: type: object required: - name - locationId - password - trunkType properties: name: type: string example: trunkName description: A unique name for the trunk. locationId: type: string example: Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQLzA1OWEyNzNlLWJiYjAtMTFlYy04NDIyLTAyNDJhYzEyMDAwMg description: ID of location associated with the trunk. password: type: string example: password description: A password to use on the trunk. dualIdentitySupportEnabled: type: boolean example: true description: Dual Identity Support setting impacts the handling of the From header and P-Asserted-Identity header when sending an initial SIP `INVITE` to the trunk for an outbound call. trunkType: $ref: '#/components/schemas/TrunkType' description: Trunk Type associated with the trunk. deviceType: type: string example: Cisco Unified Border Element description: Device type assosiated with trunk. address: type: string example: lgw1.london description: FQDN or SRV address. Required to create a static certificate-based trunk. domain: type: string example: acme.corp description: Domain name. Required to create a static certificate based trunk. port: type: number example: 5000 description: FQDN port. Required to create a static certificate-based trunk. maxConcurrentCalls: type: number example: 1000 description: Max Concurrent call. Required to create a static certificate based trunk. pChargeInfoSupportPolicy: $ref: '#/components/schemas/PChargeInfoSupportPolicyType' RouteGroupUsageGetResponse: type: object required: - id - name - inUse properties: id: type: string example: NTJiZmUxNDAtYjIwMS00NTUzLWI1OGQtMmVkNDU1NTFmYTUy description: UUID of the route group associated with the Trunk. name: type: string example: RouteGroup01 description: Name of the Route Group associated with the Trunk. inUse: type: boolean example: true description: In use flag. LocationTranslationPatternGet: type: object required: - id - name - matchingPattern - replacementPattern properties: id: type: string example: Y2lzY29zcGFyazovL3VzL0RJR0lUX1BBVFRFUk5TLzg3NGRjMjM1LTgwNTktNGM4OC05ZjU5LTRiNjdkZDJhZTZjMg description: Unique identifier for a translation pattern. name: type: string example: CHNHelpDesk description: A name given to a translation pattern for a location. matchingPattern: type: string example: +91[2-7]XX21 description: A matching pattern given to a translation pattern for a location. replacementPattern: type: string example: '+91352133' description: A replacement pattern given to a translation pattern for a location. HostedAgentType: type: string enum: - PEOPLE - PLACE description: " * `PEOPLE` - This object is a person.\n * `PLACE` - A workspace that is not assigned to a specific person such as for a shared device in a common area.\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" DialPlanPut: type: object required: - name - routeId - routeType properties: name: type: string example: dialPlanName description: A unique name for the dial plan. routeId: type: string example: Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQLzA1OWEyNzNlLWJiYjAtMTFlYy04NDIyLTAyNDJhYzEyMDAwMg description: ID of route type associated with the dial plan. routeType: $ref: '#/components/schemas/RouteType' description: Route Type associated with the dial plan. RouteGroupPatch: type: object required: - name - localGateways properties: name: type: string example: routeGroupName description: A unique name for the Route Group. localGateways: type: array items: $ref: '#/components/schemas/LocalGateways' description: Local Gateways that are part of this Route Group. PChargeInfoSupportPolicyType: type: string example: CONFIGURABLE_CHARGE_NUMBER enum: - DISABLED - ASSERTED_IDENTITY - CONFIGURABLE_CHARGE_NUMBER description: " * `DISABLED` - The P-Charge-Info header support policy is disabled.\n * `ASSERTED_IDENTITY` - The P-Charge-Info header is always included in outbound PSTN calls using Webex Calling primary number or location’s main number.\n * `CONFIGURABLE_CHARGE_NUMBER` - The P-Charge-Info header is included in outbound PSTN calls using the originating or redirecting Webex Calling entity's location charge number if set, else the entity's primary number if set and not toll-free, else the main number of the entity's location if set and not toll-free. If none of these are set or not toll-free, it uses the same number as the ASSERTED_IDENTITY option.\n" TranslationPattern: type: object properties: configurationLevel: type: string enum: - LOCATION - ORGANIZATION description: "The level from which the configuration is applied.\n * `LOCATION` - The applied services of location level.\n * `ORGANIZATION` - The applied services of the organization level.\n" name: type: string example: TP1 description: Name given to a translation pattern. matchingPattern: type: string example: +91XXX description: Matching pattern given to a translation pattern. replacementPattern: type: string example: '+91234' description: Replacement pattern given to a translation pattern. matchedNumber: type: string example: '+91236' description: The original called number. translatedNumber: type: string example: '+91234' description: The modified number after matching against `matchingPattern` and replacing with corresponding `replacementPattern`. Repair: type: object properties: trunkName: type: string example: trunkName1 description: Name of the trunk. trunkId: type: string example: Y2lzY29zcGFyazovL3VzL1RSVU5LLzA4Yjc2MmZlLWJmYWItNGFmYi04ODQ1LTNhNzJjNGQ0NjZiOQ description: Unique identifier of the trunk. routeGroupName: type: string example: routeGroupName1 description: Name of the route group. routeGroupId: type: string example: Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2YyODkyMTc0LWYxM2YtNDhjYy1iMmJhLWQ4ZmM4Yzg4MzJhYg description: Unique identifier of the route group. trunkLocationName: type: string example: trunkLocationName1 description: Location of the trunk; required if `trunkName` is returned. trunkLocationId: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA description: Location ID of the trunk; required if `trunkName` is returned. UnknownNumber: type: object properties: trunkName: type: string example: trunkName1 description: Name of the trunk. trunkId: type: string example: Y2lzY29zcGFyazovL3VzL1RSVU5LLzA4Yjc2MmZlLWJmYWItNGFmYi04ODQ1LTNhNzJjNGQ0NjZiOQ description: Unique identifier of the trunk. routeGroupName: type: string example: routeGroupName1 description: Name of the route group. routeGroupId: type: string example: Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2YyODkyMTc0LWYxM2YtNDhjYy1iMmJhLWQ4ZmM4Yzg4MzJhYg description: Unique identifier of the route group. trunkLocationName: type: string example: trunkLocationName1 description: Location of the trunk; required if `trunkName` is returned. trunkLocationId: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA description: Location ID of the trunk; required if `trunkName` is returned. RouteListListGet: type: object required: - id - name - locationId - locationName properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1JPVVRFX0xJU1QvOTljNjJkMGQtNmFhYi00NGQ0LWE0ZTctZjk0MjQ4OWVhMWJj description: ID of the Route List. name: type: string example: RouteList Name description: Name of the Route List. locationId: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2JjNWUwNWFjLTI5ZmEtNGY0NS05MmM1LWUxZTExMDc0OTIwZg description: Location associated with the Route List. locationName: type: string example: locationName description: Location associated with the Route List. routeGroupId: type: string example: Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2ZjN2EzZDU2LTg1OGMtNDVkZC1iZDA1LTE2OWM2NGU1OTRmMQ description: ID of the route group associated with Route List. routeGroupName: type: string example: RouteGroup01 description: Name of the Route Group associated with Route List. LocalGatewayUsageCount: type: object required: - pstnConnectionCount - callToExtensionCount - dialPlanCount - routeGroupCount properties: pstnConnectionCount: type: number example: 1 description: The count where the local gateway is used as a PSTN Connection setting. callToExtensionCount: type: number example: 1 description: The count where the given local gateway is used as call to extension setting. dialPlanCount: type: number example: 1 description: The count where the given local gateway is used by the dial plan. routeGroupCount: type: number example: 1 description: The count where the given local gateway is used by the route group. CallSourceType: type: string enum: - ROUTE_LIST - DIAL_PATTERN - UNKOWN_EXTENSION - UNKOWN_NUMBER description: " * `ROUTE_LIST` - Route list is a type of call source.\n * `DIAL_PATTERN` - Dial pattern is a type of call source.\n * `UNKOWN_EXTENSION` - The call source extension is unknown.\n * `UNKOWN_NUMBER` - The call source phone number is unknown.\n" HostedAgent: type: object required: - id - type - firstName - lastName - locationName - locationId properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mMjU4YjhmZi1lODIxLTQ3MDktYTI2My1mMmI4OWZjN2FlYmQ description: Unique identifier for the person or workspace agent identified as call destination. type: $ref: '#/components/schemas/HostedAgentType' description: Type of agent for call destination. firstName: type: string example: firstName description: First name for the hosted agent specified by `id`. lastName: type: string example: lastName description: Last name for the hosted agent specified by `id`. locationName: type: string example: locationName description: Name of hosted agent's location. locationId: type: string example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA description: Unique identifier for hosted agent's location. phoneNumber: type: string example: '9874531287' description: Phone number for the hosted agent. extension: type: string example: '111' description: Extension for the hosted agent. ResponseId: type: object description: Response object that contains the unique identifier for the created or updated criteria. properties: id: type: string description: The unique identifier for the criteria. example: id: Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL2RHVnpkRjltYVd4MFpYST0 DialPatternPut: type: object properties: dialPatterns: type: array items: $ref: '#/components/schemas/DialPattern' description: Array of dial patterns to add or delete. Dial Pattern that is not present in the request is not modified. deleteAllDialPatterns: type: boolean example: true description: Delete all the dial patterns for a dial plan. DialPlanPost: type: object required: - name - routeId - routeType properties: name: type: string example: dialPlanName description: A unique name for the dial plan. routeId: type: string example: Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQLzA1OWEyNzNlLWJiYjAtMTFlYy04NDIyLTAyNDJhYzEyMDAwMg description: ID of route type associated with the dial plan. routeType: $ref: '#/components/schemas/RouteType' description: Route Type associated with the dial plan. dialPatterns: type: array items: type: string example: +5555,+5556 description: An Array of dial patterns. 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