Add a Cisco Jabber Web Phone Device Using AXL

Problem

Your application needs to add and configure a new device for a Cisco Jabber web phone, and associate this device with an existing user.

Solution

Cisco UC Manager Version: 8.5

To add and configure a Jabber device, we need to complete the following steps:

Step 1: Add a new line

First, we will look at the request and response for adding a line. When you use the addLine method, you need to pass in the DN value for the line in the pattern element of the request. The response returns the uuid of the new line that is created.

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:addLine>
								<line>
									<pattern>4107</pattern>
								</line>
							</ns:addLine>
						</soapenv:Body>
					</soapenv:Envelope>
	
                            <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
                                <soapenv:Body>
                                    <ns:addLineResponse xmlns:ns="http://www.cisco.com/AXL/API/8.5">
                                        <return>{A3076BE9-E8AD-7714-0C8E-0803C09A7234}</return>
                                    </ns:addLineResponse>
                                </soapenv:Body>
                            </soapenv:Envelope>

Step 2: Add a new phone

Next, we will use the addPhone method to add a new phone for the Jabber device. We will associate the new line that we created in the step 1 above with this phone by passing in the uuid for the line. We will also associate an existing user with the phone by passing in the user id.

When adding a Jabber Web Phone device, you need to be sure to specify the following. See the Jabber SDK CUCM Setup Guide for more details.

  • Phone Type - Cisco Unified Client Services Framework
  • Device Name - The device name should be of the form: ECP<username>.
  • Description - specify a description
  • Device Pool - select the desired device pool
  • Phone Button Template - Set to Standard Client Services Framework
  • Device Security Profile - Set to Cisco Unified Client Services Framework - Standard SIP Non-Secure
  • SIP Profile - Set to Standard SIP Profile
addPhone
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:addPhone>
								<phone>
									<name>ECPuser1</name>
									<!--Optional:-->
									<description>Mandy Jabber</description>
									<product>Cisco Unified Client Services Framework</product>
									<class>Phone</class>
									<protocol>SIP</protocol>
									<protocolSide>User</protocolSide>
									<devicePoolName>Default</devicePoolName>

									<securityProfileName>Cisco Unified Client Services Framework - Standard SIP Non-Secure</securityProfileName>
									<!--Optional:-->
									<sipProfileName>Standard SIP Profile</sipProfileName>
									<!--Optional:-->
									<lines>
										<!--You have a CHOICE of the next 2 items at this level-->
										<!--1 or more repetitions:-->
										<line>
											<index>1</index>
											<dirn uuid="EAAB1D52-988E-EF84-F6A3-FE791A8EF6E3"></dirn>
											<associatedEndusers>
												<!--Zero or more repetitions:-->
												<enduser>
													<userId>user1</userId>
												</enduser>
											</associatedEndusers>
										</line>
									</lines>
									<phoneTemplateName>Standard Client Services Framework</phoneTemplateName>
								</phone>
							</ns:addPhone>
						</soapenv:Body>
					</soapenv:Envelope>
	
                            <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
                                <soapenv:Body>
                                    <ns:addPhoneResponse xmlns:ns="http://www.cisco.com/AXL/API/8.5">
                                        <return>{35232B68-2404-A4D3-7E98-3F3518EA65AD}</return>
                                </ns:addPhoneResponse>
                                </soapenv:Body>
                            </soapenv:Envelope>