The RisPort70 (Real-Time Information Port) service provides an API for querying the current connection status of phones, devices, and applications connected to Cisco Unified Communications Manager (Unified CM). Details provided by RisPort70 include last known connection and registration state, IP address, and model information. The API provides queries, for example by name, for single device or application instances, and wildcard queries which return the status of multiple devices at once.
The RisPort70 API allows clients to:
- Query Cisco Unified CM for the status and details of phones and other telephony devices
- Query Cisco Unified CM for the status and details of CTI applications
Use the RisPort70 WSDL:
https://<server>:8443/realtimeservice2/services/RISService70?wsdl
Deprecated Methods
The RisPort WSDL is deprecated. Use the RisPort70 WSDL.
SelectCmDevice
This method allows clients to perform Cisco Unified CM device-related queries. The method returns a snapshot of real-time device registration status from each Cisco Unified CM node. The data includes registration status, IP address, model info, and CTI application connections to the device. A single device may appear in multiple elements if the device has registered to multiple nodes. Devices may be requested by wildcard using an asterisk, *.
<!--RisPort70 API - SelectCmDevice - Request-->
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://schemas.cisco.com/ast/soap">
<soapenv:Header/>
<soapenv:Body>
<soap:selectCmDevice>
<soap:StateInfo></soap:StateInfo>
<soap:CmSelectionCriteria>
<soap:MaxReturnedDevices>2000</soap:MaxReturnedDevices>
<soap:DeviceClass>Any</soap:DeviceClass>
<soap:Model>255</soap:Model>
<soap:Status>Any</soap:Status>
<soap:NodeName></soap:NodeName>
<soap:SelectBy>DirNumber</soap:SelectBy>
<soap:SelectItems>
<!--Zero or more repetitions:-->
<soap:item>
<soap:Item>6961</soap:Item>
</soap:item>
</soap:SelectItems>
<soap:Protocol>Any</soap:Protocol>
<soap:DownloadStatus>Any</soap:DownloadStatus>
</soap:CmSelectionCriteria>
</soap:selectCmDevice>
</soapenv:Body>
</soapenv:Envelope>
Request Format
| Parameter | Description |
|---|---|
| StateInfo | The StateInfo string as returned by a previous execution of the current query. Refer to the StateInfo Usage section. |
| CmSelectionCriteria | A Cisco Unified CM Selection criteria. |
| MaxReturnedDevices | The maximum number of devices to return. The maximum parameter value is 2000 |
| DeviceClass | The device class to query for real-time status. Device classes include:
|
| Model | Model number of a particular device or 255 for "any model." See example table . The complete list of available model numbers is stored in the Cisco Unified CM typemodel database table. |
| Status | Allows device searches by status (or state):
|
| NodeName | The UC Manager node name to query. If no NodeName is given, all nodes in the cluster are queried. |
| SelectBy | Search by:
|
| SelectItems | An array of one or more item elements, which may include names, IP addresses, or directory numbers, depending on the SelectBy parameter. The item value can include a * to return wildcard matches. |
| Protocol | Search by device protocol:
|
| DownloadStatus | Use this parameter to search for devices that may be in the process of upgrading their internal firmware. It is possible to identify devices that are currently in the process of upgrading or have failed to upgrade using this parameter. The parameter choices are:
|
Model Table
Model Table(CUCM v15)
name enum ================================================== ===== EMCC Base Phone 15 SCCP Phone 20 Analog Access 30 Digital Access 40 Digital Access+ 42 Digital Access WS-X6608 43 Analog Access WS-X6624 47 Conference Bridge 50 Conference Bridge WS-X6608 51 H.323 Gateway 62 Music On Hold 70 Device Pilot 71 CTI Route Point 73 Voice Mail Port 80 Route List 90 Load Simulator 100 Media Termination Point 110 Media Termination Point Hardware 111 MGCP Station 120 MGCP Trunk 121 GateKeeper 122 Trunk 125 Tone Announcement Player 126 Unknown MGCP Gateway 254 Unknown 255 Cisco IOS Conference Bridge (HDV2) 52 Cisco Conference Bridge (WS-SVC-CMM) 53 Cisco IOS Software Media Termination Point (HDV2) 83 Cisco Media Server (WS-SVC-CMM-MS) 84 Cisco IOS Media Termination Point (HDV2) 112 Cisco Media Termination Point (WS-SVC-CMM) 113 SIP Trunk 131 SIP Gateway 132 WSM Trunk 133 Cisco Video Conference Bridge (IPVC-35xx) 85 BlackBerry MVS VoWifi 522 Usage Profile 640 Ascom IP-DECT Device 598 Cisco TelePresence Exchange System 599 Cisco TelePresence Conductor 36041 Interactive Voice Response 36219 Cisco Meeting Server 36250 H.323 Phone 61 CTI Port 72 Remote Destination Profile 134 Analog Phone 30027 ISDN BRI Phone 30028 SIP Station 36298 Cisco 12 SP+ 2 Cisco 12 SP 3 Cisco 12 S 4 Cisco 30 SP+ 1 Cisco 30 VIP 5 Cisco 7935 9 Cisco 7910 6 Cisco 7960 7 Cisco 7940 8 Cisco VGC Phone 10 Cisco VGC Virtual Phone 11 VGC Gateway 48 Cisco ATA 186 12 7914 14-Button Line Expansion Module 124 Third-party SIP Device (Basic) 336 Third-party SIP Device (Advanced) 374 Cisco 7941 115 Cisco 7971 119 Cisco 7905 20000 Cisco 7985 302 Cisco 7911 307 Cisco 7961G-GE 308 Cisco 7941G-GE 309 Motorola CN622 335 Cisco 7931 348 Cisco Unified Personal Communicator 358 Cisco 7921 365 Cisco 7906 369 Cisco TelePresence 375 Nokia S60 376 Cisco 7920 30002 Cisco 7970 30006 Cisco 7912 30007 Cisco 7902 30008 Cisco IP Communicator 30016 Cisco 7961 30018 Cisco 7936 30019 SCCP gateway virtual phone 30032 IP-STE 30035 Cisco 7962 404 Cisco 3951 412 Cisco 7937 431 Cisco 7942 434 Cisco 7945 435 Cisco 7965 436 Cisco 7975 437 Cisco 3911 446 Cisco ATA 187 550 Third-party AS-SIP Endpoint 631 BEKEM 36-Button Line Expansion Module 36049 Cisco Collaboration Mobile Convergence 36263 Cisco IOS Heterogeneous Video Conference Bridge 86 Cisco IOS Guaranteed Audio Video Conference Bridge 87 Cisco IOS Homogeneous Video Conference Bridge 88 7915 12-Button Line Expansion Module 227 7915 24-Button Line Expansion Module 228 7916 12-Button Line Expansion Module 229 7916 24-Button Line Expansion Module 230 CKEM 36-Button Line Expansion Module 232 Cisco Unified Mobile Communicator 468 Cisco TelePresence 1000 478 Cisco TelePresence 3000 479 Cisco TelePresence 3200 480 Cisco TelePresence 500-37 481 Cisco 7925 484 Cisco 9971 493 Cisco 6921 495 Cisco 6941 496 Cisco 6961 497 Cisco Unified Client Services Framework 503 Cisco TelePresence 1300-65 505 Cisco TelePresence 1100 520 Transnova S3 521 Cisco 9951 537 Cisco 8961 540 Cisco 6901 547 Cisco 6911 548 Cisco TelePresence 200 557 Cisco TelePresence 400 558 Cisco Dual Mode for iPhone 562 Cisco 6945 564 Cisco Dual Mode for Android 575 Cisco 7926 577 Cisco E20 580 Generic Single Screen Room System 582 Generic Multiple Screen Room System 583 Cisco TelePresence EX90 584 Cisco 8945 585 Cisco 8941 586 Generic Desktop Video Endpoint 588 Cisco TelePresence 500-32 590 Cisco TelePresence 1300-47 591 Cisco 3905 592 Cisco Cius 593 VKEM 36-Button Line Expansion Module 594 Cisco TelePresence TX1310-65 596 Cisco TelePresence MCU 597 Cisco TelePresence EX60 604 Cisco TelePresence Codec C90 606 Cisco TelePresence Codec C60 607 Cisco TelePresence Codec C40 608 Cisco TelePresence Quick Set C20 609 Cisco TelePresence Profile 42 (C20) 610 Cisco TelePresence Profile 42 (C60) 611 Cisco TelePresence Profile 52 (C40) 612 Cisco TelePresence Profile 52 (C60) 613 Cisco TelePresence Profile 52 Dual (C60) 614 Cisco TelePresence Profile 65 (C60) 615 Cisco TelePresence Profile 65 Dual (C90) 616 Cisco TelePresence MX200 617 Cisco TelePresence TX9000 619 Cisco TelePresence TX9200 620 Cisco 7821 621 Cisco 7841 622 Cisco 7861 623 Cisco TelePresence SX20 626 Cisco TelePresence MX300 627 IMS-integrated Mobile (Basic) 628 Cisco Cius SP 632 Cisco TelePresence Profile 42 (C40) 633 Cisco VXC 6215 634 Carrier-integrated Mobile 642 Universal Device Template 645 Cisco DX650 647 Cisco Unified Communications for RTX 648 Cisco Jabber for Tablet 652 Cisco 8831 659 Cisco ATA 190 681 Cisco TelePresence SX10 682 Cisco 8841 683 Cisco 8851 684 Cisco 8861 685 Cisco TelePresence SX80 688 Cisco TelePresence MX200 G2 689 Cisco TelePresence MX300 G2 690 SPA8800 253 Cisco DX80 36042 Cisco DX70 36043 Cisco TelePresence MX700 36207 Cisco TelePresence MX800 36208 Cisco TelePresence IX5000 36210 Cisco 7811 36213 Cisco 8821 36216 Cisco 8811 36217 Cisco 8845 36224 Cisco 8865 36225 Cisco TelePresence MX800 Dual 36227 Cisco 8851NR 36232 Cisco Spark Remote Device 36235 Cisco Webex DX80 36239 Cisco TelePresence DX70 36241 Cisco 8865NR 36248 Cisco Webex Room Kit 36251 Cisco Webex Room 55 36254 Cisco Webex Room Kit Plus 36255 CP-8800-Audio 28-Button Key Expansion Module 36257 CP-8800-Video 28-Button Key Expansion Module 36256 Cisco Webex Room 70 Single 36259 Cisco 8832NR 36260 Cisco 8841NS 36340 Cisco Webex Room Kit Mini 36299 Cisco 8851NS 36338 Cisco 7832 36247 CTI Remote Device 635 Cisco Webex Room 70 Dual 36265 Cisco Webex Room Bar 36335 Cisco Webex Desk LE 36322 Cisco Webex Room Panorama 36308 Cisco 8811NS 36339 Cisco ATA 191 36262 Cisco Webex Board Pro 55 36333 Cisco 8832 36258 Cisco Room Kit EQ 36341 Cisco Webex Desk 36324 Cisco Webex Room 70 Single G2 36296 Cisco Webex Desk Hub 36327 Cisco 860 36319 Cisco Webex Room Kit Pro 36292 Cisco Webex Board 85 36306 Cisco Room Kit EQX 36344 Cisco Webex Desk Mini 36326 Cisco Webex Room 70 Dual G2 36297 Cisco Webex Room 55 Dual 36295 Cisco Webex VDI Svc Framework 36302 Cisco 8875NR 36337 Cisco Webex Room Phone 36312 Cisco Webex Board Pro 75 36334 Cisco Room Bar Pro 36343 Cisco Webex Board 70 36305 Cisco 840 36320 Cisco 8875 36336 Cisco Webex Desk Pro 36307 Cisco Webex Room 70 Panorama 36309 Cisco Webex Board 55 36304
The StateInfo feature is an optional mechanism for applications to receive full RisPort70 data updates only if the state of one or more devices returned by a previous, identical query changed. This can reduce RisPort70 and application-side processing impact when queries are large and device state changes are infrequent. Benefits are improved performance and request latency which allows applications to poll for state changes more frequently.
How It Works
As part of each successful RisPort70 response, the StateInfo field is populated with a string value representing an internal RisPort70 state. This StateInfo value is specific to the parameters and timestamp of the query, and is a snapshot of the device state of all devices queried at the time of the request.
<!-- Example: -->
<ns1:StateInfo><StateInfo ClusterWide="1"><Node Name="DS-UCM105" SubsystemStartTime="1412580217" StateId="61" TotalItemsFound="1" TotalItemsReturned="1"/></StateInfo></ns1:StateInfo>
Note: data within the
<StateInfo>element is XML-escaped by design
If an application performs a RisPort70 query identical to a previously executed query, it may provide the associated StateInfo string in the request. RisPort70 will then compare the previous RisPort70 state snapshot with the current device states, and determine if they exactly match. If the state of all devices is unchanged, RisPort70 returns a response with TotalDevicesFound= 0 and NoChange= true.
<!-- Example: -->
<ns1:SelectCmDeviceResult>
<ns1:TotalDevicesFound>0</ns1:TotalDevicesFound>
<ns1:CmNodes>
<ns1:item>
<ns1:ReturnCode>Ok</ns1:ReturnCode>
<ns1:Name>DS-UCM105</ns1:Name>
<ns1:NoChange>true</ns1:NoChange>
<ns1:CmDevices xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
</ns1:item>
</ns1:CmNodes>
</ns1:SelectCmDeviceResult>
If any of the devices have changed state, then the standard RisPort70 response will be provided, including full state data for all queried devices. An updated StateInfo value represents the new state snapshot.
Using RisPort70 With Bulk Requests
Applications using RisPort70 to perform queries on large numbers of devices, for example in order to update a devicename to IP address lookup table, need to balance:
- Request rate throttle (18 requests per minute maximum)
- The number of devices per request (up to 2000)
- The possibility of duplicate records (from
selectCmDevice) - Truncated results if more than 2000 results returned
- Keeping device state information as up-to-date as possible
Obtain the right balance by testing and observation of Cisco Unified CM system performance, for example via the RTMT tool.
Applications can perform bulk query operations by providing multiple Item elements in the SelectItems list:
<!-- Example: Multiple `item` elements -->
<soap:SelectBy>Name</soap:SelectBy>
<soap:SelectItems>
<soap:item>
<soap:Item>IPCMRAEU5UCM5X7</soap:Item>
</soap:item>
<soap:item>
<soap:Item>IPCXYZAU4UCM4X3</soap:Item>
</soap:item>
</soap:SelectItems>
or use the * wildcard to return partial SelectItems matches:
<!-- Example: wildcard, partial Name match -->
<soap:SelectBy>Name</soap:SelectBy>
<soap:SelectItems>
<soap:item>
<soap:Item>IPC*</soap:Item>
</soap:item>
</soap:SelectItems>
or "all" devices (not supported with selectCmDeviceExt):
<!-- Example: wildcard, "all" Name match -->
<soap:SelectBy>Name</soap:SelectBy>
<soap:SelectItems>
<soap:item>
<soap:Item>*</soap:Item>
</soap:item>
</soap:SelectItems>
The application can specify the maximum number of results it is able to accept with MaxReturnedDevices. However, the upper limit on returned results for RisPort70 itself is 2000. If the number of devices found by the query exceeds 2000, only the first 2000 results are returned.
Note: The RisPort70 response does not indicate if results greater than 2000 have been truncated.
In practice, wildcard queries should be used with care, as systems with greater than 2000 devices are common, and results truncation can occur. Applications may want to consider results with exactly 2000 results as truncated.
One approach to retrieving bulk RisPort70 data is to submit requests specifying multiple individual Item elements in the request (see the XML example.) In this way an application can gather large collections of device names, for example 500 devices at a time, with good assurance of getting complete results.
Note: selectCmDevice can return multiple results per unique device if a device has registered on more than one Cisco Unified CM node at some point, for example due to failover. selectCmDeviceExt returns only the most recent result.
Applications can obtain device names individually or in bulk via the Cisco Unified CM AXL SOAP API, for example getPhone and listPhone.
RisPort70 Request Throttling
By default RisPort70 accepts up to 18 requests per minute, combined across all RisPort70 applications. Configure this maximum via the Cisco Unified CM Enterprise Parameter Allowed Device Queries Per Minute (default = 15, up to a limit of 18 requests per minute). If RisPort70 receives more requests in a minute than the current maximum, requests may fail with a SOAP fault error. It is recommend that applications pace requests, especially large ones, to correspond to a rate of approximately 15 per minute or the configured maximum value.
Response Format
<!--RisPort70 API - SelectCmDevice - Response-->
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns1:selectCmDeviceResponse xmlns:ns1="http://schemas.cisco.com/ast/soap">
<ns1:selectCmDeviceReturn>
<ns1:SelectCmDeviceResult>
<ns1:TotalDevicesFound>1</ns1:TotalDevicesFound>
<ns1:CmNodes>
<ns1:item>
<ns1:ReturnCode>Ok</ns1:ReturnCode>
<ns1:Name>cucm3</ns1:Name>
<ns1:NoChange>false</ns1:NoChange>
<ns1:CmDevices>
<ns1:item>
<ns1:Name>SEPE8B7480316D6</ns1:Name>
<ns1:DirNumber>6961-Registered</ns1:DirNumber>
<ns1:DeviceClass>Phone</ns1:DeviceClass>
<ns1:Model>497</ns1:Model>
<ns1:Product>384</ns1:Product>
<ns1:BoxProduct>0</ns1:BoxProduct>
<ns1:Httpd>Yes</ns1:Httpd>
<ns1:RegistrationAttempts>0</ns1:RegistrationAttempts>
<ns1:IsCtiControllable>true</ns1:IsCtiControllable>
<ns1:LoginUserId xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:Status>Registered</ns1:Status>
<ns1:StatusReason>0</ns1:StatusReason>
<ns1:PerfMonObject>2</ns1:PerfMonObject>
<ns1:DChannel>0</ns1:DChannel>
<ns1:Description>SEPE8B7480316D6</ns1:Description>
<ns1:H323Trunk>
<ns1:ConfigName xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:TechPrefix xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:Zone xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:RemoteCmServer1 xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:RemoteCmServer2 xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:RemoteCmServer3 xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:AltGkList xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:ActiveGk xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:CallSignalAddr xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:RasAddr xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
</ns1:H323Trunk>
<ns1:TimeStamp>1411595208</ns1:TimeStamp>
<ns1:Protocol>SCCP</ns1:Protocol>
<ns1:NumOfLines>1</ns1:NumOfLines>
<ns1:LinesStatus>
<ns1:item>
<ns1:DirectoryNumber>6961</ns1:DirectoryNumber>
<ns1:Status>Registered</ns1:Status>
</ns1:item>
</ns1:LinesStatus>
<ns1:ActiveLoadID>SCCP69xx.9-4-1-3SR1</ns1:ActiveLoadID>
<ns1:InactiveLoadID xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:DownloadStatus>Unknown</ns1:DownloadStatus>
<ns1:DownloadFailureReason xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:DownloadServer xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:IPAddress>
<ns1:item>
<ns1:IP>192.168.168.186</ns1:IP>
<ns1:IPAddrType>ipv4</ns1:IPAddrType>
<ns1:Attribute>AdministrativeAndSignaling</ns1:Attribute>
</ns1:item>
</ns1:IPAddress>
</ns1:item>
</ns1:CmDevices>
</ns1:item>
</ns1:CmNodes>
</ns1:SelectCmDeviceResult>
<ns1:StateInfo><StateInfo ClusterWide="1"><Node Name="cucm3" SubsystemStartTime="1411513436" StateId="84" TotalItemsFound="1" TotalItemsReturned="1"/></StateInfo></ns1:StateInfo>
</ns1:selectCmDeviceReturn>
</ns1:selectCmDeviceResponse>
</soapenv:Body>
</soapenv:Envelope>
The response includes information requested using the SelectCmDevice request, and can include information for one or more Cisco Unified CM nodes.
| Parameter | Description |
|---|---|
| TotalDevicesFound | The total number of devices found. |
| CmNodes | An array of requested node information for one or more nodes. Each CmNode contains a sequence of devices and their registration status including:
|
| ReturnCode | Returns Real-Time Information Service return codes:
|
| Name | The Host Name or IP address. |
| NoChange | True or false. Refer to the StateInfo Usage section for more details. |
A CmDevice in the CmNode contains the following information:
| Parameter | Description |
|---|---|
| Name | The name of the device. |
| DirNumber | The directory number. |
| DeviceClass | The type of device. |
| Model | Model number of the device. See example table . The complete list of available model numbers is stored in the Cisco Unified CM typemodel database table. |
| Product | Product number of the device. See example table . The complete list of available product numbers is stored in the Cisco Unified CM typeproduct database table. |
| BoxProduct | Displays the integer value (0 or 1) for box products. |
| Httpd | Indicates whether the device has an onboard HTTP web server. Values:
|
| RegistrationAttempts | Number of registration attempts. |
| IsCtiControllable | True or False |
| LoginUserId | Displays EM (Extension Mobility) login User ID. This is used for the Cisco Unified CM Extension Mobility feature. |
| Status | The device registration status type:
|
| StatusReason | Indicates the reason code for the current device status, if known. Click here for the Reason Code table. |
| PerfMonObject | The PerfMonObject ID. |
| DChannel | The number of D channels supported for PRI devices. |
| Description | Description of the device. |
| H323Trunk | The H323 trunk details. |
| TimeStamp | The UTC format time-stamp. |
| Protocol | The device protocol type including:
|
| NumOfLines | The number of lines. |
| LinesStatus | The status of each line:
|
| ActiveLoadID | Displays the currently active firmware on the phone. |
| InactiveLoadID | Displays the inactive phone load. |
| DownloadStatus | Displays the current firmware download status. Possible values are:
|
| DownloadFailureReason | Displays firmware download failure reason, if any. |
| DownloadServer | Displays the current firmware download server. |
| IPAddress | An array list of device IP Addresses. IPAddrType indicates the IP version type:
Attribute indicates the IP address function:
|
Product Table
Product Table (CUCM v15)
name enum =================================================== ===== Pilot 0 Cisco Catalyst 6000 T1 VoIP Gateway 1 Cisco Catalyst 6000 E1 VoIP Gateway 2 Cisco Catalyst 6000 24 port FXS Gateway 3 Cisco Catalyst 6000 12 port FXO Gateway 4 EMCC Base Phone 15 H.323 Client 16 H.323 Gateway 17 Cisco MGCP FXO Port 18 Cisco MGCP FXS Port 19 CTI Port 25 Cisco Voice Mail Port 27 Cisco Conference Bridge Software 28 Cisco Conference Bridge Hardware 29 Cisco Media Termination Point Software 30 Cisco Media Termination Point Hardware 31 SCCP Device 33 Route List 37 Unknown 38 Load Simulator 39 Gatekeeper 40 NM-1V 41 NM-2V 42 CTI Route Point 48 Music On Hold 51 Cisco MGCP T1 Port 52 NM-HDV 53 VIC_SLOT 54 Cisco MGCP E1 Port 55 VWIC_SLOT 56 FLEX_SLOT 57 Cisco IOS Conference Bridge 60 Cisco IOS Media Termination Point 61 IAD2400_ANALOG 63 IAD2400_DIGITAL 64 SIP Trunk 95 VGC Port 67 H.225 Trunk (Gatekeeper Controlled) 75 Inter-Cluster Trunk (Gatekeeper Controlled) 76 Inter-Cluster Trunk (Non-Gatekeeper Controlled) 77 WS-X6600 81 AIM-VOICE-30 83 NM-HDA 84 PA-VXA 85 PA-VXB 86 PA-VXC 87 PA-MCX 88 Annunciator 89 Cisco Conference Bridge (WS-SVC-CMM) 96 Cisco Media Server (WS-SVC-CMM-MS) 97 Cisco Media Termination Point (WS-SVC-CMM) 98 Cisco IOS Enhanced Software Media Termination Point 99 Cisco IOS Enhanced Conference Bridge 101 Cisco IOS Enhanced Media Termination Point 102 Cisco Video Conference Bridge(IPVC-35xx) 103 Hunt List 110 SIP WSM Connection 111 Remote Destination Profile 112 Cisco TelePresence Conductor 487 Cisco TelePresence Exchange System 488 Interactive Voice Response 36672 Cisco Meeting Server 36703 Analog Phone 30065 ISDN BRI Phone 30066 Cisco SIP FXS Port 36759 Cisco MGCP BRI Port 90 NM-HD-1V 91 NM-HD-2V 92 NM-HD-2VE 93 WS-SVC-CMM-MS 10001 NM-4VWIC-MBRD 10002 VNM-HDA 10003 NM-HDV2-0PORT 10004 NM-HDV2-1PORT 10005 NM-HDV2-2PORT 10006 Cisco 12 SP+ 20 Cisco 12 SP 21 Cisco 12 S 22 Cisco 30 SP+ 23 Cisco 30 VIP 24 Cisco 7935 32 Cisco 7910 34 Cisco 7960 35 Cisco 7940 36 Cisco VG200 43 Cisco 26XX 44 Cisco 362X 45 Cisco 364X 46 Cisco 366X 47 Cisco Catalyst 4224 Voice Gateway Switch 58 Cisco Catalyst 4000 Access Gateway Module 59 Cisco IAD2400 62 Cisco VGC Phone 65 Cisco VGC Virtual Phone 68 Cisco VG248 Gateway 66 Cisco ATA 186 69 Communication Media Module 80 7914 14-Button Line Expansion Module 100 Third-party SIP Device (Basic) 235 Third-party SIP Device (Advanced) 273 Cisco 3745 20000 Cisco 3725 20002 Cisco 269X 30011 Cisco 1760 30019 Cisco 1751 30020 VG224 30038 Cisco 2821 30040 Cisco 3825 30052 Cisco 3845 30053 Cisco 2811 30059 Cisco 2851 30060 Cisco 7941 115 Cisco 7971 119 Cisco 7905 20003 Cisco 7985 202 Cisco 7911 206 Cisco 7961G-GE 207 Cisco 7941G-GE 208 Motorola CN622 234 Cisco 7931 247 Cisco Unified Personal Communicator 257 Cisco 7921 264 Cisco 7906 268 Cisco TelePresence 274 Nokia S60 275 Cisco 7920 30002 Cisco 7970 30018 Cisco 7912 30022 Cisco 7902 30023 Cisco IP Communicator 30041 Cisco 7961 30044 Cisco 7936 30050 SCCP gateway virtual phone 30071 IP-STE 30076 Cisco 2801 30202 Cisco 7962 303 Cisco 3951 311 Cisco 7937 330 Cisco 7942 333 Cisco 7945 334 Cisco 7965 335 Cisco 7975 336 Cisco 3911 345 Cisco ATA 187 437 Third-party AS-SIP Endpoint 518 BEKEM 36-Button Line Expansion Module 36390 Cisco Collaboration Mobile Convergence 36716 Cisco IOS Heterogeneous Video Conference Bridge 104 Cisco IOS Guaranteed Audio Video Conference Bridge 105 Cisco IOS Homogeneous Video Conference Bridge 106 7915 12-Button Line Expansion Module 227 7915 24-Button Line Expansion Module 228 7916 12-Button Line Expansion Module 229 7916 24-Button Line Expansion Module 230 CKEM 36-Button Line Expansion Module 232 Cisco Unified Mobile Communicator 355 Cisco TelePresence 1000 365 Cisco TelePresence 3000 366 Cisco TelePresence 3200 367 Cisco TelePresence 500-37 368 Cisco 7925 371 Cisco 9971 380 Cisco 6921 382 Cisco 6941 383 Cisco 6961 384 Cisco Unified Client Services Framework 390 Cisco TelePresence 1300-65 392 Cisco TelePresence 1100 407 Transnova S3 408 Cisco 9951 424 Cisco 8961 427 Cisco 6901 434 Cisco 6911 435 Cisco TelePresence 200 444 Cisco TelePresence 400 445 Cisco Dual Mode for iPhone 449 Cisco 6945 451 Cisco Dual Mode for Android 462 Cisco 7926 464 Cisco E20 467 Generic Single Screen Room System 469 Generic Multiple Screen Room System 470 Cisco TelePresence EX90 471 Cisco 8945 472 Cisco 8941 473 Generic Desktop Video Endpoint 475 Cisco TelePresence 500-32 477 Cisco TelePresence 1300-47 478 Cisco 3905 479 Cisco Cius 480 VKEM 36-Button Line Expansion Module 482 Cisco TelePresence TX1310-65 483 Cisco TelePresence MCU 484 Cisco TelePresence EX60 491 Cisco TelePresence Codec C90 493 Cisco TelePresence Codec C60 494 Cisco TelePresence Codec C40 495 Cisco TelePresence Quick Set C20 496 Cisco TelePresence Profile 42 (C20) 497 Cisco TelePresence Profile 42 (C60) 498 Cisco TelePresence Profile 52 (C40) 499 Cisco TelePresence Profile 52 (C60) 500 Cisco TelePresence Profile 52 Dual (C60) 501 Cisco TelePresence Profile 65 (C60) 502 Cisco TelePresence Profile 65 Dual (C90) 503 Cisco TelePresence MX200 504 Cisco TelePresence TX9000 506 Cisco TelePresence TX9200 507 Cisco 7821 508 Cisco 7841 509 Cisco 7861 510 Cisco TelePresence SX20 513 Cisco TelePresence MX300 514 IMS-integrated Mobile (Basic) 515 Cisco Cius SP 519 Cisco TelePresence Profile 42 (C40) 520 Cisco VXC 6215 521 Carrier-integrated Mobile 527 Universal Device Template 530 Cisco DX650 532 Cisco Unified Communications for RTX 533 Cisco Jabber for Tablet 537 Cisco 8831 544 Cisco ATA 190 566 Cisco TelePresence SX10 567 Cisco 8841 568 Cisco 8851 569 Cisco 8861 570 Cisco TelePresence SX80 573 Cisco TelePresence MX200 G2 574 Cisco TelePresence MX300 G2 575 Cisco 1861 30266 VG204 30270 Cisco VGD-1T3 30272 VG202 30274 Cisco 881 30280 Cisco 2951 30282 Cisco 3945 30286 Cisco 888/887/886 30290 Cisco 2911 30291 Cisco 3925 30292 Cisco 2921 30293 Cisco 2901 30297 Cisco 3945E 30298 Cisco 3925E 30299 SPA8800 30312 C881V 30315 C887VA-V 30316 VG350 30319 Cisco ISR 4451 30333 Cisco ISR 4431 36381 Cisco DX80 36382 Cisco DX70 36383 VG310 36385 VG320 36386 Cisco ISR 4351 36652 Cisco TelePresence MX700 36653 Cisco TelePresence MX800 36654 Cisco TelePresence IX5000 36656 Cisco ISR 4331 36659 Cisco 7811 36665 Cisco ISR 4321 36668 Cisco 8821 36669 Cisco 8811 36670 Cisco 8845 36677 Cisco 8865 36678 Cisco TelePresence MX800 Dual 36680 Cisco 8851NR 36685 Cisco Spark Remote Device 36688 Cisco Webex DX80 36692 Cisco TelePresence DX70 36694 Cisco 8865NR 36701 Cisco Webex Room Kit 36704 Cisco Webex Room 55 36707 Cisco Webex Room Kit Plus 36708 CP-8800-Audio 28-Button Key Expansion Module 36709 CP-8800-Video 28-Button Key Expansion Module 36710 Cisco ISR 4461 36723 Cisco Webex Room 70 Single 36712 Cisco ENCS 5400 ISRV 36730 Cisco C8300-1N1S-6T 36767 VG450 36722 Cisco 8832NR 36713 Cisco 8841NS 36807 Cisco Webex Room Kit Mini 36760 Cisco 8851NS 36805 Cisco 7832 36700 Cisco C8300-1N1S-4T2X 36763 CTI Remote Device 522 Cisco Webex Room 70 Dual 36718 Cisco Webex Room Bar 36802 Cisco Webex Desk LE 36789 Cisco Webex Room Panorama 36774 VG420 36787 Cisco 8811NS 36806 Cisco ATA 191 36715 Cisco Webex Board Pro 55 36800 Cisco 8832 36711 Cisco C8200/L-1N-4T 36766 Cisco Room Kit EQ 36808 Cisco Webex Desk 36791 Cisco Webex Room 70 Single G2 36757 Cisco Webex Desk Hub 36794 Cisco 860 36785 Cisco Webex Room Kit Pro 36753 Cisco Webex Board 85 36772 Cisco Room Kit EQX 36813 Cisco Webex Desk Mini 36793 Cisco Webex Room 70 Dual G2 36758 Cisco Webex Room 55 Dual 36756 Cisco Webex VDI Svc Framework 36768 VG400 36749 Cisco 8875NR 36804 Cisco Webex Room Phone 36778 Cisco Webex Board Pro 75 36801 Cisco Room Bar Pro 36812 Cisco Webex Board 70 36771 Cisco 840 36786 Cisco 8875 36803 Cisco Webex Desk Pro 36773 VG410 36810 Cisco Webex Room 70 Panorama 36775 Cisco C8300-2N2S-4T2X/6T 36765 Cisco Webex Board 55 36770
SelectCmDevice Status Reason Codes
If the device is Registered on the server, the StatusReason is 0. If the device is Unregistered, then one of the following values will be displayed in the response.
| Reason Code | Description |
|---|---|
| 1 | Unknown - The device has unregistered for an unknown reason. If the device does not re-register within 5 minutes, verify that it is powered up and there is network connectivity between the device and Cisco Unified CM. |
| 6 | ConnectivityError - Network communication between the device and Cisco Unified CM has been interrupted. Possible causes include device power outage, network power outage, network configuration error, network delay, packet drops, or packet corruption. It is also possible to receive this error if the Cisco Unified CM node is experiencing high CPU usage. Verify that the device is powered up and operating, network connectivity exists between the device and Cisco Unified CM, and the CPU utilization is in the safe range. Monitor CPU utilization via the CPU Pegging Alert in RTMT. |
| 8 | DeviceInitiatedReset - The device has initiated a reset, possibly due to a power cycle or internal error. No action required; the device will re-register automatically. |
| 9 | CallManagerReset - A device reset was initiated from Cisco Unified CM Administration, either due to an explicit command from an administrator, or due to internal errors encountered. No action necessary; the device will re-register automatically. |
| 10 | DeviceUnregistered - The device has explicitly unregistered. Possible causes include a change in the IP address or port of the device. No action is necessary; the device will re-register automatically. |
| 11 | MalformedRegisterMsg - (SIP only) A SIP REGISTER message could not be processed because of an illegal format. Possible causes include a missing Call-ID header, a missing AoR in the To header, or an expires value that is too small. Check the REGISTER message for any of these issues and correct the issue, if found. |
| 12 | SCCPDeviceThrottling - (SCCP only) The indicated SCCP device exceeded the maximum number of events allowed per-SCCP device. Events can be phone calls, KeepAlive messages, or excessive SCCP or non-SCCP messages. The maximum number of allowed events is controlled by the Cisco Unified CM service parameter Max Events Allowed. When an individual device exceeds the number configured in that service parameter, Cisco Unified CM closes the TCP connection to the device; automatic re-registration generally follows. This action is an attempt to stop malicious attacks on Cisco Unified CM or to ward off excessive CPU usage. |
| 13 | KeepAliveTimeout - A KeepAlive message was not received. Possible causes include device power outage, network power outage, network configuration error, network delay, packet drops, and packet corruption. It is also possible to receive this error if the Cisco Unified CM node is experiencing high CPU usage. Verify that the device is powered up and operating, there is network connectivity between the device and Cisco Unified CM, and the CPU utilization is in the safe range. Monitor CPU utilization via the CPU Pegging Alert in RTMT. |
| 14 | ConfigurationMismatch - (SIP only) The configuration on the device does not match the configuration in Cisco Unified CM. This can be caused by database replication errors or other internal Cisco Unified CM communication errors. Using the Cisco Unified Reporting web page, generate a Cisco Unified CM Database Status report and verify that all servers have a good replication status. Another method is using the Real-Time Reporting Tool (RTMT) and checking the Replication Status in the Database Summary page. If the status shows 2, then replication is working. If this device continues to unregister with this reason code, go to the Device Configuration page in Cisco Unified CM Administration for the device indicated in this alarm and click Save. This generates a change notify message to the Cisco Unified CM and TFTP services and rebuilds a new configuration file for the device. If the problem still persists, restart the TFTP service and the Cisco Unified CM service. |
| 15 | CallManagerRestart - A device restart was initiated from Cisco Unified CM Administration, either due to an explicit command from an administrator or due to a configuration change such as adding, deleting, or changing a directory number associated with the device. No action is necessary; the device will re-register automatically. |
| 16 | DuplicateRegistration - Cisco Unified CM detected that the device attempted to register to two nodes at the same time. Cisco Unified CM initiated a restart to the phone to force it to re-home to a single node. No action is necessary; the device will re-register automatically. |
| 17 | CallManagerApplyConfig - An ApplyConfig action was performed in Cisco Unified CM Administration resulting in an unregistration. No action is necessary; the device will re-register automatically. |
| 18 | DeviceNoResponse - The device did not respond to a reset or restart notification. The device is being forcibly reset. If the device does not re-register within 5 minutes, confirm that it is powered up and confirm that there is network connectivity between the device and Cisco Unified CM. |
| 19 | EMLoginLogout - The device has been unregistered due to an Extension Mobility login or logout |
| 20 | EMCCLoginLogout - The device has been unregistered due to an Extension Mobility Cross Cluster login or logout |
| 25 | RegistrationSequenceError - (SCCP only) A device requested configuration information from Unified CM at an unexpected time and Unified CM no longer had the requested information in memory. The device will automatically attempt to register again. If this alarm occurs again, manually reset the device. If this alarm continues to occur after the manual reset, there may be an internal firmware error. Collect existing SDI and SDL traces and contact the Cisco Technical Assistance Center (TAC). |
| 26 | InvalidCapabilities - (SCCP only) Unified CM detected an error in the updated media capabilities reported in one of the StationUpdateCapabilities messages sent by the device. The device will automatically attempt to register again. If this alarm occurs again, manually reset the device. If this alarm continues to occur after the manual reset, there may be a protocol error. Collect existing SDI and SDL traces and contact the Cisco Technical Assistance Center (TAC) |
| 28 | FallbackInitiated - The device has initiated a fallback and will automatically re-register to a higher-priority Unified CM. No action is necessary |
| 29 | DeviceSwitch - A second instance of an endpoint with the same device name has registered and assumed control. No action is necessary |
| 30 | DeviceWipe - An administrator has reset this device to factory settings. All configuration and data on the device will be erased. This device may remain unregistered until reconfigured |
| 31 | DeviceForcedReset - The device has been reset to resolve an inconsistency issue caused by a network connectivity problem. This forced reset is triggered by a SIP 503 response to a SIP Register message. The endpoint should automatically retry the SIP registration after this reset. |
| 33 | LowBattery - The device initiated a graceful shutdown due to battery depletion |
| 34 | ManualPowerOff - The device unregistered because it was manually powered off |
SelectCMDeviceExt
<!--RisPort70 API - SelectCmDeviceExt - Request-->
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://schemas.cisco.com/ast/soap">
<soapenv:Header/>
<soapenv:Body>
<soap:selectCmDeviceExt>
<soap:StateInfo></soap:StateInfo>
<soap:CmSelectionCriteria>
<soap:MaxReturnedDevices>2000</soap:MaxReturnedDevices>
<soap:DeviceClass>Any</soap:DeviceClass>
<soap:Model>255</soap:Model>
<soap:Status>Any</soap:Status>
<soap:NodeName></soap:NodeName>
<soap:SelectBy>Name</soap:SelectBy>
<soap:SelectItems>
<!--Zero or more repetitions:-->
<soap:item>
<soap:Item>SEPE8B7480316D6</soap:Item>
</soap:item>
</soap:SelectItems>
<soap:Protocol>Any</soap:Protocol>
<soap:DownloadStatus>Any</soap:DownloadStatus>
</soap:CmSelectionCriteria>
</soap:selectCmDeviceExt>
</soapenv:Body>
</soapenv:Envelope>
<!--RisPort70 API - SelectCmDeviceExt - Response-->
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns1:selectCmDeviceResponse xmlns:ns1="http://schemas.cisco.com/ast/soap">
<ns1:selectCmDeviceReturn>
<ns1:SelectCmDeviceResult>
<ns1:TotalDevicesFound>1</ns1:TotalDevicesFound>
<ns1:CmNodes>
<ns1:item>
<ns1:ReturnCode>Ok</ns1:ReturnCode>
<ns1:Name>cucm3</ns1:Name>
<ns1:NoChange>false</ns1:NoChange>
<ns1:CmDevices>
<ns1:item>
<ns1:Name>SEPE8B7480316D6</ns1:Name>
<ns1:DirNumber>6961-Registered</ns1:DirNumber>
<ns1:DeviceClass>Phone</ns1:DeviceClass>
<ns1:Model>497</ns1:Model>
<ns1:Product>384</ns1:Product>
<ns1:BoxProduct>0</ns1:BoxProduct>
<ns1:Httpd>Yes</ns1:Httpd>
<ns1:RegistrationAttempts>0</ns1:RegistrationAttempts>
<ns1:IsCtiControllable>true</ns1:IsCtiControllable>
<ns1:LoginUserId xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:Status>Registered</ns1:Status>
<ns1:StatusReason>0</ns1:StatusReason>
<ns1:PerfMonObject>2</ns1:PerfMonObject>
<ns1:DChannel>0</ns1:DChannel>
<ns1:Description>SEPE8B7480316D6</ns1:Description>
<ns1:H323Trunk>
<ns1:ConfigName xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:TechPrefix xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:Zone xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:RemoteCmServer1 xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:RemoteCmServer2 xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:RemoteCmServer3 xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:AltGkList xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:ActiveGk xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:CallSignalAddr xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:RasAddr xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
</ns1:H323Trunk>
<ns1:TimeStamp>1411595208</ns1:TimeStamp>
<ns1:Protocol>SCCP</ns1:Protocol>
<ns1:NumOfLines>1</ns1:NumOfLines>
<ns1:LinesStatus>
<ns1:item>
<ns1:DirectoryNumber>6961</ns1:DirectoryNumber>
<ns1:Status>Registered</ns1:Status>
</ns1:item>
</ns1:LinesStatus>
<ns1:ActiveLoadID>SCCP69xx.9-4-1-3SR1</ns1:ActiveLoadID>
<ns1:InactiveLoadID xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:DownloadStatus>Unknown</ns1:DownloadStatus>
<ns1:DownloadFailureReason xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:DownloadServer xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:IPAddress>
<ns1:item>
<ns1:IP>192.168.168.186</ns1:IP>
<ns1:IPAddrType>ipv4</ns1:IPAddrType>
<ns1:Attribute>AdministrativeAndSignaling</ns1:Attribute>
</ns1:item>
</ns1:IPAddress>
</ns1:item>
</ns1:CmDevices>
</ns1:item>
</ns1:CmNodes>
</ns1:SelectCmDeviceResult>
<ns1:StateInfo><StateInfo ClusterWide="1"><Node Name="cucm3" SubsystemStartTime="1411513436" StateId="84" TotalItemsFound="1" TotalItemsReturned="1"/></StateInfo></ns1:StateInfo>
</ns1:selectCmDeviceReturn>
</ns1:selectCmDeviceResponse>
</soapenv:Body>
</soapenv:Envelope>
The request and response schema format for SelectCmDevice and SelectCmDeviceExt are identical, with the exception of the base request name. See SelectCmDevice for usage and parameter values.
The difference is in functionality. SelectCmDeviceExt collates device status records across nodes, eliminating any duplicates.
This API returns a snapshot of the real-time device state from each Cisco Unified CM node. This data includes registration status, IP address, and model info. This request consolidates device records across nodes, returning only the device info for the latest registration.
Note: SelectCMDeviceExt does not support using the * wildcard for SelectItems matching.
SelectCtiItem
This method allows clients to perform CTI manager related queries. The method returns a snapshot of real-time CTI application status from each Cisco Unified CM node. This data includes application name, authenticated user, IP address, controlled CTI devices, and connection status.
<!--RisPort70 API - SelectCtiItem - Request-->
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://schemas.cisco.com/ast/soap">
<soapenv:Header/>
<soapenv:Body>RisPort70
<soap:selectCtiItem>
<soap:StateInfo></soap:StateInfo>
<soap:CtiSelectionCriteria>
<soap:MaxReturnedItems>2000</soap:MaxReturnedItems>
<soap:CtiMgrClass>Line</soap:CtiMgrClass>
<soap:Status>Any</soap:Status>
<soap:NodeName></soap:NodeName>
<soap:SelectAppBy>AppId</soap:SelectAppBy>
<soap:AppItems>
<!--Zero or more repetitions:-->
<soap:item>
<soap:AppItem>cucmuser-192.168.168.169-4963</soap:AppItem>
</soap:item>
</soap:AppItems>
<soap:DevNames>
<!--Zero or more repetitions:-->
<soap:item>
<soap:DevName>SEPF01FAF38ABC2</soap:DevName>
</soap:item>
</soap:DevNames>
<soap:DirNumbers>
<!--Zero or more repetitions:-->
<soap:item>
<soap:DirNumber>1002</soap:DirNumber>
</soap:item>
</soap:DirNumbers>
</soap:CtiSelectionCriteria>
</soap:selectCtiItem>
</soapenv:Body>
</soapenv:Envelope>
<!--RisPort70 API - SelectCtiItem - Response-->
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns1:selectCtiItemResponse xmlns:ns1="http://schemas.cisco.com/ast/soap">
<ns1:selectCtiItemReturn>
<ns1:SelectCtiItemResult>
<ns1:TotalItemsFound>1</ns1:TotalItemsFound>
<ns1:CtiNodes>
<ns1:item>
<ns1:ReturnCode>Ok</ns1:ReturnCode>
<ns1:Name>cucm3</ns1:Name>
<ns1:NoChange>false</ns1:NoChange>
<ns1:CtiItems>
<ns1:item>
<ns1:AppId>cucmuser-192.168.168.169-4963</ns1:AppId>
<ns1:UserId>cucmuser</ns1:UserId>
<ns1:AppIpAddr>192.168.168.169</ns1:AppIpAddr>
<ns1:AppIpv6Addr xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:AppStatus>Closed</ns1:AppStatus>
<ns1:AppStatusReason>2</ns1:AppStatusReason>
<ns1:AppTimeStamp>1412194696</ns1:AppTimeStamp>
<ns1:CtiDevice>
<ns1:AppControlsMedia>false</ns1:AppControlsMedia>
<ns1:DeviceName>SEPF01FAF38ABC2</ns1:DeviceName>
<ns1:DeviceStatus>Open</ns1:DeviceStatus>
<ns1:DeviceStatusReason xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:DeviceTimeStamp xsi:nil="1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
</ns1:CtiDevice>
<ns1:CtiLine>
<ns1:DirNumber>1002</ns1:DirNumber>
<ns1:LineStatus>Closed</ns1:LineStatus>
<ns1:LineStatusReason>0</ns1:LineStatusReason>
<ns1:LineTimeStamp>1412194696</ns1:LineTimeStamp>
</ns1:CtiLine>
</ns1:item>
</ns1:CtiItems>
</ns1:item>
</ns1:CtiNodes>
</ns1:SelectCtiItemResult>
<ns1:StateInfo><StateInfo ClusterWide="1"><Node Name="cucm3" SubsystemStartTime="1411513254" StateId="621" TotalItemsFound="1" TotalItemsReturned="1"/></StateInfo></ns1:StateInfo>
</ns1:selectCtiItemReturn>
</ns1:selectCtiItemResponse>
</soapenv:Body>
</soapenv:Envelope>
Request Format
| Parameter | Description |
|---|---|
| StateInfo | Returns state information for the items in the request. The StateInfo returned can be used to determine if a change has occurred since a previous request. Refer to the StateInfo Usage section. |
| CtiSelectionCriteria | See the following table for parameters. |
CtiSelectionCriteria includes:
| Parameter | Description |
|---|---|
| MaxReturnedItems | The maximum number of devices to return. The maximum parameter value is 2000. |
| CtiMgrClass | A search is requested on Provider, Device, or Line. |
| Status | The status or class on which to search:
|
| NodeName | The server to search. If no node name is given and clusters are configured, all servers in the cluster will be searched. |
| SelectAppBy | Selection criteria to search for an application:
|
| AppItems | AppItems is the result set. Each item is a string representing a unique CTI application connection with the format:
|
| DevNames | List of devices controlled by the CTI application(s). |
| DirNumbers | List of directory numbers controlled by the CTI application(s). Note: DirNumber lookup only works if specifying "Line" in the soap:CtiMgrClass tag. |
Response Format
| Parameter | Description |
|---|---|
| TotalItemsFound | The total number of items found. |
| CtiNodes | An array of requested information for one or more items. Each CtiNode contains a sequence of items and their registration status:
|
CtiNodes contains the following information:
| Parameter | Description |
|---|---|
| ReturnCode | Returns Real-Time Information Service return codes:
|
| Name | The name of the node. |
| NoChange | True or false. Refer to the StateInfo Usage section for more details. |
| CtiItems | An array of requested information for one or more items. |
CtiItems contains the following information:
| Parameter | Description |
|---|---|
| AppId | The application ID. |
| UserId | The user ID. |
| AppIpAddr | The IP address of the application. |
| AppIpv6Addr | The IPv6 address of the application, if applicable. |
| AppStatus | The status of the application:
|
| AppStatusReason | The reason for the application status. |
| AppTimeStamp | The UNIX time stamp. |
| CtiDevice | One or more CtiDevice elements. |
| CtiLine | One or more CtiLine elements. |
CtiDevice contains the following information:
| Parameter | Description |
|---|---|
| AppControlsMedia | True or false. |
| DeviceName | Name of the device. |
| DeviceStatus | The status of the device:
|
| DeviceStatusReason | The reason for the device status. |
| DeviceTimeStamp | The UNIX time stamp. |
CtiLine contains the following information:
| Parameter | Description |
|---|---|
| DirNumber | The directory number. |
| LineStatus | The status of the line:
|
| LineStatusReason | The reason for the line status. |
| LineTimeStamp | The UNIX time stamp. |