Webex Cloud Calling — Device Call Settings

naftiko: 1.0.0-alpha2
info:
  label: Webex Cloud Calling — Device Call Settings
  description: 'Webex Cloud Calling — Device Call Settings. 47 operations. Lead operation: Preview Apply Line Key Template.
    Self-contained Naftiko capability covering one Webex business surface.'
  tags:
  - Webex
  - Device 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-device-call-settings
    baseUri: ''
    description: Webex Cloud Calling — Device Call Settings business capability. Self-contained, no shared references.
    resources:
    - name: telephony-config-devices-actions-previewApplyLineKeyTemplate-invoke
      path: /telephony/config/devices/actions/previewApplyLineKeyTemplate/invoke
      operations:
      - name: previewapplylinekeytemplate
        method: POST
        description: Preview Apply Line Key Template
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: query
          type: string
          description: Preview Line Key Template for this organization.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-devices-actions-validateMacs-invoke
      path: /telephony/config/devices/actions/validateMacs/invoke
      operations:
      - name: validatealistofmacaddress
        method: POST
        description: Validate a list of MAC address
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: query
          type: string
          description: Validate the mac address(es) for this organization.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-devices-availableMembers-count
      path: /telephony/config/devices/availableMembers/count
      operations:
      - name: getcountofavailablemembers
        method: GET
        description: Get Count of Available Members
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: query
          type: string
          description: Retrieves the count of available members in this organization.
        - name: memberName
          in: query
          type: string
          description: Search (Contains) numbers based on member name.
        - name: phoneNumber
          in: query
          type: string
          description: Search (Contains) based on number.
        - name: locationId
          in: query
          type: string
          description: Unique identifier for the location.
        - name: extension
          in: query
          type: string
          description: Search (Contains) based on extension.
        - name: usageType
          in: query
          type: string
          description: Search for members eligible to become the owner of the device, or share line on the device.
        - name: excludeVirtualLine
          in: query
          type: boolean
          description: If true, filters out virtual lines from the available members list.
        - name: deviceLocationId
          in: query
          type: string
          description: Unique identifier for the device's location. When specified, filters available members to those in
            the same location as the device.
    - name: telephony-config-devices-backgroundImages
      path: /telephony/config/devices/backgroundImages
      operations:
      - name: readthelistofbackgroundimages
        method: GET
        description: Read the List of Background Images
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: query
          type: string
          description: Retrieves the list of images in this organization.
      - name: deletedevicebackgroundimages
        method: DELETE
        description: Delete Device Background Images
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: query
          type: string
          description: Deletes the list of images in this organization.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-devices-dectNetworks-supportedDevices
      path: /telephony/config/devices/dectNetworks/supportedDevices
      operations:
      - name: readthedectdevicetypelist
        method: GET
        description: Read the DECT device type list
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: query
          type: string
    - name: telephony-config-devices-dects-supportedDevices
      path: /telephony/config/devices/dects/supportedDevices
      operations:
      - name: readthedectdevicetypelistdeprecated
        method: GET
        description: Read the DECT device type list - Deprecated
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: query
          type: string
    - name: telephony-config-devices-lineKeyTemplates
      path: /telephony/config/devices/lineKeyTemplates
      operations:
      - name: createlinekeytemplate
        method: POST
        description: Create a Line Key Template
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: query
          type: string
          description: Organization to which the line key template belongs.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: readlistoflinekeytemplates
        method: GET
        description: Read the list of Line Key Templates
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: query
          type: string
          description: List line key templates for this organization.
    - name: telephony-config-devices-lineKeyTemplates-templateId
      path: /telephony/config/devices/lineKeyTemplates/{templateId}
      operations:
      - name: getdetailsoflinekeytemplate
        method: GET
        description: Get details of a Line Key Template
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: templateId
          in: path
          type: string
          description: Get line key template for this template ID.
          required: true
        - name: orgId
          in: query
          type: string
          description: Retrieve a line key template for this organization.
      - name: modifylinekeytemplate
        method: PUT
        description: Modify a Line Key Template
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: templateId
          in: path
          type: string
          description: Modify line key template with this template ID.
          required: true
        - name: orgId
          in: query
          type: string
          description: Modify a line key template for this organization.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deletelinekeytemplate
        method: DELETE
        description: Delete a Line Key Template
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: templateId
          in: path
          type: string
          description: Delete line key template with this template ID.
          required: true
        - name: orgId
          in: query
          type: string
          description: Delete a line key template for this organization.
    - name: telephony-config-devices-settings
      path: /telephony/config/devices/settings
      operations:
      - name: readdeviceoverridesettingsfororganization
        method: GET
        description: Read the device override settings for a organization
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: query
          type: string
          description: List supported devices for an organization.
    - name: telephony-config-devices-deviceId
      path: /telephony/config/devices/{deviceId}
      operations:
      - name: getwebexcallingdevicedetails
        method: GET
        description: Get Webex Calling Device Details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: deviceId
          in: path
          type: string
          description: Unique identifier for the device.
          required: true
        - name: orgId
          in: query
          type: string
          description: ID of the organization in which the device resides.
      - name: updatethirdpartydevice
        method: PUT
        description: Update Third Party Device
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: deviceId
          in: path
          type: string
          description: Unique identifier for the device.
          required: true
        - name: orgId
          in: query
          type: string
          description: ID of the organization in which the device resides.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-devices-deviceId-actions-applyChanges-invoke
      path: /telephony/config/devices/{deviceId}/actions/applyChanges/invoke
      operations:
      - name: applychangesforaspecificdevice
        method: POST
        description: Apply Changes for a specific device
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: deviceId
          in: path
          type: string
          description: Unique identifier for the device.
          required: true
        - name: orgId
          in: query
          type: string
          description: Apply changes for a device in this organization.
    - name: telephony-config-devices-deviceId-actions-backgroundImageUpload-invoke
      path: /telephony/config/devices/{deviceId}/actions/backgroundImageUpload/invoke
      operations:
      - name: uploadadevicebackgroundimage
        method: POST
        description: Upload a Device Background Image
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: deviceId
          in: path
          type: string
          description: Unique identifier for the device.
          required: true
        - name: orgId
          in: query
          type: string
          description: Uploads the image in this organization.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: telephony-config-devices-deviceId-availableMembers
      path: /telephony/config/devices/{deviceId}/availableMembers
      operations:
      - name: searchmembers
        method: GET
        description: Search Members
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: deviceId
          in: path
          type: string
          description: Unique identifier for the device.
          required: true
        - name: orgId
          in: query
          type: string
          description: Retrieves the list of available members on the device in this organization.
        - name: start
          in: query
          type: number
          description: Specifies the offset from the first result that you want to fetch.
        - name: max
          in: query
          type: number
          description: Specifies the maximum number of records that you want to fetch.
        - name: memberName
          in: query
          type: string
          description: Search (Contains) numbers based on member name.
        - name: phoneNumber
          in: query
          type: string
          description: Search (Contains) based on number.
        - name: locationId
          in: query
          type: string
          description: Unique identifier for the location.
        - name: extension
          in: query
          type: string
          description: Search (Contains) based on extension.
        - name: usageType
          in: query
          type: string
          description: Search for members eligible to become the owner of the device, or share line on the device.
        - name: order
          in: query
          type: string
          description: 'Sort the list of available members on the device in ascending order by name, use either last name
            `lname` or first name `fname`. Default: last name in ascending'
    - name: telephony-config-devices-deviceId-availableMembers-count
      path: /telephony/config/devices/{deviceId}/availableMembers/count
      operations:
      - name: getcountofmembers
        method: GET
        description: Get Count of Members
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: deviceId
          in: path
          type: string
          description: Unique identifier for the device.
          required: true
        - name: orgId
          in: query
          type: string
          description: Retrieves the count of available members on the device in this organization.
        - name: memberName
          in: query
          type: string
          description: Search (Contains) numbers based on member name.
        - name: phoneNumber
          in: query
          type: string
          description: Search (Contains) based on number.
        - name: locationId
          in: query
          type: string
          description: Unique identifier for the location.
        - name: extension
          in: query
          type: string
          description: Search (Contains) based on extension.
        - name: usageType
          in: query
          type: string
          description: Search for members eligible to become the owner of the device, or share line on the device.
    - name: telephony-config-devices-deviceId-layout
      path: /telephony/config/devices/{deviceId}/layout
      operations:
      - name: getdevicelayoutbydeviceid
        method: GET
        description: Get Device Layout by Device ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: deviceId
          in: path
          type: string
          description: Get device layout for this device ID.
          required: true
        - name: orgId
          in: query
          type: string
          description: Retrieve a device layout for the device in this organization.
      - name: modifydevicelayoutbydeviceid
        method: PUT
        description: Modify Device Layout by Device ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: deviceId
          in: path
          type: string
          description: Modify device layout for this device ID.
          required: true
        - name: orgId
          in: query
          type: string
          description: Modify a device layout for the device in this organization.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-devices-deviceId-members
      path: /telephony/config/devices/{deviceId}/members
      operations:
      - name: getdevicemembers
        method: GET
        description: Get Device Members
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: deviceId
          in: path
          type: string
          description: Unique identifier for the device.
          required: true
        - name: orgId
          in: query
          type: string
          description: Retrieves the list of all members of the device in this organization.
      - name: updatemembersondevice
        method: PUT
        description: Update Members on the device
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: deviceId
          in: path
          type: string
          description: Unique identifier for the device.
          required: true
        - name: orgId
          in: query
          type: string
          description: Modify members on the device in this organization.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-devices-deviceId-settings
      path: /telephony/config/devices/{deviceId}/settings
      operations:
      - name: getdevicesettings
        method: GET
        description: Get Device Settings
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: deviceId
          in: path
          type: string
          description: Unique identifier for the device.
          required: true
        - name: orgId
          in: query
          type: string
          description: Settings on the device in this organization.
        - name: deviceModel
          in: query
          type: string
          description: The model type of the device. The corresponding device model display name sometimes called the product
            name, can also be used to specify the model.
      - name: updatedevicesettings
        method: PUT
        description: Update device settings
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: deviceId
          in: path
          type: string
          description: Unique identifier for the device.
          required: true
        - name: orgId
          in: query
          type: string
          description: Organization in which the device resides..
        - name: deviceModel
          in: query
          type: string
          description: The model type of the device. The corresponding device model display name sometimes called the product
            name, can also be used to specify the model.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-jobs-devices-applyLineKeyTemplate
      path: /telephony/config/jobs/devices/applyLineKeyTemplate
      operations:
      - name: applylinekeytemplate
        method: POST
        description: Apply a Line Key Template
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: query
          type: string
          description: Apply Line Key Template for this organization.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: getlistofapplylinekeytemplatesjobs
        method: GET
        description: Get List of Apply Line Key Template jobs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: query
          type: string
          description: Retrieve list of line key templates jobs in this organization.
    - name: telephony-config-jobs-devices-applyLineKeyTemplate-jobId
      path: /telephony/config/jobs/devices/applyLineKeyTemplate/{jobId}
      operations:
      - name: getthejobstatusofanapplylinekeytemplatejob
        method: GET
        description: Get the job status of an Apply Line Key Template 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 a line key template job status in this organization.
    - name: telephony-config-jobs-devices-applyLineKeyTemplate-jobId-errors
      path: /telephony/config/jobs/devices/applyLineKeyTemplate/{jobId}/errors
      operations:
      - name: getjoberrorsforapplylinekeytemplatejob
        method: GET
        description: Get job errors for an Apply Line Key Template 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 an apply line key template job in this organization.
    - name: telephony-config-jobs-devices-callDeviceSettings
      path: /telephony/config/jobs/devices/callDeviceSettings
      operations:
      - name: changedevicesettingsacrossorganizationorlocationjob
        method: POST
        description: Change Device Settings Across Organization Or Location Job
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: query
          type: string
          description: Apply change device settings for all the devices under this organization.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: listchangedevicesettingsjobs
        method: GET
        description: List Change Device Settings Jobs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: query
          type: string
          description: Retrieve list of 'calldevicesettings' jobs for this organization.
        - name: start
          in: query
          type: number
          description: Start at the zero-based offset in the list of jobs. Default is 0.
        - name: max
          in: query
          type: number
          description: Limit the number of jobs returned to this maximum count. Default is 2000.
    - name: telephony-config-jobs-devices-callDeviceSettings-jobId
      path: /telephony/config/jobs/devices/callDeviceSettings/{jobId}
      operations:
      - name: getchangedevicesettingsjobstatus
        method: GET
        description: Get Change Device Settings Job Status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: jobId
          in: path
          type: string
          description: Retrieve job details for this `jobId`.
          required: true
    - name: telephony-config-jobs-devices-callDeviceSettings-jobId-errors
      path: /telephony/config/jobs/devices/callDeviceSettings/{jobId}/errors
      operations:
      - name: listchangedevicesettingsjoberrors
        method: GET
        description: List Change Device Settings Job Errors
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: jobId
          in: path
          type: string
          description: Retrieve job details for this `jobId`.
          required: true
        - name: orgId
          in: query
          type: string
          description: Retrieve list of jobs for this organization.
        - name: start
          in: query
          type: number
          description: Specifies the offset from the first result that you want to fetch. Default is 0.
        - name: max
          in: query
          type: number
          description: Specifies the maximum number of records that you want to fetch. Default is 2000
    - name: telephony-config-jobs-devices-rebuildPhones
      path: /telephony/config/jobs/devices/rebuildPhones
      operations:
      - name: rebuildphonesconfiguration
        method: POST
        description: Rebuild Phones Configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: query
          type: string
          description: Rebuild phones for this organization.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: listrebuildphonesjobs
        method: GET
        description: List Rebuild Phones Jobs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: query
          type: string
          description: List of rebuild phones jobs in this organization.
    - name: telephony-config-jobs-devices-rebuildPhones-jobId
      path: /telephony/config/jobs/devices/rebuildPhones/{jobId}
      operations:
      - name: getthejobstatusofarebuildphonesjob
        method: GET
        description: Get the Job Status of a Rebuild Phones 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 a rebuild phones job status in this organization.
    - name: telephony-config-jobs-devices-rebuildPhones-jobId-errors
      path: /telephony/config/jobs/devices/rebuildPhones/{jobId}/errors
      operations:
      - name: getjoberrorsforarebuildphonesjob
        method: GET
        description: Get Job Errors for a Rebuild Phones 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 a rebuild phones job in this organization.
    - name: telephony-config-locations-locationId-devices-settings
      path: /telephony/config/locations/{locationId}/devices/settings
      operations:
      - name: getlocationdevicesettings
        method: GET
        description: Get Location Device 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: Organization in which the device resides.
    - name: telephony-config-people-personId-devices
      path: /telephony/config/people/{personId}/devices
      operations:
      - name: getpersondevices
        method: GET
        description: Get Person Devices
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: personId
          in: path
          type: string
          description: Person for whom to retrieve devices.
          required: true
        - name: orgId
          in: query
          type: string
          description: Organization to which the person belongs.
    - name: telephony-config-people-personId-devices-count
      path: /telephony/config/people/{personId}/devices/count
      operations:
      - name: getuserdevicescount
        method: GET
        description: Get User Devices Count
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: personId
          in: path
          type: string
          description: Person for whom to retrieve the device count.
          required: true
        - name: orgId
          in: query
          type: string
          description: Organization to which the person belongs.
    - name: telephony-config-people-personId-devices-settings
      path: /telephony/config/people/{personId}/devices/settings
      operations:
      - name: getdevicesettingsforaperson
        method: GET
        description: Get Device Settings for a Person
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: personId
          in: path
          type: string
          description: ID of the person for whom to retrieve device settings.
          required: true
        - name: orgId
          in: query
          type: string
          description: Retrieves the device settings for a person in this organization.
      - name: updatedevicesettingsforaperson
        method: PUT
        description: Update Device Settings for a Person
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: personId
          in: path
          type: string
          description: ID of the person for whom to update device settings.
          required: true
        - name: orgId
          in: query
          type: string
          description: Modify device settings for a person in this organization.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-people-personId-devices-settings-hoteling
      path: /telephony/config/people/{personId}/devices/settings/hoteling
      operations:
      - name: modefyhotelingsettingsforpersonsprimarydevices
        method: PUT
        description: Modify Hoteling Settings for a Person's Primary Devices
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: personId
          in: path
          type: string
          description: ID of the person associated with the device.
          required: true
        - name: orgId
          in: query
          type: string
          description: Organization to which the person belongs.
        - name: body
          in: body
          type: object
          d

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