Nortel 5100 Series Release 2.3.3 Programming Reference Manual

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.

3

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

.

5

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

.

Contents 11

Remove Location (removeLocation) 221

Get Location (getLocation) 222

Get Locations for Domain (getLocations) 222

Get Locations by Parent (getLocationsByParent) 222

Add ERL (addErl) 223

Get ERL (getErl) 223

Modify ERL (modifyErl) 223

Remove ERL (removeErl) 224

List ANI for Domain (getAniList) 224

List of Valid ANI Registration Times in Seconds (getValidAniRegTimes) 225

List Deprecated Locations for Domain (getDeprecatedLocations) 225

Purge Deprecated Locations for Domain (purgeDeprecatedLocations) 225

Telephony Routes Operations 225

Number Qualiﬁer Operations 226

Pre-Translation Operations 229

Add a new Telephony route (addTelephonyRoute) 232

Add multiple Telephony routes (addTelephonyRoutes) 233

Modify a telephony route (modifyTelephonyRoute) 234

Remove a telephony route (removeTelephonyRoute) 234

Remove multiple telephony routes (removeTelephonyRoutes) 235

Get telephony route types (getTelephonyRouteTypes) 235

Get a telephony route in a domain (getTelephonyRoutesByDomain) 235

Get a telephony route (getTelephonyRoute) 236

Add a route list (addRouteList) 236

Add multiple route list (addRouteLists) 236

Modify a route list (modifyRouteList) 237

Remove a route list (removeRouteList) 237

Remove multiple route lists (removeRouteLists) 238

Remove all telephony routes from a route list (removeAllTelephonyRoutesFrom-

RouteList) 238

Remove a telephony route from route list (removeTelephonyRouteFrom-

RouteList) 238

Get route lists by domain (getRouteListByDomain) 239

Get a route list by name (getRouteListByName) 239

Get a route list by Class Of Service (getRouteListByClassOfService) 239

Get route list actions (getRouteListActions) 240

Get translation destinations (getDestinations) 240

Add Direct To Gateway service preﬁx for a domain (assignDirectToGatewayPre-

ﬁxData) 240

Get Direct To Gateway service preﬁx for a domain (getDirectToGWPreﬁx-

Data) 241

Remove Direct To Gateway service preﬁx for a domain (removeDirectToGW-

PreﬁxData) 241

Voicemail Operations 241

Nortel Multimedia Communication Server 5100

Application Programming Interfaces Reference

NN42020-146 01.07 Standard

Release 4.0 19 October 2007

.

12 Contents

Add a Voicemail Server Host (addVoicemailServerHost) 242

Modify a Voicemail Server Host (modifyVoicemailServerHost) 243

Remove a Voicemail Server Host (removeVoicemailServerHost) 243

Get Voicemail Servers Host (getVoicemailServerHost) 243

Get all Voicemail Server Hosts (getAllVoicemailServerHosts) 244

Get all Voicemail Server Host Types (getAllVoicemailServerHostTypes) 244

Add a SIP Voicemail Server (addSIPVoicemailServer) 244

Modify a SIP Voicemail Server (modifySIPVoicemailServer) 245

Remove a SIP Voicemail Server (removeSIPVoicemailServer) 246

Get all SIP Voicemail Servers (getAllSIPVoicemailServers) 246

Get all SIP Voicemail Servers for a domain (getAllSIPVoicemailServersByDo-

main) 246

Add a Trunk Voicemail Server (addTrunkVoicemailServer) 247

Modify a Trunk Voicemail Server (modifyTrunkVoicemailServer) 248

Remove a Trunk Voicemail Server (removeTrunkVoicemailServer) 249

Get all Trunk Voicemail Servers of a particular trunk type (getAllTrunkVoice-

mailServers) 249

Get Trunk Voicemail Servers by domain (getTrunkVoicemailServerByDo-

main) 249

Add a Line Voicemail Server (addLineVoicemailServer) 250

Modify a Line Voicemail Server (modifyLineVoicemailServer) 251

Remove a Line Voicemail Server (removeLineVoicemailServer) 253

Get Line Voicemail Servers for a domain (getLineVoicemailServerByDo-

main) 253

Get all Line Voicemail Server (getAllLineVoicemailServers) 253

Get all Voicemail Servers (getAllVoicemailServers) 253

Get all Voicemail Servers for a domain (getAllVoicemailServersByDomain) 254

Get all users for Voicemail Server (getUsersForVoicemailServer) 254

Addressbook Operations 254

Add address book entry for a User (addAddressBookEntry) 256

Add multiple address book entries for a User (addAddressBookEntries) 257

Modify an address book entry for a User (modifyAddressBookEntry) 258

Modify address book entries for a User (modifyAddressBookEntries) 258

Remove address book entries for a User (removeAddressBookEntries) 259

Remove an address book entry for a User (removeAddressBookEntry) 260

Remove address book for a User (removeUserAddressBook) 260

Remove address book for a User (removeAddressBook) 260

Get address book for a User (getAddressBook) 261

Remove a buddy from a users address book (removeBuddy) 261

Get buddies from the address book of a User (getBuddies) 261

Add a banned user (addBannedUser) 262

Add banned users (addBannedUsers) 262

Modify a banned user (modifyBannedUser) 262

Get the banned users for a User (getBannedUsers) 263

Nortel Multimedia Communication Server 5100

Application Programming Interfaces Reference

NN42020-146 01.07 Standard

Release 4.0 19 October 2007

.

Contents 13

Remove a banned user for a User (removeBannedUser) 263

Remove all banned users for a User (removeAllBannedUsers) 263

Get all address book groups for a User (getAddressBookGroups) 264

Add new group to the address book of a User (addAddressBookGroup) 264

Add new groups to the address book of a User (addAddressBookGroups) 264

Modify address book group names for a User (modifyAddressBookGroups) 265

Remove address book group of a User (removeAddressBookGroup) 265

Rename address book group of a User (renameAddressBookGroup) 265

Add users to the address book of a User (addUsersToAddressBook) 266

Get an addressbook entry (getAddressBookEntry) 266

Get address book for a User with photo urls (getAddressBookWithPhoto) 267

Get an addressbook entry with photo url (getFullAddressBookEntry) 267

Get address book for a User without photo urls (getLightWeightAddress-

Book) 267

Make this entry a buddy (makeBuddy) 268

Time Zone Operations 268

Get a Time Zone by ID (getTimeZoneByID) 268

Get a Time Zone by name (getTimeZoneByName) 269

Get all Time Zone IDs (getAllTimeZoneIds) 269

Get all Time Zones (getAllTimeZones) 269

Add a Time Zone (addTimeZone) 270

Remove a Time Zone (removeTimeZone) 270

Modify a Time Zone (modifyTimeZone) 270

Emergency Number Operations 271

Add Emergency Number (addEmergencyNumber) 271

Add Emergency Numbers (addEmergencyNumbers) 271

Get all Emergency Numbers (getAllEmergencyNumbers) 272

Get Emergency Aliases (getEmergencyAlias) 272

Remove all Emergency Numbers (removeAllEmergencyNumbers) 272

Remove an Emergency Number (removeEmergencyNumber) 272

Update Emergency Alias List (updateEmergencyAlias) 273

Media Portal Group and Route Operations 273

Add a new Media Portal Group (addMediaPortalGroup) 274

Add multiple Media Portal Groups (addMediaPortalGroups) 274

Modify a Media Portal Group (modifyMediaPortalGroup) 275

Remove a Media Portal Group (removeMediaPortalGroup) 276

Remove multiple Media Portal Groups (removeMediaPortalGroups) 276

Get a Media Portal Group data (getMediaPortalGroupByName) 276

Get all Media Portal Groups (getAllMediaPortalGroups) 277

Get available domains and locations not assigned to any MP Group

(getAvailableDomainLocations) 277

Get all existing conﬁgured Media Portal IP addresses (getAllMediaPortalRe-

sourceIPs) 277

Add a new Media Portal Route (addMpRoutabilityGroup) 277

Nortel Multimedia Communication Server 5100

Application Programming Interfaces Reference

NN42020-146 01.07 Standard

Release 4.0 19 October 2007

.

14 Contents

Add multiple Media Portal Routes (addMpRoutabilityGroups) 278

Modify a Media Portal Route (modifyMpRoutabilityGroup) 278

Remove a Media Portal Route (removeMpRoutabilityGroup) 279

Remove multiple Media Portal Routes (removeMpRoutabilityGroups) 279

Get a Media Portal Route data (getMpRoutabilityGroupByName) 279

Get all Media Portal Routes (getAllMpRoutabilityGroups) 280

Get all domains and locations in the system (getAllDomainLocations) 280

Modify domain locations by Media Portal Group (modifyDomainLocationsByMP-

Group) 280

Modify domain locations by Route Name (modifyDomainLocationsByRT-

Group) 281

Resource Management 281

Add Domain Resource (setDomainResource) 281

Modify Domain Resource (modifyDomainResource) 282

Remove Domain Resource By Service (removeDomainResource) 282

Remove All Domain Resources (removeAllDomainResources) 282

Get Domain Resources (getDomainResourcesByDomain) 283

Get Domain Resource by Service Name (getDomainResourceByService) 283

LicenseKey Usage 283

Get License Key Usage for a Given Keycode (getLicenseKeyUsage) 284

LDAP Syncing 284

Add LDAP Schema (addLdapSchema) 285

Add LDAP Info (addLdapInfo) 285

Add LDAP Time Block (addLdapTimeBlock) 286

Add LDAP User Defaults (addLdapUserDefaults) 287

Add LDAPSyncFilterCriteria (setLDAPSyncFilterCriteria) 287

Remove LDAP Info for Domain (removeLdapInfo) 287

Remove LDAP Schema for Domain (removeLdapSchema) 288

Remove LDAP Time Block for Domain (removeLdapTimeBlock) 288

Remove LDAP User Defaults (removeLdapUserDefaults) 288

Remove LdapSyncFilterCriteria for Domain (removeLdapSyncFilterCriteria) 289

Get LDAP Schema for Domain Name (getLdapSchema) 289

Get LDAP Information for Domain Name (getLdapInfo) 289

Get LDAP Time block for Domain Name (getLdapTimeBlock) 290

Get LDAP User Defaults for Domain Name (getLdapUserDefaults) 290

Get Ldap Sync Filter Criteria for Domain Name (getLdapsyncFilterCriteria) 290

Start LDAP Synchronization Now (startLdapSyncNow) 291

Password Policy Operations 291

Get a Password Policy by name (getPasswordPolicy) 291

Get all Password Policies (getAllPasswordPolicies) 291

Add a Password Policy (addPasswordPolicy) 292

Modify a Password Policy (modifyPasswordPolicy) 292

Remove a Password Policy (removePasswordPolicy) 293

Parm Deﬁnition 293

Nortel Multimedia Communication Server 5100

Application Programming Interfaces Reference

NN42020-146 01.07 Standard

Release 4.0 19 October 2007

.

Contents 15

Get all Parm Types (getAllParmTypes) 293

Get all Parm Validation Types (future method) getAllParmValidationTypes 294

Get all Parm Owners (getAllParmOwners) 294

Get all Parm Deﬁnitions (getAllParmDeﬁnitions) 294

Get all Parm Deﬁnitions By Owner (getParmDeﬁnitionByOwner) 294

Get Parm Deﬁnition By Name (getParmDeﬁnitionByName) 295

Get all Parm Deﬁnition Data (future method) (getParmDeﬁnitionDataFor-

Parm) 295

Add Parm Deﬁnition (addParmDeﬁnition) 295

Remove Parm Deﬁnition (removeParmDeﬁnition) 296

Assign Parm Deﬁnition To Owner (assignParmDeﬁnitionToOwner) 296

Remove Parm Deﬁnition To Owner (removeParmDeﬁnitionFromOwner) 296

Release, Version Information 297

Get the current version of OPI (getCurrentOPIVersion) 297

Get the versions of OPI supported (getSupportedOPIVersions) 297

Get the name of the current release (getReleaseName) 297

Groups 297

Add a group (addGroup) 298

Add groups (addGroups) 298

Modify a group (modifyGroup) 299

Remove a group (removeGroup) 299

Remove groups (removeGroups) 299

Get a group (getGroup) 299

Get a group by user name (getGroupByUsername) 300

Get groups for domain (getAllGroupsForDomain) 300

Get users in a group (getUsersByGroup) 300

Assign users to a group (assignGroupsToUser) 300

Remove user from group (removeGroupByUser) 301

Get groups for a user (getUserGroups) 301

Get a group (getGroupsByUsersByType) 301

Get all group types (getAllGroupTypes) 301

Remove all groups for user (removeAllUserGroups) 301

SIP Lines 302

Get SIP Line Audit Data By EndpointId (getSIPLineAuditData) 302

Get SIP Line Audit Data By UserName (getSIPLineAuditDataByUserName) 302

Get SIP Line Audit Data By Domain (getSIPLineAuditDataByDomain) 303

Get SIP Line Audit Data By Domain And VMG (getSIPLineAuditDataByDo-

mainByVMG) 303

Get Domains By VMG (getDomainsForVMG) 303

Get VMGs for Domain (getVMGForDomain) 303

Get Users By Registration State (getUsersByRegistrationState) 304

Get Users By Registration State And Client Type (getUsersByRegStateAnd-

ClientType) 304

Methods available only in OPI 304

Nortel Multimedia Communication Server 5100

Application Programming Interfaces Reference

NN42020-146 01.07 Standard

Release 4.0 19 October 2007

.

16 Contents

getAliasesForExpressMsging 305

getAliasesForMsgRetrieval 305

getAssistantTypes 305

getChairAccessURL 305

getConfDialUpNumbers 305

getWebCollabURL 305

getUserPicture 306

addUserPicture 306

modifyUserPicture 306

Subscriber Open Provisioning Interface overview 307

Security 307

Building SOPI clients 307

Building SOPI stub clients 307

Writing a client 308

Client sample code 310

Subscriber Open Provisioning Interface methods 313

User personal information 314

authenticateUser 314

changePassword 315

getUserPersonalData 315

modifyUserPersonalData 315

User time block groups 315

addTimeBlockGroup 315

addTimeBlockGroups 316

getTimeBlockGroupByName 316

getTimeBlockGroupsByUser 316

modifyTimeBlockGroup 316

Personalized call settings 316

getNotesByUserName 317

getRejectReasonsByUserName 317

getSubjectsByUserName 317

getUserData 317

modifyUserData 317

modifyUserNotes 317

modifyUserReasons 317

modifyUserSubjects 318

removeAllCallSubjects 318

removeAllRejectReasons 318

removeAllUserNotes 318

removeUserData 318

Address book 318

addAddressBookEntries 319

addAddressBookEntry 319

Nortel Multimedia Communication Server 5100

Application Programming Interfaces Reference

NN42020-146 01.07 Standard

Release 4.0 19 October 2007

.

Contents 17

getAddressBook 319

getAddressBookEntry 319

getAddressBookWithPhoto 320

getBuddies 320

getFullAddressBookEntry 320

getLightWeightAddressBook 320

makeBuddy 320

modifyAddressBookEntries 320

modifyAddressBookEntry 320

removeUserAddressBook 320

removeAddressBookEntries 321

removeAddressBookEntry 321

removeBuddy 321

Address book groups 321

addAddressBookGroup 321

addAddressBookGroups 322

addUsersToAddressBook 322

getAddressBookGroups 322

modifyAddressBookGroups 322

removeAddressBookGroup 322

renameAddressBookGroup 322

Global address book search 322

searchGABByFirstName 323

searchGABByFirstNameRange 323

searchGABByLastName 323

searchGABByLastNameRange 323

searchGABByName 324

searchGABByNameRange 324

searchGABByPhoneNumber 324

searchGABByPhoneNumberRange 324

searchGABByUserName 324

searchGABByUserNameRange 324

Call screening and routes 325

activateRoutes 325

addRoute 326

addRoutes 326

deactivateRoutes 326

getAllRouteParmNames 326

getRoute 326

getRouteNames 326

getRoutes 326

modifyRoute 326

removeAllRoutes 327

Nortel Multimedia Communication Server 5100

Application Programming Interfaces Reference

NN42020-146 01.07 Standard

Release 4.0 19 October 2007

.

18 Contents

removeRoute 327

reorderRoutes 327

setActiveRoutes 327

Service preferences 327

getAllUserPreferences 328

getUserServicePackage 328

modifyAllUserPreferences 328

modifyUserPreferences 328

removeAllUserPreferences 328

Service information 328

getParameterDisplayNameByParameterName 329

getParameterNameByParameterDisplayName 329

getServiceDisplayNameByServiceName 329

getServiceNameByServiceDisplayName 329

Meet Me service data 329

addMeetMeConfUser 330

getMeetMeConfData 330

modifyMeetMeConfUser 330

getConfDialUpNumbers 330

getWebCollabURL 330

getChairAccessURL 330

removeMeetMeConfUser 331

Call logs 331

deleteCallLogs 331

getCallLogs 331

getIncomingCallLogs 331

getOutgoingCallLogs 331

Time zones 332

getAllTimeZones 332

Locales 332

getSystemLocalesList 332

Password policy 332

getPasswordPolicyDescription 332

E911 location list 333

getLocationList 333

User picture 333

addUserPicture 333

getUserPicture 333

modifyUserPicture 334

removeUserPicture 334

Banned user 334

addBannedUser 334

addBannedUsers 334

Nortel Multimedia Communication Server 5100

Application Programming Interfaces Reference

NN42020-146 01.07 Standard

Release 4.0 19 October 2007

.

Contents 19

getBannedUsers 334

modifyBannedUser 335

removeAllBannedUsers 335

removeBannedUser 335

Assistant user manager 335

getAssistedUsers 335

Click To Call 335

clickToCall 336

I200x 336

logoutUserFromDevice 336

SOPI version 336

getCurrentSOPIVersion 336

getSupportedSOPIVersions 337

Error codes and messages 339

Data access error codes and messages (000000) 341

Directories error codes and messages (001000) 343

Address book error codes and messages (002000) 344

User Service Package error codes and messages (003000) 348

User Operation error codes and messages (004000) 350

Resource Management Exceptions error codes and messages (004100) 355

Subscriber OPI error codes and messages (004150) 356

Preﬁx error codes and messages (004200) 356

Domain error codes and messages (005000) 357

Address Book Group error codes and messages (006000) 359

Domain bulletins error codes and messages (007000) 359

Banned subscriber error codes and messages (008000) 359

Resource Management error codes and messages (009000) 360

Device error codes and messages (010000) 362

Domain COS error codes and messages (011000) 363

Domain Proﬁle error codes and messages (012000) 364

Domain locale error codes and messages (013000) 364

Global Address Book error codes and messages (014000) 365

Foreign domain error codes and messages (015000) 365

IPCM error codes and messages (016000) 367

Network call logs error codes and messages (017000) 368

Personal Address Book error codes and messages (018000) 368

Phone Number error codes and messages (019000) 368

Trunk and Gateway error codes and messages (020000) 369

Route error codes and messages (024000) 369

Service error codes and messages (025000) 372

Telephony Route error codes and messages (026000) 375

Status reason error codes and messages (027000) 378

Number qualiﬁer error codes and messages (028000) 379

Nortel Multimedia Communication Server 5100

Application Programming Interfaces Reference

NN42020-146 01.07 Standard

Release 4.0 19 October 2007

.

20 Contents

Time block group and Presence condition error codesand messages (029000) 380

Time zone error codes and messages (030000) 380

User Data error codes and messages (032000) 381

User time and Click to call error codes and messages (033000) 381

Voicemail error codes and messages (034000) 383

Reserved addresses error codes and messages (035000) 384

User properties error codes and messages (036000) 384

Music on Hold error codes and messages (037000) 384

Branding error codes and messages (038000) 385

Treatment error codes and messages (039000) 386

Assistant error codes and messages (040000) 387

User picture error codes and messages (041000) 389

Location error codes and messages (042000) 389

ErlInfo error codes and messages (043000) 391

Emergency alias error codes and messages (044000) 393

Emergency numbers error codes and messages (045000) 393

Meet Me Audio Conferencing related error codes and messages (046000) 394

Media Portal Group error codes and messages (046100) 395

Media Portal Routability Group error codes and messages (047000) 398

Auto ID error codes and messages (048000) 400

LDAP error codes and messages (049000) 400

Pooled Entity related error messages (050000) 402

Converged Desktop feature error messages (051000) 404

Voicemail server provisioning related error codes and messages (052000) 405

Password policy error codes and messages (055000) 408

SMS subscriber, SMPP conﬁguration and interworking domain error codes and

messages (056000) 409

Voicemail error codes and messages (057000) 410

Global address book error codes and messages (058000) 410

Service node error codes and messages (059000) 410

Admin and role related error codes and messages (060000) 414

Parm Deﬁnition error codes and messages (061000) 415

Out of band REFER error codes and messages (062000) 416

Ringback error codes and messages (063000) 416

Domain CLI error codes and messages (064000) 417

Translation tool error codes and messages (070000) 418

Presence error codes and messages (072000) 418

Group error codes and messages (089000) 418

System-speciﬁc exceptions and authorization error codes and messages

(099000) 420

Generic exceptions (099999) 421

Nortel Multimedia Communication Server 5100

Application Programming Interfaces Reference

NN42020-146 01.07 Standard

Release 4.0 19 October 2007

.

Page is loading ...

Nortel 5100 Series Release 2.3.3 Programming Reference Manual

Nortel 5100 Series Release 2.3.3 Programming Reference Manual

Related papers

Other documents