Webex Cloud Calling — Call Routing

naftiko: 1.0.0-alpha2
info:
  label: Webex Cloud Calling — Call Routing
  description: 'Webex Cloud Calling — Call Routing. 46 operations. Lead operation: Test Call Routing. Self-contained Naftiko
    capability covering one Webex business surface.'
  tags:
  - Webex
  - Call Routing
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    WEBEX_API_KEY: WEBEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: cloud-calling-call-routing
    baseUri: ''
    description: Webex Cloud Calling — Call Routing business capability. Self-contained, no shared references.
    resources:
    - name: telephony-config-actions-testCallRouting-invoke
      path: /telephony/config/actions/testCallRouting/invoke
      operations:
      - name: testcallrouting
        method: POST
        description: Test Call Routing
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: query
          type: string
          description: Organization in which we are validating a call routing.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-callRouting-translationPatterns
      path: /telephony/config/callRouting/translationPatterns
      operations:
      - name: createatranslationpatternforanorganization
        method: POST
        description: Create a Translation Pattern for an Organization
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: query
          type: string
          description: ID of the organization containing the translation pattern.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: retrievethelistoftranslationpatterns
        method: GET
        description: Retrieve the list of Translation Patterns
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: query
          type: string
          description: ID of the organization containing the translation patterns.
        - name: limitToLocationId
          in: query
          type: string
          description: When a location ID is passed, then return only the corresponding location level translation patterns.
        - name: limitToOrgLevelEnabled
          in: query
          type: string
          description: When set to be `true`, then return only the organization-level translation patterns.
        - name: max
          in: query
          type: number
          description: Limit the number of objects returned to this maximum count.
        - name: start
          in: query
          type: number
          description: Start at the zero-based offset in the list of matching objects.
        - name: order
          in: query
          type: string
          description: Sort the list of translation patterns according to translation pattern name, ascending or descending.
        - name: name
          in: query
          type: string
          description: Only return translation patterns with the matching `name`.
        - name: matchingPattern
          in: query
          type: string
          description: Only return translation patterns with the matching `matchingPattern`.
    - name: telephony-config-callRouting-translationPatterns-translationId
      path: /telephony/config/callRouting/translationPatterns/{translationId}
      operations:
      - name: retrieveaspecifictranslationpatternforanorganization
        method: GET
        description: Retrieve a specific Translation Pattern for an Organization
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: query
          type: string
          description: ID of the organization containing the translation pattern.
        - name: translationId
          in: path
          type: string
          description: Retrieve the translation pattern with the matching ID.
          required: true
      - name: modifyaspecifictranslationpatternforanorganization
        method: PUT
        description: Modify a specific Translation Pattern for an Organization
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: query
          type: string
          description: ID of the organization containing the translation pattern.
        - name: translationId
          in: path
          type: string
          description: Modify translation pattern with the matching ID.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deleteaspecifictranslationpattern
        method: DELETE
        description: Delete a specific Translation Pattern
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: query
          type: string
          description: ID of the organization containing the translation pattern.
        - name: translationId
          in: path
          type: string
          description: Delete a translation pattern with the matching ID.
          required: true
    - name: telephony-config-locations-locationId-callRouting-translationPatterns
      path: /telephony/config/locations/{locationId}/callRouting/translationPatterns
      operations:
      - name: createatranslationpatternforalocation
        method: POST
        description: Create a Translation Pattern for a Location
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Unique identifier for the location.
          required: true
        - name: orgId
          in: query
          type: string
          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.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-locations-locationId-callRouting-translationPatterns-translatio
      path: /telephony/config/locations/{locationId}/callRouting/translationPatterns/{translationId}
      operations:
      - name: retrieveaspecifictranslationpatternforalocation
        method: GET
        description: Retrieve a specific Translation Pattern for a Location
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Unique identifier for the location.
          required: true
        - name: orgId
          in: query
          type: string
          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.
        - name: translationId
          in: path
          type: string
          description: Unique identifier for the translation pattern.
          required: true
      - name: modifyaspecifictranslationpatternforalocation
        method: PUT
        description: Modify a specific Translation Pattern for a Location
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Unique identifier for the location.
          required: true
        - name: orgId
          in: query
          type: string
          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.
        - name: translationId
          in: path
          type: string
          description: Unique identifier for the translation pattern.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deleteaspecifictranslationpatternforalocation
        method: DELETE
        description: Delete a specific Translation Pattern for a Location
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Unique identifier for the location.
          required: true
        - name: orgId
          in: query
          type: string
          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.
        - name: translationId
          in: path
          type: string
          description: Unique identifier for the translation pattern.
          required: true
    - name: telephony-config-premisePstn-actions-validateDialPatterns-invoke
      path: /telephony/config/premisePstn/actions/validateDialPatterns/invoke
      operations:
      - name: validateadialpattern
        method: POST
        description: Validate a Dial Pattern
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: query
          type: string
          description: Organization to which dial plan belongs.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-premisePstn-dialPlans
      path: /telephony/config/premisePstn/dialPlans
      operations:
      - name: readthelistofdialplans
        method: GET
        description: Read the List of Dial Plans
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: query
          type: string
          description: List dial plans for this organization.
        - name: dialPlanName
          in: query
          type: string
          description: Return the list of dial plans matching the dial plan name.
        - name: routeGroupName
          in: query
          type: string
          description: Return the list of dial plans matching the Route group name..
        - name: trunkName
          in: query
          type: string
          description: Return the list of dial plans matching the Trunk name..
        - name: max
          in: query
          type: number
          description: Limit the number of objects returned to this maximum count.
        - name: start
          in: query
          type: number
          description: Start at the zero-based offset in the list of matching objects.
        - name: order
          in: query
          type: string
          description: 'Order the dial plans according to the designated fields.  Available sort fields: `name`, `routeName`,
            `routeType`. Sort order is ascending by default'
      - name: createadialplan
        method: POST
        description: Create a Dial Plan
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: query
          type: string
          description: Organization to which dial plan belongs.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-premisePstn-dialPlans-dialPlanId
      path: /telephony/config/premisePstn/dialPlans/{dialPlanId}
      operations:
      - name: getadialplan
        method: GET
        description: Get a Dial Plan
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dialPlanId
          in: path
          type: string
          description: ID of the dial plan.
          required: true
        - name: orgId
          in: query
          type: string
          description: Organization to which dial plan belongs.
      - name: modifyadialplan
        method: PUT
        description: Modify a Dial Plan
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dialPlanId
          in: path
          type: string
          description: ID of the dial plan being modified.
          required: true
        - name: orgId
          in: query
          type: string
          description: Organization to which dial plan belongs.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deleteadialplan
        method: DELETE
        description: Delete a Dial Plan
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dialPlanId
          in: path
          type: string
          description: ID of the dial plan.
          required: true
        - name: orgId
          in: query
          type: string
          description: Organization to which dial plan belongs.
    - name: telephony-config-premisePstn-dialPlans-dialPlanId-dialPatterns
      path: /telephony/config/premisePstn/dialPlans/{dialPlanId}/dialPatterns
      operations:
      - name: modifydialpatterns
        method: PUT
        description: Modify Dial Patterns
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dialPlanId
          in: path
          type: string
          description: ID of the dial plan being modified.
          required: true
        - name: orgId
          in: query
          type: string
          description: Organization to which dial plan belongs.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-premisePstn-routeGroups
      path: /telephony/config/premisePstn/routeGroups
      operations:
      - name: readthelistofroutinggroups
        method: GET
        description: Read the List of Routing Groups
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: query
          type: string
          description: List route groups for this organization.
        - name: name
          in: query
          type: string
          description: Return the list of route groups matching the Route group name..
        - name: max
          in: query
          type: number
          description: Limit the number of objects returned to this maximum count.
        - name: start
          in: query
          type: number
          description: Start at the zero-based offset in the list of matching objects.
        - name: order
          in: query
          type: string
          description: Order the route groups according to designated fields.  Available sort orders are `asc` and `desc`.
      - name: createroutegroupforaorganization
        method: POST
        description: Create Route Group for a Organization
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: query
          type: string
          description: Organization to which the Route Group belongs.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-premisePstn-routeGroups-routeGroupId
      path: /telephony/config/premisePstn/routeGroups/{routeGroupId}
      operations:
      - name: readaroutegroupforaorganization
        method: GET
        description: Read a Route Group for a Organization
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: routeGroupId
          in: path
          type: string
          description: Route Group for which details are being requested.
          required: true
        - name: orgId
          in: query
          type: string
          description: Organization of the Route Group.
      - name: modifyaroutegroupforaorganization
        method: PUT
        description: Modify a Route Group for a Organization
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: routeGroupId
          in: path
          type: string
          description: Route Group for which details are being requested.
          required: true
        - name: orgId
          in: query
          type: string
          description: Organization of the Route Group.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: removearoutegroupfromanorganization
        method: DELETE
        description: Remove a Route Group from an Organization
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: routeGroupId
          in: path
          type: string
          description: Route Group for which details are being requested.
          required: true
        - name: orgId
          in: query
          type: string
          description: Organization of the Route Group.
    - name: telephony-config-premisePstn-routeGroups-routeGroupId-usage
      path: /telephony/config/premisePstn/routeGroups/{routeGroupId}/usage
      operations:
      - name: readtheusageofaroutinggroup
        method: GET
        description: Read the Usage of a Routing Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: routeGroupId
          in: path
          type: string
          description: ID of the requested Route group.
          required: true
        - name: orgId
          in: query
          type: string
          description: Organization associated with the specific route group.
    - name: telephony-config-premisePstn-routeGroups-routeGroupId-usageCallToExtension
      path: /telephony/config/premisePstn/routeGroups/{routeGroupId}/usageCallToExtension
      operations:
      - name: readthecalltoextensionlocationsofaroutinggroup
        method: GET
        description: Read the Call to Extension Locations of a Routing Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: routeGroupId
          in: path
          type: string
          description: ID of the requested Route group.
          required: true
        - name: orgId
          in: query
          type: string
          description: Organization associated with specific route group.
        - name: locationName
          in: query
          type: string
          description: Return the list of locations matching the location name.
        - name: max
          in: query
          type: number
          description: Limit the number of objects returned to this maximum count.
        - name: start
          in: query
          type: number
          description: Start at the zero-based offset in the list of matching objects.
        - name: order
          in: query
          type: string
          description: Order the locations according to designated fields.  Available sort orders are `asc`, and `desc`.
    - name: telephony-config-premisePstn-routeGroups-routeGroupId-usageDialPlan
      path: /telephony/config/premisePstn/routeGroups/{routeGroupId}/usageDialPlan
      operations:
      - name: readthedialplanlocationsofaroutinggroup
        method: GET
        description: Read the Dial Plan Locations of a Routing Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: routeGroupId
          in: path
          type: string
          description: ID of the requested Route group.
          required: true
        - name: orgId
          in: query
          type: string
          description: Organization associated with specific route group.
        - name: locationName
          in: query
          type: string
          description: Return the list of locations matching the location name.
        - name: max
          in: query
          type: number
          description: Limit the number of objects returned to this maximum count.
        - name: start
          in: query
          type: number
          description: Start at the zero-based offset in the list of matching objects.
        - name: order
          in: query
          type: string
          description: Order the locations according to designated fields.  Available sort orders are `asc`, and `desc`.
    - name: telephony-config-premisePstn-routeGroups-routeGroupId-usagePstnConnection
      path: /telephony/config/premisePstn/routeGroups/{routeGroupId}/usagePstnConnection
      operations:
      - name: readthepstnconnectionlocationsofaroutinggroup
        method: GET
        description: Read the PSTN Connection Locations of a Routing Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: routeGroupId
          in: path
          type: string
          description: ID of the requested Route group.
          required: true
        - name: orgId
          in: query
          type: string
          description: Organization associated with specific route group.
        - name: locationName
          in: query
          type: string
          description: Return the list of locations matching the location name.
        - name: max
          in: query
          type: number
          description: Limit the number of objects returned to this maximum count.
        - name: start
          in: query
          type: number
          description: Start at the zero-based offset in the list of matching objects.
        - name: order
          in: query
          type: string
          description: Order the locations according to designated fields.  Available sort orders are `asc`, and `desc`.
    - name: telephony-config-premisePstn-routeGroups-routeGroupId-usageRouteList
      path: /telephony/config/premisePstn/routeGroups/{routeGroupId}/usageRouteList
      operations:
      - name: readtheroutelistsofaroutinggroup
        method: GET
        description: Read the Route Lists of a Routing Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: routeGroupId
          in: path
          type: string
          description: ID of the requested Route group.
          required: true
        - name: orgId
          in: query
          type: string
          description: Organization associated with specific route group.
        - name: name
          in: query
          type: string
          description: Return the list of locations matching the location name.
        - name: max
          in: query
          type: number
          description: Limit the number of objects returned to this maximum count.
        - name: start
          in: query
          type: number
          description: Start at the zero-based offset in the list of matching objects.
        - name: order
          in: query
          type: string
          description: Order the locations according to designated fields.  Available sort orders are `asc`, and `desc`.
    - name: telephony-config-premisePstn-routeLists
      path: /telephony/config/premisePstn/routeLists
      operations:
      - name: readthelistofroutelists
        method: GET
        description: Read the List of Route Lists
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: query
          type: string
          description: List all Route List for this organization.
        - name: start
          in: query
          type: number
          description: Start at the zero-based offset in the list of matching objects.
        - name: max
          in: query
          type: number
          description: Limit the number of objects returned to this maximum count.
        - name: order
          in: query
          type: string
          description: Order the Route List according to the designated fields. Available sort fields are `name`, and `locationId`.
            Sort order is ascending by default
        - name: name
          in: query
          type: array
          description: Return the list of Route List matching the route list name.
        - name: locationId
          in: query
          type: array
          description: Return the list of Route Lists matching the location id.
      - name: createaroutelist
        method: POST
        description: Create a Route List
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: query
          type: string
          description: Organization to which the Route List belongs.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-premisePstn-routeLists-routeListId
      path: /telephony/config/premisePstn/routeLists/{routeListId}
      operations:
      - name: deletearoutelist
        method: DELETE
        description: Delete a Route List
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: routeListId
          in: path
          type: string
          description: ID of the Route List.
          required: true
        - name: orgId
          in: query
          type: string
          description: Organization to which the Route List belongs.
      - name: getaroutelist
        method: GET
        description: Get a Route List
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: routeListId
          in: path
          type: string
          description: ID of the Route List.
          required: true
        - name: orgId
          in: query
          type: string
          description: Organization to which the Route List belongs.
      - name: modifyaroutelist
        method: PUT
        description: Modify a Route List
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: routeListId
          in: path
          type: string
          description: ID of the Route List.
          required: true
        - name: orgId
          in: query
          type: string
          description: Organization to which the Route List belongs.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-premisePstn-routeLists-routeListId-numbers
      path: /telephony/config/premisePstn/routeLists/{routeListId}/numbers
      operations:
      - name: modifynumbersforroutelist
        method: PUT
        description: Modify Numbers for Route List
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: routeListId
          in: path
          type: string
          description: ID of the Route List.
          required: true
        - name: orgId
          in: query
          type: string
          description: Organization to which the Route List belongs.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: getnumbersassignedtoaroutelist
        method: GET
        description: Get Numbers assigned to a Route List
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: routeListId
          in: path
          type: string
          description: ID of the Route List.
          required: true
        - name: orgId
          in: query
          type: string
          description: Organization to which the Route List belongs.
        - name: start
          in: query
          type: number
          description: Start at the zero-based offset in the list of matching objects.
        - name: max
          in: query
          type: number
          description: Limit the number of objects returned to this maximum count.
        - name: number
          in: query
          type: string
          description: Number assigned to the route list.
        - name: order
          in: query
          type: string
          description: Order the Route Lists according to number, ascending or descending.
    - name: telephony-config-premisePstn-trunks
      path: /telephony/config/premisePstn/trunks
      operations:
      - name: readthelistoftrunks
        method: GET
        description: Read the List of Trunks
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: query
          type: string
          description: List trunks for this organization.
        - name: name
          in: query
          type: array
          description: Return the list of trunks matching the local gateway names.
        - name: locationName
          in: query
          type: array
          description: Return the list of trunks matching the location names.
        - name: trunkType
          in: query
          type: string
          description: Return the list of trunks matching the trunk type.
        - name: max
          in: query
          type: number
          description: Limit the number of objects returned to this maximum count.
        - name: start
          in: query
          type: number
          description: Start at the zero-based offset in the list of matching objects.
        - name: order
          in: query
          type: string
          description: 'Order the trunks according to the designated fields.  Available sort fields: name, locationName. Sort
            order is ascending by default'
      - name: createatrunk
        method: POST
        description: Create a Trunk
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: query
          type: string
          description: Organization to which the trunk belongs.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-premisePstn-trunks-act

# --- truncated at 32 KB (83 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/webex/refs/heads/main/capabilities/cloud-calling-call-routing.yaml