Webex Cloud Calling — Virtual Line Call Settings

naftiko: 1.0.0-alpha2
info:
  label: Webex Cloud Calling — Virtual Line Call Settings
  description: 'Webex Cloud Calling — Virtual Line Call Settings. 63 operations. Lead operation: Read the List of Virtual
    Lines. Self-contained Naftiko capability covering one Webex business surface.'
  tags:
  - Webex
  - Virtual Line 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-virtual-line-call-settings
    baseUri: ''
    description: Webex Cloud Calling — Virtual Line Call Settings business capability. Self-contained, no shared references.
    resources:
    - name: telephony-config-virtualLines
      path: /telephony/config/virtualLines
      operations:
      - name: readthelistofvirtuallines
        method: GET
        description: Read the List of Virtual Lines
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: query
          type: string
          description: List virtual lines for this organization.
        - name: locationId
          in: query
          type: array
          description: Return the list of virtual lines matching these location ids. Example for multiple values - `?locationId=locId1&locationId=locId2`.
        - 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: id
          in: query
          type: array
          description: Return the list of virtual lines matching these virtualLineIds. Example for multiple values - `?id=id1&id=id2`.
        - name: ownerName
          in: query
          type: array
          description: Return the list of virtual lines matching these owner names. Example for multiple values - `?ownerName=name1&ownerName=name2`.
        - name: phoneNumber
          in: query
          type: array
          description: Return the list of virtual lines matching these phone numbers. Example for multiple values - `?phoneNumber=number1&phoneNumber=number2`.
        - name: locationName
          in: query
          type: array
          description: Return the list of virtual lines matching the location names. Example for multiple values - `?locationName=loc1&locationName=loc2`.
        - name: order
          in: query
          type: array
          description: Return the list of virtual lines based on the order. Default sort will be in an Ascending order. Maximum
            3 orders allowed at a time. Example for multiple values
        - name: hasDeviceAssigned
          in: query
          type: boolean
          description: If `true`, includes only virtual lines with devices assigned. When not explicitly specified, the default
            includes both virtual lines with devices assigned and n
        - name: hasExtensionAssigned
          in: query
          type: boolean
          description: If `true`, includes only virtual lines with an extension assigned. When not explicitly specified, the
            default includes both virtual lines with extension assigne
        - name: hasDnAssigned
          in: query
          type: boolean
          description: If `true`, includes only virtual lines with an assigned directory number, also known as a Dn. When
            not explicitly specified, the default includes both virtual l
      - name: createavirtualline
        method: POST
        description: Create a Virtual Line
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: query
          type: string
          description: Create the virtual line for this organization.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-virtualLines-availableNumbers
      path: /telephony/config/virtualLines/availableNumbers
      operations:
      - name: getvirtuallineavailablephonenumbers
        method: GET
        description: Get Virtual Line Available Phone Numbers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: query
          type: string
          description: List numbers for this organization.
        - name: locationId
          in: query
          type: string
          description: Return the list of phone numbers for this location within the given organization. The maximum length
            is 36.
        - 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: telephony-config-virtualLines-virtualLineId
      path: /telephony/config/virtualLines/{virtualLineId}
      operations:
      - name: deleteavirtualline
        method: DELETE
        description: Delete a Virtual Line
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: virtualLineId
          in: path
          type: string
          description: Delete the virtual line with the matching ID.
          required: true
        - name: orgId
          in: query
          type: string
          description: Delete the virtual line from this organization.
      - name: getdetailsforavirtualline
        method: GET
        description: Get Details for a Virtual Line
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: virtualLineId
          in: path
          type: string
          description: Retrieve settings for a virtual line with the matching ID.
          required: true
        - name: orgId
          in: query
          type: string
          description: Retrieve virtual line settings from this organization.
      - name: updateavirtualline
        method: PUT
        description: Update a Virtual Line
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: virtualLineId
          in: path
          type: string
          description: Update settings for a virtual line with the matching ID.
          required: true
        - name: orgId
          in: query
          type: string
          description: Update virtual line settings from this organization.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-virtualLines-virtualLineId-agent-availableCallerIds
      path: /telephony/config/virtualLines/{virtualLineId}/agent/availableCallerIds
      operations:
      - name: retrieveagentslistofavailablecallerids
        method: GET
        description: Retrieve Agent's List of Available Caller IDs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: virtualLineId
          in: path
          type: string
          description: Unique identifier for the Virtual Line.
          required: true
        - name: orgId
          in: query
          type: string
          description: ID of the organization in which the Virtual Line resides. Only admin users of another organization
            (such as partners) may use this parameter as the default is t
    - name: telephony-config-virtualLines-virtualLineId-agent-callerId
      path: /telephony/config/virtualLines/{virtualLineId}/agent/callerId
      operations:
      - name: retrieveagentscalleridinformation
        method: GET
        description: Retrieve Agent's Caller ID Information
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: virtualLineId
          in: path
          type: string
          description: Unique identifier for the Virtual Line.
          required: true
      - name: modifyagentscalleridinformation
        method: PUT
        description: Modify Agent's Caller ID Information
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: virtualLineId
          in: path
          type: string
          description: Unique identifier for the Virtual Line.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-virtualLines-virtualLineId-bargeIn
      path: /telephony/config/virtualLines/{virtualLineId}/bargeIn
      operations:
      - name: readbargeinsettingsforavirtualline
        method: GET
        description: Read Barge In Settings for a Virtual Line
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: virtualLineId
          in: path
          type: string
          description: Retrieve settings for a virtual line with the matching ID.
          required: true
        - name: orgId
          in: query
          type: string
          description: ID of the organization in which the virtual line resides. Only admin users of another organization
            (such as partners) may use this parameter as the default is t
      - name: configurebargeinsettingsforavirtualline
        method: PUT
        description: Configure Barge In Settings for a Virtual Line
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: virtualLineId
          in: path
          type: string
          description: Retrieve settings for a virtual line with the matching ID.
          required: true
        - name: orgId
          in: query
          type: string
          description: ID of the organization in which the virtual line resides. Only admin users of another organization
            (such as partners) may use this parameter as the default is t
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-virtualLines-virtualLineId-callBridge
      path: /telephony/config/virtualLines/{virtualLineId}/callBridge
      operations:
      - name: readcallbridgesettingsforavirtualline
        method: GET
        description: Read Call Bridge Settings for a Virtual Line
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: virtualLineId
          in: path
          type: string
          description: Retrieve settings for a virtual line with the matching ID.
          required: true
        - name: orgId
          in: query
          type: string
          description: ID of the organization in which the virtual line resides. Only admin users of another organization
            (such as partners) may use this parameter as the default is t
      - name: configurecallbridgesettingsforavirtualline
        method: PUT
        description: Configure Call Bridge Settings for a Virtual Line
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: virtualLineId
          in: path
          type: string
          description: Retrieve settings for a virtual line with the matching ID.
          required: true
        - name: orgId
          in: query
          type: string
          description: ID of the organization in which the virtual line resides. Only admin users of another organization
            (such as partners) may use this parameter as the default is t
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-virtualLines-virtualLineId-callForwarding
      path: /telephony/config/virtualLines/{virtualLineId}/callForwarding
      operations:
      - name: readcallforwardingsettingsforavirtualline
        method: GET
        description: Read Call Forwarding Settings for a Virtual Line
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: virtualLineId
          in: path
          type: string
          description: Retrieve settings for a virtual line with the matching ID.
          required: true
        - name: orgId
          in: query
          type: string
          description: ID of the organization in which the virtual line resides. Only admin users of another organization
            (such as partners) may use this parameter as the default is t
      - name: configurecallforwardingsettingsforavirtualline
        method: PUT
        description: Configure Call Forwarding Settings for a Virtual Line
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: virtualLineId
          in: path
          type: string
          description: Update settings for a virtual line with the matching ID.
          required: true
        - name: orgId
          in: query
          type: string
          description: ID of the organization in which the virtual line resides. Only admin users of another organization
            (such as partners) may use this parameter as the default is t
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-virtualLines-virtualLineId-callForwarding-availableNumbers
      path: /telephony/config/virtualLines/{virtualLineId}/callForwarding/availableNumbers
      operations:
      - name: getvirtuallinecallforwardavailablephonenumbers
        method: GET
        description: Get Virtual Line Call Forward Available Phone Numbers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: virtualLineId
          in: path
          type: string
          description: Unique identifier for the virtual line.
          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 PSTN phone numbers with the given `extension`.
    - name: telephony-config-virtualLines-virtualLineId-callIntercept-availableNumbers
      path: /telephony/config/virtualLines/{virtualLineId}/callIntercept/availableNumbers
      operations:
      - name: getvirtuallinecallinterceptavailablephonenumbers
        method: GET
        description: Get Virtual Line Call Intercept Available Phone Numbers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: virtualLineId
          in: path
          type: string
          description: Unique identifier for the virtual line.
          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 PSTN phone numbers with the given `extension`.
    - name: telephony-config-virtualLines-virtualLineId-callRecording
      path: /telephony/config/virtualLines/{virtualLineId}/callRecording
      operations:
      - name: readcallrecordingsettingsforavirtualline
        method: GET
        description: Read Call Recording Settings for a Virtual Line
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: virtualLineId
          in: path
          type: string
          description: Unique identifier for the virtual line.
          required: true
        - name: orgId
          in: query
          type: string
          description: ID of the organization in which the virtual line resides. Only admin users of another organization
            (such as partners) may use this parameter as the default is t
      - name: configurecallrecordingsettingsforavirtualline
        method: PUT
        description: Configure Call Recording Settings for a Virtual Line
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: virtualLineId
          in: path
          type: string
          description: Unique identifier for the virtual line.
          required: true
        - name: orgId
          in: query
          type: string
          description: ID of the organization in which the virtual profile resides. Only admin users of another organization
            (such as partners) may use this parameter as the default i
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-virtualLines-virtualLineId-callWaiting
      path: /telephony/config/virtualLines/{virtualLineId}/callWaiting
      operations:
      - name: readcallwaitingsettingsforavirtualline
        method: GET
        description: Read Call Waiting Settings for a Virtual Line
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: virtualLineId
          in: path
          type: string
          description: Retrieve settings for a virtual line with the matching ID.
          required: true
        - name: orgId
          in: query
          type: string
          description: ID of the organization in which the virtual line resides. Only admin users of another organization
            (such as partners) may use this parameter as the default is t
      - name: configurecallwaitingsettingsforavirtualline
        method: PUT
        description: Configure Call Waiting Settings for a Virtual Line
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: virtualLineId
          in: path
          type: string
          description: Update settings for a virtual line with the matching ID.
          required: true
        - name: orgId
          in: query
          type: string
          description: ID of the organization in which the virtual line resides. Only admin users of another organization
            (such as partners) may use this parameter as the default is t
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-virtualLines-virtualLineId-callerId
      path: /telephony/config/virtualLines/{virtualLineId}/callerId
      operations:
      - name: readcalleridsettingsforavirtualline
        method: GET
        description: Read Caller ID Settings for a Virtual Line
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: virtualLineId
          in: path
          type: string
          description: Retrieve settings for a virtual line with the matching ID.
          required: true
        - name: orgId
          in: query
          type: string
          description: 'ID of the organization in which the virtual line resides. Only admin users of another organization
            (such as partners) may use this parameter, as the default is '
      - name: configurecalleridsettingsforavirtualline
        method: PUT
        description: Configure Caller ID Settings for a Virtual Line
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: virtualLineId
          in: path
          type: string
          description: Update settings for a virtual line with the matching ID.
          required: true
        - name: orgId
          in: query
          type: string
          description: 'ID of the organization in which the virtual line resides. Only admin users of another organization
            (such as partners) may use this parameter, as the default is '
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-virtualLines-virtualLineId-dectNetworks
      path: /telephony/config/virtualLines/{virtualLineId}/dectNetworks
      operations:
      - name: getlistofdectnetworkshandsetsforavirtualline
        method: GET
        description: Get List of DECT Networks Handsets for a Virtual Line
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: virtualLineId
          in: path
          type: string
          description: Retrieve settings for a virtual line with the matching ID.
          required: true
        - name: orgId
          in: query
          type: string
          description: Retrieve virtual line settings from this organization.
    - name: telephony-config-virtualLines-virtualLineId-devices
      path: /telephony/config/virtualLines/{virtualLineId}/devices
      operations:
      - name: getlistofdevicesassignedforavirtualline
        method: GET
        description: Get List of Devices assigned for a Virtual Line
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: virtualLineId
          in: path
          type: string
          description: Retrieve settings for a virtual line with the matching ID.
          required: true
        - name: orgId
          in: query
          type: string
          description: Retrieve virtual line settings from this organization.
    - name: telephony-config-virtualLines-virtualLineId-directorySearch
      path: /telephony/config/virtualLines/{virtualLineId}/directorySearch
      operations:
      - name: updatedirectorysearchforavirtualline
        method: PUT
        description: Update Directory search for a Virtual Line
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: virtualLineId
          in: path
          type: string
          description: Update settings for a virtual line with the matching ID.
          required: true
        - name: orgId
          in: query
          type: string
          description: Update virtual line settings from this organization.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-virtualLines-virtualLineId-doNotDisturb
      path: /telephony/config/virtualLines/{virtualLineId}/doNotDisturb
      operations:
      - name: getvirtuallinedonotdisturb
        method: GET
        description: Retrieve DoNotDisturb Settings for a Virtual Line
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: virtualLineId
          in: path
          type: string
          description: Unique identifier for the virtual line.
          required: true
        - name: orgId
          in: query
          type: string
          description: ID of the organization within which the virtual line resides.
      - name: putvirtuallinedonotdisturb
        method: PUT
        description: Modify DoNotDisturb Settings for a Virtual Line
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: virtualLineId
          in: path
          type: string
          description: Unique identifier for the virtual line.
          required: true
        - name: orgId
          in: query
          type: string
          description: ID of the organization within which the virtual line resides.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-virtualLines-virtualLineId-emergencyCallbackNumber-availableNum
      path: /telephony/config/virtualLines/{virtualLineId}/emergencyCallbackNumber/availableNumbers
      operations:
      - name: getvirtuallineecbnavailablephonenumbers
        method: GET
        description: Get Virtual Line ECBN Available Phone Numbers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: virtualLineId
          in: path
          type: string
          description: Unique identifier for the virtual line.
          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-virtualLines-virtualLineId-faxMessage-availableNumbers
      path: /telephony/config/virtualLines/{virtualLineId}/faxMessage/availableNumbers
      operations:
      - name: getvirtuallinefaxmessageavailablephonenumbers
        method: GET
        description: Get Virtual Line Fax Message Available Phone Numbers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: virtualLineId
          in: path
          type: string
          description: Unique identifier for the virtual line.
          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: telephony-config-virtualLines-virtualLineId-incomingPermission
      path: /telephony/config/virtualLines/{virtualLineId}/incomingPermission
      operations:
      - name: readincomingpermissionsettingsforavirtualline
        method: GET
        description: Read Incoming Permission Settings for a Virtual Line
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: virtualLineId
          in: path
          type: string
          description: Retrieve settings for a virtual line with the matching ID.
          required: true
        - name: orgId
          in: query
          type: string
          description: ID of the organization in which the virtual line resides. Only admin users of another organization
            (such as partners) may use this parameter as the default is t
      - name: configureincomingpermissionsettingsforavirtualline
        method: PUT
        description: Configure Incoming Permission Settings for a Virtual Line
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: virtualLineId
          in: path
          type: string
          description: Update settings for a virtual line with the matching ID.
          required: true
        - name: orgId
          in: query
          type: string
          description: ID of the organization in which the virtual line resides. Only admin users of another organization
            (such as partners) may use this parameter as the default is t
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: telephony-config-virtualLines-virtualLineId-intercept
      path: /telephony/config/virtualLines/{virtualLineId}/intercept
      operations:
      - name: readcallinterceptsettingsforavirtualline
        method: GET
        description: Read Call Intercept Settings for a Virtual Line
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: virtualLineId
          in: path
          type: string
          description: Retrieve settings for a virtual line with the matching ID.
          required: true
        - 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: configurecallinterceptsettingsforavirtualline
        method: 

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