[Index]

Model: relation/SingleNumberReachREL

Single Number Reach

Full HTML Help

Overview

Single number reach (SNR) is the remote destination number configured for a subscriber.

Note

While you can add one or more Remote Destination Profiles (RDP) to a subscriber, only one RDP may be added to a subscriber's SNR service.

View and Manage Single Number Reach

This procedure displays, moves, exports, and updates existing single number reach (SNR) remote destination profiles (RDPs), and adds new RDPs for SNR. For example, you can configure ring schedules, choose a mobility profile and a single number reach voicemail policy, or set up answer too soon / answer too late timers.

Pre-requisites:

To view, add, or update a subscriber's SNR:

  1. In the VOSS Automate Admin Portal, go to (default menu) Subscriber Management > Single Number Reach to open the Single Number Reach list view.

    Note

    You can also view a multi vendor subscriber's SNR details (line and mobile number) via (default menus) User Management > User Services > Multi Vendor Subscribers, then click the Edit icon (wrench) to update their SNR settings, or click the Delete icon to remove their SNR. See Multi Vendor Subscribers.



  2. View existing single number reach (SNR) profiles.

  3. Choose an option:

CUCM Single Number Reach (RDP / RD) based relation.

Model Details: relation/SingleNumberReachREL

Title Description Details
Protocol * Protocol option is read-only,except when creating a device.
  • Field Name: protocol
  • Type: String
  • Cardinality: [1..1]
  • Choices: ["SCCP", "Digital Access PRI", "H.225", "Analog Access", "Digital Access T1", "Route Point", "Unicast Bridge", "Multicast Point", "Inter-Cluster Trunk", "RAS", "Digital Access BRI", "SIP", "MGCP", "Static SIP Mobile Subscriber", "SIP Connector", "Remote Destination", "Mobile Smart Client", "Digital Access E1 R2", "CTI Remote Device", "Protocol Not Specified"]
Network Hold MOH Audio Source Choose the audio source from the IOS gateway that provides multicasting audio source for Cisco Unified Mobility and Mobile Voice Access calls.
  • Field Name: networkHoldMohAudioSourceId
  • Type: ["String", "Null", "Integer"]
  • Target: /api/device/cucm/MohAudioSource/choices/?field=sourceId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24992NrQq9GnM5jCSN%24AV%2BCIEwJ9ZCh95hrJ%2BAFLI0vlLXO9GNmGvoJxIkB4APNG1Y5k2vyxRdrTYqveIIoptxam9S%2BLQCux7J3c7Wvyo1oJmZMER5fwYSLAcge4hYnug9omgTkFdEr5ZsSz0Xtjhe1MfhnQT7A277mc73mpXGGpY4VBbAuRsXfhwZSnUuBuWdkf/QPPVNQXsN5kd6VQhI9dBqEZK8K0uUQRccqMQQUBW91fGp2t2AiFRWhUC/IZoQq4DxSayPI/ziJwLTWgQMuM1UXavdOjQwO2zS9VKOCJh82tF/k78trHArk53F7zAj9XC8i5AVIHHdi8wzGM7YvoIxYsd/XZmBHuqgyNQvo/MSugiOD1nyOLwpHHOllUG8nEDEHxvRh%2Bo1XSP/TDaW6v4An9ZEKq1yXTFYnNoc%3D%24%3D%3D
  • Target attr: sourceId
  • Target Model Type: device/cucm/MohAudioSource
  • Cardinality: [0..1]
  • Format: uri
  • Choices: []
User ID * Choose the user to whom this profile is assigned. The selection must match the ID of a user in the End User Configuration window where Enable Mobility is checked.
  • Field Name: userId
  • Type: ["String", "Null"]
  • Target: /api/device/cucm/User/choices/?field=userid&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24BbOz5pqamUHEFEeM%24DdQQSPQM9ZyKI91TLTICbSz4GGukByTF4DRWr2dPbNQ/ZKSaJ96K7DvjCTIthzgz9WiOwPCYk4xrsaUyu6lPxd%2BBrtg46IKm%2BMlfE6oDzKaxNeNBaTRhfRpDzl0/bM1av6adr0AZMKqaCJCXw/9dHdoc2%2BnpskppK/P8Uc/%2Bdyb%2BvxRlyTx3XrlTobrH19RFiuc2JeOmdtqQUQ9MCUXYzP4HXwu9mjNm%2B7%2BHLGttZkfnt5YUKZzDzbmC1ddTShkKTDXUTf6trOf4i5L9k5pLBUIWdfmp5VMVg4FCWLQoKDz9vMSwb6VlcAEEjdFvHj1yOwIV%2BB7A%2BJ1hy0SK5mzalc5n65phMxdOBttvg42kdLpV4xip063Divjb5IfGnShI0o3Bv10%3D%24%3D%3D
  • Target attr: userid
  • Target Model Type: device/cucm/User
  • Cardinality: [1..1]
  • Format: uri
  • Choices: []
User Hold Audio Source Choose the audio option for users on hold for Cisco Unified Mobility and Mobile Voice Access calls.
  • Field Name: userHoldMohAudioSourceId
  • Type: ["String", "Null", "Integer"]
  • Target: /api/device/cucm/MohAudioSource/choices/?field=sourceId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24992NrQq9GnM5jCSN%24AV%2BCIEwJ9ZCh95hrJ%2BAFLI0vlLXO9GNmGvoJxIkB4APNG1Y5k2vyxRdrTYqveIIoptxam9S%2BLQCux7J3c7Wvyo1oJmZMER5fwYSLAcge4hYnug9omgTkFdEr5ZsSz0Xtjhe1MfhnQT7A277mc73mpXGGpY4VBbAuRsXfhwZSnUuBuWdkf/QPPVNQXsN5kd6VQhI9dBqEZK8K0uUQRccqMQQUBW91fGp2t2AiFRWhUC/IZoQq4DxSayPI/ziJwLTWgQMuM1UXavdOjQwO2zS9VKOCJh82tF/k78trHArk53F7zAj9XC8i5AVIHHdi8wzGM7YvoIxYsd/XZmBHuqgyNQvo/MSugiOD1nyOLwpHHOllUG8nEDEHxvRh%2Bo1XSP/TDaW6v4An9ZEKq1yXTFYnNoc%3D%24%3D%3D
  • Target attr: sourceId
  • Target Model Type: device/cucm/MohAudioSource
  • Cardinality: [0..1]
  • Format: uri
  • Choices: []
Calling Search Space Choose the calling search space to be used for routing Mobile Voice Access or Enterprise Feature Access calls. Note    This calling search space setting applies only when you are routing calls from the remote destination, which specifies the outbound call leg to the dialed number for Mobile Voice Access and Enterprise Feature Access calls.
  • Field Name: callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: /api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24JgWTT3apnjL7yiA2%243xPpu5ElSQm7qDbg1XqqBeW%2ByAOyVTU97D8FjqueuoDhHH6CnB0eOdhfd7DqwaBeXsynfTtbJmq1sT8xf/KNwzaLenmUTuUfSBMMgM9IDJXhope6AtZVdLUq54tAgGyh4QU%2Bz5b2kbKdvwjytcsbVf/OgxBSgP8Kqxt1/lSv8gTxnKRaPvYenWbgitate1ex0qax5HyUD%2BjRFJOo2i/PVwGe9DikUML2AIhy%2BDM3TFLcctffkI1fEenkHvSBIqCDiNinpf8U3Otrdq9PS3GzTJg8xQJMVT6FZyJVPnWj3Hraokv6vYqD9T6CtOh4QD%2BgyYV/u1275TBvGbPyB7UBvGqFJYZpTp5Q%2BPvrpkisztF2lyQjU6uhq5/syItlT4Vuu5s%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: device/cucm/Css
  • Cardinality: [0..1]
  • Format: uri
  • Choices: []
Mobile Smart Client Profile Name
  • Field Name: mobileSmartClientProfileName
  • Type: ["String", "Null"]
  • Target: /api/device/cucm/MobileSmartClientProfile/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%2495Xe7g13vqIOpCc9%24v4SEW7sAcBufFymDbWEJ1TGXNlqZtWmwzhZ1EtZK66bv0xVGJuselte5cVmDoOo/0WxDpksZ/LClZq613fW%2BqhClL6Xjk6O9TQ8I1eqMRzESYTLQFFql92TLb5AbXKP4X2uK1VuGPerB5clV9647JTNa6xZL/Ois6NHwHfrdnRnCFApWx4YP9hNIgJupONipoeVjfKCk6HseAu%2B8lz6L/hCJYGCqcpTR0jgScTAdKp7oZIcFCpzAa7i5Nqj1ibW/TkoPk7BfT8WIvYvWJBsq3iYYSZolvWCB1WhjhSvJHn9hXb9eawDn6wVV0hnWk0woCj3HhcrmHVKU7R4Ot9JquL67iqi6TezCRfEtlnA%2B7JxbJCuyvAYyxT/fIsQ4eDA83K2aPZJtYp2i7s35sc11/4i0bXN/7Hk%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: device/cucm/MobileSmartClientProfile
  • Cardinality: [0..1]
  • Format: uri
  • Choices: []
Network Locale
  • Field Name: networkLocale
  • Type: ["String", "Null"]
  • Target: /api/device/cucm/Country/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24fraImZ8iDXZ8vzwH%2412On77uhwZzvyJRV36ctZmCzqSfmfaY/fJDCSzMAH/Pgl4Jh9UnZFGPGM3rxn8t3VyqMHxdI23D7kIoFKHErNSDRIiZCaVTcLz8ohm5gRo8cMjb1Xmdo4EjbGYBx6lRdATwC2Jr/scvoHzzwo5Ah%2B4dzj5VsQeMUgt7zORzUqgp4JL85ai3kO3TFIksvQ9GNsDiPcQ4d5OlaU5593nXyIPWmibKKw4aEKbeu%2B9700LIzOgN2sL84TMTSGMXLbK29lzIXxnrHEb%2BwTurZRocWubTlrxE65esUK3mJOyny8Tj0OV2e9wZnCFXsDM%2BltV6NS46hm/yApGRgoQT6r1ARQOBcOn6XdbVhVdcwBcsPCwF6qs7ySkpMmQFB8tnKF21fniiFc60D%24%3D%3D
  • Target attr: name
  • Target Model Type: device/cucm/Country
  • Cardinality: [0..1]
  • Format: uri
  • Choices: []
Use Device Pool Calling Party Transformation CSS To use the Calling Party Transformation CSS that is configured in the device pool that is assigned to this device, check this check box. If you do not check this check box, the device uses the Calling Party Transformation CSS that you configured in the Remote Destination Profile Configuration window. Default: True
  • Field Name: useDevicePoolCgpnTransformCss
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Product * Product ID string. read-only except when creating a device.
  • Field Name: product
  • Type: String
  • Cardinality: [1..1]
  • Choices: ["7914 14-Button Line Expansion Module", "7915 12-Button Line Expansion Module", "7915 24-Button Line Expansion Module", "7916 12-Button Line Expansion Module", "7916 24-Button Line Expansion Module", "AIM-VOICE-30", "Analog Phone", "Annunciator", "BEKEM 36-Button Line Expansion Module", "C881V", "C887VA-V", "CKEM 36-Button Line Expansion Module", "CP-8800-Audio 28-Button Key Expansion Module", "CP-8800-Video 28-Button Key Expansion Module", "CTI Port", "CTI Remote Device", "CTI Route Point", "Carrier-integrated Mobile", "Cisco IAD2400", "Cisco 12 S", "Cisco 12 SP", "Cisco 12 SP+", "Cisco 1751", "Cisco 1760", "Cisco 1861", "Cisco 269X", "Cisco 26XX", "Cisco 2801", "Cisco 2811", "Cisco 2821", "Cisco 2851", "Cisco 2901", "Cisco 2911", "Cisco 2921", "Cisco 2951", "Cisco 30 SP+", "Cisco 30 VIP", "Cisco 362X", "Cisco 364X", "Cisco 366X", "Cisco 3725", "Cisco 3745", "Cisco 3825", "Cisco 3845", "Cisco 3905", "Cisco 3911", "Cisco 3925", "Cisco 3925E", "Cisco 3945", "Cisco 3945E", "Cisco 3951", "Cisco 6901", "Cisco 6911", "Cisco 6921", "Cisco 6941", "Cisco 6945", "Cisco 6961", "Cisco 7811", "Cisco 7821", "Cisco 7832", "Cisco 7841", "Cisco 7861", "Cisco 7902", "Cisco 7905", "Cisco 7906", "Cisco 7910", "Cisco 7911", "Cisco 7912", "Cisco 7920", "Cisco 7921", "Cisco 7925", "Cisco 7926", "Cisco 7931", "Cisco 7935", "Cisco 7936", "Cisco 7937", "Cisco 7940", "Cisco 7941", "Cisco 7941G-GE", "Cisco 7942", "Cisco 7945", "Cisco 7960", "Cisco 7961", "Cisco 7961G-GE", "Cisco 7962", "Cisco 7965", "Cisco 7970", "Cisco 7971", "Cisco 7975", "Cisco 7985", "Cisco 860", "Cisco 881", "Cisco 8811", "Cisco 8821", "Cisco 8831", "Cisco 8832", "Cisco 8832NR", "Cisco 8841", "Cisco 8845", "Cisco 8851", "Cisco 8851NR", "Cisco 8861", "Cisco 8865", "Cisco 8865NR", "Cisco 888/887/886", "Cisco 8941", "Cisco 8945", "Cisco 8961", "Cisco 9951", "Cisco 9971", "Cisco ATA 186", "Cisco ATA 187", "Cisco ATA 190", "Cisco ATA 191", "Cisco C8200/L-1N-4T", "Cisco C8300-1N1S-4T2X", "Cisco C8300-1N1S-6T", "Cisco C8300-2N2S-4T2X/6T", "Cisco Catalyst 4000 Access Gateway Module", "Cisco Catalyst 4224 Voice Gateway Switch", "Cisco Catalyst 6000 12 port FXO Gateway", "Cisco Catalyst 6000 24 port FXS Gateway", "Cisco Catalyst 6000 E1 VoIP Gateway", "Cisco Catalyst 6000 T1 VoIP Gateway", "Cisco Cius", "Cisco Cius SP", "Cisco Collaboration Mobile Convergence", "Cisco Conference Bridge (WS-SVC-CMM)", "Cisco Conference Bridge Hardware", "Cisco Conference Bridge Software", "Cisco DX650", "Cisco DX70", "Cisco DX80", "Cisco Dual Mode for Android", "Cisco Dual Mode for iPhone", "Cisco E20", "Cisco ENCS 5400 ISRV", "Cisco IOS Conference Bridge", "Cisco IOS Enhanced Conference Bridge", "Cisco IOS Enhanced Media Termination Point", "Cisco IOS Enhanced Software Media Termination Point", "Cisco IOS Guaranteed Audio Video Conference Bridge", "Cisco IOS Heterogeneous Video Conference Bridge", "Cisco IOS Homogeneous Video Conference Bridge", "Cisco IOS Media Termination Point", "Cisco IP Communicator", "Cisco ISR 4321", "Cisco ISR 4331", "Cisco ISR 4351", "Cisco ISR 4431", "Cisco ISR 4451", "Cisco ISR 4461", "Cisco Jabber for Tablet", "Cisco MGCP BRI Port", "Cisco MGCP E1 Port", "Cisco MGCP FXO Port", "Cisco MGCP FXS Port", "Cisco MGCP T1 Port", "Cisco Media Server (WS-SVC-CMM-MS)", "Cisco Media Termination Point (WS-SVC-CMM)", "Cisco Media Termination Point Hardware", "Cisco Media Termination Point Software", "Cisco Meeting Server", "Cisco SIP FXS Port", "Cisco Spark Remote Device", "Cisco TelePresence", "Cisco TelePresence 1000", "Cisco TelePresence 1100", "Cisco TelePresence 1300-47", "Cisco TelePresence 1300-65", "Cisco TelePresence 200", "Cisco TelePresence 3000", "Cisco TelePresence 3200", "Cisco TelePresence 400", "Cisco TelePresence 500-32", "Cisco TelePresence 500-37", "Cisco TelePresence Codec C40", "Cisco TelePresence Codec C60", "Cisco TelePresence Codec C90", "Cisco TelePresence Conductor", "Cisco TelePresence DX70", "Cisco TelePresence EX60", "Cisco TelePresence EX90", "Cisco TelePresence Exchange System", "Cisco TelePresence IX5000", "Cisco TelePresence MCU", "Cisco TelePresence MX200", "Cisco TelePresence MX200 G2", "Cisco TelePresence MX300", "Cisco TelePresence MX300 G2", "Cisco TelePresence MX700", "Cisco TelePresence MX800", "Cisco TelePresence MX800 Dual", "Cisco TelePresence Profile 42 (C20)", "Cisco TelePresence Profile 42 (C40)", "Cisco TelePresence Profile 42 (C60)", "Cisco TelePresence Profile 52 (C40)", "Cisco TelePresence Profile 52 (C60)", "Cisco TelePresence Profile 52 Dual (C60)", "Cisco TelePresence Profile 65 (C60)", "Cisco TelePresence Profile 65 Dual (C90)", "Cisco TelePresence Quick Set C20", "Cisco TelePresence SX10", "Cisco TelePresence SX20", "Cisco TelePresence SX80", "Cisco TelePresence TX1310-65", "Cisco TelePresence TX9000", "Cisco TelePresence TX9200", "Cisco Unified Client Services Framework", "Cisco Unified Communications for RTX", "Cisco Unified Mobile Communicator", "Cisco Unified Personal Communicator", "Cisco VG200", "Cisco VG248 Gateway", "Cisco VGC Phone", "Cisco VGC Virtual Phone", "Cisco VGD-1T3", "Cisco VXC 6215", "Cisco Video Conference Bridge(IPVC-35xx)", "Cisco Voice Mail Port", "Cisco Webex Board 55", "Cisco Webex Board 70", "Cisco Webex Board 85", "Cisco Webex DX80", "Cisco Webex Desk LE", "Cisco Webex Desk Pro", "Cisco Webex Room 55", "Cisco Webex Room 55 Dual", "Cisco Webex Room 70 Dual", "Cisco Webex Room 70 Dual G2", "Cisco Webex Room 70 Panorama", "Cisco Webex Room 70 Single", "Cisco Webex Room 70 Single G2", "Cisco Webex Room Kit", "Cisco Webex Room Kit Mini", "Cisco Webex Room Kit Plus", "Cisco Webex Room Kit Pro", "Cisco Webex Room Panorama", "Cisco Webex Room Phone", "Cisco Webex VDI Svc Framework", "Communication Media Module", "EMCC Base Phone", "FLEX_SLOT", "Gatekeeper", "Generic Desktop Video Endpoint", "Generic Multiple Screen Room System", "Generic Single Screen Room System", "H.225 Trunk (Gatekeeper Controlled)", "H.323 Client", "H.323 Gateway", "Hunt List", "IAD2400_ANALOG", "IAD2400_DIGITAL", "IMS-integrated Mobile (Basic)", "IP-STE", "ISDN BRI Phone", "Inter-Cluster Trunk (Gatekeeper Controlled)", "Inter-Cluster Trunk (Non-Gatekeeper Controlled)", "Interactive Voice Response", "Load Simulator", "Motorola CN622", "Music On Hold", "NM-1V", "NM-2V", "NM-4VWIC-MBRD", "NM-HD-1V", "NM-HD-2V", "NM-HD-2VE", "NM-HDA", "NM-HDV", "NM-HDV2-0PORT", "NM-HDV2-1PORT", "NM-HDV2-2PORT", "Nokia S60", "PA-MCX", "PA-VXA", "PA-VXB", "PA-VXC", "Pilot", "Remote Destination Profile", "Route List", "SCCP Device", "SCCP gateway virtual phone", "SIP Trunk", "SIP WSM Connection", "SPA8800", "Third-party AS-SIP Endpoint", "Third-party SIP Device (Advanced)", "Third-party SIP Device (Basic)", "Transnova S3", "Universal Device Template", "Unknown", "VG202", "VG204", "VG224", "VG310", "VG320", "VG350", "VG400", "VG420", "VG450", "VGC Port", "VIC_SLOT", "VKEM 36-Button Line Expansion Module", "VNM-HDA", "VWIC_SLOT", "WS-SVC-CMM-MS", "WS-X6600"]
Description Enter a text description of the remote destination profile. This field can comprise up to 128 characters. You can use all characters except quotes (“), close angle bracket (>), open angle bracket (<), backslash (\), ampersand (&), and percent sign (%).
  • Field Name: description
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Ignore Presentation Indicators (internal calls only) Check the check box if you want to ignore the connected line ID presentation. Use this configuration for internal calls.
  • Field Name: ignorePresentationIndicators
  • Type: Boolean
  • Cardinality: [0..1]
User Locale From the drop-down list box, choose the locale that is associated with the phone user interface. The user locale identifies a set of detailed information, including language and font, to support users. Cisco Unified Communications Manager makes this field available only for phone models that support localization. Note    If the users require information to display (on the phone) in any language other than English, verify that the locale installer is installed before you configure user locale. See the Cisco Unified Communications Manager Locale Installer documentation.
  • Field Name: userLocale
  • Type: ["String", "Null"]
  • Target: /api/device/cucm/UserLocale/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24RkHoagBOL3NMfIRv%24sHN5kq5vgd5zzB86687ah59m8PYJvOpZ6Ci7Tf%2BBi4CJU42EvRe/d5Qq3Ezz0N20dfnv1GpF0rDqLdF8fRXjsNLHkhkPOt7iDH225nOliQ/giwnIfEFSaW52rQKJrh67Osb12nUHeP6QqR4bkZecTHdOomd/DeJ1FqP3bXTgaAzRD8c61hizh6hU%2B16IvfcBx3Zmwc4MrGS2reJxQJ71RbmOgTMYCQ32BLoBIQG6Hc4Al9IfUD5fieaZ0q6JHFBMZ34l0WUZxLUSGfNdyzYHxo1/wOjqRz6IXPhvOpUjnBQ9cbIuxtE6rrTOdiB%2BCHdB3Aqym/fuFywaOIh%2BxF9Ddm6XAQBsR2prhXkHygdOSMvCEgj3d0gDDnK56RFnX4PuIOv38erlNiqR%24%3D%3D
  • Target attr: name
  • Target Model Type: device/cucm/UserLocale
  • Cardinality: [0..1]
  • Format: uri
  • Choices: []
Class * Class ID string. Class information is read-only except when creating a device.
  • Field Name: class
  • Type: String
  • Cardinality: [1..1]
  • Choices: ["Phone", "Gateway", "Conference Bridge", "Media Termination Point", "Route List", "Voice Mail", "CTI Route Point", "Music On Hold", "Simulation", "Pilot", "GateKeeper", "Add-on modules", "Hidden Phone", "Trunk", "Tone Announcement Player", "Remote Destination Profile", "EMCC Base Phone Template", "EMCC Base Phone", "Remote Destination Profile Template", "Gateway Template", "UDP Template", "Phone Template", "Device Profile", "Invalid", "Interactive Voice Response"]
Primary Phone Name
  • Field Name: primaryPhoneName
  • Type: ["String", "Null"]
  • Target: /api/device/cucm/Phone/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24zfjMgfgMAQZLAphw%24Gab1Ey0ac0QuLVAEHYhgDVOvxF84MsHP9fLKrWWoplJL/YC5BBHuLPFhyK81XiKqyx7DOE5Bx4Xmx624XESfszPpsN1itilkLMtf9qHfgL3dEp0Fz1CXQ7cUvp/a2IW4chwhLthG8P7sOGOjMU7WWriQqiUcQf9iR2keqdoSSP4e7ChXpYPG3cRbKlyP90Lj%2BkWXFce6YM9awvK6FferBDoyq%2B%2BEi6/ePjWFGAiFWLsbQxsrsR1TnwACT8I0AB9W2PpZZb5aaMOLKy2UPY81iRUQAllhN%2BF%2BrYLbB%2BJYWb63egV8umwNQsRiemFDT67TUcYKbTOLU/L/LZUF9ire6/KNEDqHmvySX0xG/HEXdW4e0x6n4R8MAIsJOlilgdCNtQh60Q%3D%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: device/cucm/Phone
  • Cardinality: [0..1]
  • Format: uri
  • Choices: []
Dnd Option This Call Reject option specifies that no incoming call information gets presented to the user. Note    For mobile devices, dual-mode phones, and phones that are running SCCP, you can only choose the Call Reject option. When you activate DND Call Reject on a mobile device or dual-mode phone, no call information gets presented to the device. Default: Ringer Off
  • Field Name: dndOption
  • Type: String
  • Cardinality: [0..1]
  • Default: Ringer Off
  • Choices: ["Ringer Off", "Call Reject", "Use Common Phone Profile Setting"]
Dnd Status Check this check box to enable Do Not Disturb on the phone.
  • Field Name: dndStatus
  • Type: Boolean
  • Cardinality: [0..1]
Name * Enter a text name for the remote destination profile. This name can comprise up to 50 characters. Valid characters include letters, numbers, dashes, dots (periods), spaces, and underscores.
  • Field Name: name
  • Type: String
  • Cardinality: [1..1]
Privacy * Choose a privacy option for the remote destination profile. If you choose the Default value for this field, the setting matches the value of the Privacy Setting service parameter. Note    If you change and save the value of the Privacy Setting service parameter, you must return to the Remote Destination Profile Configuration window for a remote destination profile that specifies Default and click Save for the service parameter change to take effect. Note    You cannot transfer a call from a cell phone to a desk phone if the Remote Destination Profile Privacy specifies On, and the "Enforce Privacy Setting on Held Calls" service parameter specifies True. Default: Default
  • Field Name: callInfoPrivacyStatus
  • Type: String
  • Cardinality: [1..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Rerouting Calling Search Space Choose a calling search space to be used to route Cisco Unified Mobility calls. Note    Ensure that the gateway that is configured for routing mobile calls is assigned to the partition that belongs to the Rerouting Calling Search Space. Cisco Unified Communications Manager determines how to route calls based on the remote destination number and the Rerouting Calling Search Space. Note    The Rerouting Calling Search Space setting applies only when you are routing calls to the remote destination or mobility identity, which specifies the outbound call leg toward the remote destination or mobility identity when a call comes in to the user enterprise number. Note    Cisco Unified Mobility calls do not get routed to the dual-mode mobility identity number that corresponds to the dual-mode mobile phone number if the device associates with the enterprise WLAN and registers with Cisco Unified Communications Manager. Cisco Unified Mobility calls get routed to the dual-mode mobility identity number only when the device is outside the enterprise.
  • Field Name: rerouteCallingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: /api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24JgWTT3apnjL7yiA2%243xPpu5ElSQm7qDbg1XqqBeW%2ByAOyVTU97D8FjqueuoDhHH6CnB0eOdhfd7DqwaBeXsynfTtbJmq1sT8xf/KNwzaLenmUTuUfSBMMgM9IDJXhope6AtZVdLUq54tAgGyh4QU%2Bz5b2kbKdvwjytcsbVf/OgxBSgP8Kqxt1/lSv8gTxnKRaPvYenWbgitate1ex0qax5HyUD%2BjRFJOo2i/PVwGe9DikUML2AIhy%2BDM3TFLcctffkI1fEenkHvSBIqCDiNinpf8U3Otrdq9PS3GzTJg8xQJMVT6FZyJVPnWj3Hraokv6vYqD9T6CtOh4QD%2BgyYV/u1275TBvGbPyB7UBvGqFJYZpTp5Q%2BPvrpkisztF2lyQjU6uhq5/syItlT4Vuu5s%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: device/cucm/Css
  • Cardinality: [0..1]
  • Format: uri
  • Choices: []
Protocol Side * Side information is read-only except when creating a device Default: User
  • Field Name: protocolSide
  • Type: String
  • Cardinality: [1..1]
  • Default: User
  • Choices: ["Network", "User"]
Lines
  • Field Name: lines
  • Type: ["Null", "Object"]
  • Cardinality: [0..1]
Line An XLine is an entry in the DeviceNumPlanMap table. The actual directory number is referenced inside the XLine object by the "dirn" or "dirnId" element.
  • Field Name: line.[n]
  • Type: Array
Display Ascii
  • Field Name: lines.line.[n].displayAscii
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
Associated Endusers
  • Field Name: associatedEndusers
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Enduser
  • Field Name: enduser.[n]
  • Type: Array
User Id *
  • Field Name: lines.line.[n].associatedEndusers.enduser.[n].userId
  • Type: ["String", "Null"]
  • Target: /api/device/cucm/User/choices/?field=userid&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24BbOz5pqamUHEFEeM%24DdQQSPQM9ZyKI91TLTICbSz4GGukByTF4DRWr2dPbNQ/ZKSaJ96K7DvjCTIthzgz9WiOwPCYk4xrsaUyu6lPxd%2BBrtg46IKm%2BMlfE6oDzKaxNeNBaTRhfRpDzl0/bM1av6adr0AZMKqaCJCXw/9dHdoc2%2BnpskppK/P8Uc/%2Bdyb%2BvxRlyTx3XrlTobrH19RFiuc2JeOmdtqQUQ9MCUXYzP4HXwu9mjNm%2B7%2BHLGttZkfnt5YUKZzDzbmC1ddTShkKTDXUTf6trOf4i5L9k5pLBUIWdfmp5VMVg4FCWLQoKDz9vMSwb6VlcAEEjdFvHj1yOwIV%2BB7A%2BJ1hy0SK5mzalc5n65phMxdOBttvg42kdLpV4xip063Divjb5IfGnShI0o3Bv10%3D%24%3D%3D
  • Target attr: userid
  • Target Model Type: device/cucm/User
  • Cardinality: [1..1]
  • Format: uri
  • Choices: []
Ring Setting Default: Ring
  • Field Name: lines.line.[n].ringSetting
  • Type: String
  • Cardinality: [0..1]
  • Default: Ring
  • Choices: ["Use System Default", "Disable", "Flash Only", "Ring Once", "Ring", "Beep Only"]
Consecutive Ring Setting Consecutive Rings Setting. Replaces the consective ring setting on IPPhone. Default: Use System Default
  • Field Name: lines.line.[n].consecutiveRingSetting
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • Default: Use System Default
  • Choices: ["Use System Default", "Disable", "Flash Only", "Ring Once", "Ring", "Beep Only"]
Recording Profile Name
  • Field Name: lines.line.[n].recordingProfileName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Index
  • Field Name: lines.line.[n].index
  • Type: Integer
  • Cardinality: [1..1]
Ring Setting Active Pickup Alert Applicable only for IP Phones Default: Use System Default
  • Field Name: lines.line.[n].ringSettingActivePickupAlert
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • Default: Use System Default
  • Choices: ["Use System Default", "Disable", "Flash Only", "Ring Once", "Ring", "Beep Only"]
Label
  • Field Name: lines.line.[n].label
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Recording Media Source Default: Gateway Preferred
  • Field Name: lines.line.[n].recordingMediaSource
  • Type: String
  • Cardinality: [0..1]
  • Default: Gateway Preferred
  • Choices: ["Gateway Preferred", "Phone Preferred"]
Max Num Calls Default: 2
  • Field Name: lines.line.[n].maxNumCalls
  • Type: Integer
  • Cardinality: [0..1]
  • Default: 2
Partition Usage This tag cannot be modified. It can only be specified in the add request. Default: General
  • Field Name: lines.line.[n].partitionUsage
  • Type: String
  • Cardinality: [0..1]
  • Default: General
  • Choices: ["Intercom", "Call Control Discovery Learned Pattern", "General", "Directory URI"]
Recording Flag Default: Call Recording Disabled
  • Field Name: lines.line.[n].recordingFlag
  • Type: String
  • Cardinality: [0..1]
  • Default: Call Recording Disabled
  • Choices: ["Call Recording Disabled", "Automatic Call Recording Enabled", "Selective Call Recording Enabled"]
Speed Dial
  • Field Name: lines.line.[n].speedDial
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Monitoring Css Name
  • Field Name: lines.line.[n].monitoringCssName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
E164Mask
  • Field Name: lines.line.[n].e164Mask
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 255
Missed Call Logging Default: True
  • Field Name: lines.line.[n].missedCallLogging
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Call Info Display
  • Field Name: callInfoDisplay
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Dialed Number Default: True
  • Field Name: lines.line.[n].callInfoDisplay.dialedNumber
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Redirected Number
  • Field Name: lines.line.[n].callInfoDisplay.redirectedNumber
  • Type: Boolean
  • Cardinality: [0..1]
Caller Number
  • Field Name: lines.line.[n].callInfoDisplay.callerNumber
  • Type: Boolean
  • Cardinality: [0..1]
Caller Name Default: True
  • Field Name: lines.line.[n].callInfoDisplay.callerName
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Dirn Only uuid attribute is returned in response
  • Field Name: dirn
  • Type: ["Object", "Null"]
  • Cardinality: [1..1]
Inventory Filter Default: default
  • Field Name: lines.line.[n].dirn.line_filter
  • Type: String
  • Default: default
  • Choices: ["Default", "Show Unused Numbers (Site Only)", "Show Unused Numbers", "Show Unused Numbers with Associated E164's (Site Only)", "Show Unused Numbers with Associated E164's", "Show Used Numbers (Site Only)", "Show Used Numbers", "Show Numbers belonging to this Subscriber"]
Pattern *
  • Field Name: lines.line.[n].dirn.pattern
  • Type: String
  • Cardinality: [1..1]
Route Partition Name *
  • Field Name: lines.line.[n].dirn.routePartitionName
  • Type: ["String", "Null"]
  • Target: /api/device/cucm/RoutePartition/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24sq5rVgKueCuyaTG1%24K2RJ87SuhN9c5N9tWMLa6HlrZfRcNQaFui7gaAQdekD6otOyxWhoqwiLlWvexH43H6VzyfZRMHhX4BZe%2BUW6YELxreGiyw2YgUTvTuKLtRWEA3ciAFKLUX/WGLxD5L/RfpC/Ra5wUjsyKrxm2BBwhmSe3aYVkpxamSZvy/DiNGvAsrA3/pt7AM%2B9PzlSCCnId1JY82pRf3a%2BBS75WFFn3BbnQzDNiGfHDvzBuWc8PvHVFCulsIYcqUnX6yvv1bDbnVOeZjYkCAAC3Uxlx2aKyCXUZwVmzI8ie93bARtA%2BroMrg96Xl8Pg0a5hEhjzO0Y9qqe5McOX8%2BgIgJnAo2iYTR2xZ5tSBP6DnJ9/3RkZSyUkRdocEQqT8A6YkqcOGNSi661zq2VzQ%2BfthHYiQ%3D%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: device/cucm/RoutePartition
  • Cardinality: [1..1]
  • Format: uri
  • Choices: []
Mwl Policy Default: Use System Policy
  • Field Name: lines.line.[n].mwlPolicy
  • Type: String
  • Cardinality: [0..1]
  • Default: Use System Policy
  • Choices: ["Use System Policy", "Light and Prompt", "Prompt Only", "Light Only", "None"]
Ring Setting Idle Pickup Alert Applicable only for IP Phones Default: Use System Default
  • Field Name: lines.line.[n].ringSettingIdlePickupAlert
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • Default: Use System Default
  • Choices: ["Use System Default", "Disable", "Flash Only", "Ring Once", "Ring", "Beep Only"]
Busy Trigger Default: 1
  • Field Name: lines.line.[n].busyTrigger
  • Type: Integer
  • Cardinality: [0..1]
  • Default: 1
Audible Mwi Not applicable for gatewayEndpointAnalogAccess and CiscoCatalyst600024PortFXSGateway Default: Default
  • Field Name: lines.line.[n].audibleMwi
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • Choices: ["Off", "On", "Default"]
Display
  • Field Name: lines.line.[n].display
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 50
Calling Party Transformation CSS Choose the calling search space for transformations. This setting allows you to localize the calling party number on the device. Make sure that the Calling Party Transformation CSS that you choose contains the calling party transformation pattern that you want to assign to this device. Note    The partitions in the calling search space should contain only calling party transformations. Note    Ensure the calling search space is not null because no transformations can apply to null partitions. Note    The device takes on the attributes of the Calling Party Transformation Pattern because you assign the pattern to a partition where the Calling Party Transformation CSS exists. For example, when you configure the Calling Party Transformation CSS under Call Routing > Class of Control > Calling Search Space, you assign the CSS to a partition; when you configure the Calling Party Transformation CSS under Call Routing > Transformation Pattern > Calling Party Transformation Pattern, you choose the partition where the Calling Party Transformation CSS is assigned.
  • Field Name: cgpnTransformationCssName
  • Type: ["String", "Null"]
  • Target: /api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24JgWTT3apnjL7yiA2%243xPpu5ElSQm7qDbg1XqqBeW%2ByAOyVTU97D8FjqueuoDhHH6CnB0eOdhfd7DqwaBeXsynfTtbJmq1sT8xf/KNwzaLenmUTuUfSBMMgM9IDJXhope6AtZVdLUq54tAgGyh4QU%2Bz5b2kbKdvwjytcsbVf/OgxBSgP8Kqxt1/lSv8gTxnKRaPvYenWbgitate1ex0qax5HyUD%2BjRFJOo2i/PVwGe9DikUML2AIhy%2BDM3TFLcctffkI1fEenkHvSBIqCDiNinpf8U3Otrdq9PS3GzTJg8xQJMVT6FZyJVPnWj3Hraokv6vYqD9T6CtOh4QD%2BgyYV/u1275TBvGbPyB7UBvGqFJYZpTp5Q%2BPvrpkisztF2lyQjU6uhq5/syItlT4Vuu5s%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: device/cucm/Css
  • Cardinality: [0..1]
  • Format: uri
  • Choices: []
Calling Search Space AAR Choose a calling search space to be used to route Cisco Unified Mobility calls. Note    Ensure that the gateway that is configured for routing mobile calls is assigned to the partition that belongs to the Rerouting Calling Search Space. Cisco Unified Communications Manager determines how to route calls based on the remote destination number and the Rerouting Calling Search Space. Note    The Rerouting Calling Search Space setting applies only when you are routing calls to the remote destination or mobility identity, which specifies the outbound call leg toward the remote destination or mobility identity when a call comes in to the user enterprise number. Note    Cisco Unified Mobility calls do not get routed to the dual-mode mobility identity number that corresponds to the dual-mode mobile phone number if the device associates with the enterprise WLAN and registers with Cisco Unified Communications Manager. Cisco Unified Mobility calls get routed to the dual-mode mobility identity number only when the device is outside the enterprise.
  • Field Name: automatedAlternateRoutingCssName
  • Type: ["String", "Null"]
  • Target: /api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24JgWTT3apnjL7yiA2%243xPpu5ElSQm7qDbg1XqqBeW%2ByAOyVTU97D8FjqueuoDhHH6CnB0eOdhfd7DqwaBeXsynfTtbJmq1sT8xf/KNwzaLenmUTuUfSBMMgM9IDJXhope6AtZVdLUq54tAgGyh4QU%2Bz5b2kbKdvwjytcsbVf/OgxBSgP8Kqxt1/lSv8gTxnKRaPvYenWbgitate1ex0qax5HyUD%2BjRFJOo2i/PVwGe9DikUML2AIhy%2BDM3TFLcctffkI1fEenkHvSBIqCDiNinpf8U3Otrdq9PS3GzTJg8xQJMVT6FZyJVPnWj3Hraokv6vYqD9T6CtOh4QD%2BgyYV/u1275TBvGbPyB7UBvGqFJYZpTp5Q%2BPvrpkisztF2lyQjU6uhq5/syItlT4Vuu5s%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: device/cucm/Css
  • Cardinality: [0..1]
  • Format: uri
  • Choices: []
Device Pool * Choose the device pool that applies to this profile. The device pool defines sets of common characteristics for devices, such as region, date/time group, softkey template, and MLPP information.
  • Field Name: devicePoolName
  • Type: ["String", "Null"]
  • Target: /api/device/cucm/DevicePool/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24d60hDrkPzWrCtjUE%24sDSQZLghZHdonLnGZEd/C0OJo5E9SbqaR1Z4gpErtn37KF2H756RKeGwIpoJrr3S6w%2Bc/D7gFcZOFg1tYTOP4/sFBT7g7BsYfgxdRn1tIomaVXkeJCysGBU2b8UuWEJ5a%2BWXsFintAy9ZaKzwesTOaJa4mh7D8yicpRrCAHpbefJMEZs9n2qCUVO5Gn3EMb%2B0IfbRIxhaa3IhWZ%2BqS8P%2BfKfooGLkFccbfXJ86C/%2B4UpqWwTy57KplpdUjBz5KYRwXOF4iqzmkz6vfo2I6D%2B2RtxusdHp5OatU4ZRjn25ZWiap3Zi/9AP/tQUqGPymeunviSmExauWbWfo8eHe3qPkV3TVsWBDmC9151RlJk4Bk3ddfW9y9skKUjKQCGRQi6rTYGA7B94GPy%24%3D%3D
  • Target attr: name
  • Target Model Type: device/cucm/DevicePool
  • Cardinality: [1..1]
  • Format: uri
  • Choices: []
Destination
  • Field Name: Destination.[n]
  • Type: Array
Enable Extend And Connect While UPDATE set it to false if you want to delete Enable Extend and Connect.Use only while update
  • Field Name: Destination.[n].enableExtendAndConnect
  • Type: Boolean
  • Cardinality: [0..1]
Dial Via Office Reverse Voicemail Configures how dual mode device users answer Dial-via-Office Reverse (DVO-R) calls that terminate on the Mobile Identity (MI). This feature provides users with a single enterprise voicemail box for their enterprise mobility if the RD call reaches an external voice mail system. Available options are as follows: Use System Default Timer Control User Control Default: Use System Default
  • Field Name: Destination.[n].dialViaOfficeReverseVoicemail
  • Type: String
  • Cardinality: [0..1]
  • Default: Use System Default
  • Choices: ["Use System Default", "Timer Control", "User Control"]
Mobile Smart Client Name This tag is not applicable for dualmode phones
  • Field Name: Destination.[n].mobileSmartClientName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Answer Too Late Timer * Enter the maximum time in milliseconds that Cisco Unified Communications Manager allows for the mobile phone to answer. If this value is reached, Cisco Unified Communications Manager stops ringing the mobile phone and pulls the call back to the enterprise. Range: 0 and 10,000 - 300,000 milliseconds Default: 19,000 milliseconds If the value is set to zero, the timer is not started. Default: 19000
  • Field Name: Destination.[n].answerTooLateTimer
  • Type: Integer
  • Cardinality: [1..1]
  • Default: 19000
Line Associations The line association for this remote destination. The line to be associated must already be added to the remote destination profile. All directory numbers specified must already exist in the database.
  • Field Name: lineAssociations
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Line Association
  • Field Name: lineAssociation.[n]
  • Type: Array
Pattern The directory number to be associated. This directory number must be already associated to remote destination profile.
  • Field Name: Destination.[n].lineAssociations.lineAssociation.[n].pattern
  • Type: String
  • Cardinality: [1..1]
Route Partition Name
  • Field Name: Destination.[n].lineAssociations.lineAssociation.[n].routePartitionName
  • Type: String
  • Target: /api/device/cucm/RoutePartition/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24sq5rVgKueCuyaTG1%24K2RJ87SuhN9c5N9tWMLa6HlrZfRcNQaFui7gaAQdekD6otOyxWhoqwiLlWvexH43H6VzyfZRMHhX4BZe%2BUW6YELxreGiyw2YgUTvTuKLtRWEA3ciAFKLUX/WGLxD5L/RfpC/Ra5wUjsyKrxm2BBwhmSe3aYVkpxamSZvy/DiNGvAsrA3/pt7AM%2B9PzlSCCnId1JY82pRf3a%2BBS75WFFn3BbnQzDNiGfHDvzBuWc8PvHVFCulsIYcqUnX6yvv1bDbnVOeZjYkCAAC3Uxlx2aKyCXUZwVmzI8ie93bARtA%2BroMrg96Xl8Pg0a5hEhjzO0Y9qqe5McOX8%2BgIgJnAo2iYTR2xZ5tSBP6DnJ9/3RkZSyUkRdocEQqT8A6YkqcOGNSi661zq2VzQ%2BfthHYiQ%3D%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: device/cucm/RoutePartition
  • Cardinality: [0..1]
  • Format: uri
  • Choices: []
Tod Access Name From 11.0 this tag will not get the precedence if ringSchedule tag is present because ring schedule of the RD will be set based on ringSchedule tag
  • Field Name: Destination.[n].todAccessName
  • Type: String
  • Cardinality: [0..1]
Dual Mode Device Name
  • Field Name: Destination.[n].dualModeDeviceName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Destination Number * Enter the PSTN telephone number for the destination. Include the area code and any additional digits that are required to obtain an outside line. Maximum field length equals 24 characters; individual characters can take the values 0-9, *, #, and +. Cisco recommends that you configure the caller ID of the remote destination. If the administrator configures the Incoming Calling Party settings in the Cisco Unified Communications Manager gateway, trunk, or device pool to globalize the incoming calling party number, configure the Destination Number of the remote destination in the E.164 format. Example: For a remote destination with US area code 408 and destination number 5552222, configure the Destination Number as +14085552222. Additionally, if globalized destination numbers are in use, set the Matching Caller ID with Remote Destination service parameter to Complete Match. Note    Add the necessary translation pattern or route patterns to route the destination number. You can also enter a directory URI in this field. Keep in mind that if you enter a directory URI in this field, you must also configure a domain-based SIP route pattern. Note    When you place a call from a remote destination, the caller ID of the destination phone displays the directory number that is associated with the calling directory URI rather than the directory URI.
  • Field Name: Destination.[n].destination
  • Type: String
  • Cardinality: [1..1]
Enable Mobile Connect Check the check box to allow an incoming call to ring your desk phone and remote destination at the same time. For detailed task information about Cisco Unified Mobility and Extend and Connect, see the Feature Configuration Guide for Cisco Unified Communications Manager. Default: True
  • Field Name: Destination.[n].enableMobileConnect
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Client Services Framework or CTI Remote Device ctiRemoteDeviceName tag will be used to associate either CTI Remote Device or a Cisco Spark Remote Device with a Remote Destination
  • Field Name: Destination.[n].ctiRemoteDeviceName
  • Type: String
  • Cardinality: [0..1]
Mobility Profile From the drop-down list box, choose the mobility profile that you want to use for this remote destination. To configure a mobility profile, use the Call Routing > Mobility > Mobility Profile menu option.
  • Field Name: Destination.[n].mobilityProfileName
  • Type: ["String", "Null"]
  • Target: /api/device/cucm/MobilityProfile/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24OgKQXJa4aqqLQWBL%24T%2BHrURBz9Vq7HltH7fgKVzAHgy/HbkLYrFjccwxnYlt1mvJI3Sm%2BveluoSlRUa4VF7ywhwG5iH%2Bh0ai6Gao2qc5sQbNvdEy3rsx1QDc0aEk98NHIbNykKJXhuiZQHMkNWj8y%2BSW0TwXfJBhxbXsNiOMYD32/t5CyraiuqH%2BWaxnPWEZkeJbNj225bh38vB74vMrrDXboGsQtKgP49nSm64HpxCOmKrS9evMXoGQ98NEyR01GxfHfP4VFkXONexQwmzhMOacgRRSTCGBtagWA95tBa/hqxk9psSvR26v5ZESS5oG04xgw%2B/hYayNrU6KM0nP9871rO%2BTxKKrrioAAY7xKLI81mWMz8EohxbU9QwNWv0WR67PfZztRox86LgxBHL1C54sUhskJD4AcZeE%3D%24%3D%3D
  • Target attr: name
  • Target Model Type: device/cucm/MobilityProfile
  • Cardinality: [0..1]
  • Format: uri
  • Choices: []
Enable Unified Mobility While UPDATE set it to false if you want to delete enable Unified Mobility feature.Use only while update
  • Field Name: Destination.[n].enableUnifiedMobility
  • Type: Boolean
  • Cardinality: [0..1]
Remote Destination Profile From the drop-down list box, choose the remote destination profile that you want to use for this remote destination.
  • Field Name: Destination.[n].remoteDestinationProfileName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Single Number Reach Voicemail Policy Configures how mobile device users answer calls that terminate on a remote destination (RD). This feature provides users with a single enterprise voice mail box for their enterprise mobility if the RD call reaches an external voice mail system. Available options are as follows: Use System Default Timer Control User Control Note    For User Control to work, you must set the Enable Enterprise Feature Access service parameter to TRUE. Default: Use System Default
  • Field Name: Destination.[n].singleNumberReachVoicemail
  • Type: String
  • Cardinality: [0..1]
  • Default: Use System Default
  • Choices: ["Use System Default", "Timer Control", "User Control"]
Owner User Id From 10.5, to get proper value of this tag in get handler's response it is required to have value of todaccess, in case if user does not give any value in todaccesss tag, axl will insert a random row so that get handler response can return proper value of Owner User id
  • Field Name: Destination.[n].ownerUserId
  • Type: String
  • Cardinality: [1..1]
Answer Too Soon Timer * Enter the minimum time in milliseconds that Cisco Unified Communications Manager requires the mobile phone to ring before answering the call. This setting accounts for situations where the mobile phone is switched off or is not reachable, in which case the network may immediately divert the call to the mobile phone voice mail. If the mobile phone is answered before this timer expires, Cisco Unified Communications Manager pulls the call back to the enterprise. Range: 0 - 10,000 milliseconds Default: 1,500 milliseconds Default: 1500
  • Field Name: Destination.[n].answerTooSoonTimer
  • Type: Integer
  • Cardinality: [1..1]
  • Default: 1500
Ring Schedule This tag must be used for configuring RingSchedule of RD, this tag will get precendence over todaccess and accesslist tag. Passing a blank ringSchedule tag in updateRemoteDestination request will result in setting the time schedule to All the time.
  • Field Name: ringSchedule
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Member
  • Field Name: member.[n]
  • Type: Array
  • Cardinality: [0..7]
End Day Default: None
  • Field Name: Destination.[n].ringSchedule.member.[n].endDay
  • Type: String
  • Cardinality: [0..1]
  • Default: None
  • Choices: ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "None"]
Start Day StartDay and EndDay value should be same Default: None
  • Field Name: Destination.[n].ringSchedule.member.[n].startDay
  • Type: String
  • Cardinality: [0..1]
  • Default: None
  • Choices: ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "None"]
End Time Default: No Office Hours
  • Field Name: Destination.[n].ringSchedule.member.[n].endTime
  • Type: String
  • Cardinality: [0..1]
  • Default: No Office Hours
  • Choices: ["No Office Hours", "00:00", "00:15", "00:30", "00:45", "01:00", "01:15", "01:30", "01:45", "02:00", "02:15", "02:30", "02:45", "03:00", "03:15", "03:30", "03:45", "04:00", "04:15", "04:30", "04:45", "05:00", "05:15", "05:30", "05:45", "06:00", "06:15", "06:30", "06:45", "07:00", "07:15", "07:30", "07:45", "08:00", "08:15", "08:30", "08:45", "09:00", "09:15", "09:30", "09:45", "10:00", "10:15", "10:30", "10:45", "11:00", "11:15", "11:30", "11:45", "12:00", "12:15", "12:30", "12:45", "13:00", "13:15", "13:30", "13:45", "14:00", "14:15", "14:30", "14:45", "15:00", "15:15", "15:30", "15:45", "16:00", "16:15", "16:30", "16:45", "17:00", "17:15", "17:30", "17:45", "18:00", "18:15", "18:30", "18:45", "19:00", "19:15", "19:30", "19:45", "20:00", "20:15", "20:30", "20:45", "21:00", "21:15", "21:30", "21:45", "22:00", "22:15", "22:30", "22:45", "23:00", "23:15", "23:30", "23:45", "24:00"]
Start Time Default: No Office Hours
  • Field Name: Destination.[n].ringSchedule.member.[n].startTime
  • Type: String
  • Cardinality: [0..1]
  • Default: No Office Hours
  • Choices: ["No Office Hours", "00:00", "00:15", "00:30", "00:45", "01:00", "01:15", "01:30", "01:45", "02:00", "02:15", "02:30", "02:45", "03:00", "03:15", "03:30", "03:45", "04:00", "04:15", "04:30", "04:45", "05:00", "05:15", "05:30", "05:45", "06:00", "06:15", "06:30", "06:45", "07:00", "07:15", "07:30", "07:45", "08:00", "08:15", "08:30", "08:45", "09:00", "09:15", "09:30", "09:45", "10:00", "10:15", "10:30", "10:45", "11:00", "11:15", "11:30", "11:45", "12:00", "12:15", "12:30", "12:45", "13:00", "13:15", "13:30", "13:45", "14:00", "14:15", "14:30", "14:45", "15:00", "15:15", "15:30", "15:45", "16:00", "16:15", "16:30", "16:45", "17:00", "17:15", "17:30", "17:45", "18:00", "18:15", "18:30", "18:45", "19:00", "19:15", "19:30", "19:45", "20:00", "20:15", "20:30", "20:45", "21:00", "21:15", "21:30", "21:45", "22:00", "22:15", "22:30", "22:45", "23:00", "23:15", "23:30", "23:45", "24:00"]
Mobile Phone Check the check box if you want calls that the desk phone answers to be sent to your mobile phone as the remote destination. Checking this check box ensures that, if Send Call to Mobile Phone is specified (by using the Mobility softkey for remote destination pickup), the call gets extended to this remote destination. Note    This check box does not apply to dual-mode phones that are running SIP nor to dual-mode phones that are running SCCP, such as the Nokia S60.
  • Field Name: Destination.[n].isMobilePhone
  • Type: Boolean
  • Cardinality: [0..1]
Blocked Access List Click this radio button to prevent incoming calls from ringing this remote destination if the caller belongs to the access list that is specified in the drop-down list box and according to the Ring Schedule that you specify in the Ring Schedule pane. This setting applies only if the Enable Cisco Unified Mobility check box is checked for this remote destination. From the drop-down list box, choose an access list that applies to this setting. If you want to view the details of an access list, click the View Details link. (To modify an access list, you must use the Call Routing > Class of Control > Access List menu option.) Choosing an access list that contains no members equates to choosing the Always ring this destination radio button.
  • Field Name: Destination.[n].accessListName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Delay Before Ringing Timer * Enter the time that elapses before the mobile phone rings when a call is extended to the remote destination. Range: 0 - 30,000 milliseconds Default: 4,000 milliseconds Tip    When a hunt group is in use, the lines ring only for a short period of time. You may need to manipulate the Delay Before Ringing Timer setting and make it zero to allow a remote destination call to be established, ring, and answer, before the hunt list timer expires and pulls the call back. Default: 4000
  • Field Name: Destination.[n].delayBeforeRingingCell
  • Type: Integer
  • Cardinality: [1..1]
  • Default: 4000
Name Enter a name that identifies the remote destination or mobile identity.
  • Field Name: Destination.[n].name
  • Type: String
  • Cardinality: [0..1]
Time Zone From the drop-down list box, choose a time zone to use for this remote destination or mobile identity. Note    The time-of-day access feature uses the time zone that you choose for this remote destination or mobile identity to allow or to block calls to this remote destination or mobile identity. Default: Etc/GMT
  • Field Name: Destination.[n].timeZone
  • Type: String
  • Cardinality: [0..1]
  • Default: Etc/GMT
  • Choices: ["Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmara", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/Buenos_Aires", "America/Argentina/Catamarca", "America/Argentina/Cordoba", "America/Argentina/Jujuy", "America/Argentina/La_Rioja", "America/Argentina/Mendoza", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Atikokan", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Costa_Rica", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Fortaleza", "America/Glace_Bay", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Indianapolis", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Juneau", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montreal", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nipigon", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Ojinaga", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Velho", "America/Puerto_Rico", "America/Rainy_River", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Shiprock", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "America/Yellowknife", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/South_Pole", "Antarctica/Syowa", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Choibalsan", "Asia/Chongqing", "Asia/Colombo", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Gaza", "Asia/Harbin", "Asia/Hebron", "Asia/Ho_Chi_Minh", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Istanbul", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Kolkata", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qyzylorda", "Asia/Rangoon", "Asia/Riyadh", "Asia/Riyadh87", "Asia/Riyadh88", "Asia/Riyadh89", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Thimphu", "Asia/Tokyo", "Asia/Ulaanbaatar", "Asia/Urumqi", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faroe", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Currie", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/Perth", "Australia/Sydney", "CET", "CST6CDT", "EET", "EST", "EST5EDT", "Etc/GMT", "Etc/GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT0", "Etc/Greenwich", "Etc/UCT", "Etc/UTC", "Etc/Universal", "Etc/Zulu", "Europe/Amsterdam", "Europe/Andorra", "Europe/Athens", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kiev", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Nicosia", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Uzhgorod", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zaporozhye", "Europe/Zurich", "HST", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "MET", "MST", "MST7MDT", "Mideast/Riyadh87", "Mideast/Riyadh88", "Mideast/Riyadh89", "PST8PDT", "Pacific/Apia", "Pacific/Auckland", "Pacific/Chatham", "Pacific/Chuuk", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Johnston", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Pohnpei", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Wake", "Pacific/Wallis", "US/Pacific-New", "WET"]