Get Information about a Phone
Problem
Your application needs to retrieve configuration information about a phone registered with Cisco Unified CM.
Solution
Cisco UC Manager Version: 8.5
Use the getPhone AXL API. You can specify the device that you want to retrieve information for by using either:
- device name
- uuid
Step 1: Retrieve Phone Information
In this example, we will use the getPhone API to retrieve information about the phone. We are going to pass in the device name of the phone.
addLine
Request Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.cisco.com/AXL/API/8.5"> <soapenv:Header/> <soapenv:Body> <ns:getPhone sequence="?"> <!--You have a CHOICE of the next 2 items at this level--> <name>SEPE8B7480316D6</name> </ns:getPhone> </soapenv:Body> </soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:getPhoneResponse xmlns:ns="http://www.cisco.com/AXL/API/8.5">
<return>
<phone uuid="{FBBA4DE1-D2AF-1F85-8A1B-8631319266E0}">
<name>SEPE8B7480316D6</name>
<description>SEPE8B7480316D6</description>
<product>Cisco 6961</product>
<model>Cisco 6961</model>
<class>Phone</class>
<protocol>SCCP</protocol>
<protocolSide>User</protocolSide>
<callingSearchSpaceName/>
<devicePoolName uuid="{1B1B9EB6-7803-11D3-BDF0-00108302EAD1}">Default</devicePoolName>
<commonDeviceConfigName/>
<commonPhoneConfigName uuid="{AC243D17-98B4-4118-8FEB-5FF2E1B781AC}">Standard Common Phone Profile</commonPhoneConfigName>
<networkLocation>Use System Default</networkLocation>
<locationName uuid="{29C5C1C4-8871-4D1E-8394-0B9181E8C54D}">Hub_None</locationName>
<mediaResourceListName/>
<networkHoldMohAudioSourceId/>
<userHoldMohAudioSourceId/>
<automatedAlternateRoutingCssName/>
<aarNeighborhoodName/>
<loadInformation special="false">SCCP69xx.9-3-1-3</loadInformation>
<vendorConfig>
<disableSpeaker>false</disableSpeaker>
<disableSpeakerAndHeadset>false</disableSpeakerAndHeadset>
<pcPort>0</pcPort>
<settingsAccess>1</settingsAccess>
<voiceVlanAccess>0</voiceVlanAccess>
<videoCapability>0</videoCapability>
<webAccess>0</webAccess>
<daysBacklightNotActive>1,7</daysBacklightNotActive>
<backlightOnTime>07:30</backlightOnTime>
<backlightOnDuration>10:30</backlightOnDuration>
<backlightIdleTimeout>01:00</backlightIdleTimeout>
<backlightOnWhenIncomingCall>1</backlightOnWhenIncomingCall>
<spanToPCPort>1</spanToPCPort>
<loggingDisplay>1</loggingDisplay>
<recordingTone>0</recordingTone>
<recordingToneLocalVolume>100</recordingToneLocalVolume>
<recordingToneRemoteVolume>50</recordingToneRemoteVolume>
<rtcp>0</rtcp>
<moreKeyReversionTimer>5</moreKeyReversionTimer>
<enableCdpSwPort>1</enableCdpSwPort>
<enableCdpPcPort>1</enableCdpPcPort>
<enableLldpSwPort>1</enableLldpSwPort>
<enableLldpPcPort>1</enableLldpPcPort>
<powerPriority>0</powerPriority>
<eapAuthentication>0</eapAuthentication>
<LineKeyBarge>0</LineKeyBarge>
</vendorConfig>
<versionStamp>{1350331162-79CDDAEA-8032-4F17-A6B7-86D46C3FF347}</versionStamp>
<traceFlag>false</traceFlag>
<mlppDomainId/>
<mlppIndicationStatus>Default</mlppIndicationStatus>
<preemption>Default</preemption>
<useTrustedRelayPoint>Default</useTrustedRelayPoint>
<retryVideoCallAsAudio>true</retryVideoCallAsAudio>
<securityProfileName uuid="{8D2A6DED-F1F7-4A7B-A250-DB21C469DAC1}">Cisco 6961 - Standard SCCP Non-Secure Profile</securityProfileName>
<sipProfileName/>
<cgpnTransformationCssName/>
<useDevicePoolCgpnTransformCss>true</useDevicePoolCgpnTransformCss>
<geoLocationName/>
<geoLocationFilterName/>
<sendGeoLocation>false</sendGeoLocation>
<lines>
<line uuid="{DA56F55D-3B6C-E489-EF45-6D50D0E3F008}">
<index>2</index>
<label/>
<asciiLabel/>
<display/>
<dirn uuid="{FB67F928-11EF-9500-58EA-DFC6BA9BC042}">
<pattern>1010</pattern>
<routePartitionName/>
</dirn>
<ringSetting>Use System Default</ringSetting>
<consecutiveRingSetting>Use System Default</consecutiveRingSetting>
<ringSettingIdlePickupAlert>Use System Default</ringSettingIdlePickupAlert>
<ringSettingActivePickupAlert>Use System Default</ringSettingActivePickupAlert>
<displayAscii/>
<e164Mask/>
<dialPlanWizardId/>
<mwlPolicy>Use System Policy</mwlPolicy>
<maxNumCalls>2</maxNumCalls>
<busyTrigger>1</busyTrigger>
<callInfoDisplay>
<callerName>true</callerName>
<callerNumber>false</callerNumber>
<redirectedNumber>false</redirectedNumber>
<dialedNumber>true</dialedNumber>
</callInfoDisplay>
<recordingProfileName/>
<monitoringCssName/>
<recordingFlag>Call Recording Disabled</recordingFlag>
<audibleMwi>Default</audibleMwi>
<speedDial/>
<partitionUsage>General</partitionUsage>
<associatedEndusers/>
<missedCallLogging>true</missedCallLogging>
</line>
<line uuid="{B47D9D00-711D-022C-7473-B282245B9897}">
<index>1</index>
<label/>
<asciiLabel/>
<display/>
<dirn uuid="{A2AE8CF2-CC26-3913-861C-AFB95C1C602B}">
<pattern>6961</pattern>
<routePartitionName/>
</dirn>
<ringSetting>Use System Default</ringSetting>
<consecutiveRingSetting>Use System Default</consecutiveRingSetting>
<ringSettingIdlePickupAlert>Use System Default</ringSettingIdlePickupAlert>
<ringSettingActivePickupAlert>Use System Default</ringSettingActivePickupAlert>
<displayAscii/>
<e164Mask/>
<dialPlanWizardId/>
<mwlPolicy>Use System Policy</mwlPolicy>
<maxNumCalls>1</maxNumCalls>
<busyTrigger>1</busyTrigger>
<callInfoDisplay>
<callerName>true</callerName>
<callerNumber>false</callerNumber>
<redirectedNumber>false</redirectedNumber>
<dialedNumber>true</dialedNumber>
</callInfoDisplay>
<recordingProfileName/>
<monitoringCssName/>
<recordingFlag>Call Recording Disabled</recordingFlag>
<audibleMwi>Default</audibleMwi>
<speedDial/>
<partitionUsage>General</partitionUsage>
<associatedEndusers/>
<missedCallLogging>true</missedCallLogging>
</line>
</lines>
<numberOfButtons>18</numberOfButtons>
<phoneTemplateName uuid="{06806631-8E35-41E8-89AF-B4C05B56D030}">Standard 6961 SCCP</phoneTemplateName>
<speeddials/>
<busyLampFields/>
<primaryPhoneName/>
<ringSettingIdleBlfAudibleAlert>Default</ringSettingIdleBlfAudibleAlert>
<ringSettingBusyBlfAudibleAlert>Default</ringSettingBusyBlfAudibleAlert>
<blfDirectedCallParks/>
<addOnModules/>
<userlocale/>
<networkLocale/>
<idleTimeout/>
<authenticationUrl/>
<directoryUrl/>
<idleUrl/>
<informationUrl/>
<messagesUrl/>
<proxyServerUrl/>
<servicesUrl/>
<services/>
<softkeyTemplateName/>
<defaultProfileName/>
<enableExtensionMobility>false</enableExtensionMobility>
<currentProfileName/>
<loginTime/>
<loginDuration/>
<currentConfig>
<userHoldMohAudioSourceId/>
<phoneTemplateName uuid="{06806631-8E35-41E8-89AF-B4C05B56D030}">Standard 6961 SCCP</phoneTemplateName>
<mlppDomainId/>
<mlppIndicationStatus>Default</mlppIndicationStatus>
<preemption>Default</preemption>
<softkeyTemplateName/>
<ignorePresentationIndicators>false</ignorePresentationIndicators>
<singleButtonBarge>Off</singleButtonBarge>
<joinAcrossLines>Off</joinAcrossLines>
<callInfoPrivacyStatus>Default</callInfoPrivacyStatus>
<dndStatus/>
<dndRingSetting/>
<dndOption>Use Common Phone Profile Setting</dndOption>
<alwaysUsePrimeLine>Default</alwaysUsePrimeLine>
<alwaysUsePrimeLineForVoiceMessage>Default</alwaysUsePrimeLineForVoiceMessage>
<emccCallingSearchSpaceName xsi:nil="true" uuid="" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<deviceName/>
<model/>
<product/>
<deviceProtocol/>
<class/>
<addressMode/>
<allowAutoConfig/>
<remoteSrstOption/>
<remoteSrstIp/>
<remoteSrstPort/>
<remoteSipSrstIp/>
<remoteSipSrstPort/>
<geolocationInfo/>
</currentConfig>
<singleButtonBarge>Off</singleButtonBarge>
<joinAcrossLines>Off</joinAcrossLines>
<builtInBridgeStatus>Default</builtInBridgeStatus>
<callInfoPrivacyStatus>Default</callInfoPrivacyStatus>
<hlogStatus>On</hlogStatus>
<ownerUserName/>
<ignorePresentationIndicators>false</ignorePresentationIndicators>
<packetCaptureMode>None</packetCaptureMode>
<packetCaptureDuration>0</packetCaptureDuration>
<subscribeCallingSearchSpaceName/>
<rerouteCallingSearchSpaceName/>
<allowCtiControlFlag>true</allowCtiControlFlag>
<presenceGroupName uuid="{AD243D17-98B4-4118-8FEB-5FF2E1B781AC}">Standard Presence group</presenceGroupName>
<unattendedPort>false</unattendedPort>
<requireDtmfReception>false</requireDtmfReception>
<rfc2833Disabled>false</rfc2833Disabled>
<certificateOperation>No Pending Operation</certificateOperation>
<certificateStatus>None</certificateStatus>
<upgradeFinishTime/>
<deviceMobilityMode>Default</deviceMobilityMode>
<remoteDevice>false</remoteDevice>
<dndOption>Use Common Phone Profile Setting</dndOption>
<dndRingSetting/>
<dndStatus>false</dndStatus>
<isActive>true</isActive>
<isDualMode>false</isDualMode>
<mobilityUserIdName/>
<phoneSuite>Default</phoneSuite>
<phoneServiceDisplay>Default</phoneServiceDisplay>
<isProtected>false</isProtected>
<mobileSmartClientProfileName/>
<mtpRequired>false</mtpRequired>
<mtpPreferedCodec>711ulaw</mtpPreferedCodec>
<dialRulesName/>
<sshUserId>sshtest</sshUserId>
<digestUser/>
<outboundCallRollover>No Rollover</outboundCallRollover>
<hotlineDevice>false</hotlineDevice>
<secureInformationUrl/>
<secureDirectoryUrl/>
<secureMessageUrl/>
<secureServicesUrl/>
<secureAuthenticationUrl/>
<secureIdleUrl/>
<alwaysUsePrimeLine>Default</alwaysUsePrimeLine>
<alwaysUsePrimeLineForVoiceMessage>Default</alwaysUsePrimeLineForVoiceMessage>
<featureControlPolicy/>
<deviceTrustMode>Not Trusted</deviceTrustMode>
</phone>
</return>
</ns:getPhoneResponse>
</soapenv:Body>
</soapenv:Envelope>