Webex Cloud Calling — Location Call Settings

naftiko: 1.0.0-alpha2
info:
  label: Webex Cloud Calling — Location Call Settings
  description: 'Webex Cloud Calling — Location Call Settings. 38 operations. Lead operation: Validate the List of Extensions.
    Self-contained Naftiko capability covering one Webex business surface.'
  tags:
  - Webex
  - Location Call Settings
  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-location-call-settings
    baseUri: ''
    description: Webex Cloud Calling — Location Call Settings business capability. Self-contained, no shared references.
    resources:
    - name: telephony-config-actions-validateExtensions-invoke
      path: /telephony/config/actions/validateExtensions/invoke
      operations:
      - name: validatethelistofextensions
        method: POST
        description: Validate the List of Extensions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: query
          type: string
          description: Validate Extension for this organization.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-jobs-locations-deleteCallingLocation
      path: /telephony/config/jobs/locations/deleteCallingLocation
      operations:
      - name: disablelocationforwebexcalling
        method: POST
        description: Disable a Location for Webex Calling
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: query
          type: string
          description: Organization ID for disabling the location for Webex Calling.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: getlistofdisablecallinglocationjobs
        method: GET
        description: Get a List of Disable Calling Location Jobs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: query
          type: string
          description: List disable calling location jobs for this organization.
        - name: max
          in: query
          type: integer
          description: Maximum number of jobs to return.
        - name: start
          in: query
          type: integer
          description: Offset to start returning records from.
    - name: telephony-config-jobs-locations-deleteCallingLocation-jobId
      path: /telephony/config/jobs/locations/deleteCallingLocation/{jobId}
      operations:
      - name: getdisablecallinglocationjobstatus
        method: GET
        description: Get Disable Calling Location Job Status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: jobId
          in: path
          type: string
          description: Unique identifier for the job.
          required: true
        - name: orgId
          in: query
          type: string
          description: Organization ID for which to retrieve the job status.
    - name: telephony-config-jobs-locations-deleteCallingLocation-jobId-actions-pause-invoke
      path: /telephony/config/jobs/locations/deleteCallingLocation/{jobId}/actions/pause/invoke
      operations:
      - name: pausedisablecallinglocationjob
        method: POST
        description: Pause a Disable Calling Location Job
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: jobId
          in: path
          type: string
          description: Unique identifier for the job to pause.
          required: true
        - name: orgId
          in: query
          type: string
          description: Organization ID for which to pause the job.
    - name: telephony-config-jobs-locations-deleteCallingLocation-jobId-actions-resume-invok
      path: /telephony/config/jobs/locations/deleteCallingLocation/{jobId}/actions/resume/invoke
      operations:
      - name: resumepauseddisablecallinglocationjob
        method: POST
        description: Resume a Paused Disable Calling Location Job
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: jobId
          in: path
          type: string
          description: Unique identifier for the job to resume.
          required: true
        - name: orgId
          in: query
          type: string
          description: Organization ID for which to resume the job.
    - name: telephony-config-jobs-locations-deleteCallingLocation-jobId-errors
      path: /telephony/config/jobs/locations/deleteCallingLocation/{jobId}/errors
      operations:
      - name: retrieveerrorsfordisablecallinglocationjob
        method: GET
        description: Retrieve Errors for a Disable Calling Location Job
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: jobId
          in: path
          type: string
          description: Unique identifier for the job to get errors for.
          required: true
        - name: orgId
          in: query
          type: string
          description: Organization ID for disable calling location job.
    - name: telephony-config-jobs-updateRoutingPrefix
      path: /telephony/config/jobs/updateRoutingPrefix
      operations:
      - name: getalistofupdateroutingprefixjobs
        method: GET
        description: Get a List of Update Routing Prefix jobs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: query
          type: string
          description: Retrieve list of update routing prefix jobs in this organization.
    - name: telephony-config-jobs-updateRoutingPrefix-jobId
      path: /telephony/config/jobs/updateRoutingPrefix/{jobId}
      operations:
      - name: getthejobstatusofupdateroutingprefixjob
        method: GET
        description: Get the job status of Update Routing Prefix job
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: jobId
          in: path
          type: string
          description: Retrieve job status for this `jobId`.
          required: true
        - name: orgId
          in: query
          type: string
          description: Check update routing prefix job status in this organization.
    - name: telephony-config-jobs-updateRoutingPrefix-jobId-errors
      path: /telephony/config/jobs/updateRoutingPrefix/{jobId}/errors
      operations:
      - name: getjoberrorsforupdateroutingprefixjob
        method: GET
        description: Get job errors for update routing prefix job
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: jobId
          in: path
          type: string
          description: Retrieve job errors for this `jobId`.
          required: true
        - name: orgId
          in: query
          type: string
          description: Retrieve list of errors for update routing prefix job in this organization.
    - name: telephony-config-locations
      path: /telephony/config/locations
      operations:
      - name: listlocationswebexcallingdetails
        method: GET
        description: List Locations Webex Calling Details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: query
          type: string
          description: List locations for this organization.
        - name: max
          in: query
          type: number
          description: Limit the maximum number of locations in the response.
        - name: start
          in: query
          type: number
          description: Specify the offset from the first result that you want to fetch.
        - name: name
          in: query
          type: string
          description: List locations whose name contains this string.
        - name: order
          in: query
          type: string
          description: Sort the list of locations based on `name`, either asc or desc.
      - name: enablealocationforwebexcalling
        method: POST
        description: Enable a Location for Webex Calling
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: query
          type: string
          description: ID of the organization in which the person resides. Only admin users of another organization (such
            as partners) may use this parameter as the default is the sam
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-locations-locationId
      path: /telephony/config/locations/{locationId}
      operations:
      - name: getlocationwebexcallingdetails
        method: GET
        description: Get Location Webex Calling Details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Retrieve Webex Calling location attributes for this location.
          required: true
        - name: orgId
          in: query
          type: string
          description: Retrieve Webex Calling location attributes for this organization.
      - name: updatelocationwebexcallingdetails
        method: PUT
        description: Update Location Webex Calling Details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Updating Webex Calling location attributes for this location.
          required: true
        - name: orgId
          in: query
          type: string
          description: Updating Webex Calling location attributes for this organization.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-locations-locationId-actions-modifyAnnouncementLanguage-invoke
      path: /telephony/config/locations/{locationId}/actions/modifyAnnouncementLanguage/invoke
      operations:
      - name: changeannouncementlanguage
        method: POST
        description: Change Announcement Language
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Change announcement language for this location.
          required: true
        - name: orgId
          in: query
          type: string
          description: Change announcement language for this organization.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-locations-locationId-actions-precheckForDeletion-invoke
      path: /telephony/config/locations/{locationId}/actions/precheckForDeletion/invoke
      operations:
      - name: safedeletecheckbeforedisablingcallinglocation
        method: POST
        description: Safe Delete Check Before Disabling a Location for Webex Calling
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Unique identifier for the location to be checked.
          required: true
        - name: orgId
          in: query
          type: string
          description: Organization ID for which the safe delete check operation is being performed.
    - name: telephony-config-locations-locationId-actions-validateExtensions-invoke
      path: /telephony/config/locations/{locationId}/actions/validateExtensions/invoke
      operations:
      - name: validateextensions
        method: POST
        description: Validate Extensions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Validate extensions for this location.
          required: true
        - name: orgId
          in: query
          type: string
          description: Validate extensions for this organization.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-locations-locationId-availableNumbers
      path: /telephony/config/locations/{locationId}/availableNumbers
      operations:
      - name: getavailablephonenumbersforalocationwithgivencriteria
        method: GET
        description: Get Available Phone Numbers for a Location with Given Criteria
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Return the list of phone numbers for this location within the given organization. The maximum length
            is 36.
          required: true
        - name: orgId
          in: query
          type: string
          description: List numbers for this organization.
        - name: max
          in: query
          type: number
          description: Limit the number of phone numbers returned to this maximum count. The default is 2000.
        - name: start
          in: query
          type: number
          description: Start at the zero-based offset in the list of matching phone numbers. The default is 0.
        - name: phoneNumber
          in: query
          type: array
          description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array.
        - name: ownerName
          in: query
          type: string
          description: Return the list of phone numbers that are owned by the given `ownerName`. Maximum length is 255.
    - name: telephony-config-locations-locationId-callCaptions
      path: /telephony/config/locations/{locationId}/callCaptions
      operations:
      - name: getthelocationcallcaptionssettings
        method: GET
        description: Get the location call captions settings
        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: Unique identifier for the organization.
      - name: updatethelocationcallcaptionssettings
        method: PUT
        description: Update the location call captions settings
        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: Unique identifier for the organization.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-locations-locationId-callIntercept-availableNumbers
      path: /telephony/config/locations/{locationId}/callIntercept/availableNumbers
      operations:
      - name: getlocationcallinterceptavailablephonenumbers
        method: GET
        description: Get Location Call Intercept Available Phone Numbers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Return the list of phone numbers for this location within the given organization. The maximum length
            is 36.
          required: true
        - name: orgId
          in: query
          type: string
          description: List numbers for this organization.
        - name: max
          in: query
          type: number
          description: Limit the number of phone numbers returned to this maximum count. The default is 2000.
        - name: start
          in: query
          type: number
          description: Start at the zero-based offset in the list of matching phone numbers. The default is 0.
        - name: phoneNumber
          in: query
          type: array
          description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array.
        - name: ownerName
          in: query
          type: string
          description: Return the list of phone numbers that are owned by the given `ownerName`. Maximum length is 255.
        - name: extension
          in: query
          type: string
          description: Returns the list of phone numbers with the given `extension`.
    - name: telephony-config-locations-locationId-chargeNumber-availableNumbers
      path: /telephony/config/locations/{locationId}/chargeNumber/availableNumbers
      operations:
      - name: getavailablechargenumberslist
        method: GET
        description: Get Available Charge Numbers for a Location with Given Criteria
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Return the list of available charge numbers for this location within the given organization. The maximum
            length is 36.
          required: true
        - name: orgId
          in: query
          type: string
          description: List numbers for this organization.
        - name: max
          in: query
          type: number
          description: Limit the number of phone numbers returned to this maximum count. The default is 2000.
        - name: start
          in: query
          type: number
          description: Start at the zero-based offset in the list of matching phone numbers. The default is 0.
        - name: phoneNumber
          in: query
          type: array
          description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array.
        - name: ownerName
          in: query
          type: string
          description: Return the list of phone numbers that are owned by the given `ownerName`. Maximum length is 255.
    - name: telephony-config-locations-locationId-emergencyCallbackNumber-availableNumbers
      path: /telephony/config/locations/{locationId}/emergencyCallbackNumber/availableNumbers
      operations:
      - name: getlocationecbnavailablephonenumbers
        method: GET
        description: Get Location ECBN Available Phone Numbers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Return the list of phone numbers for this location within the given organization. The maximum length
            is 36.
          required: true
        - name: orgId
          in: query
          type: string
          description: List numbers for this organization.
        - name: max
          in: query
          type: number
          description: Limit the number of phone numbers returned to this maximum count. The default is 2000.
        - name: start
          in: query
          type: number
          description: Start at the zero-based offset in the list of matching phone numbers. The default is 0.
        - name: phoneNumber
          in: query
          type: array
          description: Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array.
        - name: ownerName
          in: query
          type: string
          description: Return the list of phone numbers that are owned by the given `ownerName`. Maximum length is 255.
    - name: telephony-config-locations-locationId-externalCallerId-availableNumbers
      path: /telephony/config/locations/{locationId}/externalCallerId/availableNumbers
      operations:
      - name: getthelistofphonenumbersavailableforexternalcallerid
        method: GET
        description: Get the List of Phone Numbers Available for External Caller ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Retrieve available external caller ID numbers for this location.
          required: true
        - name: orgId
          in: query
          type: string
          description: List numbers for this organization.
        - name: max
          in: query
          type: number
          description: Limit the number of phone numbers returned to this maximum count. The default is 2000.
        - name: start
          in: query
          type: number
          description: Start at the zero-based offset in the list of matching phone numbers. The default is 0.
        - name: phoneNumber
          in: query
          type: array
          description: Filter phone numbers based on the provided list in the `phoneNumber` array.
        - name: ownerName
          in: query
          type: string
          description: Return the list of phone numbers that are owned by the given `ownerName`. Maximum length is 255.
        - name: personId
          in: query
          type: string
          description: Retrieve available external caller ID numbers for this person. If `personId` is not provided it may
            result in the unsuccessful assignment of the returned number
    - name: telephony-config-locations-locationId-features-emergencyCallbackNumber
      path: /telephony/config/locations/{locationId}/features/emergencyCallbackNumber
      operations:
      - name: getalocationemergencycallbacknumber
        method: GET
        description: Get a Location Emergency callback number
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Update location attributes for this location.
          required: true
        - name: orgId
          in: query
          type: string
          description: Update location attributes for this organization.
      - name: updatealocationemergencycallbacknumber
        method: PUT
        description: Update a Location Emergency callback number
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Update location attributes for this location.
          required: true
        - name: orgId
          in: query
          type: string
          description: Update location attributes for this organization.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-locations-locationId-musicOnHold
      path: /telephony/config/locations/{locationId}/musicOnHold
      operations:
      - name: updatemusiconhold
        method: PUT
        description: Update Music On Hold
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Update music on hold settings for this location.
          required: true
        - name: orgId
          in: query
          type: string
          description: Update music on hold settings for this organization.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: getmusiconhold
        method: GET
        description: Get Music On Hold
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Retrieve music on hold settings for this location.
          required: true
        - name: orgId
          in: query
          type: string
          description: Retrieve music on hold settings for this organization.
    - name: telephony-config-locations-locationId-privateNetworkConnect
      path: /telephony/config/locations/{locationId}/privateNetworkConnect
      operations:
      - name: getprivatenetworkconnect
        method: GET
        description: Get Private Network Connect
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Retrieve the network connection type for this location.
          required: true
        - name: orgId
          in: query
          type: string
          description: Retrieve the network connection type for this organization.
      - name: updateprivatenetworkconnect
        method: PUT
        description: Update Private Network Connect
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Update the network connection type for this location.
          required: true
        - name: orgId
          in: query
          type: string
          description: Update network connection type for this organization.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-locations-locationId-receptionistContacts-directories
      path: /telephony/config/locations/{locationId}/receptionistContacts/directories
      operations:
      - name: createareceptionistcontactdirectory
        method: POST
        description: Create a Receptionist Contact Directory
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Add a Receptionist Contact Directory to this location.
          required: true
        - name: orgId
          in: query
          type: string
          description: Add a Receptionist Contact Directory to this organization.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: readlistofreceptionistcontactdirectories
        method: GET
        description: Read list of Receptionist Contact Directories
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: List Receptionist Contact Directories for this location.
          required: true
        - name: orgId
          in: query
          type: string
          description: List Receptionist Contact Directories for this organization.
    - name: telephony-config-locations-locationId-receptionistContacts-directories-directory
      path: /telephony/config/locations/{locationId}/receptionistContacts/directories/{directoryId}
      operations:
      - name: getdetailsforareceptionistcontactdirectory
        method: GET
        description: Get details for a Receptionist Contact Directory
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Get a Receptionist Contact Directory from this location.
          required: true
        - name: directoryId
          in: path
          type: string
          description: Get details for the Receptionist Contact Directory with this identifier.
          required: true
        - name: orgId
          in: query
          type: string
          description: Get a Receptionist Contact Directory from this organization.
        - name: searchCriteriaModeOr
          in: query
          type: boolean
          description: When `true`, results matching any one of the search criteria are included. The value can only be `true`
            or not included in the request. Specifying `searchCriter
        - name: firstName
          in: query
          type: string
          description: Search for directories that contain people with the indicated first name.
        - name: lastName
          in: query
          type: string
          description: Search for directories that contain people with the indicated last name.
        - name: phoneNumber
          in: query
          type: string
          description: Search for directories that contain people with the indicated phone number.
        - name: extension
          in: query
          type: string
          description: Search for directories that contain people with the indicated extension.
        - name: personId
          in: query
          type: string
          description: Search for directories that contain people with the indicated person ID.
      - name: deleteareceptionistcontactdirectory
        method: DELETE
        description: Delete a Receptionist Contact Directory
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Delete a Receptionist Contact Directory from this location.
          required: true
        - name: directoryId
          in: path
          type: string
          description: Delete the Receptionist Contact Directory ID with the matching ID.
          required: true
        - name: orgId
          in: query
          type: string
          description: Delete a Receptionist Contact Directory from this organization.
      - name: modifyareceptionistcontactdirectory
        method: PUT
        description: Modify a Receptionist Contact Directory
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: locationId
          in: path
          type: string
          description: Modify list of Receptionist Contact Directories for this location.
          required: true
        - name: directoryId
          in: path
          type: string
          description: Get details for the Receptionist Contact Directory with this identifier.
          required: true
        - name: orgId
          in: query
          type: string
          description: Modify list of Receptionist Contact Director

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