topic Re: listPhone AXL API call in Management

listPhone AXL API call

snikamvyopta — Mon, 13 Oct 2014 21:36:00 GMT

I am new to CUCM AXL APIs and currently using SoapUI 5.0 for testing CUCM AXL APIs.

I was able to enable AXL on CUCM and have also verified that, the AXL Web Service is working and accepting requests. I was able to get a response for an API such as getCCMVersion.

But for few APIs, where it asks for a name in searchCriteria, I am not able to get any response back. For a name, I specified a name which I see on CUCM, which in our case is 'cucmdev'. In the following schema documentation, it mentions: "The device name,using only URL-friendly characters".

What am I missing here?

Following is a schema I am referring to:

https://developer.cisco.com/media/axl-schema-10-0/AXLSoap.html

Also, there are most of the APIs which have optional attributes to be mentioned in the API request, so not specifying them at all should be fine, right? What does these means: sequence="?" ctiid="?" uuid="?"

Re: listPhone AXL API call

dstaudt — Mon, 13 Oct 2014 23:23:49 GMT

Note, the name given to listPhone should be the devicename of the phone itself - typically of the form 'SEP[MAC address]' for most Cisco phones. If you are looking to get a list of phones associated to a particular user, try the getUser request.

Re: listPhone AXL API call

snikamvyopta — Tue, 14 Oct 2014 14:38:05 GMT

Hi dstaudt,

For some reason, none of the APIs except the one I mentioned works for me.

For example: when I tried getUser following is the response:

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.cisco.com/AXL/API/9.1">

<soapenv:Header/>

<soapenv:Body>

<ns:getUser sequence="?">

<userid>vyopta</userid>

</ns:getUser>

</soapenv:Body>

</soapenv:Envelope>

Response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">

<soapenv:Body>

<soapenv:Fault>

<faultcode>soapenv:Server</faultcode>

<faultstring>Item not valid: The specified User was not found</faultstring>

<axlmessage>Item not valid: The specified User was not found</axlmessage>

<request>getUser</request>

</axlError>

</detail>

</soapenv:Fault>

</soapenv:Body>

</soapenv:Envelope>

Re: listPhone AXL API call

dstaudt — Tue, 14 Oct 2014 17:53:49 GMT

I would note that you have 'sequence="?"', where "?" should be a number (normally incrementing, so you app can match requests with responses), however I believe AXL will just ignore this.

From the request/response, it seems that the end-user with user id of 'vyopta' simply doesn't exist in UCM. Can you confirm?

Re: listPhone AXL API call

snikamvyopta — Tue, 14 Oct 2014 18:02:56 GMT

vyopta user exists in CUCM and I have enabled Standard AXL API access role for this user as well.

dstaudt, Could you please give me details on what APIs we should use, to get all the phone related data from CUCM AXL APIs?

Also, any good documentation source will be really helpful.

Re: listPhone AXL API call

snikamvyopta — Tue, 14 Oct 2014 19:22:27 GMT

Hi dstaudt,

Cisco AXL API Demo - YouTube

I found this video on Youtube. He is making a ListPhone API call with two parameters- Default, AXLproxy.PhoneSearchKey.DevicePoolName at the time mark 4:08 in the video.

This is exactly what I want to do. Could you please let me know, what these two parameters he is providing for?

This is the default request that comes in SoapUI.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.cisco.com/AXL/API/9.1">

<soapenv:Header/>

<soapenv:Body>

<ns:listPhone sequence="?">

</searchCriteria>

</currentConfig>

</returnedTags>

</ns:listPhone>

</soapenv:Body>

</soapenv:Envelope>

Re: listPhone AXL API call

dstaudt — Tue, 14 Oct 2014 20:04:08 GMT

My guess would be that the 'vyopta' user has been created as an 'Application User' rather than as an 'End User'. <getApplicationUser> is used for the former, <getUser> for the latter.

From the video it looks like the <listPhones> request is being created with:

<devicePoolName>Default</devicePoolName>

</searchCriteria>

Re: listPhone AXL API call

jocreed — Wed, 15 Oct 2014 00:16:38 GMT

Are you using AXL version 10.0 or 9.1? in your original post you had mentioned the 10.0 schema but your later examples seem to reflect 9.1. Either way, here is an example (10.0 AXL version) of a listphone request and response that you would want to try. I only used some of the return tags to cut down on length. If you want all phone information remove the <returntags></returnTags> and all of the elements within the tags. Let either dstaudt or myself know if you have any more trouble. See below...

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.cisco.com/AXL/API/10.0">

<soapenv:Header/>

<soapenv:Body>

<ns:listPhone>

<devicePoolName>Default</devicePoolName>

</searchCriteria>

</returnedTags>

</ns:listPhone>

</soapenv:Body>

</soapenv:Envelope>

Response:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

<soap:Body>

<ns2:listPhoneResponse xmlns:ns2="http://www.cisco.com/AXL/API/10.0">

<model>Cisco IP Communicator</model>

<ownerUserName uuid="{EA799838-0615-1814-3847-40BE09BF6D03}">adrienne</ownerUserName>

</phone>

<model>Cisco 7926</model>

</phone>

<name>IPCMRAEU5UCM5X7</name>

<model>Cisco IP Communicator</model>

</phone>

<model>Ascom IP-DECT Device</model>

<ownerUserName uuid="{EA799838-0615-1814-3847-40BE09BF6D03}">adrienne</ownerUserName>

</phone>

<model>Syn-Apps Virtual Phone</model>

<ownerUserName uuid="{DAF3A2C3-3D7E-2611-842A-7B9582C27C24}">supadhya</ownerUserName>

</phone>

<model>IPTrade TAD</model>

<ownerUserName uuid="{DAF3A2C3-3D7E-2611-842A-7B9582C27C24}">supadhya</ownerUserName>

</phone>

<model>IPTrade TAD</model>

<ownerUserName uuid="{DAF3A2C3-3D7E-2611-842A-7B9582C27C24}">supadhya</ownerUserName>

</phone>

<model>Cisco DX650</model>

<ownerUserName uuid="{DAF3A2C3-3D7E-2611-842A-7B9582C27C24}">supadhya</ownerUserName>

</phone>

<name>CSFNPETRELEB54D</name>

<model>Cisco Unified Client Services Framework</model>

<ownerUserName uuid="{1F432427-E66B-071B-F231-46330E5CCB25}">nicholas</ownerUserName>

</phone>

<model>Cisco IP Communicator</model>

</phone>

<model>Cisco 8861</model>

<ownerUserName uuid="{EA799838-0615-1814-3847-40BE09BF6D03}">adrienne</ownerUserName>

</phone>

</return>

</ns2:listPhoneResponse>

</soap:Body>

</soap:Envelope>

Re: listPhone AXL API call

snikamvyopta — Wed, 15 Oct 2014 20:45:27 GMT

Thanks Kristopher!

I am having issues in getting responses for other few APIs. I will open another discussion for them.