You are on page 1of 42

IP Office

IP Office Configuration Service


Programmer's Guide

15-601473 Issue 03b - (20 February 2013)

2013 AVAYA All Rights Reserved.


Notice
While reasonable efforts have been made to ensure that the
information in this document is complete and accurate at the time of
printing, Avaya assumes no liability for any errors. Avaya reserves
the right to make changes and corrections to the information in this
document without the obligation to notify any person or organization
of such changes.
Documentation disclaimer
"Documentation" means information published by Avaya in varying
mediums which may include product information, operating
instructions and performance specifications that Avaya generally
makes available to users of its products. Documentation does not
include marketing materials. Avaya shall not be responsible for any
modifications, additions, or deletions to the original published version
of documentation unless such modifications, additions, or deletions
were performed by Avaya. End User agrees to indemnify and hold
harmless Avaya, Avaya's agents, servants and employees against all
claims, lawsuits, demands and judgments arising out of, or in
connection with, subsequent modifications, additions or deletions to
this documentation, to the extent made by End User.
Link disclaimer
Avaya is not responsible for the contents or reliability of any linked
websites referenced within this site or documentation provided by
Avaya. Avaya is not responsible for the accuracy of any information,
statement or content provided on these sites and does not
necessarily endorse the products, services, or information described
or offered within them. Avaya does not guarantee that these links
will work all the time and has no control over the availability of the
linked pages.
Warranty
Avaya provides a limited warranty on its hardware and Software
("Product(s)"). Refer to your sales agreement to establish the terms
of the limited warranty. In addition, Avayas standard warranty
language, as well as information regarding support for this Product
while under warranty is available to Avaya customers and other
parties through the Avaya Support website:
http://support.avaya.com. Please note that if you acquired the
Product(s) from an authorized Avaya reseller outside of the United
States and Canada, the warranty is provided to you by said Avaya
reseller and not by Avaya. "Software" means computer programs in
object code, provided by Avaya or an Avaya Channel Partner,
whether as stand-alone products or pre-installed on hardware
products, and any upgrades, updates, bug fixes, or modified
versions thereto.
Licenses
THE SOFTWARE LICENSE TERMS AVAILABLE ON THE AVAYA
WEBSITE, HTTP://SUPPORT.AVAYA.COM/LICENSEINFO/ ARE
APPLICABLE TO ANYONE WHO DOWNLOADS, USES AND/OR
INSTALLS AVAYA SOFTWARE, PURCHASED FROM AVAYA INC.,
ANY AVAYA AFFILIATE, OR AN AUTHORIZED AVAYA RESELLER
(AS APPLICABLE) UNDER A COMMERCIAL AGREEMENT WITH
AVAYA OR AN AUTHORIZED AVAYA RESELLER. UNLESS
OTHERWISE AGREED TO BY AVAYA IN WRITING, AVAYA DOES
NOT EXTEND THIS LICENSE IF THE SOFTWARE WAS OBTAINED
FROM ANYONE OTHER THAN AVAYA, AN AVAYA AFFILIATE OR AN
AVAYA AUTHORIZED RESELLER; AVAYA RESERVES THE RIGHT TO
TAKE LEGAL ACTION AGAINST YOU AND ANYONE ELSE
USING OR SELLING THE SOFTWARE WITHOUT A LICENSE. BY
INSTALLING, DOWNLOADING OR USING THE SOFTWARE, OR
AUTHORIZING OTHERS TO DO SO, YOU, ON BEHALF OF YOURSELF
AND THE ENTITY FOR WHOM YOU ARE INSTALLING,
DOWNLOADING OR USING THE SOFTWARE (HEREINAFTER
REFERRED TO INTERCHANGEABLY AS "YOU" AND "END USER"),
AGREE TO THESE TERMS AND CONDITIONS AND CREATE A
BINDING CONTRACT BETWEEN YOU AND AVAYA INC. OR THE
APPLICABLE AVAYA AFFILIATE ( "AVAYA").

IP Office Configuration Service Programmer's Guide


IP Office

Avaya grants you a license within the scope of the license types
described below, with the exception of Heritage Nortel Software, for
which the scope of the license is detailed below. Where the order
documentation does not expressly identify a license type, the
applicable license will be a Designated System License. The
applicable number of licenses and units of capacity for which the
license is granted will be one (1), unless a different number of
licenses or units of capacity is specified in the documentation or
other materials available to you.
"Designated Processor" means a single stand-alone computing
device.
"Server" means a Designated Processor that hosts a software
application to be accessed by multiple users.
License types
Designated System(s) License (DS). End User may install and use
each copy of the Software only on a number of Designated
Processors up to the number indicated in the order. Avaya may
require the Designated Processor(s) to be identified in the order by
type, serial number, feature key, location or other specific
designation, or to be provided by End User to Avaya through
electronic means established by Avaya specifically for this purpose.
Concurrent User License (CU). End User may install and use the
Software on multiple Designated Processors or one or more servers,
so long as only the licensed number of Units are accessing and using
the Software at any given time. A "Unit" means the unit on which
Avaya, at its sole discretion, bases the pricing of its licenses and can
be, without limitation, an agent, port or user, an e-mail or voice mail
account in the name of a person or corporate function (e.g.,
webmaster or helpdesk), or a directory entry in the administrative
database utilized by the Software that permits one user to interface
with the Software.
Units may be linked to a specific, identified Server.
Database License (DL). End User may install and use each copy of
the Software on one Server or on multiple Servers provided that
each of the Servers on which the Software is installed communicates
with no more than a single instance of the same database.
CPU License (CP). End User may install and use each copy of the
Software on a number of Servers up to the number indicated in the
order provided that the performance capacity of the Server(s) does
not exceed the performance capacity pecified for the Software. End
User may not re-install or operate the software on Server(s) with a
larger performance capacity without Avayas prior consent and
payment of an upgrade fee.
Named User License (NU). You may: (i) install and use the Software
on a single Designated Processor or Server per authorized Named
User (defined below); or (ii) install and use the Software on a Server
so long as only authorized Named Users access and use the
Software.
"Named User", means a user or device that has been expressly
authorized by Avaya to access and use the Software. At Avayas sole
discretion, a "Named User" may be, without limitation, designated by
name, corporate function (e.g., webmaster or helpdesk), an e-mail
or voice mail account in the name of a person or corporate function,
or a directory entry in the administrative database utilized by the
Software that permits one user to interface with the Software.
Shrinkwrap License (SR). You may install and use the Software in
accordance with the terms and conditions of the applicable license
agreements, such as "shrinkwrap" or "clickthrough" license
accompanying or applicable to the Software ("Shrinkwrap License").

Page 2
15-601473 Issue 03b (20 February 2013)

Heritage Nortel Software


"Heritage Nortel Software" means the software that was acquired by
Avaya as part of its purchase of the Nortel Enterprise Solutions
Business in December 2009. The Heritage Nortel Software currently
available for license from Avaya is the software contained within the
list of Heritage Nortel Products located at
http://support.avaya.com/licenseinfo under the link "Heritage Nortel
Products". For Heritage Nortel Software, Avaya grants Customer a
license to use Heritage Nortel Software provided hereunder solely to
the extent of the authorized activation or authorized usage level,
solely for the purpose specified in the Documentation, and solely as
embedded in, for execution on, or (in the event the applicable
Documentation permits installation on non-Avaya equipment) for
communication with Avaya equipment. Charges for Heritage Nortel
Software may be based on extent of activation or use authorized as
specified in an order or invoice.

Trademarks
The trademarks, logos and service marks ("Marks") displayed in this
site, the Documentation and Product(s) provided by Avaya are the
registered or unregistered Marks of Avaya, its affiliates, or other
third parties. Users are not permitted to use such Marks without
prior written consent from Avaya or such third party which may own
the Mark.
Nothing contained in this site, the Documentation and Product(s)
should be construed as granting, by implication, estoppel, or
otherwise, any license or right in and to the Marks without the
express written permission of Avaya or the applicable third party.

Copyright
Except where expressly stated otherwise, no use should be made of
materials on this site, the Documentation, Software, or hardware
provided by Avaya. All content on this site, the documentation and
the Product provided by Avaya including the selection, arrangement
and design of the content is owned either by Avaya or its licensors
and is protected by copyright and other intellectual property laws
including the sui generis rights relating to the protection of
databases. You may not modify, copy, reproduce, republish, upload,
post, transmit or distribute
in any way any content, in whole or in part, including any code and
software unless expressly authorized by Avaya. Unauthorized
reproduction, transmission, dissemination, storage, and or use
without the express written consent of Avaya can be a criminal, as
well as a civil offense under the applicable law.

Downloading Documentation
For the most current versions of Documentation, see the Avaya
Support website: http://support.avaya.com.

Avaya is a registered trademark of Avaya Inc.


All non-Avaya trademarks are the property of their respective
owners, and "Linux" is a registered trademark of Linus Torvalds.

Contact Avaya Support


See the Avaya Support website: http://support.avaya.com for
product notices and articles, or to report a problem with your Avaya
product.
For a list of support telephone numbers and contact addresses, go to
the Avaya Support website: http://support.avaya.com, scroll to the
bottom of the page, and select Contact Avaya Support.

Virtualization
Third Party Components
"Third Party Components" mean certain software programs or
portions thereof included in the Software that may contain software
(including open source software) distributed under third party
agreements ("Third Party Components"), which contain terms
regarding the rights to use certain portions of the Software ("Third
Party Terms"). Information regarding distributed Linux OS source
code (for those Products that have distributed Linux OS source code)
and identifying the copyright holders of the Third Party Components
and the Third Party Terms that apply is available in the
Documentation or on Avayas website at:
http://support.avaya.com/Copyright. You agree to the Third Party
Terms for any such Third Party Components.
Note to Service Provider
The Product may use Third Party Components that have Third Party
Terms that do not allow hosting and may need to be independently
licensed for such purpose.
Preventing Toll Fraud
"Toll Fraud" is the unauthorized use of your telecommunications
system by an unauthorized party (for example, a person who is not
a corporate employee, agent, subcontractor, or is not working on
your company's behalf). Be aware that there can be a risk of Toll
Fraud associated with your system and that, if Toll Fraud occurs, it
can result in substantial additional charges for your
telecommunications services.
Avaya Toll Fraud Intervention
If you suspect that you are being victimized by Toll Fraud and you
need technical assistance or support, call Technical Service Center
Toll Fraud Intervention Hotline at +1-800-643-2353 for the United
States and Canada. For additional support telephone numbers, see
the Avaya Support website: http://support.avaya.com. Suspected
security vulnerabilities with Avaya products should be reported to
Avaya by sending mail to: securityalerts@avaya.com.

IP Office Configuration Service Programmer's Guide


IP Office

Page 3
15-601473 Issue 03b (20 February 2013)

Contents

Contents
1. IP Office Configuration Service
1.1 Key Terms.....................................................................
Used in this Document
10
1.2 Runtime Requirements
..................................................................... 11

2. Architectural Overview
2.1 Configuration
.....................................................................
Consistency
16

3. IP Office Configuration Service


Methods
3.1 ConnectAndGetUnitDetails
.....................................................................
3.2 Primary Service
.....................................................................
Methods
3.2.1 GetUnitConfiguration
............................................................................
Method
3.2.2 SetUnitConfiguration
............................................................................
Method
3.2.3 GetSEUnitConfiguration
............................................................................
3.2.4 SetSEUnitConfiguration
............................................................................
3.2.5 IP
............................................................................
Office Server Edition Usage Notes

18
19
19
20
21
21
21

4. XML Format
4.1 Document Root
.....................................................................
4.2 User
.....................................................................
4.2.1 DSS
............................................................................
Keys
4.2.2 DSS
............................................................................
Key Examples
4.3 Groups
.....................................................................
4.3.1 Group
............................................................................
Membership

24
25
28
30
31
33

5. Hosting and Secure Configuration


Guides
5.1 Configuring.....................................................................
Secure Transport on IP Office
36
5.2 Hosting Under
.....................................................................
IIS
38
Index
...............................................................................39

IP Office Configuration Service Programmer's Guide


IP Office

Page 5
15-601473 Issue 03b (20 February 2013)

Chapter 1.
IP Office Configuration
Service

IP Office Configuration Service Programmer's Guide


IP Office

Page 7
15-601473 Issue 03b (20 February 2013)

IP Office Configuration Service:

1. IP Office Configuration Service


This document details the Application Programming Interface (API) for the IP Office Configuration Service component. It
details the operation of the API and the data that is exchanged to effect the supported configuration changes on user and
group objects.
The API is only supported with IP Office systems operating in IP Office Essential Edition, IP Office Preferred Edition, IP
Office Advanced Edition or IP Office Server Edition mode and running IP Office Release 4.2 or higher. See Runtime
Requirements 11 for further details.
The API enables integrators and ISVs to incorporate robust configuration changes into their solution via a web service
interface, expressing configuration changes via an XML document. It enables changes to be made to the following IP Office
entities:
User
Group

Subsets of the available fields are supported for each entity, which fulfils the majority of use-cases targeted by this
release. These supported fields are documented in the XML document section.
Various methods are exposed by the service interface. These are designed to support hosting under IIS or can be self
hosted. The service interface utilizes the Windows Communications Foundation (WCF); this technology supports a number
of hosting scenarios, such as self hosted. The IIS hosted approach is the only method discussed in this document. The
primary service methods 19 are used to get the configuration from the IP Office (GetUnitConfiguration 19 ) and to set
the configuration (SetUnitConfiguration 20 ) respectively (for IP Office Server Edition systems the alternate methods
GetSEUnitConfiguration 21 and SetSEUnitConfiguration 21 are used).
These methods work by supplying or consuming an XML document. The XML format 24 is consistent across a get/set for
the supported User/Group entity fields. When making configuration changes, an Opp (Operation Code) attribute is used to
indicate the desired operation against an entity. The following Opp attributes are supported:
Add
Update
Delete

For new or updated data, the XML document need only contain the change fields for the new or updated data. A summary
document is returned for a set method to indicate if the configuration changes were successfully applied, or if the changes
resulted in a validation message. The following validation levels are used:
Informational
Warning
Error

The GetUnitConfiguration method call returns the supported User and Group entities and their supported fields, along
with additional supporting information such as the handset for the User record.
Additional supplemental data is also supplied; this can be used to support your validation logic if required.
The data supplied includes:
Unit Name and software version number
Extensions, Extn Number, Port, Phone Type
User Rights, template name
Existing Validation, messages

Note
It is imperative that you have a good understanding of the configuration and management of IP Office and that
you are comfortable using the IP Office Manager application.

IP Office Configuration Service Programmer's Guide


IP Office

Page 9
15-601473 Issue 03b (20 February 2013)

1.1 Key Terms Used in this Document


General industry terms and their acronyms are introduced inline, as in "TCP" (Transmission Control Protocol) when first
used in a section, if the term is either sufficiently new or specific to this architecture then it will be documented in this
section and an explanation provided.
BINDING
WCF (see below) binding directive, used to configure the protocol utilized, for example basicHttpBinding and
wsHttpBinding. Binding also can be configured to affect policy and security.
GUID
Global Unique Identifier. A 128 bit number written as a sequence of hexadecimal digits.
OPP
Operation Code, an attribute supplied that identifies how an element and its data should be processed. The defined
operations are Update, Add and Delete.
UCC
Upper Camel Case. Naming convention, where words are compounded together and the first letter of each word is
capitalized.
WCF
Windows Communications Foundation, a unified communications programming model implemented as part of the
.Net 3.0 technology stack.
WinFx
Microsofts Framework for delivering key Communications/Presentation API on Windows XP (SP2)/Vista client
operating systems and Windows 2003 and Longhorn Server.

When there are important concepts to explain a note section will be used to breakout the detail and bring them to your
attention.

Note
These notes provide useful information, about the current subject

IP Office Configuration Service Programmer's Guide


IP Office

Page 10
15-601473 Issue 03b (20 February 2013)

IP Office Configuration Service: Key Terms Used in this Document

1.2 Runtime Requirements


Software Component

Requirement

IP Office System

IP Office Essential Edition, IP Office Preferred Edition, IP Office Advanced Edition or IP


Office Server Edition systems only.
IP Office Release 4.2 or higher.

PC Operating System

Windows Server 2003 SP1 (Standard Edition, Enterprise Edition, or Datacenter


Edition), depending on load/usage a client OS Windows Vista or Windows XP may be
adequate (subject to your own load and capacity evaluation).
Windows 7 32-bit and 64-bit.
Windows 8 32-bit and 64-bit.
Windows Server 2008 R2

Web Server for hosting the


web service

IIS 6.0

Additional Runtimes
Installed

Windows 7/ Windows server 2008, 64 bit Support - Install Avaya IP Office


ConfigServiceHost prerequisite
.NET Framework Version 3.0
ASP.NET 2.0
Visual Studio 2005 C++ SPI C/C++ runtime

You install IIS 6.0 by using the Windows Control Panel. For details, see the Windows Server documentation.
To download Service Pack 1 for Windows Server 2003, go to
http://www.microsoft.com/windowsserver2003/downloads/servicepacks/sp1/default.mspx.
To download the .NET Framework, go to
http://www.microsoft.com/downloads/details.aspx?familyid=10CC340B-F857-4A14-83F5-25634C3BF043&displayla
ng=en.
To download the C++ runtime (Visual Studio 2005 SP1), go to
http://www.microsoft.com/downloads/details.aspx?FamilyID=200b2fd9-ae1a-4a14-984d-389c36f85647&DisplayLa
ng=en.

IP Office Configuration Service Programmer's Guide


IP Office

Page 11
15-601473 Issue 03b (20 February 2013)

Chapter 2.
Architectural Overview

IP Office Configuration Service Programmer's Guide


IP Office

Page 13
15-601473 Issue 03b (20 February 2013)

2. Architectural Overview
The solution targets the Windows 2003 Server platform and utilizes the Microsoft .Net framework 3.0 to provide a robust
and scalable service implementation. The service interface is hosted using the Windows Communications Framework
(WCF), to enable flexible hosting of the service as a standalone executable or via IIS. The web service enables non
windows platforms to consume its services if required, based on a standard http based binding.
Communication between the Avaya IP Office Configuration Service and the customers IP Office is over TCP using a secure
connection. Transport Layer Security (TLS) is utilized to establish a session between the configuration service and the IP
Office for the duration of a transfer to/from the service and the IP Office.
The port number of the IP Office services can be configured for individual systems using the security manager (introduced
in the IP Office Manager Release 4.1) when the system is commissioned. The default ports are as follows:
IP Office Service

Unsecured

Secured

Comment

Configuration

50804

50805

This is the only interface utilized by the Avaya IP


Office configuration component.

Program

50806

50807

System Status Interface

50808

50809

Directory Lists

50810

50811

Security Administration

50812

50813

Whois_2

50802

Utilized by IP Office Manager, replaces UDP


based whois.

These ports are based on a base port defined via the security manager, so adjustments to the base port move the ports
en bloc; please review the necessary IP Office 4.1 details for these and other changes/options regarding TCP/UDP
services.
IP Office can be configured to meet different security expectations; the security configuration is separate from the core
unit configuration. With the exception of the Whois_2 port, the IP Office enables the security to be configured to support
insecure/secure and secure or insecure access to these services, dependant on the level of authentication required. Legacy
UDP based service can also be locked down.
A secure port only will be used to access the IP Office, the level must be set to low (the inbuilt certificate that IP Office
generates will be utilized, when a secure service is configured). The certificate is used to enable key exchange only and is
not verified. The service will trust the inbuilt certificate presented from the IP Office to enable the secure session to be
established.

Note
The security level must be set to low, to enable use of the inbuilt certificate.

IP Office Configuration Service Programmer's Guide


IP Office

Page 14
15-601473 Issue 03b (20 February 2013)

Architectural Overview:
The services utilizes the secure connection and authentication credentials supplied to retrieve the binary configuration file
from the IP Office, the file is unpacked into an object representation before converting the supported subset of information
into XML. The same steps are taken when applying configuration changes, retrieve the file from the IP Office at the latest
possible moment, before applying the changes embodied in the XML configuration, validation takes place during
processing if no errors are detected representation is repacked and transferred back to the IP Office.

Figure 1 - Logical Architecture

IP Office Configuration Service Programmer's Guide


IP Office

Page 15
15-601473 Issue 03b (20 February 2013)

2.1 Configuration Consistency


The following strategies are used to handle data consistency.
Data changes are always applied to the most recent configuration. This involves fetching the configuration binary
from the unit, prior to applying the updates and then returning the configuration binary promptly. These steps are
sequential within a service invocation.
The configuration XML file contains the entities and field changes only, these changes are applied to the
configuration. Scoping the changes to only the fields that have been affected reduces the amount of data required
to be processed and ensures only the data that needs to be touched is affected. This approach is embodied in the
format of the XML changes document.
The entity level flag on the changed item (user, group, etc) is set to indicate which entities have been changed.
This enables the IP Office to process the new configuration file specifically merging the entities that have been
marked. This isolates the impact of locally changed values at an entity level, as a binary diff is used to identify
changes to records. Being explicit ensures that entities that have not been flagged explicitly are not considered for
merging.

The approach above reduces the impact on the total system configuration and focus the changes to just the affected
entities and within these entities only the relevant fields.
The overall configuration strategy is no less vulnerable than having two local manager instances, where last change wins.
If the entity changes are not overlapping, then both updates will be successful. These behaviors and operations will be
consistent with the standalone IP Office Manager operation.
It is recommended that consumers of the service implement a strategy to avoid concurrent overlapping configuration
writes. If your application supports multiple concurrent clients, then your solution should aggregate these requests and
serialize the requests to the configuration service.

Note
If your integration requires multiple concurrent requests, provide a service faade to queue the requests before
calling the service. IP Office makes live the configuration changes approximately 2 seconds after processing the
received configuration.

IP Office Configuration Service Programmer's Guide


IP Office

Page 16
15-601473 Issue 03b (20 February 2013)

Chapter 3.
IP Office Configuration
Service Methods

IP Office Configuration Service Programmer's Guide


IP Office

Page 17
15-601473 Issue 03b (20 February 2013)

3. IP Office Configuration Service Methods


The service exposes a utility method, ConnectAndGetUnitDetails 18 , that can be used to check if the IP Office system
is reachable. The following primary methods can then be used to get and to set configuration settings:
GetUnitConfiguration

19

SetUnitConfiguration

20

GetSEUnitConfiguration

21

(used with IP Office Server Edition systems only)

SetSEUnitConfiguration

21

(used with IP Office Server Edition systems only)

The service interface utilizes a string type to return the XML representation of the configuration items and likewise the
SetUnitConfiguration method will accept an XML document defined as a string type to transfer the configuration
updates.
This arrangement allows the same interface to be utilized as the solution evolves over time; the content of the XML infers
what operations are required and the structure is kept simple to allow future extensibility.

Note
The service interface is hosted under IIS, via a "svc" file. The URL of the service endpoint is determined by
your configuration. You will typically need to access the Web Services Description Language (WSDL) of the
service to build a proxy in your development environment.

3.1 ConnectAndGetUnitDetails
The service exposes a utility method, ConnectAndGetUnitDetails, that can be used to check if the IP Office system is
reachable. The method also returns some basic unit information:
Unit Name
IP Address
Type
Version
Unit MAC Address
Mode

The following example is the XML returned by an IP500 V2 based Expansion System in a IP Office Server Edition network:
<IPOfficeUnitDetails>
<UnitName>00E007057148</UnitName>
<IPAddress>148.147.206.154</IPAddress>
<Type>IP 500 V2</Type>
<Version>9.0 (102029)</Version>
<MacAddress>00e007057148</MacAddress>
<Mode>IPO S-EDITION(E)</Mode>
</IPOfficeUnitDetails>

The service utilizes the internal implementation to assert if the unit is reachable before attempting to retrieve configuration
data from the IP Office.

IP Office Configuration Service Programmer's Guide


IP Office

Page 18
15-601473 Issue 03b (20 February 2013)

IP Office Configuration Service Methods: ConnectAndGetUnitDetails

3.2 Primary Service Methods


The two service methods enable you to retrieve (GetUnitConfiguraiton 19 ) configuration data as XML and make
changes to configuration (SetUnitConfiguration 20 ) via a XML configuration document. These methods are stateless, a
new session is created per request, and this enables multiple services to be deployed across PCs utilising a load balancer
if high scalability is required.
For IP Office Server Edition systems, the alternate service methods GetSEUnitConfiguration
SetSEUnitConfiguration 21 are used instead.

21

and

3.2.1 GetUnitConfiguration Method


The following parameters are required:
Unit IP Address (string)
Unit Configuration Service Port number (string)
Service Account Name (string)
Service Account Password (string)

The return value is an XML document that represents the configuration elements on success or a fault message indicating
the nature of the error.

IP Office Configuration Service Programmer's Guide


IP Office

Page 19
15-601473 Issue 03b (20 February 2013)

3.2.2 SetUnitConfiguration Method


The following parameters are required:
Unit IP Address (string)
Unit Configuration Service Port number (string)
Service Account Name (string)
Service Account Password (string)
Configuration XML directives (string)
Batch Transactional (string)

The return value is an XML document with summary request data or a fault contract that represents the nature of the
failure "ConnectivityFault" containing a fault reason code and an error description. The "ConnectivityFault" is returned to
indicate an unrecoverable condition, such as the unit being unreachable, failing authentication or invalid XML being
supplied.
The summary return data provides feedback on the number of issues related to the changes processed, if the information
is informational or a warning then the changes would have been applied, indicated by the "ConfigTransferred" element
containing a true value.
If errors are detected, these will be indicated in the Errors element as a count, details of the validation errors are
returned, referencing the original GUID used and a detailed description of the failure.

Note
When errors are caused by incoming change requests a decision is made based on the "BatchTransactional"
flag, either to continue disregarding the failed change request and continue processing other potential valid
requests or fail all changes and not commit back the configuration. In either case, if errors are detected in the
completed configuration update, they are never committed back to the IP Office. This enables you to accept
failures and get feedback, while only applying valid changes that pass validation to succeed.
Setting "BatchTransactional" to false will enable partial changes to succeed, while a true setting will not allow
partial failures.

Example: Summary Return Data on a Successful Method Call


<?xml version="1.0" encoding="utf-8"?>
<av:ValidationResultsxmlns:av="http://Avaya/Validation/IPOffice/2007/01">
<SummaryResults>
<PreValidationErrors>0</PreValidationErrors>
<Errors>0</Errors>
<Warning>0</Warning>
<Informational>0</Informational>
<RebootDetected>False</RebootDetected>
<ConfigTransferred>True</ConfigTransferred>
</SummaryResults>
</av:ValidationResults>

Note
When adding a new user or group, a GUID is supplied as a unique reference, the GUID in this case is only valid
for the request, IP Office will allocate a new GUID for the record and utilize its own MAC address for the
relevant portion of the GUID. Any errors or validation issues will utilize the supplied GUID to ensure a
consistent reference, it should not be persisted.

IP Office Configuration Service Programmer's Guide


IP Office

Page 20
15-601473 Issue 03b (20 February 2013)

IP Office Configuration Service Methods: Primary Service Methods

3.2.3 GetSEUnitConfiguration
This method can only be used with IP Office Server Edition systems. The following parameters are required:
Unit IP Address (string)
Unit Configuration Service Port number (string)
Service Account Name (string)
Service Account Password (string)
Unit Type (string) For IP Office Server Edition systems this is always IPOfficeMMManager.

The return value is an XML document that represents the configuration elements on success or a fault message indicating
the nature of the error.

3.2.4 SetSEUnitConfiguration
This method can only be used with IP Office Server Edition systems. The following parameters are required:
Unit IP Address (string)
Unit Configuration Service Port number (string)
Service Account Name (string)
Service Account Password (string)
Configuration XML directives (string)
Batch Transactional (string)
Unit Type (string) For IP Office Server Edition systems this is always IPOfficeMMManager.

The return value is an XML document with summary request data or a fault contract that represents the nature of the
failure "ConnectivityFault" containing a fault reason code and an error description. The "ConnectivityFault" is returned to
indicate an unrecoverable condition, such as the unit being unreachable, failing authentication or invalid XML being
supplied.

3.2.5 IP Office Server Edition Usage Notes


Use ConnectAndGetUnitDetails 18 first to get the <Mode> and <TYPE> strings. These will indicate the role of the
server in the IP Office Server Edition network and the type of platform on which the server is based. The current possible
combinations are:
<Type>IPO-Linux-PC</Type>
<Mode>IPO S_EDITION(P)</Mode>
This is the mode for a Linux based Primary Server in a IP Office Server Edition network.
<Type>IPO-Linux-PC</Type>
<Mode>IPO S-EDITION(S)</Mode>
This is the mode for a Linux based Secondary Server in a IP Office Server Edition network.
<Type>IPO-Linux-PC</Type>
<Mode>IPO S-EDITION(E)</Mode>
This is the mode for a Linux based Expansion System in a IP Office Server Edition network.
<Type>IP 500 V2</Type>
<Mode>IPO S-EDITION(E)</Mode>
This is the mode for an IP500 V2 based Expansion System in a IP Office Server Edition network.

Use GetSEUnitConfiguration
IPOfficeMMManager.

21

or SetSEUnitConfiguration

IP Office Configuration Service Programmer's Guide


IP Office

21

calls with the Unit Type string set as

Page 21
15-601473 Issue 03b (20 February 2013)

Chapter 4.
XML Format

IP Office Configuration Service Programmer's Guide


IP Office

Page 23
15-601473 Issue 03b (20 February 2013)

4. XML Format
This section describes the format of the XML document used to effect configuration changes. The document is based on
the format retrieved as a result of a GetUnitConfiguration 19 or GetSEUnitConfiguration 21 method, with the
addition of an Opp code attribute value (Update, Add or Delete) to signify the intent of the change at a User/Group
level.
User records have additional DSSKey sub elements that can be individually set. An Opp code attribute can be expressed
for each individual element representing a key.
The document format is composed of a root element and sub elements that are categories of configuration data expressed
as plurals for example "Users", these in turn contain the type of element using the singular, for example User.
The element that represents the record of an entity is composed of two attributes; the first is the GUID of the object (its
unique key) and the operation to be performed if the document is a configuration change document.
The child elements use the English IP Office Manager field names to identify the field of a record and the value is
contained as the inner text of the element.
The XML data must be UTF-8 encoded.
The elements and attributes use Upper Camel Case (UCC), to capitalize the first character of each word and
compound the name.

Note
The XML naming is mainly aligned with the IP Office Manager application fields. IP Office Manager is a great
learning tool for round tripping between the service to observe how your changes are applied/rendered in XML.

4.1 Document Root


The document root element is AvayaIPOConfiguration. The elements that support configuration changes are User and
Group; each contained in a parent element named Users and Groups respectively.
The table below shows how the overall XML document is structured.
Document Root

Parent Elements

Entity Element

<AvayaIPOConfiguration>

Comments
Root element

<Users>

Users container
<User>

25

User record

</Users>
<Groups>

Groups container
<Group>

31

Group record

</Groups>
</AvayaIPOConfiguration>
Table 1

IP Office Configuration Service Programmer's Guide


IP Office

Page 24
15-601473 Issue 03b (20 February 2013)

XML Format: Document Root

4.2 User
User elements are contained by the "Users" container as shown in Table 1
users such as "NoUser", a template used for new user records.

24

, they represent the user record and inbuilt

Note
User records generally should be updated. A system automatically creates a user record for each extension and
associates the two. The ability exists to delete and add user records, if required.

User

Mandatory/
Optional

Attributes

Comments

<User Guid="" Opp="">

Mandatory

Guid

The GUID unique key of the user


record.

Mandatory

Opp

Opp code for change "Add", "Update


", "Delete".

Example:
<User Guid="cf4b99005f3511d80b100e007026702" Opp="Update">

Name
User Element

Mandatory/
Optional

Value

Comments

Name

Optional/
Mandatory

The record name of the user,


traditionally "Extn206". Mandatory
on an "Add" operation.

A textual key; must not contain


spaces or reserved characters.

Example:
<User Guid="cf4b99005f3511d80b100e007026702" Opp="Update">
<Name>Extn206</Name>
</User>

Note
Name and FullName fields do not support the following punctuation characters ",(),#,?,/,-,+,=,,$,*,~,@,%, <
and comma.

FullName
User Element

Mandatory/
Optional

Value

Comments

FullName

Optional

Full user name, displayed on phone. Full name of the user displayed in
the directory.

Example:
<User Guid="cf4b99005f3511d80b100e007026702" Opp="Update">
<FullName>Jack Sparrow</FullName>
</User>

User
User Element

Mandatory/
Optional

Value

Comments

Password

Optional

User records password.

Phone Manager,SoftConsole, Dialin


and TAPI password.

Example:
<User Guid="cf4b99005f3511d80b100e007026702" Opp="Update">
<Password>150697</Password>
</User>

IP Office Configuration Service Programmer's Guide


IP Office

Page 25
15-601473 Issue 03b (20 February 2013)

Extn
User Element

Mandatory/
Optional

Value

Comments

Extn

Optional

Extension Number

A valid extension number not


already in use. A list of extensions
is provided in a
GetUnitConfiguration, each use
record also contains this element.

Example:
<User Guid="cf4b99005f3511d80b100e007026702" Opp="Update">
<Extn>4769</Extn>
</User>

VoicemailOn
User Element

Mandatory/
Optional

Value

Comments

VoicemailOn

Optional

true/false

Turns voicemail on or off for the


user record.

Example:
<User Guid="cf4b99005f3511d80b100e007026702" Opp="Update">
<VoicemailOn>true</VoicemailOn>
</User>

VoicemailCode
User Element

Mandatory/
Optional

Value

Comments

VoicemailCode

Optional

15 digits maximum.

Voicemail access password.

Example:
<User Guid="cf4b99005f3511d80b100e007026702" Opp="Update">
<VoicemailCode>4769</VoicemailCode>
</User>

CanIntrude
User Element

Mandatory/
Optional

Value

Comments

CanIntrude

Optional

true/false

Sets the intrude ability of a user


record.

Example:
<User Guid="cf4b99005f3511d80b100e007026702" Opp="Update">
<CanIntrude>true</CanIntrude>
</User>

CannotBeIntruded
User Element

Mandatory/
Optional

Value

Comments

CannotBeIntruded

Optional

true/false

Sets the can be intruded ability of a


user record.

Example:
<User Guid="cf4b99005f3511d80b100e007026702" Opp="Update">
<CannotIntrude>false</CannotIntrude>
</User>

IP Office Configuration Service Programmer's Guide


IP Office

Page 26
15-601473 Issue 03b (20 February 2013)

XML Format: User

XDirectory
User Element

Mandatory/
Optional

Value

Comments

XDirectory

Optional

true/false

Sets the user record directory


visibility.

Example:
<User Guid="cf4b99005f3511d80b100e007026702" Opp="Update">
<XDirectory>false</XDirectory>
</User>

UserRights
User Element

Mandatory/
Optional

Value

Comments

UserRights

Optional

User Rights template name. Provide Inherits settings of named User


an empty element to remove any
Rights template. A list of templates
associated template.
is provided via the
GetUnitConfiguration method. They
are contained in a <UserRights>
element, for each template there is
a <UserRight> element with a
Name attribute that contains the
name of the template.

Example:
<User Guid="cf4b99005f3511d80b100e007026702" Opp="Update">
<UserRights>CustomUser</UserRights>
</User>

Note
The user record also supplies some associated data, PhoneType and PhoneTypeIndex, these values reflect the
type of phone device connected on the port associated with the extension. This could be used to present some
form of UI representing the device, the PhoneType text is descriptive.
Applications such as PhoneManager, utilize these additional buttons, even though the device is unable to
display them.

PhoneType/PhoneTypeIndex
User Element

Mandatory/
Optional

Value

Comments

PhoneType

Not Applicable

Phone Type

The type of phone associated with


the users extension.

PhoneTypeIndex

Not Applicable

PhoneType enumeration

Enumeration of the phone type,


supplied only.

IP Office Configuration Service Programmer's Guide


IP Office

Page 27
15-601473 Issue 03b (20 February 2013)

4.2.1 DSS Keys


DSS keys can be programmed using a subset of the available features. Each key is individually identified by a key number
and requires an "Opp" code attribute to indicate the operation to be performed such as "Add", "Update" or "Delete".

Note
There are a number of rules that must be met regarding positions of appearance buttons (Call Appearance,
Line Appearance, Bridged Appearance and Coverage Appearance). These rules vary depending in the
level of software being run by the IP Office system. Refer to the IP Office Manager help for details.

DSS Keys are scoped within the User element, and contained by a <DSSKeys> element. Each key definition is described
by a <DSSKey> element and two attributes are used to convey the key number and the operation to be performed. Table
2 shows how the "DSSKeys" container scopes the DSSKey.
User Record

Parent Elements

Entity Element

Comments

<User>
<DSSKeys>

Container for individual keys


<DSSKey Key="4" Opp="Add">

Key entry, attributes Key number


to be programmed and operation to
perform.

<Label>

Display data

<ActionObject>

The key function. See Table 3


below.

<Data>

Associated data, dependant on


function.

29

<RingDelay>
</DSSKeys>
</User>
Table 2

Note
Please refer to the IP Office Manager application help file for complete details on the DSS key functions
supported.

IP Office Configuration Service Programmer's Guide


IP Office

Page 28
15-601473 Issue 03b (20 February 2013)

XML Format: User

DSS Functions
Function Action Object

Mandatory/
Optional
Data Item

Data Item

Comments

AbbreviatedDial

Mandatory

Full/Partial number to dial

Use the label to display a


caption

AbbreviatedDialProgram

Not Applicable

Initiate user abbreviated


programming from the handset.

AccountCode

Optional

Set the account code.

AutoDial

Mandatory

BridgeAppearance

Mandatory

Barred

Not Applicable

CallForward

Optional

Forward number

CallIntrude

Mandatory

Numeric extn number

CallListen

Mandatory

Numeric extn number

CallPark

Optional

CallPickup

Not Applicable

CallAppearance

Mandatory

CoverageAppearance

Mandatory

DialPaging

Optional

Directory

Not Applicable

DoNotDisturbOn

Not Applicable

ExtnLogin

Not Applicable

ExtnLogout

Not Applicable

FollowMeTo

Not Applicable

Acts as a toggle if the feature is


activated, confirms/prompts for
forward number if not set. If the
number was supplied, then the
number cannot be changed, the
button toggles the Call Forward
feature.

Blank for default or specific park


slot number

a=, b=, c=

Must occupy the first button


position, must be contiguous if
more the one appearance is
required.

Button Toggles DND

Prompts for location

FollowMeHere
FollowMeHereCancel

Optional

ForwardHuntgroupCallsOn

Not Applicable

ForwardHuntgroupCallsOff

Not Applicable

ForwardUnconditionalOn

Not Applicable

Extn Number

Must be cancelled from the


extension that was originally set
as the follow me target.
Acts as a toggle

Acts as a toggle, uses the


configured forward number.

HuntGroupNightService

Hunt group extn number

SetHuntGroupOutOfService

Hunt group extn number

Acts as a toggle

HuntGroupEnable

Optional

Hunt group extn or blank for all

SetAbsentText

Mandatory

1/0 for on/off, message number,


custom text

TimeOfDay

Not Applicable

UserBLF

Mandatory

VoicemailOn

Not Applicable

VoicemailOff

Not Applicable

VoicemailCollect

Mandatory

Extn Number

Table 3

IP Office Configuration Service Programmer's Guide


IP Office

Page 29
15-601473 Issue 03b (20 February 2013)

4.2.2 DSS Key Examples


The following examples show how the DDS keys are programmed.

Note
DSS Keys are scoped by the owning user entity, each key needs to specify the "Opp" code to effect the desired
change, and the owning user record required the "Opp" code to indicate that there are changes.
Keys are identified by the "Key" attribute, which starts at 1

The examples utilize the supported features documented in Table 3


scoping of the containing entities, including the root:

29

, a full example is first shown to displaythe full

Example:
<?xml version="1.0" encoding="utf-8"?>
<AvayaIPOConfiguration>
<Users>
<User Guid="cf4b99005f3511d80b100e007026702" Opp="Update">
<DSSKeys>
<DSSKey Key="1" Opp="Add">
<Label />
<ActionObject>CallAppearance</ActionObject>
<Data>a=</Data>
<RingDelay>0</RingDelay>
</DSSKey>
</DSSKeys>
</User>
</Users>
</AvayaIPOConfiguration>

Note
DSS Keys are processed sequentially, so order your updates/deletes/adds to ensure you dont break any rules
regarding ordering or prior dependencies. If your needs are more complex it may be more effective to delete
and recreate the key structure. Internally keys occupy an array slot ordered by key number, so add and
update are the some underlyingoperation.

IP Office Configuration Service Programmer's Guide


IP Office

Page 30
15-601473 Issue 03b (20 February 2013)

XML Format: User

4.3 Groups
The API is designed to support local groups only, not distributed hunt groups. The Groups container scopes the "Group"
record as indicated in Table 1 24 .

Group

Mandatory/
Optional

Attributes

Comments

<Group Guid="" Opp=""> Mandatory

Guid

The GUID unique key of the group


record.

Mandatory

Opp

Opp code for change "Add", "Update


", "Delete".

Example:
<Group Guid="cf4b99005f3511d80b100e007026702" Opp="Update">

Name
Group Element

Mandatory/
Optional

Value

Comments

Name

Optional/
Mandatory

Unique name. Mandatory on an "


Add" operation.

Must not contain any reserved


characters. Max 35 characters.

Example:
<Group Guid="cf4b99005f3511d80b100e007026702" Opp="Update">
<Name>Emil</Name>
</Group>

Extn
Group Element

Mandatory/
Optional

Value

Comments

Extn

Optional/
Mandatory

The number of the group.

The number must be available and


not allocated to a user or existing
group; the get configuration method
provides details of existing groups
and extension numbers. The extn
number is mandatory on an add
operation. Range 2-9 digits.

Example:
<Group Guid="cf4b99005f3511d80b100e007026702" Opp="Update">
<Extn>700</Extn>
</Group>

NoAnswerTime
Group Element

Mandatory/
Optional

Value

Comments

NoAnswerTime

Optional

Number of seconds

1-99999 seconds. Default 15


seconds.

Example:
<Group Guid="cf4b99005f3511d80b100e007026702" Opp="Update">
<NoAnswerTime>20</NoAnswerTime>
</Group>

IP Office Configuration Service Programmer's Guide


IP Office

Page 31
15-601473 Issue 03b (20 February 2013)

VoicemailAnswerTime
Group Element

Mandatory/
Optional

Value

Comments

VoicemailAnswerTime

Optional

Number of seconds

1-99999 seconds. Default 45


seconds.

Example:
<Group Guid="cf4b99005f3511d80b100e007026702" Opp="Update">
<VoicemailAnswerTime>45</VoicemailAnswerTime>
</Group>

GroupRingMode
Group Element

Mandatory/
Optional

Value

Comments

GroupRingMode

Optional

Rotary
Collective
Sequential
LongestWaiting

Default Sequential

Example:
<Group Guid="cf4b99005f3511d80b100e007026702" Opp="Update">
<GroupRingMode>Rotary</GroupRingMode>
</Group>

VoicemailOn
Group Element

Mandatory/
Optional

Value

Comments

VoicemailOn

Optional

true or false

Defaults to On; does not affect


other mailbox usage: recording,
messages forwarded from other
mailboxes.

Example:
<Group Guid="cf4b99005f3511d80b100e007026702" Opp="Update">
<VoicemailOn>false</VoicemailOn>
</Group>

VoicemailCode
Group Element

Mandatory/
Optional

Value

Comments

VoicemailCode

Optional

passcode

Range 0-15 digits, default is blank.

Example:
<Group Guid="cf4b99005f3511d80b100e007026702" Opp="Update">
<VoicemailCode>12345</VoicemailCode>
</Group>

IP Office Configuration Service Programmer's Guide


IP Office

Page 32
15-601473 Issue 03b (20 February 2013)

XML Format: Groups

4.3.1 Group Membership


Group Membership is expressed as a set of "Member" elements scoped by a "Members" element container, the container is
scoped by the Group entity containing element. You manipulate these in a similar manner to DSS Key entries for a user, in
that each member has an "Extn" attribute to indicate the members extension number and an "Opp" code to indicate the
desired operation "Add", "Update", "Delete". The "Enabled" status is set via an element with a true/false value.
Group Record

Parent Elements

Entity Element

<Group>

Comments
The Group level must contain an "
Opp" code attribute of update.

<Members>
<Member Extn="205" Opp="Add">

The member extension is


expressed as an attribute.

<Enabled>true</Enabled>

Enabled status

</Member>
</Members>
</Group>

Example: Creating a new group and setting the members


<?xml version="1.0" encoding="utf-8"?>
<AvayaIPOConfiguration>
<Groups>
<Group Guid="73aaad8049ee11d5832200e007026702" Opp="Add">
<Name>Mark</Name>
<Extn>400</Extn>
<GroupRingMode>Sequential</GroupRingMode>
<VoicemailOn>true</VoicemailOn>
<Members>
<Member Extn="201" Opp="Add">
<Enabled>true</Enabled>
</Member>
<Member Extn="202" Opp="Add">
<Enabled>true</Enabled>
</Member>
<Member Extn="203" Opp="Add">
<Enabled>true</Enabled>
</Member>
</Members>
</Group>
</Groups>
</AvayaIPOConfiguration>

IP Office Configuration Service Programmer's Guide


IP Office

Page 33
15-601473 Issue 03b (20 February 2013)

Chapter 5.
Hosting and Secure
Configuration Guides

IP Office Configuration Service Programmer's Guide


IP Office

Page 35
15-601473 Issue 03b (20 February 2013)

5. Hosting and Secure Configuration Guides


The following sections provide guidance on how to secure the IP Office transport via the new secure service configuration
capabilities in the 4.1 and above release of IP Office. Guidance is also provide on how to host the service under IIS. While
we focus on this method, it is worth mentioning that there are a number of other hosting models available, that may be
more suitable to your particular needs, please see the WCF documentation available on-line at http://msdn.microsoft.com.

5.1 Configuring Secure Transport on IP Office


IP Office 4.1 and higher stores a separate security configuration, which is accessible via the security settings editor in IP
Office Manager. You access the security settings via File | Advanced | Security Settings menu in the IP Office Manager
application. Select the unit and establish a logon using a security account. The default account on a new system is "
security" and the password is "securitypwd". This is a quick guide to getting the necessary secure configuration
transport enabled.

Note
Note that the arrangement of the security settings forms may vary depending on the particular core software
release of a system. The notes below are a general indication of where the settings are located only.

Note
The process below creates a default system security certificate if necessary. Creating certificates is system
intensive and can take few minutes. It is recommended that this is done when the system is not in use or is
relatively idle. Selecting any secure option will cause an internal certificate to be generated if one does not
already exist.

When first configuring a system, its prudent to ensure that the configuration service has both secure and unsecured
access, to support existing access via IP Office Manager over UDP, until you are confident about securing the system.
Deployment of a secured system is dependent on customer needs, but the service API only supports secure access.
To configure the Services, select the Services node from the tree and from the Group pane select the Configuration
service. Initially configure it to support both Unsecure + Secure as in the example diagram below.

Open the security settings after a few minutes. The exact time is dependent on your IP Office hardware (an IP500/IP500
V2 creates a certificate in about 30 seconds whilst an IP Office Small Office system can take 15 minutes).

IP Office Configuration Service Programmer's Guide


IP Office

Page 36
15-601473 Issue 03b (20 February 2013)

Hosting and Secure Configuration Guides: Configuring Secure Transport on IP Office


If you select the System node in the tree you will see that an internal certificate has been created based on the string "IP
Office" + MAC Address. See the following diagram for reference.

Note
You can configure IP Office Manager to utilize the secure connection, via the File | Preferences | Security
tab. Check that you can access the IP Office using a secure connection with IP Office Manager to confirm your
configuration is valid. A small shield is displayed in the bottom right status bar of IP Office Manager to indicate
it is using a secure connection.

IP Office Configuration Service Programmer's Guide


IP Office

Page 37
15-601473 Issue 03b (20 February 2013)

5.2 Hosting Under IIS


To host the service under IIS, you need to create a virtual directory to host the web application, using the "Internet
Information Services (IIS) Manager". At the physical location used to host the web application, a "bin" sub directory is
required to host the service binaries. In the root of the application a "service.svc" file is required to expose the service, it
needs to contain the service details as follows:
<% @ServiceHost Service = "IPOConfigService.Service.IPOfficeService" %>

The binaries should be copied to a bin directory. The deployment model is the same as a .Net web application.
To complete the installation a web.config file is required in the web application root to configure the service. If you have
an existing configuration, merge in the service elements shown below for reference.
<system.serviceModel>
<services>
<service name="IPOConfigService.Service.IPOfficeService"
behaviorConfiguration="IPOfficeConfigSvcBehavior">
<endpoint address="" binding="wsHttpBinding"
contract="IPOConfigService.Service.Interface.IConfigurationService" />
<endpoint address="mex" binding="mexHttpBinding" contract="IMetadataExchange"/>
</service>
</services>
<behaviors>
<serviceBehaviors>
<behavior name="IPOfficeConfigSvcBehavior">
<serviceMetadata httpGetEnabled="True" />
<serviceDebug includeExceptionDetailInFaults="True" />
</behavior>
</serviceBehaviors>
</behaviors>
</system.serviceModel>

There are many choices to consider based on your deployment scenario, WCF supports a number of profiles to meet
interoperability and various levels of security, please refer to the following on-line detailed article: WCF - Configuring
Services http://msdn2.microsoft.com/en-us/library/ms733830.aspx.

Note
The two key bindings are "basicHttpBinding" used to enable interoperability, there is no security by default,
and transport level security can be established using a secured transport "https". The more advanced "ws*"
protocols are enabled by configuring the binding to use "wsHttpBinding", this enables access to the more
secure standards and security is enabled by default. The windows account is utilized by default, there are other
authentication alternatives including custom ASP.Net and certificate authentication. These can all be configured
via the configuration file.
Access to the WSDL is only required to develop your proxy, you should turn off access to the service definition
when your service is deployed in a live environment.

IP Office Configuration Service Programmer's Guide


IP Office

Page 38
15-601473 Issue 03b (20 February 2013)

Index
Ports 14

Index

RebootDetected 20
Root Element 24
Rotary 31

.NET 11

A
Add 9
Architecture 14
ASP 11

S
Sequential 31
SetUnitConfiguration 20
Software Version 18

B
basicHttpBinding 38
BatchTransactional 20
BINDING 10

U
UCC 10
Unit MAC Address 18
Unit Name 18
Unit Type 18
Update 9
User
Extn 25
Name 25
UserRights 25

C
CanIntrude 25
CannotBeIntruded 25
Collective 31
ConfigTransferred 20
ConnectAndGetUnitDetails 18
ConnectivityFault 20

Default Ports 14
Delete 9
Document Root 24
DSSKeys 28

Visual Studio 11
VoicemailAnswerTime 31
VoicemailCode
Group 31
User 25
VoicemailOn
Group 31
User 25

E
Error 9
Errors 20
Extn
Group 31
User 25

W
Warning 9, 20
WCF 10
Windows Server 11
WinFx 10
wsHttpBinding 38

F
FullName 25

G
GetUnitConfiguration 19
Group
Extn 31
Name 31
GroupRingMode 31
GUID 10

X
XDirectory 25

I
IIS 38
Informational 9, 20
IP Address 18

L
LongestWaiting 31

M
Method
ConnectAndGetUnitDetails
GetUnitConfiguration 19
SetUnitConfiguration 20

18

N
Name
FullName 25
Group 31
User 25
NoAnswerTime 31

O
Operating System 11
OPP 10

P
PhoneType 25
PhoneTypeIndex 25
IP Office Configuration Service Programmer's Guide
IP Office

Page 39
15-601473 Issue 03b (20 February 2013)

IP Office Configuration Service Programmer's Guide


IP Office

Page 41
15-601473 Issue 03b (20 February 2013)

Template: 21st November 2012

Performance figures and data quoted in this document are typical, and must be
specifically confirmed in writing by Avaya before they become applicable to any
particular order or contract. The company reserves the right to make alterations
or amendments to the detailed specifications at its discretion. The publication of
information in this document does not imply freedom from patent or other
protective rights of Avaya or others.
All trademarks identified by the or are registered trademarks or trademarks,
respectively, of Avaya Inc. All other trademarks are the property of their
respective owners.
This document contains proprietary information of Avaya and is not to be
disclosed or used except in accordance with applicable agreements.
2013 Avaya Inc. All rights reserved.
IP Office Configuration Service Programmer's Guide
IP Office

Page 42
15-601473 Issue 03b (20 February 2013)