[Index]

Model: relation/HcsAnalogGatewayREL

Analog Gateways

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

Pre-requisites

Note

VOSS Automate supports SCCP and MGCP protocols. It does not support BRI endpoints. Do not add slots or modules or subunits for BRI.

Perform these steps:

  1. Log in as provider, reseller, or customer administrator.

  2. Choose Apps Management > IOS > Analog Gateways.

  3. Click Add.

  4. Choose the required hierarchy path from the drop-down and click OK.

  5. On the Gateway tab, complete, at minimum, the mandatory Gateway Fields.

  6. On the Gateway Units tab, click + to expand Modules, and complete, at minimum, the mandatory Gateway Units - Modules Fields.

  7. On the Endpoints tab, click + to expand the SCCP or MGSP endpoints, and complete, at minimum, the mandatory:

    Note

    Gateway endpoints will be shown in the following order on the Endpoints tab of the form:

    Slot > Subunit > Port Number, for example:

    0-0-0
    0-0-1
    2-0-0
    2-0-1
    2-0-2
    
  8. On the Config tab, click + to expand the Product Specific Configuration Layout, and complete the required Config: Product Specific Configuration Layout Fields.

  9. Click Save.

There are few scenarios that show the expected behavior of an Analog gateway when adding, deleting, or modifying a gateway.

Successful Scenario Failure Scenario
Adding an Analog device with a phone line. Removing the phone line from the endpoint.
Adding an Analog gateway without using enable command builder. Adding a phone line after adding the command builder.
Removing the command builder after adding an analog gateway with command builder.

Adding an analog gateway without a phone line after adding a phone line to an endpoint.

Note: Ensure to add the Directory Names to both endpoints.

Gateway Fields

Field Description
IOS Device *

Choose the required IOS Device from the drop-down list. For example: IOS 11. This is a mandatory field. Note:

The IOS device identifies the devices that are not associated with any Analog Gateways.

Product *

Choose the product from the drop-down list. For example: VG202, where VG represents Voice Gateway and 202 represents port. It has 2 ports, 0 and 1. This is a mandatory field. Note:

The analog gateway supports the following models (FXS ports):

  • VG202: 2 ports
  • VG204: 4 ports
  • VG224: 24 ports
  • VG310: 24 ports
  • VG320: 48 ports
  • VG350: 144/160 ports
  • VG400: 8 ports max
  • VG450: 144 ports max
Protocol * Choose the protocol from the drop-down list. The available protocols are SCCP and MGCP. This is a mandatory field.
Gateway Name * Enter the MAC address of the analog gateway. For example: SKIGW0102030405, where SKI represents SCCP, GW represents gateway, and the last 10 digits represents the MAC address of the gateway. This is a mandatory field for the SCCP protocol.
Domain Name Enter a fully qualified domain name. For example: E7C1VG310.hcsent17.com. This is a mandatory field for the MGCP protocol.
Call Manager Group *

Choose the call manager group from the drop-down list. For example: Default. This is a mandatory field.

Note:

Call Manager Group is default based on the site default device pool.

Enable Command Builder Leave the check box clear to generate IOS commands, when Analog Gateway is added, deleted, or modified.

Note

For more information,see Local Break Out and Analog Gateway Events, IOS Commands, and Variables. To view generated commands from Command Builder, see View IOS Commands Log.

Field Description
Gateway Network Interface *

Enter a Gateway Network Interface. For example: FastEthernet0/0, FastEthernet0/1, GigabitEthernet0/0, GigabitEthernet0/1 or **GigabitEthernet0/2. This is a mandatory field.

Note:

Check the network interface at the Physical Device, then choose the appropriate Network Interface and Port as applicable. The Network Interface is used in Command Generation.

Choose FastEthernet for all 2x series and GigabitEthernet for all 3x series.

Call Disconnect Timeout *

Enter the time unit for Call Disconnect Timeout. For example: 2. This is a mandatory field.

Note:

The time unit always is in seconds. Do not enter any negative timer values.

CP Tone *

Choose the call progress tone (country code) from the drop-down list. For example: in (for India). This is a mandatory field.

Note:

CP Tone is an FXS configuration parameter that supports each analog device in the gateway.

Signal *

Choose a signal from the drop-down list. For example: loop-start or ground-start. This is a mandatory field.

Note:

Signal is an FXS configuration parameter that supports each analog device in the gateway.

Gateway Units - Modules Fields

Field Description
Slot *

Choose the required value from the drop-down list. For example: 0. This is a mandatory field

Note:

  • Add only those Units (Modules) and Subunits that are listed in the drop-down list, without duplicate the units and subunit numbers.
  • If duplicating entry is made for a slot, then the new slot overwrites the older configuration. You may lose previously configured endpoints.
  • For VG310 model, do not choose any module for slot 1.
Module *

Choose the available module from the drop-down list. For example: NM-4VWIC-MBRD.

Note:

Only modules that are available for the slot appear in the list.

Subunits * Click + to expand Subunits. This is a mandatory field.
Subunit Position *

Choose the subunit position from the drop-down list. For example: 0.

Note:

Subunit position 1 on the VG310 gateway has no available hardware by design, so choosing a value of 1 in this drop-down will not allow you to continue. Please choose a different subunit position to continue setting up your gateway.

Subunit * Choose the subunit from the drop-down list. For example: VIC3-2FXS-E/DID-SCCP.

Note

When managing Gateways Units for Analog Gateways on the on the Legacy Admin GUI, the Slot number and Subunit Position may disappear from the form, but values are captured.

SCCP Endpoints Fields

Field Description
Gateway Name GUI read-only field is populated from the analog gateway for the SCCP protocol. This is a mandatory field.
Slot * GUI read-only field is populated from the gateway units. This is a mandatory field.
Subunit Position * GUI read-only field is populated from the gateway units. This is a mandatory field.
Port Number * GUI read-only field is populated from the gateway units. This is a mandatory field.
Product Type * Choose the product type from the drop-down list. For example: Analog Phone. This is a mandatory field.
Device Protocol * Choose the device protocol from the drop-down list. This is a mandatory field.
Device Name * GUI read-only field is populated from the analog gateway. This is a mandatory field.
Description When the endpoint is added, the default description is in the format: Endpoint for slot/subunit/port n/n/n gateway @domain that can be updated if required. This is an optional field and accepts a string value.
Device Pool * Choose the device pool from the drop-down list. For example: Cu2Si2-DevicePool. This is a mandatory field.
Phone Button Template * Choose the phone button template from the drop-down list. For example: Standard Analog. This has a specific phone button template for the analog gateway. This is a mandatory field.
Common Phone Profile * Choose the common phone profile from the drop-down list. For example: Standard Common Phone Profile. It includes the attributes (services or features) that are associated with a particular user. This is a mandatory field.
Calling Search Space From the drop-down list, choose the appropriate calling search space. The calling search space specifies a collection of partitions that are searched to determine how a collected (originating) number should be routed.
AAR Calling Search Space Choose the appropriate calling search space for the device to use when it performs automated alternate routing (AAR). The AAR calling search space specifies the collection of route partitions that are searched to determine how to route a collected (originating) number that is otherwise blocked due to insufficient bandwidth.
Media Resource Group List This list provides a prioritized grouping of media resource groups. An application chooses the required media resource, such as a Music On Hold server, from among the available media resources according to the priority order that a Media Resource Group List defines.
Location * Choose a location from the drop-down list. For example: Cu2Si2-Location. This is a mandatory field.
AAR Group Specify the automated alternate routing (AAR) group for this device. The AAR group provides the prefix digits that are used to route calls that are otherwise blocked due to insufficient bandwidth.
Owner Choose from the drop-down list.
Field Description
Always Use Prime Line for Voice Message * Choose the required options from the drop-down list. For example: On, Off or Default. This is a mandatory field. This specifies whether the device will always use the prime line for voice messages.
Geolocation From the drop-down list, choose a geolocation. You can choose the Unspecified geolocation, which designates that this device does not associate with a geolocation.
Transmit UTF-8 for Calling Party Name Keep the check box clear.
Called Party Transformation CSS

This setting allows you to send transformed called party number in SETUP message for outgoing calls. Make sure that the Called Party Transformation CSS that you choose contains the called party transformation pattern that you want to assign to this device.

Note:

If the Called Party Transformation CSS is configured as <None>, the transformation does not match and does not get applied. Ensure that you configure the Called Party Transformation CSS in a non-null partition that is not used for routing.

Use Device Pool Called Party Transformation CSS Select the check box.
Allow Control Of Device From CTI Select the check box.
Logged Into Hunt Group Select the check box.
Calling Party Transformation CSS (Caller ID For Calls From This Phone)

This setting allows you to send transformed calling party number in SETUP message for outgoing calls. Also when redirection occurs for outbound calls, this CSS will be used to transform the connected number sent from Cisco Unified Communications Manager side in outgoing NOTIFY messages. 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.

Note:

If the Calling Party Transformation CSS is configured 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.

Use Device Pool Calling Party Transformation CSS (Caller ID for Calls From This Phone) Select the check box.
Calling Party Transformation CSS (Device Mobility Related Information)  
Use Device Pool Calling Party Transformation CSS (Device Mobility Related Information) Select the check box.
Field Description
BLF Presence Group * Choose the presence group for busy lamp field buttons from the drop-down list. For example: Standard Presence group is the default value. This is a mandatory field.
Device Security Profile * Choose options from the drop-down list. For example: Analog Phone - Standard SCCP Non-Secure Profile. This is mandatory field.
MLPP Domain

If you leave the value <None>, this device inherits its MLPP domain from the value that was set for the device pool of this device.

If the device pool does not have an MLPP Domain setting, this device inherits its MLPP domain from the value that was set for the MLPP Domain Identifier enterprise parameter.

MLPP Indication Choose options from the drop-down list. For example: On, Off, or Default. This is a mandatory field.
MLPP Preemption

Choose options from the drop-down list. For example: Disabled, Forceful, or Default. This is a mandatory field.

Note:

If there are any changes to be performed to analog phone line then do not refer line settings. For example: Changing CSS is done under Subscriber Management.

Line Click + to expand Line.
Pattern * Choose the route pattern from the drop-down list. For example: 08231006
Enduser Click + to expand Enduser.
User ID Choose the available user ID from the drop-down list. For example: Subscriber 1
Product Specific Configuration Layout Click + to expand Product Specific Configuration Layout.
Key Enter the Key for the product specific configuration layout. For example: stcappRegCap.
Value Enter the Value for the product specific configuration layout. For example: 0.

Note

For more optional field information, see Configure Phones.

MGCP Endpoints Fields

You can configure multiple endpoints for an MGCP gateway.

Option Description
Domain Name GUI read-only field is populated from the analog gateway for the MGCP protocol. This is a mandatory field.
Slot * GUI read-only field is populated from the gateway units. This is a mandatory field.
Subunit Position * GUI read-only field is populated from the gateway units. This is a mandatory field.
Port Number * GUI read-only field is populated from the gateway units. This is a mandatory field.
Product Type * Choose the product type from the drop down list. For example: Analog Phone. This is a mandatory field.
Device Protocol * Choose the device protocol from the drop-down list. For example: SCCP. This is a mandatory field.
Protocol Side * This is a read-only field except when creating a device. This is a mandatory field.
Class * This is a read-only field except when creating a device. This is a mandatory field.
Device Name * GUI read-only field is populated from the analog gateway. This is a mandatory field.
Description When the endpoint is added, the default description is in the format: Endpoint for slot/subunit/port n/n/n gateway @domain that can be updated if required. This is an optional field and accepts a string value.
Device Pool Choose the device pool from the drop-down list. For example: Cu2Si2-DevicePool. This is a mandatory field.
Calling Search Space Choose the calling search space name from the drop-down list. This is an optional field.
Common Device Configuration Specify the Configuration name of the device. This is an optional field.
Network Locale Choose the location from the drop-down list. This is an optional field.
Location * Choose a location from the drop-down list. For example: Cu2Si2-Location. This is a mandatory field.
Media Resource Group List Enter a media resource to allocate for a device. This is an optional field.
AAR calling search space Choose the appropriate calling search space for the device to use when it performs automated alternate routing (AAR) from the drop-down list. This is an optional field.
Field Description
User Trusted Relay Point

Choose one of the following values:

  • Off - Choose this value to disable the use of a Trusted Relay Point (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.
  • 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.
AAR Group Specify the automated alternate routing (AAR) group for this device. The AAR group provides the prefix digits that are used to route calls that are otherwise blocked due to insufficient bandwidth.
Geolocation Specify the location name. This is an optional field.
Transmit UTF-8 for Calling Party Name Keep the check box clear.
Port Number * Configure the ports for the MGCP Endpoint. This is a mandatory field.
Trunk * This field value auto-populates depending on the value set for the Port Number. This is a mandatory field.
Trunk Direction * The field value auto-populates depending on the value set for the Number. This is a mandatory field.
Trunk Level * The field value auto-populates depending on the value set for the Number. This is a mandatory field.
Attendant DN Specify this field for group start and loop start. This is a mandatory field.
Prefix DN Enter the prefix digits that are appended to the digits that this trunk receives on incoming calls.
Num Digits * Enter the number of significant digits to collect between 0 to 32.
Expected Digits * Enter the number of digits that are expected on the inbound side of the trunk. You can leave zero as the default value, if you are unsure.
Field Description
SMDI Port Number (0 - 4096) *

Enter the first SMDI port number of the T1 span.

If you set this parameter to a nonxero value and this gateway belongs to an unknown type of route list, route group, or route list, hunting does not continue beyond this span.

Unattended Port Select this check box to indicate an unattended port on this device.
Line Click + to expand Line.
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.
E164 Mask

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

You can enter a maximum of 24 numbers, 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.

Dirn, Pattern * Choose the route pattern from the drop-down list. For example: 08231006.
Dirn, 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.
Enduser Click + to expand Enduser.
User ID Choose the available user ID from drop-down list. For example: Subscriber 1.
Index This field is the line position on the device. If left blank, an integer is automatically assigned.
Trunk Selection Order * Choose the order from the drop-down list to display the call routing logic for the route pattern.

Config: Product Specific Configuration Layout Fields

Field Description
Key Enter the Key for the product-specific configuration Layout. For example stcappRegCap.
Value Enter the Key for the product-specific configuration layout. For example: 0.

Analog Gateways

Full HTML Help

Pre-requisites

Note

VOSS Automate supports SCCP and MGCP protocols. It does not support BRI endpoints. Do not add slots or modules or subunits for BRI.

Perform these steps:

  1. Log in as provider, reseller, or customer administrator.

  2. Choose Apps Management > IOS > Analog Gateways.

  3. Click Add.

  4. Choose the required hierarchy path from the drop-down and click OK.

  5. On the Gateway tab, complete, at minimum, the mandatory Gateway Fields.

  6. On the Gateway Units tab, click + to expand Modules, and complete, at minimum, the mandatory Gateway Units - Modules Fields.

  7. On the Endpoints tab, click + to expand the SCCP or MGSP endpoints, and complete, at minimum, the mandatory:

    Note

    Gateway endpoints will be shown in the following order on the Endpoints tab of the form:

    Slot > Subunit > Port Number, for example:

    0-0-0
    0-0-1
    2-0-0
    2-0-1
    2-0-2
    
  8. On the Config tab, click + to expand the Product Specific Configuration Layout, and complete the required Config: Product Specific Configuration Layout Fields.

  9. Click Save.

There are few scenarios that show the expected behaviour of an Analog gateway when adding, deleting, or modifying a gateway.

Successful Scenario Failure Scenario
Adding an Analog device with a phone line. Removing the phone line from the endpoint.
Adding an Analog gateway without using enable command builder. Adding a phone line after adding the command builder.
Removing the command builder after adding an analog gateway with command builder.

Adding an analog gateway without a phone line after adding a phone line to an endpoint.

Note: Ensure to add the Directory Names to both endpoints.

Gateway Fields

Field Description
IOS Device *

Choose the required IOS Device from the drop-down list. For example: IOS 11. This is a mandatory field. Note:

The IOS device identifies the devices that are not associated with any Analog Gateways.

Product *

Choose the product from the drop-down list. For example: VG202, where VG represents Voice Gateway and 202 represents port. It has 2 ports, 0 and 1. This is a mandatory field. Note:

The analog gateway supports the following models (FXS ports):

  • VG202: 2 ports
  • VG204: 4 ports
  • VG224: 24 ports
  • VG310: 24 ports
  • VG320: 48 ports
  • VG350: 144/160 ports
  • VG400: 8 ports max
  • VG420: 144 ports max
  • VG450: 144 ports max
Protocol * Choose the protocol from the drop-down list. The available protocols are SCCP and MGCP. This is a mandatory field.
Gateway Name * Enter the MAC address of the analog gateway. For example: SKIGW0102030405, where SKI represents SCCP, GW represents gateway, and the last 10 digits represents the MAC address of the gateway. This is a mandatory field for the SCCP protocol.
Domain Name Enter a fully qualified domain name. For example: E7C1VG310.hcsent17.com. This is a mandatory field for the MGCP protocol.
Call Manager Group *

Choose the call manager group from the drop-down list. For example: Default. This is a mandatory field.

Note:

Call Manager Group is default based on the site default device pool.

Enable Command Builder Leave the check box clear to generate IOS commands, when Analog Gateway is added, deleted, or modified.

Note

To view generated commands from Command Builder, see View IOS Commands Log.

Field Description
Gateway Network Interface *

Enter a Gateway Network Interface. For example: FastEthernet0/0, FastEthernet0/1, GigabitEthernet0/0, GigabitEthernet0/1 or **GigabitEthernet0/2. This is a mandatory field.

Note:

Check the network interface at the Physical Device, then choose the appropriate Network Interface and Port as applicable. The Network Interface is used in Command Generation.

Choose FastEthernet for all 2x series and GigabitEthernet for all 3x series.

Call Disconnect Timeout *

Enter the time unit for Call Disconnect Timeout. For example: 2. This is a mandatory field.

Note:

The time unit always is in seconds. Do not enter any negative timer values.

CP Tone *

Choose the call progress tone (country code) from the drop-down list. For example: in (for India). This is a mandatory field.

Note:

CP Tone is an FXS configuration parameter that supports each analog device in the gateway.

Signal *

Choose a signal from the drop-down list. For example: loop-start or ground-start. This is a mandatory field.

Note:

Signal is an FXS configuration parameter that supports each analog device in the gateway.

Gateway Units - Modules Fields

Field Description
Slot *

Choose the required value from the drop-down list. For example: 0. This is a mandatory field

Note:

  • Add only those Units (Modules) and Subunits that are listed in the drop-down list, without duplicate the units and subunit numbers.
  • If duplicating entry is made for a slot, then the new slot overwrites the older configuration. You may lose previously configured endpoints.
  • For VG310 model, do not choose any module for slot 1.
Module *

Choose the available module from the drop-down list. For example: NM-4VWIC-MBRD.

Note:

Only modules that are available for the slot appear in the list.

Subunits * Click + to expand Subunits. This is a mandatory field.
Subunit Position *

Choose the subunit position from the drop-down list. For example: 0.

Note:

Subunit position 1 on the VG310 gateway has no available hardware by design, so choosing a value of 1 in this drop-down will not allow you to continue. Please choose a different subunit position to continue setting up your gateway.

Subunit * Choose the subunit from the drop-down list. For example: VIC3-2FXS-E/DID-SCCP.

SCCP Endpoints Fields

Option Description
Gateway Name GUI read-only field is populated from the analog gateway for the SCCP protocol. This is a mandatory field.
Slot * GUI read-only field is populated from the gateway units. This is a mandatory field.
Subunit Position * GUI read-only field is populated from the gateway units. This is a mandatory field.
Port Number * GUI read-only field is populated from the gateway units. This is a mandatory field.
Product Type * Choose the product type from the drop-down list. For example: Analog Phone. This is a mandatory field.
Device Protocol * Choose the device protocol from the drop-down list. This is a mandatory field.
Device Name * GUI read-only field is populated from the analog gateway. This is a mandatory field.
Description When the endpoint is added, the default description is in the format: Endpoint for slot/subunit/port n/n/n gateway @domain that can be updated if required. This is an optional field and accepts a string value.
Device Pool * Choose the device pool from the drop-down list. For example: Cu2Si2-DevicePool. This is a mandatory field.
Phone Button Template * Choose the phone button template from the drop-down list. For example: Standard Analog. This has a specific phone button template for the analog gateway. This is a mandatory field.
Common Phone Profile * Choose the common phone profile from the drop-down list. For example: Standard Common Phone Profile. It includes the attributes (services or features) that are associated with a particular user. This is a mandatory field.
Calling Search Space From the drop-down list, choose the appropriate calling search space. The calling search space specifies a collection of partitions that are searched to determine how a collected (originating) number should be routed.
AAR Calling Search Space Choose the appropriate calling search space for the device to use when it performs automated alternate routing (AAR). The AAR calling search space specifies the collection of route partitions that are searched to determine how to route a collected (originating) number that is otherwise blocked due to insufficient bandwidth.
Media Resource Group List This list provides a prioritized grouping of media resource groups. An application chooses the required media resource, such as a Music On Hold server, from among the available media resources according to the priority order that a Media Resource Group List defines.
Location * Choose a location from the drop-down list. For example: Cu2Si2-Location. This is a mandatory field.
AAR Group Specify the automated alternate routing (AAR) group for this device. The AAR group provides the prefix digits that are used to route calls that are otherwise blocked due to insufficient bandwidth.
Owner Choose from the drop-down list.
Option Description
Always Use Prime Line for Voice Message Choose the required options from the drop-down list. For example: On, Off or Default. This is a mandatory field. This specifies whether the device will always use the prime line for voice messages.
Geolocation From the drop-down list, choose a geolocation. You can choose the Unspecified geolocation, which designates that this device does not associate with a geolocation.
Transmit UTF-8 for Calling Party Name Keep the check box clear.
Called Party Transformation CSS

This setting allows you to send transformed called party number in SETUP message for outgoing calls. Make sure that the Called Party Transformation CSS that you choose contains the called party transformation pattern that you want to assign to this device.

Note:

If the Called Party Transformation CSS is configured as <None>, the transformation does not match and does not get applied. Ensure that you configure the Called Party Transformation CSS in a non-null partition that is not used for routing.

Use Device Pool Called Party Transformation CSS Select the check box.
Allow Control Of Device From CTI Select the check box.
Logged Into Hunt Group Select the check box.
Calling Party Transformation CSS (Caller ID For Calls From This Phone)

This setting allows you to send transformed calling party number in SETUP message for outgoing calls. Also when redirection occurs for outbound calls, this CSS will be used to transform the connected number sent from Cisco Unified Communications Manager side in outgoing NOTIFY messages. 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.

Note:

If the Calling Party Transformation CSS is configured 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.

Use Device Pool Calling Party Transformation CSS (Caller ID for Calls From This Phone) Select the check box.
Calling Party Transformation CSS (Device Mobility Related Information)  
Field Description
Use Device Pool Calling Party Transformation CSS (Device Mobility Related Information) Select the check box.
BLF Presence Group * Choose the presence group for busy lamp field buttons from the drop-down list. For example: Standard Presence group is the default value. This is a mandatory field.
Device Security Profile * Choose options from the drop-down list. For example: Analog Phone - Standard SCCP Non-Secure Profile. This is mandatory field.
MLPP Domain

If you leave the value <None>, this device inherits its MLPP domain from the value that was set for the device pool of this device.

If the device pool does not have an MLPP Domain setting, this device inherits its MLPP domain from the value that was set for the MLPP Domain Identifier enterprise parameter.

MLPP Indication Choose options from the drop-down list. For example: On, Off, or Default. This is a mandatory field.
MLPP Preemption

Choose options from the drop-down list. For example: Disabled, Forceful, Default. This is a mandatory field.

Note:

If there are any changes to be performed to analog phone line then do not refer line settings. For example: Changing CSS is done under Subscriber Management.

Line Click + to expand Line.
Pattern * Choose the route pattern from the drop-down list. For example: 08231006
Enduser Click + to expand Enduser.
User ID Choose the available user ID from the drop-down list. For example: Subscriber 1
Product Specific Configuration Layout Click + to expand Product Specific Configuration Layout.
Key Enter the Key for the product specific configuration layout. For example: stcappRegCap.
Value Enter the Key for the product specific configuration layout. For example: 0.

Note

For more optional field information, see Configure Phones.

MGCP Endpoints Fields

You can configure multiple endpoints for an MGCP gateway.

Option Description
Domain Name GUI read-only field is populated from the analog gateway for the MGCP protocol. This is a mandatory field.
Slot * GUI read-only field is populated from the gateway units. This is a mandatory field.
Subunit Position * GUI read-only field is populated from the gateway units. This is a mandatory field.
Port Number * GUI read-only field is populated from the gateway units. This is a mandatory field.
Product Type * Choose the product type from the drop- down list. For example: Analog Phone. This is a mandatory field.
Device Protocol * Choose the device protocol from the drop-down list. For example: SCCP. This is a mandatory field.
Protocol Side * This is a read-only field except when creating a device. This is a mandatory field.
Class * This is a read-only field except when creating a device. This is a mandatory field.
Device Name * GUI read-only field is populated from the analog gateway. This is a mandatory field.
Description When the endpoint is added, the default description is in the format: Endpoint for slot/subunit/port n/n/n gateway @domain. Update it with an optional description for the device. This is an optional field and accepts a string value.
Device Pool Choose the device pool from the drop-down list. For example: Cu2Si2-DevicePool. This is a mandatory field.
Calling Search Space Choose the space name from the drop-down list. This is an optional field.
Common Device Configuration Specify the Configuration name of the device. This is an optional field.
Network Locale Choose the location from the drop-down list. This is an optional field.
Location * Choose a location from the drop-down list. For example: Cu2Si2-Location. This is a mandatory field.
Media Resource Group List Choose a media resource to allocate for a device. This is an optional field.
AAR calling search space Choose the appropriate calling search space for the device to use when it performs automated alternate routing (AAR) from the drop-down list. This is an optional field.
Field Description
Use Trusted Relay Point

Choose one of the following values:

  • Off - Choose this value to disable the use of a Trusted Relay Point (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.
  • 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.
AAR Group Specify the automated alternate routing (AAR) group for this device. The AAR group provides the prefix digits that are used to route calls that are otherwise blocked due to insufficient bandwidth.
Geolocation Specify the location name. This is an optional field.
Transmit UTF-8 for Calling Perty Name MLPP Preemption Keep the check box cleared.
Port Number * Configure the ports for the MGCP Endpoint. This is a mandatory field.
Trunk * This field value auto-populates depending on the value set for the Port Number. This is a mandatory field.
Trunk Direction * The field value auto-populates depending on the value set for the Number. This is a mandatory field.
Trunk Level * The field value auto-populates depending on the value set for the Number. This is a mandatory field.
Attendant DN Specify this field for group start and loop start. This is a mandatory field.
Prefix DN Enter the prefix digits that are appended to the digits that this trunk receives on incoming calls.
Num Digits * Enter the number of significant digits to collect between 0 to 32.
Expected Digits * Enter the number of digits that are expected on the inbound side of the trunk. You can leave zero as the default value, if you are unsure.
Field Description
SMDI Port Number (0 - 4096) *

Enter the first SMDI port number of the T1 span.

If you set this parameter to a nonxero value and this gateway belongs to an unknown type of route list, route group, or route list, hunting does not continue beyond this span.

Unattended Port Select this check box to indicate an unattended port on this device.
Line Click + to expand Line.
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.
E164 Mask

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

You can enter a maximum of 24 numbers, 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.

Dirn, Pattern * Choose the route pattern from the drop-down list. For example: 08231006.
Dirn, 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.
Enduser Click + to expand Enduser.
User ID Choose the available user ID from drop-down list. For example: Subscriber 1.
Index This field is the line position on the device. If left blank, an integer is automatically assigned.
Trunk Selection Order * Choose the order from the drop-down list to display the call routing logic for the route pattern.

Config: Product Specific Configuration Layout Fields

Field Description
Key Enter the Key for the product-specific configuration Layout. For example stcappRegCap.
Value Enter the Key for the product-specific configuration layout. For example: 0.

HCS Gateway Relation

Model Details: relation/HcsAnalogGatewayREL

Title Description Details
Product *
  • 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"]
Call Manager Group Name
  • Field Name: callManagerGroupName
  • Type: String
  • Target: device/cucm/CallManagerGroup
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Protocol *
  • 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"]
Description
  • Field Name: description
  • Type: String
  • Cardinality: [0..1]
Domain Name * For SCCP mention MAC Address
  • Field Name: domainName
  • Type: String
  • Cardinality: [1..1]
Vendor Config
  • Field Name: vendorConfig.[n]
  • Type: Array
Value
  • Field Name: vendorConfig.[n].value
  • Type: Any
Key
  • Field Name: vendorConfig.[n].key
  • Type: String
Units
  • Field Name: units
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Unit
  • Field Name: unit.[n]
  • Type: Array
  • Cardinality: [1..n]
Index *
  • Field Name: units.unit.[n].index
  • Type: Integer
  • Cardinality: [1..1]
Product *
  • Field Name: units.unit.[n].product
  • Type: ["String", "Null"]
  • Cardinality: [1..1]
  • Choices: ["AIM-VOICE-30 (2 subunits)", "AIM-VOICE-30-SLOT-0 (3 subunits- slot 0 only)", "ANALOG", "C-SM-NIM-ADPT", "DIGITAL", "ENCS-1NIM-MBRD", "EVM-HD", "FLEX-SLOT", "GENERIC-SLOT", "ISR-2NIM-MBRD", "ISR-3NIM-MBRD", "NM-1V", "NM-2V", "NM-3VWIC-MBRD", "NM-4VWIC-MBRD", "NM-HD-1V", "NM-HD-2V", "NM-HD-2VE", "NM-HDA", "NM-HDV", "NM-HDV2-0PORT", "NM-HDV2-1PORT-E1", "NM-HDV2-1PORT-T1", "NM-HDV2-2PORT-E1", "NM-HDV2-2PORT-T1", "NONE", "PA-MCX", "PA-VXA", "PA-VXB", "PA-VXC", "SM-X-NIM-ADPTR", "VG-1NIM-MBRD", "VG-2VWIC-MBRD", "VG-3VWIC-MBRD", "VGC_PORT", "VIC-SLOT", "VWIC-SLOT", "WS-X6600"]
Subunits
  • Field Name: subunits
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Subunit
  • Field Name: subunit.[n]
  • Type: Array
  • Cardinality: [1..n]
Index *
  • Field Name: units.unit.[n].subunits.subunit.[n].index
  • Type: ["Integer", "Null"]
  • Cardinality: [1..1]
Product *
  • Field Name: units.unit.[n].subunits.subunit.[n].product
  • Type: ["String", "Null"]
  • Cardinality: [1..1]
  • Choices: ["16FXS", "16FXS8FXO", "1T1", "24FXS", "24FXS-SCCP", "2FXS-MGCP", "2FXS-SCCP", "48_PORTS", "4FXS-MGCP", "4FXS-SCCP", "8FXS", "EM-4BRI-NT/TE", "EM-4BRI-NT/TE-EM0", "EM-4BRI-NT/TE-EM1", "EM-4BRI-NT/TE-SCCP", "EM-4FXO-EM0", "EM-4FXO-EM1", "EM-8FXS-EM0", "EM-8FXS-EM0-SCCP", "EM-8FXS-EM1", "EM-8FXS-EM1-SCCP", "EM-HDA-3FXS/4FXO", "EM-HDA-3FXS/4FXO-SCCP", "EM-HDA-6FXO", "EM-HDA-8FXS", "EM-HDA-8FXS-SCCP", "EM2-4FXO-EM0", "EM2-4FXO-EM1", "EM3-HDA-8FXS/DID", "EM3-HDA-8FXS/DID-SCCP", "EVM-HD-8FXS/DID", "EVM-HD-8FXS/DID-SCCP", "HWIC-1CE1T1-PRI-E1", "HWIC-1CE1T1-PRI-T1", "HWIC-2CE1T1-PRI-E1", "HWIC-2CE1T1-PRI-T1", "HWIC-4CE1T1-PRI-E1", "HWIC-4CE1T1-PRI-T1", "Intelbras 80 Port FXS", "NIM-1CE1T1-PRI-E1", "NIM-1CE1T1-PRI-T1", "NIM-1MFT-T1E1-E1", "NIM-1MFT-T1E1-T1", "NIM-2BRI-NT/TE", "NIM-2BRI-NT/TE-SCCP", "NIM-2CE1T1-PRI-E1", "NIM-2CE1T1-PRI-T1", "NIM-2FXO", "NIM-2FXS", "NIM-2FXS-SCCP", "NIM-2FXS-SIP", "NIM-2FXS/4FXO", "NIM-2FXS/4FXO-SCCP", "NIM-2FXS/4FXO-SIP", "NIM-2MFT-T1E1-E1", "NIM-2MFT-T1E1-T1", "NIM-4BRI-NT/TE", "NIM-4BRI-NT/TE-SCCP", "NIM-4FXO", "NIM-4FXS", "NIM-4FXS-SCCP", "NIM-4FXS-SIP", "NIM-4MFT-T1E1-E1", "NIM-4MFT-T1E1-T1", "NIM-8CE1T1-PRI-E1", "NIM-8CE1T1-PRI-T1", "NIM-8MFT-T1E1-E1", "NIM-8MFT-T1E1-T1", "NM-HDA-4FXS", "NM-HDA-4FXS-SCCP", "NM-HDV2-ONBOARD-E1", "NM-HDV2-ONBOARD-E1-2PORT", "NM-HDV2-ONBOARD-T1", "NM-HDV2-ONBOARD-T1-2PORT", "PA-MCX-2TE1-E1", "PA-MCX-2TE1-T1", "PA-MCX-4TE1-E1", "PA-MCX-4TE1-T1", "PA-MCX-6TE1-E1", "PA-MCX-6TE1-T1", "PA-MCX-8TE1-E1", "PA-MCX-8TE1-T1", "PA-VXA-1TE1-24-T1", "PA-VXA-1TE1-30-E1", "PA-VXB-2TE1-E1", "PA-VXB-2TE1-T1", "PA-VXC-2TE1-E1", "PA-VXC-2TE1-T1", "SM-D-48FXS-E", "SM-D-48FXS-E-SCCP", "SM-D-72FXS", "SM-D-72FXS-SCCP", "SM-V-132FXS/6FXO", "SM-V-132FXS/6FXO-SCCP", "SM-V-132FXS/6FXO-SIP", "SM-V-144FXS", "SM-V-144FXS-SCCP", "SM-V-144FXS-SIP", "SM-V-84FXS/6FXO", "SM-V-84FXS/6FXO-SCCP", "SM-V-84FXS/6FXO-SIP", "SM-X-16FXS-SIP", "SM-X-16FXS/2FXO", "SM-X-16FXS/2FXO-SCCP", "SM-X-24FXS-SIP", "SM-X-24FXS/4FXO", "SM-X-24FXS/4FXO-SCCP", "SM-X-56FXS", "SM-X-56FXS-SCCP", "SM-X-56FXS-SIP", "SM-X-72FXS", "SM-X-72FXS-SCCP", "SM-X-72FXS-SIP", "SM-X-8FXS-SIP", "SM-X-8FXS/12FXO", "SM-X-8FXS/12FXO-SCCP", "VG-2FXS/2FXO", "VG-2FXS/2FXO-SCCP", "VG-4FXS/4FXO", "VG-4FXS/4FXO-SCCP", "VG-6FXS/6FXO", "VG-6FXS/6FXO-SCCP", "VG-8FXS", "VG-8FXS-SCCP", "VGD-DFC-CT3", "VIC-16FXS", "VIC-2BRI", "VIC-2FXO", "VIC-2FXS", "VIC-2FXS-SCCP", "VIC-4FXO", "VIC-4FXS", "VIC-4FXS-SCCP", "VIC-4FXS/DID", "VIC-8FXO", "VIC-8FXS", "VIC2-1BRI", "VIC2-1FXO", "VIC2-1MFT-T1E1-E1", "VIC2-1MFT-T1E1-T1", "VIC2-2BRI", "VIC2-2BRI-NT/TE-SCCP", "VIC2-2FXO", "VIC2-2FXS", "VIC2-2FXS-SCCP", "VIC2-2MFT-T1E1-E1", "VIC2-2MFT-T1E1-T1", "VIC2-4FXO", "VIC3-2FXS-E/DID", "VIC3-2FXS-E/DID-SCCP", "VIC3-2FXS/DID", "VIC3-2FXS/DID-SCCP", "VIC3-4FXS/DID", "VIC3-4FXS/DID-SCCP", "VIC_NONE", "VWIC-1MFT-E1", "VWIC-1MFT-T1", "VWIC-2MFT-E1", "VWIC-2MFT-T1", "VWIC2-1MFT-G703-E1", "VWIC2-1MFT-G703-T1", "VWIC2-1MFT-T1E1-E1", "VWIC2-1MFT-T1E1-T1", "VWIC2-2MFT-G703-E1", "VWIC2-2MFT-G703-T1", "VWIC2-2MFT-T1E1-E1", "VWIC2-2MFT-T1E1-T1", "VWIC3-1MFT-G703-E1", "VWIC3-1MFT-G703-T1", "VWIC3-1MFT-T1E1-E1", "VWIC3-1MFT-T1E1-T1", "VWIC3-2MFT-G703-E1", "VWIC3-2MFT-G703-T1", "VWIC3-2MFT-T1E1-E1", "VWIC3-2MFT-T1E1-T1", "VWIC3-4MFT-T1E1-E1", "VWIC3-4MFT-T1E1-T1", "WS-SVC-CMM-MS", "WS-U4604-16FXS", "WS-U4604-8FXO-2FXS", "WS-U4604-8FXS", "WS-X6600-24FXS", "WS-X6600-6E1", "WS-X6600-6T1"]
Begin Port
  • Field Name: units.unit.[n].subunits.subunit.[n].beginPort
  • Type: ["Integer", "Null"]
  • Cardinality: [0..1]
Endpoints
  • Field Name: Endpoints.[n]
  • Type: Array
Subunit *
  • Field Name: Endpoints.[n].subunit
  • Type: ["Integer", "Null"]
  • Cardinality: [1..1]
Endpoint
  • Field Name: endpoint
  • Type: ["Object", "Null"]
  • Cardinality: [1..1]
Protocol * Protocol option is read-only,except when creating a device.
  • Field Name: Endpoints.[n].endpoint.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"]
Geo Location Filter Name
  • Field Name: Endpoints.[n].endpoint.geoLocationFilterName
  • Type: ["String", "Null"]
  • Target: device/cucm/GeoLocationFilter
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Calling Party Strip Digits
  • Field Name: Endpoints.[n].endpoint.callingPartyStripDigits
  • Type: ["Integer", "Null"]
  • Cardinality: [0..1]
Vendor Config
  • Field Name: vendorConfig.[n]
  • Type: Array
Value
  • Field Name: Endpoints.[n].endpoint.vendorConfig.[n].value
  • Type: Any
Key
  • Field Name: Endpoints.[n].endpoint.vendorConfig.[n].key
  • Type: String
Always Use Prime Line * Default: Default
  • Field Name: Endpoints.[n].endpoint.alwaysUsePrimeLine
  • Type: String
  • Cardinality: [1..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Calling Party Unknown Transformation Css Name
  • Field Name: Endpoints.[n].endpoint.callingPartyUnknownTransformationCssName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Phone Template Name *
  • Field Name: Endpoints.[n].endpoint.phoneTemplateName
  • Type: String
  • Target: device/cucm/PhoneButtonTemplate
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Calling Search Space Name
  • Field Name: Endpoints.[n].endpoint.callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Index *
  • Field Name: Endpoints.[n].endpoint.index
  • Type: Integer
  • Cardinality: [1..1]
Allow Cti Control Flag Applicable only for SCCP
  • Field Name: Endpoints.[n].endpoint.allowCtiControlFlag
  • Type: Boolean
  • Cardinality: [0..1]
Packet Capture Duration
  • Field Name: Endpoints.[n].endpoint.packetCaptureDuration
  • Type: ["Integer", "Null"]
  • Cardinality: [0..1]
Use Trusted Relay Point * Default: Default
  • Field Name: Endpoints.[n].endpoint.useTrustedRelayPoint
  • Type: String
  • Cardinality: [1..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Pstn Access Default: True
  • Field Name: Endpoints.[n].endpoint.pstnAccess
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Common Device Config Name
  • Field Name: Endpoints.[n].endpoint.commonDeviceConfigName
  • Type: ["String", "Null"]
  • Target: device/cucm/CommonDeviceConfig
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Network Locale
  • Field Name: Endpoints.[n].endpoint.networkLocale
  • Type: ["String", "Null"]
  • Target: device/cucm/Country
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
  • Choices: ["Argentina", "Australia", "Austria", "Belgium", "Brazil", "Canada", "China", "Colombia", "Cyprus", "Czech Republic", "Denmark", "Egypt", "Finland", "France", "Germany", "Ghana", "Greece", "Hong Kong", "Hungary", "Iceland", "India", "Indonesia", "Ireland", "Israel", "Italy", "Japan", "Jordan", "Kenya", "Korea Republic", "Lebanon", "Luxembourg", "Malaysia", "Mexico", "Nepal", "Netherlands", "New Zealand", "Nigeria", "Norway", "Pakistan", "Panama", "Peru", "Philippines", "Poland", "Portugal", "Russian Federation", "Saudi Arabia", "Singapore", "Slovakia", "Slovenia", "South Africa", "Spain", "Sweden", "Switzerland", "Taiwan", "Thailand", "Turkey", "United Kingdom", "United States", "Venezuela", "Zimbabwe", "Itu", "Chile", "Bulgaria", "Croatia", "Romania", "Serbia and Montenegro", "United Arab Emirates", "Oman", "Kuwait", "Algeria", "Bahrain", "Iraq", "Mauritania", "Republic of Montenegro", "Morocco", "Qatar", "Republic of Serbia", "Sudan", "Tunisia", "Vietnam", "Yemen", "Lithuania", "Latvia", "Estonia", "Ukraine"]
Mlpp Indication Status This setting only affects devices that support MLPP. Default: Off
  • Field Name: Endpoints.[n].endpoint.mlppIndicationStatus
  • Type: String
  • Cardinality: [0..1]
  • Default: Off
  • Choices: ["Off", "On", "Default"]
Owner User Id Applicable only for SCCP
  • Field Name: Endpoints.[n].endpoint.ownerUserId
  • Type: ["String", "Null"]
  • Target: device/cucm/User
  • Target attr: userid
  • Cardinality: [0..1]
  • Format: uri
Media Resource List Name
  • Field Name: Endpoints.[n].endpoint.mediaResourceListName
  • Type: ["String", "Null"]
  • Target: device/cucm/MediaResourceList
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Packet Capture Mode Default: None
  • Field Name: Endpoints.[n].endpoint.packetCaptureMode
  • Type: String
  • Cardinality: [0..1]
  • Default: None
  • Choices: ["None", "Batch Processing Mode"]
Unattended Port Applicable only for SCCP
  • Field Name: Endpoints.[n].endpoint.unattendedPort
  • Type: ["Boolean", "Null"]
  • Cardinality: [0..1]
Use Device Pool Cgpn Transform Css Default: True
  • Field Name: Endpoints.[n].endpoint.useDevicePoolCgpnTransformCss
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Product * Product ID string. read-only except when creating a device.
  • Field Name: Endpoints.[n].endpoint.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"]
Calling Party Number Prefix
  • Field Name: Endpoints.[n].endpoint.callingPartyNumberPrefix
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 16
Always Use Prime Line For VM * Default: Default
  • Field Name: Endpoints.[n].endpoint.alwaysUsePrimeLineForVM
  • Type: String
  • Cardinality: [1..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Description Optional description of the device
  • Field Name: Endpoints.[n].endpoint.description
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
Use Device Pool Cgpn Transform Css Unknown Default: True
  • Field Name: Endpoints.[n].endpoint.useDevicePoolCgpnTransformCssUnknown
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Ignore Presentation Indicators Applicable only for SCCP
  • Field Name: Endpoints.[n].endpoint.ignorePresentationIndicators
  • Type: Boolean
Subscribe Calling Search Space Name Applicable only for SCCP
  • Field Name: Endpoints.[n].endpoint.subscribeCallingSearchSpaceName
  • Type: String
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
User Locale
  • Field Name: Endpoints.[n].endpoint.userLocale
  • Type: ["String", "Null"]
  • Target: device/cucm/UserLocale
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
  • Choices: ["English United States"]
Use Device Pool Cdpn Transform Css Default: True
  • Field Name: Endpoints.[n].endpoint.useDevicePoolCdpnTransformCss
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Geo Location Name
  • Field Name: Endpoints.[n].endpoint.geoLocationName
  • Type: ["String", "Null"]
  • Target: device/cucm/GeoLocation
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Device Mobility Mode * Default: Default
  • Field Name: Endpoints.[n].endpoint.deviceMobilityMode
  • Type: String
  • Cardinality: [1..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Preemption This setting only affects devices that support MLPP. Default: Default
  • Field Name: Endpoints.[n].endpoint.preemption
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Disabled", "Forceful", "Default"]
Hlog Status Applicable only for SCCP
  • Field Name: Endpoints.[n].endpoint.hlogStatus
  • Type: Boolean
  • Cardinality: [0..1]
Cdpn Transformation Css Name
  • Field Name: Endpoints.[n].endpoint.cdpnTransformationCssName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Class * Class ID string. Class information is read-only except when creating a device.
  • Field Name: Endpoints.[n].endpoint.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"]
Hotline Device This tag is applicable for MGCP FXS ports,which supports PLAR.
  • Field Name: Endpoints.[n].endpoint.hotlineDevice
  • Type: Boolean
  • Cardinality: [0..1]
Security Profile Name *
  • Field Name: Endpoints.[n].endpoint.securityProfileName
  • Type: String
  • Target: device/cucm/PhoneSecurityProfile
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Presence Group Name * Applicable only for SCCP
  • Field Name: Endpoints.[n].endpoint.presenceGroupName
  • Type: String
  • Target: device/cucm/PresenceGroup
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Name * The device name,using only URL-friendly characters
  • Field Name: Endpoints.[n].endpoint.name
  • Type: String
  • Cardinality: [1..1]
  • MaxLength: 128
Retry Video Call As Audio Default: True
  • Field Name: Endpoints.[n].endpoint.retryVideoCallAsAudio
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Protocol Side * Side information is read-only except when creating a device Default: User
  • Field Name: Endpoints.[n].endpoint.protocolSide
  • Type: String
  • Cardinality: [1..1]
  • Default: User
  • Choices: ["Network", "User"]
Common Phone Config Name *
  • Field Name: Endpoints.[n].endpoint.commonPhoneConfigName
  • Type: String
  • Target: device/cucm/CommonPhoneConfig
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Mlpp Domain Id This setting only effects devices that support MLPP. Use -1 to set to null
  • Field Name: Endpoints.[n].endpoint.mlppDomainId
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 128
Remote Device Applicable only for SCCP
  • Field Name: Endpoints.[n].endpoint.remoteDevice
  • Type: Boolean
  • Cardinality: [0..1]
Aar Neighborhood Name
  • Field Name: Endpoints.[n].endpoint.aarNeighborhoodName
  • Type: ["String", "Null"]
  • Target: device/cucm/AarGroup
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Location Name *
  • Field Name: Endpoints.[n].endpoint.locationName
  • Type: String
  • Target: device/cucm/Location
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Transmit Utf8
  • Field Name: Endpoints.[n].endpoint.transmitUtf8
  • Type: Boolean
  • Cardinality: [0..1]
Cgpn Transformation Css Name
  • Field Name: Endpoints.[n].endpoint.cgpnTransformationCssName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Automated Alternate Routing Css Name
  • Field Name: Endpoints.[n].endpoint.automatedAlternateRoutingCssName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Device Pool Name *
  • Field Name: Endpoints.[n].endpoint.devicePoolName
  • Type: String
  • Target: device/cucm/DevicePool
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Model Model ID string. Read Only
  • Field Name: Endpoints.[n].endpoint.model
  • Type: String
  • Cardinality: [0..1]
  • Choices: ["Cisco 30 SP+", "Cisco 12 SP+", "Cisco 12 SP", "Cisco 12 S", "Cisco 30 VIP", "Cisco 7910", "Cisco 7960", "Cisco 7940", "Cisco 7935", "Cisco VGC Phone", "Cisco VGC Virtual Phone", "Cisco ATA 186", "EMCC Base Phone", "SCCP Phone", "Analog Access", "Digital Access", "Digital Access+", "Digital Access WS-X6608", "Analog Access WS-X6624", "VGC Gateway", "Conference Bridge", "Conference Bridge WS-X6608", "Cisco IOS Conference Bridge (HDV2)", "Cisco Conference Bridge (WS-SVC-CMM)", "H.323 Phone", "H.323 Gateway", "Music On Hold", "Device Pilot", "CTI Port", "CTI Route Point", "Voice Mail Port", "Cisco IOS Software Media Termination Point (HDV2)", "Cisco Media Server (WS-SVC-CMM-MS)", "Cisco Video Conference Bridge (IPVC-35xx)", "Cisco IOS Heterogeneous Video Conference Bridge", "Cisco IOS Guaranteed Audio Video Conference Bridge", "Cisco IOS Homogeneous Video Conference Bridge", "Route List", "Load Simulator", "Media Termination Point", "Media Termination Point Hardware", "Cisco IOS Media Termination Point (HDV2)", "Cisco Media Termination Point (WS-SVC-CMM)", "Cisco 7941", "Cisco 7971", "MGCP Station", "MGCP Trunk", "GateKeeper", "7914 14-Button Line Expansion Module", "Trunk", "Tone Announcement Player", "SIP Trunk", "SIP Gateway", "WSM Trunk", "Remote Destination Profile", "7915 12-Button Line Expansion Module", "7915 24-Button Line Expansion Module", "7916 12-Button Line Expansion Module", "7916 24-Button Line Expansion Module", "CKEM 36-Button Line Expansion Module", "SPA8800", "Unknown MGCP Gateway", "Unknown", "Cisco 7985", "Cisco 7911", "Cisco 7961G-GE", "Cisco 7941G-GE", "Motorola CN622", "Third-party SIP Device (Basic)", "Cisco 7931", "Cisco Unified Personal Communicator", "Cisco 7921", "Cisco 7906", "Third-party SIP Device (Advanced)", "Cisco TelePresence", "Nokia S60", "Cisco 7962", "Cisco 3951", "Cisco 7937", "Cisco 7942", "Cisco 7945", "Cisco 7965", "Cisco 7975", "Cisco 3911", "Cisco Unified Mobile Communicator", "Cisco TelePresence 1000", "Cisco TelePresence 3000", "Cisco TelePresence 3200", "Cisco TelePresence 500-37", "Cisco 7925", "Cisco 9971", "Cisco 6921", "Cisco 6941", "Cisco 6961", "Cisco Unified Client Services Framework", "Cisco TelePresence 1300-65", "Cisco TelePresence 1100", "Transnova S3", "BlackBerry MVS VoWifi", "Cisco 9951", "Cisco 8961", "Cisco 6901", "Cisco 6911", "Cisco ATA 187", "Cisco TelePresence 200", "Cisco TelePresence 400", "Cisco Dual Mode for iPhone", "Cisco 6945", "Cisco Dual Mode for Android", "Cisco 7926", "Cisco E20", "Generic Single Screen Room System", "Generic Multiple Screen Room System", "Cisco TelePresence EX90", "Cisco 8945", "Cisco 8941", "Generic Desktop Video Endpoint", "Cisco TelePresence 500-32", "Cisco TelePresence 1300-47", "Cisco 3905", "Cisco Cius", "VKEM 36-Button Line Expansion Module", "Cisco TelePresence TX1310-65", "Cisco TelePresence MCU", "Ascom IP-DECT Device", "Cisco TelePresence Exchange System", "Cisco TelePresence EX60", "Cisco TelePresence Codec C90", "Cisco TelePresence Codec C60", "Cisco TelePresence Codec C40", "Cisco TelePresence Quick Set C20", "Cisco TelePresence Profile 42 (C20)", "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 MX200", "Cisco TelePresence TX9000", "Cisco TelePresence TX9200", "Cisco 7821", "Cisco 7841", "Cisco 7861", "Cisco TelePresence SX20", "Cisco TelePresence MX300", "IMS-integrated Mobile (Basic)", "Third-party AS-SIP Endpoint", "Cisco Cius SP", "Cisco TelePresence Profile 42 (C40)", "Cisco VXC 6215", "CTI Remote Device", "Usage Profile", "Carrier-integrated Mobile", "Universal Device Template", "Cisco DX650", "Cisco Unified Communications for RTX", "Cisco Jabber for Tablet", "Cisco 8831", "Cisco ATA 190", "Cisco TelePresence SX10", "Cisco 8841", "Cisco 8851", "Cisco 8861", "Cisco TelePresence SX80", "Cisco TelePresence MX200 G2", "Cisco TelePresence MX300 G2", "Cisco 7905", "Cisco 7920", "Cisco 7970", "Cisco 7912", "Cisco 7902", "Cisco IP Communicator", "Cisco 7961", "Cisco 7936", "Analog Phone", "ISDN BRI Phone", "SCCP gateway virtual phone", "IP-STE", "Cisco TelePresence Conductor", "Cisco DX80", "Cisco DX70", "BEKEM 36-Button Line Expansion Module", "Cisco TelePresence MX700", "Cisco TelePresence MX800", "Cisco TelePresence IX5000", "Cisco 7811", "Cisco 8821", "Cisco 8811", "Interactive Voice Response", "Cisco 8845", "Cisco 8865", "Cisco TelePresence MX800 Dual", "Cisco 8851NR", "Cisco Spark Remote Device", "Cisco Webex DX80", "Cisco TelePresence DX70", "Cisco 7832", "Cisco 8865NR", "Cisco Meeting Server", "Cisco Webex Room Kit", "Cisco Webex Room 55", "Cisco Webex Room Kit Plus", "CP-8800-Video 28-Button Key Expansion Module", "CP-8800-Audio 28-Button Key Expansion Module", "Cisco 8832", "Cisco Webex Room 70 Single", "Cisco 8832NR", "Cisco ATA 191", "Cisco Collaboration Mobile Convergence", "Cisco Webex Room 70 Dual", "Cisco Webex Room Kit Pro", "Cisco Webex Room 55 Dual", "Cisco Webex Room 70 Single G2", "Cisco Webex Room 70 Dual G2", "SIP Station", "Cisco Webex Room Kit Mini", "Cisco Webex VDI Svc Framework", "Cisco Webex Board 55", "Cisco Webex Board 70", "Cisco Webex Board 85", "Cisco Webex Desk Pro", "Cisco Webex Room Panorama", "Cisco Webex Room 70 Panorama", "Cisco Webex Room Phone", "Cisco 860", "Cisco Webex Desk LE"]
Ime E164Transformation Name
  • Field Name: Endpoints.[n].endpoint.imeE164TransformationName
  • Type: ["String", "Null"]
  • Target: device/cucm/ImeE164Transformation
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Lines
  • Field Name: lines
  • Type: 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. Not applicable to FXO ports
  • Field Name: line.[n]
  • Type: Array
  • Cardinality: [0..1]
Display Ascii
  • Field Name: Endpoints.[n].endpoint.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: Endpoints.[n].endpoint.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: Endpoints.[n].endpoint.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: Endpoints.[n].endpoint.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: Endpoints.[n].endpoint.lines.line.[n].recordingProfileName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Index
  • Field Name: Endpoints.[n].endpoint.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: Endpoints.[n].endpoint.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: Endpoints.[n].endpoint.lines.line.[n].label
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
Recording Media Source Default: Gateway Preferred
  • Field Name: Endpoints.[n].endpoint.lines.line.[n].recordingMediaSource
  • Type: String
  • Cardinality: [0..1]
  • Default: Gateway Preferred
  • Choices: ["Gateway Preferred", "Phone Preferred"]
Max Num Calls Default: 2
  • Field Name: Endpoints.[n].endpoint.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: Endpoints.[n].endpoint.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: Endpoints.[n].endpoint.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: Endpoints.[n].endpoint.lines.line.[n].speedDial
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Monitoring Css Name
  • Field Name: Endpoints.[n].endpoint.lines.line.[n].monitoringCssName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
E164Mask
  • Field Name: Endpoints.[n].endpoint.lines.line.[n].e164Mask
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 255
Missed Call Logging Default: True
  • Field Name: Endpoints.[n].endpoint.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: Endpoints.[n].endpoint.lines.line.[n].callInfoDisplay.dialedNumber
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Redirected Number
  • Field Name: Endpoints.[n].endpoint.lines.line.[n].callInfoDisplay.redirectedNumber
  • Type: Boolean
  • Cardinality: [0..1]
Caller Number
  • Field Name: Endpoints.[n].endpoint.lines.line.[n].callInfoDisplay.callerNumber
  • Type: Boolean
  • Cardinality: [0..1]
Caller Name Default: True
  • Field Name: Endpoints.[n].endpoint.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: Endpoints.[n].endpoint.lines.line.[n].dirn.pattern
  • Type: String
  • Cardinality: [1..1]
Route Partition Name *
  • Field Name: Endpoints.[n].endpoint.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: Endpoints.[n].endpoint.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: Endpoints.[n].endpoint.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: Endpoints.[n].endpoint.lines.line.[n].busyTrigger
  • Type: Integer
  • Cardinality: [0..1]
  • Default: 1
Audible Mwi Not applicable for gatewayEndpointAnalogAccess and CiscoCatalyst600024PortFXSGateway Default: Default
  • Field Name: Endpoints.[n].endpoint.lines.line.[n].audibleMwi
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Display
  • Field Name: Endpoints.[n].endpoint.lines.line.[n].display
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
Unit *
  • Field Name: Endpoints.[n].unit
  • Type: Integer
  • Cardinality: [1..1]
Domain Name
  • Field Name: Endpoints.[n].domainName
  • Type: String
  • Cardinality: [0..1]
Gateway Dat
  • Field Name: GatewayDAT
  • Type: Object
Domain Name * Domain Name
  • Field Name: GatewayDAT.domainName
  • Type: String
  • MaxLength: 1024
IOS Device * IOS Device
  • Field Name: GatewayDAT.iosDevice
  • Type: String
  • Target: data/HcsIOSDeviceDAT
  • Target attr: name
  • MaxLength: 512
  • Format: uri
Product
  • Field Name: GatewayDAT.product
  • Type: String
  • MaxLength: 1024
Protocol
  • Field Name: GatewayDAT.protocol
  • Type: String
  • MaxLength: 1024
CCM Group
  • Field Name: GatewayDAT.ccmGroup
  • Type: String
  • MaxLength: 1024
Description
  • Field Name: GatewayDAT.description
  • Type: String
  • MaxLength: 1024
Enable Command Builder Generate IOS Commands for this gateway and ports Default: true
  • Field Name: GatewayDAT.generateIOSCommands
  • Type: Boolean
  • Default: true
Gateway Network Interface
  • Field Name: GatewayDAT.networkInterface
  • Type: String
  • MaxLength: 1024
  • Choices: ["FastEthernet0/0", "FastEthernet0/1", "GigabitEthernet0/0", "GigabitEthernet0/1", "GigabitEthernet0/2", "GigabitEthernet0/0/0", "GigabitEthernet0/0/1", "GigabitEthernet0/0/2", "GigabitEthernet0/0/3"]
Call Disconnect Timeout
  • Field Name: GatewayDAT.disconnectTimeout
  • Type: Integer
CP Tone
  • Field Name: GatewayDAT.cpTone
  • Type: String
  • MaxLength: 1024
  • Choices: ["ar", "au", "at", "be", "br", "ca", "cn", "co", "cz", "dk", "de", "eg", "fi", "fr", "gh", "gb", "gr", "hk", "hu", "is", "in", "id", "ie", "il", "it", "jp", "jo", "ke", "kr", "lb", "lu", "my", "mx", "np", "nl", "nz", "ng", "no", "pk", "pa", "pe", "ph", "pl", "pt", "ru", "sa", "sg", "sk", "si", "za", "es", "se", "ch", "tw", "th", "tr", "us", "ve", "zw"]
Signal
  • Field Name: GatewayDAT.signal
  • Type: String
  • MaxLength: 1024
  • Choices: ["loop-start", "ground-start"]
M Endpoints
  • Field Name: mEndpoints.[n]
  • Type: Array
Subunit *
  • Field Name: mEndpoints.[n].subunit
  • Type: ["Integer", "Null"]
  • Cardinality: [1..1]
Endpoint
  • Field Name: endpoint
  • Type: ["Object", "Null"]
  • Cardinality: [1..1]
Protocol * Protocol option is read-only,except when creating a device.
  • Field Name: mEndpoints.[n].endpoint.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"]
Geo Location Filter Name
  • Field Name: mEndpoints.[n].endpoint.geoLocationFilterName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Calling Party Strip Digits
  • Field Name: mEndpoints.[n].endpoint.callingPartyStripDigits
  • Type: ["Integer", "Null"]
  • Cardinality: [0..1]
Vendor Config
  • Field Name: vendorConfig.[n]
  • Type: Array
Value
  • Field Name: mEndpoints.[n].endpoint.vendorConfig.[n].value
  • Type: Any
Key
  • Field Name: mEndpoints.[n].endpoint.vendorConfig.[n].key
  • Type: String
Calling Party Unknown Transformation Css Name
  • Field Name: mEndpoints.[n].endpoint.callingPartyUnknownTransformationCssName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Calling Search Space Name
  • Field Name: mEndpoints.[n].endpoint.callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Index *
  • Field Name: mEndpoints.[n].endpoint.index
  • Type: Integer
  • Cardinality: [1..1]
Packet Capture Duration
  • Field Name: mEndpoints.[n].endpoint.packetCaptureDuration
  • Type: ["Integer", "Null"]
  • Cardinality: [0..1]
Use Trusted Relay Point Default: Default
  • Field Name: mEndpoints.[n].endpoint.useTrustedRelayPoint
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Port
  • Field Name: port
  • Type: ["Object", "Null"]
  • Cardinality: [1..1]
Trunk Level
  • Field Name: mEndpoints.[n].endpoint.port.trunkLevel
  • Type: String
  • Cardinality: [0..1]
  • Choices: ["AAL(A)", "AAL(D)", "A/TT", "DAL", "ICS", "ISD/TT", "IST", "ONS", "OPS", "S/ATT", "S/DTT", "A/TO"]
Vendor Config Arbitrary XML defined by 3rd party vendors.
  • Field Name: vendorConfig.[n]
  • Type: Array
Value
  • Field Name: mEndpoints.[n].endpoint.port.vendorConfig.[n].value
  • Type: Any
Key
  • Field Name: mEndpoints.[n].endpoint.port.vendorConfig.[n].key
  • Type: String
Timer4 *
  • Field Name: mEndpoints.[n].endpoint.port.timer4
  • Type: Integer
  • Cardinality: [1..1]
Prefix Dn
  • Field Name: mEndpoints.[n].endpoint.port.prefixDn
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 255
Start Dial Protocol Default: Not Set
  • Field Name: mEndpoints.[n].endpoint.port.startDialProtocol
  • Type: String
  • Cardinality: [0..1]
  • Default: Not Set
  • Choices: ["Not Set", "Immediate", "Wink Start Feature Group B", "Delay Dial", "Wink Start Feature Group D"]
Port Number *
  • Field Name: mEndpoints.[n].endpoint.port.portNumber
  • Type: Integer
  • Cardinality: [1..1]
Silence Suppression Threshold
  • Field Name: mEndpoints.[n].endpoint.port.silenceSuppressionThreshold
  • Type: String
  • Cardinality: [0..1]
  • Choices: ["Disable", "-48dbm0", "-45dbm0", "-42dbm0", "-39dbm0", "-36dbm0", "-33dbm0", "-30dbm0"]
Sig Digits * The value for sigDigits must be between 0 to 32. enable attribute is read only.
  • Field Name: mEndpoints.[n].endpoint.port.sigDigits
  • Type: Integer
  • Cardinality: [1..1]
Caller Id Dn
  • Field Name: mEndpoints.[n].endpoint.port.callerIdDn
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 255
Timer6 *
  • Field Name: mEndpoints.[n].endpoint.port.timer6
  • Type: Integer
  • Cardinality: [1..1]
Timer5 *
  • Field Name: mEndpoints.[n].endpoint.port.timer5
  • Type: Integer
  • Cardinality: [1..1]
Calling Party Selection
  • Field Name: mEndpoints.[n].endpoint.port.callingPartySelection
  • Type: String
  • Cardinality: [0..1]
  • Choices: ["Originator", "First Redirect Number", "Last Redirect Number", "First Redirect Number (External)", "Last Redirect Number (External)"]
Timer3 *
  • Field Name: mEndpoints.[n].endpoint.port.timer3
  • Type: Integer
  • Cardinality: [1..1]
Timer2 *
  • Field Name: mEndpoints.[n].endpoint.port.timer2
  • Type: Integer
  • Cardinality: [1..1]
Timer1 *
  • Field Name: mEndpoints.[n].endpoint.port.timer1
  • Type: Integer
  • Cardinality: [1..1]
Expected Digits *
  • Field Name: mEndpoints.[n].endpoint.port.expectedDigits
  • Type: Integer
  • Cardinality: [1..1]
Digit Sending Default: DTMF
  • Field Name: mEndpoints.[n].endpoint.port.digitSending
  • Type: String
  • Cardinality: [0..1]
  • Default: DTMF
  • Choices: ["DTMF", "MF", "PULSE"]
Smdi Port Number * Not used by T1 Ports
  • Field Name: mEndpoints.[n].endpoint.port.smdiPortNumber
  • Type: Integer
  • Cardinality: [1..1]
Attendant Dn Mandatory for ground start and loop start
  • Field Name: mEndpoints.[n].endpoint.port.attendantDn
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 255
Trunk
  • Field Name: mEndpoints.[n].endpoint.port.trunk
  • Type: String
  • Cardinality: [0..1]
  • Choices: ["Ground Start", "Loop Start", "DID", "POTS", "EANDM"]
Presentation Bit
  • Field Name: mEndpoints.[n].endpoint.port.presentationBit
  • Type: String
  • Cardinality: [0..1]
  • Choices: ["Default", "Allowed", "Restricted"]
Lines
  • Field Name: lines
  • Type: 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. Not applicable to FXO ports
  • Field Name: line.[n]
  • Type: Array
  • Cardinality: [0..1]
Display Ascii
  • Field Name: mEndpoints.[n].endpoint.port.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: mEndpoints.[n].endpoint.port.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: mEndpoints.[n].endpoint.port.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: mEndpoints.[n].endpoint.port.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: mEndpoints.[n].endpoint.port.lines.line.[n].recordingProfileName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Index
  • Field Name: mEndpoints.[n].endpoint.port.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: mEndpoints.[n].endpoint.port.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: mEndpoints.[n].endpoint.port.lines.line.[n].label
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
Recording Media Source Default: Gateway Preferred
  • Field Name: mEndpoints.[n].endpoint.port.lines.line.[n].recordingMediaSource
  • Type: String
  • Cardinality: [0..1]
  • Default: Gateway Preferred
  • Choices: ["Gateway Preferred", "Phone Preferred"]
Max Num Calls Default: 2
  • Field Name: mEndpoints.[n].endpoint.port.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: mEndpoints.[n].endpoint.port.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: mEndpoints.[n].endpoint.port.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: mEndpoints.[n].endpoint.port.lines.line.[n].speedDial
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Monitoring Css Name
  • Field Name: mEndpoints.[n].endpoint.port.lines.line.[n].monitoringCssName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
E164Mask
  • Field Name: mEndpoints.[n].endpoint.port.lines.line.[n].e164Mask
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 255
Missed Call Logging Default: True
  • Field Name: mEndpoints.[n].endpoint.port.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: mEndpoints.[n].endpoint.port.lines.line.[n].callInfoDisplay.dialedNumber
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Redirected Number
  • Field Name: mEndpoints.[n].endpoint.port.lines.line.[n].callInfoDisplay.redirectedNumber
  • Type: Boolean
  • Cardinality: [0..1]
Caller Number
  • Field Name: mEndpoints.[n].endpoint.port.lines.line.[n].callInfoDisplay.callerNumber
  • Type: Boolean
  • Cardinality: [0..1]
Caller Name Default: True
  • Field Name: mEndpoints.[n].endpoint.port.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: mEndpoints.[n].endpoint.port.lines.line.[n].dirn.pattern
  • Type: String
  • Cardinality: [1..1]
Route Partition Name *
  • Field Name: mEndpoints.[n].endpoint.port.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: mEndpoints.[n].endpoint.port.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: mEndpoints.[n].endpoint.port.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: mEndpoints.[n].endpoint.port.lines.line.[n].busyTrigger
  • Type: Integer
  • Cardinality: [0..1]
  • Default: 1
Audible Mwi Not applicable for gatewayEndpointAnalogAccess and CiscoCatalyst600024PortFXSGateway Default: Default
  • Field Name: mEndpoints.[n].endpoint.port.lines.line.[n].audibleMwi
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Display
  • Field Name: mEndpoints.[n].endpoint.port.lines.line.[n].display
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
Caller Id Enable *
  • Field Name: mEndpoints.[n].endpoint.port.callerIdEnable
  • Type: Boolean
  • Cardinality: [1..1]
Unattended Port
  • Field Name: mEndpoints.[n].endpoint.port.unattendedPort
  • Type: ["Boolean", "Null"]
  • Cardinality: [0..1]
Trunk Direction *
  • Field Name: mEndpoints.[n].endpoint.port.trunkDirection
  • Type: String
  • Cardinality: [1..1]
  • Choices: ["Inbound", "Outbound", "Bothways"]
Trunk Pad Tx
  • Field Name: mEndpoints.[n].endpoint.port.trunkPadTx
  • Type: String
  • Cardinality: [0..1]
  • Choices: ["Minus32db", "Minus31db", "Minus30db", "Minus29db", "Minus28db", "Minus27db", "Minus26db", "Minus25db", "Minus24db", "Minus23db", "Minus22db", "Minus21db", "Minus20db", "Minus19db", "Minus18db", "Minus17db", "Minus16db", "Minus15db", "Minus14db", "Minus13db", "Minus12db", "Minus11db", "Minus10db", "Minus9db", "Minus8db", "Minus7db", "Minus6db", "Minus5db", "Minus4db", "Minus3db", "Minus2db", "Minus1db", "NoDbPadding", "Plus1db", "Plus2db", "Plus3db", "Plus4db", "Plus5db", "Plus6db", "Plus7db", "Plus8db", "Plus9db", "Plus10db", "Plus11db", "Plus12db", "Plus13db", "Plus14db", "Plus15db", "Plus16db", "Plus17db", "Plus18db", "Plus19db", "Plus20db", "Plus21db", "Plus22db", "Plus23db", "Plus24db", "Plus25db", "Plus26db", "Plus27db", "Plus28db", "Plus29db", "Plus30db", "Plus31db", "Plus32db"]
Trunk Pad Rx
  • Field Name: mEndpoints.[n].endpoint.port.trunkPadRx
  • Type: String
  • Cardinality: [0..1]
  • Choices: ["Minus32db", "Minus31db", "Minus30db", "Minus29db", "Minus28db", "Minus27db", "Minus26db", "Minus25db", "Minus24db", "Minus23db", "Minus22db", "Minus21db", "Minus20db", "Minus19db", "Minus18db", "Minus17db", "Minus16db", "Minus15db", "Minus14db", "Minus13db", "Minus12db", "Minus11db", "Minus10db", "Minus9db", "Minus8db", "Minus7db", "Minus6db", "Minus5db", "Minus4db", "Minus3db", "Minus2db", "Minus1db", "NoDbPadding", "Plus1db", "Plus2db", "Plus3db", "Plus4db", "Plus5db", "Plus6db", "Plus7db", "Plus8db", "Plus9db", "Plus10db", "Plus11db", "Plus12db", "Plus13db", "Plus14db", "Plus15db", "Plus16db", "Plus17db", "Plus18db", "Plus19db", "Plus20db", "Plus21db", "Plus22db", "Plus23db", "Plus24db", "Plus25db", "Plus26db", "Plus27db", "Plus28db", "Plus29db", "Plus30db", "Plus31db", "Plus32db"]
Pstn Access Default: True
  • Field Name: mEndpoints.[n].endpoint.pstnAccess
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Common Device Config Name
  • Field Name: mEndpoints.[n].endpoint.commonDeviceConfigName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Network Locale
  • Field Name: mEndpoints.[n].endpoint.networkLocale
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • Choices: ["Argentina", "Australia", "Austria", "Belgium", "Brazil", "Canada", "China", "Colombia", "Cyprus", "Czech Republic", "Denmark", "Egypt", "Finland", "France", "Germany", "Ghana", "Greece", "Hong Kong", "Hungary", "Iceland", "India", "Indonesia", "Ireland", "Israel", "Italy", "Japan", "Jordan", "Kenya", "Korea Republic", "Lebanon", "Luxembourg", "Malaysia", "Mexico", "Nepal", "Netherlands", "New Zealand", "Nigeria", "Norway", "Pakistan", "Panama", "Peru", "Philippines", "Poland", "Portugal", "Russian Federation", "Saudi Arabia", "Singapore", "Slovakia", "Slovenia", "South Africa", "Spain", "Sweden", "Switzerland", "Taiwan", "Thailand", "Turkey", "United Kingdom", "United States", "Venezuela", "Zimbabwe", "Itu", "Chile", "Bulgaria", "Croatia", "Romania", "Serbia and Montenegro", "United Arab Emirates", "Oman", "Kuwait", "Algeria", "Bahrain", "Iraq", "Mauritania", "Republic of Montenegro", "Morocco", "Qatar", "Republic of Serbia", "Sudan", "Tunisia", "Vietnam", "Yemen", "Lithuania", "Latvia", "Estonia", "Ukraine"]
Media Resource List Name
  • Field Name: mEndpoints.[n].endpoint.mediaResourceListName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Packet Capture Mode Default: None
  • Field Name: mEndpoints.[n].endpoint.packetCaptureMode
  • Type: String
  • Cardinality: [0..1]
  • Default: None
  • Choices: ["None", "Batch Processing Mode"]
Use Device Pool Cgpn Transform Css Default: True
  • Field Name: mEndpoints.[n].endpoint.useDevicePoolCgpnTransformCss
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Product * Product ID string. read-only except when creating a device.
  • Field Name: mEndpoints.[n].endpoint.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"]
Calling Party Number Prefix
  • Field Name: mEndpoints.[n].endpoint.callingPartyNumberPrefix
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 16
Description Optional description of the device
  • Field Name: mEndpoints.[n].endpoint.description
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 128
Use Device Pool Cgpn Transform Css Unknown Default: True
  • Field Name: mEndpoints.[n].endpoint.useDevicePoolCgpnTransformCssUnknown
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Use Device Pool Cdpn Transform Css Default: True
  • Field Name: mEndpoints.[n].endpoint.useDevicePoolCdpnTransformCss
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Geo Location Name
  • Field Name: mEndpoints.[n].endpoint.geoLocationName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Elin Group
  • Field Name: mEndpoints.[n].endpoint.elinGroup
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Cdpn Transformation Css Name
  • Field Name: mEndpoints.[n].endpoint.cdpnTransformationCssName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Class * Class ID string. Class information is read-only except when creating a device.
  • Field Name: mEndpoints.[n].endpoint.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"]
Hotline Device This tag is applicable for MGCP FXS ports,which supports PLAR.
  • Field Name: mEndpoints.[n].endpoint.hotlineDevice
  • Type: Boolean
  • Cardinality: [0..1]
Name * The device name,using only URL-friendly characters
  • Field Name: mEndpoints.[n].endpoint.name
  • Type: String
  • Cardinality: [1..1]
  • MaxLength: 128
Retry Video Call As Audio Default: True
  • Field Name: mEndpoints.[n].endpoint.retryVideoCallAsAudio
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Protocol Side * Side information is read-only except when creating a device Default: User
  • Field Name: mEndpoints.[n].endpoint.protocolSide
  • Type: String
  • Cardinality: [1..1]
  • Default: User
  • Choices: ["Network", "User"]
Trunk Selection Order *
  • Field Name: mEndpoints.[n].endpoint.trunkSelectionOrder
  • Type: String
  • Cardinality: [1..1]
  • Choices: ["Bottom Up", "Top Down"]
Mlpp Domain Id This setting only effects devices that support MLPP. Use -1 to set to null
  • Field Name: mEndpoints.[n].endpoint.mlppDomainId
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 128
Aar Neighborhood Name
  • Field Name: mEndpoints.[n].endpoint.aarNeighborhoodName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Location Name *
  • Field Name: mEndpoints.[n].endpoint.locationName
  • Type: String
  • Cardinality: [1..1]
Transmit Utf8
  • Field Name: mEndpoints.[n].endpoint.transmitUtf8
  • Type: Boolean
  • Cardinality: [0..1]
Cgpn Transformation Css Name
  • Field Name: mEndpoints.[n].endpoint.cgpnTransformationCssName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Automated Alternate Routing Css Name
  • Field Name: mEndpoints.[n].endpoint.automatedAlternateRoutingCssName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Device Pool Name *
  • Field Name: mEndpoints.[n].endpoint.devicePoolName
  • Type: ["String", "Null"]
  • Cardinality: [1..1]
Model Model ID string. Read Only
  • Field Name: mEndpoints.[n].endpoint.model
  • Type: String
  • Cardinality: [0..1]
  • Choices: ["Cisco 30 SP+", "Cisco 12 SP+", "Cisco 12 SP", "Cisco 12 S", "Cisco 30 VIP", "Cisco 7910", "Cisco 7960", "Cisco 7940", "Cisco 7935", "Cisco VGC Phone", "Cisco VGC Virtual Phone", "Cisco ATA 186", "EMCC Base Phone", "SCCP Phone", "Analog Access", "Digital Access", "Digital Access+", "Digital Access WS-X6608", "Analog Access WS-X6624", "VGC Gateway", "Conference Bridge", "Conference Bridge WS-X6608", "Cisco IOS Conference Bridge (HDV2)", "Cisco Conference Bridge (WS-SVC-CMM)", "H.323 Phone", "H.323 Gateway", "Music On Hold", "Device Pilot", "CTI Port", "CTI Route Point", "Voice Mail Port", "Cisco IOS Software Media Termination Point (HDV2)", "Cisco Media Server (WS-SVC-CMM-MS)", "Cisco Video Conference Bridge (IPVC-35xx)", "Cisco IOS Heterogeneous Video Conference Bridge", "Cisco IOS Guaranteed Audio Video Conference Bridge", "Cisco IOS Homogeneous Video Conference Bridge", "Route List", "Load Simulator", "Media Termination Point", "Media Termination Point Hardware", "Cisco IOS Media Termination Point (HDV2)", "Cisco Media Termination Point (WS-SVC-CMM)", "Cisco 7941", "Cisco 7971", "MGCP Station", "MGCP Trunk", "GateKeeper", "7914 14-Button Line Expansion Module", "Trunk", "Tone Announcement Player", "SIP Trunk", "SIP Gateway", "WSM Trunk", "Remote Destination Profile", "7915 12-Button Line Expansion Module", "7915 24-Button Line Expansion Module", "7916 12-Button Line Expansion Module", "7916 24-Button Line Expansion Module", "CKEM 36-Button Line Expansion Module", "SPA8800", "Unknown MGCP Gateway", "Unknown", "Cisco 7985", "Cisco 7911", "Cisco 7961G-GE", "Cisco 7941G-GE", "Motorola CN622", "Third-party SIP Device (Basic)", "Cisco 7931", "Cisco Unified Personal Communicator", "Cisco 7921", "Cisco 7906", "Third-party SIP Device (Advanced)", "Cisco TelePresence", "Nokia S60", "Cisco 7962", "Cisco 3951", "Cisco 7937", "Cisco 7942", "Cisco 7945", "Cisco 7965", "Cisco 7975", "Cisco 3911", "Cisco Unified Mobile Communicator", "Cisco TelePresence 1000", "Cisco TelePresence 3000", "Cisco TelePresence 3200", "Cisco TelePresence 500-37", "Cisco 7925", "Cisco 9971", "Cisco 6921", "Cisco 6941", "Cisco 6961", "Cisco Unified Client Services Framework", "Cisco TelePresence 1300-65", "Cisco TelePresence 1100", "Transnova S3", "BlackBerry MVS VoWifi", "Cisco 9951", "Cisco 8961", "Cisco 6901", "Cisco 6911", "Cisco ATA 187", "Cisco TelePresence 200", "Cisco TelePresence 400", "Cisco Dual Mode for iPhone", "Cisco 6945", "Cisco Dual Mode for Android", "Cisco 7926", "Cisco E20", "Generic Single Screen Room System", "Generic Multiple Screen Room System", "Cisco TelePresence EX90", "Cisco 8945", "Cisco 8941", "Generic Desktop Video Endpoint", "Cisco TelePresence 500-32", "Cisco TelePresence 1300-47", "Cisco 3905", "Cisco Cius", "VKEM 36-Button Line Expansion Module", "Cisco TelePresence TX1310-65", "Cisco TelePresence MCU", "Ascom IP-DECT Device", "Cisco TelePresence Exchange System", "Cisco TelePresence EX60", "Cisco TelePresence Codec C90", "Cisco TelePresence Codec C60", "Cisco TelePresence Codec C40", "Cisco TelePresence Quick Set C20", "Cisco TelePresence Profile 42 (C20)", "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 MX200", "Cisco TelePresence TX9000", "Cisco TelePresence TX9200", "Cisco 7821", "Cisco 7841", "Cisco 7861", "Cisco TelePresence SX20", "Cisco TelePresence MX300", "IMS-integrated Mobile (Basic)", "Third-party AS-SIP Endpoint", "Cisco Cius SP", "Cisco TelePresence Profile 42 (C40)", "Cisco VXC 6215", "CTI Remote Device", "Usage Profile", "Carrier-integrated Mobile", "Universal Device Template", "Cisco DX650", "Cisco Unified Communications for RTX", "Cisco Jabber for Tablet", "Cisco 8831", "Cisco ATA 190", "Cisco TelePresence SX10", "Cisco 8841", "Cisco 8851", "Cisco 8861", "Cisco TelePresence SX80", "Cisco TelePresence MX200 G2", "Cisco TelePresence MX300 G2", "Cisco 7905", "Cisco 7920", "Cisco 7970", "Cisco 7912", "Cisco 7902", "Cisco IP Communicator", "Cisco 7961", "Cisco 7936", "Analog Phone", "ISDN BRI Phone", "SCCP gateway virtual phone", "IP-STE", "Cisco TelePresence Conductor", "Cisco DX80", "Cisco DX70", "BEKEM 36-Button Line Expansion Module", "Cisco TelePresence MX700", "Cisco TelePresence MX800", "Cisco TelePresence IX5000", "Cisco 7811", "Cisco 8821", "Cisco 8811", "Interactive Voice Response", "Cisco 8845", "Cisco 8865", "Cisco TelePresence MX800 Dual", "Cisco 8851NR", "Cisco Spark Remote Device", "Cisco Webex DX80", "Cisco TelePresence DX70", "Cisco 7832", "Cisco 8865NR", "Cisco Meeting Server", "Cisco Webex Room Kit", "Cisco Webex Room 55", "Cisco Webex Room Kit Plus", "CP-8800-Video 28-Button Key Expansion Module", "CP-8800-Audio 28-Button Key Expansion Module", "Cisco 8832", "Cisco Webex Room 70 Single", "Cisco 8832NR", "Cisco ATA 191", "Cisco Collaboration Mobile Convergence", "Cisco Webex Room 70 Dual", "Cisco Webex Room Kit Pro", "Cisco Webex Room 55 Dual", "Cisco Webex Room 70 Single G2", "Cisco Webex Room 70 Dual G2", "SIP Station", "Cisco Webex Room Kit Mini", "Cisco Webex VDI Svc Framework", "Cisco Webex Board 55", "Cisco Webex Board 70", "Cisco Webex Board 85", "Cisco Webex Desk Pro", "Cisco Webex Room Panorama", "Cisco Webex Room 70 Panorama", "Cisco Webex Room Phone", "Cisco 860", "Cisco Webex Desk LE"]
Ime E164Transformation Name
  • Field Name: mEndpoints.[n].endpoint.imeE164TransformationName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Ime E164Directory Number
  • Field Name: mEndpoints.[n].endpoint.imeE164DirectoryNumber
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 16
Unit *
  • Field Name: mEndpoints.[n].unit
  • Type: Integer
  • Cardinality: [1..1]
Domain Name
  • Field Name: mEndpoints.[n].domainName
  • Type: String
  • Cardinality: [0..1]