[Index]

Model: relation/HcsCtiRoutePointREL

CUCM CtiRoutePoint

Add a CTI Route Point

To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com

This procedure adds a CTI route point.

A computer telephony integration (CTI) route point designates a virtual device that can receive multiple, simultaneous calls for application-controlled redirection.

Perform these steps:

  1. Log in as provider, reseller, or customer administrator.
  2. Set the hierarchy path to the site for which you want to configure CTI Route Points.
  3. Navigate to the CTI Route Points page:
    • If you're logged in as provider or reseller administrator, choose Device Management > CUCM > CTI Route Points.
    • If you're logged in as customer administrator, choose Device Management > Advanced > CTI Route Points.
  4. Click Add.
  5. Complete at minimum, the mandatory CTI Route Points Fields.
  6. Click + next to Line, to associate a line with the CTI Route Point. Complete, at minimum, the mandatory CTI Route Points Line Fields.
  7. Click Save.

CTI Route Points Fields

Option Description
Device Name * Enter a unique identifier for this device, from 1 to 15 characters, including alphanumeric, dot, dash, or underscores. This field is mandatory.
Description Enter a descriptive name for the CTI route point. The description can include up to 50 characters in any language, but it cannot include double-quotes ("), percentage sign (%), ampersand (&), back-slash (\), or angle brackets (<>).
Device Pool * Choose the name of a Device Pool. The device pool specifies the collection of properties for this device, including Cisco Unified Communications Manager Group, Date Time Group, Region, and Calling Search Space for autoregistration. This field is mandatory.
Common Device Configuration Choose the common device configuration to which you want this CTI route point assigned. The common device configuration includes the attributes (services or features) that are associated with a particular user. Configure common device configurations in the Common Device Configuration window.
Calling Search Space From the drop-down list, choose a calling search space. The calling search space specifies the collection of partitions that are searched to determine how a collected (originating) number is routed.
Location *

From the drop-down list, choose the appropriate location for this CTI route point. This field is mandatory.

Locations implement call admission control (CAC) in a centralized call-processing system. CAC regulates audio quality and video availability by limiting the amount of bandwidth that is available for audio and video calls between locations. The location specifies the total bandwidth that is available for calls to and from this location.

A location setting of Hub_None means that the locations feature does not track the bandwidth that this CTI route point consumes. A location setting of Phantom specifies a location that enables successful CAC across intercluster trunks that use H.323 protocol or SIP.

User Locale

From the drop-down list, choose the locale that is associated with the CTI route point. The user locale identifies a set of detailed information to support users, including language and font. Note:

If no user locale is specified, Cisco Unified CM uses the user locale that is associated with the device pool

Media Resource Group List

Choose the appropriate Media Resource Group List. A Media Resource Group List is a prioritized grouping of media resource groups. An application chooses the required media resource, such as a Music On Hold server, from the available media resources. The application chooses according to the priority order defined in a Media Resource Group List.

If you choose <none>, Cisco Unified CM uses the Media Resource Group that is defined in the device pool.

Option Description
Network Hold MOH Audio Source

Choose the audio source that plays when the network starts a hold action.

If you do not choose an audio source, Cisco Unified CM uses the audio source that is defined in the device pool. If the device pool does not specify an audio source, the system default is used.

User Hold MOH Audio Source

Choose the audio source that plays when an application starts a hold action.

If you do not choose an audio source, Cisco Unified CM uses the audio source that is defined in the device pool. If the device pool does not specify an audio source, the system default is used.

Use Trusted Relay Point Required Field *

Enable or disable whether Cisco Unified CM inserts a trusted relay point (TRP) device with this media endpoint. This field is mandatory. Choose one of the following values:

  • Default - If you choose this value, the device uses the Use Trusted Relay Point setting from the common device configuration with which this device associates.
  • Off - Choose this value to disable the use of a TRP with this device. This setting overrides the Use Trusted Relay Point setting in the common device configuration with which this device associates.
  • On - Choose this value to enable the use of a TRP with this device. This setting overrides the Use Trusted Relay Point setting in the common device configuration with which this device associates.

A Trusted Relay Point (TRP) device designates an MTP or transcoder device that is labeled as Trusted Relay Point.

Calling Party Transformation CSS

This setting allows you to localize the calling party number on the device. Make sure that the Calling Party Transformation CSS that you choose contains the calling party transformation pattern that you want to assign to this device. Tip:

Before the call occurs, the device must apply the transformation by using digit analysis. If you configure the Calling Party Transformation CSS as None, the transformation does not match and does not get applied. Ensure that you configure the Calling Party Transformation Pattern in a non-null partition that is not used for routing.

Geolocation

From the drop-down list box, choose a geolocation.

You can choose the Unspecified geolocation, which designates that this device does not associate with a geolocation.

Use Device Pool Calling Party Transformation CSS To use the Calling Party Transformation CSS that is configured in the device pool that is assigned to this device, select this check box. If you do not select this check box, the device uses the Calling Party Transformation CSS that you configured in the CTI Route Point Configuration window.

CTI Route Points Line Fields

Field Description
Directory Number *

Enter a dialable phone number. Values can include route pattern wildcards and numeric characters (0 to 9). Special characters such as a question mark (?), exclamation mark (!), backslash (\), brackets ([ ]), plus sign (+), dash (-), asterisk (*), caret (^), pound sign (#), and an X are also allowable. Special characters that are not allowed are a period (.), at sign (@), dollar sign ($), and percent sign (%). This field is mandatory.

At the beginning of the pattern, enter \+ if you want to use the international escape character +. For this field, \+ does not represent a wildcard; instead, entering \+ represents a dialable digit.

Route Partition * Choose the partition to which the directory number belongs. Make sure that the directory number that you enter in the Directory Number field is unique within the partition that you choose. If you do not want to restrict access to the directory number, choose <None> for the partition.
Index This field is the line position on the device. If left blank, an integer is automatically assigned.
External Phone Number Mask

Indicate phone number (or mask) that is used to send Caller ID information when a call is placed from this line.

You can enter a maximum of 24 number, the international escape character +, and "X" characters. The Xs represent the directory number and must appear at the end of the pattern. For example, if you specify a mask of 972813XXXX, an external call from extension 1234 displays a caller ID number of 9728131234.

Line Text Label

Use this field only if you do not want the directory number to show on the line appearance. Enter text that identifies this directory number for a line and phone combination.

Suggested entries include boss name, department name, or other appropriate information to identify multiple directory numbers to a secretary or assistant who monitors multiple directory numbers.

Display (Internal Caller ID)

Leave this field blank to have the system display the extension.

Use a maximum of 30 characters. Typically, use the username or the directory number. If using the directory number, the person receiving the call may not see the proper identity of the caller.

ASCII Display (Caller ID) This field provides the same information as the Display (Internal Caller ID) field, but limit input to ASCII characters. Devices that do not support Unicode (internationalized) characters display the content of the ASCII Display (Internal Caller ID) field.
Ring Setting (Phone Active)

If applicable, the ring setting that is used when this phone has another active call on a different line. Choose one of the following options:

  • Use system default
  • Disable
  • Flash only
  • Ring once
  • Ring
  • Beep only
Field Description
Ring Setting (Phone Idle)

If applicable, the ring setting for the line appearance when an incoming call is received and no other active calls exist on that device. Choose one of the following options:

  • Use system default
  • Disable
  • Flash only
  • Ring once
  • Ring
Recording Option

This field determines the recording option on the line appearance of an agent. The default recording option is Call Recording Disabled.

Choose one of the following options:

  • Call Recording Disabled - Calls made on this line appearance cannot be recorded.
  • Automatic Call Recording Enabled - Calls made on this line appearance are recorded automatically.
  • Selective Call Recording Enabled - Calls made on this line appearance can be recorded using a softkey or programmable line key that is:
    • assigned to the device
    • a CTI-enabled application
    • both interchangeably
Recording Profile This field determines the recording profile on the line appearance of an agent.
Recording Media Source

This field determines the recording media source option on the line appearance.

Choose one of the following options:

  • Gateway Preferred - Voice gateway is selected as the recording media source when the call is routed through a recording enabled gateway.
  • Phone Preferred - Phone is selected as the recording media source.
Monitoring Calling Search Space The monitoring calling search space of the supervisor line appearance must include the agent line or device partition to allow monitoring the agent.
Visual Message Waiting Indicator Policy

Use this field to configure the handset lamp illumination policy. Choose one of the following options:

  • Use System Policy (The directory number refers to the service parameter "Message Waiting Lamp Policy" setting.)
  • Light and Prompt
  • Prompt Only
  • Light Only
  • None
Audible Message Waiting Indicator Policy

Use this field to configure an audible message waiting indicator policy. Choose one of the following options:

  • Off
  • On - When you select this option, you receive a stutter dial tone when you take the handset off hook.
  • Default - When you select this option, the phone uses the default that was set at the system level.
Log Missed Calls If selected, Cisco Unified CM logs missed calls in the call history for the shared line appearance on the phone.
Field Description
Busy Trigger This setting, working with Maximum Number of Calls and Call Forward Busy, determines the maximum call number for the line. Use this field with Maximum Number of Calls for CTI route points. The default specifies 4500 calls
Maximum Number of Calls For CTI route points, you can configure up to 10,000 calls for each port. The default specifies 5000 calls. Use this field with the Busy Trigger field. Note: We recommend that you set the maximum number of calls to no more than 200 per route point. This prevents system performance degradation. If the CTI application needs more than 200 calls, we recommend that you configure multiple CTI route points.
Dialed Number Select to display original dialed number upon call forward.
Redirected Number Select to display the redirected number upon call forward.
Caller Number Select to display the caller number upon call forward.
Caller Name Select to display the caller name upon call forward.
End User, User ID The User ID of a user associated with the line.

This relation wraps the device/cucm/CtiRoutePoint element.

Model Details: relation/HcsCtiRoutePointREL

Title Description Details
Use Device Pool Calling Party Transformation CSS To use the Calling Party Transformation CSS that is configured in the device pool that is assigned to this device, check this check box. If you do not check this check box, the device uses the Calling Party Transformation CSS that you configured in the CTI Route Point Configuration window. Default: True
  • Field Name: useDevicePoolCgpnTransformCss
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Product * Product ID string. read-only except when creating a device.
  • Field Name: product
  • Type: String
  • Cardinality: [1..1]
  • Choices: ["7914 14-Button Line Expansion Module", "7915 12-Button Line Expansion Module", "7915 24-Button Line Expansion Module", "7916 12-Button Line Expansion Module", "7916 24-Button Line Expansion Module", "AIM-VOICE-30", "Analog Phone", "Annunciator", "BEKEM 36-Button Line Expansion Module", "C881V", "C887VA-V", "CKEM 36-Button Line Expansion Module", "CP-8800-Audio 28-Button Key Expansion Module", "CP-8800-Video 28-Button Key Expansion Module", "CTI Port", "CTI Remote Device", "CTI Route Point", "Carrier-integrated Mobile", "Cisco IAD2400", "Cisco 12 S", "Cisco 12 SP", "Cisco 12 SP+", "Cisco 1751", "Cisco 1760", "Cisco 1861", "Cisco 269X", "Cisco 26XX", "Cisco 2801", "Cisco 2811", "Cisco 2821", "Cisco 2851", "Cisco 2901", "Cisco 2911", "Cisco 2921", "Cisco 2951", "Cisco 30 SP+", "Cisco 30 VIP", "Cisco 362X", "Cisco 364X", "Cisco 366X", "Cisco 3725", "Cisco 3745", "Cisco 3825", "Cisco 3845", "Cisco 3905", "Cisco 3911", "Cisco 3925", "Cisco 3925E", "Cisco 3945", "Cisco 3945E", "Cisco 3951", "Cisco 6901", "Cisco 6911", "Cisco 6921", "Cisco 6941", "Cisco 6945", "Cisco 6961", "Cisco 7811", "Cisco 7821", "Cisco 7832", "Cisco 7841", "Cisco 7861", "Cisco 7902", "Cisco 7905", "Cisco 7906", "Cisco 7910", "Cisco 7911", "Cisco 7912", "Cisco 7920", "Cisco 7921", "Cisco 7925", "Cisco 7926", "Cisco 7931", "Cisco 7935", "Cisco 7936", "Cisco 7937", "Cisco 7940", "Cisco 7941", "Cisco 7941G-GE", "Cisco 7942", "Cisco 7945", "Cisco 7960", "Cisco 7961", "Cisco 7961G-GE", "Cisco 7962", "Cisco 7965", "Cisco 7970", "Cisco 7971", "Cisco 7975", "Cisco 7985", "Cisco 860", "Cisco 881", "Cisco 8811", "Cisco 8821", "Cisco 8831", "Cisco 8832", "Cisco 8832NR", "Cisco 8841", "Cisco 8845", "Cisco 8851", "Cisco 8851NR", "Cisco 8861", "Cisco 8865", "Cisco 8865NR", "Cisco 888/887/886", "Cisco 8941", "Cisco 8945", "Cisco 8961", "Cisco 9951", "Cisco 9971", "Cisco ATA 186", "Cisco ATA 187", "Cisco ATA 190", "Cisco ATA 191", "Cisco C8200/L-1N-4T", "Cisco C8300-1N1S-4T2X", "Cisco C8300-1N1S-6T", "Cisco C8300-2N2S-4T2X/6T", "Cisco Catalyst 4000 Access Gateway Module", "Cisco Catalyst 4224 Voice Gateway Switch", "Cisco Catalyst 6000 12 port FXO Gateway", "Cisco Catalyst 6000 24 port FXS Gateway", "Cisco Catalyst 6000 E1 VoIP Gateway", "Cisco Catalyst 6000 T1 VoIP Gateway", "Cisco Cius", "Cisco Cius SP", "Cisco Collaboration Mobile Convergence", "Cisco Conference Bridge (WS-SVC-CMM)", "Cisco Conference Bridge Hardware", "Cisco Conference Bridge Software", "Cisco DX650", "Cisco DX70", "Cisco DX80", "Cisco Dual Mode for Android", "Cisco Dual Mode for iPhone", "Cisco E20", "Cisco ENCS 5400 ISRV", "Cisco IOS Conference Bridge", "Cisco IOS Enhanced Conference Bridge", "Cisco IOS Enhanced Media Termination Point", "Cisco IOS Enhanced Software Media Termination Point", "Cisco IOS Guaranteed Audio Video Conference Bridge", "Cisco IOS Heterogeneous Video Conference Bridge", "Cisco IOS Homogeneous Video Conference Bridge", "Cisco IOS Media Termination Point", "Cisco IP Communicator", "Cisco ISR 4321", "Cisco ISR 4331", "Cisco ISR 4351", "Cisco ISR 4431", "Cisco ISR 4451", "Cisco ISR 4461", "Cisco Jabber for Tablet", "Cisco MGCP BRI Port", "Cisco MGCP E1 Port", "Cisco MGCP FXO Port", "Cisco MGCP FXS Port", "Cisco MGCP T1 Port", "Cisco Media Server (WS-SVC-CMM-MS)", "Cisco Media Termination Point (WS-SVC-CMM)", "Cisco Media Termination Point Hardware", "Cisco Media Termination Point Software", "Cisco Meeting Server", "Cisco SIP FXS Port", "Cisco Spark Remote Device", "Cisco TelePresence", "Cisco TelePresence 1000", "Cisco TelePresence 1100", "Cisco TelePresence 1300-47", "Cisco TelePresence 1300-65", "Cisco TelePresence 200", "Cisco TelePresence 3000", "Cisco TelePresence 3200", "Cisco TelePresence 400", "Cisco TelePresence 500-32", "Cisco TelePresence 500-37", "Cisco TelePresence Codec C40", "Cisco TelePresence Codec C60", "Cisco TelePresence Codec C90", "Cisco TelePresence Conductor", "Cisco TelePresence DX70", "Cisco TelePresence EX60", "Cisco TelePresence EX90", "Cisco TelePresence Exchange System", "Cisco TelePresence IX5000", "Cisco TelePresence MCU", "Cisco TelePresence MX200", "Cisco TelePresence MX200 G2", "Cisco TelePresence MX300", "Cisco TelePresence MX300 G2", "Cisco TelePresence MX700", "Cisco TelePresence MX800", "Cisco TelePresence MX800 Dual", "Cisco TelePresence Profile 42 (C20)", "Cisco TelePresence Profile 42 (C40)", "Cisco TelePresence Profile 42 (C60)", "Cisco TelePresence Profile 52 (C40)", "Cisco TelePresence Profile 52 (C60)", "Cisco TelePresence Profile 52 Dual (C60)", "Cisco TelePresence Profile 65 (C60)", "Cisco TelePresence Profile 65 Dual (C90)", "Cisco TelePresence Quick Set C20", "Cisco TelePresence SX10", "Cisco TelePresence SX20", "Cisco TelePresence SX80", "Cisco TelePresence TX1310-65", "Cisco TelePresence TX9000", "Cisco TelePresence TX9200", "Cisco Unified Client Services Framework", "Cisco Unified Communications for RTX", "Cisco Unified Mobile Communicator", "Cisco Unified Personal Communicator", "Cisco VG200", "Cisco VG248 Gateway", "Cisco VGC Phone", "Cisco VGC Virtual Phone", "Cisco VGD-1T3", "Cisco VXC 6215", "Cisco Video Conference Bridge(IPVC-35xx)", "Cisco Voice Mail Port", "Cisco Webex Board 55", "Cisco Webex Board 70", "Cisco Webex Board 85", "Cisco Webex DX80", "Cisco Webex Desk LE", "Cisco Webex Desk Pro", "Cisco Webex Room 55", "Cisco Webex Room 55 Dual", "Cisco Webex Room 70 Dual", "Cisco Webex Room 70 Dual G2", "Cisco Webex Room 70 Panorama", "Cisco Webex Room 70 Single", "Cisco Webex Room 70 Single G2", "Cisco Webex Room Kit", "Cisco Webex Room Kit Mini", "Cisco Webex Room Kit Plus", "Cisco Webex Room Kit Pro", "Cisco Webex Room Panorama", "Cisco Webex Room Phone", "Cisco Webex VDI Svc Framework", "Communication Media Module", "EMCC Base Phone", "FLEX_SLOT", "Gatekeeper", "Generic Desktop Video Endpoint", "Generic Multiple Screen Room System", "Generic Single Screen Room System", "H.225 Trunk (Gatekeeper Controlled)", "H.323 Client", "H.323 Gateway", "Hunt List", "IAD2400_ANALOG", "IAD2400_DIGITAL", "IMS-integrated Mobile (Basic)", "IP-STE", "ISDN BRI Phone", "Inter-Cluster Trunk (Gatekeeper Controlled)", "Inter-Cluster Trunk (Non-Gatekeeper Controlled)", "Interactive Voice Response", "Load Simulator", "Motorola CN622", "Music On Hold", "NM-1V", "NM-2V", "NM-4VWIC-MBRD", "NM-HD-1V", "NM-HD-2V", "NM-HD-2VE", "NM-HDA", "NM-HDV", "NM-HDV2-0PORT", "NM-HDV2-1PORT", "NM-HDV2-2PORT", "Nokia S60", "PA-MCX", "PA-VXA", "PA-VXB", "PA-VXC", "Pilot", "Remote Destination Profile", "Route List", "SCCP Device", "SCCP gateway virtual phone", "SIP Trunk", "SIP WSM Connection", "SPA8800", "Third-party AS-SIP Endpoint", "Third-party SIP Device (Advanced)", "Third-party SIP Device (Basic)", "Transnova S3", "Universal Device Template", "Unknown", "VG202", "VG204", "VG224", "VG310", "VG320", "VG350", "VG400", "VG420", "VG450", "VGC Port", "VIC_SLOT", "VKEM 36-Button Line Expansion Module", "VNM-HDA", "VWIC_SLOT", "WS-SVC-CMM-MS", "WS-X6600"]
Protocol * Protocol option is read-only,except when creating a device.
  • Field Name: protocol
  • Type: String
  • Cardinality: [1..1]
  • Choices: ["SCCP", "Digital Access PRI", "H.225", "Analog Access", "Digital Access T1", "Route Point", "Unicast Bridge", "Multicast Point", "Inter-Cluster Trunk", "RAS", "Digital Access BRI", "SIP", "MGCP", "Static SIP Mobile Subscriber", "SIP Connector", "Remote Destination", "Mobile Smart Client", "Digital Access E1 R2", "CTI Remote Device", "Protocol Not Specified"]
Device Name * Enter unique identifier for this device, from 1 to 15 characters, including alphanumeric, dot, dash, or underscores.
  • Field Name: name
  • Type: String
  • Cardinality: [1..1]
  • MaxLength: 128
User Hold MOH Audio Source To specify the audio source that plays when an application initiates a hold action, click the drop-down arrow and choose an audio source from the list that displays. If you do not choose an audio source, Cisco Unified Communications Manager uses the audio source that is defined in the device pool or the system default if the device pool does not specify an audio source ID. You define audio sources in the Music On Hold Audio Source Configuration window. For access, choose Media Resources > Music On Hold Audio Source.
  • Field Name: userHoldMohAudioSourceId
  • Type: ["String", "Null", "Integer"]
  • Target: device/cucm/MohAudioSource
  • Target attr: sourceId
  • Cardinality: [0..1]
  • Format: uri
  • Choices: ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "33", "34", "35", "36", "37", "38", "39", "40", "41", "42", "43", "44", "45", "46", "47", "48", "49", "50", "null", ""]
Lines
  • Field Name: lines
  • Type: ["Null", "Object"]
  • Cardinality: [0..1]
Line An XLine is an entry in the DeviceNumPlanMap table. The actual directory number is referenced inside the XLine object by the "dirn" or "dirnId" element.
  • Field Name: line.[n]
  • Type: Array
Display Ascii
  • Field Name: lines.line.[n].displayAscii
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
Associated Endusers
  • Field Name: associatedEndusers
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Enduser
  • Field Name: enduser.[n]
  • Type: Array
User Id *
  • Field Name: lines.line.[n].associatedEndusers.enduser.[n].userId
  • Type: ["String", "Null"]
  • Target: device/cucm/User
  • Target attr: userid
  • Cardinality: [1..1]
  • Format: uri
Ring Setting Default: Ring
  • Field Name: lines.line.[n].ringSetting
  • Type: String
  • Cardinality: [0..1]
  • Default: Ring
  • Choices: ["Use System Default", "Disable", "Flash Only", "Ring Once", "Ring", "Beep Only"]
Consecutive Ring Setting Consecutive Rings Setting. Replaces the consective ring setting on IPPhone. Default: Use System Default
  • Field Name: lines.line.[n].consecutiveRingSetting
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • Default: Use System Default
  • Choices: ["Use System Default", "Disable", "Flash Only", "Ring Once", "Ring", "Beep Only"]
Recording Profile Name
  • Field Name: lines.line.[n].recordingProfileName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Index
  • Field Name: lines.line.[n].index
  • Type: Integer
  • Cardinality: [1..1]
Ring Setting Active Pickup Alert Applicable only for IP Phones Default: Use System Default
  • Field Name: lines.line.[n].ringSettingActivePickupAlert
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • Default: Use System Default
  • Choices: ["Use System Default", "Disable", "Flash Only", "Ring Once", "Ring", "Beep Only"]
Label
  • Field Name: lines.line.[n].label
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
Recording Media Source Default: Gateway Preferred
  • Field Name: lines.line.[n].recordingMediaSource
  • Type: String
  • Cardinality: [0..1]
  • Default: Gateway Preferred
  • Choices: ["Gateway Preferred", "Phone Preferred"]
Max Num Calls Default: 2
  • Field Name: lines.line.[n].maxNumCalls
  • Type: Integer
  • Cardinality: [0..1]
  • Default: 2
Partition Usage This tag cannot be modified. It can only be specified in the add request. Default: General
  • Field Name: lines.line.[n].partitionUsage
  • Type: String
  • Cardinality: [0..1]
  • Default: General
  • Choices: ["Intercom", "Call Control Discovery Learned Pattern", "General", "Directory URI"]
Recording Flag Default: Call Recording Disabled
  • Field Name: lines.line.[n].recordingFlag
  • Type: String
  • Cardinality: [0..1]
  • Default: Call Recording Disabled
  • Choices: ["Call Recording Disabled", "Automatic Call Recording Enabled", "Selective Call Recording Enabled"]
Speed Dial
  • Field Name: lines.line.[n].speedDial
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Monitoring Css Name
  • Field Name: lines.line.[n].monitoringCssName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
E164Mask
  • Field Name: lines.line.[n].e164Mask
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 255
Missed Call Logging Default: True
  • Field Name: lines.line.[n].missedCallLogging
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Call Info Display
  • Field Name: callInfoDisplay
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Dialed Number Default: True
  • Field Name: lines.line.[n].callInfoDisplay.dialedNumber
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Redirected Number
  • Field Name: lines.line.[n].callInfoDisplay.redirectedNumber
  • Type: Boolean
  • Cardinality: [0..1]
Caller Number
  • Field Name: lines.line.[n].callInfoDisplay.callerNumber
  • Type: Boolean
  • Cardinality: [0..1]
Caller Name Default: True
  • Field Name: lines.line.[n].callInfoDisplay.callerName
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Dirn Only uuid attribute is returned in response
  • Field Name: dirn
  • Type: ["Object", "Null"]
  • Cardinality: [1..1]
Pattern *
  • Field Name: lines.line.[n].dirn.pattern
  • Type: String
  • Cardinality: [1..1]
Route Partition Name *
  • Field Name: lines.line.[n].dirn.routePartitionName
  • Type: ["String", "Null"]
  • Target: device/cucm/RoutePartition
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Mwl Policy Default: Use System Policy
  • Field Name: lines.line.[n].mwlPolicy
  • Type: String
  • Cardinality: [0..1]
  • Default: Use System Policy
  • Choices: ["Use System Policy", "Light and Prompt", "Prompt Only", "Light Only", "None"]
Ring Setting Idle Pickup Alert Applicable only for IP Phones Default: Use System Default
  • Field Name: lines.line.[n].ringSettingIdlePickupAlert
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • Default: Use System Default
  • Choices: ["Use System Default", "Disable", "Flash Only", "Ring Once", "Ring", "Beep Only"]
Busy Trigger Default: 1
  • Field Name: lines.line.[n].busyTrigger
  • Type: Integer
  • Cardinality: [0..1]
  • Default: 1
Audible Mwi Not applicable for gatewayEndpointAnalogAccess and CiscoCatalyst600024PortFXSGateway Default: Default
  • Field Name: lines.line.[n].audibleMwi
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Display
  • Field Name: lines.line.[n].display
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
Protocol Side * Side information is read-only except when creating a device Default: User
  • Field Name: protocolSide
  • Type: String
  • Cardinality: [1..1]
  • Default: User
  • Choices: ["Network", "User"]
Use Trusted Relay Point * From the drop-down list box, enable or disable whether Cisco Unified Communications Manager inserts a trusted relay point (TRP) device with this media endpoint. Choose one of the following values: Default—If you choose this value, the device uses the Use Trusted Relay Point setting from the common device configuration with which this device associates. Off—Choose this value to disable the use of a TRP with this device. This setting overrides the Use Trusted Relay Point setting in the common device configuration with which this device associates. On—Choose this value to enable the use of a TRP with this device. This setting overrides the Use Trusted Relay Point setting in the common device configuration with which this device associates. A Trusted Relay Point (TRP) device designates an MTP or transcoder device that is labeled as Trusted Relay Point. Cisco Unified Communications Manager places the TRP closest to the associated endpoint device if more than one resource is needed for the endpoint (for example, a transcoder or RSVPAgent). If both TRP and MTP are required for the endpoint, TRP gets used as the required MTP. See the Cisco Unified Communications Manager System Guide for details of call behavior. If both TRP and RSVPAgent are needed for the endpoint, Cisco Unified Communications Manager first tries to find an RSVPAgent that can also be used as a TRP. If both TRP and transcoder are needed for the endpoint, Cisco Unified Communications Manager first tries to find a transcoder that is also designated as a TRP. See the Cisco Unified Communications Manager System Guide for a complete discussion of network virtualization and trusted relay points. Default: Default
  • Field Name: useTrustedRelayPoint
  • Type: String
  • Cardinality: [1..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Network Hold MOH Audio Source To specify the audio source that plays when the network initiates a hold action, click the drop-down arrow and choose an audio source from the list that displays. If you do not choose an audio source, Cisco Unified Communications Manager uses the audio source that is defined in the device pool or the system default if the device pool does not specify an audio source ID. You define audio sources in the Music On Hold Audio Source Configuration window. For access, choose Media Resources > Music On Hold Audio Source.
  • Field Name: networkHoldMohAudioSourceId
  • Type: ["String", "Null", "Integer"]
  • Target: device/cucm/MohAudioSource
  • Target attr: sourceId
  • Cardinality: [0..1]
  • Format: uri
  • Choices: ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "33", "34", "35", "36", "37", "38", "39", "40", "41", "42", "43", "44", "45", "46", "47", "48", "49", "50", "null", ""]
User Locale From the drop-down list box, choose the locale that is associated with the CTI route point. The user locale identifies a set of detailed information to support users, including language and font. Cisco Unified Communications Manager makes this field available only for CTI route points that support localization. Note    If no user locale is specified, Cisco Unified Communications Manager uses the user locale that is associated with the device pool. Note    If the users require that information be displayed (on the phone) in any language other than English, verify that the locale installer is installed before configuring user locale. See the Cisco Unified Communications Manager locale installer that is in the Cisco Unified Communications Operating System Administration Guide.
  • Field Name: userLocale
  • Type: ["String", "Null"]
  • Target: device/cucm/UserLocale
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
  • Choices: ["English United States"]
Calling Search Space From the drop-down list box, choose a calling search space. The calling search space specifies the collection of partitions that are searched to determine how a collected (originating) number should be routed. You can configure the number of calling search spaces that display in this drop-down list box by using the Max List Box Items enterprise parameter. If more calling search spaces exist than the Max List Box Items enterprise parameter specifies, the Find button displays next to the drop-down list box. Click the Find button to display the Find and List Calling Search Space window, then find and choose a calling search space name. Note    To set the maximum list box items, choose System > Enterprise Parameters and choose CCMAdmin Parameters.
  • Field Name: callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Location * Use locations to implement call admission control (CAC) in a centralized call-processing system. CAC enables you to regulate audio quality and video availability by limiting the amount of bandwidth that is available for audio and video calls over links between locations. The location specifies the total bandwidth that is available for calls to and from this location. From the drop-down list box, choose the appropriate location for this CTI route point. A location setting of Hub_None means that the locations feature does not keep track of the bandwidth that this CTI route point consumes. A location setting of Phantom specifies a location that enables successful CAC across intercluster trunks that use H.323 protocol or SIP. To configure a new location, use the System > Location menu option. For an explanation of location-based CAC across intercluster trunks, see the Cisco Unified Communications Manager System Guide.
  • Field Name: locationName
  • Type: String
  • Target: device/cucm/Location
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Calling Party Transformation CSS This setting allows you to localize the calling party number on the device. Make sure that the Calling Party Transformation CSS that you choose contains the calling party transformation pattern that you want to assign to this device. Tip    Before the call occurs, the device must apply the transformation by using digit analysis. If you configure the Calling Party Transformation CSS as None, the transformation does not match and does not get applied. Ensure that you configure the Calling Party Transformation Pattern in a non-null partition that is not used for routing.
  • Field Name: cgpnTransformationCssName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Common Device Configuration Choose the common device configuration to which you want this CTI route point assigned. The common device configuration includes the attributes (services or features) that are associated with a particular user. Configure common device configurations in the Common Device Configuration window.
  • Field Name: commonDeviceConfigName
  • Type: ["String", "Null"]
  • Target: device/cucm/CommonDeviceConfig
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Device Pool * Choose the name of a Device Pool. The device pool specifies the collection of properties for this device, including Cisco Unified Communications Manager Group, Date/Time Group, Region, and Calling Search Space for auto-registration.
  • Field Name: devicePoolName
  • Type: ["String", "Null"]
  • Target: device/cucm/DevicePool
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Media Resource Group List Choose the appropriate Media Resource Group List. A Media Resource Group List comprises a prioritized grouping of media resource groups. An application chooses the required media resource, such as a Music On Hold server, from the available media resources according to the priority order that is defined in a Media Resource Group List. If you choose <none>, Cisco Unified Communications Manager uses the Media Resource Group that is defined in the device pool. For more information, see topics related to media resource management in the Cisco Unified Communications Manager System Guide.
  • Field Name: mediaResourceListName
  • Type: ["String", "Null"]
  • Target: device/cucm/MediaResourceList
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Geolocation From the drop-down list box, choose a geolocation. You can choose the Unspecified geolocation, which designates that this device does not associate with a geolocation. You can also choose a geolocation that has been configured with the System > Geolocation Configuration menu option. For an explanation of geolocations, including configuration details, see the Cisco Unified Communications Manager Features and Services Guide. For an overview and details of how logical partitioning uses geolocations, see the Cisco Unified Communications Manager Features and Services Guide.
  • Field Name: geoLocationName
  • Type: ["String", "Null"]
  • Target: device/cucm/GeoLocation
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Class * Class ID string. Class information is read-only except when creating a device.
  • Field Name: class
  • Type: String
  • Cardinality: [1..1]
  • Choices: ["Phone", "Gateway", "Conference Bridge", "Media Termination Point", "Route List", "Voice Mail", "CTI Route Point", "Music On Hold", "Simulation", "Pilot", "GateKeeper", "Add-on modules", "Hidden Phone", "Trunk", "Tone Announcement Player", "Remote Destination Profile", "EMCC Base Phone Template", "EMCC Base Phone", "Remote Destination Profile Template", "Gateway Template", "UDP Template", "Phone Template", "Device Profile", "Invalid", "Interactive Voice Response"]
Description Enter a descriptive name for the CTI route point. The description can include up to 50 characters in any language, but it cannot include double-quotes ("), percentage sign (%), ampersand (&), back-slash (\), or angle brackets (<>).
  • Field Name: description
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
Shadow
  • Field Name: shadow.[n]
  • Type: Array
  • Cardinality: [0..1]
Name *
  • Field Name: shadow.[n].name
  • Type: String
  • MaxLength: 1024