Free XML Services for IP Phones

7/23/2019 Free XML Services for IP Phones

1/27

Corporate Headquarters:

Singlewire Software 2601 West Beltline Highway #510Madison, WI 53713

2014 Singlewire. All rights reserved.

Free IP Phone Services

Configuration and Usage Guide for a CiscoUnifiedCommunications Manager Environment


2/27

2014 Singlewire. All rights reserved.

All referenced trademarks are trademarks of their respective owners and our reference tothem does not imply or indicate any approval, endorsement, sponsorship or affiliation withsuch owners unless such approval, endorsement, sponsorship or affiliation is expresslyindicated.

Last updated: May 22, 2014


3/27

Table of ContentsOverview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Intended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Create the Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Subscribe Phones to the Service . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Local Weather . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Stock Ticker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Area Code Lookup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Currency Converter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Appendix. Optional Advanced Service Setup . . . . . . . . . . . . . . . . 21

Create Individual Services Instead of a Menu . . . . . . . . . . . . . . . . . 21

Create Services that Require No Prompting . . . . . . . . . . . . . . . . . . 24


4/27

1

Cisco Unified Communications Manager Environment

Version 2.0

Free IP Phone Services Configuration and Usage Guide

Overview

OverviewSinglewire Software offers free IP phone services for use on most models of Cisco IP phones. Theseservices (completed through web requests) offer helpful answers to commonly asked questions such ascurrency conversion, local time, and local weather, to name a few. All of Singlewires free IP phone

services are available through theApplicationsor Servicesbutton on your phone, depending on themodel Cisco IP phone you have.

Intended Audience

The configuration of the services should be performed in Cisco Unified Communications Manager(CUCM); Configuration on page 2is intended for a CUCM administrator. However, Usage onpage 9is intended for both administrators and users.

Support

There is no technical support offered for these free services. They are offered on good faith to anyonein the world who would care to use them. If you have ideas for other useful free services, please [email protected].
mailto:[email protected]:[email protected]


5/27

2


Version 2.0


Configuration

ConfigurationThe configuration of Singlewires free IP phone services, done entirely on Ciscos UnifiedCommunications Manager (CUCM), consists of creating a phone service that contains the URL for thefree IP phone services and assigning that phone service to your phones.

Create the Service

When creating a service in CUCM, you have two options:

Subscribe every phone (enterprise subscription)

Subscribe individual phones (non-enterprise subscription)

An enterprise subscription service subscribes all phones in a CUCM cluster to the service automatically.A non-enterprise subscription service allows you to selectively assign phones to it.

Note With a non-enterprise subscription service, it is still possible to subscribe all phones in the CUCMcluster using the Bulk Administration Tool, but this is outside the scope of this document.

Step 1 Open and log into your CUCM server. The Cisco Unified CM Administration page appears.


6/27

3


Version 2.0


Configuration

Step 2 Go to Device| Device Settings| Phone Services. The Find and List IP Phone Services pageappears.

Step 3 Click theAdd Newbutton. The IP Phone Services Configuration page appears.

Step 4 Enter Singlewire Servicesin the Service Namefield.

Step 5 Press theTabkey to populate theASCII Service Namefield with Singlewire Servicesas well.

Step 6 Enter Singlewire Free Hosted Servicesin the Service Descriptionfield.

Step 7 Enter http://www.singlewire.com/freeservices/menuin the Service URLfield.

Step 8 Enter http://www.singlewire.com/freeservices/menuin the Secure Service URLfield.

Tip Entering this URL creates a menu on your phones that contains all of the free services. If youwant to create single services, i.e. just local weather or just currency conversion, use the stepsin Create Individual Services Instead of a Menu on page 21.

Step 9 Select XML Servicefrom the Service Category dropdown menu.

Step 10 Select Standard IP Phone Servicefrom the Service Typedropdown menu.

Step 11 Enter Singlewire Softwarein the Service Vendorfield.


7/27

4


Version 2.0


Configuration

Step 12 Leave the Service Versionfield blank.

Step 13 Select the Enablecheckbox.

Step 14 Select the Enterprise Subscriptioncheckbox if you want every phone in your CUCM clustersubscribed to this service. Leave it unselected if you want to selectively subscribe phones to this service

Note If you select the Enterprise Subscriptioncheckbox, your phones may reset when you savethis configuration.

Step 15 Click the Savebutton. The IP Phone Services Configuration page refreshes and you have completedadding the service.

Tip Further customization tips for the service (e.g. single services instead of a menu or no-promptservices) can be found in Appendix. Optional Advanced Service Setup on page 21.

If you selected the Enterprise Subscriptioncheckbox, the service will not show up as a service towhich phones can be subscribed; an enterprise subscription service is automatically placed on allphones in a CUCM cluster. Skip the next section, Subscribe Phones to the Service on page 5, andcontinue with Usage on page 9.

If you didnt select the Enterprise Subscriptioncheckbox, you will need to complete the steps inSubscribe Phones to the Service on page 5before continuing with Usage on page 9.


8/27

5


Version 2.0


Configuration

Subscribe Phones to the Service

After you have created the Singlewire Services service, you will want to assign phones to it.

Step 1 Go to Device| Phone. The Find and List Phones page appears.

Step 2 Click the Findbutton to display a list of phones. The Find and List Phones page refreshes.


9/27

6


Version 2.0


Configuration

Step 3 Click the Device Namelink for the phone to which you want to assign your service. The PhoneConfiguration page appears.


10/27

7


Version 2.0


Configuration

Step 4 Select Subscribe/Unsubscribe Servicesfrom the Related Linksdropdown menu and click the Gobutton. The Subscribed Cisco IP Phone Services window for that phone appears.

Step 5 Select Singlewire Servicesfrom the Select a Service dropdown menu and click the Nextbutton. The

Subscribed Cisco IP Phone Services window refreshes.


11/27

8


Version 2.0


Configuration

Step 6 Click the Subscribebutton. The Subscribed Cisco IP Phone Services window refreshes.

NoteClicking the Subscribebutton may cause this phone to reset.

Step 7 Close the Subscribed Cisco IP Phone Services window. This phone is now subscribed to the SinglewireServices service.

Step 8 Repeat Steps 1through 7for each phone youd like to subscribe to the Singlewire Services service.


12/27

9


Version 2.0


Usage

UsageOnce youve created the Singlewire Services service and appropriately assigned it to phones, you canaccess the free IP phone services from any phones to which the phone service was assigned.

Step 1 Press theApplicationsbutton ( ) on your phone. The Applications window appears.

Note For 79XX series phones, press the Servicesbutton.


13/27

10


Version 2.0


Usage

Step 2 Highlight Singlewire Servicesusing the arrow buttons and press the Opensoftkey. The SinglewireServices window appears.

Step 3 Use the arrow keys to highlight the service you want to access and press the Selectsoftkey.

Step 4 Continue with the steps for the particular service you selected:

Local Weather on page 11

Stock Ticker on page 14

Area Code Lookup on page 16

Currency Converter on page 18


14/27

11


Version 2.0


Usage

Local Weather

The Local Weather service allows you to check the weather in an area based on a specified ZIP/postalcode.

Step 1 Access the Singlewire Services window (follow Steps 1through 3on page 10) and select LocalWeather. The Weather Check window appears.


15/27

12


Version 2.0


Usage

Step 2 Use the arrow keys to highlight US ZIP Code, Canadian Postal Code, or UK Postal Code. Pressthe Selectsoftkey. The Weather Check window refreshes with your selection. This guide uses a U.S.ZIP code as an example.


16/27

13


Version 2.0


Usage

Step 3 Use the numbered keypad to enter your ZIP/postal code. Press the Submitsoftkey. The Local Weatherwindow appears with the weather information for the area of the ZIP/postal code you entered.


17/27

14


Version 2.0


Usage

Stock Ticker

The Stock Ticker service allows you to view stock information for a specific company.

Step 1 Access the Singlewire Services window (follow Steps 1through 3on page 10) and select Stock Ticker.

The Stock Quote window appears.


18/27

15


Version 2.0


Usage

Step 2 Use the numbered keypad to enter a stock symbol for a particular company. Press the Submitsoftkey.The Stock Quote window refreshes with the stock information you requested.

Tip Letters can be entered using multi-tap text entry, e.g. pressing the 2button three times enters a

c.


19/27

16


Version 2.0


Usage

Area Code Lookup

The Area Code Lookup service lets you see information about a specified area code.

Step 1 Access the Singlewire Services window (follow Steps 1through 3on page 10) and selectArea Code

Lookup. The Area Code Lookup window appears.


20/27

17


Version 2.0


Usage

Step 2 Use the numbered keypad to enter an area code. Press the Submitsoftkey. The Area Code windowappears with the location of the area code you entered.


21/27

18


Version 2.0


Usage

Currency Converter

The Currency Converter service allows you to convert currency amounts from one type to another.

Step 1 Access the Singlewire Services window (follow Steps 1through 3on page 10) and select Currency

Converter. The Currency Conversion window appears.


22/27

19


Version 2.0


Usage

Step 2 Use the arrow buttons and numbered keypad to enter the amount youd like to convert, the currency itis presently, and the currency with which youre comparing it, e.g. 10 from usd to eur. Press the Submitsoftkey. The Currency Conversion window refreshes with your converted currency.

Tip To view valid currency options, enter an amount and press the Submitsoftkey. A help windowwill appear listing available currencies.


23/27

20


Version 2.0


Troubleshooting

TroubleshootingBecause these services are hosted on the Internet, you will want to make sure that your phones canreach the services. The following questions may help you in troubleshooting your environment:

Can you reach the URL with a web browser, and does it return XML?

Can you access the URL with a web browser from a PC on the voice VLAN, and does it returnXML?

Do the phones have access to the Internet?

Is there a proxy server blocking direct communication?

Is the Cisco IP phone service created correctly?

Is the service subscribed to the phone?

Was the phone reset so the service(s) can show up properly?

The most useful tool to troubleshoot will be to use a protocol analyzer like Wireshark(http://www.wireshark.org/) and capture the traffic from the phone when accessing the services. This

can be done by creating a monitor session (span port) on the switch to which the phone is connected.Alternatively, you can set the Span to PC Portsetting in CUCM and plug your PC into the back of thephone to capture the traffic.

The capture should show:

The phone making a Servicesmenu request to CUCM

CUCM returning the Servicesmenu

The phone making an HTTP request to singlewire.com

Singlewire.com returning the service data
http://www.wireshark.org/http://www.wireshark.org/


24/27

21


Version 2.0


Appendix. Optional Advanced Service Setup

Appendix. Optional Advanced Service SetupIt is possible to customize your free IP phone services, such as offering individual services instead of amenu or creating services that skip specific prompts.

Create Individual Services Instead of a Menu

If you only want users to have access to one (or some) of the services, it is possible to create instancesfor each individual service instead of the menu shown in Step 2 on page 10. To do this, you will needto modify the service you created in Create the Service on page 2.

Step 1 Open and log into your CUCM server. The Cisco Unified CM Administration page appears.

Step 2 Go to Device| Device Settings| Phone Services. The Find and List IP Phone Services pageappears.


25/27

22


Version 2.0



Step 3 Click the Findbutton. The Find and List IP Phone Services page refreshes with a list of services.


26/27

23


Version 2.0



Step 4 Click the Singlewire Services link. The IP Phone Services Configuration page appears.

Step 5 Use the following table to fill in the Service Name,ASCII Service Name, Service Description,Service URL, and Secure Service URL fields:

Step 6 Enter a name from the Service columnin the Service Namefield.

Step 7 Press theTabkey to populate theASCII Service Namefield with that same service name.

Step 8 Enter that same service name in the Service Descriptionfield.

Step 9 Enter a URL from the URL column that corresponds to your service in the Service URLfield.

Step 10 Enter that same URL in the Secure Service URLfield.

Step 11 Select XML Servicefrom the Service Category dropdown menu.

Step 12 Select Standard IP Phone Servicefrom the Service Typedropdown menu.

Step 13 Enter Singlewire Softwarein the Service Vendorfield.

Step 14 Leave the Service Versionfield blank.

Service URL

Main Service Menu http://www.singlewire.com/freeservices/menu

Local Weather http://www.singlewire.com/freeservices/localweather

Stock Ticker http://www.singlewire.com/freeservices/stockquote

Area Code Lookup http://www.singlewire.com/freeservices/areacode

Currency Converter http://www.singlewire.com/freeservices/currency


27/27



Step 15 Select the Enablecheckbox.

Step 16 Select the Enterprise Subscriptioncheckbox if you want every phone in your CUCM clustersubscribed to this service. Leave it unselected if you want to selectively subscribe phones to this service

Note If you select the Enterprise Subscriptioncheckbox, your phones may reset when you savethis configuration.

Step 17 Click the Savebutton. You have completed modifying the service

If you selected the Enterprise Subscriptioncheckbox, the service will not show up as a service towhich phones can be subscribed; an enterprise subscription service is automatically placed on allphones in a CUCM cluster.

If you didnt select the Enterprise Subscriptioncheckbox, you will need to complete the steps inSubscribe Phones to the Service on page 5.

Create Services that Require No Prompting

For common, repetitive queries, you can create a service with hard-coded parameters, allowing you toskip prompts. For example, suppose you want to assign the weather service to a specific location andskip entering the ZIP code every time. You can set a parameter in the services URL so that when theservice is accessed, it always goes right to the local weather.

Instead of entering the URLs specified in Step 5 on page 23, youd add a question mark (?) followed bythe parameters from this table:

An example of the weather in Madison, WI would then be:http://www.singlewire.com/freeservices/localweather?where=53703

An example of Ciscos stock ticker would then be:http://www.singlewire.com/freeservices/stockquote?sym=csco

Service Parameter Defined

Local Weather where Zip CodeStock Ticker sym Stock Symbol

Area Code Lookup npa Area Code

Currency Converter amt

src

tgt

Numeric Amount

Current Currency

Converted Currency

Documents

Free XML Services for IP Phones