Identifying The Capabilities Of Ip Phone Clients; X-Ciscoipphonemodelname; X-Ciscoipphonedisplay; X-Ciscoipphonesdkversion - Cisco OL-18696-01 Development Manual

Chapter 5 HTTP Requests and Header Settings

Identifying the Capabilities of IP Phone Clients

XML services are supported on many Cisco Unified IP Phones, so web application servers must identify
the capabilities of the requesting IP phone to optimize the content returned to the phone. For example,
if the requesting phone is a Cisco Unified IP Phone 7960, which cannot support color PNG images, the
application server must be able to identify this and return a gray scale CIP image instead.
The IP phone client request to send the relevant information from the IP phone to the web server
application includes three (3) HTTP headers:
•
•
•

x-CiscoIPPhoneModelName

This Cisco-proprietary header contains the Cisco manufacturing Model Name of the device, which can
typically be found by going to Settings > Model Information, but varies between different models.
Some examples of manufacturing Model Names are CP-7960, CP-7960G, CP-7940G, CP-7905G, and
CP-7970G.

x-CiscoIPPhoneDisplay

This Cisco-proprietary header contains the display capabilities of the requesting device with the
following four parameters (listed in the order in which they appear):
•
•
•
•
These parameters get separated by commas as shown in the following example of a
Cisco Unified IP Phone 7970 header:
x-CiscoIPPhoneDisplay: 298, 168, 12, C
The pixel resolutions advertised by the device define the area of the display accessible by the phone
Note
services; not the actual resolution of the display.

x-CiscoIPPhoneSDKVersion

This Cisco-proprietary header contains the version of the IP Phone Services SDK that the requesting
phone supports. The HTTP header does not specify which URIs are supported. Therefore, you must
check the "Supported URIs" matrix in the IP Phone Services SDK to determine which URIs are
supported based on the Phone Model Name and supported SDK version.
See
OL-18696-01
x-CiscoIPPhoneModelName
x-CiscoIPPhoneDisplay
x-CiscoIPPhoneSDKVersion
Width (in pixels)
Height (in pixels)
Color depth (in bits)
A single character indicating whether the display is color (''C'') or gray scale (''G'')
Table 4-1 table to find which IP phone models support the URIs documented in this SDK.
Identifying the Capabilities of IP Phone Clients
Cisco Unified IP Phone Services Application Development Notes
5-7