Interface to Open

Communications
OpenScape Voice V5
Assistant API
Volume 8, Assistant API Description

A31003-H8050-M104-1-76A9

Communication for the open minded

Siemens Enterprise Communications

www.siemens-enterprise.com
 Copyright © Siemens Enterprise
Communications GmbH & Co. KG 2010
Hofmannstr. 51, 80200 München
Siemens Enterprise Communications GmbH & Co. KG
is a Trademark Licensee of Siemens AG
Reference No.: A31003-H8050-M104-1-76A9
The information provided in this document contains
merely general descriptions or characteristics of
performance which in case of actual use do not
always apply as described or which may change as
a result of further development of the products. An
obligation to provide the respective characteristics
shall only exist if expressly agreed in the terms of
contract. Availability and technical specifications are
subject to change without notice.
Communication for the open minded OpenScape, OpenStage and HiPath are registered
trademarks of Siemens Enterprise
Communications GmbH & Co. KG.
Siemens Enterprise Communications All other company, brand, product and service
www.siemens-enterprise.com names are trademarks or registered trademarks of
their respective holders.
 HP8000AssistantAPITOC.fm
For internal use only OpenScape Voice V5 Assistant API - Content

OpenScape Voice V5 Assistant API - Content 0

1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.1 The OpenScape Voice V5 implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.2 The OpenScape Voice V5 WSDL file. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.3 The OpenScape Voice V5 operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.3.1 General Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
1.3.2 Session-Related Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
1.3.2.1 Open a session (openSession) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
1.3.2.2 Close a session (closeSession). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
1.3.3 System-Related Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
1.3.3.1 Show the API version (getApiServerVersion) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
1.3.3.2 Show the Software Versions (getSwVersions) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
1.3.4 Office Code-Related Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
1.3.4.1 List Office Codes (listOfficeCodes) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
1.3.4.2 Create an Office Code (createOfficeCode) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
1.3.4.3 Delete an Office Code (deleteOfficeCode) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
1.3.5 Directory Number-Related Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
1.3.5.1 List Directory Numbers of an Office Code (listDirectoryNumbers) . . . . . . . . . . . . . . . . . . . . . . . . 11
1.3.5.2 Add Directory Numbers to an Office Code (createDirectoryNumbers) . . . . . . . . . . . . . . . . . . . . . 11
1.3.5.3 Delete a Directory Number (deleteDirectoryNumbers) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
1.3.5.4 List Vacant Directory Numbers (listVacantDirectoryNumbers) . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
1.3.6 Numbering Plan-Related Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
1.3.6.1 List Numbering Plans (listPrivateNumberingPlans). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
1.3.6.2 List Numbering Plan Subscribers (listNumberingPlanSubscribers). . . . . . . . . . . . . . . . . . . . . . . . 12
1.3.7 Numbering Plan Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
1.3.7.1 List Rate Areas (listRateAreas) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
1.3.7.2 List Classes of Service (listClassesOfService) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
1.3.7.3 List Calling Locations (listCallingLocations) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
1.3.8 Business Group-Related Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
1.3.8.1 List Business Groups (listBusinessGroups) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
1.3.8.2 Create a Business Group (createBusinessGroup) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
1.3.8.3 Delete a Business Group (deleteBusinessGroup). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
1.3.8.4 Modify a Business Group (modifyBusinessGroup) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
1.3.8.5 List all properties of a Business Group (getBusinessGroup). . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
1.3.8.6 List the Subscribers of a Business Group (listBusinessGroupSubscribers) . . . . . . . . . . . . . . . . . 16
1.3.8.7 List the SIP Subscribers of a Business Group (listBusinessGroupSubscribersSip) . . . . . . . . . . . 16
1.3.8.8 List the SIP Subscriber ID passed to DLS (listBusinessGroupSubscribersSipV4) . . . . . . . . . . . . 17
1.3.8.9 List the Feature Profiles of a Business Group (listFeatureProfiles). . . . . . . . . . . . . . . . . . . . . . . . 17
1.3.8.10 List the Departments of a Business Group (listDepartmentsOfBusinessGroup) . . . . . . . . . . . . . 17
1.3.8.11 List the Call Pickup Groups of a Business Group (listCallPickupGroups) . . . . . . . . . . . . . . . . . . 17
1.3.9 Subscriber-Related Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
1.3.9.1 List Subscribers (listBusinessGroupSubscribers) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
1.3.9.2 List all Properties of a Subscriber (getSubscriber) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
1.3.9.3 List SIP details of the Subscribers (listBusinessGroupSubscribersSip) . . . . . . . . . . . . . . . . . . . . 21
1.3.9.4 Create a Subscriber (CreateSubscriber) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
1.3.9.5 Modify a Subscriber (modifySubscriber) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
1.3.9.6 Delete Subscriber (deleteSubscriber) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
1.3.9.7 List Intercept Announcements (listInterceptAnnouncements) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

A31003-H8050-M104-1-76A9, 09/2010
OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description 3
HP8000AssistantAPITOC.fm
OpenScape Voice V5 Assistant API - Content For internal use only

1.3.10 Feature Profile-Related Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

1.3.10.1 Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
1.3.10.2 List all Feature Profiles(listFeatureProfiles) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
1.3.10.3 List all properties of a Feature Profile (getFeatureProfile) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
1.3.10.4 Create Feature Profile (createFeatureProfile) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
1.3.10.5 Modify a Feature Profile (modifyFeatureProfile) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
1.3.10.6 Delete a Feature Profile (deleteFeatureProfile) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
1.3.11 DLS-Related Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
1.3.11.1 List DLS Servers (listDLS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
1.3.12 Switch-Related Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
1.3.12.1 List Switches (listSwitch) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
1.3.12.2 List Used and Total Licenses (listLicenses) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
1.3.12.3 Retrieve the Operation Mode of a Switch (getOperationMode) . . . . . . . . . . . . . . . . . . . . . . . . . 45
1.3.13 OpenScape Branch-Related Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
1.3.13.1 List Available OpenScape Branch Offices (listOpenBranches) . . . . . . . . . . . . . . . . . . . . . . . . . 46
1.3.14 Scenarios. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
1.3.14.1 Create a Business Group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
1.3.14.2 Create a Subscriber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
1.3.14.3 Modify the Display Name of a Subscriber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
2 Using the OpenScape Voice V5 with Java . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
2.1 Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
2.2 Analyzing the OpenScape Voice V5 WSDL file with Java . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
2.2.1 Preparing the WSDL Analysis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
2.2.2 Showing available operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
2.2.3 Showing operational parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
2.3 Sending commands to the OpenScape Voice with Java . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
2.3.1 A simple client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
2.3.2 A complex client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
2.4 Secure Access to OpenScape Voice V5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
3 Using the OpenScape Voice V5 with PHP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
3.1 Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
3.2 Analyzing the OpenScape Voice V5 WSDL file with PHP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
3.2.1 Preparing the WSDL analysis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
3.2.2 Showing available operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
3.2.3 Showing operational parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
3.2.4 Showing WSDL specific types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
3.3 Sending commands to the OpenScape Voice with PHP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
3.3.1 Preparing the communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
3.3.2 Sending a simple command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
3.3.3 Sending a complex command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

A31003-H8050-M104-1-76A9, 09/2010
4 OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description
 HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 implementation

1 Introduction

Note: OpenScape Voice was formerly known as HiPath 8000. References to

HiPath 8000 in this documentation are equivalent to OpenScape Voice.

The administration of the OpenScape Voice system is done by the OpenScape

Voice Assistant, a web based administration interface. Because there are service
and customer scenarios where automatic changes of special OpenScape Voice
settings are required by ’foreign’ applications, the OpenScape Voice Assistant
also offers a web services interface called OpenScape Voice Assistant API.
This API provides a WSDL (Web Service Description Language) file describing
all possible operations and all data structures used.

The document at hand describes the content of this WSDL file for the OpenScape
Voice Assistant API version 3.1 and the usage of the provided web services.

To use this document, the user should have a knowledge about the general
architecture of the OpenScape Voice and how it is to be used. In addition, the
user should have a general understanding of SOAP (Simple Object Access
Protocol) and WSDL.

1.1 The OpenScape Voice V5 implementation

The OpenScape Voice V5 is implemeted as Java Web Services using the
Apache implementation of the ’Simple Object Access Protocol’ (SOAP) called
Axis. It is automatically installed on the same server as the OpenScape Voice V5
Assistant as Axis services running on the Tomcat web server.

1.2 The OpenScape Voice V5 WSDL file

The OpenScape Voice V5 WSDL can be found and viewed at the URL
https://<yourHiPath8000Assistant>/HiPath8000AssistantAPIv310/
services/HiPath8000AssistantAPI?wsdl

1.3 The OpenScape Voice V5 operations

All available operations can be displayed at the URL
https://<yourHiPath8000Assistant>/HiPath8000AssistantAPIv310/
services

A31003-H8050-M104-1-76A9, 09/2010
OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description 5
HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 operations

1.3.1 General Information

OpenScape Voice Assistant API operations are logically grouped as

• Session-Related Commands,

• System-Related Commands,

• Office Code-Related Commands,

• Directory Number-Related Commands,

• Numbering Plan-Related Commands,

• Numbering Plan Resources,

• Business Group-Related Commands,

• Subscriber-Related Commands,

• Feature Profile-Related Commands,

• DLS-Related Commands,

• Switch-Related Commands.

The methods, input and return parameters and values for these parameters are
explained in detail in the following sections.

Most of the API operations can be used by authorized users only. Therefore, a
session token should be requested and this token shall be added to every
command to be executed. The session token request is done via
openSession(username, password) method. For finishing the session, this
session should be closed with closeSession(sessionToken) method.

Predefined User Profiles

OpenScape Voice Assistant uses predefined profiles. The profiles specify the
access rights of the users. Depending on the profiles and the features assigned
to the profiles, the user is either allowed or not allowed to perform the operations.
If the method is not allowed to run, the user will get the proper error message. The
administration of the profiles is performed using the OpenScape Voice Assistant.

It is recommended to create a dedicated user account for the API access. This can be done using the

> OpenScape Voice Assistant application.

Multiple OpenScape Voice Switch Support

The OpenScape Voice Assistant API supports multiple OpenScape Voice
switches. In other words, the user can perform operations on different
OpenScape Voice switches by specifying the proper switch name in the method.
For example, the user can list business groups of switch1 whose name is

A31003-H8050-M104-1-76A9, 09/2010
6 OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description
 HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 operations

switchName1 via listBusinessGroups(sessionToken, switchName1) method

or list office codes of switch2 whose name is switchName2 via
listOfficeCodes(sessionToken, switchName2) method.

Multiple DLS Support

A list of all available DLS servers (with active API) can be displayed to the user.
This list contains several pieces of information, including DLS Server Name, DLS
ID, DLS Status and Version, DLS URL, API URL and DLS Client Session ID.

Additionally, the user can create a subscriber and select the DLS server to which
he wants to be assigned in order to send data to this server. Using the Modify
Subscriber method the user can also change the assigned DLS server.
On the other hand, the user may retrieve basic DLS data – the DLS name and
DLS ID – from the corresponding DLS server, via the subscriber data.

Types of Operations of API

There are typically five types of operations of API:

create

Create and modify operations get the bean as an input parameter. They
usually return ResultStatus bean. The input bean points to the valid bean like
OfficeCodeBean, BusinessGroupBean …etc.

delete

Delete operations get the unique property of the bean like name or id as an
input parameter. They also return ResultStatus bean.

get

Get operations have the unique property of the bean like name or id as an
input parameter. They return response bean of the operation, which includes
ResultStatus bean and required bean.

modify

Create and modify operations get the bean as an input parameter. They
return ResultStatus bean. The input bean points to the valid bean like
OfficeCodeBean, BusinessGroupBean etc.

and

A31003-H8050-M104-1-76A9, 09/2010
OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description 7
HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 operations

list

List operations usually do not have any input parameter except session
token. They return response bean of the operation, which includes
ResultStatus bean and required list of beans.

Office codes, directory numbers, business groups, subscribers, feature profiles

are created, deleted, get, modifed and listed via API. Each of these operations
requires session token as input parameter.

For enumerated values, constants are used. There are many types of constants
like ConstantsApplyRecall, ConstantsAuthorizationCode…etc. Proper constant
value should be set to the enumerated field.

For a better understanding of the usage of the available API operations, we

present you some scenarios in Section 1.3.14, “Scenarios” after describing the
methods in detail.

ResultStatus

ResultStatus bean contains the execution state of the operation. If any error has
occurred during validation of parameters or during execution of the operation, the
currentState field of ResultStatus includes the error or failure message. If the
operation is executed successfully, this field contains an empty string.

1.3.2 Session-Related Commands

1.3.2.1 Open a session (openSession)

Nearly all operations of the OpenScape Voice Assistant API need a session
token. This token has to be retrieved via openSession(username, password)
method.

1.3.2.2 Close a session (closeSession)

For finishing a session you have to call closeSession(sessionToken) method.

A31003-H8050-M104-1-76A9, 09/2010
8 OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description
 HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 operations

1.3.3 System-Related Commands

1.3.3.1 Show the API version (getApiServerVersion)

Every API version is related to a specific URL. The same API version always
offers the same interface, regardless of the appropriate release number. Changes
to the interface result in a new API version. At least two different API versions are
supported at the same time. Therefore, your applications must not always be
adapted after interface changes.

Use getApiServerVersion() method to read the version number of the attached

web services. The server version method returns "3.1" for this version.

1.3.3.2 Show the Software Versions (getSwVersions)

The user can retrieve information regarding the software status of the operating
system via getSwVersions (sessionToken, switchName) method. The
available information concerning the software status are: HiPath8000 version,
Assistant version, Patchset level and Build number. The
AssistantSwVersionBean includes those versions.

1.3.4 Office Code-Related Commands

Office codes must be created before subscribers can be allocated to the switch.

The office code is comprised of country code, area code, location code (i.e. local
office code) consecutively.

The user can create, delete and list office codes using API. The office code bean,
named OfficeCodeBean, is used for create and list operations.

Office Code Bean (OfficeCodeBean)

The fields of the office code bean are the following:

Field Name Description Length Range Default Value

officeCode The office code is composed of 1..9 Numeric string
country code, area code, location
code (i.e. local office code).
countryCode The country code. 0..4 Numeric string
areaCode The area code. 0..6 Numeric string
locationCode The location code (i.e. local office 1..8 Numeric string Required
code).

Table 1 Fields of the office code bean

A31003-H8050-M104-1-76A9, 09/2010
OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description 9
HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 operations

1.3.4.1 List Office Codes (listOfficeCodes)

For listing all available office codes, listOfficeCodes(sessionToken,

switchName) method is used. For each office code you will receive its code in a
plain and a structured way, also separated in country code, area code and
location code (i.e. local office code).

1.3.4.2 Create an Office Code (createOfficeCode)

Creating an office code is the first thing you have to do if you plan to create a
business group. To create an office code, createOfficeCode(sessionToken,
switchName, inputBean) method is used. The inputBean points to an
OfficeCodeBean. This method returns CreateOfficeCodeResult which includes
the result status and created office code. This is the only create method returning
the result bean instead of ResultStatus.

The office code is created by concatenation of country code, area code and
location code (i.e. local office code), which are specified in the office code bean.

To create an office code, at least a 1-digit non-empty location code (i.e. local office
code) shall be provided, and office code should not exceed 9 digits.

1.3.4.3 Delete an Office Code (deleteOfficeCode)

Deleting an office code is done via deleteOfficeCode(sessionToken,

switchName, officeCode) method. Existing office code shall be provided for
successful deletion.

This operations will not be successful in case the office code is still used.

1.3.5 Directory Number-Related Commands

The directory numbers for an office code can be created, deleted and listed by
API. Moreover, vacant directory numbers of an office code can be listed. The
directory number bean, DirectoryNumberBean, is used for list operations.

Directory Number Bean (DirectoryNumberBean)

The fields of the directory number bean are the following:

Field Name Description Length Range Default Value

officeCode The office for this directory 1..9 Numeric string Required
number.

Table 2 Fields of directory number bean

A31003-H8050-M104-1-76A9, 09/2010
10 OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description
 HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 operations

Field Name Description Length Range Default Value

extension The directory number. 3..6 Numeric string Required

Table 2 Fields of directory number bean

1.3.5.1 List Directory Numbers of an Office Code

(listDirectoryNumbers)

To get all available directory numbers of an office code, listDirectoryNumbers

(sessionToken, switchName, officeCode) method is used. The list of directory
number beans, named DirectoryNumberBean, is retrieved.

1.3.5.2 Add Directory Numbers to an Office Code

(createDirectoryNumbers)

With createDirectoryNumbers(sessionToken, switchName, officeCode,

startExtension, endExtension,tenantDomain), you can add a range of
directory numbers in the specified interval of start extension and end extension to
an office code.

All parameters of the method are mandatory. The valid values for the parameters
shall be provided. Start extension and end extension are usually 4-digit integers
and they should have the same digit length. Tenant domain shall be a valid
domain.

To create a range of directory numbers, last subscriber number must be greater

than the starting subscriber number. To create a single directory number, last
extension number must equal the start extension number.

1.3.5.3 Delete a Directory Number (deleteDirectoryNumbers)

With deleteDirectoryNumber(sessionToken, switchName, officeCode,

extension) method, you can delete any directory number. Existing office code
and extension of the directory number shall be provided for successful deletion.

1.3.5.4 List Vacant Directory Numbers

(listVacantDirectoryNumbers)

For creating subscribers you need a directory number not yet used. With
listVacantDirectoryNumbers (sessionToken, switchName, officeCode)
method, a list of all vacant extensions for a given office code can be retrieved.

A31003-H8050-M104-1-76A9, 09/2010
OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description 11
HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 operations

1.3.6 Numbering Plan-Related Commands

The numbering plans can be listed by API user. Moreover, subscribers of the
numbering plans can be listed.

Numbering Plan Bean (NPBean)

The fields of the numbering plan bean are the following:

Field Name Description Length Range Default Value

name The name of the numbering plan. Character String
type The numbering plan type. Character String

Table 3 Fields of the numbering plan bean

1.3.6.1 List Numbering Plans (listPrivateNumberingPlans)

The numbering plans can be retrived using

listPrivateNumberingPlans(sessionToken, switchName,
businessGroupName) method. This method retrieves the private numbers of
given business group name in the list of NPBean.

1.3.6.2 List Numbering Plan Subscribers

(listNumberingPlanSubscribers)

The subscribers of the numbering plans can be listed using

listNumberingPlanSubscribers (sessionToken, switchName,
businessGroupName, numberingPlanName) method. The business group
name of the numbering plan and the name of the numbering plan shall be
provided.

The list of subscriberBean with summary info is retrieved as a result. Resulting

subscriber beans include service id, feature profile name, display name and bg
line name (i.e. subscriber name) properties of the subscriber.

1.3.7 Numbering Plan Resources

1.3.7.1 List Rate Areas (listRateAreas)

You can list all rate areas (i.e. Routing Areas) via listRateAreas(sessionToken,
switchName) method. The list of rate areas (i.e. routing areas), named
RateAreaBean, will be retrieved as a result.

A31003-H8050-M104-1-76A9, 09/2010
12 OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description
 HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 operations

1.3.7.2 List Classes of Service (listClassesOfService)

You can list classes of service using listClassesOfService(sessionToken,

switchName) method. The list of classes of service, named
ClassOfServiceBean, will be retrieved as a result.

1.3.7.3 List Calling Locations (listCallingLocations)

The calling locations can be retrived using listCallingLocations(sessionToken,

switchName) method. The list of calling locations, named CallingLocationBean,
will be retrieved as a result.

1.3.8 Business Group-Related Commands

A Business Group (BG) is an entity of related subscribers.

The user can create, delete, modify, get and list business groups by using API.
The generic business group bean, named BGBean, is used for create, modify and
get operations. The list method returns list of business group list bean, named
BGListBean.

Business Group Bean (BGBean)

The fields of the business group bean are the following:

Field Name Description Length Range Default Value

businessGroupNa The business group name. It should 1..28 Character String Required
me be unique.
defaultOfficeCode Existing office code shall be 1..9 Numeric String Required
provided. Any existing office
code1
displayNumber The display number, shown when a 1..15 Numeric String Required
subscriber makes an external call.
It should be unique.
numberingPlan Default numbering plan for the
business group.
cdrActive Activate/deactivate value for call True, False False
data recording.
cdrId Identification of customer during call 10 Numeric String
data recording.
emergencyAnnou Emergency announcement of Character String
ncement Emergency LIN Administration Any existing
service. intercept
announcement2
Table 4 Fields of the business group bean

A31003-H8050-M104-1-76A9, 09/2010
OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description 13
HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 operations

Field Name Description Length Range Default Value

emergencyNumb Emergency number of Emergency Numeric String
er LIN Administration service. Any existing
subscriber ID3
hotDeskHH Hour value of the auto-logoff time of 1 to 24 hour
hot desking service.
Auto-logoff time is the time at which
all subscribers’ hot desking session
will be automatically terminated.
hotDeskmm Minute value of the auto-logoff time 0 to 59 min
of hot desking service.
nightBellCPUActiv Activate/deactivate Night Bell Call True, False False
e Pickup Group service, which is a
group of phones that ring
simultaneously.
Incoming calls can be picked up by
any Subscriber in the Business
Group that the Night Bell CPU
Group is associated with.
nightBellCPUId The night bell call pickup group. Numeric String
Any existing pickup
group4
Table 4 Fields of the business group bean
1 Office codes can be retrieved using listOfficeCodes method (Section 1.3.4.1, “List Office Codes (listOfficeCodes)”)
2 Emergency announcements can be retrieved by listInterceptAnnouncement method (Section 1.3.9.7, “List Intercept Announcements
(listInterceptAnnouncements)”)
3 Subscribers of the business group can be retrieved by listBusinessGroupSubscribers method (List the Subscribers of a Business
Group (listBusinessGroupSubscribers))
4 Call pickup groups can be retrieved by listCallPickupGroups method (Section 1.3.8.11, “List the Call Pickup Groups of a Business
Group (listCallPickupGroups)”)

Business Group List Bean (BGListBean)

This is the summary bean of business group. It is only used for listing purposes.

The fields of the business group list bean are the following:

Field Name Description Length Range Default Value

businessGroupName The business group name. Character String
areaCode The area code of the office code Numeric String
countryCode The country code of the office code Numeric String
localOfficeCode The location code (i.e. local office Numeric String
code) of the office code
displayNumber The display number, shown when a Numeric String
subscriber makes an external call.
defaultFeatureProfile The default feature profile Character String
numberSubscribers The number of subscribers

Table 5 Fields of the business group list bean

A31003-H8050-M104-1-76A9, 09/2010
14 OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description
 HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 operations

1.3.8.1 List Business Groups (listBusinessGroups)

You can list all available business groups via listBusinessGroups

(sessionToken, switchName) method and you will receive a list of all business
groups, BGListBean’s, including their name, their display number and their
amount of associated subscribers.

The list business group method retrieves only some properties of the business
groups. If you need the details of the business group, you should use the
getBusinessGroup method.

1.3.8.2 Create a Business Group (createBusinessGroup)

With createBusinessGroup(sessionToken, switchName, inputBean)

method, you can create a new business group. The inputBean parameter is of
type BGBean.

It expects at least businessGroupName, defaultOfficeCode and

displayNumber being set. Business group name should be unique in the
OpenScape Voice node. Display number should be unique in the OpenScape
Voice node, too.

Existing office code should be provided. The listOfficeCodes method can be

used to obtain available office codes.

Business Group specific services are

• Hot Desking,

• Night Bell Call Pickup,

• Emergency LIN Administration.

These services can be activated or deactivated.

Existing values for call pickup group, emergency number and emergency
announcement should be set. Proper list methods can be used for retrieveing
existing values.

1.3.8.3 Delete a Business Group (deleteBusinessGroup)

For deleting a business group, deleteBusinessGroup(sessionToken,

switchName, businessGroupName) method is used. Existing business group
name shall be provided for successful deletion.

A31003-H8050-M104-1-76A9, 09/2010
OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description 15
HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 operations

1.3.8.4 Modify a Business Group (modifyBusinessGroup)

You can modify a business group using modifyBusinessGroup(sessionToken,

switchName, inputBean) method. As an inputBean, you have to provide a valid
business group bean. Either you can create this bean from scratch or you can first
retrieve a business group using getBusinessGroup command. If you’re creating
from scratch, you have to set at least businessGroupName, defaultOfficeCode
and displayNumber in the bean.

1.3.8.5 List all properties of a Business Group

(getBusinessGroup)

In order to retrieve all properties of a business group, you can use

getBusinessGroup (sessionToken, switchName, businessGroupName)
method. Existing business group name shall be provided. You will get a business
group bean as return value which contains all the properties of the business
group.

1.3.8.6 List the Subscribers of a Business Group

(listBusinessGroupSubscribers)

To list the subscribers, listBusinessGroupSubscribers(sessionToken,

switchName, businessGroupName) method is used. If the
businessGroupName parameter is empty, all subscribers of the system (for all
Business Groups) are listed. If the businessGroupName parameter is not empty,
all subscribers of the mentioned Business Group are listed. In the result, you find
all valid subscriber IDs which can be used for further operations.

1.3.8.7 List the SIP Subscribers of a Business Group

(listBusinessGroupSubscribersSip)

To list all SIP details of a business group,

listBusinessGroupSubscribersSip(sessionToken, switchName,
businessGroupName) method is used.

A31003-H8050-M104-1-76A9, 09/2010
16 OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description
 HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 operations

1.3.8.8 List the SIP Subscriber ID passed to DLS

(listBusinessGroupSubscribersSipV4)

As of OpenScape Voice V3.1 R3, in order to list the display IDs of all SIP
subscribers passed to DLS for synchronization purposes, use the
listBusinessGroupSubscribersSipV4(sessionToken, switchName,
businessGroupName) method.

Note: There is no compatibility check on the Assistant (DSA) side, so if the call
to listBusinessGroupSubscribersSipV4 fails, an AxisException emerges and
the user must handle and explicitly call the old
listBusinessGroupSubscribersSip method.

1.3.8.9 List the Feature Profiles of a Business Group

(listFeatureProfiles)

You can list all profiles of a business group via

listFeatureProfiles(sessionToken, switchName, businessGroupName,
featureProfileType) method. You will get a list of Feature Profiles of the Business
Group according to the profile type you have provided.

1.3.8.10 List the Departments of a Business Group

(listDepartmentsOfBusinessGroup)

The departments of a business group can be listed via

listDepartmentsOfBusinessGroup (sessionToken, switchName,
businessGroupName) method. You will get a list of departments of the business
group as a result.

1.3.8.11 List the Call Pickup Groups of a Business Group

(listCallPickupGroups)

To list all call pickup groups of a business group, listCallPickupGroups

(sessionToken, switchName, businessGroupName) method is used. You will
get a list of pickup groups of the business group as a result.

A31003-H8050-M104-1-76A9, 09/2010
OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description 17
HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 operations

1.3.9 Subscriber-Related Commands

You can create, delete, modify, get and list subscribers by using API. The
subscriber bean, named SubscriberBean, is used for create, modify and get
operations. Moreover, the list method returns list of subscriber beans.

Subscriber Bean (SubscriberBean)

The fields of the susbscriber bean are the following:

Field Name Description Length Range Default Value

serviceID The service ID of the subscriber. Numeric String
It is composed of office code and
extension.
businessGroupNa The business group name. Character String Required
me Any existing
business group
name1.
officeCode The office code. 1..9 Numeric String Required
Any existing office2.
extension The directory number of the 3..6 Numeric String Required
subscriber. Any vacant directory
number3.
displayName The external display name of the 0..30 Character String System user name
subscriber.
bgLineName The internal display name of the 0..30 Character String System user name
subscriber.
pickupGroup The call pickup group. Numeric String
Any existing call
pickup group4.
COS The class of services. Character String
Any existing class of
service5.
rateArea The rate area. Character String
Any existing rate
area6.
callingLoc The calling location. Character String
Any existing calling
location7.
SIP PHONE Fields (They make sense, if Connection Info is SIP Phone)
phoneName The name for the SIP phone. It is 0..15 Character String. Required, if Connection
used during the registration of Should be unique. Information is SIP Phone
this phone.
regType The type of the SIP registration. Enum Static Dynamic
Dynamic

Table 6 Fields of subscriber bean

A31003-H8050-M104-1-76A9, 09/2010
18 OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description
 HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 operations

Field Name Description Length Range Default Value

serviceType The SIP transport type. Enum UDP UDP
TCP
TLS
ipaddress The IP adress for SIP phone. Standard IP address Required, if registration
It is meaningful when the convention type is static
registration type is static. (XXX.XXX.XXX.XXX
)
port The port for SIP phone.It is 0..5 Numeric String Required, if registration
meaningful when the registration Standard port type is static
type is static. number convention
1..9999
realm The domain of SIP phone. 0..128 Character String
userName The user name for the SIP phone 6...64 Character String
user.
passWord The password for the SIP phone 6...20 Character String
user.
Advanced Fields
bgDeptName The department name Character String
Any existing
department name8
timezone The timezone Enum GMT+0, GMT+1...,
GMT+1
PIN The personal identification 0..10 Numeric String
number.
This code is used by various
service features where a PIN is
needed, unless that feature has
its own PIN.
SIP(connectionInf The connection information. Enum SIP Phone, Profile if profile info value is
o) Profile only means that you Only selected, above SIP
create a subscriber who does not Phone Fields does not
have a connection. The make sense.
subscriber cannot use Remote
Call Forwarding (RCF).
externalDNFlag The flag that specifies if the True, False True
subscriber is an external
directory number. External
directory number means that a
caller can dial this number from
outside to reach an internal
subscriber.
bgAttendantNumb The flag specifying if the True, False False
er subscriber is an attendant
number.
keyset The keyset. Enum None, None
Primary Line,
Phantom Line
Table 6 Fields of subscriber bean

A31003-H8050-M104-1-76A9, 09/2010
OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description 19
HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 operations

Field Name Description Length Range Default Value

featureProfileNam The feature profile name. Character String.
e Any existing feature
profile name9
featureProfileBGN The business group name of the Character String
ame feature profile. The business group
name of the selected
feature profile name
macAddress The mac address of the Number String
subscriber sperated by colons

deviceProfile The device profile of the Chracter String,

subscriber Proper device profile
from DLS
plugAndPlayStan The plug and play standard of the
dard subscriber
dlsId id of the dls server Numeric String,
Proper dls server id10
dlsName the name of the dls server Character String,
Proper dls server
name11
Table 6 Fields of subscriber bean
1 Defined business groups can be retrieved using the listBusinessGroups method (Section 1.3.8.1, “List Business Groups
(listBusinessGroups)”)
2 The available list of office codes can be retrieved using the listOfficeCodes method (Section 1.3.4.1, “List Office Codes
(listOfficeCodes)”)
3 The available vacant directory numbers of the office code can be retrieved using the listVAcantDirectoryNumbers method (Section
1.3.5.4, “List Vacant Directory Numbers (listVacantDirectoryNumbers)”)
4 The available list of call pickup groups can be retrieved using the listCallPickupGroups method (Section 1.3.8.11, “List the Call
Pickup Groups of a Business Group (listCallPickupGroups)”)
5 The available list of class of services can be retrieved using the listClassOfServices method (Section 1.3.7.2, “List Classes of
Service (listClassesOfService)”)
6 The available list of rate areas can be retrieved using the listRateAreas method (Section 1.3.7.1, “List Rate Areas (listRateAreas)”)
7 The available list of calling locations can be retrieved using the listCallingLocations method (Section 1.3.7.3, “List Calling Locations
(listCallingLocations)”)
8 The available list of department names can be retrieved using the listDepartmentsOfBusinessGroups method (Section 1.3.8.10,
“List the Departments of a Business Group (listDepartmentsOfBusinessGroup)”
9 Defined feature profiles can be retrieved using the listFeatureProfiles method (Section 1.3.10.2, “List all Feature
Profiles(listFeatureProfiles)”)
10 Available dls server id’s can be retrieved using the listDLS method (Section 1.3.11.1, “List DLS Servers (listDLS)”)
11 Available dls server names can be retrieved using the listDLS method (Section 1.3.11.1, “List DLS Servers (listDLS)”)

1.3.9.1 List Subscribers (listBusinessGroupSubscribers)

Please refer to Section 1.3.8.6, “List the Subscribers of a Business Group

(listBusinessGroupSubscribers)”.

A31003-H8050-M104-1-76A9, 09/2010
20 OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description
 HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 operations

1.3.9.2 List all Properties of a Subscriber (getSubscriber)

With getSubscriber(sessionToken, switchName, subscriber), the all

properties of a subscriber can be retrieved. ServiceID of the subscriber shall be
provided as the third parameter. A subscriber bean containing all the properties
is retrieved as return value.

1.3.9.3 List SIP details of the Subscribers

(listBusinessGroupSubscribersSip)

Please refer to Section 1.3.8.7, “List the SIP Subscribers of a Business Group
(listBusinessGroupSubscribersSip)”).

1.3.9.4 Create a Subscriber (CreateSubscriber)

For creating a subscriber, createSubscriber(sessionToken, switchName,

inputBean) method is used. The parameter inputBean point s to a valid
SubscriberBean.

Input bean expects at least values for the bean elements businessGroupName,
officeCode and extension. Existing office code and vacant directory number as
an extension should be provided. As service ID is composed of office code and
extension, it should not be assigned to any value during creation. It will be ignored
even if it is assigned to a value.

Available office codes can be retrieved by listOfficeCodes method. Vacant

directory numbers of the office code can be retrieved by
listVacantDirectoryNumbers method.

The display name and Business Group line name (i.e. subscriber name) fields are
automatically set to the user name, if they are left empty. The maximum length is
30 characters.

Existing call pickup group, class of service, routing area, calling location and
department should be provided. Available call pickup groups can be retrieved by
listCallPickupGroups method. Available classes of service can be retrieved by
listClassOfServices method. Available routing areas can be retrieved by
listRateAreas method. Available calling locations can be retrieved by
listCallingLocations method. Available departments can be retrieved by
listDepartments method.

Connection information (SIP) field can be SIP phone or profile only.

ConstantsConnectionInfo shall be used to set the value. Profile only means that
you create a subscriber who does not have a connection and the subscriber
cannot use Remote Call Forwarding (RCF). If connection information is SIP
phone, phone name is a mandatory field. It shall be unique and can have a
maximum length of 15 characters.

A31003-H8050-M104-1-76A9, 09/2010
OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description 21
HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 operations

The SIP registration type can be Dynamic or Static. ConstantsRegType shall be

used to set the value. Default value is dynamic registration. In static registration,
IP address and port shall be given.

The time zone is of the type ConstantsTimezone.

The keyset is of the type ConstantsKeysetUse.

1.3.9.5 Modify a Subscriber (modifySubscriber)

You can modify a subscriber using modifySubscriber(sessionToken,

switchName, inputBean). inputBean points to a valid SubscriberBean. You can
either create this bean from scratch or you can first retrieve a subscriber using
getSubscriber. For modifying a subscriber bean, you have to set at least service
ID, office code and business group name in the bean.

1.3.9.6 Delete Subscriber (deleteSubscriber)

To delete one subscriber, deleteSubscriber(sessionToken, switchName,

subscriber, businessGroupName) method is used. The subscriber parameter
expects valid subscriberID and the business group name parameter expects
correct business group name.

1.3.9.7 List Intercept Announcements

(listInterceptAnnouncements)

The intercept announcements can be listed using listInterceptAnnouncements

(sessionToken, switchName) method. This method retrieves a list of intercept
announcements.

1.3.10 Feature Profile-Related Commands

You can create, delete, modify, get and list feature profiles by using API. The
feature profile bean, named FeatureProfileBean, is used for create, modify and
get operations. Moreover, the list method returns list of feature profile beans.

Feature Profile Bean (FeatureProfileBean)

The fields of the susbscriber bean are the following:

A31003-H8050-M104-1-76A9, 09/2010
22 OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description
 HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 operations

Field Name Description Length Range Default Value

businessGroupNa The business group name. Character String Required
me Any existing
business group
name1.
featureProfileNam The name of the feature profile. 1..40 Character String Required
e Should be unique for
business group
fpDefault The flag for the feature profile True, False False
being default or not
listOfFeaturesBea The list of feature beans. It keeps List of valid features
n all services of the feature profile.
Details of the services are given
in the Features section.

Table 7 Fields of the subsrciber bean

1 Defined business groups can be retrieved using the listBusinessGroups method (Section 1.3.8.1, “List Business Groups
(listBusinessGroups)”)

1.3.10.1 Features

The features of the feature profile are described in this section.

Base Feature Bean - FeatureBean

Feature bean is the base class for the features of the feature profile. All features
extends this bean.

The following table lists the parameters of this base bean.

Field Name Description Length Range Default Value

featureName The name of the feature. Character String Required
featureSubscribed Subscribes/ unsubscribes the True, False False
service feature.
Features shall be subscribed before
configuring it.
featureActive Activate/ deactivates the feature. True, False False

Table 8 Parameters of base feature bean

Automatic Callback Feature - CfACBean

When a subscriber calls a number that is busy, this service enables the
subscriber to have the switch call the number back when the number becomes
available.

This feature shall be subscribed before setting other properties.

A31003-H8050-M104-1-76A9, 09/2010
OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description 23
HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 operations

The following table lists the input and output parameters associated with this
feature.

Field Name Description Length Range Default Value

ARSwitchControl The callback switch control. Ability Enum InterSwitch,
to call back subscribers across IntraSwitch,
switches or restrict call back to UseSwitchSetting
subscribers in that switch alone.

Table 9 Input and output parameters of automatic callback feature

Account Code Feature - CfAcctCodeBean

This feature allows the customer to add a special number sequence to the Call
Detail Record (CDR) for billing purposes.

Anonymous Caller Reject Feature - CfACRBean

This feature enables subscribers to forward callers who have restricted their
calling number presentation status to an anonymous denial announcement.

Automatic Recall Feature - CfARBean

This feature enables subscribers to enter an access code to redial the number of
the last incoming call.

The following table lists the input and output parameters associated with this
feature.

Field Name Description Length Range Default Value

ARSwitchControl The recall switch control. Ability to Enum InterSwitch,
recall subscribers across switches IntraSwitch,
or restrict call back to subscribers in UseSwitchSetting
that switch alone.

Table 10 Input and output paramters of the automatic recall feature

Authorization Code Feature - CfAuthCodeBean

This feature enables a subscriber to make certain external calls. It keeps

authorization code for CDR Report and authorization codes for off-net traffic
types.

The following table lists the input and output parameters associated with this
feature.

A31003-H8050-M104-1-76A9, 09/2010
24 OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description
 HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 operations

Field Name Description Length Range Default Value

authCodeCDRType The authorization code CDR type. Enum None, None
Specifies how Authorization Code is AccountCode,
to be saved in CDR records. It can AuthorizationCode,
be saved as an authorization code, Both
as an account code, as both
authorization code and account
code or can not be saved.
Authorization Codes for off-net Traffic Types
(The parameters in this section specifies which traffic types require Off-Net Authorization)
emergency Determines if emergency require True, False False
off-net authorization.
homeDirAssist Determines if home directory True, False False
assistance require off-net
authorization.
interLATA Determines if inter lata traffic type True, False False
require off-net authorization.
international Determines if international traffic True, False False
type require off-net authorization.
internationalZone1 Determines if international zone True, False False
traffic type require off-net
authorization.
intraLATA Determines if intra lata traffic type True, False False
require off-net authorization.
localDirAssist Determines if local directory True, False False
assistance require off-net
authorization
homeDirAssist Determines if home directory True, False False
assistance require off-net
authorization.
tollFree Determines if toll free traffic type True, False False
require off-net authorization.

Table 11 Input and output parameter of authorization code feature

Name Delivery Feature - CfBgCNAMBean

This feature enables to display the incoming caller’s name to the subscriber.

Call Pickup Group Feature - CfBgCPUBean

This feature enables the subscriber to be assigned to a call pickup group and then
to retrieve calls within that group.

A31003-H8050-M104-1-76A9, 09/2010
OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description 25
HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 operations

Outgoing CID Presentation Status Feature - CfBgDAPPSBean

This feature indicates the presentation status for caller ID services.

The following table lists the parameters associated with this feature.

Field Name Description Length Range Default Value

subPpsIntraBgCalls The presentation status Enum Public, Public
Private
Display order of callers within Business Group
callingIntraBGDisplay The first display order of Enum Business Group Name, Business Group
First callers within business group Subscriber Name, Name
Department Name
callingIntraBGDisplay The second display order of Enum Business Group Name, Business Group
Second callers within business group Subscriber Name, Name
Department Name
callingIntraBGDisplay The third display order of Enum Business Group Name, Business Group
Third callers within business group Subscriber Name, Name
Department Name
Display order of callers outside Business Group
callingNonIntraBGDis The first display order of Enum Business Group Name, Business Group
playFirst callers outside business Subscriber Name Name
group
callingNonIntraBGDis The second display order of Enum Business Group Name, Business Group
playSecond callers outside business Subscriber Name Name
group
Display order of connected parties within Business Group
connectedIntraBGDis The first display order of Enum Business Group Name, Business Group
playFirst connected parties within Subscriber Name, Name
business group Department Name
connectedIntraBGDis The second display order of Enum Business Group Name, Business Group
playSecond connected parties within Subscriber Name, Name
business group Department Name
connectedIntraBGDis The third display order of Enum Business Group Name, Business Group
playThird connected parties within Subscriber Name, Name
business group Department Name

Table 12 Parameters of outgoing CID presentation status feature

Outgoing CID Presentation Status Plus Feature - CfBgDNPPSBean

This feature indicates the default setting of the subscriber’s number (private or
public) when making calls.

The following table lists the parameters associated with this feature.

A31003-H8050-M104-1-76A9, 09/2010
26 OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description
 HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 operations

Field Name Description Length Range Default Value

subPpsIntraBgCalls The presentation status Enum Public, Public
Private

state The default presentation Enum Public, Private Public

status
externalCallerID The external caller ID to be Enum Public, Private Public
used for number caller ID
purposes for non-intra BG
calls.

Table 13 Parameters of outgoing CID presentation status plus feature

Call Forward Busy Feature - CfCCWBean

This service feature enables users to forward calls to another destination if the
original destination is busy. If a subscriber is subscribed to Call Forward Busy, it
cannot be subscribed to Voice Mail.

The following table lists the parameters associated with this feature.

Field Name Description Length Range Default Value

serviceId The redirect number. 30 Numeric String, Required when this
Any related subscriber’s feature is activated
service ID
subActivatable The method by which the Enum None ( subscriber cannot None
subscriber can activate/ activate or
deactivate this feature. deactivate this
feature)
Phone ( subscriber can activate
or deactivate this feature via the
phone)
Web( subscriber can activate or
deactivate this feature via the
Web).
All (subscriber can activate or
deactivate this feature via either
Web or Phone)

Table 14 Parameters of call forward busy feature

A31003-H8050-M104-1-76A9, 09/2010
OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description 27
HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 operations

Field Name Description Length Range Default Value

destServiceIdSubCon The method of specifying Enum None(Subscriber can not None
trollable redirect number by which the change the destination for this
subscriber can change the feature).
destination of Call Phone(subscriber can change
Forwarding. the destination for this feature
This field may only be set to via the Phone).
Phone only if SubActivatable Web(subscriber can change
is set to Phone or All as the the destination for this feature
subscriber can only change via the Web). All(subscriber
the destination when the can change the destination for
feature is activated. this feature via either the Web
or phone)
CFCourtesyCallBeha The courtesy call behavior Enum No Courtesy Call,
vior that occurs when a Required,
subscriber updates the Not Required
Destination ServiceId when
this feature is activated.
This field can be specified
only if
DestServiceIdSubControllabl
e is set to Phone or All, since
there are no courtesy calls
placed when the number is
set via the web.
notifySubCallFwdActi Enables timed reminder. If True, False False
ve set to True, the user is
reminded that call forwarding
is currently active.
CFNotifyCallingParty The notify calling party. Enum Notification (no announcement Notification
is played to the calling party).
Include calling
number(announcement with
the forwarding number is
played to the calling party).
Do not include calling number(
announcement that is played to
the calling party does not
include the forwarding number)
Table 14 Parameters of call forward busy feature

Call Forward No Reply Feature - CfCFDABean

This feature indicates the disposition of an incoming call to the subscriber when
the subscriber does not answer the call. The caller is redirected to the number
specified after the number of ring cycles specified (about 6 seconds per ring).

The following table lists parameters associated with this feature.

A31003-H8050-M104-1-76A9, 09/2010
28 OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description
 HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 operations

Field Name Description Length Range Default Value

serviceId The redirect number. 30 Numeric String, Required when this
Any related subscriber’s feature is activated
service ID
subActivatable The method by which the Enum None (subscriber cannot None
subscriber can activate/ activate or
deactivate this feature. deactivate this
feature)
Phone (subscriber can activate
or deactivate this feature via the
phone)
Web (subscriber can activate or
deactivate this feature via the
Web).
All (subscriber can activate or
deactivate this feature via either
Web or Phone)
destServiceIdSubCon The method of specifying Enum None (Subscriber can not None
trollable redirect number by which the change the destination for this
subscriber can change the feature).
destination of Call Phone (subscriber can change
Forwarding. the destination for this feature
This field may only be set to via the Phone).
Phone only if SubActivatable Web (subscriber can change
is set to Phone or All as the the destination for this feature
subscriber can only change via the Web).
the destination when the All (subscriber can change the
feature is activated. destination for this feature via
either the Web or phone)
ringDuration The duration for which the 0 to 60 sec
phone will ring before (if not
answered) the call will be
redirected.
CFCourtesyCallBeha The courtesy call behavior Enum No Courtesy Call,
vior that occurs when a Required,
subscriber updates the Not Required
Destination ServiceId when
this feature is activated.
This field can be specified
only if
DestServiceIdSubControllabl
e is set to Phone or All, since
there are no courtesy calls
placed when the number is
set via the web.
notifySubCallFwdActi Enables timed reminder. True, False False
ve If set to True, the user is
reminded that call forwarding
is currently active.

Table 15 Parameters of call forward no reply feature

A31003-H8050-M104-1-76A9, 09/2010
OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description 29
HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 operations

Field Name Description Length Range Default Value

CFNotifyCallingParty The notify calling party. Enum Notification(no announcement Notification
is played to the calling party).
Include calling number
(announcement with the
forwarding number is played to
the calling party).
Do not include calling number
(announcement that is played
to the calling party does not
include the forwarding
number).
Table 15 Parameters of call forward no reply feature

Call Forward Unconditional Feature - CfCFVBean

This service feature indicates the subscriber-specified disposition of an incoming

call to the subscriber. The caller is redirected to the number specified. If this
feature is enabled, the subscriber’s phone receives a courtesy ring when a call is
forwarded.

The following table lists the parameters associated with this feature.

Field Name Description Length Range Default Value

serviceId The redirect number. 30 Numeric String, Required when this
Any related subscriber’s feature is activated
service ID
subActivatable The method by which the Enum None (subscriber cannot None
subscriber can activate/ activate or
deactivate this feature. deactivate this
feature)
Phone (subscriber can activate
or deactivate this feature via the
phone)
Web (subscriber can activate or
deactivate this feature via the
Web).
All (subscriber can activate or
deactivate this feature via either
Web or Phone)

Table 16 Parameters of call forward unconditional feature

A31003-H8050-M104-1-76A9, 09/2010
30 OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description
 HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 operations

Field Name Description Length Range Default Value

destServiceIdSubCon The method of specifying Enum None (Subscriber can not None
trollable redirect number by which the change the destination for this
subscriber can change the feature).
destination of Call Phone (subscriber can change
Forwarding. the destination for this feature
This field may only be set to via the Phone).
Phone only if SubActivatable Web (subscriber can change
is set to Phone or All as the the destination for this feature
subscriber can only change via the Web).
the destination when the All (subscriber can change the
feature is activated. destination for this feature via
either the Web or phone).
CFCourtesyCallBeha The courtesy call behavior Enum No Courtesy Call,
vior that occurs when a Required,
subscriber updates the Not Required
Destination ServiceId when
this feature is activated.
This field can be specified
only if
DestServiceIdSubControllabl
e is set to Phone or All, since
there are no courtesy calls
placed when the number is
set via the web.
notifySubCallFwdActi Enables timed reminder. True, False False
ve If set to True, the user is
reminded that call forwarding
is currently active.
CFNotifyCallingParty The notify calling party. Enum Notification (no announcement Notification
is played to the calling party).
Include calling number
(announcement with the
forwarding number is played to
the calling party).
Do not include calling number
(announcement that is played
to the calling party does not
include the forwarding
number).
Table 16 Parameters of call forward unconditional feature

Call Hold Feature - CfCHLDBean

This feature enables the user to put a call in progress on hard hold by hook
flashing and dialing an access code. Only one call per station line can be held at
a time. The held call cannot be added to the other call. Dialing the call hold access
code a second time can retrieve the original connection. Hanging up results in the
held call re-calling the subscriber.

This feature is not valid for SIP endpoints.

A31003-H8050-M104-1-76A9, 09/2010
OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description 31
HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 operations

Outgoing CID Suppression Feature - CfCIDSBean

This feature indicates whether the subscriber can control the presentation of their
name and ID when making a call. Activation codes indicate whether to deliver or
suppress this information. Blocks or delivers both name and number.

Called Name Delivery Feature - CfCISNAMEBean

This feature indicates that when the subscriber originates a call, the name of the
called party is delivered to the originating phone for display.

This feature is set as subscribed by default and cannot be changed.

Called Name Delivery Feature - CfCISNAMEBean

This feature indicates that when the subscriber originates a call, the number of
the called party is delivered to the originating phone for display.

This feature is set as subscribed by default and cannot be changed.

Outgoing Name Delivery Blocking Feature - CfCNABBean

This feature enables the subscriber to use access codes on a per call basis to
toggle the calling number presentation status to the called party.

Outgoing Number Delivery Blocking Feature - CfCNDBBean

This feature enables the subscriber to use access codes on a per call basis to
toggle the calling name presentation status to the called party.

Caller ID Feature - CfCNDBean

This feature enables the subscriber to see the phone number of a caller.

This feature is set as subscribed by default and cannot be changed.

A31003-H8050-M104-1-76A9, 09/2010
32 OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description
 HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 operations

CSTA Feature - CfCSTABean

This feature enables a subscriber to use third-party call control that allows PC
applications to control calls to and from a co-located SIP Phone.

The following table lists the parameters associated with this feature

Field Name Description Length Range Default Value

cstaType The type of CSTA specifying Enum Normal, Normal
the capabilities of the Siemens Type 1,
endpoint. GCP Residential, MGCP
Business, Special 1,
Special 2,
Special 3,
Special 4,
Special 5

Table 17 Parameters of CSTA feature

Call Transfer Feature - CfCTBean

This feature enables the subscriber to transfer a call to a different phone.

The following table lists the parameters associated with this feature.

Field Name Description Length Range Default Value

transferCall Indicates whether the Enum All, All
subscriber can transfer all Internal Only
calls or only internal calls
(those from within a business
group).
recallTimer The amount of time to wait in 5 to 3600 sec 50
seconds before calling the
person who originated the
call.
applyRecallTo The type of calls for which Enum All, All
intercept timer will be applied. Internal DN,
External DN,
None
announcementTimer The amount of time for the 6 to 3600 sec 70
intercept to start.
announcementDestin The destination for the Any related subscriber’s
ation intercept. service ID
The destination DN must be
the same BG as the
transferring DN.

Table 18 Parameters of call transfer feature

A31003-H8050-M104-1-76A9, 09/2010
OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description 33
HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 operations

Field Name Description Length Range Default Value

applyAnnouncementT The type of calls for which Enum All, None
o intercept timer will be applied. Internal DN,
External DN,
None
Table 18 Parameters of call transfer feature

Distinctive Ringing for Waiting Calls Feature - CfDRCWBean

This feature provides a distinctive ringing tone when a caller calls the subscriber
and the calling number is listed in the Public or Private list.

Enhanced Anonymous Caller Reject Feature - CfEACRBean

This feature enables you to block calls from callers who have Caller ID blocking.
The subscriber does not have to have Caller ID to subscribe to this service. The
subscriber can choose whether the caller receives a denial announcement, is
routed to voice mail, or is routed to a Privacy Director. The Privacy Director asks
for the caller's name, calls the subscriber, speaks the name of the calling party,
and connects the callers based upon the subscriber decision.

The following table lists the parameters associated with this feature.

Field Name Description Length Range Default Value

subControlled Indicates whether the True, False False
subscriber can activate/
deactivate the feature.
billing The type of billing. Enum Flat Rate, Flat Rate
Usage-sensitive
EACRDest The call treatment a rejected Enum Play Denial Announcement, Play Denial
caller receives. Route to Voice Mail, Route to Announcement
Privacy Director
voiceMailDN The voice mail directory Character string
number.
If call treatment is Route to
Voice Mail,then voice mail dn
can be set. Also, If call
treatment is Route to Privacy
Director, Anonymous call
screener can be set to this
field.

Table 19 Parameters of enhanced anonymous caller reject feature

A31003-H8050-M104-1-76A9, 09/2010
34 OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description
 HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 operations

Call Forward Enhanced Feature - CfECFBean

This feature enables the subscriber to forward calls to another number on a

subscriber-controlled schedule.

When enabled, this service overrides Call Forward Variable, Call Forward Busy,
and Call Forward No Answer, depending on whether the service is active and the
type of forwarding selected for that period.

The following table lists the parameters associated with this feature.

Field Name Description Length Range Default Value

listOfScreenEntryBea The list of numbers to 32 entries; up to15 digits each
ns forward. List of numeric strings
ringDuration Duration that the phone will 0 to 60 sec 24
ring before (if not answered)
the call will be redirected to
the Voice
Mail server.
listOfCFECFEntryBea The list of schedules. Each entry represents a time
ns period for a specific day of the
week.
DayOfWeek The day of the week to which Enum Sunday, Sunday
the forwarding data defined in Monday,
this entry applies. Tuesday,
Wednesday,
Thursday,
Friday,
Saturday
Schedule The time schedule. It Start and stop time should be
contains start time and stop HH:MMAM/PM format and are
time. At start time the concetaned by "-". (for example
forwarding data defined in 06:00AM-07:00AM)
this entry applies and at stop
time the forwarding data
defined in this entry no longer
applies, in subscriber’s local
timezone.
CallFwdType The type of call forwarding Enum Always forward, Line is Busy, Always forward
performed for this entry. No Answer,
Busy No Answer
ScreeningList Option The value indicating which Enum All Numbers, Numbers on caller All Numbers
calls will be forwarded. list,
Numbers not on caller list.
ServiceId The destination number Number String
indicates the destination to
which calls are forwarded for
the time specified in this
entry.

Table 20 Parameters of call forward enhanced feature

A31003-H8050-M104-1-76A9, 09/2010
OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description 35
HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 operations

Hot Desking Feature - CfHotDeskBean

This feature enables a subscriber to log on and to use a telephone in a remote

office. The remote phone has all of the same features and capabilities at the
subscriber's home office telephone, except those provided by the telephone itself
and not the OpenScape Voice system.

The following table lists the parameters associated with this feature.

Field Name Description Length Range Default Value

hotDeskSide The type of hot desking side. Enum Remote, Home Base Remote

Table 21 Parameters of hot desking feature

Malicious Call Trace Feature - CfMCTBean

This service enables the subscriber to issue a Call Trace Report to the authorities
to report harassing calls.

Music On Hold Feature - CfMOHBean

This feature allows the subscriber to specify a music source to be played for any
held parties when they are placed on hold by the subscriber with the MOH
feature. The source of the music is specified by an intercept name.

One Number Feature - CfONSBean

This feature feature allows a subscriber to originate call using a device other than
the subscriber's primary business telephone, while keeping the functions and
features of their business telephone.

Remote Activation Feature - CfRACFBean

This feature enables the subscriber to change the CFV data from a remote
phone.

Selective Caller Acceptance Feature - CfSCABean

This feature enables the subscriber to restrict incoming callers to an unshared list.
Callers who are not on the list are forwarded to another number or hear a denial
announcement.The caller can then enter a PIN and reach the subscriber. The PIN
is available only when the denial is announced.

A31003-H8050-M104-1-76A9, 09/2010
36 OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description
 HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 operations

The following table lists the parameters associated with this feature.

Field Name Description Length Range Default Value

billing The billing type. Enum Flat Rate, Flat Rate
Usage-Sensitive
pin The personal identification 10 Character String
number, a caller can use to
be placed through to the
subscriber even though they
are calling from a phone that
is not on the screening list.
This service cannot be used
unless PIN is configured.
scaTerminationTreat The type of rejected calls, Enum Redirect, Redirect
ment which is indicating whether a Play Denial Announcement
denial announcement is to be
played or the call is to be
redirected to another
number. If the call is to be
redirected, enter the phone
number to which the call is to
be redirected in the field.
serviceId The service id of the Numeric String
subscriber to which the call is
to be redirected.
listOfScreenEntryBea The list of numbers to 32 entries; up List of numeric strings
ns forward. to15 digits
each

Table 22 Parameters of selective caller acceptance feature

Selective Call Forwarding Feature - CfSCFBean

This service enables the subscriber to forward calls from callers who are on a
subscriber-controlled list.

The following table lists the parameters associated with this feature.

Field Name Description Length Range Default Value

serviceId The redirect number, which is Any related subscriber’s
the destination number to service ID
which calls are forward when
callers are found to be in the
screening list.
screenListBean The list of numbers to 32 entries; up List of numeric strings
forward. to15 digits
each

Table 23 Parameters of selective call forwardinf feature

A31003-H8050-M104-1-76A9, 09/2010
OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description 37
HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 operations

Selective Caller Reject Feature - CfSCRBean

This feature enables the subscriber to restrict incoming callers. Callers on a

subscriber-controlled list hear a denial announcement.

Field Name Description Length Range Default Value

billing The billing type. Enum Flat Rate, Flat Rate
Usage-Sensitive
subControlled Indicates whether the True, False False
subscriber can activate/
deactivate this feature.
listOfScreenEntryBea The list of selective caller 32 entries; up List of numeric strings
ns acceptance member. to15 digits
each

Table 24 Parameters of selective caller reject feature

Serial Ringing Feature - CfSERRNGBean

This feature enables the subscriber to configure a list of DNs to be called if the
primary DN does not respond within the specified "duration". The numbers are
then dialed sequentially from the list if their status reflects "enabled".
Furthermore, the duration for which these lines are dialed is also configured
through a Duration parameter.

Field Name Description Length Range Default Value

ringDuration The period of time the 0 to 60 Flat Rate, Flat Rate
primary phone rings before seconds Usage-Sensitive
the DNs in the list are dialed.
listOfSerialDNEntryB A list of up to six entries, each with the attributes listed below.
eans
serviceID A subscriber’s service ID to Numeric String
be rung serially.
duration Period of time this entry’s integer 1 to 120
phone rings before the next
DN in the list is dialed.
ring Indicates that the DN is a True, False False
ring.

Table 25 Parameters of serial ringing feature

Speed Calling Feature - CfSPCALLBean

This feature enables subscribers to store frequently called numbers in the

telephone and then program one or two digits to call that number when pressed.

A31003-H8050-M104-1-76A9, 09/2010
38 OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description
 HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 operations

Field Name Description Length Range Default Value

billing The billing type. Enum Flat Rate, Flat Rate
Usage-Sensitive
subControlled Indicates whether the True, False False
subscriber can activate/
deactivate this feature.
oneDigit Indicates whether the 0 for No List, 0
subscriber has its own list or 1 for Custom List,
shares the list from another subscriber’s service ID for
entity. This field may also Shared List
contain the literal subscriber
to indicate that the list is
shared from the Business
Group.
twoDigit Indicates whether the 0 for No List, 0
subscriber has its own list or 1 for Custom List,
shares the list from another subscriber’s service ID for
entity. This field may also Shared List
contain the literal subscriber
to indicate that the list is
shared from the Business
Group.
oneSPCALLList The list of one-digit calling numbers with below attributes.
SPCALLNum The one-digit control Enum 2 to 9
numbers.
serviceId The subscriber for which Number String
speed call assigned.
twoSPCALLList The list of two-digit calling numbers with below attributes.
SPCALLNum The two-digit control Enum 20 to 49
numbers.
serviceId The subscriber for which Number String
speed call assigned.

Table 26 Parameters of speed calling feature

Line Restriction Feature - CfSRBean

This feature enables a BG Administrator to impose restriction levels for calls that
originate from or terminate at a subscriber.

The following table lists the parameters associated with this feature.

A31003-H8050-M104-1-76A9, 09/2010
OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description 39
HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 operations

Field Name Description Length Range Default Value

originatingSR The restriction level for calls Enum No Restriction, No Restriction
the subscriber originates. Semi-Restricted Line, Fully
Restricted Line, Fully
Restricted Line with Attendant
Access.
terminatingSR The restriction level for calls Enum No Restriction, No Restriction
terminating to the subscriber. Semi-Restricted Line, Fully
Restricted Line, Fully
Restricted Line with Attendant
Access.

Table 27 Parameters of line restriction feature

Simultaneous Ringing Feature - CfSRSBean

This feature enables a subscriber to create a list of six subscribers that will ring
simultaneously when the main DN receives an incoming call and is not busy. The
call can be answered at the BG main number or any of the other subscribers in
the list.

The following table lists the parameters associated with this feature.

Field Name Description Length Range Default Value

listOfDNRingEntryBe The simultaneous ringing list that can contain up to six entries.
ans
serviceID A DN to be simultaneously Number String
rung.
extension Indicates that the DN is an True, False False
extension, or intercom dialing
code (True). If False, the
number is not an extension,
but a fully qualified national
numbering plan formatted
number.

Table 28 Parameters of simultaneous ringing feature

Toll and Call restrictions Feature - CfTRSBean

This feature indicates the type of calling restrictions that are active.

The following table lists the parameters associated with this feature.

A31003-H8050-M104-1-76A9, 09/2010
40 OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description
 HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 operations

Field Name Description Length Range Default Value

blkDomLongDist The restriction for domestic True, False False
long distance calls of the
subscriber
blkIntLongDist The restriction for True, False False
international long distance
calls of the subscriber
blkOperAssist The restriction for operator True, False False
assisted domestic long
distance calls of the
subscriber.
blkOperRequest The restriction for operator True, False False
calls of the subscriber.
blkIntOperAssist The restriction for operator True, False False
assisted international long
distance calls of the
subscriber.
blkLocalDirAssist The restriction for local True, False False
directory assistance calls of
the subscriber.
restrictedLineList The toll and call restrictions List of Numeric String
list. The subscriber cannot
make calls to the numbers in
this list. The list may contain
partial numbers, such as 212,
that prevent the caller from
calling any number that starts
with 212. Individual entries in
this list cannot be edited. The
list must be completely
specified.

Table 29 Parameters toll and call restriction feature

Usage Sensitive Call Forward Variable Feature - CfUSCFVBean

This feature indicates the subscriber controllable disposition of an incoming call

to the subscriber. The caller is redirected to the number specified. If this feature
is enabled, the subscriber’s phone receives a "courtesy" ring when a call is
forwarded. This feature is similar to the Call Forwarding Unconditional (CFV)
feature except that the billing of the feature depends on usage, rather than a flat
rate charge.

The following table lists the parameters associated with this feature.

A31003-H8050-M104-1-76A9, 09/2010
OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description 41
HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 operations

Field Name Description Length Range Default Value

serviceId The redirect number. 30 Numeric String, Required when this
Any related subscriber’s feature is activated
service ID
subActivatable The method by which the Enum None (subscriber cannot None
subscriber can activate/ activate or
deactivate this feature. deactivate this
feature)
Phone (subscriber can activate
or deactivate this feature via the
phone)
Web (subscriber can activate or
deactivate this feature via the
Web).
All (subscriber can activate or
deactivate this feature via either
Web or Phone)
destServiceIdSubCon The method of specifying Enum None (Subscriber can not None
trollable redirect number by which the change the destination for this
subscriber can change the feature).
destination of Call Phone (subscriber can change
Forwarding. the destination for this feature
This field may only be set to via the Phone).
Phone only if SubActivatable Web (subscriber can change
is set to Phone or All as the the destination for this feature
subscriber can only change via the Web).
the destination when the All (subscriber can change the
feature is activated. destination for this feature via
either the Web or phone)
CFCourtesyCallBeha The courtesy call behavior Enum No Courtesy Call, No Courtesy Call
vior that occurs when a Required,
subscriber updates the Not Required
Destination ServiceId when
this feature is activated.
This field can be specified
only if
DestServiceIdSubControllabl
e is set to Phone or All, since
there are no courtesy calls
placed when the number is
set via the web.

Table 30 Parameters of usage sensitive call forward variable feature

Voice Mail Feature - CfCFVBean

This feature forwards calls to a voice mail box if the phone is busy or there is no
answer. This service cannot be subscribed if either Call Forward Busy or Call
Forward No Answer features have been already subscribed.

The following table lists the parameters associated with this feature.

A31003-H8050-M104-1-76A9, 09/2010
42 OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description
 HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 operations

Field Name Description Length Range Default Value

serviceId The voice mail destination 30 Numeric String, Required when this
number. Any related subscriber’s feature is activated
service ID
ringDuration Indicates the duration that Integer 0 to 60 sec
the phone will ring before (if
not answered) the call will be
redirected to the Voice Mail
server.

Table 31 Parameters of voice mail feature

1.3.10.2 List all Feature Profiles(listFeatureProfiles)

You can list all Feature Profiles via listFeatureProfiles(sessionToken,

switchName, businessGroupName, fpListType).

The fpListType field is enumerated field. It describes the type of list, depending
on the switch-wide or business group specific feature profiles. It is enumerated
value and can be set as FP_LIST_TYPE_ALL,
FP_LIST_TYPE_SYSTEM_ONLY, FP_LIST_TYPE_BG_UNION_SYSTEM or
FP_LIST_TYPE_BG_ONLY values of the ConstantFpType class;

• To list all feature profiles, use FP_LIST_TYPE_ALL value.

• To list only switch-wide feature profiles, use

FP_LIST_TYPE_SYSTEM_ONLY.

• To list feature profiles of the specific business group with switch-wide feature
profiles together, use FP_LIST_TYPE_ BG_UNION_SYSTEM and set
business group name.

• To list feature profiles of the specific business group, use

FP_LIST_TYPE_BG_ONLY and set business group name.

Do not pass a business group as an argument to list all the feature profiles and
only switch-wide feature profiles.

1.3.10.3 List all properties of a Feature Profile

(getFeatureProfile)

With getFeatureProfile(sessionToken, switchName, featureProfileName,

businessGroupName), you can list all properties of a Feature Profile. You will
get a bean as return value which contains all the properties.

A31003-H8050-M104-1-76A9, 09/2010
OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description 43
HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 operations

1.3.10.4 Create Feature Profile (createFeatureProfile)

With createFeatureProfile(sessionToken, switchName, inputBean) method,

you can create both switch-wide feature profile, i.e. global feature profile and
feature profile for a specific business group. The input bean points to a valid
feature profile bean.

When creating feature profile for a specific business group, inputBean expects at
least values for the bean elements businessGroupName and
featureProfileName. In other case, when creating global feature profile, at least
feature profile name shall be set to the input bean. The services can be specified
during creation or they can be set later with modify operation.

Multiple Feature Profiles for the specific business group and switch-wide can be
created.

1.3.10.5 Modify a Feature Profile (modifyFeatureProfile)

You can modify a Feature Profile using modifyFeatureProfile(sessionToken,

switchName, inputBean). inputBean points a valid Feature Profile bean. You
can either create this bean from scratch or you can first retrieve a Feature Profile
using getFeatureProfile. For creating a Feature Profile (FP) bean, you have to set
at least businessGroupName and featureProfileName in the bean.

1.3.10.6 Delete a Feature Profile (deleteFeatureProfile)

You can delete a feature profile with deleteFeatureProfile(sessionToken,

switchName, featureProfileName, businessGroupName) method. The
method expects a valid feature profile name and business group name.

1.3.11 DLS-Related Commands

1.3.11.1 List DLS Servers (listDLS)

With listDLS(sessionToken) method, a list of all available DLS servers can be

displayed to the user. This list contains several pieces of information, including
DLS Server Name, DLS ID, DLS Status and Version, DLS URL, API URL and
DLS Client Session ID.

A31003-H8050-M104-1-76A9, 09/2010
44 OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description
 HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 operations

1.3.12 Switch-Related Commands

1.3.12.1 List Switches (listSwitch)

listSwitch(java.lang.String sessionToken) which returns a ListSwitchResult

containing an array of SwitchDTO. The method helps as an entry point to get a
switch name to pass to subsequent operations, and for standalone usage, to get
switch-related information.

1.3.12.2 List Used and Total Licenses (listLicenses)

listLicenses(String sessionToken, String switchName) returns the used and

total number of licenses available for a given switch name.

1.3.12.3 Retrieve the Operation Mode of a Switch

(getOperationMode)

Returns the operation mode of 'own' and 'partner' nodes as seen by the two
nodes of the switch.

The operation mode can have the following values:

Operation Mode Description

Values
Normal The switch is simplex or duplex with both nodes active in a
cluster, or duplex with one node out of service.
StandAlone, The two nodes of the switch cannot communicate with each
StandAlonePrim other, but both stay active on their own in switch-over mode.
ary,
StandAloneSec
ondary
ShuttingDown, Cluster communication is possible again, one of the nodes is
StandAoneSync sending data to the partner and is going to reboot afterwards.
h
Unknown This is the status of the partner node, in case there is no x-
channel. So each node shows one of the modes defined
above for itself and 'unknown' for the partner.
Table 32 Operation Modes of a Switch

A31003-H8050-M104-1-76A9, 09/2010
OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description 45
HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 operations

1.3.13 OpenScape Branch-Related Commands

1.3.13.1 List Available OpenScape Branch Offices

(listOpenBranches)

To get all available OpenScape Branch Offices, listOpenBranches(String

sessionToken) method is used. A list of Branch Offices of type BranchOfficeDTO
is retrieved. Each BranchOfficeDTO may contain:
branchOfficeName, branchOfficeRepEndpointName,
branchOfficeRepEndpointIp, businessGroupName, listOfUsers, switchId,
soapUrl, hiPath8000Name, hiPath8000IpAddress, userId, userPassword and
description.

1.3.14 Scenarios

1.3.14.1 Create a Business Group

For creating a Business Group you must have at least an Office Code and
Directory Numbers to be associated to the new group. Therefore the sequence
for creating a new Business Group is:

openSession(username, password) Section 1.3.2.1

createOfficeCode(sessionToken, switchName, inputBean) Section 1.3.4.2
createDirectoryNumbers(sessionToken, switchName, officeCode,startExtension, Section 1.3.5.2
endExtension)
createBusinessGroup(sessionToken, switchName, inputBean) Section 1.3.8.2
closeSession(sessionToken, switchName) Section 1.3.2.2

1.3.14.2 Create a Subscriber

For creating a Subscriber you must have at least his/her name, a valid and free
subscriber ID and the business group the new subscriber is associated to.
Therefore the sequence for creating a new Subscriber is the following.

in case of vacant extensions available:

openSession(username, password) Section 1.3.2.1

listVacantDirectoryNumbers(sessionToken, switchName, officeCode) Section 1.3.5.4
createSubscriber(sessionToken, switchName, inputBean) Section 1.3.9.4
closeSession(sessionToken, switchName) Section 1.3.2.2

in case of all extensions used:

A31003-H8050-M104-1-76A9, 09/2010
46 OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description
 HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 operations

openSession(username, password) Section 1.3.2.1

createDirectoryNumbers(sessionToken, switchName, officeCode, startExtension, Section 1.3.5.2
endExtension)
createSubscriber(sessionToken, switchName, inputBean) Section 1.3.9.4
closeSession(sessionToken, switchName) Section 1.3.2.2

1.3.14.3 Modify the Display Name of a Subscriber

For modifying a Subscriber you must have a valid subscriber ID of the Subscriber.
Therefore the sequence for modifying a Subscriber is:

openSession(username, password) Section 1.3.2.1

modifySubscriber(sessionToken, switchName, inputBean) Section 1.3.9.5
closeSession(sessionToken, switchName) Section 1.3.2.2

in case Subscriber is retrieved before modification

openSession(username, password) Section 1.3.2.1

getSubscriber(sessionToken, switchName, inputBean) Section 1.3.9.2
modifySubscriber(sessionToken, switchName, inputBean) Section 1.3.9.5
closeSession(sessionToken, switchName) Section 1.3.2.2

A31003-H8050-M104-1-76A9, 09/2010
OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description 47
HP8000AssistantAPI_intro.fm
Introduction
The OpenScape Voice V5 operations

A31003-H8050-M104-1-76A9, 09/2010
48 OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description
 HP8000AssistantAPI_usingJava.fm
Using the OpenScape Voice V5 with Java
Requirements

2 Using the OpenScape Voice V5 with Java

2.1 Requirements
For accessing the OpenScape Voice V5 with a Java program there are some
requirements to comply with.

First of all you need a Java compiler and a runtime environment where your Java
implementation can be used. For implementing web services you also need a
web server. For our examples we used Sun’s Java JDK and RTE version 5.0 and
Apache’s Tomcat web server version 5.5.

For using the SOAP protocol and accessing WSDL files we used Apache Axis
and JAX APIs. To understand the example programs you should be familiar with
web services and the mentioned components. All necessary libraries are included
in the Axis package and have to be added to every web services project. The files
are:

• axis.jar the Axis core library

• axis-ant.jar definition of axis ant tasks
• commons-discovery.jar Jakarta Discovery Framework
• commons-logging.jar Jakarta Logging Framework
• jaxrpc.jar JAX-RPC core API
• log4j-1.28.jar Log4J components used by Axis
• saaj.jar API for SOAP handling
• wsdl4j.jar API for WSDL handling

2.2 Analyzing the OpenScape Voice V5 WSDL file with Java

2.2.1 Preparing the WSDL Analysis

Java has an API for representing WSDL documents in Java, called as JWSDL.
JWSDL is designed to allow users to read, modify, create and re-organize WSDL
documents in memory.

You can use WSDLFactory, WSDLReader, WSDLWriter classes to manipulate

WSDL files.

First, obtain a WSDLFactory instance via the static newInstance method of

WSDLFactory.
WSDLFactory factory = WSDLFactory.newInstance();

A31003-H8050-M104-1-76A9, 09/2010
OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description 49
HP8000AssistantAPI_usingJava.fm
Using the OpenScape Voice V5 with Java
Analyzing the OpenScape Voice V5 WSDL file with Java

Once a WSDLFactory instance is obtained, newDefinition,

newWSDLReader,newWSDLWriter methods can be invoked to create the
desired object.

The following is an example of how to create a WSDLReader to construct a

Definition that represents the WSDL file of DSA API.

WSDLReader reader = factory.newWSDLReader();

Definition definition = reader.readWSDL(null, "https://<yourHiPath8000>/
HiPath8000AssistantAPIv310/services/
HiPath8000AssistantAPI");

2.2.2 Showing available operations

To see what the operations defined for a particular service, we have to navigate
Definition. Before navigating, you need an instance of Definition as explained in
Section 2.2, “Analyzing the OpenScape Voice V5 WSDL file with Java”. Then you
can perform navigation.

String tns = "urn:hipath8000-assistant-api-v310";

Service service = def.getService(new QName(tns,
"HiPath8000AssistantAPIService"));
Port port = service.getPort("HiPath8000AssistantAPI")
Binding binding = port.getBinding();
PortType portType = binding.getPortType();
List operations = portType.getOperations()
Iterator opIterator = operations.iterator()
while (opIterator.hasNext()){
Operation operation =(Operation)opIterator.next();
if (!operation.isUndefined()){
System.out.println(operation.getName());
}
}

When you run the above code segment appropriately, you will see the available
operations as the following;
openSession
closeSession
createOfficeCode
deleteOfficeCode
createFeatureProfile
getFeatureProfile
getBusinessGroup
...

A31003-H8050-M104-1-76A9, 09/2010
50 OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description
 HP8000AssistantAPI_usingJava.fm
Using the OpenScape Voice V5 with Java
Analyzing the OpenScape Voice V5 WSDL file with Java

2.2.3 Showing operational parameters

To display the parameters of the operations, you should analyze the Operation
class instance obtained in the previous Section 2.2.2, “Showing available
operations”. getInput() , getOutput() and getParameterOrdering() methods of the
a particular operation will help you to display these parameters as the following;
if (!operation.isUndefined()){
System.out.print(operation.getName());
System.out.println(operation.getParameterOrdering());
System.out.println(operation.getInput());
System.out.println(operation.getOutput());
}
When you run this code for the operations, you will see the results like below;
openSession[username, password]
Input: name=openSessionRequest
Message: name={urn:hipath8000-assistant-api-
v310}openSessionRequest
Part: name=password
typeName={http://www.w3.org/2001/XMLSchema}string
Part: name=username
typeName={http://www.w3.org/2001/XMLSchema}string
Output: name=openSessionResponse
Message: name={urn:hipath8000-assistant-api-
v310}openSessionResponse
Part: name=openSessionReturn
typeName={http://www.w3.org/2001/XMLSchema}string

createOfficeCode[sessionToken, switchName, inputBean]

Input: name=createOfficeCodeRequest
Message: name={urn:hipath8000-assistant-api-
v310}createOfficeCodeRequest
Part: name=sessionToken
typeName={http://www.w3.org/2001/XMLSchema}string
Part: name=switchName
typeName={http://www.w3.org/2001/XMLSchema}string
Part: name=inputBean
typeName={urn:hipath8000-assistant-api-v310}OfficeCodeBean
Output: name=createOfficeCodeResponse
Message: name={urn:hipath8000-assistant-api-
v310}createOfficeCodeResponse
Part: name=createOfficeCodeReturn
typeName={urn:hipath8000-assistant-api-v310}ResultStatus

A31003-H8050-M104-1-76A9, 09/2010
OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description 51
HP8000AssistantAPI_usingJava.fm
Using the OpenScape Voice V5 with Java
Sending commands to the OpenScape Voice with Java

2.3 Sending commands to the OpenScape Voice with Java

2.3.1 A simple client

To use the client functionality of Axis you have to expand your class path with the
appropriate jar files provided by Axis. For accessing a web service a client needs

• an instance of the Axis classes Service and Call

Service service = new Service();

Call call = (Call) service.createCall();

• the URL of the web service, called endpoint

String endpoint = "https://<yourHiPath8000>/
HiPath8000AssistantAPIv310/services/HiPath8000AssistantAPI";
• and optional information about data types of the used parameters and
returned values.

Because our first example does not use any parameter we can start to set the
endpoint for the Call object, define which web service operation has to be called
and execute the call via invoke.
call.setTargetEndpointAddress( new java.net.URL(endpoint));
call.setOperationName("getApiServerVersion");
String ret = (String) call.invoke( new Object[] {});
The invoke method expects an array of objects but as the called operation does
not have any parameters the array is empty. The return value of
getApiServerVersion is a string and can be displayed immediately. This is the
whole program:

import org.apache.axis.client.Call;
import org.apache.axis.client.Service;

public class simpleClient {

public static void main(String[] args) {

try {
String endpoint = "https://<yourHiPath8000>/
HiPath8000AssistantAPIv310/services/HiPath8000AssistantAPI";
Service service = new Service();
Call call = (Call) service.createCall();
call.setTargetEndpointAddress( new java.net.URL(endpoint));
call.setOperationName("getApiServerVersion");

A31003-H8050-M104-1-76A9, 09/2010
52 OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description
 HP8000AssistantAPI_usingJava.fm
Using the OpenScape Voice V5 with Java
Sending commands to the OpenScape Voice with Java

String ret = (String) call.invoke( new Object[] {});

System.out.println("API version: " + ret);
}
catch (Exception e) {
System.err.println(e.toString());
}
}
}

2.3.2 A complex client

For accessing different operations of the web service, implementing complex
workflow scenarios or using operations with a huge amount of parameters or
return values it is very useful to work with classes representing the available
operations and their in and out parameters. For our examples we chose the static
way in using a set of stub classes.

These classes are generated by the Axis tool WSDL2Java with the command
java org.apache.axis.wsdl.WSDL2Java https://
<yourServer>:<yourPort>/HiPath8000AssistantAPIv310/services/
HiPath8000AssistantAPI?wsdl
With the factory class HiPath8000AssistantAPIServiceLocator you can get a port
which implements the HiPath8000AssistantAPI interface.
port = (HiPath8000AssistantAPI)
new HiPath8000AssistantAPIServiceLocator().
getHiPath8000AssistantAPI(https://<yourServer>:<yourPort>/
/HiPath8000AssistantAPIv310/services/
HiPath8000AssistantAPI);
This port can be used to call all the operations provided by the OpenScape Voice
V5 as e.g. retrieving the API version
String serverVersion = port.getApiServerVersion();
The whole program looks like:

import java.net.MalformedURLException;
import java.net.URL;
import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import hipath8000_assistant_api_v310.*;

public class complexClient_V1 {

example 32-1 Example 2: complexClient_V1.java

A31003-H8050-M104-1-76A9, 09/2010
OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description 53
HP8000AssistantAPI_usingJava.fm
Using the OpenScape Voice V5 with Java
Sending commands to the OpenScape Voice with Java

public static void main(String[] args) {

HiPath8000AssistantAPI port = null;

try {
URL url=new URL("https://<yourServer>:<yourPort>/
HiPath8000AssistantAPIv310/services/
HiPath8000AssistantAPI");
port = (HiPath8000AssistantAPI)
new HiPath8000AssistantAPIServiceLocator().
getHiPath8000AssistantAPI(url);
String serverVersion = port.getApiServerVersion();
System.out.println("Api server version: " + serverVersion);
}
catch (ServiceException e) {
e.printStackTrace();
}
catch (MalformedURLException e) {
e.printStackTrace();
}
catch (RemoteException e) {
e.printStackTrace();
}
}
}
example 32-1 Example 2: complexClient_V1.java

Instead of only showing the used API version we now want to change a
subscriber’s display name.

Because the subscriber-related operations can be used by authorized users only,

you have to request a session token via openSession() before sending the
request and after completing all tasks you should finish the session by closing it.
So you have to wrap all operations with a session handling. Session token
methods are called same as other methods;
String sessionToken = port.openSession(“myUser”,
“myUsersPassword”); port.closeSession(sessionToken);
As stated in Section 1.3.8.6, “List the Subscribers of a Business Group
(listBusinessGroupSubscribers)”, you can either create the input bean from
scratch or retrieve related subscriber using getSubscriber method.

A31003-H8050-M104-1-76A9, 09/2010
54 OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description
 HP8000AssistantAPI_usingJava.fm
Using the OpenScape Voice V5 with Java
Sending commands to the OpenScape Voice with Java

GetSubscriberResult res =
port.getSubscriber(sessionToken,switchName,serviceId)
;
SubscriberBean subscriber= result.getSubscriberBean();
subscriber.setDisplayName("newDisplayName");
port.modifySubscriber(sessionToken,switchName,subscriber);
Here you can see the complete code;

import java.net.MalformedURLException;
import java.net.URL;
import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import hipath8000_assistant_api_v310.*;

public class complexClient_V2 {

public static void main(String[] args) {

HiPath8000AssistantAPI port = null;

String sessionToken=””;
String serviceId="";
GetSubscriberResult result=null;
try {
URL url=new URL("https://<yourServer>:<yourPort>/
HiPath8000AssistantAPIv310/services/
HiPath8000AssistantAPI");
port = (HiPath8000AssistantAPI)
new HiPath8000AssistantAPIServiceLocator().
getHiPath8000AssistantAPI(url);
sessionToken = port.openSession(“myUser”, “myUsersPassword”)
result = port.getSubscriber(sessionToken, switchName, serviceId)
SubscriberBean subscriber=result.getSubscriberBean();
subscriber.setDisplayName("newDisplayName");
port.modifySubscriber(sessionToken,switchName,subscriber);
port.closeSession(sessionToken);
};
catch (ServiceException e) {
e.printStackTrace();
}
catch (MalformedURLException e) {
Table 33 Example 3: complexClient_V2.java

A31003-H8050-M104-1-76A9, 09/2010
OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description 55
HP8000AssistantAPI_usingJava.fm
Using the OpenScape Voice V5 with Java
Secure Access to OpenScape Voice V5

e.printStackTrace();
}
catch (RemoteException e) {
e.printStackTrace();
}
}
}
Table 33 Example 3: complexClient_V2.java

2.4 Secure Access to OpenScape Voice V5

The OpenScape Voice V5 can be accessed by https protocol as well. The
OpenScape Voice V5 WSDL file can be found and viewed at the URL.
https://<yourHiPath8000>:<yourPort>/
HiPath8000AssistantAPIv310/services/
HiPath8000AssistantAPI?wsdl
Also, all available operations can be displayed at the URL
https://<yourHiPath8000>:<yourPort>/
HiPath8000AssistantAPIv310/services
To be able to connect API, you should set some system properties after you
created valid keystore and truststore files for your server and client. Additionally,
you should put the server keystore files under tomcat conf directory and client
files under a specific directory. For detailed information about keystores, please
see http://java.sun.com/docs/books/tutorial/security1.2/index.html.
System.setProperty("javax.net.ssl.trustStore",
<yourTrustStorePath>);
System.setProperty("javax.net.ssl.trustStorePassword",
<yourTrustStorePassword>);
System.setProperty("javax.net.ssl.keyStore",
<yourKeyStorePath>);
System.setProperty("javax.net.ssl.keyStorePassword",
<yourKeyStorePassword>);
Afterwards, you can call openSession method to open a session.

The whole program looks like:

import java.net.MalformedURLException;
import java.net.URL;
import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
Table 34 Example 2: secureConnectClient_V1.java

A31003-H8050-M104-1-76A9, 09/2010
56 OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description
 HP8000AssistantAPI_usingJava.fm
Using the OpenScape Voice V5 with Java
Secure Access to OpenScape Voice V5

import hipath8000_assistant_api_v310.*;

public class secureConnectClient_V1 {

public static void main(String[] args) {

HiPath8000AssistantAPI port = null;

try {
System.setProperty("javax.net.ssl.trustStore", <yourTrustStorePath>);
System.setProperty("javax.net.ssl.trustStorePassword",
<yourTrustStorePassword>);
System.setProperty("javax.net.ssl.keyStore", <yourKeyStorePath>);
System.setProperty("javax.net.ssl.keyStorePassword",
<yourKeyStorePassword>);
URL url=new URL("https://<yourServer>:<yourPort>/
HiPath8000AssistantAPIv310/services/
HiPath8000AssistantAPI");
port = (HiPath8000AssistantAPI)
new HiPath8000AssistantAPIServiceLocator().
getHiPath8000AssistantAPI(url);
sessionToken = port.openSession(“myUser”, “myUsersPassword”)
catch (ServiceException e) {
e.printStackTrace();
}
catch (MalformedURLException e) {
e.printStackTrace();
}
catch (RemoteException e) {
e.printStackTrace();
}
}
}
Table 34 Example 2: secureConnectClient_V1.java

A31003-H8050-M104-1-76A9, 09/2010
OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description 57
HP8000AssistantAPI_usingJava.fm
Using the OpenScape Voice V5 with Java
Secure Access to OpenScape Voice V5

A31003-H8050-M104-1-76A9, 09/2010
58 OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description
 HP8000AssistantAPI_usingPHP.fm
Using the OpenScape Voice V5 with PHP
Requirements

3 Using the OpenScape Voice V5 with PHP

3.1 Requirements
For accessing the OpenScape Voice V5 with a PHP (Hypertext Preprocessor)
script there are some requirements to comply with.

First of all you need a PHP implementation and an environment where this PHP
implementation can be used. The most common package is the XAMPP
distribution, which we used to develop our PHP examples.

As PHP does not support the SOAP protocol and WSDL files directly, you need
an appropriate add-on. We have tested the NuSOAP open source package (also
written in PHP) and it works fine for this purpose. There may be other packages
available which are not evaluated yet.

To become familiar with this package read the tutorial ’Introduction to NuSOAP’.

3.2 Analyzing the OpenScape Voice V5 WSDL file with PHP

3.2.1 Preparing the WSDL analysis

In order to use the NuSOAP package we copied the nusoap.php file into the same
directory where our test scripts are. If you use another directory you have to adapt
the require statement or use an appropriate include path for your PHP
environment.
require_once('nusoap.php');
Create a new instance of the wsdl class, the sole parameter indicates the URL of
your WSDL file:

$wsdl = new wsdl('https://<yourServer>:<yourPort>/'.

'HiPath8000AssistantAPIv<version>/services/'.
'HiPath8000AssistantAPI?wsdl');
// change <yourServer> to your server’s name or IP address
// change <version> to the current used API version (e.g. 310)

If that action fails you will receive an error message:

$err = $wsdl->getError();
if ($err) {
// Display the error

A31003-H8050-M104-1-76A9, 09/2010
OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description 59
HP8000AssistantAPI_usingPHP.fm
Using the OpenScape Voice V5 with PHP
Analyzing the OpenScape Voice V5 WSDL file with PHP

echo '<h2>Constructor error</h2><pre>' . $err . '</pre>';

// At this point, you know the call that follows will fail
// and you can exit your script
exit();
}
In creating that WSDL instance the WSDL file is parsed and analyzed. The WSDL
class now knows all about the offered web services. To show this information you
need to use the getOperations and getTypeDef methods of that class. Both
methods return an associative array which can be parsed with nested foreach
loops, in a recursive form or you can access each element directly if you know the
data structure.

3.2.2 Showing available operations

For analyzing purpose we choose the former possibility getOperations:
$operations = array();
$operations = $wsdl->getOperations();
// perhaps you want to show all available methods in a sorted
way
asort($operations);
foreach ($operations as $message => $msgvalue) {
echo("Operation <b>$message</b><br />");
}
Now you can start the script to have a look at the available operations. You will
see something like this:
Operation closeSession
Operation createBusinessGroup
Operation createDirectoryNumbers
Operation createFeatureProfile
Operation createOfficeCode
Operation createSubscriber
Operation deleteBusinessGroup
Operation deleteDirectoryNumber
Operation deleteFeatureProfile
Operation deleteOfficeCode
Operation deleteSubscriber
...
Following the complete script, it is really short:
Table 35 Example 1: analyze_wsdl_V1.php

<?php
require_once('nusoap.php');
$wsdl = new wsdl('https://<yourServer>:<yourPort>/'.
'HiPath8000AssistantAPIv<version>/services/'.

A31003-H8050-M104-1-76A9, 09/2010
60 OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description
 HP8000AssistantAPI_usingPHP.fm
Using the OpenScape Voice V5 with PHP
Analyzing the OpenScape Voice V5 WSDL file with PHP

'HiPath8000AssistantAPI?wsdl');
$err = $wsdl->getError()
if ($err) {
echo '<h2>Constructor error</h2><pre>' . $err . '</pre>';
exit();
}
$operations = array();
$operations = $wsdl->getOperations();
asort($operations);
foreach ($operations as $message => $msgvalue) {
echo("Operation <b>$message</b><br />");
}
?>

3.2.3 Showing operational parameters

Perhaps you now want to know which parameters are necessary to use these
operations. Therefore we have to analyze the $operations array. Because this
array represents a dynamical structure we write a recursive function showing the
content of a dynamical array and change the foreach loop into a call of this new
function.
This is the recursive function, showing dynamical data:

function showDynData($level, $var) {

$ofs = '';
for ($i=0; $i<$level; $i++) $ofs .= '-';
if (gettype($var) == 'array') {
foreach ($var as $key => $value) {
if (gettype($value) == 'array') {
if ($level == 0) echo("<h3>$key</h3>");
else echo("$ofs <b>$key</b><br />");
showDynData($level+1, $value);
}
else
echo("$ofs $key: $value<br />");
}
}
else
echo("$ofs $var<br />");

A31003-H8050-M104-1-76A9, 09/2010
OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description 61
HP8000AssistantAPI_usingPHP.fm
Using the OpenScape Voice V5 with PHP
Analyzing the OpenScape Voice V5 WSDL file with PHP

and calling this function results in the new script version:

<?php
require_once('nusoap.php');

function showDynData($level, $var) {

$ofs = '';
for ($i=0; $i<$level; $i++) $ofs .= '-';
if (gettype($var) == 'array') {
foreach ($var as $key => $value) {
if (gettype($value) == 'array') {
if ($level == 0) echo("<h3>$key</h3>");
else echo("$ofs <b>$key</b><br />");
showDynData($level+1, $value);
}
else
echo("$ofs $key: $value<br />");
}
}
else
echo("$ofs $var<br />");
}
$wsdl = new wsdl('https://<yourServer>:<yourPort>/'.
'HiPath8000AssistantAPIv<version>/services/'.
'HiPath8000AssistantAPI?wsdl');
$err = $wsdl->getError();
if ($err) {
echo '<h2>Constructor error</h2><pre>' . $err . '</pre>';
exit();
}
$operations = array();
$operations = $wsdl->getOperations();
asort($operations);

Table 36 Example 2: analyze_wsdl_V2.php

A31003-H8050-M104-1-76A9, 09/2010
62 OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description
 HP8000AssistantAPI_usingPHP.fm
Using the OpenScape Voice V5 with PHP
Analyzing the OpenScape Voice V5 WSDL file with PHP

showDynData(0, $operations);

?>
Table 36 Example 2: analyze_wsdl_V2.php

Running this new script version shows you the complete content of the dynamical
$operations array and you are able to examine its structure and the name of all
array indices to address its elements directly.
closeSession
- name: closeSession
- binding: HiPath8000AssistantAPISoapBinding
- endpoint: https://139.21.215.77:8080/
HiPath8000AssistantAPIv310/services/HiPath8000AssistantAPI
- soapAction:
- input
-- encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
-- namespace: urn:hipath8000-assistant-api-v310
-- use: encoded
-- message: closeSessionRequest
-- parts
--- sessionToken: http://www.w3.org/2001/XMLSchema:string
- output
-- encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
-- namespace: urn:hipath8000-assistant-api-v310
-- use: encoded
-- message: closeSessionResponse
-- parts
- style: rpc
- transport: http://schemas.xmlsoap.org/soap/http
- documentation:
createFeatureProfile
- name: createFeatureProfile
- binding: HiPath8000AssistantAPISoapBinding
- endpoint: https://139.21.215.77:8080/
HiPath8000AssistantAPIv310/services/HiPath8000AssistantAPI
- soapAction:
- input
-- encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
-- namespace: urn:hipath8000-assistant-api-v310
-- use: encoded
-- message: createFeatureProfileRequest
-- parts
--- sessionToken: http://www.w3.org/2001/XMLSchema:string
--- switchName: http://www.w3.org/2001/XMLSchema:string
--- inputBean: urn:hipath8000-assistant-api-
v310:FeatureProfileBean
- output
-- encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
-- namespace: urn:hipath8000-assistant-api-v310
-- use: encoded
-- message: createFeatureProfileResponse
-- parts
--- createFeatureProfileReturn: urn:hipath8000-assistant-api-
v310:ResultStatus
- style: rpc

A31003-H8050-M104-1-76A9, 09/2010
OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description 63
HP8000AssistantAPI_usingPHP.fm
Using the OpenScape Voice V5 with PHP
Analyzing the OpenScape Voice V5 WSDL file with PHP

- transport: http://schemas.xmlsoap.org/soap/http
- documentation:

In analyzing this shortened output example you find all necessary input
parameters and their types. The operation ’closeSession’ has only one string
parameter called sessionToken but the ’getFeatureProfile’ operation has an
additional one with an API specific type. How to analyze this new type? Its as
easy as all things before.

3.2.4 Showing WSDL specific types

Using the wsdl class’ method getTypeDef also returns a dynamical array
representing the necessary data structure. So we can use the showDynData
function the next time within itself.

function showDynData($level, $var) {

global $wsdl;
$ofs = '';
for ($i=0; $i<$level; $i++) $ofs .= '-';
if (gettype($var) == 'array') {
foreach ($var as $key => $value) {
if (gettype($value) == 'array') {
if ($level == 0) echo("<h3>$key</h3>");
else echo("$ofs <b>$key</b><br />");
showDynData($level+1, $value);
}
else {
if ($key != 'namespace'
and
substr($value,0,28)
== 'urn:hipath8000-assistant-api') {
$colonpos = strrpos($value,':');
$apiType = $wsdl->getTypeDef(substr($value,
$colonpos+1),substr($value,0,$colonpos));
echo("<table border=\"1\">
<tr><td style=\"vertical-align:top\">
$ofs $key: </td><td>$value<br />");
showDynData(1,$apiType);
echo("</td></tr></table>");
}
else
echo("$ofs $key: $value<br />");

A31003-H8050-M104-1-76A9, 09/2010
64 OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description
 HP8000AssistantAPI_usingPHP.fm
Using the OpenScape Voice V5 with PHP
Analyzing the OpenScape Voice V5 WSDL file with PHP

}
}
}
else
echo("$ofs $var<br />");
}

Replacing this function leads to the 3rd example analyze_wsdl_V3.php which

now shows the API types as well, see the appropriate extract:
createOfficeCode
- name: createOfficeCode
- binding: HiPath8000AssistantAPISoapBinding
- endpoint: https://139.21.215.77:8080/
HiPath8000AssistantAPIv310/services/HiPath8000AssistantAPI
- soapAction:
- input
-- encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
-- namespace: urn:hipath8000-assistant-api-v310
-- use: encoded
-- message: createOfficeCodeRequest
-- parts
--- sessionToken: http://www.w3.org/2001/XMLSchema:string
--- switchName: http://www.w3.org/2001/XMLSchema:string
--- inputBean: urn:hipath8000-assistant-api-
v310:OfficeCodeBean
- name: OfficeCodeBean
- typeClass: complexType
- phpType: struct
- compositor: sequence
- elements
-- areaCode
--- name: areaCode
--- nillable: true
--- type: http://www.w3.org/2001/XMLSchema:string
--- form: unqualified
-- countryCode
--- name: countryCode
--- nillable: true
--- type: http://www.w3.org/2001/XMLSchema:string
--- form: unqualified
-- locationCode
--- name: locationCode
--- nillable: true
--- type: http://www.w3.org/2001/XMLSchema:string
--- form: unqualified
- output
-- encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
-- namespace: urn:hipath8000-assistant-api-v310
-- use: encoded
-- message: createOfficeCodeResponse
-- parts
...

A31003-H8050-M104-1-76A9, 09/2010
OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description 65
HP8000AssistantAPI_usingPHP.fm
Using the OpenScape Voice V5 with PHP
Sending commands to the OpenScape Voice with PHP

3.3 Sending commands to the OpenScape Voice with PHP

3.3.1 Preparing the communication

For using the operations defined in the WSDL file you need an instance of a soap
client. If you know the operations you want to use and the data structure of their
parameters you don’t need an instance of the wsdl class of your own.

As in the first example you need to include the NuSOAP classes.

require_once('nusoap.php');
From there you have to instantiate the soap client.
$wsdlUrl ='https://localhost:<yourPort>/
HiPath8000AssistantAPIv310/services/’.
’HiPath8000AssistantAPI?wsdl';
$client = new soapclient( $wsdlUrl, true);
// the first parameter assigns the URL to the web service or
WSDL file
// the second one tells the system that we use a WSDL file
As already seen in the first example we should check if the constructor
succeeded.
$err = $client->getError();
if ($err) {
// Display the error
echo("<h2>Constructor error</h2><pre>" . $err . "</pre>");
// At this point, you know the call that follows will fail
exit();
}
As seen in the tutorial, it is easier to work with a proxy, so we create one.
$proxy = $client->getProxy();

3.3.2 Sending a simple command

Now all is prepared to send commands to the OpenScape Voice V5 or via this API
to the OpenScape Voice. Let’s look what API version the server runs.
$response = $proxy->getApiServerVersionString();
First we now have to check if this command succeeded.

if ($proxy->fault) {
echo '<h2>Fault</h2><pre>';

A31003-H8050-M104-1-76A9, 09/2010
66 OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description
 HP8000AssistantAPI_usingPHP.fm
Using the OpenScape Voice V5 with PHP
Sending commands to the OpenScape Voice with PHP

print_r($response);
echo '</pre>';
exit();
} else {
// Check for errors
$err = $proxy->getError();
if ($err) {
echo '<h2>Error</h2><pre>' . $err . '</pre>';
exit();
}
}

If there was no fault we have received the running version and we can show it.
echo(“you are working with API version $resproxy<br />”);
That’s it. Here is the code again in a complete form.

<?php
require_once('nusoap.php');
$wsdlUrl ='https://localhost:<yourPort>/HiPath8000AssistantAPIv310/services/’
.’HiPath8000AssistantAPI?wsdl';
$client = new soapclient( $wsdlUrl, true);
$err = $client->getError();
if ($err) {
echo("<h2>Constructor error</h2><pre>" . $err . "</pre>");
exit();
}
$proxy = $client->getProxy();
$response = $proxy->getApiServerVersion();
if ($proxy->fault) {
echo '<h2>Fault</h2><pre>';
print_r($resproxy);
echo '</pre>';
exit();
} else {
$err = $proxy->getError();
if ($err) {
echo '<h2>Error</h2><pre>' . $err . '</pre>';
Table 37 Example 3: send_operation_V1.php

A31003-H8050-M104-1-76A9, 09/2010
OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description 67
HP8000AssistantAPI_usingPHP.fm
Using the OpenScape Voice V5 with PHP
Sending commands to the OpenScape Voice with PHP

exit();
}
}
echo(“you are working with API version $response<br />”);
?>
Table 37 Example 3: send_operation_V1.php

The output of this script is:

you are working with API version 3.1
This is a simple example because there is no parameter needed and the returning
result is of a scalar type. The next example will show you a more complex
operation.

3.3.3 Sending a complex command

The preparation for sending complex commands is the same as already
described in Section 3.3.1, “Preparing the communication”. Adding parameters to
an operation is as easy as to add them to functions or methods. You have to use
$proxy->operationName(param1, param2, param3);

You can call listBusinessGroups method as the following;

$response = $proxy-
>listBusinessGroups('mySessionToken','mySwitchName');
Of course you should check the success of this call (see Section 3.3.2, “Sending
a simple command”). If the operation succeeded you can evaluate its response.
As already seen the response can be displayed directly. Last time the result was
a simple string but now the result is a structure of an API specific type, handled
by NuSOAP and PHP with an associative array. For the display of such arrays we
have defined the function showDynData (see Section 3.2.3, “Showing operational
parameters”), which we now use for presenting the result.

Because the API operation of our example can be used by authorized users only,
you have to request a session token via openSession() before sending the
request and after completing all tasks you should finish the session by closing it.
So you have to wrap all operations with a session handling.
$username = ’myUser’;
$password = ’myUsersPassword’;
$sessionToken = $proxy->openSession($username, $password);
// do all necessary operations
$proxy->closeSession($sessionToken);
Here you can see the complete script:

A31003-H8050-M104-1-76A9, 09/2010
68 OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description
 HP8000AssistantAPI_usingPHP.fm
Using the OpenScape Voice V5 with PHP
Sending commands to the OpenScape Voice with PHP

<?php
require_once('nusoap.php');

function showDynData($level, $var) {

$ofs = '';
for ($i=0; $i<$level; $i++) $ofs .= '-';
if (gettype($var) == 'array') {
foreach ($var as $key => $value) {
if (gettype($value) == 'array') {
if ($level == 0) echo("<h3>$key</h3>");
else echo("$ofs <b>$key</b><br />");
showDynData($level+1, $value);
}
else
echo("$ofs $key: $value<br />");
}
}
else
echo("$ofs $var<br />");
}

function checkResponse ($response) {

global $proxy;
if ($proxy->fault) {
echo '<h2>Fault</h2><pre>';
print_r($response);
echo '</pre>';
exit();
} else {
$err = $proxy->getError();
if ($err) {
echo '<h2>Error</h2><pre>' . $err . '</pre>';
exit();
}
}
Table 38 Example 4: send_operation_V2.php

A31003-H8050-M104-1-76A9, 09/2010
OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description 69
HP8000AssistantAPI_usingPHP.fm
Using the OpenScape Voice V5 with PHP
Sending commands to the OpenScape Voice with PHP

$wsdlUrl ='https://localhost:<yourPort>/HiPath8000AssistantAPIv310/services/’
’HiPath8000AssistantAPI?wsdl'; // change to your WSDL’s URL
$client = new soapclient( $wsdlUrl, true);
// the first parameter assigns the URL to the web service or WSDL file
// the second one tells the system that we use a WSDL file

$err = $client->getError();
if ($err) {
echo("<h2>Constructor error</h2><pre>" . $err . "</pre>");
exit();
}

$proxy = $client->getProxy();

$username = 'myUser'; // has to be changed to your user

$password = 'myUsersPassword'; // change to your user’s password
$switchName = 'mySwitch'; // change to your user’s password
$response = $proxy->openSession($username, $password);
checkResponse($response);

$sessionToken = $response;

$response = $proxy->listBusinessGroups($sessionToken,$switchName);
checkResponse($response);

showDynData(0, $response);

$proxy->closeSession($sessionToken);
?>
Table 38 Example 4: send_operation_V2.php

If there are data available this operation results in an output like that:
listdisplay
- 0
-- areaCode:
-- countryCode:
-- defaultFeatureProfile:

A31003-H8050-M104-1-76A9, 09/2010
70 OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description
 HP8000AssistantAPI_usingPHP.fm
Using the OpenScape Voice V5 with PHP
Sending commands to the OpenScape Voice with PHP

-- displayNumber: 4351701
-- localOfficeCode:
-- name: BGstier01
-- numberSubscribers: 2
- 1
-- areaCode:
-- countryCode:
-- defaultFeatureProfile:
-- displayNumber: 4351702
-- localOfficeCode:
-- name: BGstier02
-- numberSubscribers: 0
- 2
-- areaCode:
-- countryCode:
-- defaultFeatureProfile:
-- displayNumber: 4351706
-- localOfficeCode:
-- name: BGstier06
-- numberSubscribers: 0
- 3
-- areaCode:
-- countryCode:
-- defaultFeatureProfile:
-- displayNumber: 4351707
-- localOfficeCode:
-- name: BGstier07
-- numberSubscribers: 2
...
resultStatus
- commandReplies:
- currentState:
- lastJobResultHashCode: 0

A31003-H8050-M104-1-76A9, 09/2010
OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description 71
HP8000AssistantAPI_usingPHP.fm
Using the OpenScape Voice V5 with PHP
Sending commands to the OpenScape Voice with PHP

A31003-H8050-M104-1-76A9, 09/2010
72 OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description
 HP8000AssistantAPI_popup.fm

Apache

http://www.apache.org/

SOAP

http://www.w3.org/TR/soap/

Axis

http://ws.apache.org/axis/

Tomcat

http://tomcat.apache.org/

RTE

http://java.sun.com/j2se/1.5.0/download.jsp

JAX

http://java.sun.com/webservices/index.jsp

XAMPP

http://www.apachefriends.org/en/xampp.html

NuSOAP

http://sourceforge.net/projects/nusoap/

Tutorial ’Introduction to "NuSOAP":

http://www.scottnichol.com/nusoapintro.htm

A31003-H8050-M104-1-76A9, 09/2010
OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description 73
HP8000AssistantAPI_popup.fm

A31003-H8050-M104-1-76A9, 09/2010
74 OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description
 HP8000AssistantAPISIX.fm
For internal use only Index

Index Z

A Distinctive Ringing for Waiting Calls Feature -

Account Code Feature - CfAcctCodeBean 24 CfDRCWBean 34
Add Directory Numbers to an Office Code (createDi- DLS Related Commands 44
rectoryNumbers) 11
Anonymous Caller Reject Feature - CfACRBean 24
E
Apache 5 Enhanced Anonymous Caller Reject Feature - CfE-
API operations 5 ACRBean 34
API version (getApiServerVersion) 9 F
Authorization Code Feature - CfAuthCodeBean 24 Feature Profile
Automatic Callback Feature - CfACBean 23 Features 23
Automatic Recall Feature - CfARBean 24 Feature Profile Bean (FeatureProfileBean) 22
Axis 5 Feature Profile related commands 22
B Features
Base Feature Bean - FeatureBean 23 Feature Profile 23
Business Group Bean (BGBean) 13 H
Business Group List Bean (BGListBean) 14 Hot Desking Feature - CfHotDeskBean 36
Business Group related commands 13
I
C implementation 5
Call Forward Busy Feature - CfCCWBean 27 Introduction 5
Call Forward Enhanced Feature - CfECFBean 35
Call Forward No Reply Feature - CfCFDABean 28 L
Call Forward Unconditional Feature - CfCFVBean 30 Line Restriction Feature - CfSRBean 39
Call Hold Feature - CfCHLDBean 31 List all Feature Profiles (listFeatureProfiles) 43
Call Pickup Group Feature - CfBgCPUBean 25 List all properties of a Business Group (getBusiness-
Call Transfer Feature - CfCTBean 33 Group) 16
Called Name Delivery Feature - CfCISNAMEBean 32 List all properties of a Feature Profile (getFeaturePro-
Caller ID Feature - CfCNDBean 32 file) 43
Create a Business Group List all properties of a Subscriber (getSubscriber) 21
Scenario 46 List Available OpenScape Branch Offices (listOpen-
Create a Business Group (createBusinessGroup) 15 Branches) 46
Create a Subscriber List Business Groups (listBusinessGroups) 15
Scenario 46 List Calling Locations (listCallingLocations) 13
Create a Subscriber (CreateSubscriber) 21 List Classes of Service (listClassesOfService) 13
Create an Office Code (createOfficeCode) 10 List Directory Numbers of an Office Code (listDirecto-
Create Feature Profile (createFeatureProfile) 44 ryNumbers) 11
CSTA Feature - CfCSTABean 33 List DLS Servers (listDLS) 44
List Intercept Announcements (listInterceptAnnounce-
D ments) 22
Delete a Business Group (deleteBusinessGroup) 15 List Numbering Plan Subscribers (listNumberingPlan-
Delete a Directory Number (deleteDirectoryNumbers) Subscribers) 12
11 List Numbering Plans (listNumberingPlans) 12
Delete a Feature Profile (deleteFeatureProfile) 44 List Office Codes (listOfficeCodes) 10
Delete an Office Code (deleteOfficeCode) 10 List Rate Areas (listRateAreas) 12
Delete Subscriber (deleteSubscriber) 22 List SIP details of the Subscribers (listBusinessGroup-
Directory Number related commands 10 SubscribersSip) 21

A31003-H8050-M104-1-76A9, 09/2010
OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description 75
HP8000AssistantAPISIX.fm
Index For internal use only

List Subscribers (listBusinessGroupSubscribers) 20 P

List Switches (listSwitch) 45 Predefined User Profiles 6
List the Call Pickup Groups of a Business Group (list-
CallPickupGroups) 17 R
List the Departments of a Business Group (listDepart- Remote Activation Feature - CfRACFBean 36
mentsOfBusinessGroup) 17 Retrieve the Operation Mode of a Switch (getOpera-
List the Feature Profiles of a Business Group (listFea- tionMode) 45
tureProfiles) 17
List the SIP Subscriber ID passed to DLS S
(listBusinessGroupSubscribersSipV4) 17 Scenario
List the SIP Subscribers of a Business Group (listBusi- Create a Business Group 46
nessGroupSubscribersSip) 16 Create a Subscriber 46
List the Subscribers of a Business Group (listBusiness- Modify the Display Name of a Subscriber 47
GroupSubscribers) 16 Scenarios 46
List Used and Total Licenses (listLicenses) 45 Secure Access to OpenScape Voice Assistant V5 API
List Vacant Directory Numbers (listVacantDirecto- 56
ryNumbers) 11 Selective Call Forwarding Feature - CfSCFBean 37
Selective Caller Acceptance Feature - CfSCABean 36
M Selective Caller Reject Feature - CfSCRBean 38
Malicious Call Trace Feature - CfMCTBean 36 Sending commands to the OpenScape Voice with
Modify a Business Group (modifyBusinessGroup) 16 Java
Modify a Feature Profile (modifyFeatureProfile) 44 A complex client 53
Modify a Subscriber (modifySubscriber) 22 A simple client 52
Modify the Display Name of a Subscriber WSDL file with Java 52
Scenario 47 Sending commands to the OpenScape Voice with PHP
Multiple 8K support of API 6 Preparing the communication 66
Multiple DLS support of API 7 Sending a complex command 68
Music On Hold Feature - CfMOHBean 36 Sending a simple command 66
WSDL file with PHP 66
N Serial Ringing Feature - CfSERRNGBean 38
Name Delivery Feature - CfBgCNAMBean 25 Session related commands 8
Numbering Plan Bean (NPBean) 12 Simple Object Access Protocol 5
Numbering Plan related commands 12 Simultaneous Ringing Feature - CfSRSBean 40
Numbering Plan Resources 12 SOAP 5
Speed Calling Feature - CfSPCALLBean 38
O Subscriber Bean (SubscriberBean) 18
Office Code Bean (OfficeCodeBean) 9 Subscriber related commands 18
Office Code related commands 9 Switch-Related Commands 45
One Number Feature - CfONSBean 36 System related commands 9
OpenScape Voice Assistant API
Web Services Interface 5 T
OpenScape Voice Assistant API with Java 49 Toll and Call restrictions Feature - CfTRSBean 40
OpenScape Voice Assistant API with PHP 59 Tomcat 5
Outgoing CID Presentation Status Feature - CfB- Types of Operations of API 7
gDAPPSBean 26
Outgoing CID Presentation Status Plus Feature - CfB- U
gDNPPSBean 26 Usage Sensitive Call Forward Variable Feature -
Outgoing CID Suppression Feature - CfCIDSBean 32 CfUSCFVBean 41
Outgoing Name Delivery Blocking Feature - CfCNAB-
Bean 32 V
Outgoing Number Delivery Blocking Feature - Voice Mail Feature - CfCFVBean 42
CfCNDBBean 32

A31003-H8050-M104-1-76A9, 09/2010
76 OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description
 HP8000AssistantAPISIX.fm
For internal use only Index

W
Web Services Interface
OpenScape Voice Assistant API 5
WSDL file 5
WSDL file for the OpenScape Voice Assistant API 5
WSDL file with Java 49
Analysis 49
Available operations 50
Operational parameters 51
Sending commands to the OpenScape Voice with
Java 52
WSDL file with PHP 59
Analysis 59
Available operations 60
Operational parameters 61
Sending commands to the OpenScape Voice with
PHP 66
Showing WSDL specific types 64

A31003-H8050-M104-1-76A9, 09/2010
OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description 77
HP8000AssistantAPISIX.fm
Index For internal use only

A31003-H8050-M104-1-76A9, 09/2010
78 OpenScape Voice V5 Assistant API, Volume 8, Assistant API Description