Nortel 5100 Series Release 2.3.3 Manuel du propriétaire

Nortel Multimedia Communication Server 5100

Application Programming

Interfaces Reference

NN42020-146

Document status: Standard

Document version: 01.07

Document date: 19 October 2007

Sourced in Canada

The information in this document is subject to change without notice. The statements, conﬁgurations, technical

data, and recommendations in this document are believed to be accurate and reliable, but are presented without

express or implied warranty. Users must take full responsibility for their applications of any products speciﬁed in this

document. The information in this document is proprietary to Nortel Networks.

Nortel, Nortel (Logo), and the Globemark are trademarks of Nortel Networks.

All other trademarks are the property of their respective owners.

Revision History

October 2007

Standard 01.07. This document is up-issued to support Multimedia

Communication Server 5100 Release 4.0. This document addresses CR

Q01619033.

July 2007

Standard 01.06. This document is up-issued to support Multimedia

Communication Server 5100 Release 4.0. This document addresses CR

Q01670119.

June 2007

Standard 01.05. This document is up-issued to support Multimedia

Communication Server 5100 Release 4.0. This document addresses CR

Q01676724.

March 2007

Standard 01.04. This document is up-issued to support Multimedia

Communication Server 5100 Release 4.0. This document addresses CRs

Q01564258 and Q01543719.

January 2007

Standard 01.01. This document is issued to support Multimedia

Communication Server 5100 Release 4.0. This document contains

information previously contained in the following legacy documents, now

retired:

•Open Provisioning Interface (NN42020-123)

•Bulk Provisioning Tool Reference Guide (NN42020-501)

Nortel Multimedia Communication Server 5100

Application Programming Interfaces Reference

NN42020-146 01.07 Standard

Release 4.0 19 October 2007

4Revision History

Nortel Multimedia Communication Server 5100

Application Programming Interfaces Reference

NN42020-146 01.07 Standard

Release 4.0 19 October 2007

Contents

New in this release 23

Feature changes 23

Subscriber OPI productization 23

SSL for web and SOAP interface 23

Password management 23

Language support 24

Multiple login restrictions 24

Other changes 24

How to get help 25

Finding the latest updates on the Nortel web site 25

Getting help from the Nortel web site 25

Getting help over the phone from a Nortel Solutions Center 25

Getting help from a specialist by using an Express Routing Code 26

Getting help through a Nortel distributor or reseller 26

Application Programming Interfaces overview 27

Audience 28

Related documents 28

Open Provisioning Interface overview 29

Open Provisioning Interface introduction 29

Web Services Description Language 1.1 29

Security 30

Import a CA Certiﬁcate into BPT 30

Third-party client development 31

Get the WSDL 31

Generate stubs 32

Implement interface accessing stubs 32

Access stubs from the third-party application 33

Authentication and authorization 33

Authentication 33

Authorization 33

Provisioning interface 34

Success indication on remove methods 35

Provisioning data visibility 35

Nortel Multimedia Communication Server 5100

Application Programming Interfaces Reference

NN42020-146 01.07 Standard

Release 4.0 19 October 2007

6Contents

PROV606 logs 36

Open Provisioning Interface clients 37

Open Provisioning Interface client stubs 37

Requirements 37

Download the Axis toolkit 37

Conﬁgure the classpath 38

Download the WSDL ﬁle 39

Compile the stubs 39

Write a client to perform some speciﬁc OPI operations 41

Two examples 44

Example: creating a user route to screen two numbers 44

Example: creating a route using simultaneous ringing 46

Recommended methods 48

.NET authentication headers 49

Bulk Provisioning Tool introduction 51

Overview 51

Why use the BPT? 52

BPT requirements 52

Limitations 52

Install and launch the BPT 53

Install the BPT on a workstation 53

Launch the BPT on a workstation 54

Launch the BPT on the provisioning server 55

BPT Main Menu 56

Commands 57

Files and scripts 58

Files 58

Scripts 59

BPT limitations 59

PROV606 logs 59

Mapping between Provisioning Client and BPT 59

Batch processing 59

Resource use 60

Provisioning data visibility 60

Bulk Provisioning Tool conventions and examples 61

Method and ﬁle syntax conventions 61

Optional syntax 62

Brackets 63

Angle brackets 63

Square brackets 63

Bar 64

Comma separated strings 64

Using fully qualiﬁed user names 65

Nortel Multimedia Communication Server 5100

Application Programming Interfaces Reference

NN42020-146 01.07 Standard

Release 4.0 19 October 2007

Contents 7

Success indication on remove methods 65

Unknown error messages 65

Example - adding a new provisioning role 65

Mapping of the addRole method to the Provisioning Client window ﬁelds 65

Deﬁning a new role to add 66

Performing the add method 68

Viewing the details of the new role 69

Deleting the role 71

New, changed, and deleted methods for OPI and BPT 73

Methods added in this release 73

Methods changed in this release 78

Methods removed from this release 78

Methods for OPI and BPT 79

Domain Operations 80

Domain Locale Operations 81

Status Reasons Operations 84

Domain Class of Service Operations 87

Domain Proﬁle Operations 88

Banned Subscriber Operations 89

Converged Desktop Service Data 92

Add a root domain (addRootDomain) 97

Add a sub domain (addSubDomain) 98

Modify a domain (modifyDomain) 98

Remove a domain (removeDomain) 98

Get all root domain parameters (getAllRootDomainParms) 99

Get all sub domain parameters (getAllSubDomainParms) 99

Get all possible values for a domain parameter (getDomainParmValues) 99

Get all domains (getAllDomains) 99

Get a domain by name (getDomain) 100

Get all child domains of a domain (getChildrenDomains) 100

Get the parent domain of a domain (getParentDomain) 100

Get the root domain of a domain (getRootDomain) 101

Add a foreign domain (addForeignDomain) 101

Get a foreign domain (getForeignDomain) 102

Modify a foreign domain (modifyForeignDomain) 102

Remove a foreign domain (removeForeignDomain) 102

Get domains subset (getDomains) 103

Get all the root domain names (getAllRootDomainNames) 103

Get all the children domain names for a domain (getAllChildrenDomain-

Names) 103

Get the domain count in the system (getNumberOfDomains) 104

Device Operations 104

Add a device (addDevice) 104

Nortel Multimedia Communication Server 5100

Application Programming Interfaces Reference

NN42020-146 01.07 Standard

Release 4.0 19 October 2007

8Contents

Add devices (addDevices) 105

Modify a device (modifyDevice) 106

Remove a device (removeDevice) 106

Remove devices (removeDevices) 107

Get a device (getDevice) 107

Get a list of devices (getDevices) 107

Get devices by domain (getDevicesInDomain) 108

Get devices by User name (getCurrentDevices) 108

Get devices by MAC address (getDeviceByMacAddress) 108

get SubDomain For Device (getSubDomainForDevice) 109

IPCM Operations 109

Add a single IPCM (addIPCM) 109

Modify a single IPCM (modifyIPCM) 110

Get a single IPCM (getIPCM) 110

Remove a single IPCM (removeIPCM) 110

Get available capacity for an IPCM (getIPCMAvailCapacity) 111

Get assigned IPCMs for a domain (getAssignedIPCMs) 111

Get IPCM capacity for domain (getIPCMCapacityByDomain) 111

Remove Physical IPCM (deletePhysicalIPCM) 112

User Operations 112

User Data Operations 113

User Call Log Operations 117

User Times Operations 119

Route Operations 122

User Service Operations 135

User Meet Me Conferencing Operations 137

User Watcher Operations 140

User Converged Desktop Operations 141

User SIP Line Data Operations 144

Assistant Support Operations 149

User Search Operations 153

User Management Operations 157

User Voicemail Operations 167

User Direct to Gateway Operations 168

Logout all user contacts (sendUnRegister) 170

Get clientRedirectServlet login authorization (getClientRedirectLogin) 170

Admin Operations 170

Role Operations 170

Add an Admin (addAdmin) 173

Modify an Admin (modifyAdmin) 174

Remove an Admin (removeAdmin) 174

Get an Admin (getAdmin) 174

Get all Admins (getAllAdmins) 175

Nortel Multimedia Communication Server 5100

Application Programming Interfaces Reference

NN42020-146 01.07 Standard

Release 4.0 19 October 2007

Contents 9

Get all children Admins (getAllChildrenAdmins) 175

Change password (changeAdminPassword) 175

Reset password (resetAdminPassword) 176

Service Operations 176

Service Package Operations 177

Get all services assigned to a domain (getServicesByDomain) 181

Add services to a domain (addServicesToDomain) 181

Remove all services assigned to a domain (removeServicesByDomain) 181

Modify services assigned to a domain (modifyDomainServices) 182

Add services to multiple domains (addServicesToDomains) 182

Modify services of multiple domains (modifyServicesToDomains) 182

Modify the acceptable parameter values for a service (modifyServiceParm) 183

Set a parameter value as default value for a service (setServiceParmAsDe-

fault) 183

Get all service names (getAllServiceNames) 183

Get parameter names for a service (getParmNamesByService) 184

Get parameter names for all services (getParmNamesForAllServices) 184

Get all acceptable values for given parameter (getServiceParmValues) 184

Get Parameter Display Name By Parameter Name (getParameterDisplayName-

ByParameterName) 185

Get Parameter Name By Parameter Display Name (getParameterNameByPa-

rameterDisplayName) 185

Get Service Display Name By Service Name (getServiceDisplayNameByServi-

ceName) 185

Get Service Name By Service Display Name (getServiceNameByServiceDis-

playName) 186

Pooled Entity 186

Services 186

Node Operations 200

Get all Node Type Names (getAllNodeTypeNames) 201

Add a node (addNode) 201

Add multiple nodes (addNodes) 202

Modify a node (modifyNode) 202

Remove a node (removeNode) 203

Get a Node (getNode) 203

Get all Nodes (getAllNodes) 204

Get node count (getNodeCount) 204

Add a single logical entity (addLogicalEntity) 204

Add multiple Logical Entitys (addLogicalEntitys) 205

Modify a Logical Entity (modifyLogicalEntity) 205

Remove a Logical Entity (removeLogicalEntity) 206

Get a Logical Entity (getLogicalEntity) 206

Get All Logical Entitys (getAllLogicalEntitys) 206

Get Logical Entity Count (getLogicalEntityCount) 207

Nortel Multimedia Communication Server 5100

Application Programming Interfaces Reference

NN42020-146 01.07 Standard

Release 4.0 19 October 2007

10 Contents

Add node to root domains (assignDomainsToNode) 207

Assign node to sub domains (assignNodeToSubDomains) 207

Get root domains for a node (getNodeDomains) 208

Get sub domains for a node (getNodeSubDomains) 208

Get all node names for sub domains (getAllNodeNamesForDomain) 208

Get all Nodes for the root domain (getDomainNodes) 209

Get all Routing Algorithms (getAllRoutingAlgorithms) 209

Get all Routable Services (getAllRoutableServices) 209

Get all Routable Service Groups (getAllRoutableServiceGroups) 209

Pool Management 210

Get all Nodes By Routable Service (getAllNodesByRoutableService) 210

Get all Nodes By Routable Service Groups (getAllNodesByRoutableService-

Group) 211

Get Assigned Domain Routing Node (getAssignedNodeByDomainByService-

Group) 211

Get Assigned Location Routing Node (getAssignedNodeByLocationByService-

Group) 211

Get Routing Locations By Service Group (getAllLocationsForNodeByService-

Group) 212

Get All Locations By Service Group (getAllAvailableLocationsByService-

Group) 212

Assign Node to Domain Routable Service (assignNodeToDomain) 213

Assign Node to Location Routable Service (assignNodeToLocation) 213

Assign Node to Location Routable Services (assignNodeToLocations) 213

Alias Routing 214

Add, Modify or Delete Alias Routing Information (modifyRoutableSer-

viceAlias) 214

Get a list of Aliases Providing a Service (getRoutableServiceAliases) 215

Get Aliases Information for an Alias (getRoutableServiceAliasInfo) 215

Get Aliases All Information for an Alias Providing a Speciﬁed Service

(getAliasInfoByService) 215

Remove routable service alias (deleteRoutableServiceAlias) 216

Routable Service Parameter 216

GetDomainServiceParmsforaService (getDomainRoutingServiceParms) 217

Get Location Service Parms for a Service (getLocationRoutingServi-

ceParms) 217

Get Alias Service Parms for a Service (getAliasServiceParms) 217

Set Domain Service Parms for a Service (setDomainRoutingServiceParms) 218

Set Location Service Parms for a Service (setLocationRoutingServi-

ceParms) 218

Set Alias Service Parms for a Service (setAliasServiceParms) 219

Location Services 219

Add Location (addLocation) 220

Add Locations (addLocations) 220

Modify Location (modifyLocation) 221

Nortel Multimedia Communication Server 5100

Application Programming Interfaces Reference

NN42020-146 01.07 Standard

Release 4.0 19 October 2007

Autres manuels pour 5100 Series Release 2.3.3

Table des matières

Autres manuels Nortel Serveur

Nortel

Nortel 1000S Manuel utilisateur

Nortel

Nortel 1000 Con?guration guide Manuel du propriétaire

Nortel

Nortel 1002rp Guide de configuration

Nortel

Nortel CallPilot 702t Instructions d'utilisation et d'entretien

Nortel

Nortel Succession 1000M Guide d'installation

Nortel

Nortel 1000 Con?guration guide Manuel utilisateur

Nortel

Nortel 5100 Series Release 2.3.3 Guide de configuration rapide

Nortel

Nortel 1000E Mode d’emploi

Nortel

Nortel 703t Guide de configuration

Nortel

Nortel 201i Manuel

Nortel

Nortel MCC 3100 Guide de démarrage rapide

Nortel

Nortel 1000E Mode d’emploi

Nortel

Nortel 2000 Instructions de montage

Nortel

Nortel 5100 Series Release 2.3.3 Manuel utilisateur

Nortel

Nortel 1000 Con?guration guide Manuel utilisateur

Nortel

Nortel AS 5300 Guide de l'utilisateur

Nortel

Nortel 1000E Mode d’emploi

Nortel

Nortel CallPilot Instructions d'utilisation et d'entretien

Nortel

Nortel 1000 Con?guration guide Manuel utilisateur

Nortel

Nortel CS 1000 Series Manuel utilisateur

Nortel

Nortel 201i Guide de configuration

Nortel

Nortel 2100 Manuel utilisateur

Nortel

Nortel 5391 Instructions d'installation et d'utilisation

Nortel

Nortel 5100 Series Release 2.3.3 Mode d’emploi

Manuels Serveur populaires d'autres marques

HP AlphaServer ES47 Manuel utilisateur

Dell

Dell PowerEdge R410 Manuel utilisateur

PowerNAS

PowerNAS CMA Manuel utilisateur

Supero

Supero FatTwin F617R3-FT Manuel utilisateur

MSI

MSI P1-109N-L70 Manuel utilisateur

Dell

Dell PowerEdge XE9640 Manuel

Dell

Dell PS4100 Instructions de montage

EtroVISION

EtroVISION EV3151 Manuel utilisateur

NEC

NEC Express5800/T110j Manuel utilisateur

HP ProLiant Gen9 Manuel utilisateur

Compaq

Compaq ProLiant 3000 Manuel

Dell

Dell PowerEdge 3YPMN Manuel utilisateur

iRobo

iRobo IPC2U Manuel utilisateur

Asus

Asus AP7500 Manuel d'utilisation et d'entretien

Avid Technology

Avid Technology AirSpeed 5000 Manuel utilisateur

HP Integrity rx2600 Guide d'installation

Milestone

Milestone Husky IVO 350T Manuel utilisateur

Planet

Planet NAS-7410 Manuel utilisateur