Nortel 5100 Programming Reference Manual
  1. Manuals
  2. Brands
  3. Nortel Manuals
  4. Server
  5. 5100 Series Release 2.3.3
  6. Programming reference manual

Nortel 5100 Programming Reference Manual

Application programming interfaces reference
Hide thumbs Also See for 5100:
1
2
3
4
Table Of Contents
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
Table of Contents

Advertisement

Quick Links

Download this manual See also: User Manual
Nortel Multimedia Communication Server 5100
Application Programming
Interfaces Reference
NN42020-146
.

Advertisement

Table of Contents
loading

Related Manuals for Nortel 5100

Summary of Contents for Nortel 5100

  • Page 1 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference NN42020-146...
  • Page 2 Users must take full responsibility for their applications of any products specified in this document. The information in this document is proprietary to Nortel Networks. Nortel, Nortel (Logo), and the Globemark are trademarks of Nortel Networks.

  • Page 3: Revision History

    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.
  • Page 4 4 Revision History Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference NN42020-146 01.07 Standard Release 4.0 19 October 2007 Copyright © 2007, Nortel Networks...

  • Page 5: Table Of Contents

    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...
  • Page 6 Angle brackets 63 Square brackets 63 Bar 64 Comma separated strings 64 Using fully qualified user names 65 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 7: Contents

    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 Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 8 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 Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 9 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 Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 10 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 Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 11 Get Direct To Gateway service prefix for a domain (getDirectToGWPrefix- Data) 241 Remove Direct To Gateway service prefix for a domain (removeDirectToGW- PrefixData) 241 Voicemail Operations 241 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 12 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 Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard...
  • Page 13 (getAvailableDomainLocations) 277 Get all existing configured Media Portal IP addresses (getAllMediaPortalRe- sourceIPs) 277 Add a new Media Portal Route (addMpRoutabilityGroup) 277 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 14 Add a Password Policy (addPasswordPolicy) 292 Modify a Password Policy (modifyPasswordPolicy) 292 Remove a Password Policy (removePasswordPolicy) 293 Parm Definition 293 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 15 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 Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 16 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 Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 17 326 deactivateRoutes 326 getAllRouteParmNames 326 getRoute 326 getRouteNames 326 getRoutes 326 modifyRoute 326 removeAllRoutes 327 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007 Contents 17...
  • Page 18 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 Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 19: Contents

    Telephony Route error codes and messages (026000) 375 Status reason error codes and messages (027000) 378 Number qualifier error codes and messages (028000) 379 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 20 Group error codes and messages (089000) 418 System-specific exceptions and authorization error codes and messages (099000) 420 Generic exceptions (099999) 421 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 21 Procedure 7 Procedure 8 Procedure 9 Procedure 10 Procedure 11 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Logical view of OPI interactions 31 Interactions of the stub 32 Sample folder for client stubs 39 Compiling the client stubs sample 40 Client stub class files sample 41...
  • Page 22 22 Contents Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference NN42020-146 01.07 Standard Release 4.0 19 October 2007 Copyright © 2007, Nortel Networks...

  • Page 23: New In This Release

    "Language support" (page 24) • "Multiple login restrictions" (page 24) For information about all the MCS 5100 Release 4.0 features, see MCS 5100 New in this Release (NN42020-404). Subscriber OPI productization The Subscriber Open Provisioning Interface (SOPI) provides an Application Programming Interface (API) for access to Personal Agent and Multimedia PC Client operations.

  • Page 24: Language Support

    Some methods have been removed for Release 4.0. Lists of new, changed, and deleted OPI and BPT methods are contained in deleted methods for OPI and BPT" (page This document merges the following MCS 5100 Release 3.5 books: • Open Provisioning Interface (NN42020-123) •...

  • Page 25: How To Get Help

    Communication System (MCS) 5100, go to the Technical Documentation page for MCS 5100. Getting help from the Nortel web site The best way to get technical support for Nortel products is from the Nortel Technical Support web site: www.nortel.com/support This site provides access to software, documentation, bulletins, and tools to address issues with Nortel products.

  • Page 26: Getting Help From A Specialist By Using An Express Routing Code

    To access some Nortel Technical Solutions Centers, you can use an Express Routing Code (ERC) to quickly route your call to a specialist in your Nortel product or service. To locate the ERC for your product or service, go to: www.nortel.com/erc...

  • Page 27: Application Programming Interfaces Overview

    Application Programming Interfaces overview MCS 5100 provides Application Programming Interface (API) support. There are two main APIs and one tool: • Open Provisioning Interface (OPI) • Subscriber Open Provisioning Interface (SOPI) • Bulk Provisioning Tool (BPT) OPI is the foundation for the BPT, as well as an API for third-party applications.

  • Page 28: Audience

    • System Management Console User Guide (NN42020-110) • Provisioning Manager Fundamentals (NN42020-114) • Alarm and Log Reference (NN42020-703) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 29: Open Provisioning Interface Overview

    A detailed description of the WSDL standard is available online at the W3C (World Wide Web Consortium) web site at www.w3.org/TR/wsdl. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard...

  • Page 30: Security

    To verify that the certificate is now in the BPT trust store, enter the following command (on one line) keytool -list -v -keystore opitruststore The tool displays the contents of the BPT trust store. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks —End—...

  • Page 31: Third-Party Client Development

    The WSDL file for MCS is stored on the System Manager server. Retrieve the file from the loads directory on the System Manager server, located at /var/mcp/loads/<loadname>/clientAPI/wsdl/opi/opi.wsdl Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Third-party client development 31 NN42020-146 01.07 Standard...

  • Page 32: Generate Stubs

    If the credentials are not present or validation fails, a SOAP fault is sent back to indicate the failure and the action is not performed. "Error codes and messages" (page 339) messages. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks contains a complete list of error NN42020-146 01.07 Standard...

  • Page 33: Access Stubs From The Third-Party Application

    The authorization includes both domain-level authorization and provisioning-level authorization. If either authorization fails validation, a SOAP fault is sent back, indicating the reason for failure, Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Authentication and authorization 33 NN42020-146 01.07 Standard...

  • Page 34: Provisioning Interface

    WSDL file. • simple types: — Boolean — Byte — Double — Float — Integer — Long Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 35: Success Indication On Remove Methods

    Manager. However, it can take up to 5 minutes before the same data is visible to clients connected to a second instance of a Provisioning Manager running in the system. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Domain Not found ’nn.com’...

  • Page 36: Prov606 Logs

    OPI. The logs are viewed in the System Management Console log browser and are described in the Provisioning Module Fundamentals (NN42020-111) document. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard...

  • Page 37: Open Provisioning Interface Clients

    Download the Axis toolkit The steps in this chapter use the Axis toolkit 1.1 final version. The Axis toolkit is a free download from the Apache Web site. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard...

  • Page 38: Configure The Classpath

    In your web browser, navigate to the Axis toolkit page on the Apache web site at ws.apache.org.axis. Nortel recommends the 1.1 final version. Download the 1.1 final version file, axis-1_1.zip, to your PC. Unzip the files to a drive on the PC.

  • Page 39: Download The Wsdl File

    Run the WSDL2JAVA tool on the WSDL file. For example: java org.apache.axis.wsdl.WSDL2Java -O -1 -d Session -Nurn:OPI com.client.opi.service opi.wsdl Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Open Provisioning Interface client stubs 39 —End—...

  • Page 40: Figure 4 Compiling The Client Stubs Sample

    Interactive Development Environment (IDE) such as netbeans or eclipse, and put them into a separate folder. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks see"Methods for OPI and BPT" (page Note: The OPISoapBindingStub.java, generated under...

  • Page 41: Write A Client To Perform Some Specific Opi Operations

    Instantiate the OPIServiceLocator. Instantiate a URL object that points to the Provisioning Server location and the OPI service running on it. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Write a client to perform some specific OPI operations 41 —End—...
  • Page 42 For the details of the addUser method, see OPI and BPT" (page An example is shown below. In the example, this class is placed under D:\opiclient. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks 79).

  • Page 43: Figure 6 Client Code Example

    OPI stubs and executed. During execution, the OPI stub classes and the Axis toolkit jars must be present in the classpath, as shown in the following figure. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Write a client to perform some specific OPI operations 43...

  • Page 44: Two Examples

    Example: creating a user route to screen two numbers The following example illustrates the creation of a user route that screens on two numbers and forwards them straight to voice. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard...

  • Page 45: Figure 8 Client Code Example - Creating A User Route

    Figure 8 Client code example - creating a user route Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007 Two examples 45...

  • Page 46: Example: Creating A Route Using Simultaneous Ringing

    The following example illustrates the creation of a route. It travels during after-hours, rings two given phone numbers simultaneously, and then rolls over to voice mail. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard...

  • Page 47: Figure 9 Client Code Example - Creating A Route

    Figure 9 Client code example - creating a route Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007 Two examples 47...

  • Page 48: Recommended Methods

    ProvisionException; Use this method to get all the root domain names in the system. It returns a String[] array of root domain names in alphabetical order. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard...

  • Page 49: Net Authentication Headers

    .NET client. The code must be added in the stub class so that it can hijack the request and add the headers to it. Figure 10 Authentication header sample Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 50 50 Open Provisioning Interface clients Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference NN42020-146 01.07 Standard Release 4.0 19 October 2007 Copyright © 2007, Nortel Networks...

  • Page 51: Bulk Provisioning Tool Introduction

    Do not use BPT for large transactions during regular business hours. In deployments where the BPT uses the same network (LAN) as the LAN processing sessions, large BPT transactions may impact network performance. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ATTENTION NN42020-146 01.07 Standard...

  • Page 52: Why Use The Bpt

    Log on requirement Limitations The Bulk Provisioning Tool only works with Java version 1.4. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Java 1.4 + JRE in the system classpath Compatible (tested) telnet terminals: •...

  • Page 53: Install And Launch The Bpt

    Provisioning server. The use of the BPT and available methods is the same for both access methods. Nortel recommends that administrators use the BPT on a workstation, allowing easier use of files and scripts, without affecting the performance of the server hosting the Provisioning Manager.

  • Page 54: Launch The Bpt On A Workstation

    Navigate to C:\Program Files\Java. b. Open the folder that contains 1.4 in the name. c. Open the bin folder and verify that the file java.exe is in this Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks "BPT Main Menu"...

  • Page 55: Launch The Bpt On The Provisioning Server

    Using SSH, connect to the provisioning server. Log on as nortel. Navigate to the directory /var/mcp/run/MCP_9.1/PROV<NE_in- stance>/wars/prov/downloads Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks For example, this file can reside in C:\Program Files\Java\j2re1.4.2_05\bin.

  • Page 56: Bpt Main Menu

    For example, to access the Domain Operations submenu, type 1 and press Enter. The BPT displays the Domain Operations menu selections. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks "BPT Main Menu"...

  • Page 57: Commands

    BPT commands BPT command 1 - 97 For information about BPT method syntax conventions and examples, see conventions and examples" (page Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Description Return to the previous menu.

  • Page 58: Files And Scripts

    The contents of the text files (*.txt) use the comma separated value (CSV) format. By using this format, files can be generated by, or imported into, third-party applications that recognize the CSV file content. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Description Execute all methods inside the specified file.

  • Page 59: Scripts

    1000 entries each. If an error occurs in a block of 1000 entries, such as a user name already in use, the complete 1000 entries are not processed. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks "Methods for OPI and BPT"...

  • Page 60: Resource Use

    BPT residing on a workstation. Performing the task on a server can affect the performance of in-progress sessions using the component services running on the server. Nortel recommends using the BPT during off-peak times or maintenance windows when large amounts of information are being added. Provisioning data visibility...

  • Page 61: Bulk Provisioning Tool Conventions And Examples

    1 The BPT displays the BPT method syntax, followed by the required file syntax, as shown in the following figure. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard...

  • Page 62: Optional Syntax

    To write the returned information to the screen, you use the syntax: getSysRoles To write the returned information to a file named roles.txt, you use the syntax: Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard...

  • Page 63: Brackets

    .. Right Type,The Read privilege,The write privilege,The delete privilege]]]) | file <file name> [optional] into <file name> Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Method and file syntax conventions 63 NN42020-146 01.07 Standard...

  • Page 64: Bar

    Zone,Locale,Provisioning Role,[The list of Domains that he is assigned to, .. assigned to]]) | file <file name> [optional] into <file name> Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,The list of Domains that he is NN42020-146 01.07 Standard...

  • Page 65: Using Fully Qualified User Names

    BPT methods map to fields in the Provisioning Client. Mapping of the addRole method to the Provisioning Client window fields The BPT method for adding a new role has the following syntax: Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Example - adding a new provisioning role 65 Domain Not found ’nn.com’, because the domain...

  • Page 66: Defining A New Role To Add

    Defining a new role to add If you want to add a new role with the following properties: Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Figure 15 "Add a New Role in the 66).
  • Page 67 Management,true,true,false],[Device Management,true,false,false],[Admin,true,true,true]]] The same task performed in the Provisioning Client involves the fields highlighted in the following figure. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Example - adding a new provisioning role 67...

  • Page 68: Performing The Add Method

    To invoke the method, enter the following in the BPT command line: addRole using file D:\prov\addexample.txt The BPT indicates whether the method succeeded or failed, as shown in the following figure. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard...

  • Page 69: Viewing The Details Of The New Role

    The BPT returns the following information. It is identical to the file contents used to create the new role. [AddExample,BPT add example,[[Domain Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Example - adding a new provisioning role 69 NN42020-146 01.07 Standard...

  • Page 70: Figure 19 Getrole Results As Viewed In The Provisioning Client

    Admins > List Roles > View Details. The Provisioning Client displays the following (the affected fields are highlighted). Figure 19 GetRole results as viewed in the Provisioning Client Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard...

  • Page 71: Deleting The Role

    The BPT indicates whether the method succeeded or failed, as shown in the following figure. Figure 20 removeRole method invoked on the BPT Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Example - adding a new provisioning role 71 NN42020-146 01.07 Standard...
  • Page 72 72 Bulk Provisioning Tool conventions and examples Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference NN42020-146 01.07 Standard Release 4.0 19 October 2007 Copyright © 2007, Nortel Networks...

  • Page 73: New, Changed, And Deleted Methods For Opi And Bpt

    "Client Type Information" (page 144) "User SIP Line Data Operations" (page submenu "Client Type Information" (page 144) not supported in MCS 5100 Release 4.0 "Node Operations" (page 200) "Node Operations" (page 200) "Node Operations" (page 200) "Node Operations" (page 200) NN42020-146 01.07 Standard...
  • Page 74 Located in the following BPT menu: "Domain Operations" (page 80) "Parm Definition" (page 293) "Voicemail Operations" (page 241) not supported in MCS 5100 Release 4.0 "Telephony Routes Operations" (page 225) "Domain Operations" (page Desktop Service Data" (page 92) "Node Operations" (page 200) "Pool Management"...
  • Page 75 "Node Operations" (page 200) "Node Operations" (page 200) "Voicemail Operations" (page 241) "Voicemail Operations" (page 241) not supported in MCS 5100 Release 4.0 not supported in MCS 5100 Release 4.0 "Pool Management" (page 210) "Pool Management" (page 210) "Methods available only in OPI" (page 304) not supported in MCS 5100 Release 4.0...

  • Page 76: Voicemail Operations

    Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Located in the following BPT menu: "Node Operations" (page 200) "Domain Operations" (page 80) "Domain Operations" (page 80) "Service Operations" (page 176) "Service Operations"...
  • Page 77 Methods added in this release 77 Located in the following BPT menu: "Voicemail Operations" (page 241) "Location Services" (page 219) not supported in MCS 5100 Release 4.0 "Addressbook Operations" (page 254) "User SIP Line Data Operations" (page submenu "Client Type Information" (page 144) not supported in MCS 5100 Release 4.0...

  • Page 78: Methods Changed In This Release

    Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks New declaration getServicePackage(java.lang.String domain, java.lang.String name) modifyServicePackage(java.lang.String domain, java.lang.String name, com.nortelnetworks .ims.base.prov.opi.shared.ServicePackage servicePackage) setDefaultServicePackageToDomain(java.lang .String domain, java.lang.String name) NN42020-146 01.07 Standard...

  • Page 79: Methods For Opi And Bpt

    "Resource Management" (page 281) • "LicenseKey Usage" (page 283) • "LDAP Syncing" (page 284) • "Password Policy Operations" (page 291) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 80: Domain Operations

    "Domain Class of Service Operations" (page 87) • "Domain Profile Operations" (page 88) • "Banned Subscriber Operations" (page 89) • Domain CLI Operations (not supported by MCS 5100) • "Converged Desktop Service Data" (page 92) • "Add a root domain (addRootDomain)" (page 97) •...

  • Page 81: Domain Locale Operations

    BPT Method Syntax addDomainLocales using (Domain name,[Locale descriptions, , Locale descriptions]) | file <file name> [optional] into <file name> Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 82 (Domain name) | file <file name> [optional] into <file name> BPT Required file format Domain name Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 83 (Domain name, Locale description) | file <file name> [optional] into <file name> BPT Required file format Domain name, Locale description Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks , Locale descriptions]) | file <file NN42020-146 01.07 Standard...

  • Page 84: Status Reasons Operations

    .opi.shared.ProvisionException; Note: The Status Reason URL parameter is reserved for future use. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 85 BPT Method Syntax getAllStatusNames [optional] into <file name> OPI method public java.lang.String[] getAllStatusNames() throws java.rmi.RemoteException, com.nortelnetworks.ims.base.prov .opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007 Domain Operations 85...
  • Page 86 Name,Status Reason Description,Status Reason URL] OPI method public void modifyStatusReason(java.lang.String domain, java.lang.String status, java.lang.String name, com.nortelnetworks.ims.base.prov.opi.shared.StatusReason updateObj) throws java.rmi.RemoteException, com.nortelnetwo rks.ims.base.prov.opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 87: Domain Class Of Service Operations

    Description]] OPI method public void modifyDomainCos(java.lang.String domain, com.nortelnetworks.ims.base.prov.opi.shared.DomainCos[] newCos) throws java.rmi.RemoteException, com.nortelnetworks .ims.base.prov.opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,[Class of Service,Class of ,[Class of Service,Class of Service NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 88: Domain Profile Operations

    (Domain name) | file <file name> [optional] into <file name> BPT Required file format Domain name Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 89: Banned Subscriber Operations

    "Get all banned subscribers in a domain (getBannedSubscribersBy- Domain)" (page 91) • "Get all banned service options names (getBanServiceOptionNames)" (page 91) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 90 OPI method public void addBannedSubscribers(java.lang.String domain, com.nortelnetworks.ims.base.prov.opi.shared.BannedSubscribe r[] newObj) throws java.rmi.RemoteException, com.nortelnetw orks.ims.base.prov.opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks reason for banning),Banned service]) | file reason for banning),Banned ,[Party address,Description (eg.
  • Page 91 Domain name, Banned Subscriber UserName OPI method public void removeBannedSubscriber(java.lang.String domain, java.lang.String party) throws java.rmi.RemoteException, com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce ption; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007 Domain Operations 91...

  • Page 92: Converged Desktop Service Data

    "Remove the Converged Desktop Service data from a domain (removeConvDesktopServiceData)" (page 94) • "Add Mobile converged audio device prefix for a domain (assignDomainMCPrefixData)" (page 95) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks , Banned Subscriber UserNames NN42020-146 01.07 Standard...
  • Page 93 DN is the digits needed to route a call to a PRI Gateway,Number Qualifier entry needed to qualify the Service DN]) | file <file name> [optional] into <file name> BPT Required file format Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 94: Domain Operations

    <file name> [optional] into <file name> BPT Required file format Domain name OPI method public void removeConvDesktopServiceData(java.lang.String domainName) throws java.rmi.RemoteException, com.nortelnetw orks.ims.base.prov.opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 95 BPT Required file format Domain name OPI method public void removeDomainMCPrefixData(java.lang.String domain) throws java.rmi.RemoteException, com.nortelnetworks .ims.base.prov.opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007 Domain Operations 95...
  • Page 96 Click to Dial feature for private terminations] OPI method public void modifyOOBReferAccessCodes(java.lang.String domainName, com.nortelnetworks.ims.base.prov.opi.shared.O OBReferService newData) throws java.rmi.RemoteException, com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce ption; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 97: Add A Root Domain (Addrootdomain)

    ,[Name,Value]] OPI method public void addRootDomain(com.nortelnetworks.ims.base.prov .opi.shared.Domain domain) throws java.rmi.RemoteException, com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce ption; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,[Name,Value]]]) | file <file NN42020-146 01.07 Standard Release 4.0 19 October 2007 Domain Operations 97...

  • Page 98: Add A Sub Domain (Addsubdomain)

    (Domain name) | file <file name> [optional] into <file name> BPT Required file format Domain name Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks , Domain aliases],Location]) | file <file ,[Name,Value]],[Domain aliases, ..

  • Page 99: Get All Root Domain Parameters (Getallrootdomainparms)

    Get all domains (getAllDomains) BPT Method Syntax getAllDomains [optional] into <file name> Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 100: Get A Domain By Name (Getdomain)

    (Domain name) | file <file name> [optional] into <file name> BPT Required file format Domain name Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 101: Get The Root Domain Of A Domain (Getrootdomain)

    ,The Aliases associated with this Domain]] OPI method public void addForeignDomain(com.nortelnetworks.ims .base.prov.opi.shared.ForeignDomain forDomain) throws java.rmi.RemoteException, com.nortelnetworks.ims.base.prov .opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,The Aliases associated NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 102: Get A Foreign Domain (Getforeigndomain)

    (Foreign Domain name) | file <file name> [optional] into <file name> BPT Required file format Foreign Domain name Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,The Foreign Routes associated with this ,The Aliases associated NN42020-146 01.07 Standard...

  • Page 103: Get Domains Subset (Getdomains)

    BPT Required file format Domain name OPI method public java.lang.String[] getAllChildrenDomainNames(java .lang.String rootDomain) throws java.rmi.RemoteException, com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce ption; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007 Domain Operations 103...

  • Page 104: Get The Domain Count In The System (Getnumberofdomains)

    Format,Idle Display,Location,Locale,Time Zone,IPCM name,[The users on this Device, .. Device]]) | file <file name> [optional] into <file name> BPT Required file format Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 105: Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference

    OPI method public void addDevices(java.lang.String domainName, com.nortelnetworks.ims.base.prov.opi.shared.Device[] devices) throws java.rmi.RemoteException, com.nortelnetwork s.ims.base.prov.opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,The users on this Device]] ,The users on this Device]], .. ,The users on this Device]] NN42020-146 01.07 Standard...

  • Page 106: Modify A Device (Modifydevice)

    Domain name, MAC Address OPI method public void removeDevice(java.lang.String domainName, java .lang.String macaddress) throws java.rmi.RemoteException, com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce ption; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007 ,The users...

  • Page 107: Remove Devices (Removedevices)

    Domain name,[ MAC Addresses, .. OPI method public com.nortelnetworks.ims.base.prov.opi.shared.Device[] getDevices(java.lang.String domainName, java.lang.String[] macaddr) throws java.rmi.RemoteException, com.nortelnetwork s.ims.base.prov.opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks , MAC Addresses] NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 108: Get Devices By Domain (Getdevicesindomain)

    [optional] into <file name> BPT Required file format MAC Address OPI method public com.nortelnetworks.ims.base.prov.opi.shared.NameVa lue[] getDeviceByMacAddress(java.lang.String macAddress) throws java.rmi.RemoteException, com.nortelnetworks.ims.bas e.prov.opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 109: Get Subdomain For Device (Getsubdomainfordevice)

    [Name of the IPCM,The IPCM Capacity,[[IPCM capacity assigned to this Domain,Domain Name,Activation Key], ,[IPCM capacity assigned to this Domain,Domain Name,Activation Key]]] Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,[IPCM capacity assigned to this Domain,Domain NN42020-146 01.07 Standard...

  • Page 110: Modify A Single Ipcm (Modifyipcm)

    Remove a single IPCM (removeIPCM) BPT Method Syntax removeIPCM using (IPCM name) | file <file name> [optional] into <file name> Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,[IPCM capacity assigned to this ,[IPCM capacity assigned to this Domain,Domain NN42020-146 01.07 Standard...

  • Page 111: Get Available Capacity For An Ipcm (Getipcmavailcapacity)

    (IPCM name, Domain name) | file <file name> [optional] into <file name> BPT Required file format IPCM name, Domain name Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 112: Remove Physical Ipcm (Deletephysicalipcm)

    • "User Meet Me Conferencing Operations" (page 137) • "User Watcher Operations" (page 140) • User Unified Communications Operations (not supported by MCS 5100) • "User Converged Desktop Operations" (page 141) • "User SIP Line Data Operations" (page 144) •...

  • Page 113: User Data Operations

    Remove all subjects for a user (removeAllCallSubjects) BPT Method Syntax removeAllCallSubjects using (User name) | file <file name> [optional] into <file name> BPT Required file format Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks , Subjects] NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 114 BPT Method Syntax removeAllRejectReasons using (User name) | file <file name> [optional] into <file name> BPT Required file format User name Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks , Reasons] NN42020-146 01.07 Standard...
  • Page 115 Remove user data (removeUserData) BPT Method Syntax removeUserData using (User name) | file <file name> [optional] into <file name> Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,The reason information for a user],[The NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 116 BPT Method Syntax removeAllUserNotes using (User name) | file <file name> [optional] into <file name> BPT Required file format User name Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks , Notes] NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 117: User Call Log Operations

    BPT Required file format User name OPI method public com.nortelnetworks.ims.base.prov.opi.shared.Ca llLog[] getCallLogs(java.lang.String username) throws java.rmi.RemoteException, com.nortelnetworks.ims.base.prov .opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007 User Operations 117...
  • Page 118 User name, [ Call ID, .. OPI method public void deleteCallLogs(java.lang.String username, java .lang.String[] callIds) throws java.rmi.RemoteException, com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce ption; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks , Call ID] NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 119: User Times Operations

    Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,The days of the week that the time range ,[The time that begins this time block.,The ,The days of the week that the NN42020-146 01.07 Standard...
  • Page 120 BPT Method Syntax removeTimeBlockGroup using (User name, Time Block Group name) | file <file name> [optional] into <file name> Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,The days of the week that the time | file <file name>...
  • Page 121 ,The days of the week that the time range applies.]]]] Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,The days of the week that the time | file <file name>...

  • Page 122: Route Operations

    • "Add a new route for a user (addRoute)" (page 124) • "Add multiple routes for a user (addRoutes)" (page 125) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 123 "Generate CPL for a user (generateCPL)" (page 134) • "Get CPL for a user (getCPL)" (page 135) • Set Ringtone—not supported in MCS 5100 Release 4.0 • Remove Ringtone—not supported in MCS 5100 Release 4.0 • Get Ringtone—not supported in MCS 5100 Release 4.0...
  • Page 124 .. this condition or exception]], .. condition or exception,[The values associated with this condition or exception, .. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,The set of actions that would trigger this route that callers hear], ..
  • Page 125 .. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,[The type of route condition or ,The values associated with this condition route that callers hear], ..
  • Page 126 .. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks route that callers hear], ..
  • Page 127 .. ,[The name of a route defined by this user,Specify if this particular route is active or inactive,[The set of actions that would trigger this route, .. , Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks...
  • Page 128 Route Names list]) | file <file name> [optional] into <file name> BPT Required file format User name,[ Route Names list, .. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,The values associated ,The values associated with route that callers hear], ..
  • Page 129 BPT Required file format User name OPI method public java.lang.String[] getRouteNames(java.lang.String userName) throws java.rmi.RemoteException, com.nortelnetwor ks.ims.base.prov.opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007 User Operations 129...
  • Page 130 .. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,The set of actions that...
  • Page 131 -or- [Name,[[Name,Value], .. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,[Name,Value]]]]) | file <file...
  • Page 132 [optional] into <file name> BPT Required file format User name OPI method public java.lang.String[] getStaticRoutesByUserName(java.la ng.String userName) throws java.rmi.RemoteException, com.no rtelnetworks.ims.base.prov.opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 133 User name, Route Name OPI method public void removeRoute(java.lang.String userName, java.lan g.String routeName) throws java.rmi.RemoteException, com.no rtelnetworks.ims.base.prov.opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks , Route name] , Route name] NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 134 BPT Required file format User name OPI method public void generateCPL(java.lang.String userName) throws java.rmi.RemoteException, com.nortelnetworks.ims.base.prov .opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks , Route names list] , Route names list] NN42020-146 01.07 Standard...

  • Page 135: User Service Operations

    BPT Required file format userName OPI method public com.nortelnetworks.ims.base.prov.opi.shared.Service Package getUserServicePackage(java.lang.String userName) throws java.rmi.RemoteException, com.nortelnetworks.ims.bas e.prov.opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007 User Operations 135...
  • Page 136 BPT Required file format Username, Service data OPI method public void modifyUserPreferences(java.lang.String userN ame, com.nortelnetworks.ims.base.prov.opi.shared.Service service) throws java.rmi.RemoteException, com.nortelnetwork s.ims.base.prov.opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 137: User Meet Me Conferencing Operations

    "Get Meet Me Conferencing data for a user (getMeetMeConfData)" (page 139) • "Get Meet Me Conferencing data for a domain (getMeetMeConfDataBy- Domain)" (page 140) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,[Name,Value]]], .. ,[Name,Value]]]]) | file ,[Name of the service,[[Name,Value], NN42020-146 01.07 Standard...
  • Page 138 (true/false).,E-mail address where recorded conferences will be sent.]) | file <file name> [optional] into <file name> BPT Required file format Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks | file <file name> [optional] into <file NN42020-146 01.07 Standard...
  • Page 139 User name OPI method public com.nortelnetworks.ims.base.prov.opi.shared.MeetMeCo nfData getMeetMeConfData(java.lang.String userName) throws java.rmi.RemoteException, com.nortelnetworks.ims.base.prov .opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks digit unique numeric access chair leaves,Denotes whether Instant chair. Reserved for future use.,4-10 audible tone when participants enter and NN42020-146 01.07 Standard...

  • Page 140: User Watcher Operations

    BPT Method Syntax getUserWatchers using (UserName) | file <file name> [optional] into <file name> BPT Required file format UserName Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 141: User Converged Desktop Operations

    IN serving this user, either USP or M1]) | file <file name> [optional] into <file name> BPT Required file format Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 142 [optional] into <file name> BPT Required file format User name OPI method public void removeConvDesktopUserData(java.lang.String userName) throws java.rmi.RemoteException, com.nortelnetwor ks.ims.base.prov.opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 143 BPT Required file format userName OPI method public java.lang.String getUserMCPrefixData(java.lang.Strin g username) throws java.rmi.RemoteException, com.nortelnetw orks.ims.base.prov.opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007 User Operations 143...

  • Page 144: User Sip Line Data Operations

    "Get All Client Types (getClientTypes)" (page 146) • "Get a Client Type by name (getClientTypeByName)" (page 146) Add a Client Type (addClientType) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 145 .opi.shared.ProvisionException; Modify a Client Type (modifyClientType) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,[The name of the client which can NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 146 [optional] into <file name> OPI method public com.nortelnetworks.ims.base.prov.opi.shared.Client Type[] getClientTypes() throws java.rmi.RemoteException, com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce ption; Get a Client Type by name (getClientTypeByName) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 147 OPI method public com.nortelnetworks.ims.base.prov.opi.shared.SIPLin eData getSIPLineData(java.lang.String endPointId) throws java.rmi.RemoteException, com.nortelnetworks.ims.base.prov .opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks , The type of client associated to the user NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 148 Domain name, vmg, start, stop OPI method public com.nortelnetworks.ims.base.prov.opi.shared.SIPL ineData[] getSIPLineDataByDomainByVMG(java.lang.String domain, java.lang.String vmg, int start, int stop) throws java.rmi.RemoteException, com.nortelnetworks.ims.base.prov .opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 149: Assistant Support Operations

    "Determine if an assistant is provisioned for a user (isAssistantForUser)" (page 151) • "Remove assisted users for an assistant (removeAssistedUsers)" (page 152) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 150 BPT Method Syntax getAllAssistantsForUser using (User) | file <file name> [optional] into <file name> BPT Required file format User Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 151 (User,Assistants) | file <file name> [optional] into <file name> BPT Required file format User, Assistants Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks , List of assisted users]) | file <file name>...
  • Page 152 List of assistants]) | file <file name> [optional] into <file name> BPT Required file format User,[ List of assistants, .. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks , List of assisted users]) | file <file name>...

  • Page 153: User Search Operations

    (searchGABByNameRange)" (page 156) • "Retrieve users from the users domain that have a matching phone number (searchGABByPhoneNumberRange)" (page 157) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 154 (Username, Name) | file <file name> [optional] into <file name> BPT Required file format Username, Name Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 155 OPI method public com.nortelnetworks.ims.base.prov.opi.shared.Full AddressBookEntry[] searchGABByUserName(java.lang.String userName, java.lang.String searchUserName) throws java.rmi.RemoteException, com.nortelnetworks.ims.base.prov .opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007 User Operations 155...
  • Page 156 (Username, Name, Start Index, Stop Index) | file <file name> [optional] into <file name> BPT Required file format Username, Name, Start Index, Stop Index Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard...

  • Page 157: User Management Operations

    User Management Operations This section contains the following: • "Add a single user (addUser)" (page 158) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007 User Operations 157...
  • Page 158 ID,Public Charge ID,VPN Number,Class of service,Redirection Class of service,Time zone,User Locale,User service package,[List of User aliases, .. aliases],[List of blended aliases, .. aliases],[User routes, .. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,User routes],[Display NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 159 IPCM]]]]) | file <file name> [optional] into <file name> BPT Required file format Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,User routes],[Display ,[The user name,Users first name,Users last NN42020-146 01.07 Standard...
  • Page 160 ,List of User aliases],[List of blended aliases, ,List of blended aliases],[User routes, .. routes],[Display name,Registration timer give in seconds,Name of the IPCM],Location,Directory Number of the user] Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,User routes],[Display NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 161 (User name) | file <file name> [optional] into <file name> BPT Required file format User name Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 162 (Domain name, User name) | file <file name> [optional] into <file name> BPT Required file format Domain name, User name Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 163 (User name) | file <file name> [optional] into <file name> BPT Required file format User name Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 164 (From Domain name,To Domain name, User name) | file <file name> [optional] into <file name> BPT Required file format From Domain name,To Domain name, User name Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard...
  • Page 165 (User name) | file <file name> [optional] into <file name> BPT Required file format User name Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks , User names]) | file <file name> [optional] NN42020-146 01.07 Standard...
  • Page 166 (Domain name) | file <file name> [optional] into <file name> BPT Required file format Domain name Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 167: User Voicemail Operations

    | file <file name> [optional] into <file name> BPT Required file format Domain name,User name,[Voice mail,Voicemail server] Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 168: User Direct To Gateway Operations

    "Get Direct to Gateway service prefix for a user (getUserDirectToG- WPrefixData)" (page 169) • "Remove Direct to Gateway service prefix for a user (removeUserDirectToGWPrefixData)" (page 169) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 169 BPT Required file format User name OPI method public void removeUserDirectToGWPrefixData(java.lang.String username) throws java.rmi.RemoteException, com.nortelnetwor ks.ims.base.prov.opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007 User Operations 169...

  • Page 170: Logout All User Contacts (Sendunregister)

    "Reset password (resetAdminPassword)" (page 176) Role Operations This section contains the following: • "Add a new Role (addRole)" (page 171) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 171 Role,[[The Provisioning Right Type,The Read privilege,The write privilege,The delete privilege], .. ,[The Provisioning Right Type,The Read privilege,The write privilege,The delete privilege]]] Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,[The Provisioning Right Type,The Read NN42020-146 01.07 Standard...
  • Page 172 Get all system roles (getSysRoles) BPT Method Syntax getSysRoles [optional] into <file name> OPI method public java.lang.String[] getSysRoles() throws java.rmi.RemoteException, com.nortelnetworks.ims.base.prov .opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 173: Add An Admin (Addadmin)

    OPI method public void addAdmin(com.nortelnetworks.ims.base.prov.opi.s hared.Admin admin) throws java.rmi.RemoteException, com.nor telnetworks.ims.base.prov.opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,The list of Domains that he is NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 174: Modify An Admin (Modifyadmin)

    BPT Method Syntax getAdmin using (Admin name) | file <file name> [optional] into <file name> BPT Required file format Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 175: Get All Admins (Getalladmins)

    BPT Required file format New password OPI method public void changeAdminPassword(java.lang.String newPassword) throws java.rmi.RemoteException, com.nortelnet works.ims.base.prov.opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007 Admin Operations 175...

  • Page 176: Reset Password (Resetadminpassword)

    "Get parameter names for all services (getParmNamesForAllServices)" (page 184) • "Get all acceptable values for given parameter (getServiceParmValues)" (page 184) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 177: Service Package Operations

    <file name> BPT Required file format Domain name,[Name of the Service Package,[[Name of the service,[[Name,Value], .. the service,[[Name,Value], .. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,[Name of the service,[[Name,Value], ,[Name,Value]]], .. ,[Name,Value]]]]] NN42020-146 01.07 Standard...
  • Page 178 (Domain name, Service package name,[Name of the Service Package,[[Name of the service,[[Name,Value], .. the service,[[Name,Value], .. <file name> [optional] into <file name> Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,[Name,Value]]], .. ,[Name,Value]]]]]) | file NN42020-146 01.07 Standard...
  • Page 179 OPI method public void removeServicePackages(java.lang.String domain, java.lang.String[] names) throws java.rmi.RemoteException, com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce ption; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,[Name of the service,[[Name,Value], , Service package names]) | file <file name> NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 180 BPT Method Syntax DefaultServicePackageByDomain BPT Required file format OPI method Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 181: Get All Services Assigned To A Domain (Getservicesbydomain)

    BPT Required file format Domain name OPI method public void removeServicesByDomain(java.lang.String domain) throws java.rmi.RemoteException, com.nortelnetworks.ims.bas e.prov.opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007 Service Operations 181...

  • Page 182: Modify Services Assigned To A Domain (Modifydomainservices)

    <file name> BPT Required file format [Domain name list, .. service,[[Name,Value], .. the service,[[Name,Value], .. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,[Name of the service,[[Name,Value], ,Domain names list],[[Name of the ,[Name,Value]]], ..

  • Page 183: Modify The Acceptable Parameter Values For A Service (Modifyserviceparm)

    Get all service names (getAllServiceNames) BPT Method Syntax getAllServiceNames [optional] into <file name> Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks , Parameter values]) | file <file NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 184: Get Parameter Names For A Service (Getparmnamesbyservice)

    BPT Required file format Service name, Parameter name OPI method public java.lang.String[] getServiceParmValues(java.lang.St ring serviceName, java.lang.String parmDisplayName) throws java.rmi.RemoteException, com.nortelnetworks.ims.base.prov .opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 185: Get Parameter Display Name By Parameter Name (Getparameterdisplayname-Byparametername)

    (Service Name) | file <file name> [optional] into <file name> BPT Required file format Service Name Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 186: Get Service Name By Service Display Name (Getservicenamebyservicedis- Playname)

    This section contains the following: • "Music On Hold " (page 186) • "Branding" (page 190) • Crbt—not supported by MCS 5100 Release 4.0 • "Treatment" (page 194) Music On Hold This section contains the following: • "Add Music on Hold folder to a pooled resource (addMusicOnHoldFolder)"...
  • Page 187 Assign Music on Hold folder and pooled resource to domain (assignMusicOnHoldFolder) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks , Folders list]) | file <file name> NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 188 OPI method public java.lang.String getAssignedMusicOnHoldFolder(jav a.lang.String domain, java.lang.String poolName) throws java.rmi.RemoteException, com.nortelnetworks.ims.base.prov .opi.shared.ProvisionException; Get the assigned Music Pool (getAssignedMusicOnHoldPool) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 189 Remove All Music On Hold Folders (removeAllMusicOnHoldFolders) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 190 (Domain name, Pool Name, File Name) | file <file name> [optional] into <file name> BPT Required file format Domain name, Pool Name, File Name Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks 192)Get the assigned branding pool for a domain NN42020-146 01.07 Standard...
  • Page 191 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks , Files list]) | file <file name> [optional] into...
  • Page 192 (Domain name) | file <file name> [optional] into <file name> BPT Required file format Domain name Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 193 (Domain name, Pooled Resource Name) | file <file name> [optional] into <file name> BPT Required file format Domain name, Pooled Resource Name Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 194 • "Remove all treatment files in a pooled resource (removeAllTreatment- Files)" (page 200) Add treatment file to a pooled resource (addTreatmentFile) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 195 [optional] into <file name> BPT Required file format Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks , Files list]) | file <file name> [optional] into | file <file name>...
  • Page 196 Domain name OPI method public java.lang.String[] getTreatmentGroupNames(java.lang .String domain) throws java.rmi.RemoteException, com.nortel networks.ims.base.prov.opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,Collection of files associated ,Collection of reasons associated with a NN42020-146 01.07 Standard...
  • Page 197 .String domain) throws java.rmi.RemoteException, com.nortel networks.ims.base.prov.opi.shared.ProvisionException; Get names of all treatment files that are available in a group (getAvailableTreatmentFiles) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 198 <file name> [optional] into <file name> BPT Required file format Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,Collection of files associated ,Collection of reasons associated with a NN42020-146 01.07 Standard...
  • Page 199 Domain name, Treatment Group Name OPI method public void removeTreatmentGroup(java.lang.String domain, java.lang.String groupName) throws java.rmi.RemoteExcept ion, com.nortelnetworks.ims.base.prov.opi.shared.Provisi onException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007 Pooled Entity 199...

  • Page 200: Node Operations

    "Get sub domains for a node (getNodeSubDomains)" (page 208) • "Get all node names for sub domains (getAllNodeNamesForDomain)" (page 208) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 201: Get All Node Type Names (Getallnodetypenames)

    2. If you use a Node Address Type of DNS, the Address Name parameter can be any value. You use the DNS type to add nodes to the external domain. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks...

  • Page 202: Add Multiple Nodes (Addnodes)

    <file name> BPT Required file format Node name,[Node Name,Node Address information,Node Address Type: IP or DNS,Node Information,[[Name,Value], .. ,[Name,Value]]] Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,Node type information,Node Location rmation,Node Location...

  • Page 203: Remove A Node (Removenode)

    BPT Required file format Node name OPI method public com.nortelnetworks.ims.base.prov.opi.shared.Node getNode(java.lang.String nodeName) throws java.rmi.RemoteEx ception, com.nortelnetworks.ims.base.prov.opi.shared.Pro visionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007 Node Operations 203...

  • Page 204: Get All Nodes (Getallnodes)

    ,[Name,Value]],Routing Weight: OPI method public void addLogicalEntity(com.nortelnetworks.im s.base.prov.opi.shared.LogicalEntity node) throws java.rmi.RemoteException, com.nortelnetworks.ims.base.prov .opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks only Weighted Average 0-10]]]) | file <file name> [optional] ,[Name,Value]],Routing Weight: ,[Route Name,Node Name, [[Name,Value], ..

  • Page 205: Add Multiple Logical Entitys (Addlogicalentitys)

    [Name,Value]],Routing Weight: 0-10], .. ,[Route Name,Node Name,[[Name,Value], .. , [Name,Value]],Routing Weight: 0-10]]]) | file <file name> [optional] into <file name> BPT Required file format Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks 0-10], .. ,[Route Name,Node [Name,Value]],Routing Weight: NN42020-146 01.07 Standard...

  • Page 206: Remove A Logical Entity (Removelogicalentity)

    Get All Logical Entitys (getAllLogicalEntitys) BPT Method Syntax getAllLogicalEntitys [optional] into <file name> Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,Pooled Entity Services], [[Route Name,Node ,[Name,Value]],Routing Weight: ,[Route Name,Node Name,[[Name,Value], ..

  • Page 207: Get Logical Entity Count (Getlogicalentitycount)

    [optional] into <file name> BPT Required file format Parent Domain Name, Node Name,[ Sub domains, .. domains] Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks | file <file name> [optional] , Root Domains] , ..

  • Page 208: Get Root Domains For A Node (Getnodedomains)

    (Domain Name) | file <file name> [optional] into <file name> BPT Required file format Domain name Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 209: Get All Nodes For The Root Domain (Getdomainnodes)

    .opi.shared.ProvisionException; Get all Routable Service Groups (getAllRoutableServiceGroups) BPT Method Syntax getAllRoutableServiceGroups [optional] into <file name> Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007 Node Operations 209...

  • Page 210: Pool Management

    Domain name, Routable Service name OPI method public java.lang.String[] getAllNodesByRoutableService(j ava.lang.String domain, java.lang.String service) throws java.rmi.RemoteException, com.nortelnetworks.ims.base.prov .opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 211: Get All Nodes By Routable Service Groups (Getallnodesbyroutableservice-Group)

    Location Name, Routable Service Group name) | file <file name> [optional] into <file name> BPT Required file format Domain name, Location Name, Routable Service Group name Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 212: Get Routing Locations By Service Group (Getalllocationsfornodebyservice-Group)

    Domain name, Routable Service Group name OPI method public java.lang.String[] getAllAvailableLocationsByService Group(java.lang.String domain, java.lang.String service) throws java.rmi.RemoteException, com.nortelnetworks.ims.bas e.prov.opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 213: Assign Node To Domain Routable Service (Assignnodetodomain)

    [optional] into <file name> BPT Required file format usage=Domain Name, Location Names, Node name, Routable Service Group Name Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 214: Alias Routing

    Routing Alias,[[Name of the Service Parameter,[List of parameter values, .. label], .. parameter values, .. label]]]] Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,List of parameter values],Display ,[Name of the Service Parameter,[List of ,List of parameter values],Display NN42020-146 01.07 Standard...

  • Page 215: Get A List Of Aliases Providing A Service (Getroutableservicealiases)

    BPT Method Syntax getAliasInfoByService using (Domain Name, Service Name) | file <file name> [optional] into <file name> BPT Required file format Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 216: Remove Routable Service Alias (Deleteroutableservicealias)

    "Set Location Service Parms for a Service (setLocationRoutingServi- ceParms)" (page 218) • "Set Alias Service Parms for a Service (setAliasServiceParms)" (page 219) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 217: Get Domain Service Parms For A Service (Getdomainroutingserviceparms)

    Service Name) | file <file name> [optional] into <file name> BPT Required file format Domain Name, Alias Name, Service Name Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 218: Set Domain Service Parms For A Service (Setdomainroutingserviceparms)

    .. of parameter values],Display label]]) | <file name> [optional] into <file name> BPT Required file format Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks , List of parameter values], Display label]], , List of parameter values], Display label]]) |...

  • Page 219: Set Alias Service Parms For A Service (Setaliasserviceparms)

    "Remove Location (removeLocation)" (page 221) • "Get Location (getLocation)" (page 222) • "Get Locations for Domain (getLocations)" (page 222) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,List of parameter values],Display ,[Name of the Service Parameter,[List of ,List of parameter values],Display NN42020-146 01.07 Standard...

  • Page 220: Add Location (Addlocation)

    .. location description]]) | file <file name> [optional] into <file name> BPT Required file format Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,[Fully qualified location name,Full NN42020-146 01.07 Standard...

  • Page 221: Modify Location (Modifylocation)

    Domain name, String locationName OPI method public void removeLocation(java.lang.String domainName, java.lang.String locationName) throws java.rmi.RemoteExcept ion, com.nortelnetworks.ims.base.prov.opi.shared.Provisi onException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007 Location Services 221...

  • Page 222: Get Location (Getlocation)

    BPT Required file format Domain name, String locationName OPI method public com.nortelnetworks.ims.base.prov.opi.shared.L ocationInfo[] getLocationsByParent(java.lang.String domainName, java.lang.String parentLocationName) throws java.rmi.RemoteException, com.nortelnetworks.ims.base.prov .opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 223: Add Erl (Adderl)

    ANIs used for emergency callback to this ERL, .. callback to this ERL]]) | file <file name> [optional] into <file name> Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,The list of ANIs used for emergency...

  • Page 224: Remove Erl (Removeerl)

    Domain name OPI method public java.lang.String getAniList(java.lang.String domainName) throws java.rmi.RemoteException, com.nortelnetw orks.ims.base.prov.opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,The list of ANIs used for emergency callback to NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 225: List Of Valid Ani Registration Times In Seconds (Getvalidaniregtimes)

    "Pre-Translation Operations" (page 229) • "Add a new Telephony route (addTelephonyRoute)" (page 232) • "Add multiple Telephony routes (addTelephonyRoutes)" (page 233) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Telephony Routes Operations 225 NN42020-146 01.07 Standard...

  • Page 226: Number Qualifier Operations

    "Add multiple new Number Qualifiers (addNumberQualifiers)" (page 227) • "Get all Number Qualifiers for a domain (getNumberQualifiers)" (page 228) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 227 Gateways,Further description of the Format. NPI=??] OPI method public void addNumberQualifiers(java.lang.String rootDomain, com.nortelnetworks.ims.base.prov.opi.s hared.NumberQualifierPE[] numberQualifiers) throws java.rmi.RemoteException, com.nortelnetworks.ims.base.prov .opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Telephony Routes Operations 227 TON=?? and NPI=??]) TON=?? and NPI=??], ..
  • Page 228 Qualifier name) | file <file name> [optional] into <file name> BPT Required file format Root domain name, Number Qualifier name Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks | file <file name> [optional] into <file name>...

  • Page 229: Pre-Translation Operations

    Domain name,[Name of the Number Qualifier used by the Gateways,Length of incoming digits of the RequestURI,Digits to prepend to the Request URI] Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Telephony Routes Operations 229 NN42020-146 01.07 Standard...
  • Page 230 [optional] into <file name> BPT Required file form Domain name OPI method public com.nortelnetworks.ims.base.prov.opi.shared.PreTrans latorPE[] getPreTranslators(java.lang.String domain) throws java.rmi.RemoteException, com.nortelnetworks.ims.base.prov .opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 231 BPT Method Syntax removeAllPreTranslators using (Domain name) | file <file name> [optional] into <file name> BPT Required file format Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Telephony Routes Operations 231 NN42020-146 01.07 Standard...

  • Page 232: Add A New Telephony Route (Addtelephonyroute)

    ,[Name,Value]],The type of telephony route Gateway, SIP or Private] OPI method public void addTelephonyRoute(java.lang.String domainName, com.nortelnetworks.ims.base.prov.opi.shared.TelephonyRoute teleRoute) throws java.rmi.RemoteException, com.nortelnetwo rks.ims.base.prov.opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 233: Add Multiple Telephony Routes (Addtelephonyroutes)

    Private] OPI method public void addTelephonyRoutes(java.lang.String domainName, com.nortelnetworks.ims.base.prov.opi.shared.TelephonyRoute [] teleRoutes) throws java.rmi.RemoteException, com.norteln etworks.ims.base.prov.opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Telephony Routes Operations 233 ,[The name of the telephony NN42020-146 01.07 Standard...

  • Page 234: Modify A Telephony Route (Modifytelephonyroute)

    (Domain name,Route name) | file <file name> [optional] into <file name> BPT Required file format Domain name,Route name Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,[Name,Value]],The type of NN42020-146 01.07 Standard...

  • Page 235: Remove Multiple Telephony Routes (Removetelephonyroutes)

    BPT Required file format domain name OPI method public com.nortelnetworks.ims.base.prov.opi.shared.Telep honyRoute[] getTelephonyRoutesByDomain(java.lang.String domainName) throws java.rmi.RemoteException, com.nortelnetw orks.ims.base.prov.opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Telephony Routes Operations 235 NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 236: Get A Telephony Route (Gettelephonyroute)

    BPT Required file format domain name, Route list OPI method public void addRouteLists(java.lang.String domainName, com.nortelnetworks.ims.base.prov.opi.shared.RouteList[] routeList) throws java.rmi.RemoteException, com.nortelnetwo rks.ims.base.prov.opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 237: Modify A Route List (Modifyroutelist)

    OPI method public void removeRouteList(java.lang.String domainName, java.lang.String routeListName) throws java.rmi.RemoteExce ption, com.nortelnetworks.ims.base.prov.opi.shared.Provisi onException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Telephony Routes Operations 237 ,The names of the telephony routes that NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 238: Remove Multiple Route Lists (Removeroutelists)

    List name,RouteName) | file <file name> [optional] into <file name> BPT Required file format Domain name,Route List name,RouteName Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 239: Get Route Lists By Domain (Getroutelistbydomain)

    (Domain name,Class of service) | file <file name> [optional] into <file name> BPT Required file format Domain name,Class of service Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Telephony Routes Operations 239 NN42020-146 01.07 Standard...

  • Page 240: Get Route List Actions (Getroutelistactions)

    BPT Required file format Domain name, Prefix OPI method public void assignDirectToGatewayPrefixData(java.lang .String domain, java.lang.String domPrefixData) throws java.rmi.RemoteException, com.nortelnetworks.ims.base.prov .opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 241: Get Direct To Gateway Service Prefix For A Domain (Getdirecttogwprefix-Data)

    "Get all Voicemail Server Host Types (getAllVoicemailServerHostTypes)" (page 244) • "Add a SIP Voicemail Server (addSIPVoicemailServer)" (page 244) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 242: Add A Voicemail Server Host (Addvoicemailserverhost)

    (Voicemail Server Host) | file <file name> [optional] into <file name> BPT Required file format Voicemail Server Host Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 243: Modify A Voicemail Server Host (Modifyvoicemailserverhost)

    BPT Method Syntax getVoicemailServerHost using (Hostname) | file <file name> [optional] into <file name> BPT Required file format Hostname Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 244: Get All Voicemail Server Hosts (Getallvoicemailserverhosts)

    SIP voicemail server, .. host of the SIP voicemail server]]) | file <file name> [optional] into <file name> BPT Required file format Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,The domains that the voicemail server would NN42020-146 01.07 Standard...

  • Page 245: Modify A Sip Voicemail Server (Modifysipvoicemailserver)

    VoicemailServer sipVms) throws java.rmi.RemoteException, com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce ption; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,The domains that the voicemail ,The domains that the voicemail ,The host of the SIP voicemail NN42020-146 01.07 Standard...

  • Page 246: Remove A Sip Voicemail Server (Removesipvoicemailserver)

    BPT Required file format Domain name OPI method public com.nortelnetworks.ims.base.prov.opi.shared.SIPVoice mailServer[] getAllSIPVoicemailServersByDomain(java.lang.St ring domainName) throws java.rmi.RemoteException, com.norte lnetworks.ims.base.prov.opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 247: Add A Trunk Voicemail Server (Addtrunkvoicemailserver)

    OPI method public void addTrunkVoicemailServer(com.nortelnetworks.ims .base.prov.opi.shared.TrunkVoicemailServer trunkVms) throws java.rmi.RemoteException, com.nortelnetworks.ims.base.prov .opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,The domains that the voicemail server would ,The domains that the voicemail NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 248: Modify A Trunk Voicemail Server (Modifytrunkvoicemailserver)

    OPI method public void modifyTrunkVoicemailServer(java.lang.String serverName, com.nortelnetworks.ims.base.prov.op i.shared.TrunkVoicemailServer trunkVms) throws java.rmi.RemoteException, com.nortelnetworks.ims.base.prov .opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,The domains that the voicemail ,The host of the trunk voicemail NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 249: Remove A Trunk Voicemail Server (Removetrunkvoicemailserver)

    Domain name, Server type OPI method public com.nortelnetworks.ims.base.prov.opi.shared.TrunkVoi cemailServer[] getTrunkVoicemailServerByDomain(java.lang.S tring domainName, java.lang.String trunkServerName) throws java.rmi.RemoteException, com.nortelnetworks.ims.base.prov .opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007 Voicemail Operations 249...

  • Page 250: Add A Line Voicemail Server (Addlinevoicemailserver)

    SMDI on the terminal server,[[The host that the voicemail server Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks...

  • Page 251: Modify A Line Voicemail Server (Modifylinevoicemailserver)

    ,[The host that the voicemail server resides,[[The line number for the line used in the line based voicemail Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks...
  • Page 252 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,[The line number for the line used NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 253: Remove A Line Voicemail Server (Removelinevoicemailserver)

    .opi.shared.ProvisionException; Get all Voicemail Servers (getAllVoicemailServers) BPT Method Syntax getAllVoicemailServers [optional] into <file name> Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007 Voicemail Operations 253...

  • Page 254: Get All Voicemail Servers For A Domain (Getallvoicemailserversbydomain)

    "Add multiple address book entries for a User (addAddressBookEntries)" (page 257) • "Modify an address book entry for a User (modifyAddressBookEntry)" (page 258) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 255 "Add users to the address book of a User (addUsersToAddressBook)" (page 266) • "Get an addressbook entry (getAddressBookEntry)" (page 266) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 256: Add Address Book Entry For A User (Addaddressbookentry)

    OPI method public void addAddressBookEntry(java.lang.String userName, com.nortelnetworks.ims.base.prov.opi.shared.AddressBookEntr y addrBookEntry) throws java.rmi.RemoteException, com.norte lnetworks.ims.base.prov.opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 257: Add Multiple Address Book Entries For A User (Addaddressbookentries)

    OPI method public void addAddressBookEntries(java.lang.String userName, com.nortelnetworks.ims.base.prov.opi.s hared.AddressBookEntry[] addrBookEntries) throws java.rmi.RemoteException, com.nortelnetworks.ims.base.prov .opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007 Addressbook Operations 257...

  • Page 258: Modify An Address Book Entry For A User (Modifyaddressbookentry)

    Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,[The nickname for the NN42020-146 01.07 Standard...

  • Page 259: Remove Address Book Entries For A User (Removeaddressbookentries)

    User name,[ Nick names, .. OPI method public void removeAddressBookEntries(java.lang.String userName, java.lang.String[] nickNames) throws java.rmi.RemoteException, com.nortelnetworks.ims.base.prov .opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks , Nick names],[[The nickname ,[The nickname for the , Nick names] NN42020-146 01.07 Standard...

  • Page 260: Remove An Address Book Entry For A User (Removeaddressbookentry)

    BPT Required file format userName OPI method public void removeAddressBook(java.lang.String[] userNames) throws java.rmi.RemoteException, com.nortelnetworks.ims.bas e.prov.opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,User names] NN42020-146 01.07 Standard Release 4.0 19 October 2007 ,User names]) |...

  • Page 261: Get Address Book For A User (Getaddressbook)

    BPT Required file format User name OPI method public java.lang.String[] getBuddies(java.lang.String userName) throws java.rmi.RemoteException, com.nortelnetwor ks.ims.base.prov.opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007 Addressbook Operations 261...

  • Page 262: Add A Banned User (Addbanneduser)

    User name, Banned user name OPI method public void modifyBannedUser(java.lang.String userName, java.lang.String bannedUserName) throws java.rmi.RemoteExce ption, com.nortelnetworks.ims.base.prov.opi.shared.Provisi onException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 263: Get The Banned Users For A User (Getbannedusers)

    BPT Required file format User name OPI method public void removeAllBannedUsers(java.lang.String userName) throws java.rmi.RemoteException, com.nortelnetworks.ims.bas e.prov.opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007 Addressbook Operations 263...

  • Page 264: Get All Address Book Groups For A User (Getaddressbookgroups)

    BPT Required file format User name, group names OPI method public void addAddressBookGroups(java.lang.String userName, java.lang.String[] groupNames) throws java.rmi.RemoteException, com.nortelnetworks.ims.base.prov .opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 265: Modify Address Book Group Names For A User (Modifyaddressbookgroups)

    User name, group name,updated group name OPI method public void renameAddressBookGroup(java.lang.String userName, java.lang.String groupName, java.lang.String updatedGroupName) throws java.rmi.RemoteException, com.nort elnetworks.ims.base.prov.opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks , group names] NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 266: Add Users To The Address Book Of A User (Adduserstoaddressbook)

    (User name, Nick name) | file <file name> [optional] into <file name> BPT Required file format User name, Nick name Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,[The user name,Users first name,Users last NN42020-146 01.07 Standard...

  • Page 267: Get Address Book For A User With Photo Urls (Getaddressbookwithphoto)

    BPT Method Syntax getLightWeightAddressBook using (User name, Nick name) | file <file name> [optional] into <file name> BPT Required file format Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 268: Make This Entry A Buddy (Makebuddy)

    (Time Zone Id) | file <file name> [optional] into <file name> BPT Required file format Time Zone Id Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 269: Get A Time Zone By Name (Gettimezonebyname)

    [optional] into <file name> OPI method public com.nortelnetworks.ims.base.prov.opi.shared.TimeZone [] getAllTimeZones() throws java.rmi.RemoteException, com.n ortelnetworks.ims.base.prov.opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007 Time Zone Operations 269...

  • Page 270: Add A Time Zone (Addtimezone)

    Existing Time Zone name,[TimeZone ID,TimeZone Name] OPI method public void modifyTimeZone(java.lang.String name, com.nortelnetworks.ims.base.prov.opi.shared.TimeZone newTZ) throws java.rmi.RemoteException, com.nortelnetworks.ims.bas e.prov.opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 271: Emergency Number Operations

    BPT Required file format [String emergencyNumber, .. OPI method public void addEmergencyNumbers(java.lang.String[] emergencyNumbers) throws java.rmi.RemoteException, com.nort elnetworks.ims.base.prov.opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Emergency Number Operations 271 ,String emergencyNumber] NN42020-146 01.07 Standard...

  • Page 272: Get All Emergency Numbers (Getallemergencynumbers)

    <file name> [optional] into <file name> BPT Required file format String emergencyNumber OPI method public void removeEmergencyNumber(java.lang.String emergencyNumber) throws java.rmi.RemoteException, com.norte lnetworks.ims.base.prov.opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 273: Update Emergency Alias List (Updateemergencyalias)

    "Remove a Media Portal Route (removeMpRoutabilityGroup)" (page 279) • "Remove multiple Media Portal Routes (removeMpRoutabilityGroups)" (page 279) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Media Portal Group and Route Operations 273 , String[] aliasList]) | file <file NN42020-146 01.07 Standard...

  • Page 274: Add A New Media Portal Group (Addmediaportalgroup)

    ,Location Names]]],Specify if Group is globally addressable], .. Resources IPaddress, .. IPaddress],[[Domain Name,[Location Names, .. Names]], .. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,[Domain Name,[Location Names, ,MediaPortal Resources IPaddress],[[Domain ,Location Names]], ..

  • Page 275: Modify A Media Portal Group (Modifymediaportalgroup)

    OPI method public void modifyMediaPortalGroup(java.lang.String groupName, com.nortelnetworks.ims.base.prov.opi.shared.Me diaPortalGroup mpgroup) throws java.rmi.RemoteException, com.nortelnetworks.ims.base.prov.opi.shared.ProvisionExce ption; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Media Portal Group and Route Operations 275 ,MediaPortal Resources IPaddress],[[Domain ,Location Names]], ..

  • Page 276: Remove A Media Portal Group (Removemediaportalgroup)

    OPI method public com.nortelnetworks.ims.base.prov.opi.shared.Medi aPortalGroup getMediaPortalGroupByName(java.lang.String groupName) throws java.rmi.RemoteException, com.nortelnetwo rks.ims.base.prov.opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,Media Portal Groups names]) | file <file name> ,Media Portal Groups names] NN42020-146 01.07 Standard...

  • Page 277: Get All Media Portal Groups (Getallmediaportalgroups)

    | file <file name> [optional] into <file name> BPT Required file format [Name of the Routability Group,[[Domain Name,[Location Names, .. Names, .. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Media Portal Group and Route Operations 277 ,Location Names]], ..

  • Page 278: Add Multiple Media Portal Routes (Addmproutabilitygroups)

    <file name> BPT Required file format Existing Route Name,[Name of the Routability Group, [[Domain Name,[Location Names, .. ,[Domain Name,[Location Names, .. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,Location Names]], .. ,[Domain Name,[Location ,Location Names]]]]]) | file <file name>...

  • Page 279: Remove A Media Portal Route (Removemproutabilitygroup)

    (Media Portal Route name) | file <filename> [optional] into <file name> BPT Required file format Media Portal Route name Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Media Portal Group and Route Operations 279 ,Media Portal Routes names]) | file <file name>...

  • Page 280: Get All Media Portal Routes (Getallmproutabilitygroups)

    OPI method public void modifyDomainLocationsByMPGroup(java.lang.String groupName, com.nortelnetworks.ims.base.prov.opi.shared.Doma inLocation domLoc) throws java.rmi.RemoteException, com.nor telnetworks.ims.base.prov.opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,Location Names]]) | file <file NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 281: Modify Domain Locations By Route Name (Modifydomainlocations-Byrtgroup)

    (domainName, serviceName, maxCountForThisDomain) | file <file name> [optional] into <file name> BPT Required file format domainName, serviceName, maxCountForThisDomain Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,Location Names]]) | file <file NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 282: Modify Domain Resource (Modifydomainresource)

    BPT Method Syntax removeAllDomainResources using (domainName) | file <file name> [optional] into <file name> BPT Required file format domainName Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 283: Get Domain Resources (Getdomainresourcesbydomain)

    This section contains the following method: • "Get License Key Usage for a Given Keycode (getLicenseKeyUsage)" (page 284) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 284: Get License Key Usage For A Given Keycode (Getlicensekeyusage)

    "Get Ldap Sync Filter Criteria for Domain Name (getLdapsyncFilter- Criteria)" (page 290) • "Start LDAP Synchronization Now (startLdapSyncNow)" (page 291) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 285: Add Ldap Schema (Addldapschema)

    Primary user,Password require to login<default N>valid values Y,N,Login name for secondary User,Password for secondary user,Connect using secure connection for Primary Server<default N>valid values Y,N,Connect using secure Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 286: Add Ldap Time Block (Addldaptimeblock)

    Monthly, .. is 0-6 for weekly or 1-31 if start frequency set for Monthly],valid values are Y or N] Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ,The days of the week valid range NN42020-146 01.07 Standard...

  • Page 287: Add Ldap User Defaults (Addldapuserdefaults)

    Remove LDAP Info for Domain (removeLdapInfo) BPT Method Syntax removeLdapInfo using (Domain name) | file <file name> [optional] into <file name> Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 288: Remove Ldap Schema For Domain (Removeldapschema)

    (Domain name) | file <file name> [optional] into <file name> BPT Required file format Domain name Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 289: Remove Ldapsyncfiltercriteria For Domain (Removeldapsyncfiltercriteria)

    BPT Required file format Domain name OPI method public com.nortelnetworks.ims.base.prov.opi.shared.LDAP Info[] getLdapInfo(java.lang.String domainName) throws java.rmi.RemoteException, com.nortelnetworks.ims.base.prov .opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007 LDAP Syncing 289...

  • Page 290: Get Ldap Time Block For Domain Name (Getldaptimeblock)

    (Domain name) | file <file name> [optional] into <file name> BPT Required file format domainName OPI method Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 291: Start Ldap Synchronization Now (Startldapsyncnow)

    .opi.shared.ProvisionException; Get all Password Policies (getAllPasswordPolicies) BPT Method Syntax getAllPasswordPolicies [optional] into <file name> Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007 Password Policy Operations 291...

  • Page 292: Add A Password Policy (Addpasswordpolicy)

    Password,Minimum Number of Characters in Password] OPI method public void modifyPasswordPolicy(java.lang.String name, com.nortelnetworks.ims.base.prov.opi.shared.PasswordPolicy pp) throws java.rmi.RemoteException, com.nortelnetworks.ims .base.prov.opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 293: Remove A Password Policy (Removepasswordpolicy)

    "Remove Parm Definition To Owner (removeParmDefinitionFromOwner)" (page 296) Get all Parm Types (getAllParmTypes) BPT Method Syntax getAllParmTypes [optional] into <file name> Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 294: Get All Parm Validation Types (Future Method) Getallparmvalidationtypes

    (owner name) | file <file name> [optional] into <file name> BPT Required file format owner name Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 295: Get Parm Definition By Name (Getparmdefinitionbyname)

    (Parm Definition) | file <file name> [optional] into <file name> BPT Required file format Parm Definition Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 296: Remove Parm Definition (Removeparmdefinition)

    (Owner name, Parm name) | file <file name> [optional] into <file name> BPT Required file format Owner name, Parm name Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 297: Release, Version Information

    Groups This section contains the following: • "Add a group (addGroup)" (page 298) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007 Groups 297...

  • Page 298: Add A Group (Addgroup)

    (domain name, Groups) | file <file name> [optional] into <file name> BPT Required file format domain name, Groups OPI method Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 299: Modify A Group (Modifygroup)

    (Domain name, Group Name) | file <file name> [optional] into <file name> BPT Required file format Domain name, Group Name OPI method Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 300: Get A Group By User Name (Getgroupbyusername)

    (User name, Group Names) | file <file name> [optional] into <file name> BPT Required file format User name, Group Names OPI method Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 301: Remove User From Group (Removegroupbyuser)

    Remove all groups for user (removeAllUserGroups) BPT Method Syntax removeAllUserGroups using (User name) | file <file name> [optional] into <file name> Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 302: Sip Lines

    Get SIP Line Audit Data By UserName (getSIPLineAuditDataByUser- Name) BPT Method Syntax getSIPLineAuditDataByUserName using (User name) | file <file name> [optional] into <file name> Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 303: Get Sip Line Audit Data By Domain (Getsiplineauditdatabydomain)

    Get VMGs for Domain (getVMGForDomain) BPT Method Syntax getVMGForDomain using (Domain Name) | file <file name> [optional] into <file name> Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 304: Get Users By Registration State (Getusersbyregistrationstate)

    "getConfDialUpNumbers" (page 305) • "getWebCollabURL" (page 305) • "getUserPicture" (page 306) • "addUserPicture" (page 306) • "modifyUserPicture" (page 306) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 305: Getaliasesforexpressmsging

    OPI Method public java.lang.String getWebCollabURL(java.lang.String userName) throws java.rmi.RemoteException, com.nortelnetworks.ims.base.prov.opi.shared.Pro visionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Methods available only in OPI 305 NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 306: Getuserpicture

    OPI method public void modifyUserPicture(java.lang.String userName, com.nortelnetworks.ims.base.prov.opi.shared.UserPicture picture) throws java.rmi.RemoteException, com.nortelnetwork s.ims.base.prov.opi.shared.ProvisionException; Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 307: Subscriber Open Provisioning Interface Overview

    The Apache Axis toolkit is used for this example. Other toolkits are available that can be used to develop client stubs using the WSDL file. SOPI connects to the web server using port 80 or port 443. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard...

  • Page 308: Writing A Client

    For example, if the path D:\axis-1_1\webapps\axis\WEB-INF\lib contains jar files, you would configure CLASSPATH= D:\axis-1_1\webapps\axis\WEB-INF\lib\axis.ja r;D:\axis-1_1\webapps\axis\WEB-INF\lib\axis-ant.jar;D: \axis-1_1\webapps\axis\WEB-INF\lib\commons-discovery.ja r;D:\axis-1_1\webapps\axis\WEB-INF\lib\commons-logging Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks —End— NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 309 SOPI SOAP request message by configuring the locale attribute (for example, locale) in the SOAP header. The value of this attribute should be Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks For example, D:\sopiclient For example, java org.apache.axis.wsdl.WSDL2Java -O -1 -d...

  • Page 310: Client Sample Code

    The following sample code makes a call to retrieve the user’s personal information. It calls the getPersData() method, passing in the fully qualified username, for example, joe@nortel.com. After getting the user’s personal information, the client makes a call to modifyPersonalData() to change the user’s office and cellphone numbers.
  • Page 311 }catch (java.net.MalformedURLException ex)// Bad URL exception System.out.println("Invalid URL"); catch (javax.xml.rpc.ServiceException ex)// Unable to get ServiceLocator {}catch(Exception e) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007 Building SOPI clients 311...
  • Page 312 312 Subscriber Open Provisioning Interface overview Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference NN42020-146 01.07 Standard Release 4.0 19 October 2007 Copyright © 2007, Nortel Networks...

  • Page 313: Subscriber Open Provisioning Interface Methods

    "Assistant user manager" (page 335) • "Click To Call" (page 335) • "I200x " (page 336) • "SOPI version" (page 336) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 314: User Personal Information

    (for example, user@domain) unless specifically mentioned in the respective section. • Unified Communications Service Data methods are available, but these methods are not supported in MCS 5100 Release 4.0. • provisionable entities. User personal information These methods are used to access and manage the user’s personal information (for example, e-mail, business telephone number, home telephone number).

  • Page 315: Changepassword

    Required ServicePackage Service addTimeBlockGroup void addTimeBlockGroup(java.lang.String userName, TimeBlockGroup timeBlockGrp) This method creates a new TimeBlockGroup, using the information provided, for the user. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks TimeBlockGroup TimeBlock None NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 316: Addtimeblockgroups

    "modifyUserData" (page 317) • "modifyUserNotes" (page 317) • "modifyUserReasons" (page 317) • "modifyUserSubjects" (page 318) • "removeAllCallSubjects" (page 318) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 317: Getnotesbyusername

    This method updates the notes, associated with the user, with the notes list information. modifyUserReasons void modifyUserReasons(java.lang.String userName, java.lang.String[] reasons) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks UserData UserData None NN42020-146 01.07 Standard...

  • Page 318: Modifyusersubjects

    "getAddressBook" (page 319) • "getAddressBookEntry" (page 319) • "getAddressBookWithPhoto" (page 320) • "getBuddies" (page 320) • "getFullAddressBookEntry" (page 320) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 319: Addaddressbookentries

    This method retrieves the entry identified by the nickname from the user’s address book. The address book retrieved contains information on the user’s buddies, banned users, and groups. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks...

  • Page 320: Getaddressbookwithphoto

    This method updates an entry in the user’s address book. removeUserAddressBook void removeUserAddressBook(java.lang.String userName) This method deletes the user’s address book. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 321: Removeaddressbookentries

    This method adds a group to the user’s address book. Examples of groups are Family, Friends, and Work. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks None AddrBookGroup None NN42020-146 01.07 Standard...

  • Page 322: Addaddressbookgroups

    The global address book search functions are included in this interface. The methods are: • "searchGABByFirstName" (page 323) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 323: Searchgabbyfirstname

    FullAddressBookEntry[] searchGABByLastNameRange(java.lang.String userName, java.lang.String lastName, int start, int stop) This method retrieves the users in the global address book that match the search criteria. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks FullAddressBookEntry GlobalAddrBook None NN42020-146 01.07 Standard...

  • Page 324: Searchgabbyname

    FullAddressBookEntry[] searchGABByUserNameRange(java.lang.String userName, java.lang.String searchUserName, int start, int stop) This method retrieves the users in the global address book that match the search criteria. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard...

  • Page 325: Call Screening And Routes

    Required ServicePackage Service activateRoutes void activateRoutes(java.lang.String userName, java.lang.String[] routeNames) This method configures the status of the routes specified in the input list to Active. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Route Routes •...

  • Page 326: Addroute

    Route newRoute) This method modifies a route for the user with the route information provided. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 327: Removeallroutes

    "getUserServicePackage" (page 328) • "modifyAllUserPreferences" (page 328) • "modifyUserPreferences" (page 328) • "removeAllUserPreferences" (page 328) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007 Service preferences 327...

  • Page 328: Getalluserpreferences

    • "getParameterNameByParameterDisplayName" (page 329) • "getServiceDisplayNameByServiceName" (page 329) • "getServiceNameByServiceDisplayName" (page 329) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ServicePackage, Service ServPref None. But the users can only access the preferences for the services in their configured service packages.

  • Page 329: Getparameterdisplaynamebyparametername

    The methods are: • "addMeetMeConfUser" (page 330) • "getMeetMeConfData" (page 330) • "modifyMeetMeConfUser" (page 330) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks None ServPrefConv None NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 330: Addmeetmeconfuser

    This method returns the web collaboration URL for a particular user. getChairAccessURL String getChairAccessURL(String userName) This method retreives the chairperson access URL for a web collaboration session, if it is already started. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks MeetMeConfData MeetMe Meet Me Conferencing NN42020-146 01.07 Standard...

  • Page 331: Removemeetmeconfuser

    This method retrieves a list of incoming call logs for a user. getOutgoingCallLogs CallLog[] getOutgoingCallLogs(java.lang.String username) This method retrieves a list of outgoing call logs for a user. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks CallLog...

  • Page 332: Time Zones

    The method is: • "getPasswordPolicyDescription" (page 332) Complex Data Type (Provisionable Entity) WebService Name Required ServicePackage Service getPasswordPolicyDescription java.lang.String getPasswordPolicyDescription(java.lang.String userName) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks TimeZone TimeZone None LocaleData Locale...

  • Page 333: E911 Location List

    This method adds a picture to be associated with the userName. getUserPicture UserPicture getUserPicture(java.lang.String userName) This method retrieves the picture associated with the userName. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks LocList E911Loc...

  • Page 334: Modifyuserpicture

    This method adds multiple users to the ban list of a user’s address book which would prevent the banned user from subscribing to this user’s presence information. getBannedUsers java.lang.String[] getBannedUsers(java.lang.String userName) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks None BanUser None NN42020-146 01.07 Standard...

  • Page 335: Modifybanneduser

    This method retrieves the userNames of the users who are assisted by the given user. Click To Call The method is: • "clickToCall" (page 336) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks None AsstUser Assistant Console NN42020-146 01.07 Standard...

  • Page 336: Clicktocall

    "getSupportedSOPIVersions" (page 337) Complex Data Type (Provisionable Entity) WebService Name Required ServicePackage Service getCurrentSOPIVersion java.lang.String getCurrentSOPIVersion() This method retrieves the current SOPI version number. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks None CTCall None None...

  • Page 337: Getsupportedsopiversions

    This method retrieves the currently-supported SOPI version numbers. Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007 SOPI version 337...
  • Page 338 338 Subscriber Open Provisioning Interface methods Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference NN42020-146 01.07 Standard Release 4.0 19 October 2007 Copyright © 2007, Nortel Networks...

  • Page 339: Error Codes And Messages

    • "IPCM error codes and messages (016000)" (page 367) • "Network call logs error codes and messages (017000)" (page 368) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 340 "Media Portal Routability Group error codes and messages (047000)" (page 398) • "Auto ID error codes and messages (048000)" (page 400) Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 341: Data Access Error Codes And Messages (000000)

    000001 000002 000003 000004 000005 000006 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Data access error codes and messages (000000) 341 Error Message The field(s): {0} must be unique Numeric value is too large. Please try with a smaller value.
  • Page 342 000026 000027 000028 000029 000040 000041 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message Data unavailable (Unable to connect to listener). Please try again later. Data unavailable (Internal error). Please try again later.

  • Page 343: Directories Error Codes And Messages (001000)

    001011 001012 001013 001014 001015 001016 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Directories error codes and messages (001000) 343 Error Message Unable to commit transaction. Please contact your next level of support.

  • Page 344: Address Book Error Codes And Messages (002000)

    002004 002005 002006 002007 002008 002009 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message Groups could not be updated: Another group(s) with the same name(s) {0} exists. Updating group information failed. Data access error {0}.
  • Page 345 002026 002027 002028 002029 002030 002031 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Address book error codes and messages (002000) 345 Error Message Cannot perform requested operation on entry. Information on maximum number of friends and entries allowed could not be retrieved.
  • Page 346 002047 002048 002049 002050 002051 002052 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message Initialization failure of data for Address book: This process is recoverable later. Failed to initialize data access components. Unable to proceed further.
  • Page 347 002069 002070 002071 002072 002073 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Address book error codes and messages (002000) 347 Error Message Cannot add more than {0} to friend list: current number of friends...

  • Page 348: User Service Package Error Codes And Messages (003000)

    003007 003008 003009 003010 003011 003012 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message Updating address book entry failed: Home Phone number entry must be 50 characters or less. Updating address book entry failed: Business Phone number entry must be 50 characters or less.
  • Page 349 003031 003032 003033 003034 003035 003036 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks User Service Package error codes and messages (003000) 349 Error Message Error: Please contact your next level of support. Error: Failed to send Service Package change notification.

  • Page 350: User Operation Error Codes And Messages (004000)

    004002 004003 004004 004005 004006 004007 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message Service Package name not found. Please specify a Service Package name. Required attributes to generate the Service Package Notify message body are null.
  • Page 351 004023 004024 004025 004026 004027 004028 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks User Operation error codes and messages (004000) 351 Error Message Cannot add/modify user without Locale. Please provide the required value.
  • Page 352 004051 004052 004053 004054 004056 004057 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message Unable to add/modify user {0}. Voicemail ID specified without a valid Voicemail Server. Unable to add voicemail server for user {0}. A voicemail server is already assigned to the user.
  • Page 353 004070 004071 004072 004073 004080 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks User Operation error codes and messages (004000) 353 Error Message Unable to get User count in domain {0}. Please contact your next level of support.
  • Page 354 004085 004086 004087 004088 004089 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message Cannot add/modify user as users service package has the {0} service. {1} service limit of {2} has been exceeded for the domain {3}.

  • Page 355: Resource Management Exceptions Error Codes And Messages (004100)

    004102 004103 004104 004105 004106 004107 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message Unable to retrieve user information. {0} Invalid {0} {1}. {0} of the user cannot be greater than 30 characters.

  • Page 356: Subscriber Opi Error Codes And Messages (004150)

    Prefix error codes and messages(004200) Error Code 004200 004201 004202 004203 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message Cannot add the required number i.e. {0} users to domain {1} because it exceeds the assigned limit.

  • Page 357: Domain Error Codes And Messages (005000)

    005008 005009 005010 005011 005012 005013 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Domain error codes and messages (005000) 357 Error Message Assigning prefix data to user failed. {0} Getting user prefix data information failed. {0} Cannot assign Audio Device Prefix to the user because the user {0} does not have "MobileConverged"...
  • Page 358 005031 005032 005033 005041 005042 005043 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message Cannot add/modify domain {0} because it has an invalid value for the domain parameter {1}. {2}. Cannot add/modify domain {0} because it does not have the required domain parameter {1} {2}.

  • Page 359: Address Book Group Error Codes And Messages (006000)

    Banned subscriber error codes and messages (008000) Banned subscriber error codes and messages (008000) Error Code 008000 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Banned subscriber error codes and messages (008000) 359 Error Message The required attributes "Start"...

  • Page 360: Resource Management Error Codes And Messages (009000)

    009001 009003 009004 009005 009006 009007 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message Domain information is required. Removing banned subscriber information failed: {0} Banned Subscriber Party information is required for this operation.
  • Page 361 009021 009022 009023 009100 009101 009102 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Resource Management error codes and messages (009000) 361 Error Message Modifying domain resource information failed for domain {0} and service {1}. Requested number of units {2} is more than...

  • Page 362: Device Error Codes And Messages (010000)

    010013 010014 010015 010016 010017 010018 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message Retrieving device information failed. Cannot add/modify device because the device does not have a MAC address. Please provide a MAC address.

  • Page 363: Domain Cos Error Codes And Messages (011000)

    Domain COS error codes and messages (011000) Error Code 011000 011001 011002 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Domain COS error codes and messages (011000) 363 Error Message Cannot add/modify device with MAC address {0} because there exists no relation between the domain {1} and device IPCM {2}.

  • Page 364: Domain Profile Error Codes And Messages (012000)

    Domain locale error codes and messages (013000) Domain locale error codes and messages (013000) Error Code 013000 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message Modification of domain COS information failed: {0} Removal of domain COS information failed: {0} Retrieving domain COS information failed.

  • Page 365: Global Address Book Error Codes And Messages (014000)

    Foreign domain error codes and messages (015000) Foreign domain error codes and messages (015000) Error Code 015000 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Foreign domain error codes and messages (015000) 365 Error Message The given locale has already been added to this domain.
  • Page 366 015556 015557 015558 015559 015560 015561 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message An error occurred when trying to add/modify Foreign Domain {0}. {1} Addition of foreign Domain failed: Invalid data (Similar data...

  • Page 367: Ipcm Error Codes And Messages (016000)

    016005 016006 016007 016008 016009 016010 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks IPCM error codes and messages (016000) 367 Error Message Unable to modify client type information. {0} Unable to delete client type information. Please ensure it is not being used for any user SIP Line data.

  • Page 368: Network Call Logs Error Codes And Messages (017000)

    Phone Number error codes and messages (019000) Phone Number error codes and messages (019000) Error Code 019000 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message Add/Update of IPCM failed due to a data access error: {0} A data access error occurred while loading IPCM data.

  • Page 369: Trunk And Gateway Error Codes And Messages (020000)

    024000 024001 024002 024003 024004 024005 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Route error codes and messages (024000) 369 Error Message Retrieval of Phone Number information failed. There was a problem with the data store while trying to retrieve the information.
  • Page 370 024022 024023 024024 024025 024026 024027 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message Adding new routes information failed: {0} Route Names information is required. Route Name information is required for this operation.
  • Page 371 024042 024043 024044 024045 024046 024047 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Route error codes and messages (024000) 371 Error Message Unable to retrieve CPL for user {0}. The user {0} does not have the instant messaging service. The instant messaging service must be present to use the "When an...

  • Page 372: Service Error Codes And Messages (025000)

    025015 025016 025017 025018 025019 025020 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message Service name needs to be specified. Invalid Parameter value: {0} for parameter: {1}. Please refer to the list of acceptable values for this parameter.
  • Page 373 025038 025039 025040 025041 025042 025043 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Service error codes and messages (025000) 373 Error Message Cannot find a service with name {0}. Cannot find a parameter with name {0}.
  • Page 374 025058 025059 025060 025061 025099 025100 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message Parameter {0} is required for service {1}. {2} Parameter {0} should not be selected when service {1} is selected.

  • Page 375: Telephony Route Error Codes And Messages (026000)

    026014 026015 026016 026017 026018 026019 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Telephony Route error codes and messages (026000) 375 Error Message Adding Route List failed: Route List information cannot be null.
  • Page 376 026038 026039 026040 026041 026042 026043 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message Updating of Route List information failed: Another Route List with the name {0} exists for domain {1}. Updating of Route List information failed: {0}.
  • Page 377 026063 026064 026065 026066 026067 026068 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Telephony Route error codes and messages (026000) 377 Error Message The Route List information could not be retrieved: Data Access error.

  • Page 378: Status Reason Error Codes And Messages (027000)

    027000 027001 027002 027003 027004 027005 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message Route List information retrieval failed: {0} Unable to retrieve the cos information for Route List. Initialization of routeaction data for Telephony Routes failed.

  • Page 379: Number Qualifier Error Codes And Messages (028000)

    028002 028003 028100 028101 028102 028103 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Number qualifier error codes and messages (028000) 379 Error Message No Status Reasons found for this domain. Modification of status reason information failed: {0} Status Reason Name is null.

  • Page 380: Time Block Group And Presence Condition Error Codes And Messages (029000)

    Time zone error codes and messages (030000) Error Code 030000 030001 030002 030003 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message PreTranslator Prefix {0} contains invalid characters. The valid characters are 0-9 and ’+’.

  • Page 381: User Data Error Codes And Messages (032000)

    User time and Click to call error codes and messages (033000) Error Code 033001 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks User time and Click to call error codes and messages (033000) 381...
  • Page 382 033021 033022 033023 033024 033025 033026 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message Removing Time block Group for user {0} failed. Time block Group name cannot be null. Removing Time block Group {0} failed. User name cannot be null.

  • Page 383: Voicemail Error Codes And Messages (034000)

    Voicemail error codes and messages (034000) Error Code 034001 034002 034003 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Voicemail error codes and messages (034000) 383 Error Message Adding time block failed. Time block stop time cannot be null.

  • Page 384: Reserved Addresses Error Codes And Messages (035000)

    037003 037004 037005 037006 037007 037008 037009 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message Invalid Reserved Addresses provided. Add Reserved Address failed: {0} Remove all reserved Address failed: {0} Data retrieval failed: Reserved Address data was not found.

  • Page 385: Branding Error Codes And Messages (038000)

    038004 038005 038006 038007 038008 038009 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Branding error codes and messages (038000) 385 Error Message Renaming music folder information failed for domain: {0}, pooled resource: {1}, Folder: {2}. {3} Failed to initialize data access components: Unable to proceed further.

  • Page 386: Treatment Error Codes And Messages (039000)

    039006 039007 039008 039009 039010 039011 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message File Name is not valid. Please retrieve list of branding files in this pool and select from it.

  • Page 387: Assistant Error Codes And Messages (040000)

    Error Code 040001 040002 040003 040004 040005 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Assistant error codes and messages (040000) 387 Error Message Updating Treatment Group failed for domain: {0}, pooled resource:{1}. {2} Removing Treatment Group failed for domain: {0}.
  • Page 388 040023 040024 040025 040026 040027 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message Unable to add assistants for user {0} due to the following error: Unable to retrieve assistants. User name cannot be null.

  • Page 389: User Picture Error Codes And Messages (041000)

    Location error codes and messages (042000) Error Code 042000 042001 042002 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Location error codes and messages (042000) 389 Error Message Unable to update users for assistant {0} because specified user {1} is not a provisioned user for the assistant.
  • Page 390 042025 042026 042100 042101 042102 042103 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message Unable to retrieve location. No Location Info was found for location {0}. Unable to retrieve locations. No Locations were found for domain {0}.

  • Page 391: Erlinfo Error Codes And Messages (043000)

    043012 043013 043014 043015 043016 043017 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks ErlInfo error codes and messages (043000) 391 Error Message Unable to create Emergency Response Location. {0} is limited to {1} characters. Please use a shorter {0}.
  • Page 392 043033 043034 043035 043036 043037 043038 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message Unable to modify Emergency Response Location. Details: {0} Unable to delete Emergency Response Location. Details: {0} Unable to delete Emergency Response Location. Location is not an Emergency Response Location {0}.

  • Page 393: Emergency Alias Error Codes And Messages (044000)

    045003 045004 045005 045006 045007 045008 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Emergency numbers error codes and messages (045000) 393 Error Message Unable to create emergency alias. Details: {0} Unable to delete emergency alias. Details: {0} Unable to create emergency alias.

  • Page 394: Meet Me Audio Conferencing Related Error Codes And Messages (046000)

    046008 046009 046019 046020 046021 046022 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message Failed to Add/Update Emergency Number. The following value is Reserved: {0} Cannot perform operation. Please provide all of the following...

  • Page 395: Media Portal Group Error Codes And Messages (046100)

    Error Code 046100 046101 046102 046103 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Media Portal Group error codes and messages (046100) 395 Error Message Valid Meet Me Conferencing data not found for the User {0}.
  • Page 396 046209 046210 046211 046212 046213 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message Unable to add or modify MPGroup. MPGroup Name is not valid Unable to add MPGroup. MPGroup Name is not valid.
  • Page 397 046412 046420 046421 046430 046440 046441 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Media Portal Group error codes and messages (046100) 397 Error Message Unable to modify DomainLocs MPGroup. Existing Group Name is required.

  • Page 398: Media Portal Routability Group Error Codes And Messages (047000)

    047202 047203 047204 047206 047207 047208 047209 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message Failed to create cacheMPGroupHashMap. Data Access Error: Failed to create cacheMPGroupHashMap. Data Retrieval Error: Error Message Unable to add MPRoute. MPRoute information is required.
  • Page 399 047407 047408 047409 047411 047412 047420 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message Unable to modifyBase RTGroup. No cache data for {0} Unable to modifyBase RTGroup. Existing cache data not found for {0} Failed to modifyBase RTGroup.

  • Page 400: Auto Id Error Codes And Messages (048000)

    049006 049007 049008 049009 049010 049011 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message Failed to create cacheMPRouteHashMap. Data Retrieval Error: Invalid zone ID provided {0}. Zone ID should be a integer.
  • Page 401 049026 049027 049028 049029 049030 049031 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks LDAP error codes and messages (049000) 401 Error Message NamingException Caught in domain {0} - {1} The Server Type can only be P or S. Please provide a valid Server type.

  • Page 402: Pooled Entity Related Error Messages (050000)

    050023 050024 050025 050026 050027 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message Unable to create new pooled entity {0} in domain {1}. {2}. Unable to create new routable service alias {0} in domain {1}.
  • Page 403 050204 050205 050206 050207 050208 050209 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Pooled Entity related error messages (050000) 403 Error Message Unable to retrieve Pools in: {0} for location: {1} providing service: {2}.

  • Page 404: Converged Desktop Feature Error Messages (051000)

    051009 051010 051011 051012 051013 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message A weight of "{0}" is not valid for the route "{1}". Please use a value between 0 and 10.

  • Page 405: Voicemail Server Provisioning Related Error Codes And Messages (052000)

    Voicemail server provisioning related error codes and messages (052000) Error Code 052000 052001 052002 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message Converged Desktop Alias Search retrieval failed: {0} Converged Desktop Alias Search could not be completed. Data Access error.
  • Page 406 052019 052020 052021 052022 052023 052024 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message The ’App. Svr. Address’ provided, {0}, is not a valid IP address. Please provide a valid IP address.
  • Page 407 052052 052053 052054 052055 052056 052057 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message The voicemail server route information could not be retrieved. Data Access error. Please contact support for more information.

  • Page 408: Password Policy Error Codes And Messages (055000)

    055011 055012 055013 055014 055015 055016 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message The Host name {0} already exists. Please provide a different host name. Unable to add Voicemail Server Host due to {0}.

  • Page 409: Sms Subscriber, Smpp Configuration And Interworking Domain Error Codes And Messages (056000)

    Error Code 056000 056001 056002 056003 056010 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message Cannot remove password policy {0} because it is assigned to domains {1}. Cannot modify/delete the system defined "Existing" policy.

  • Page 410: Voicemail Error Codes And Messages (057000)

    Service node error codes and messages (059000) Error Code 059000 059001 059002 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message Invalid SMSSubscriber field userName {0}. The user name field of the SMSSubscriber must be a fully qualified username.
  • Page 411 059020 059021 059022 059023 059024 059025 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Service node error codes and messages (059000) 411 Error Message Node Information cannot be null. Please provide valid values. Node Address type can only be IP or DNS. Please provide a valid value for node {0}.
  • Page 412 059041 059042 059043 059044 059045 059046 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message Cannot remove node/ logical entity {0}. Gateway Routes are associated with the node/ entity. Cannot remove node/ logical entity {0}. ERLs are associated with the node/ entity.
  • Page 413 059064 059065 059066 059067 059068 059069 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Service node error codes and messages (059000) 413 Error Message Cannot remove node/ logical entity {0}. Routable Aliases are associated with the node/ entity.

  • Page 414: Admin And Role Related Error Codes And Messages (060000)

    060014 060015 060016 060017 060018 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message Route Name cannot be null for Logical Entity. Cannot assign domains to node: At least one domain should be provided.

  • Page 415: Parm Definition Error Codes And Messages (061000)

    061009 061010 061011 061012 061013 061014 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Parm Definition error codes and messages (061000) 415 Error Message Invalid Data: Invalid Right Type {0} Error: No such admin found, {0} Cannot add/modify admin because the parent does not enough privileges.

  • Page 416: Out Of Band Refer Error Codes And Messages (062000)

    Ringback error codes and messages (063000) Ringback error codes and messages (063000) Error Code 063000 063001 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message Parameter {0} is already assigned to owner {1}.

  • Page 417: Domain Cli Error Codes And Messages (064000)

    Domain CLI error codes and messages (064000) Error Code 064001 064002 064003 064004 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Domain CLI error codes and messages (064000) 417 Error Message Failed to initialize data access components: Unable to proceed further.

  • Page 418: Translation Tool Error Codes And Messages (070000)

    089100 089101 089102 089103 089104 089105 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message Removing Domain CLI data failed: {0} Domain information is required to carry out delete operation. {0} {1} is invalid. {0} should contain only numeric values.
  • Page 419 089124 089125 089126 089127 089128 089129 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Group error codes and messages (089000) 419 Error Message Assigning groups to user {0} failed. No group information was provided to assign to.

  • Page 420: System-Specific Exceptions And Authorization Error Codes And Messages (099000)

    099002 099003 099004 099005 099006 099007 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Error Message Removing groups from user {0} failed. {1}. Group operation failed. Group {0} is not available to domain {1} to use.

  • Page 421: Generic Exceptions (099999)

    Generic exceptions (099999) Generic exceptions (099999) Error Code 099999 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Generic exceptions (099999) 421 Error Message NN42020-146 01.07 Standard Release 4.0 19 October 2007...

  • Page 422: Index

    256, 257, 258, 258, 259, 260, 260, address Book group 264, 264 Address book error codes 344 Address book group error codes 359 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference NN42020-146 01.07 Standard Release 4.0 19 October 2007 156, 156, 157, 157 260, 261...
  • Page 423 Get all address book groups for a User 264 Get an addressbook entry 266 Get an addressbook entry with photo url 267 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference NN42020-146 01.07 Standard Release 4.0 19 October 2007 Index 423...
  • Page 424 Alias routing 214 domain 214 Get a list of Aliases Providing a Service 215 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Get Aliases All Information for an Alias Providing a Specified Service 215...
  • Page 425 88 Remove domain profile for a domain 89 Remove Mobile converged audio device prefix for a domain 95 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Remove several banned subscribers from a domain 92...
  • Page 426 Seconds 225 Modify ERL 223 Modify Location 221 Purge Deprecated Locations for Domain 225 Remove ERL 224 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Remove Location 221 Media Portal Group and Route operations 273...
  • Page 427 Group 212 Pooled entity 186 Add branding file to a pooled resource 190 Add branding files 191 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Add Music on Hold folder to a pooled resource 187 Add Music on Hold folders 187 Add treatment file to a pooled...
  • Page 428 Get all acceptable values for given parameter 184 Get all service names 183 Get all service packages in a domain 178 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Get all services assigned to a domain 181...
  • Page 429 Get all Time Zones 269 Modify a Time Zone 270 Remove a Time Zone 270 User Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Get all presence notes for a user 117 Get all reasons for a user 115...
  • Page 430 Get Users with no Meet Me Conferencing data, for a domain 140 Get voicemail server for user 168 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Logout all user contacts 170 Modify a Client Type 145...
  • Page 431 User Time operation 119 Voice mail operations 241 Add a Line Voicemail Server 250 Add a SIP Voicemail Server 244 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks Add a Trunk Voicemail Server 247...
  • Page 432 Domain Class of Service 87 error codes 363 Domain CLI error codes 417 Domain local error codes 364 Domain profile error codes 364 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 433 Address book group 359 Admin and role 414 Assistant 387 authorization 420 Auto ID 400 Banned subscriber 359 Branding 385 Click to call 381 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference NN42020-146 01.07 Standard Release 4.0 19 October 2007 Index 433...
  • Page 434 Resource management 360 Resource management exceptions 355 Ringback 416 Route 369 Service 372 Service node 410 SMPP 409 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks SMS 409 SOPI 356 Status reason 378 system-specific 420...
  • Page 435 336 getDefaultDomainLocale 82 getDefaultServicePackageByDomain 180 getDeprecatedLocations 225 getDestinations 240 getDevice 107 getDeviceByMacAddress 108 getDevices 107 getDevicesInDomain 108 getDirectToGWPrefixData 241 getDomain 100 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference NN42020-146 01.07 Standard Release 4.0 19 October 2007 Index 435...
  • Page 436 184 getServicesByDomain 181 getSIPLineAuditData 302 getSIPLineAuditDataByDomain 303 getSIPLineAuditDataByDomainByVMG 303 getSIPLineAuditDataByUserName 302 getSIPLineData 147, 147 getSIPLineDataByDomain 148 getSIPLineDataByDomainByVMG 148 getSIPLineDataByUserName 148 getStaticRoutesByUserName 132 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 437 Locales 332 location 220, 220, 221, 221, 222, 222, 222 Location error codes 389 logical entity 204, 205, 205, 206, 206, 206, Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference NN42020-146 01.07 Standard Release 4.0 19 October 2007 Index 437...
  • Page 438 243 moveAllUsers 165 moveUser 164 moveUsers 165 Music on Hold Error codes 384 folder 187, 187, 187, 188, 188, 189, 189, pool 188 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 439 214 Device 104 addDevice 104 addDevices 105 getCurrentDevices 108 getDevice 107 getDeviceByMacAddress 108 getDevices 107 getDevicesInDomain 108 getSubDomainForDevice 109 modifyDevice 106 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference NN42020-146 01.07 Standard Release 4.0 19 October 2007 Index 439...
  • Page 440 102 getNumberOfDomains 104 getOOBReferAccessCodesByDo- main 97 getParentDomain 100 getRootDomain 101 getStatusReasonsByDomain 85 modifyConvDesktopServiceData 93 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks modifyDomain 98 modifyDomainCos 87 modifyDomainLocales 83 modifyDomainProfile 89 modifyForeignDomain 102 modifyOOBReferAccessCodes 96...
  • Page 441 225 getErl 223 getLocation 222 getLocations 222 getLocationsByParent 222 getValidAniRegTimes 225 modifyErl 223 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks modifyLocation 221 purgeDeprecatedLocations 225 removeErl 224 removeLocation 221 Media Portal group 273...
  • Page 442 190 addBrandingFiles 191 addMusicOnHoldFolder 187 addMusicOnHoldFolders 187 addTreatmentFile 194 addTreatmentFiles 195 addTreatmentGroup 195 assignBranding 191 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks assignedTreatmentPool 196 assignMusicOnHoldFolder 187 Branding 190 getAssignedBrandingPool 192 getAssignedMusicOnHoldFolder 188...
  • Page 443 302 getUsersByRegistrationState 304 getUsersByRegStateAndClient- Type 304 getVMGForDomain 303 Telephony route 225 Telephony routes addNumberQualifier 227 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks addNumberQualifiers 227 addRouteList 236 addRouteLists 236 addTelephonyRoute 232 addTelephonyRoutes 233 assignDirectToGatewayPrefixData 240...
  • Page 444 114 getTimeBlockGroupByName 122 getTimeBlockGroupsByUser 122 getUser 161 getUserByDN 163 getUserByEndPointId 149 getUserCountInDomain 164 getUserCountInSubDomain 164 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks getUserData 116 getUserPresence 141 getUsersByDomain 162 getUsersByName 162 getUsersByStatus 163...
  • Page 445 253 getTrunkVoicemailServerByDo- main 249 getUsersForVoicemailServer 254 getVoicemailServerHost 243 modifyLineVoicemailServer 251 modifySIPVoicemailServer 245 modifyTrunkVoicemailServer 248 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks modifyVoicemailServerHost 243 removeLineVoicemailServer 253 removeSIPVoicemailServer 246 removeTrunkVoicemailServer 249 removeVoicemailServerHost 243 Out of band Refer...
  • Page 446 121 removeTimeZone 270 removeTreatmentFile 199 removeTreatmentGroup 199 removeTrunkVoicemailServer 249 removeUser 161 removeUserAddressBook 260, 320 removeUserData 115, 318 removeUserDirectToGWPrefixData 169 removeUserMCPrefixData 144, 144 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference NN42020-146 01.07 Standard Release 4.0 19 October 2007...
  • Page 447 319 getAddressBook 319 getAddressBookEntry 319 getAddressBookWithPhoto 320 getBuddies 320 getFullAddressBookEntry 320 getLightWeightAddressBook 320 makeBuddy 320 modifyAddressBookEntries 320 modifyAddressBookEntry 320 removeAddressBookEntries 321 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference NN42020-146 01.07 Standard Release 4.0 19 October 2007 Index 447...
  • Page 448 310 E911 location list 333 getLocationList 333 error codes 356 Global address book search 322 searchGABByFirstName 323 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks searchGABByFirstNameRange 323 searchGABByLastName 323 searchGABByLastNameRange 323...
  • Page 449 261, 261, 320, 320, 321 call logs 117, 118, 118, 118 client 144, 145, 145, 146, 146, 146 contact 170 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference NN42020-146 01.07 Standard Release 4.0 19 October 2007 Index 449...
  • Page 450 119, 120, 120, 121, 121, 122, 122 time block group 316, 316 time block groups 315, 316, 316 Nortel Multimedia Communication Server 5100 Application Programming Interfaces Reference Copyright © 2007, Nortel Networks voice mail 167, 167, 168, 254...
  • Page 452 Document version: 01.07 Document date: 19 October 2007 To provide feedback or report a problem with this document, go to www.nortel.com/documentfeedback. Sourced in Canada The information in this document is subject to change without notice. The statements, configurations, technical data, and recommendations in this document are believed to be accurate and reliable, but are presented without express or implied warranty.

Table of Contents