sending cupi requests to cisco unity using postman by stack8

19
Managed Services No Hardware Sending CUPI requests to Cisco Unity using Postman

Upload: mike-spooner

Post on 07-Feb-2017

15 views

Category:

Technology


3 download

TRANSCRIPT

Page 1: Sending CUPI requests to Cisco Unity using Postman by Stack8

Managed Services

No Hardware

Sending CUPI requests to Cisco Unity using Postman

Page 2: Sending CUPI requests to Cisco Unity using Postman by Stack8

Sending CUPI requests to Cisco Unity using Postman

The Cisco Unity Provisioning Interface (CUPI) allows a UC Administrator to programmatically perform moves, adds, and changes to various entries in Cisco Unity (users, contacts, distribution lists, and call handlers) through a simple REST API.

The following SlideShare will provide step-by-step instructions on how to perform a request to the CUPI API using Postman.

To read the original article and to receive tips and insights on Cisco Unified Communications direct to your inbox please visit: Stack8

Page 3: Sending CUPI requests to Cisco Unity using Postman by Stack8

Section 1: Creating an administrator account in

Cisco UnityPrerequisite: Administrator Account in Cisco Unity. 

Step 1.1: Login to the Cisco Unity Connection Administration page.

www.stack8.com

Page 4: Sending CUPI requests to Cisco Unity using Postman by Stack8

Step 1.2: Go to Users.

www.stack8.com

Section 1: Creating an administrator account in

Cisco Unity

Page 5: Sending CUPI requests to Cisco Unity using Postman by Stack8

Step 1.3: Click on Add New.

www.stack8.com

Section 1: Creating an administrator account in

Cisco Unity

Page 6: Sending CUPI requests to Cisco Unity using Postman by Stack8

Step 1.4: Click on the User Type dropdown and select the User Without Mailbox type.

www.stack8.com

Section 1: Creating an administrator account in

Cisco Unity

Page 7: Sending CUPI requests to Cisco Unity using Postman by Stack8

Step 1.5: Click on the Based on Template dropdown and select the administratortemplate.

www.stack8.com

Section 1: Creating an administrator account in

Cisco Unity

Page 8: Sending CUPI requests to Cisco Unity using Postman by Stack8

Step 1.6: Provide a new user alias.

www.stack8.com

Section 1: Creating an administrator account in

Cisco Unity

Page 9: Sending CUPI requests to Cisco Unity using Postman by Stack8

Step 1.7: Click Save.

www.stack8.com

Section 1: Creating an administrator account in

Cisco Unity

Page 10: Sending CUPI requests to Cisco Unity using Postman by Stack8

Step 1.8: Now that the user has been created, ensure to Edit -- Change Password to provide credentials for your newly created account.

www.stack8.com

Section 1: Creating an administrator account in

Cisco Unity

Page 11: Sending CUPI requests to Cisco Unity using Postman by Stack8

Section 2: Sending a CUPI request to Cisco Unity with

PostmanFor our example, we will request a user’s information using an account alias. 

Refer to the Cisco Unity Connection Provisioning Interface (CUPI) API for the full list of possible transactions.

www.stack8.com

Page 12: Sending CUPI requests to Cisco Unity using Postman by Stack8

Section 2: Sending a CUPI request to Cisco Unity with

PostmanStep 2.1: Open Postman (Available at http://www.getpostman.com/)

Step 2.2: Select GET from the request dropdown menu.

www.stack8.com

Page 13: Sending CUPI requests to Cisco Unity using Postman by Stack8

Section 2: Sending a CUPI request to Cisco Unity with

PostmanStep 2.3: In the URL tab, provide the URL to query the user by

alias (replace the IP and alias with your values)https://<ip-or-hostname-to-cuc>/vmrest/users/?

query=(alias is alias)

www.stack8.com

Page 14: Sending CUPI requests to Cisco Unity using Postman by Stack8

Section 2: Sending a CUPI request to Cisco Unity with

PostmanStep 2.4: Go to the Authorization tab and select Basic Auth.

www.stack8.com

Page 15: Sending CUPI requests to Cisco Unity using Postman by Stack8

Section 2: Sending a CUPI request to Cisco Unity with

PostmanStep 2.5: Provide the credentials for

the System Administrator user you created in Unity and click Update request.

www.stack8.com

Page 16: Sending CUPI requests to Cisco Unity using Postman by Stack8

Section 2: Sending a CUPI request to Cisco Unity with

PostmanStep 2.6: Press Send and then review the returned XML response containing the details of the voicemail account.

www.stack8.com

Page 17: Sending CUPI requests to Cisco Unity using Postman by Stack8

Congratulations! You have successfully sent a CUPI API request to your CUC using Postman. If you are interested in building solutions to help your organization with their UC environment using CUPI, please feel free to reach out to our Software Solutions Team. Our team of experts uses AXL and CUPI extensively for a variety of software products, including SMACS our Stack8, Moves, Adds, and Changes Solution.

Sending CUPI requests to Cisco Unity using Postman

www.stack8.com

Page 18: Sending CUPI requests to Cisco Unity using Postman by Stack8

About Stack8Stack8 is a new breed of Cisco Solutions Partner. The founders, former Cisco guys, created the company to provide Cisco Solutions that adapt to each customer’s reality. Our focus is on how people use Cisco technologies and ensuring they get the most out of it.

Stack8 is built on three pillars, each born out of the prevailing problems our customers face today: • Professional Services: the how - getting you set up quickly and painlessly • Managed Services: the help – an always live extension of your team • Software Solutions: the tools - improving and optimizing your operations

We realize that the only way for us to truly help our customers is to provide services and solutions rallied around taking that complexity out. We work hard every day to make Cisco easy.

Founded in 2010, Stack8 Technologies is an independent, privately held company based in Montreal, Canada. www.stack8.com

Page 19: Sending CUPI requests to Cisco Unity using Postman by Stack8

Stack8 Corporate Headquarters1550 Rue Metcalfe #500,

Montréal, QC H3A 1X6Canada

Tel: +1-514-940-1600Toll-free: 1-844-940-1600Email: [email protected]

www.stack8.com