Sample apps demonstrating common usage scenarios for the Cisco IP Phone Services XML interface.
Included samples:
-
ldap_directory.js
- Configurable sample allowing search by first/last/phone against a LDAP directory, providing output as a directory service; supports non-secure and StartTLS connections (<CiscoIPPhoneInput>
,<CiscoIPPhoneDirectory>
,<CiscoIPPhoneText>
). -
push_init.js
- Demonstrate clearing local call-history and closing services/messages/directories UIs, using HTTP POST (<CiscoIPPhoneExecute>
).
-
NodeJS/NPM (v18+) - Node.js and NPM to install dependencies.
If you do not have Node/NPM installed, see the following guides:
-
An IDE or developer code editor - This project was built using Visual Studio Code, which has great support for debugging Node.JS
-
Git - Source code management and sharing Git
This sample was tested using:
- Ubuntu 23.04
- Node.js 18.16.0
- CUCM 14
- OpenLDAP 2.4
-
From a terminal window, use
git
to clone this repo:git clone https://github.com/CiscoDevNet/ipps-javascript-samples
-
Change into the repo directory, and install dependencies with
npm
:cd ipps-javascript-samples npm install
-
Open the project in your IDE.
For Visual Studio code:
code .
-
Rename
.env.example
to.env
Then open it and enter your configuration options.
Be sure to save the file.
-
In VS Code, run/debug the app by switching to the Run tab, selecting the desired sample from the dropdown in the upper-left, then clicking the green arrow - or just press F5.
-
Most samples will require configuring a Phone Service in CUCM. This sample shows a typical configuration for the
ldap_directory.js
sample app: