OpenScape Voice v10 SOAP-XML Application Developers Manual

Unify OpenScape Voice V10
Interface Manual
Volume 2
SOAP/XML Subscriber
Interface Provisioning
Description
A31003-H80A0-T101-1-7618
Provide feedback to further optimize this document to [email protected].
As reseller please address further presales related questions to the responsible

presales organization at Unify or at your distributor. For specific technical inquiries
you may use the support knowledgebase, raise - if a software support contract is in
place - a ticket via our partner portal or contact your distributor.
Our Quality and Environmental Management Systems are

implemented according to the requirements of the
ISO9001 and ISO14001 standards and are certified by an
external certification company.
Copyright © Unify Software and Solutions GmbH & Co. KG 11/2021

All rights reserved.
Reference No.: A31003-H80A0-T101-1-7618
The information provided in this document contains merely general

descriptions or characteristics of performance which in case of actual
use do not always apply as described or which may change as a result
of further development of the products.
An obligation to provide the respective characteristics shall only exist if
expressly agreed in the terms of contract.
Availability and technical specifications are subject to change without

notice.
Unify, OpenScape, OpenStage and HiPath are registered trademarks of

Unify Software and Solutions GmbH & Co. KG. All other company,
brand, product and service names are trademarks or registered
trademarks of their respective holders.
atos.net
Contents
Contents
1 Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
1.1 Deployment Network Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
1.2 Subscriber Interactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
1.2.1 Service Interactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
1.3 Subscriber Provisioning Network Architecture Layout. . . . . . . . . . . . . . . . . . . . . . . . . . . 24
1.3.1 Small Medium Enterprise . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
1.3.2 OpenScape Voice Assistant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
1.3.3 SIP Network Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
2 Changes Between Version V7 and V8 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
3 Design Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
3.1 Provisioning Traffic Volumes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
3.2 Sizing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
3.3 System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
3.4 Command Line Interface (CLI) Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
3.5 Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
3.6 Requirements for Using this Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
3.6.1 CRM Required Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
3.6.2 Required Interface Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
3.7 Standards Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
3.8 Interface Version Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
4 Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
4.1 Subscribers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
4.1.1 Profile Only Subscribers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
4.2 Feature Profiles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
4.3 Branch Offices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
4.4 Recent Change Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
4.4.1 Recent Change Logging in the SOAP Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
4.4.2 Recent Change Logging in SOAP Mass Provisioning and SOAP Export . . . . . . . . . . . . 50
4.5 Hunt Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
4.5.1 Types of Hunt Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
4.5.2 Hunt Algorithms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
4.5.3 Blocking of DNs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
4.5.4 Traffic Measurements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
4.5.5 Hunt Group Restrictions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
4.5.6 Hunt Group Traffic Measurements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
4.6 Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
4.7 Media Gateways and Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
4.8 Calling Number Display Modification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
4.8.1 Display Number Definition Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
4.8.2 Display Number Prefix Table. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
4.8.3 Display Number Modification Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
4.9 Business Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
4.10 Business Group Department and Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
4.10.1 Main Numbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
4.10.2 Attendant Numbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
A31003-H80A0-T101-1-7618, 11/2021
OpenScape Voice V10, Interface Manual: Volume 2, SOAP/XML Subscriber Interface Provisioning, Description
3
Contents
4.10.3 Message Detail Recording (MDR) Information . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

4.10.4 Business Group Subnet E911 LIN Administration . . . . . . . . . . . . . . . . . . . . . . . . . 65
4.11 Business Group Traffic Measurements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
4.12 Numbering Plan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
4.12.1 Service Activation Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
4.13 Keyset Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
4.13.1 Keyset Use (enum). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
4.13.2 Manual Hold Timer (range 5..3600) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
4.13.3 Line Appearances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
4.13.3.1 Keyset Operation Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
4.13.4 Call Forward LED Indication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
4.14 Office Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
4.15 Home DNs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
4.16 SIP Endpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
4.17 EndPoint Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
4.18 SIP Network Servers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
4.19 Dynamic CAC Router Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
5 External Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
5.1 Interface (WSDL) Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
5.1.1 The Interface WSDL and Interface Release Control. . . . . . . . . . . . . . . . . . . . . . . . . 73
5.2 Obsolete Method Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
5.3 SOAP / XML Conventions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
5.4 Primitive Data Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
5.4.1 Field Data Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
5.4.2 Field Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
5.5 Paging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
5.6 Return Code Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
6 Security on OpenScape Voice and the OS Voice SOAP Server Interface . . . . . . . . . . 88
6.1 Use of TLS with the OSV Soap Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
6.1.1 Configuration of RTP Parameters for TLS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
6.1.2 Certificates and TLS Verification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
6.2 Create Client Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
6.3 Modify Client Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
6.4 Delete Client Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
6.5 Get Client Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
6.6 Get Client Profile List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
6.7 Create PFR (Packet Filter Rule) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
6.8 Modify PFR (Packet Filter Rule) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
6.9 Delete PFR (Packet Filter Rule) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
6.10 Query PFR (Packet Filter Rule) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
6.11 Get PFR Symbolic Name List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
7 General Utility Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
7.1 Get Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
7.2 Get Feature List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
7.3 Get Config Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
7.4 Set Config Parm Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
7.5 Get Config Parm Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
7.6 Get COS List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
7.7 Get Rate Area List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
7.8 Get Intercept List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
A31003-H80A0-T101-1-7618, 11/2021
4OpenScape Voice V10, Interface Manual: Volume 2, SOAP/XML Subscriber Interface Provisioning, Description
Contents
7.9 Get Calling Location List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116

7.10 Get Associated SIP Endpoint List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
7.11 Get Licensing Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
7.12 Get Licensing Usage Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
7.13 Get Destination List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
7.14 Translate Dialed Digits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
7.15 Get Supported Language List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
7.16 Get Total Number of Call Pickup Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
7.17 Get Fully Qualified Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
7.18 Get System Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
7.19 Access EZIP Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
7.20 Contact Me . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
8 Network Management Interfaces via SOAP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
8.1 Office Code . . . . . . . . . . . . . . . . ............ . . . . . . . . . . . . . . . . . . . . . . . . . . 134
8.1.1 Create Office Code . . . . . . . . ............ . . . . . . . . . . . . . . . . . . . . . . . . . . 134
8.1.2 Modify Office Code . . . . . . . . ............ . . . . . . . . . . . . . . . . . . . . . . . . . . 135
8.1.3 Delete Office Code . . . . . . . . ............ . . . . . . . . . . . . . . . . . . . . . . . . . . 136
8.1.4 Display Office Code . . . . . . . . ............ . . . . . . . . . . . . . . . . . . . . . . . . . . 136
8.2 Home DN . . . . . . . . . . . . . . . . . . ............ . . . . . . . . . . . . . . . . . . . . . . . . . . 138
8.2.1 Create Home Dn . . . . . . . . . . ............ . . . . . . . . . . . . . . . . . . . . . . . . . . 138
8.2.2 Modify Home Dn . . . . . . . . . . ............ . . . . . . . . . . . . . . . . . . . . . . . . . . 139
8.2.3 Delete Home Dn . . . . . . . . . . ............ . . . . . . . . . . . . . . . . . . . . . . . . . . 141
8.2.4 Query Home Dn . . . . . . . . . . ............ . . . . . . . . . . . . . . . . . . . . . . . . . . 142
8.3 Endpoint . . . . . . . . . . . . . . . . . . ............ . . . . . . . . . . . . . . . . . . . . . . . . . . 144
8.3.1 Create Endpoint . . . . . . . . . . ............ . . . . . . . . . . . . . . . . . . . . . . . . . . 144
8.3.2 Modify Endpoint . . . . . . . . . . ............ . . . . . . . . . . . . . . . . . . . . . . . . . . 158
8.3.3 Delete Endpoint . . . . . . . . . . ............ . . . . . . . . . . . . . . . . . . . . . . . . . . 173
8.3.4 Query Endpoint. . . . . . . . . . . ............ . . . . . . . . . . . . . . . . . . . . . . . . . . 174
8.4 Destination. . . . . . . . . . . . . . . . . ............ . . . . . . . . . . . . . . . . . . . . . . . . . . 176
8.4.1 Create Destination . . . . . . . . ............ . . . . . . . . . . . . . . . . . . . . . . . . . . 176
8.4.2 Modify Destination . . . . . . . . ............ . . . . . . . . . . . . . . . . . . . . . . . . . . 178
8.4.3 Delete Destination . . . . . . . . ............ . . . . . . . . . . . . . . . . . . . . . . . . . . 179
8.4.4 Display Destination . . . . . . . . ............ . . . . . . . . . . . . . . . . . . . . . . . . . . 180
8.5 Rate Area. . . . . . . . . . . . . . . . . . ............ . . . . . . . . . . . . . . . . . . . . . . . . . . 181
8.5.1 Create Rate Area . . . . . . . . . ............ . . . . . . . . . . . . . . . . . . . . . . . . . . 181
8.5.2 Remove Rate Area . . . . . . . . ............ . . . . . . . . . . . . . . . . . . . . . . . . . . 182
8.5.3 Query Rate Area . . . . . . . . . . ............ . . . . . . . . . . . . . . . . . . . . . . . . . . 183
8.6 Class of Service . . . . . . . . . . . . . ............ . . . . . . . . . . . . . . . . . . . . . . . . . . 184
8.6.1 Create Class of Service . . . . . ............ . . . . . . . . . . . . . . . . . . . . . . . . . . 184
8.6.2 Delete Class of Service . . . . . ............ . . . . . . . . . . . . . . . . . . . . . . . . . . 184
8.6.3 Modify Class of Service . . . . . ............ . . . . . . . . . . . . . . . . . . . . . . . . . . 185
8.6.4 Query Class of Service. . . . . . ............ . . . . . . . . . . . . . . . . . . . . . . . . . . 185
8.7 Routing . . . . . . . . . . . . . . . . . . . ............ . . . . . . . . . . . . . . . . . . . . . . . . . . 186
8.7.1 Create Routing . . . . . . . . . . . ............ . . . . . . . . . . . . . . . . . . . . . . . . . . 186
8.7.2 Prioritize Routing . . . . . . . . . ............ . . . . . . . . . . . . . . . . . . . . . . . . . . 188
8.7.3 Modify Routing . . . . . . . . . . . ............ . . . . . . . . . . . . . . . . . . . . . . . . . . 189
8.7.4 Query Routing . . . . . . . . . . . ............ . . . . . . . . . . . . . . . . . . . . . . . . . . 191
8.7.5 Unassign Routing . . . . . . . . . ............ . . . . . . . . . . . . . . . . . . . . . . . . . . 193
8.8 Media Server . . . . . . . . . . . . . . . ............ . . . . . . . . . . . . . . . . . . . . . . . . . . 195
8.8.1 Create Media Server . . . . . . . ............ . . . . . . . . . . . . . . . . . . . . . . . . . . 195
8.8.2 Modify Media Server . . . . . . . ............ . . . . . . . . . . . . . . . . . . . . . . . . . . 198
A31003-H80A0-T101-1-7618, 11/2021
5
Contents
8.8.3 Remove Media Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199

8.8.4 Block / Unblock Media Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
8.8.5 Query Media Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
8.9 Media Server Circuits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
8.9.1 Create Media Server Circuits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
8.9.2 Remove Media Server Circuits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
8.9.3 Query Media Server Circuits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
8.10 CAC Group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
8.10.1 Create CAC Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
8.10.2 Delete CAC Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
8.10.3 Modify CAC Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
8.10.4 Query CAC Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
8.10.5 Add CAC Group Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
8.10.6 Remove CAC Group Addr. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
8.10.7 Get Ancestor Tree For CAC Group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
8.11 CAC Policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
8.11.1 Create CAC Policy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
8.11.2 Delete CAC Policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
8.11.3 Modify CAC Policy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
8.11.4 Query CAC Policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
8.11.5 Get Bandwidth Usage for CAC Policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
8.11.6 Create Group To Group CAC Policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
8.11.7 Delete Group To Group CAC Policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
8.11.8 Modify Group To Group CAC Policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
8.11.9 Query Group To Group CAC Policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
8.11.10 Get Bandwidth Usage for Group to Group CAC Policy . . . . . . . . . . . . . . . . . . . . 238
8.11.11 Query CAC Monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
8.12 Time Destination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
8.12.1 Create Time Destination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
8.12.2 Remove Time Destination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
8.12.3 Query Time Destination. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
8.13 Day Schedule. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
8.13.1 Create Day Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
8.13.2 Assign Day Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
8.13.3 Unassign Day Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
8.13.4 Modify Day Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
8.13.5 Remove Day Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
8.13.6 Query Day Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
8.14 Period Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
8.14.1 Create Period Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
8.14.2 Remove Period Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
8.14.3 Modify Period Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
8.14.4 Query Period Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
8.15 Weekly Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
8.15.1 Query Weekly Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
8.16 Intercept . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
8.16.1 Create Intercept. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
8.16.2 Remove Intercept. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
8.16.3 Modify Intercept. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
8.16.4 Query Intercept . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
8.17 Treatment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
8.17.1 Assign Treatment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
A31003-H80A0-T101-1-7618, 11/2021
Contents
8.17.2 Modify Treatment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270

8.17.3 Unassign Treatment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
8.17.4 Query Treatment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
8.17.5 Prioritize Treatment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
8.17.6 Bulk Assign Treatments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
8.17.7 Bulk Modify Treatments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
8.17.8 Bulk Unassign Treatments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
8.18 SIP Trusted Entity Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
8.18.1 Add SIP Trusted Entity Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
8.18.2 Remove SIP Trusted Entity Ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
8.18.3 Get SIP Trusted Entity Ports List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
8.19 System SIP Entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
8.19.1 Add System SIP Entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
8.19.2 Modify System SIP Entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
8.19.3 Delete System SIP Entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
8.19.4 Get System SIP Entry Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
8.19.5 Get System SIP Entry List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
8.20 Stat Counter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
8.20.1 Get Stat Counter Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
8.20.2 Get Stat Counter List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
8.21 Database Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
8.21.1 Create Database Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
8.21.2 Cancel Database Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
8.21.3 Delete Database Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
8.21.4 Get Database Job List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
8.22 Calling Location. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
8.22.1 Create Calling Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
8.22.2 Modify Calling Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
8.22.3 Remove Calling Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
8.22.4 Query Calling Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
8.23 Origin Destination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
8.23.1 Create Origin Destination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
8.23.2 Modify Origin Destination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
8.23.3 Remove Origin Destination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
8.23.4 Query Origin Destination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
8.24 Origin Route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
8.24.1 Create Origin Route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
8.24.2 Modify Origin Route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
8.24.3 Remove Origin Route. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
8.24.4 Query Origin Route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
8.25 Get Generic Object Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
8.26 Generic Query. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
8.26.1 Generic Query Enhanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
8.27 Code Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
8.27.1 Create Code Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
8.27.2 Modify Code Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
8.27.3 Remove Code Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
8.27.4 Query Code Process. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
8.27.5 List Code Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
8.28 ENUM Provisioning. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
8.28.1 Create Enum Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
8.28.2 Modify Enum Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
A31003-H80A0-T101-1-7618, 11/2021
7
Contents
8.28.3 Remove Enum Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326

8.28.4 Query Enum Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
8.28.5 List Enum Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327
8.28.6 Create Operator Enum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328
8.28.7 Modify Operator Enum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329
8.28.8 Remove Operator Enum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330
8.28.9 Query Operator Enum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330
8.28.10 List Operator Enum. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
8.29 File System Backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
8.29.1 Create File System Backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
8.29.2 Cancel File System Backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334
8.29.3 Query File System Backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335
8.30 Get DB Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337
8.30.1 Get DB Version Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337
8.31 Endpoint Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338
8.31.1 Create Endpoint Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338
8.31.2 Modify Endpoint Location. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338
8.31.3 Query Endpoint Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338
8.31.4 Remove Endpoint Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
8.32 Endpoint Provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
8.32.1 Create Endpoint Provider. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340
8.32.2 Modify Endpoint Provider. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340
8.32.3 Query Endpoint Provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340
8.32.4 Remove Endpoint Provider. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
9 Subscriber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342
9.1 Create Subscriber. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342
9.2 Get Subscriber Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361
9.2.1 Get Subscriber Info By Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378
9.2.2 Get Sub Info By Rel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378
9.2.3 Get Subscriber RG Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379
9.3 Get Subscriber List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381
9.4 Get TombStone Subscriber List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389
9.5 Get Keyset Primary List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391
9.6 Delete Subscriber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
9.7 Update Subscriber Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393
9.8 Update Subscriber Account Mgt Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394
9.9 Update Subscriber BG Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396
9.10 Update Subscriber Account User Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398
9.11 Update Keyset Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401
9.12 Update Subscriber Dn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403
9.13 Update Subscriber Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405
9.14 Get Sub Tran Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408
9.15 Update Connection Info. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409
9.16 Update Subscriber Feature Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411
9.17 Add Contact List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412
9.18 Delete Contact List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413
9.19 Get Contact List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414
9.20 Update Mobile Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415
10 Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419
10.1 Account Code (CfAcctCode) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419
10.2 Anonymous Caller Rejection (CfACR) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420
A31003-H80A0-T101-1-7618, 11/2021
Contents
10.3 Attendant Answering Position (CfBgNBCPU) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421

10.4 Authorization Code (CfAuthCode) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422
10.5 Call Transfer for Endpoint (SIP Applications) (CfEpCT) . . . . . . . . . . . . . . . . . . . . . . . . 423
10.6 Completion of Calls on Busy Subscriber (CfCCBS) . . . . . . . . . . . . . . . . . . . . . . . . . . . 424
10.7 Completion of Calls on No Reply (CfCCNR) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424
10.8 Call Forward Invalid (CfCFID) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425
10.9 Call Forward System Internal External (CfCFSIE) . . . . . . . . . . . . . . . . . . . . . . . . . . . 425
10.10 Call Forward Unreachable (CfCFD) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428
10.11 Call Forwarding - All Calls (CfCFV) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429
10.12 Call Forwarding Busy Line (CfCFB) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431
10.13 Call Forwarding Don’t Answer (CfCFDA) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433
10.14 Call Forwarding Voice Mail (CfVM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436
10.15 Call Forwarding Override (CfCFO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437
10.16 Call Pickup (CfBgCPU) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438
10.17 Call Pickup Directed (CfCPUD) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438
10.18 Called Party Name Delivery (CfCISNAME) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439
10.19 Called Party Number Delivery (CfCISNUM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439
10.20 Calling Identity Delivery and Suppression (CfCIDS) . . . . . . . . . . . . . . . . . . . . . . . . . 439
10.21 Calling Name Delivery (CfCNAM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439
10.22 Calling Name Delivery (BG) (CfBgCNAM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439
10.23 Calling Name Delivery Blocking (CfCNAB) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440
10.24 Calling Number Delivery (CfCND) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440
10.25 Calling Number Delivery Blocking (CfCNDB) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440
10.26 CSTA for ComAssistant (CfCSTA). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440
10.27 Customer Originated Trace (CfMCT). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441
10.28 Deny Terminating Feature (CfDTF) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442
10.29 E9-1-1 LIN Administration (CfBgE911LIN) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442
10.30 Executive Override (CfEXO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444
10.31 Distinctive Ringing (CfBgDR). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444
10.32 Do Not Disturb (CfDND) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445
10.33 Hot Desking (CfHotDesk) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446
10.33.1 Hot Desking (BG) (CfBgHotDesk) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447
10.34 Keyset Operation (CfBgKS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447
10.35 Station Controlled Conference (CfBgLC or CfSCC) . . . . . . . . . . . . . . . . . . . . . . . . . . 449
10.36 Music On Hold (CfMOH) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450
10.37 One Number Service (CfONS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451
10.38 Remote Activation of Call Forwarding (CfRACF) . . . . . . . . . . . . . . . . . . . . . . . . . . . 453
10.39 Remote Call Forwarding (CfRCF) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453
10.40 Selective Call Acceptance (CfSCA) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454
10.41 Selective Call Forwarding (CfSCF) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455
10.42 Selective Call Rejecting (CfSCR) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456
10.43 Serial Ringing (CfSERRNG) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457
10.44 Simultaneous Ringing (CfSRS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458
10.45 Station Restrictions (Business Group) (CfSR) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459
10.46 Station Speed Calling (CfSPCALL) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460
10.47 System Speed Dial (CfBgSpDial) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462
10.48 Time-of-Day Call Forwarding (CfECF) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463
10.49 Toll and Call Restrictions (CfTRS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465
10.50 Traffic Measurement (CfBgTM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467
10.51 BG Silent Monitoring (CfBgSILM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467
10.52 Silent Monitoring Protection Feature (CfSILMProtection) . . . . . . . . . . . . . . . . . . . . . . 468
10.53 Silent Monitoring Feature (CfSILM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468
A31003-H80A0-T101-1-7618, 11/2021
9
Contents
10.54 Silent Monitoring Tag Feature (CfSILMTag) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469

10.55 Call Forwarding Restrictions (CfCFR) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470
10.56 Call Park to Server (CfCPS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470
10.57 Automatic Collect Call Blocking for Brazil . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471
10.58 Openscape Mobile Service (OSMO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472
10.59 Routing Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474
10.60 Network Wide Call Park to Server (Endpoint Profiles) . . . . . . . . . . . . . . . . . . . . . . . 475
10.61 CSTA Application external device name provider (Endpoint Profiles) . . . . . . . . . . . . . 476
10.62 Silent Monitoring Supervisor Feature (CfSILMS) . . . . . . . . . . . . . . . . . . . . . . . . . . . 477
10.63 Silent Monitoring Agent Feature (CfSILMA) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478
11 Business Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480
11.1 Create BG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480
11.2 Update BG Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481
11.3 Add BG Main Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482
11.4 Delete BG Main Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483
11.5 Update BG Main Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484
11.6 Update BG Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485
11.7 Get BG Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487
11.7.1 Get BG Info By Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487
11.8 Get BG List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488
11.9 Delete BG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489
11.10 Get BG Attendant Numbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491
11.11 Delete BG Cpu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491
11.12 Update BG Parms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493
11.13 Business Group Departments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495
11.13.1 Create BG Dept . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495
11.13.2 Delete BG Dept . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496
11.13.3 Modify BG Dept . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 498
11.13.4 Get BG Dept List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 498
11.14 Business Group Subnets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499
11.14.1 Get Bg Subnet Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500
11.14.2 Create Bg Subnet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504
11.14.3 Get Bg Subnet List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506
11.14.4 Delete Bg Subnet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510
11.14.5 Update Bg Subnet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511
11.14.6 Get Bg Subnet And LIN List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515
11.15 Business Group Authorization Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518
11.15.1 Create Auth Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518
11.15.2 Delete Auth Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519
11.15.3 Get Auth Code List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520
11.15.3.1 Get Auth Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521
11.16 Modify Auth Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 522
11.17 Private Numbering Plan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523
11.18 Business Group System Speed Dial Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 524
11.18.1 Create Bg Speed Dial List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525
11.18.2 Update Bg Speed Dial List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526
11.18.3 Update Bg Speed Dial List Entries. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
11.18.4 Delete Bg Speed Dial List Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529
11.18.5 Delete Bg Speed Dial List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530
11.18.6 Get Bg Speed Dial List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531
11.18.7 Get Bg Speed Dial List Ids . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533
A31003-H80A0-T101-1-7618, 11/2021
10 OpenScape Voice V10, Interface Manual: Volume 2, SOAP/XML Subscriber Interface
Provisioning, Description
Contents
11.19 Business Group Parking Lots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535

11.19.1 Create Parking Lot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535
11.19.2 Update Parking Lot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536
11.19.3 Delete Parking Lot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 538
11.19.4 Query Parking Lot Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 539
11.19.5 Query Parking Lot List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540
11.19.6 Query Parking Lot Usage List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541
11.20 Multiple Media Servers per Branch Office . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 544
11.20.1 Assign Media Server to Branch Office. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 544
11.20.2 Unassign Media Server from Branch Office . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545
11.20.3 Get Media Server Assignment List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 547
11.21 Branch Office . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 548
11.21.1 Create Branch Office . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549
11.21.2 Modify Branch Office . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550
11.21.3 Query Branch Office. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 551
11.22 Remove Branch Office . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 553
11.23 Remote Call Pickup Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 553
11.23.1 Add CPU Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 553
11.23.2 Modify CPU Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554
11.23.3 Add Local CPU Members . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554
11.23.4 Modify Local CPU Members . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 555
11.23.5 Remove Local CPU Members . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 556
11.23.6 Add Remote Call Pickup Groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 556
11.23.7 Modify Remote Call Pickup Groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 557
11.23.8 Remove Remote Call Pickup Groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 558
11.23.9 Get Call Pickup Group List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 559
11.23.10 Get Call Pickup Group Member List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560
11.23.11 Get Local CPU Members List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 561
11.23.12 Get Remote CPU Members List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 562
11.24 Community Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 562
11.24.1 Add Community Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 563
11.24.2 Modify Community Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 564
11.24.3 Remove Community Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 564
11.24.4 Query Community Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565
11.24.5 Add Community Group Member . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566
11.24.6 Modify Community Group Member. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 567
11.24.7 Remove Community Group Member. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 568
11.24.8 Query Community Group Member . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 568
11.25 Broadcast Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 570
11.25.1 Add Bcast Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 570
11.25.2 Modify Bcast Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 571
11.25.3 Remove Bcast Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572
11.25.4 Query Bcast Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572
11.25.5 Add Bcast Members . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573
11.25.6 Modify Bcast Members . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574
11.25.7 Remove Bcast Member. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575
11.25.8 Query Bcast Members . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 575
11.26 BG Suite. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576
11.26.1 Create BG Suite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 577
11.26.2 Configuration of the Extension Dialing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 579
11.26.3 Prefix Access Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 579
11.26.4 Destination Codes for Extension dialing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 579
A31003-H80A0-T101-1-7618, 11/2021
11
Contents
11.26.5 Extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 580

12 Numbering Plans. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581
12.1 Numbering Plan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581
12.1.1 Create Number Plan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581
12.1.2 Update Number Plan. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 582
12.1.3 Delete Number Plan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 583
12.1.4 Get Number Plan List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 584
12.1.5 Get Number Plan ID Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 586
12.1.6 Get Extended Numbering Plan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 586
12.2 Destination Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 588
12.2.1 Create Dest Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 588
12.2.2 Modify Dest Code Info. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 592
12.2.3 Delete Dest Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595
12.2.4 Get Dest Code List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 597
12.2.5 Get Dest Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599
12.2.6 Get Dest Service List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 600
12.3 Prefix Access Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 600
12.3.1 Create Prefix Access Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 600
12.3.2 Modify Prefix Access Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605
12.3.3 Delete Prefix Access Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610
12.3.4 Get Prefix Access Code List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 612
12.3.5 Get Prefix Access Code One . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615
12.4 Private Numbering Plan Location Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 616
12.4.1 Create PNP Location Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 616
12.4.2 Modify PNP Location Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 617
12.4.3 Delete PNP Location Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 618
12.4.4 Get PNP Location Code List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 619
12.5 PNP Extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 620
12.5.1 Create PNP Extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 620
12.5.2 Modify PNP Extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 622
12.5.3 Delete PNP Extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 623
12.5.4 Get PNP Extension List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 624
12.6 Domain Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 625
12.6.1 Create Domain Code. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 625
12.6.2 Modify Domain Code. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 627
12.6.3 Query Domain Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 628
12.6.4 Delete Domain Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 630
13 Number Modification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 632
13.1 DNM Prefixes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 632
13.1.1 Create DNM Prefix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 633
13.1.2 Modify DNM Prefix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634
13.1.3 Delete DNM Prefix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 635
13.1.4 Query DNM Prefix. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 637
13.1.5 Query DNM PrefixList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 639
13.2 DNM Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 640
13.2.1 Create DNM Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 641
13.2.2 Modify DNM Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 644
13.2.3 Delete DNM Definition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 645
13.2.4 Query DNM Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647
13.2.5 Query DNM Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 649
13.3 DNM Modification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 650
A31003-H80A0-T101-1-7618, 11/2021
Contents
13.3.1 Create DNM Modification . . . . . . . . . . . . . . . . . . . . . . . .................. 652

13.3.2 Modify DNM Modification . . . . . . . . . . . . . . . . . . . . . . . .................. 656
13.3.3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Delete DNM Modification 658
13.3.4 Query DNM Modification . . . . . . . . . . . . . . . . . . . . . . . . .................. 659
13.4 DNM Normalizations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .................. 661
13.4.1 Input Patterns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .................. 662
13.4.2 Output Expression . . . . . . . . . . . . . . . . . . . . . . . . . . . . .................. 663
13.4.3 Create DNM Normalization . . . . . . . . . . . . . . . . . . . . . . .................. 664
13.4.4 Modify DNM Normalization . . . . . . . . . . . . . . . . . . . . . . .................. 666
13.4.5 Delete DNM Normalization . . . . . . . . . . . . . . . . . . . . . . .................. 668
13.4.6 Query DNM Normalization . . . . . . . . . . . . . . . . . . . . . . .................. 669
13.5 DNM Conversions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .................. 671
13.5.1 Create DNM Conversion . . . . . . . . . . . . . . . . . . . . . . . . .................. 673
13.5.2 Modify DNM Conversion . . . . . . . . . . . . . . . . . . . . . . . . .................. 674
13.5.3 Delete DNM Conversion . . . . . . . . . . . . . . . . . . . . . . . . .................. 676
13.5.4 Query DNM Conversion . . . . . . . . . . . . . . . . . . . . . . . . .................. 677
13.6 DNM Local Toll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .................. 679
13.6.1 Create DNM LocalToll. . . . . . . . . . . . . . . . . . . . . . . . . . .................. 680
13.6.2 Modify DNM LocalToll. . . . . . . . . . . . . . . . . . . . . . . . . . .................. 683
13.6.3 Delete DNM LocalToll . . . . . . . . . . . . . . . . . . . . . . . . . . .................. 684
13.6.4 Query DNM LocalToll . . . . . . . . . . . . . . . . . . . . . . . . . . .................. 686
14 Feature Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 688
14.1 Create Feature Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 688
14.2 Update Feature Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 689
14.3 Delete Feature Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 690
14.4 Get Feature Profile List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 691
14.5 Get Feature Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 692
15 Hunt Groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 694
15.1 Terminals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 695
15.2 Hunt Group Phone Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 696
15.2.1 Create Mlhg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 697
15.2.2 Modify Mlhg Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 703
15.2.3 Delete Mlhg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 708
15.2.4 Get Mlhg Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 708
15.2.5 Add Sub To Mlhg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 714
15.2.6 Create Mlhg Term . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 717
15.2.7 Modify Mlhg TermInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 717
15.2.8 Delete Mlhg Term . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 720
15.2.9 Get Mlhg TM Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 721
16 Endpoint Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 722
16.1 Create Ep Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 722
16.1.1 Update Ep Mgt Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 726
16.1.2 Update Ep Capabilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 729
16.1.3 Update Ep Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 731
16.1.4 Get Ep Info. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 731
16.1.5 Get Ep Info By Release . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 733
16.1.6 Get EP List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 734
16.1.7 Delete Ep Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 735
17 Background Job Processing Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 736
17.1 Jobs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 736
A31003-H80A0-T101-1-7618, 11/2021
13
Contents
17.1.1 Get Job Info. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 736

17.1.2 Get Job List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 738
17.1.3 Get Job List By Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 739
17.1.4 Cancel Job. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 739
18 Dynamic CAC Router Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 741
18.1 Notify CAC Primary Link Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 741
18.2 Get CAC Primary Link Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 741
18.3 Get Provisioned CAC Primary Links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 742
18.4 Reset All CAC Primary Links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 743
19 Executive Assistant Functionality with Cockpit Application . . . . . . . . . . . . . . . . . . 745
19.1 Executive Assistant Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 745
19.1.1 Create Executive Assistant Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 745
19.1.2 Delete Executive Assistant Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 746
19.1.3 Update Executive Assistant Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 747
19.1.4 Get List of Executive Assistant Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 749
19.1.5 Get Extended Executive Assistant Group List . . . . . . . . . . . . . . . . . . . . . . . . . . . 750
19.2 Executive Assistant Group Members . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 751
19.2.1 Create Executive Assistant Group Member . . . . . . . . . . . . . . . . . . . . . . . . . . . . 751
19.3 Delete Executive Assistant Group Member . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 753
19.3.1 Get List of Executive Assistant Group Members . . . . . . . . . . . . . . . . . . . . . . . . . 754
19.4 Executive Assistant Group Member Relations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 755
19.4.1 Create Executive Assistant Group Member Relation . . . . . . . . . . . . . . . . . . . . . . 755
19.4.2 Delete Executive Assistant Group Member Relation . . . . . . . . . . . . . . . . . . . . . . 756
19.4.3 Get Executive Assistant Group Member Relation List. . . . . . . . . . . . . . . . . . . . . . 757
19.5 Executive Assistant Group Member Auxiliary Lines . . . . . . . . . . . . . . . . . . . . . . . . . . 758
19.5.1 Create Executive Assistant Group Member Auxiliary Line. . . . . . . . . . . . . . . . . . . 759
19.5.2 Delete Executive Assistant Group Member Auxiliary Line . . . . . . . . . . . . . . . . . . . 760
19.5.3 Get Executive Assistant Group Member Relations . . . . . . . . . . . . . . . . . . . . . . . . 761
19.6 Executive Assistant Cockpit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 762
19.6.1 Get Executive Assistant Cockpit List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 762
19.6.2 Get Executive Assistant Cockpit Configuration Data . . . . . . . . . . . . . . . . . . . . . . 763
19.6.3 Get Executive Assistant Cockpit Dynamic Data. . . . . . . . . . . . . . . . . . . . . . . . . . 764
19.6.4 Update Executive Assistant Cockpit Dynamic Data . . . . . . . . . . . . . . . . . . . . . . . 765
20 Upgrade and Remote Patching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 768
20.1 Get Node Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 768
20.2 Get Node Patch Set List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 769
20.3 Get SIS Patch Set List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 770
20.4 Upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 772
20.5 Upgrade Second Node. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 774
20.6 Get Upgrade Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 775
20.7 Upgrade Commit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 776
20.8 Upgrade Fallback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 777
20.9 Get Node Health. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 777
20.10 Query Operation Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 779
20.11 Modify Operation Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 780
20.12 Get Database Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 780
21 Traffic Types and Classes of Restrictions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 783
21.1 Create Traffic Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 783
21.2 Modify Traffic Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 785
21.3 Delete Traffic Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 786
A31003-H80A0-T101-1-7618, 11/2021
Contents
21.4 Query Traffic Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 787

21.5 Create Class Of Restrictions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 788
21.6 Modify Class Of Restrictions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 789
21.7 Delete Class Of Restrictions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 790
21.8 Query Class Of Restrictions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 790
21.9 Query Class Of Restrictions Info List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 791
21.10 Query COR Usage List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 792
21.11 Query COR Group Key List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 793
21.12 CSTA Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 795
21.12.1 GetCSTAApplicationList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 795
21.12.2 CreateCSTAApplication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 797
21.12.3 ModifyCSTAApplication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 800
21.12.4 QueryCSTAApplication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 804
21.12.5 GetCSTAActiveDeviceList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 807
21.12.6 DeleteCSTAApplication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 809
21.12.7 GetCSTASMInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 810
22 CSTA Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 813
22.1 Get CSTA Application List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 813
22.2 Create CSTA Application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 815
22.3 Modify CSTA Application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 821
22.4 Query CSTA Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 825
22.5 Get CSTA Active Device List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 829
22.6 Delete CSTA Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 832
22.7 Get CSTASM Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 833
23 Continuous Trace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 835
23.1 Get Continuous Trace Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 835
23.2 Activate Continuous Trace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 836
23.3 DeActivate Continuous Trace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 837
23.4 Start File Export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 837
23.5 Stop File Export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 838
24 Alarms and Log Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 840
24.1 Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 840
24.1.1 SOAP Server Process Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 840
24.1.2 SOAP Server Process Startup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 841
24.1.3 Submgt Schedule Process Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 842
24.1.4 Submgt Schedule Process Startup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 842
24.1.5 Error Removing Old Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 843
24.1.6 Old Jobs Removed Successfully . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 844
24.2 Log Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 844
24.2.1 Error Accessing the Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 845
24.2.2 Provisioning Error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 845
24.3 Display of OSV Error Provisoning Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 846
25 Import and Export of SOAP Provisioned Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . 849
25.1 Export and Mass Provisioning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 849
25.1.1 Importing Subscriber Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 849
25.1.2 Exporting Subscriber Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 852
25.2 Supported Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 856
25.2.1 Add Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 857
25.2.1.1 Supported Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 857
25.2.2 Remove Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 880
A31003-H80A0-T101-1-7618, 11/2021
15
Contents
25.2.3 Modify Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 881

25.2.4 Deny Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 881
25.2.5 Add Feature Profile Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 881
25.2.6 Remove Feature Profile Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 882
25.2.7 Modify Feature Profile Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 882
25.2.8 Add Business Group Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 882
25.2.8.1 Supported Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 883
25.2.9 Remove Business Group Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 884
25.2.10 Add End Point Profile Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 884
25.2.10.1 Supported Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 884
25.2.11 Create CSTA Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 890
25.2.12 Modify CSTA Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 890
25.2.13 Delete CSTA Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 891
25.2.14 Delete End Point Profile Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 891
25.2.15 Create Subscriber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 891
25.2.16 Delete Subscriber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 896
25.2.17 Update Subscriber Directory Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 896
25.2.18 Create Hunt Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 896
25.2.19 Modify Mlhg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 897
25.2.20 Remove Hunt Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 898
25.2.21 Add Subscriber To Hunt Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 898
25.2.22 Modify Hunt Group Terminal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 898
25.2.23 Remove Hunt Group Terminal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 898
25.2.24 Create Feature Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 899
25.2.25 Delete Feature Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 899
25.2.26 Update Subscriber Feature Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 899
25.2.27 Update Subscriber Account Management Info . . . . . . . . . . . . . . . . . . . . . . . . . 899
25.2.28 Update Account Business Group Information . . . . . . . . . . . . . . . . . . . . . . . . . . 900
25.2.29 Update Subscriber PIC Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 900
25.2.30 Update Subscriber QoS Profile Information . . . . . . . . . . . . . . . . . . . . . . . . . . . 900
25.2.31 Update Subscriber Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 901
25.2.32 Update Subscriber User information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 901
25.2.33 Update Connection Information for a SIP Subscriber. . . . . . . . . . . . . . . . . . . . . 902
25.2.34 Add Contact Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 902
25.2.35 Remove Contact Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 905
25.2.36 Create Business Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 907
25.2.37 Delete Business Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 907
25.2.38 Update Business Group Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 907
25.2.39 Add Business Group Main Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 907
25.2.40 Delete Business Group Main Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 908
25.2.41 Update Business Group MDR Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . 908
25.2.42 Update Business Group Media Server Information . . . . . . . . . . . . . . . . . . . . . . 908
25.2.43 Update Subscriber Keyset Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 908
25.2.44 Create Business Group Department . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 910
25.2.45 Delete Business Group Department . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 910
25.2.46 Create Business Group E9-1-1 Subnet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 911
25.2.47 Delete Business Group E9-1-1 Subnet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 911
25.2.48 Update Business Group E9-1-1 Subnet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 912
25.2.49 Create Endpoint Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 912
25.2.50 Delete Endpoint Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 913
25.2.51 Update Endpoint Profile Management Information . . . . . . . . . . . . . . . . . . . . . . 913
25.2.52 Update Endpoint Profile PICs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 913
A31003-H80A0-T101-1-7618, 11/2021
Contents
25.2.53 Update Endpoint Profile QoS Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 913

25.2.54 Create QoS Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 914
25.2.55 Modify QoS Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 915
25.2.56 Delete QoS Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 916
25.2.57 Create Destination Code. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 916
25.2.58 Modify Destination Code. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 917
25.2.59 Remove Destination Code. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 917
25.2.60 Create Number Plan. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 917
25.2.61 Remove Number Plan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 918
25.2.62 Create Authorization Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 918
25.2.63 Delete Authorization Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 918
25.2.64 Create Prefix Access Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 919
25.2.65 Create PNP Location Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 919
25.2.66 Update PNP Location Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 919
25.2.67 Remove PNP Location Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 920
25.2.68 Update Prefix Access Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 920
25.2.69 Remove Prefix Access Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 920
25.2.70 Create PNP Extension. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 921
25.2.71 Update PNP Extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 921
25.2.72 Remove PNP Extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 921
25.2.73 Create Display Number Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 921
25.2.74 Delete Display Number Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 922
25.2.75 Create Display Number Prefix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 922
25.2.76 Modify Display Number Prefix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 922
25.2.77 Delete Display Number Prefix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 923
25.2.78 Create Display Number Modification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 923
25.2.79 Modify Display Number Modification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 923
25.2.80 Delete Display Number Modification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 923
25.2.81 Update Business Group Common Numbering Plan . . . . . . . . . . . . . . . . . . . . . . . 924
25.2.82 Update Business Group Default QoS profile . . . . . . . . . . . . . . . . . . . . . . . . . . . 924
25.2.83 Create CAC Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 924
25.2.84 Delete CAC Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 925
25.2.85 Remove CAC Group Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 926
25.2.86 Add CAC Group Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 927
25.2.87 Create CAC Policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 928
25.2.88 Delete CAC Policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 929
25.2.89 Create Group To Group CAC Policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 929
25.2.90 Delete Group To Group CAC Policy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 930
25.2.91 Create Business Group Speed Calling List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 930
25.2.92 Update Business Group Speed Calling List . . . . . . . . . . . . . . . . . . . . . . . . . . . . 930
25.2.93 Delete Business Group Speed Calling List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 930
25.2.94 Delete Business Group Speed Calling List Entries . . . . . . . . . . . . . . . . . . . . . . . 931
25.2.95 Update Business Group Speed Calling List Entries . . . . . . . . . . . . . . . . . . . . . . . 931
25.2.96 Assign Day Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 931
25.2.97 Assign Treatment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 932
25.2.98 Block Media Gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 932
25.2.99 Block Trunk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 932
25.2.100 Block Trunk Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 933
25.2.101 Create Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 933
25.2.102 Create Calling Location. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 933
25.2.103 Create Class Of Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 933
25.2.104 Create Code Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 934
A31003-H80A0-T101-1-7618, 11/2021
17
Contents
25.2.105 Create Day Schedule. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 934

25.2.106 Create Destination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 934
25.2.107 Create Endpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 935
25.2.108 Create HomeDN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 936
25.2.109 Create Intercept . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 936
25.2.110 Create Media Gateway Circuits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 937
25.2.111 Create Media Gateway. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 937
25.2.112 Create Office Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 937
25.2.113 Create Origin Destination. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 938
25.2.114 Create Origin Route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 938
25.2.115 Create Period Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 938
25.2.116 Create Rate Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 939
25.2.117 Create Route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 939
25.2.118 Create Time Destination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 939
25.2.119 Create Trunk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 940
25.2.120 Create Trunk Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 940
25.2.121 Modify Class Of Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 941
25.2.122 Modify Code Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 941
25.2.123 Modify Day Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 941
25.2.124 Modify Destination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 942
25.2.125 Modify Endpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 942
25.2.126 Modify HomeDN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 943
25.2.127 Modify Intercept . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 943
25.2.128 Modify Media Gateway. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 944
25.2.129 Modify Office Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 944
25.2.130 Modify Origin Destination. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 944
25.2.131 Modify Origin Route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 945
25.2.132 Modify Period Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 945
25.2.133 Modify Route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 945
25.2.134 Modify Treatment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 946
25.2.135 Modify Trunk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 946
25.2.136 Modify Trunk Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 947
25.2.137 Prioritize Route. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 947
25.2.138 Prioritize Treatment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 948
25.2.139 Remove Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 948
25.2.140 Remove Calling Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 948
25.2.141 Remove Class Of Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 948
25.2.142 Remove Code Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 949
25.2.143 Remove Day Schedule. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 949
25.2.144 Remove Destination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 949
25.2.145 Remove Endpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 949
25.2.146 Remove HomeDN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 950
25.2.147 Remove Intercept . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 950
25.2.148 Remove Media Gateway Circuits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 950
25.2.149 Remove Media Gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 950
25.2.150 Remove Office Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 951
25.2.151 Remove Origin Destination. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 951
25.2.152 Remove Origin Route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 951
25.2.153 Remove Period Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 951
25.2.154 Remove Rate Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 951
25.2.155 Remove Time Destination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 952
25.2.156 Remove Trunk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 952
A31003-H80A0-T101-1-7618, 11/2021
Contents
25.2.157 Remove Trunk Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 952

25.2.158 Unassign Day Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 952
25.2.159 Unassign Route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 953
25.2.160 Unassign Treatment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 953
25.2.161 Create Enum Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 953
25.2.162 Modify Enum Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 954
25.2.163 Remove Enum Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 954
25.2.164 Create Operator Enum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 954
25.2.165 Modify Operator Enum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 954
25.2.166 Remove Operator Enum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 955
25.2.167 Set RTP Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 955
25.2.168 Create Disconnect DN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 955
25.2.169 Update Dn Reservation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 956
25.2.170 Create a Parking Lot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 956
25.2.171 Update a Parking Lot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 956
25.2.172 Delete a Parking Lot. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 956
25.2.173 Add Community Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 957
25.2.174 Add Community Group Member. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 957
25.2.175 Modify Community Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 957
25.2.176 Modify Community Group Member . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 957
25.2.177 Remove Community Group Member. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 957
25.2.178 Remove Community Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 958
25.2.179 Update Subscriber Mobile Info. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 958
25.2.180 Create Traffic Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 958
25.2.181 Modify Traffic Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 958
25.2.182 Delete Traffic Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 959
25.2.183 Create Class Of Restrictions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 959
25.2.184 Modify Class Of Restrictions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 961
25.2.185 Create Call Pickup Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 963
25.2.186 Modify Call Pickup Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 963
25.2.187 Delete Call Pickup Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 964
25.2.188 Add Local Call Pickup Group member . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 964
25.2.189 Modify Local Call Pickup Group member . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 964
25.2.190 Remove local Call Pickup Group member . . . . . . . . . . . . . . . . . . . . . . . . . . . . 964
25.2.191 Add Remote Call Pickup Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 965
25.2.192 Modify Remote Call Pickup Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 965
25.2.193 Remove Remote Call Pickup Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 965
25.2.194 Create Domain Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 965
25.2.195 Modify Domain Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 966
25.2.196 Delete Domain Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 966
25.2.197 Create CSTA Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 966
25.2.198 Modify CSTA Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 967
25.2.199 Create Branch Office . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 967
25.2.200 Modify Branch Office . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 969
25.2.201 Remove Branch Office . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 970
26 Subscriber Provisioning Result Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 971
26.1 Result Code Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 971
26.2 ResultMsgNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 973
26.3 Result Text Strings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 973
26.4 ResultTOY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 974
26.5 Result Codes/Result Text Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 974
A31003-H80A0-T101-1-7618, 11/2021
19
Contents
27 Using SOAP to Provision the OpenScape Voice Assistant . . . . . . . . . . . . . . . . . . . . 975

27.1 RTP Configuration Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 975
27.1.1 Set an RTP Parameter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 978
27.1.2 Display the List of Accessible RTP Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . 978
27.2 Call Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 984
27.2.1 Display the Counter Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 984
27.2.2 Display the Counter Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 985
27.2.3 Display the Counter Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 985
27.3 Database Backup and Restore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 986
27.3.1 Create Database Job Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 987
27.3.2 Cancel Database Job Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 987
27.3.3 Get Database Job List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 987
27.3.4 Values for Job Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 987
27.4 Managing Time Destinations Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 988
27.4.1 Time Destination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 989
27.4.2 Day Schedule. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 989
27.4.3 Period Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 991
27.5 SIP Signaling Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 993
27.5.1 Assign Port Range . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 993
27.5.2 Unassign Port Range. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 994
27.5.3 Display Port Ranges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 994
27.6 Billing and CDR Generation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 995
27.7 Tones and Announcements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 995
27.7.1 Intercepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 996
27.7.1.1 Create an Intercept . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 996
27.7.1.2 Modify an Intercept . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 996
27.7.1.3 Remove an Intercept . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 997
27.7.1.4 Display an Intercept . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 997
27.7.2 Treatments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 998
27.7.2.1 Assign a Treatment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 998
27.7.2.2 Modify an Existing Treatment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 999
27.7.2.3 Unassign a Treatment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1000
27.7.2.4 Display a Treatment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1000
27.8 PRIMECLUSTER (PCL) Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1001
28 RTP Parameters Relevant to Subscriber Provisioning . . . . . . . . . . . . . . . . . . . . . 1002
29 WSDL and Example SOAP Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1008
29.1 WSDL Schema Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1008
29.2 Interfacing to the System using the WSDL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1008
29.3 Sample Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1008
29.3.1 Get Version Sample Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1009
29.3.1.1 Get Version Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1009
29.3.1.2 Get Version Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1010
29.3.2 Create Subscriber Sample Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1010
29.3.2.1 Create Subscriber Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1010
29.3.2.2 Create Subscriber Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1013
29.3.3 Get Subscriber Info Sample Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1014
29.3.3.1 Get Subscriber Info Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1014
29.3.3.2 Get Subscriber Info Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1014
29.3.4 Update Subscriber Features Sample Messages . . . . . . . . . . . . . . . . . . . . . . . . . 1017
29.3.4.1 Update Subscriber Features Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1017
29.3.4.2 Update Subscriber Features Response . . . . . . . . . . . . . . . . . . . . . . . . . . . 1019
A31003-H80A0-T101-1-7618, 11/2021
Contents
29.3.5 Update Subscriber PIC Sample Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1019

29.3.5.1 Update Subscriber PIC Request. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1019
29.3.5.2 Update Subscriber PIC Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1020
29.3.6 Update Subscriber Account Management Info Sample Messages . . . . . . . . . . . . . 1021
29.3.6.1 Update Subscriber Account Management Info Request . . . . . . . . . . . . . . . . 1021
29.3.6.2 Update Subscriber Account Management Info Response . . . . . . . . . . . . . . . 1022
29.3.7 Update Subscriber Account User Info Sample Messages . . . . . . . . . . . . . . . . . . . 1022
29.3.7.1 Update Subscriber Account User Info Request . . . . . . . . . . . . . . . . . . . . . . 1022
29.3.7.2 Update Subscriber Account User Info Response . . . . . . . . . . . . . . . . . . . . . 1023
29.3.8 Update Subscriber Status Sample Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . 1023
29.3.8.1 Update Subscriber Status Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1023
29.3.8.2 Update Subscriber Status Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1024
29.3.9 Update Subscriber Connection Info Sample Messages . . . . . . . . . . . . . . . . . . . . 1025
29.3.9.1 Update Subscriber Connection Info Request . . . . . . . . . . . . . . . . . . . . . . . . 1025
29.3.9.2 Update Subscriber Connection Info Response . . . . . . . . . . . . . . . . . . . . . . . 1026
29.3.10 Update Subscriber DN Sample Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1026
29.3.10.1 Update Subscriber DN Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1026
29.3.10.2 Update Subscriber DN Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1027
29.3.10.3 Delete Subscriber Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1027
29.3.10.4 Delete Subscriber Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1028
29.3.11 Get COS List Sample Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1029
29.3.11.1 Get COS List Request. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1029
29.3.11.2 Get COS List Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1029
30 FeatureList.dat. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1031
31 Time Zones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1033
32 Test Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1038
32.1 TestSendSoapReq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1038
32.2 TestSoap.ksh (soapCli) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1039
33 Performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1041
33.1 Priority Processing and Congestion Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1042
A31003-H80A0-T101-1-7618, 11/2021
21
Contents
A31003-H80A0-T101-1-7618, 11/2021
soap_intro.fm
Introduction
Deployment Network Configuration
1 Introduction
Subscriber provisioning is the management of subscriber data on the
switch, which is managed by a component referred to as the SOAP
Server.
The SOAP (Simple Object Access Protocol) Server is an integrated

component of the OpenScape Voice system whose function is to handle
provisioning requests for subscriber, endpoint, and business group
data, including the creation, deletion, modification, and display of
these entities and their associated features, or services. The SOAP
Server expects SOAP/XML requests conforming to the SOAP Server
WSDL (Web Services Definition Language) file, which is included as a
product deliverable and is made available to external interface
partners. In particular, the OpenScape Voice Assistant uses this
interface to transmit provisioning requests from the user to the
OpenScape Voice system.
Subscriber provisioning is the management of subscriber data on the

system which consists of account creation and management of
subscriber and Business Group data. The provisioning interface handles
this management and is intended to be middleware between the
Customer Relationship Management (CRM) system and the call flow.
This book does not provide descriptions of how the features are
processed during call flow.
1.1 Deployment Network Configuration

The OpenScape Voice system is usually installed as a clustered pair of
servers. Subscriber provisioning is available on both machines of the
cluster. Furthermore, the provisioning interface supports multiple ports
(n, n+1..n+m). It is recommended that operator and subscriber traffic
use different ports. The operator traffic should use the virtual IP
address for the cluster and port n, while subscribers use the same IP
address and port n+1. In this manner, traffic will be distributed and
operators will not be blocked by subscriber traffic. If there is an
electronic interface (flow through provisioning), it should use the same
connection information as the operator traffic.
A31003-H80A0-T101-1-7618, 11/2021
OpenScape Voice V10, Interface Manual: Volume 2, SOAP/XML Subscriber Interface Provisioning,
soap_intro.fm
Introduction
Subscriber Interactions
1.2 Subscriber Interactions

Subscribers may interact because of their feature or service data. For
example, a subscriber with Speed Dialing can reference another
subscriber’s Speed Dialing List. These relationships may cause certain
service features or even the basic processing not to work correctly
when the referenced subscriber changes his or her service or features.
In this case, the SOAP Server methods process the request without
regard to other subscribers that might reference the changing
subscriber. In other words, subscriber A might have a Call Forward
feature, specifying subscriber B as the forward-to destination. If
subscriber B is deleted, disconnected, or otherwise modified such that
it is no longer a valid forward-to destination, there is no notification of
this fact, nor is there any mechanism by which subscriber A’s data is
audited or updated.
1.2.1 Service Interactions

Some services interact with each other: some may be assigned
together, but interact during call processing such that the functionality
of one overrides the other. In other cases, features may not be
assigned together because they are mutually exclusive, and finally in
some cases, features are dependent on other features. In the latter two
cases, checks are performed during provisioning to block the
assignment of features that are mutually exclusive, and to prevent the
removal of features on which other features depend.
Although some particular feature interactions may be mentioned in this

document, this document is not intended to contain a complete list of
the interactions. The provisioning checks are designed to match the
interactions specified in the OpenScape Voice Feature Description
Guide; therefore, refer to that document for further information about
feature compatibility and dependencies.
1.3 Subscriber Provisioning Network Architecture Layout

The subscriber profile data is split between the CRM system and the
OpenScape Voice system. The CRM is the “owner” of the complete
subscriber record while the OpenScape Voice system maintains only a
run-time subset of that data necessary to process calls. That
information which is not run time would not be sent to the OpenScape
Voice system by the CRM. The CRM would query the OpenScape Voice
system whenever it needed specific runtime data.
A31003-H80A0-T101-1-7618, 11/2021
soap_intro.fm
Introduction
Subscriber Provisioning Network Architecture Layout
For example, consider the subscriber record containing the following

information:
• Subscriber Alias (DN)
• Subscriber Address
• Subscriber Call Forwarding Variable Number
The CRM would provision the line to the OpenScape Voice system and
would need to send the DN and, optionally, an initial Call Forwarding
Variable number. It would not send the address but would maintain that
address in the CRM itself. The Call Forwarding Variable Number,
though, would be maintained on the OpenScape Voice system.
Whenever the CRM needs that data value, it would request it from the
The idea is that CRM systems are currently existing (CEON, MetaSolv,
Convergys, Liberate, etc. are some vendors of these systems) while
others, have internally built systems. Electronic integration with those
existing systems is desirable to avoid requiring operators to double key
into the system-provided provisioning screens.
1.3.1 Small Medium Enterprise

The Small Medium Enterprise (SME) is a framework that was integrated
in soapServer to cover some special needs for the Enterprise
environment. In the Enterprise environment, the OpenScape Voice
system uses one web client, the OpenScape Voice Assistant, to do both
subscriber provisioning and system administration. With the
introduction of the SME framework, and in conjunction with the
OpenScape Voice Assistant, the soapServer now supports (and will
continue to add additional support functionality for) system
administration.
1.3.2 OpenScape Voice Assistant

OpenScape Voice Assistant lets you administer the entire OpenScape
Voice communication system. It is a Web-based application accessed
via a browser. It can administer a OpenScape Voice communication
system with 300 to 5,000 users when it is installed in the same Linux
machine as the OpenScape Voice system (internal) and a system with
up to the maximum number of users supported from the OpenScape
Voice system when is installed in a Linux machine different from the
OpenScape Voice system (external).
A31003-H80A0-T101-1-7618, 11/2021
soap_intro.fm
Introduction
1.3.3 SIP Network Servers

The OpenScape Voice system supports SIP Network Servers. These
network entities are much like PBXs. They are defined on the
OpenScape Voice system using the Assistant, and profiles and feature
profiles are created using the Assistant or the SOAP interface.
These SIP Network Server profiles are called Endpoint Profiles.
A31003-H80A0-T101-1-7618, 11/2021
soap_intro.fm
Introduction
A31003-H80A0-T101-1-7618, 11/2021
soap_changes.fm
Changes Between Version V7 and V8
2 Changes Between Version V7 and V8

This section highlights changes that have been made in the SOAP
interface from Version 7 and Version 8. Note that the expected use of
this information is to determine if an existing SOAP client should be
updated to take advantage of the new functionality. Once it is
determined from this summary that a particular change should be
addressed in a SOAP client, the old and new WSDL files should be
compared to determine the exact interface changes that have
occurred. Not all changes listed here apply to all WSDL variants. For
example, changes related to Business Groups would not affect the
Subscriber Self-Care WSDL; updates to subscriber features would not
affect the Network Management WSDL, etc.
The following V8 features required noteworthy updates to the

OpenScape Voice SOAP interface.
• Restricted Registration via Central SBC
• EZIP Changes without Reboot
• SIP Timer Control and Audit Enhancements
• CSTA Security and Multi-Tenancy Support
• Domain Based Routing
• Cloud and Hosted Basic E911
• Business Group option to send Call Rejected by Subscriber
• Override Call Forwarding
• OpenScape Voice Support for Xpressions in OpenScape Cloud

Service
• Generic Notification Mechanism using SIP Notify
• Support of the Fit4More Version Numbering Format
The information below offers a lower-level summary of changes in

terms of the actual WSDL elements. As previously stated, a comparison
(i.e.diff) of the old and new WSDL files is the best way to ensure that
all differences in an existing client and the newer WSDL are known. The
following items were detected using such a comparison process
(between V7 and V8 WSDLs).
WSDL Additions in V8:
• simpleType name="DomainCodePrefixType"
– DCPrefixTypeOnNetAccess
A31003-H80A0-T101-1-7618, 11/2021
soap_changes.fm
– DCPrefixTypeOffNetAccess
• simpleType name="DomainCodeRedirectTo"
– DCRedirectToNone
– DCRedirectToCommonNP
– DCRedirectToGlobalNP
• simpleType name="DomainCodeDestinationType"
– DCDestTypeNone
– DCDestTypeDestination
– DCDestTypeIntercept
– DCDestTypeRestrictedCode
– DCDestTypeFallbackToLocalNP
• simpleType name="ResponsibleDomainType"
– RespDomainTypeIP
– RespDomainTypeIPv6
– RespDomainTypeFQDN
– RespDomainTypeDNSSrv
• simpleType name="Feature"
– CfCFO
• simpleType name="GetSubscriberListDataOption"
– SubListDataInclEmergencyBGDeptName
• simpleType name="ObjectType"
– GENERIC
– EZIP
• simpleType name="JobAction"
– GenericAuditHomeDn
– AccessEZIPParm
• simpleType name="EventType"
– UcContactMeEvent
– DlsContactMeEvent
• simpleType name="BGDeptVariant"
A31003-H80A0-T101-1-7618, 11/2021
soap_changes.fm
– BGDeptVariantBilling"
– BGDeptVariantEmergency
• simpleType name="ContTrcActive"
– CtInactive
– CtActive
• simpleType name="ContTrcFilter"
– extern247
– normal247
– min247
• simpleType name="CSTAApplicationType"
– CSTAAppTypeNA
• complexType name="QueryPFRRequest"
– LocalPortExpression
• complexType name="DomainCodeIdentification"
• complexType name="DomainCodeData"
• complexType name="CreateDomainCodeRequest"
• complexType name="CreateDomainCodeResult"
• complexType name="ModifyDomainCodeRequest"
• complexType name="ModifyDomainCodeResult"
• complexType name="DeleteDomainCodeRequest"
• complexType name="DeleteDomainCodeResult"
• complexType name="DomainCodeInfo"
• complexType name="DomainCodeList"
• complexType name="QueryDomainCodeRequest"
• complexType name="QueryDomainCodeResult"
• complexType name="QueryResponsibleDomainsRequest"
• complexType name="ResponsibleDomain"
• complexType name="ResponsibleDomainsList"
• complexType name="QueryResponsibleDomainsResult"
• complexType name="CfVM-locPres"
A31003-H80A0-T101-1-7618, 11/2021
soap_changes.fm
– element FwdOnCallReject
– element FwdOnDND
• complexType name="CfVM"
– element FwdOnCallReject
– element FwdOnDND
• complexType name="CfCFSIE-locPres"
– element DetermineCallBasedOnTransferringNum
– element RingDurationIntCall
– element name=RingDurationExtCall
• complexType name="CfCFSIE"
– element DetermineCallBasedOnTransferringNum
– element RingDurationIntCall
– element name=RingDurationExtCall
• complexType name="CfSILMS-locPres"
– element Whisper
• complexType name="CfSILMS"
– element Whisper
• complexType name="CfSILMA"
– element WhisperTo
• complexType name="CfSILMA-locPres"
– element WhisperTo
• complexType name="CfCFO"
• complexType name="ListOfFeatures"
– element CfCFO
• complexType name="IPPhoneAttribute"
– element RegistViaCentralSBC
– element DoNotSendAlphanumericSIPURI
– element nSendAlphanumericSIPURIWhenAvailable
– element Reserved5
• complexType name="SubscriberBGInfo
A31003-H80A0-T101-1-7618, 11/2021
soap_changes.fm
– element BGEmergencyDeptName
– element BGBranchOfficeName
– element AlphanumericSIPUri
• complexType name="MobileInfo"
– element CellDeviceNumber
– element RouteToCell
• complexType name="MobileInfoExtended"
– elementRouteToCell
• complexType name="GetSubscriberListEntry"
– element name="BGEmergencyDeptName
• complexType name="ContactMeMessageHeader"
• complexType name="ContactMeRequest"
• complexType name="ContactMeResult"
• complexType name="GenericJobRequest"
• complexType name="GenericJobResult"
• complexType name="ModBGParms"
– element Trusted
• complexType name="GetBGParms"
– element Trusted
• complexType name="CreateBGRequest"
– element Trusted
• complexType name="BgSubnetId"
– element EmergencyBGDeptName
• complexType name="UpdateBgSubnetRequest"
– element NewEmergencyBGDeptName
• complexType name="CreateBGDeptRequest"
– element BGDeptVariant
• complexType name="ModifyBGDeptRequest"
• complexType name="GetBGDeptListEntry"
A31003-H80A0-T101-1-7618, 11/2021
soap_changes.fm
• complexType name="GetBGDeptListRequest"
complexType name="EndpointAttributes"
– element MutualAuthentication
– element DoNotSendAlphanumericSIPURI
– element SendAlphanumericSIPURIWhenAvailable
– element SupportPeerDomains"
– element CentralSBC
– element UseBillingNumberForDP
– element CFLoopExtended
– element Reserved
• complexType name="CACPolicyVideoCodecsAllowed"
– element CACPolicyCodecVP8
• complexType name="CreateCACPolicyRequest"
– element MaxVideoCodecBandWidth
• complexType name="ModifyCACPolicyRequest"
• complexType name="CACPolicyInfo"
• complexType name="CreateGToGCACPolicyRequest"
• complexType name="ModifyGToGCACPolicyRequest"
• complexType name="GToGCACPolicyInfo"
• complexType name="ContTrcInfoWrite"
• complexType name="ContTrcInfoReadOnly"
• complexType name="ContTrcInfo"
• complexType name="HostExportRead"
A31003-H80A0-T101-1-7618, 11/2021
soap_changes.fm
• complexType name="HostExportWrite"
• complexType name="ContTrcExportInfo"
• complexType name="GetContTrcInfoRes"
• complexType name="GetContTrcInfoRequest"
• complexType name="ActivateContTrcRequest"
• complexType name="ActiveateContTrcRes"
• complexType name="DeActivateContTrcRequest"
• complexType name="DeActiveateContTrcRes"
• omplexType name="StartFileExportRequest"
• complexType name="StartFileExportRes"
• complexType name="StopFileExportRequest"
• complexType name="StopFileExportRes"
• complexType name="EZIPData"
• complexType name="EZIPDataList"
• complexType name="AccessEZIPParmRequest"
• complexType name="AccessEZIPParmResult"
• complexType name="ClientRole"
– element CR-AppsAdmin
• complexType name="CSTAApplicationInterfaceOptions"
• complexType name="CSTAApplicationBgACL"
• complexType name="CreateCSTAApplicationRequest"
– element InterfaceOptions
– element BgACL
• complexType name="ModifyCSTAApplicationRequest"
– element BgACL
• complexType name="CSTAApplicationStatus"
– element SecureConnected
• complexType name="CSTAApplicationResult"
A31003-H80A0-T101-1-7618, 11/2021
soap_changes.fm
– element BgACL
• complexType name="CSTAApplicationEntry"
– element SecureConnected
• message name="CreateDomainCodeRequest"
• message name="CreateDomainCodeResult"
• message name="ModifyDomainCodeRequest"
• message name="ModifyDomainCodeResult"
• message name="DeleteDomainCodeRequest"
• message name="DeleteDomainCodeResult"
• message name="QueryDomainCodeRequest"
• message name="QueryDomainCodeResult"
• message name="QueryResponsibleDomainsRequest"
• message name="QueryResponsibleDomainsResult"
• message name="ContactMeRequest"
• message name="ContactMeResult"
• message name="GenericJobRequest"
• message name="GenericJobResult"
• message name="GetContTrcInfoRequest"
• message name="GetContTrcInfoRes"
• message name="ActivateContTrcRequest"
• message name="ActiveateContTrcRes"
• message name="DeActivateContTrcRequest"
• message name="DeActiveateContTrcRes"
• message name="StartFileExportRequest"
• message name="StartFileExportRes"
• message name="StopFileExportRequest"
• message name="StopFileExportRes"
• message name="AccessEZIPParmRequest"
• message name="AccessEZIPParmResult"
A31003-H80A0-T101-1-7618, 11/2021
soap_changes.fm
• operation name="CreateDomainCode"
• operation name="ModifyDomainCode"
• operation name="DeleteDomainCode"
• operation name="QueryDomainCode"
• operation name="QueryResponsibleDomains"
• operation name="ContactMe"
• operation name="GenericJob"
• operation name="GetContTrcInfo"
• operation name="ActivateContTrc"
• operation name="DeActivateContTrc"
• operation name="StartFileExport"
• operation name="StopFileExport"
• operation name="AccessEZIPParm"
WSDL Removals in V8:
• simpleType name="CODECs"
• simpleType name="ResourceMgmtType"
• simpleType name="ServiceFeatureType"
– PrimaryDn
– TeenLineDn
– SvcFeatureProfileResidential
– MGCP
– H323
– SIPanalogUserIF
• simpleType name="GetSubscriberDataOption"
– IncludeVOIP
• simpleType name="SIPUserInterfaceType"
– UIanalog
• simpleType name="ConnectionType"
– MGCP
A31003-H80A0-T101-1-7618, 11/2021
soap_changes.fm
– H323
• simpleType name="FeatureProfileType"
– FeatureProfileResidential
• simpleType name="FeatureProfileConnectionType"
– ConnectionTypeMGCP
– ConnectionTypeSIPanalogUserIF
• simpleType name="TrunkingLicenseManagerStatus"
• simpleType name="HGFilterType"
– HGFilterByBOName
• complexType name="ListOfPCMMServices"
• complexType name="VOIP"
• complexType name="IPPhoneAttribute"
– element TrustedSub
– element GSMSub
– element StaticIMSSub
– element AcceptBillingNumber
• complexType name="IPPhone"
– element LataDigits
– element SIPUserInterfaceType
• complexType name="AccountMgtInfo
– element TestLineFlag
• complexType name="PrimaryDnInfo"
– element VOIP
• complexType name="MlhgNonDnTermInfo"
– element VOIP
• complexType name="IPPhoneUpdateInfo"
• complexType name="CreateSubscriberRequest"
– element VOIP
A31003-H80A0-T101-1-7618, 11/2021
soap_changes.fm
• complexType name="GetSubscriberListRequest"
– element ResrcMgmtType
– element TestLineFlag
• complexType name="UpdateSubscriberCapabilitiesRequest"
• complexType name="UpdateSubscriberCapabilitiesResult"
• complexType name="TrunkingLicensingInfo"
• complexType name="ClientAccessLicensingInfo"
• complexType name="GetBGListRequest"
– element DefaultResrcMgmtType
• complexType name="BgSubnetData"
– element ScanRate
– element ScanResponseTimeout
– element Passcode
– element ALIDBID
• complexType name="GetBgSubnetListRequest"
– element ALIDBID
• complexType name="EpMgtInfo"
• complexType name="CreateEpProfileReq"
– element Voip
• complexType name="GetEpInfoResult"
– element Voip
• complexType name="UpdateEpCapabilitiesRequest"
• complexType name="UpdateEpCapabilitiesResult"
• complexType name="EndpointAttributes"
– element TrustedSubscriber
– element GSMSubscriber
– element PDCSBillingInfoSupported
– element EndpointIsSecure
– element DoNotSendCICOverSip
A31003-H80A0-T101-1-7618, 11/2021
soap_changes.fm
– element RerouteToAlternateIp
– element StaticIMSSub
• message name="UpdateSubscriberCapabilities2Request"
• message name="UpdateSubscriberCapabilitiesResult"
• message name="GetEpInfoResult"
– part Voip
• message name="UpdateEpCapabilities2Request"
• message name="UpdateEpCapabilitiesResult"
• message name="UpdateSubscriberCapabilitiesRequest"
• message name="UpdateEpCapabilitiesRequest"
• operation name="UpdateSubscriberCapabilities2"
• operation name="UpdateEpCapabilities2"
• operation name="UpdateSubscriberCapabilities"
• operation name="UpdateEpCapabilities"
A31003-H80A0-T101-1-7618, 11/2021
soap_assumptions.fm
Design Considerations
Provisioning Traffic Volumes
3 Design Considerations
The following section lists and defines all of the assumptions that this
solution is predicated on and limitations imposed by this design.
3.1 Provisioning Traffic Volumes

Once the system is populated with subscribers, provisioning traffic is
relatively light (as compared to call traffic). Reports and high volume
(bulk) activities can be scheduled using customer facilities and can be
performed during off peak periods.
3.2 Sizing
The number of supported subscribers is a function of the hardware
platform selected and the expected traffic volumes. The SOAP interface
does not limit the capacity of entities.
3.3 System Requirements

The SOAP Server executes on both nodes of the OpenScape Voice
system. Since provisioning traffic is expected to be low and bulk
activities will be done during off peak periods, it is not expected to
place a burden on call processing. This process will execute at a lower
priority. No additional hardware is required.
3.4 Command Line Interface (CLI) Access

Subscriber profiles are NOT accessible via CLI.
3.5 Security
The SOAP Server is an open server behind a firewall. All requests will
come from a Customer Relationship Management (CRM) system. There
is no direct access to this provisioning interface (by subscribers or
users) from outside of the system. The SOAP interface provides a
security control to limit requests to all IP addresses or only those
requests that come in on a specific IP Address.
A31003-H80A0-T101-1-7618, 11/2021
soap_assumptions.fm
Requirements for Using this Interface
If desired, IPSec will be used at the system level. The use of IPSec is
transparent to the SOAP interface.
3.6 Requirements for Using this Interface

A web server or Customer Relationship Management (CRM) system is
required to provision and maintain subscriber profiles. The CRM
solution provides order entry, history, and other operator interface
tasks. It will integrate with the Number Management System, Facilities
Management System, as well as Billing System. It also will implement
scheduling of subscriber provisioning actions.
The OpenScape Voice system is a live call processing platform; it does

not provide any CRM features. Section 3.6.1, “CRM Required Features”
lists features that are required to be provided by CRM systems.
3.6.1 CRM Required Features

• Order Entry Screens to operators to provide:
• Operator authentication and controls (which operators can

interact with which number ranges, which switches, or domains)
• Auditing and history measurements of operator actions
• Scheduling and resource reservations for scheduled activities

(end of month and off-peak bulk provisioning)
• Interface to Number Management System to provide:
• Valid number assignments (correct NPA, reserved numbers,

premium numbers…)
• Sterilization of old numbers (6 month reuse period)
• Interface to Billing Management System to provide:
• Account number assignment and Directory Number correlation
• Calling and rate plan assignment
• Interface to Facilities Management and Trouble Ticketing Systems

to provide:
• Tracking of resource allocation.
• Subscriber problem (outage) handling and resolution
A31003-H80A0-T101-1-7618, 11/2021
soap_assumptions.fm
Standards Support
3.6.2 Required Interface Support

SOAP/XML is defined as a variable messaging interface. It is a tag/
value pair interface much like TL/1. The main difference, however, is
that in SOAP, the standard is that all tags are optional and new
unknown tags can be ignored. The OpenScape Voice system uses this
“non-strict compliance” convention to provide forward and backward
compatibility.
Attention: There is no error condition returned to the client if tags are

mistyped, misspelled or sent with incorrect case. These are treated as
unknown tags and ignored.
3.7 Standards Support

OpenScape Voice supports WSDL 1.1, SOAP 1.1 and SOAP 1.2 over
HTTP 1.0 and 1.1 supporting Doc/Literal and RPC encoding.
3.8 Interface Version Support

OpenScape Voice ignores unknown or mistyped tags and has defaults
for new tags, and SOAP clients that use this interface are expected to
do likewise. This will also facilitate communication with multiple
OpenScape Voice systems that may have different software versions
installed.
The OpenScape Voice system supports a GetVersion Interface that can

also be used; the user of this interface may know what interface
methods are available on the system. The OpenScape Voice system
does not support a dynamic Application Programming Interface (API)
discovery. See Section 5.1, “Interface (WSDL) Versions”, on page 73
for WSDL versions available on different OpenScape Voice system
versions. See Section 7.1, “Get Version”, on page 109 for the method
to retrieve the WSDL version from the OpenScape Voice system.
Some GET methods support a WSDL version, which limits the returned
parameters to what was originally supported in the provided WSDL
version. NOTE: This parameter will be obsolete in the future as SOAP
clients are expected to ignore unknown tags.
Where interfaces have changed between versions, the OpenScape

Voice system will mark the interface as deprecated (in this document),
but continue to support that interface for one more release. The
A31003-H80A0-T101-1-7618, 11/2021
soap_assumptions.fm
Interface Version Support
OpenScape Voice system supports the current release plus the two
previous release’s interfaces to allow time for customers to migrate to
the new interfaces.
A31003-H80A0-T101-1-7618, 11/2021
soap_concepts.fm
Concepts
Subscribers
4 Concepts
The OpenScape Voice system is versatile and has many elements that
need to be provisioned. There are many different types of subscribers
on the OpenScape Voice system supporting many different protocols
and methods of connection. The following subsections describe some
objects and concepts to be familiar with when using the provisioning
interface.
4.1 Subscribers
Subscribers may be provisioned for any HomeDN previously defined on
the system. Subscribers are all identified by their DNs. All subscribers
are identified by a fully qualified DN.
The DN may be an internal DN only (fictitious). Fictitious DNs are real

DNs on the platform. The user will need to set up the E.164 routing
such that these DNs are NOT routed to.
Subscribers may be Residential or related to a business group

(Business Group Lines). There is no real difference in the subscriber
definition and only some of the services that can be assigned to that
subscriber.
4.1.1 Profile Only Subscribers

In general, subscribers have a physical phone. When creating a
subscriber, that physical phone information is provided and the
endpoint/line is created and matched to the subscriber’s DN. The
OpenScape Voice system supports Profile Only subscribers. These
subscribers are created without a physical line. Obviously, these
subscribers cannot receive calls directly, but they can be used as the
Pilot DN for an Hunt Group, for Remote Call Forwarding, as a Hot
Desking subscriber, etc.
4.2 Feature Profiles

Feature Profiles are templates designed to simplify the management of
subscribers. Subscribers may be managed independently with features
applied directly to the individual or FPs may be used. Features may be
managed at a FP level and then subscribers may be assigned to a FP.
A31003-H80A0-T101-1-7618, 11/2021
soap_concepts.fm
Concepts
Feature Profiles
The features from the FP will be applied (cascaded or Inherited) to the

subscriber. The cascading is performed as a background JOB within the
Features may still be applied directly to individual subscribers and

those direct subscriptions override features from the Feature Profile.
Overrides may be performed for an entire feature or for just a specific
attribute of a feature. Subscribers who have Feature Profile features
and attributes are subject to change when those values are changed in
the feature profile.
For example, if the feature profile has CFDA and the subscriber is
assigned to the Feature Profile, the subscriber will inherit the CFDA
feature with its current FP settings. If the feature is active, the
subscriber would have his/her phone forwarded to the CFDA
destination defined in the feature profile. If the settings are changed in
the Feature Profile, that subscriber will have his/her settings changed
unless he/she (or the administrator) has changed the specific settings.
A subscriber may change his/her specific settings for a feature via the
phone. A reset option is provided to allow the administrator to override
local settings and reset those settings back to the feature profile. An
example where this could be used is where an administrator wants to
forcibly set all subscribers CFDA destinations to an attendant.
An administrator will have the ability to force change feature settings

using the ResetLocPrecence option of the UpdateFeatureProfile
interface. That option will overwrite specific local subscriber feature
data and reset those values to be the same as the Feature Profile.
Features that are provisioned directly to the subscriber are not affected
by the reset option or by feature profiles.
An inherited feature cannot be deleted at the subscriber level. To

disable a specific feature, it may be provisioned as Denied directly to
the specific subscriber. The user can provision the
UpdateSubscriberFeature and the PresenceFlags to reset the data
values of a specific subscriber feature back to the definitions of the
feature profile.
Services may not be provisioned against the Feature Profile as Denied.

The service status of Inherit is a read-only value that indicates that the
subscriber has the feature because it was provisioned to the
subscriber’s Feature Profile.
See Chapter 10, “Features” for a description of the service features that
may be assigned to individual subscribers. Table 1 defines the features
that can be assigned at the Feature Profile level. Since some features
are dependent upon or conflict with other features, it is possible to
assign features at the subscriber level whose prerequisite feature is
A31003-H80A0-T101-1-7618, 11/2021
soap_concepts.fm
Concepts
Branch Offices
assigned at the Feature Profile level. In this case, a problem could arise
if the operator attempts to delete the prerequisite feature from the
Feature Profile.
During Job processing, any dependent features found at the subscriber

level will be removed if the pre-requisite feature was removed from the
Feature Profile and any conflicting feature assigned to the FP will not
be inherited by a subscriber who has a conflicting feature assigned
directly.
A warning will be included in the Job Result data to indicate this action.
Feature interactions are fully listed in Section 1.2, “Subscriber
Interactions”, on page 24. Table 1 is a summary of feature
dependencies for which the scenario described here may occur. If a
feature in the Feature B column is removed from the Feature Profile,
the corresponding Feature A (if provisioned directly to the subscriber)
will also be removed.
Feature A Feature B
CIDCW CND or CNAM
CCW CW or CIDCW
RACF CFV
RFA SRS
Table 1 BG Feature Dependencies

If an update to the BG would cause conflicts to occur to the BGL (for
example CT), the entire update to the BGL will fail. For example,
multiple features can be applied in one request. That request may
contain CFV and CT. This may be accepted by the Feature Profile, but
the propagation to specific subscribers may fail.
FPs may be Residential or Business Group. They are treated identically

and separated only for better management because of the various
types of services between Business Group and Residential subscribers.
Refer to Chapter 14, “Feature Profiles” for more information regarding

parameters and management.
4.3 Branch Offices

A branch office is a group of related subscribers or/and endpoints, and
it is a subentity of a business group. All subscribers and endpoints of a
branch office are linked to the branch office via their associated
endpoint attribute, which matches the representative endpoint
recorded for a branch office. The representative endpoint is the
endpoint of a proxy with the 'Survivable' endpoint attribute set to true.
A31003-H80A0-T101-1-7618, 11/2021
soap_concepts.fm
Concepts
Branch Offices
Subscribers and endpoints in a BG that were administered under the

numbering plans are now part of a hierarchical concept, where they
belong to one of the branch offices (if associated with a representative
endpoint) or to the “Main Office” (either not associated to an endpoint
or associated to an endpoint that is not a representative endpoint of a
branch office).
The following data are administrable per branch office:
• Name: Each branch office shall receive a unique (per BG) name that
can be used.
• Representative endpoint: The representative endpoint is the

endpoint that is configured as the associated endpoint for all
subscribers and endpoints of the branch office. With this
association, the subscribers and endpoints of the branch office are
logically tied together. For branch offices with a survivable proxy,
following the proxy registration model, the representative endpoint
is the configured survivable proxy endpoint. For branch offices with
a survivable gateway, following the dual registration model, the
representative is the configured survivable gateway endpoint.
• Default office code: Each branch office receives a default office code
upon creation. It is however possible to assign subscribers from
other office codes for the same branch office.
• Default PNP: Each branch office receives a default private

numbering plan upon creation. It is however possible to use
multiple private numbering plans for the same branch office.
• Default Routing Area: Optional field that indicates the default

routing area of a branch office. Again, multiple routing areas can be
used per branch office.
• DID pool for correlation service: This can be created only if the
branch office is a survivable branch office (indicated via the
'Survivable' attribute on the branch office's representative
endpoint).
• OpenBranch indicator: Optional attribute that indicates that the

representative of this branch office is a HiPath OpenBranch device
for which administration will be supported through the Common
Management Platform.
• Username: The username that will be used by the OpenBranch

Assistant to administratively log on to the OpenBranch device. This
username must be supplied when the OpenBranch attribute is
provided.
A31003-H80A0-T101-1-7618, 11/2021
soap_concepts.fm
Concepts
Recent Change Logging
• Password: The password that will be used by the OpenBranch

Assistant to administratively log on to the OpenBranch device. This
password must be supplied when the OpenBranch attribute is
provided.
All numbers of the DID are configured as a vertical service in the PNP
used by the SIP gateway of the survivable branch office. The vertical
service is linked to the correlation (TIE) service.
4.4 Recent Change Logging

This capability provides security audit trails and recent change logs on
the OpenScape Voice system via the OpenScape Voice Assistant. Also
known as Security Event Logging, this functionality allows the
recording (in a log file) of all provisioning activities that are performed
on the OpenScape Voice system.
4.4.1 Recent Change Logging in the SOAP

Server
Whenever a SOAP request is received that involves the creation,
deletion, modification, or retrieval (e.g., for display/view) of data on
the OpenScape Voice system, the Event Logging API function
RtpSecEvtSendChangeLogEvent provided by RTP is called to log the
event. The data passed to the API function consists of:
• The operator ID value passed in the SOAP request.
Note: In the case of certain retrieval requests that do not include

an operator ID in the interface, a string with the IP address
identifying the system that sent the request will be used here.
• A block of data encoding the content of the request:
• The name of the SOAP request (for example: CreateSubscriber,

UpdateSubscriberFeatures, and so on).
• The identity of the object being created, deleted, or modified (eg:

for a Subscriber, the DN; for a Business Group, the BG Name; for a
Feature Profile the pair FP[:BG] name; etc.).
• A detailed description of all parameters included in the request,

identified explicitly with the names of the parameters and their
values. Parameters not included in the request or sent with no value
may be omitted.
A31003-H80A0-T101-1-7618, 11/2021
soap_concepts.fm
Concepts
• An indication of success or failure of the SOAP request.
The detailed description of the request will be the incoming XML

message after stripping off everything that is not needed (end tags,
empty tags, header, and so on. All passwords and PINs in the incoming
SOAP message will be included.
All functions that handle SOAP requests collect the data necessary to
log the operation (operatorId, operation, resource) in the beginning of
the function and call the function setChangeLogParameters. The log
function is called after the arguments that will be passed to the function
are validated and before the call is made to any other function. This
function writes the data received into a structure. The call to the API is
only done when the SOAP response corresponding to the logged
request is sent. This approach ensures that only one log entry is
generated for each SOAP request.
int setChangeLogParameters ( const char* operatorId,

const char* operation,
const char* resource)
The following text describes an example scenario that demonstrates

how a SOAP request is logged. In the example, the operator “admin”
creates a Business Group called “bg1”.
The function soap_recv_callback, that currently traces the incoming

SOAP request, calls the function processIncomingRequest. This
function determines whether the incoming message is a new message
or a continuation of the previous one, by verifying the beginning of the
string. If it is a new message, clears the incomingSoapRequest and
writes the new incoming message. Subsequent messages are
appended to incomingSoapRequest. The function
processIncomingRequest copies the incoming XML string into the
incomingSoapRequest, stripping off everything that is not needed (end
tags, empty tags, header, and so on).
The function unsp__CreateBG2 corresponding to the SOAP request,

calls the function setChangeLogParameters and provides the
parameters required to be logged:
setChangeLogParameters (OperatorId, (char*)

“CreateBGRequest”, BGName)
The function setChangeLogParameters populates the structure with all
parameters except the result field which is provided by setErrInfoNExit.
The first function called (unsp__CreateBG2) is the one corresponding
to the operator action. This function sets the flag isFirstFunctionCalled.
Other functions unsp__CreateBG2 may call aren’t logged, because the
flag is set. In this example, when the request processing finishes, the
structure logDataCollection will have the following values:
A31003-H80A0-T101-1-7618, 11/2021
soap_concepts.fm
Concepts
• logDataCollection.operator = “admin”
• logDataCollection.operation = “CreateBGRequest”
• logDataCollection.resource = “bg1”
• logDataCollection.result = RtpSuccess
• logDataCollection.isFirstFunctionCalled = TRUE
• incomingSoapRequest [] = “<BGName>bg1<OperatorId>admin
<CreateBGRequest><DisplayNumber>3059234090”
When the SOAP response is sent, the function soap_sent_callback,

used to trace the outgoing message, also resets the flag
isFirstFunctionCalled, calls the API and provides the log values. The API
is defined as follows:
RtpSecEvtSendChangeLogEv &logDataCollection.operator,
ent( &logDataCollection.resource,
&logDataCollection.operation,
logDataCollection.result,
incomingSoapRequest)
An event will be logged using the OpLogReport API if the return code
from the Security Event Logging API is not successful, indicating failure
to log the entry.
4.4.2 Recent Change Logging in SOAP Mass

Provisioning and SOAP Export
Mass Provisioning and Export operations are also logged, in the same
general manner as described above for the SOAP server, but the format
of the logged data is different.
For SOAP Mass Provisioning, the comma separated string representing

the input mass provisioning command from the input file is logged.
For SOAP Export, the operation performed is always the retrieving of

data and thus the name of the operation is logged with the generic
name: soapExport
The identity of the objects being exported are as specified in the input
command, defined by the operator (eg: the StartDN; the BGName,
etc.). In the case of exporting a list of DNs, the resource logged will be
the one given by the –startDn argument.
A31003-H80A0-T101-1-7618, 11/2021
soap_concepts.fm
Concepts
Hunt Groups
The entire string entered by the operator to execute the command is

logged, including all arguments passed to the application, identified
explicitly with the name and the value, to describe with detail the
operation being performed.
Note: As a result of Event Logging requirements, both SOAP Export

and SOAP Mass Provisioning are invoked from within the RTP CLI
Expert Mode. This becomes the normal method of performing mass
provisioning, since this enforces the requirement that the user be
logged in when performing provisioning operations. The RTP CLI Expert
Mode interface to soapMassProv and soapExport includes a password
parameter, as well as the user ID of the user logged into the RTP CLI.
It is still possible to invoke both executables from the command line for
testing purposes. This is expected to be used only internally and
requires knowledge of a password defined in an RTP parameter that is
not customer-accessible.
4.5 Hunt Groups

Hunt Groups allow calls to be routed to an idle line within a group of
specified lines. Each individual line must have its own private DN. A call
is placed to a Hunt Group by dialing the Pilot Number. Hunting does not
occur when a non-pilot DN (i.e., a line's private DN) is dialed. When a
call is placed to a Hunt Group, the attempt to terminate the call begins
with the line (i.e., member) designated by the Pilot Number based on
the group's hunt method (see Hunt Algorithms below). When all lines
are busy, overflow treatment is provided to a queue, overflow DN, or
to an intercept treatment. The lines in a single Hunt Group cannot be
a mixture of different Business Groups nor can they be a mix of
Business Group and non-Business Group lines. Refer to Chapter 15,
“Hunt Groups” for more information.
4.5.1 Types of Hunt Groups

Two types of Hunt Groups are supported. Both are routed to by dialing
a Pilot DN.
• Pilot Hunt Group (AKA, Profile-Only Hunt Group): In this type, the
Pilot DN points to the Hunt Group, and line 1 of the Hunt Group has
a DN that is different from the Pilot DN.
A31003-H80A0-T101-1-7618, 11/2021
soap_concepts.fm
Concepts
Hunt Groups
• Master Hunt Group: In this type, the Pilot DN of the Hunt Group is
also the DN of the first line in the group. Line 1 of the group is also
the “master” of the group, meaning that it can administer the
various features assigned to the group. From V7 and upwards
system restricts pilot allowed position to 1 only, and members are
restricted to the remaining position numbers.
4.5.2 Hunt Algorithms

The following hunting algorithms are supported:
• Sequential: An available line is searched for starting with line 1 of

the group sequentially through the group until the last member is
reached. The first available line is chosen to present the call to.
• Circular: An available line is searched for beginning with the line

position stored when the previous call to the Hunt Group was made.
When a line is selected to complete a call to the group, the line that
is one past it in the group is marked to become the starting point
for the hunt on the next call to the Hunt Group. For example, if the
last line in the group was chosen for the previous call, then this is
the first line in the group for the next call.
• Uniform Call Distribution (UCD): The line selected is the line which
has been idle for the longest time.
• Manual: When the Hunt Group hunt selection method is Manual, the
distribution of calls to agents will not be done by the OpenScape
Voice system. All incoming calls will be queued. For the distribution
to work, the Hunt Group should also be marked for CSTA, allowing
an external application to be notified of calls going into the queue,
and to subsequently retrieve (reroute) those calls.
• Linear Unconditional: (Obsolete / No Longer Supported). Calls are

immediately routed to the overflow destination if the hunting
passes the last group member.
• Parallel: All available members of the Hunt Group are alerted
simultaneously whenever a new call arrives at the Hunt Group.
4.5.3 Blocking of DNs

When the Pilot DN of the Hunt Group is dialed, it is the Blocked status
of the Pilot DN that is checked when determining blockage, not those
of individual members. If the Pilot DN is blocked, hunting will not occur.
If it is not blocked, the normal hunting will occur, and will not consider
the blocked status of an individual member.
A31003-H80A0-T101-1-7618, 11/2021
soap_concepts.fm
Concepts
Hunt Groups
When a member's DN is dialed directly, it is the Blocked status of that

DN that is checked when determining blockage.
4.5.4 Traffic Measurements

When the Hunt Group is classmarked to maintain traffic
measurements, the following measurements are maintained:
• Number of Incoming Calls to the Hunt Group - Count of the number

of incoming calls which are attempting to terminate to the Hunt
Group (i.e., which attempt a hunt).
• Number of Outgoing Calls from the Hunt Group - Count of the

number of outgoing calls originated from the members of the Hunt
Group.
• Number of Overflow Calls - Count of the number of terminating call

attempts to the Hunt Group that are unable to initially complete to
a line in the Hunt Group because an available line is not found.
• Total Usage of the Hunt Group - Measurement of the total Hunt

Group usage for all calls (incoming and outgoing) to the Hunt
Group. For incoming calls, the usage measurement begins when the
call is answered by a line in the Hunt Group. For outgoing calls, the
usage measurement begins when the call is answered by the party
called by the line in the Hunt Group. In both cases, it is stopped
when the call is released. It is recorded in seconds.
• Queue Attempts - Count of the number of attempts to place a call

in queue. It records both successful and unsuccessful attempts.
• Queue Usage - Measurement representing the total usage for all

calls while in queue. It is recorded in seconds.
• Queue Overflow - Count of the number of attempts to place a call

in queue that failed because the queue was full.
• Queue Abandons - Count of the number of calls that were

abandoned by the originator of the call while in queue before being
connected to a member of the hunt group.
A subscriber or BGL can be a member of multiple Hunt Groups. In this

case, one Hunt Group is designated as the primary Hunt Group. If
subscriber S is a member of Hunt Group A and is also the Pilot DN of
Hunt Group B, hunting through Hunt Group B takes place only if
subscriber S is called directly, not if the call is presented to subscriber
S as a result of hunting after an incoming call to Hunt Group A's Pilot
DN. When a subscriber or BGL is a member of multiple Hunt Groups
A31003-H80A0-T101-1-7618, 11/2021
soap_concepts.fm
Concepts
Hunt Groups
and its primary Hunt Group is removed, the member’s primary Hunt
Group designation is updated to refer to one of the still existing Hunt
Groups (the assignment will vary).
The Hunt Group PilotDn and all of the terminals must be created as
subscribers before being turned into an Hunt Group Pilot or Hunt Group
terminal. The subscriber can have a connection (phone). If the Hunt
Group Pilot subscriber has a phone, then that phone is the master
phone for the Hunt Group and controls the Hunt Group services. If the
subscriber does not have any connection info, then the Hunt Group is
just a container with its service features.
Service features can be applied to the Hunt Group PilotDn or an Hunt

Group Member (Dn). The assignment of service features to pilot or
terminals is performed through the modification of file featurelist.dat.
Each line of this file provides information for each feature. By setting
“mlhg_pilot” column ‘true’, the feature is applicable to a pilot DN. A new
column named “mlhg_member” is inserted for allowing or denying a
feature to a terminal.
When a caller calls a subscriber that is an Hunt Group PilotDn, the

services on the PilotDn — not the member or terminal to which the call
actually hunts and terminates to — are executed. When a caller calls a
subscriber that is a member of one or more Hunt Groups, the
subscriber's services are executed and not those of any Hunt Group
that the subscriber may be a member of. An exception is Keyset
Operation. A subscriber can be a keyset phone and also be a member
of a Hunt Group. In this case, it is desirable that when an incoming call
reaches a keyset Hunt Group member via hunting, the call should be
presented to all devices where the subscriber has a line appearance. To
accomplish this, it is necessary for the Hunt Group service to start the
keyset service on each individual Hunt Group member, if it is a keyset
subscriber, and also to stop the service if the No Advance timer expires
and hunting must continue.
Outgoing calls always invoke the subscriber’s (Hunt Group member)

features.
Currently, an Hunt Group member must have a DN. It can be marked

non-external if it is a non-public number. When an Hunt Group line
originates a call, if the phone has an E.164 DN, that DN will be sent as
the calling party number, along with that DN's privacy indication.
Otherwise, the Pilot DN is used, along with the DN's privacy indication.
The following limits apply to Hunt Groups in the OpenScape Voice

system:
• Maximum of 25,000 Hunt Groups per OpenScape Voice system
• Maximum of 2,048 members per Hunt Group
A31003-H80A0-T101-1-7618, 11/2021
soap_concepts.fm
Concepts
Hunt Groups
• A member can be in up to 32 different Hunt Groups
4.5.5 Hunt Group Restrictions

Some parameters of the Hunt Group are accessed and controlled using
the new Hunt Group methods. Others may be referenced using the
existing subscriber methods. The following restrictions apply to
subscribers that own a Hunt Group.
• An Hunt Group owner (subscriber) cannot be removed or

disconnected until the Hunt Group is removed.
• The RCF service feature cannot be applied to the Hunt Group owner
until the Hunt Group is removed.
• The SRS service feature cannot be applied to the Hunt Group owner
(Pilot DN) until the Hunt Group is removed.
• An Hunt Group owner (subscriber) may not be exported or have the

DN changed.
Hunt Group phones can be lines with E164 numbers, BG private

numbers, or non-numbered terminals. The phones are identified by
their service_id. This is the E.164 DN (if it’s defined), the BG private
DN (if there is one), and, lastly, by PilotDn-TermNumber.
In these releases, all subscribers are identified by a DN. NonDNHunt

Group terminals are not yet supported. The External DN flag originally
introduced to indicate whether BGLs are reachable only from within the
BG, however, is used by the Hunt Group service for this purpose. If a
non-DN terminal is needed, a fictitious DN can be used at subscriber
creation and the External DN flag set to false.
4.5.6 Hunt Group Traffic Measurements

The Hunt Group provisioning commands (See Section 15.2, “Hunt
Group Phone Services”, on page 696) include a parameter called
TMStatus, which allows the operator to enable or disable traffic
measurements for a particular Hunt Group. When enabled, traffic
measurement data is generated by the OMM process for that Hunt
Group.
In general, when traffic measurement data is generated, a subdirectory

with the format SRX3000-YYYYMMDDTHHMMSS is created in the root
traffic measurement directory
(/global/user/oms). These same directories are used for Hunt Group
traffic measurement data.
A31003-H80A0-T101-1-7618, 11/2021
soap_concepts.fm
Concepts
Jobs
The names of these directories can be retrieved using the

GetMlhgTMData SOAP request (See Section 15.2.9, “Get Mlhg TM
Data”, on page 721). This request takes as input a single subdirectory
name in the format mentioned above. When provided, this indicates
that only subdirectories that were created after the timestamp of that
subdirectory are returned. Also, since these same subdirectories also
contain other non-Hunt Group traffic measurement data, the files are
checked and the subdirectories are returned only if at least one Hunt
Group traffic measurement file (any file beginning with the characters
“mlhg”) is present.
The returned directories consist of the full path to the subdirectory that
contains Hunt Group traffic measurement data, in the form: /global/
user/oms/SRX3000-YYYYMMDDTHHMMSS.
The actual generation of the Hunt Group statistics files on the

OpenScape Voice system must be enabled via the OpenScape Voice
Assistant or CLI using the Operation Measurement Management (OMM)
settings.
4.6 Jobs
The OpenScape Voice system processes some provisioning actions as
background jobs. In future releases, it may be possible to schedule
actions, such as scheduling the disconnection of a subscriber (likely to
occur at the end of the month) to occur later on the OpenScape Voice
system. At this time, however, jobs are used for SOAP requests that
require more processing time than a client typically will wait for.
The most common type of request that requires more time than
available is an Update to a Feature Profile (FP), which may require the
updating of several thousand subscribers. Scheduled job processing is
also used for this operation.
Upon receiving this type of request, the OpenScape Voice system

returns the JobId tag in the ResultCodeStruct. When this field is
returned, it means that the request has been successfully received,
validated, applied to the FP, and updates have been scheduled for the
affected subscribers/BGLs.
The status of the job may be obtained using the GetJobInfo method
and a list of existing jobs may be obtained using the GetJobList
method. The CancelJob method may be used to terminate a running
or waiting job.
Refer to Chapter 17, “Background Job Processing Interfaces” for more

information.
A31003-H80A0-T101-1-7618, 11/2021
soap_concepts.fm
Concepts
Media Gateways and Servers
4.7 Media Gateways and Servers
Attention: The OpenScape Voice system supports the RG 8700, HiPath

4000, and the Mediatrix media gateway’s. These are all SIP endpoints
and are therefore not configured using the “Create Media Gateway”
SOAP commands. For the OpenScape Voice system, the only Media
Gateway that can be created using this command is a Media Server
(supported: OpenScape Media Server, Convedia Media Server).
4.8 Calling Number Display Modification

From the end user perspective, it is useful to see the number being
displayed that can be used exactly to call back the calling party (instead
of prefixing the public access code, country code, etc. to the display
number before calling back). In order to support the display of a dial-
able number, there are administrative tables for number modification.
The dial-able display number feature is per numbering plan based. It is

applicable for all markets, all solutions. All of these display number
related tables are optional.
Any existing features or future features which have the number display
functionality shall interact with the dialable display number feature.
The dialable display number feature applies only if the display number
supporting tables are provisioned. If they are not provisioned, then the
current display number function will be used with no modification
applied. To disable the dialable display number feature, the entries in
these tables need to be removed.
In V3, the Numbering Plan Identifier (NPID) and Type Of Network

(TON) parameters are divided into 'input' and 'output' values. The
{input, output} values for NPID are known as 'fromNPID' and 'toNPID',
respectively. The {input, output} values for TON are 'TONin' and
'TONout' respectively.
When the TONin value is unknown, the ten-digit calling party number
is compared to the Number Definition Table and the NOA value is used
as the TONin.
After the Modification Table is searched, the 'toNPID' and 'TONout'

values are used in the search of the Prefix Table. The result is to find
the PNAC & Prefix for the displayed number.
A31003-H80A0-T101-1-7618, 11/2021
soap_concepts.fm
Concepts
Calling Number Display Modification
The Modification Table is now indexed by the three values: fromNPID,

toNPID, TONin. In addition, the OVERRIDE flag has been removed
from the Modification Table in V3. The output from the Modification
Table is the TONout and the OPTIMIZE flag.
The following subsections describe the tables and their contents. For
information on the SOAP/XML provisioning capabilities to support
Number Modification functionality, please refer to Chapter 13, “Number
Modification”
4.8.1 Display Number Definition Table

The Display Number Definition table shows the breakdown of the
Number Plan. It defines the display number table by providing the
administrator the overview of the Numbering Plan attributes across the
system. The table contains the Numbering Plan data for Country Code,
Area Code, Exchange Code, Skip Digits, Unique Level for E164, and
Level 2, Level 1, Level 0, Unique Level for PNP.
There can be multiple entries for the same Numbering Plan because a
numbering plan can service one or more area codes and office codes at
the same time. There are no unique fields to the table. Only creation
and deletion of entries are supported for this table; no modification is
supported.
An entry in the display number modification table that has a -PRE

tonOUT defined which is of the same level as the tonIN, i.e. NATIONAL
to NATIONAL-PRE that also has optimization turned on, should return
a prefixed number even if it cannot optimize the number, if there are
no matching entries in the display number definition table.
The format and valid range of the Country Code (CC), Area Code
(AC), Exchange Code (EC/LC), and Location Code (L2, L1, L0)
are controlled by RTP parameters.
Location Code – A digit string of {0-9} of max 14 digits represents

the location code.
The locCode consists of L2, L1 and L0 codes. The SOAP/XML interface

requires the entry of a single string and the lengths of the L2, L1 and
L0 portions.
L1 and L2 are optional.
L1 cannot be administered without L0.
L2 cannot be administered without L1.
locL0Len - L0 code length, an integer {1-4}.
locL1Len – L1 code length, an integer {0-6}.
A31003-H80A0-T101-1-7618, 11/2021
soap_concepts.fm
Concepts
locL2Len – L2 code length, an integer {0-4}.
Skip Digit (SK): This parameter specifies the number of digits which
are to be skipped to extract the extension number when extension
number and node access code overlap (i.e. 923-1790 with skip digits
= 2 leads to extension number 31790). It is optional. The default value
is 0.
Unique Level (UL): This parameter specifies the lowest unique level.
Lowest level, which makes a called party unique. This is the extension
portion of the number (when using PNP) or the subscriber number
(when using E.164). This is a read-only field.
It is not be possible to add PRIVATE entries to this table if no PUBLIC

entries exist. This is to ensure that conversion between PRIVATE and
PUBLIC will work. Also you cannot have a lower level of number
definition on the PNP side of the display number definition without the
same level of definition on the E.164 side. Otherwise, it is not possible
to determine the extension component of the number before
converting it to PNP
Table 2 shows an example of the data contained in the Display Number

Definition Table.
Numbering Plan ISDN (E.164) Private (PNP)

CC L2
AC L1
LC L0
UL SK UL SK
Munich 49
89
NPID=1 722 3 722 3
SUB EXT
Boca 1
561
NPID=2 923 2 96 2
SUB EXT
Global 1
408
NPID=9999 492
SUB
SK = Skip digits, i.e. Number of digits which are to skipped to extract the extension
number when extension number and node access code overlap (i.e. 923-1790
with skip digits = 2 leads to extension number 31790). Default value: length of
the LC or L0 (i.e. no overlapping)
UL = lowest unique level. Lowest level, which makes a called party unique. This is
the extension portion of the number (when using PNP) or the subscriber number
(when using ISDN).
Table 2 Display Number Definition Table
A31003-H80A0-T101-1-7618, 11/2021
soap_concepts.fm
Concepts
The provisioning of the Display Number Definition table is optional. If

there are no entries to the table, number modification will not take
place. The validity of the entry is based on the administrator’s
knowledge of the numbering plan; no cross reference checking is done
during the provisioning.
4.8.2 Display Number Prefix Table

The Display Number Prefix Table constitutes the default network access
code and number prefix code per Numbering Plan for displaying the
dialable numbers. It is provisioned statically by the administrator with
the knowledge of the effective numbering plan information.
There will be only one set of default access code per numbering plan.
The network access code and the number prefix code are provisioned
based on the Numbering Plan and the Type Of Number (TON). They are
used for prefixing the number to be displayed.
The key to the table is the combination of originating Numbering Plan

Name (FromNpId) and the Type Of Number (TON).
Numbering Plan Name (FromNpId): This is the numbering plan ID

of the subscriber who originated the call. It can also contain the value
NIL, meaning ANY numbering plan.
Type Of Number (TON): The TON parameter defines the conversion

of an explicit “calling number” to a desired format before the number
is transmitted to the destination. It is mandatory.
The possible values:
INTERNAT – International number;
NATIONAL – National number;
SUBSCR – Subscriber,
LEVEL2 – Location Level 2,
LEVEL1 – Location Level 1,
LOCAL – Local subscriber Number
Public/Private Network Access Code (PNAC): The PNAC

parameter describes the public or private network access digit. For
example, the 9 for the public off-net access, or 8 for on-net access
code. The format and valid range is controlled by RTP parameters. It is
optional. The default is an empty string.
A31003-H80A0-T101-1-7618, 11/2021
soap_concepts.fm
Concepts
Prefix: The Number Prefix parameter is the prefixed digits for the
particular call type. For example, 00 for international call; 0 for national
call. The maximum length is 15, the format is controlled by the Srx/
Xdm/DnCode/digits/charSet in the SrxDigitLen.parm file. It is
optional. The default is an empty string.

Prefix Table.
From NPID TON PNAC PREFIX

1 LEVEL2 8 1
8 LEVEL1 8
3 LEVEL2 8 1
ANY LEVEL1 8
Table 3 Display Number Prefix Table
The provisioning of the Display Number Prefix table is optional. If there
are no qualified entries for the Numbering Plan, then no digits will be
prefixed to the display number. The validity of the entry is based on the
administrator’s knowledge of the numbering plan; no cross reference
checking is done during the provisioning.
4.8.3 Display Number Modification Table

The Display Number Modification Table provides the default number
display format between originating NP and terminating NP.
For the case that the TON is unknown during a call setup, this table
shall provide the desired display number format for the calling party
based on the originating NP and termination NP. For the case in which
the number format is known by call processing software, it is not
necessary to query this table.
The combination of the Originating Numbering Plan Name (fromNPID)

and the terminating Numbering Plan (toNPID) is the key to the table.
The pair must be unique, i.e. it cannot have two entries with the same
directional relationship between two numbering plans.
Originating Numbering Plan Name (fromNPID): This is the

numbering plan ID of the subscriber who originated the call. It can also
contain the value NIL, meaning ANY numbering plan.
Terminating Numbering Plan Name (toNPID): This is the

numbering plan ID of the subscriber terminating to. It can also contain
the value NIL, meaning ANY numbering plan.
A31003-H80A0-T101-1-7618, 11/2021
soap_concepts.fm
Concepts
Type Of Number (TON): The TON parameter defines the conversion

by call processing of an explicit “calling number” to a desired format
before the number is transmitted to the destination. It is mandatory.
The possible values:
• INTERNAT – International number;
• INTERPRE – International number with prefix;
• NATIONAL – National number;
• NATIOPRE – National number with prefix;
• SUBSCR – Subscriber;
• SUBSCRPRE - Subscriber number with prefix;
• LEVEL2 – Location Level 2;
• LEVEL2PRE - Location Level 2 with prefix;
• LEVEL1 – Location Level 1;
• LEVEL1PRE - Location Level 1 with prefix;
• LOCAL – Local subscriber Number
• LOCALPRE - Local subscriber Number with prefix
• ALL - all numbers; applicable to TONin
• ANY - any number; applicable to TONin and TONout
• ANYPRE - any number with prefix; applicable to TONout
The parameter values for TON depend on the particular tonIN field and
have an effect on the format of the “calling number” display.
Privacy Type: This parameter indicates the privacy setting for specific
call scenario using the numbering plan. However, a user can have his
own privacy setting based on some feature assignment. The effective
privacy setting to be applied is the more restrictive rule in combination
with NP privacy setting and the subscriber’s privacy setting. The
possible values: Transparency, Blocked, BG Number. Default:
Transparency.
Table 4 describes each of the possible Privacy Types.
Values of Privacy Type parameter

TRANSPARENT The privacy settings remain unchanged (transparent).
BGDISPLAYNUM The display number for the Business Group is used as
the calling party number.
Table 4 Privacy Type Parameter Values (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
soap_concepts.fm
Concepts
Business Groups
Values of Privacy Type parameter

BLOCKED The station number is blocked and will not be
transmitted
Table 4 Privacy Type Parameter Values (Seite 2 von 2)
Optimized: This parameter indicates that the display number is to be

further modified to an optimized format. The possible values: True
(Yes), False (No). The default value: True. When it is set to True (Yes),
then the numbers of the A and B parties will be compared after
modification and optimized to remove any similar component parts.

Modification Table.
From NPID To NPID TON Privacy Type Optimized (Y /

N)
1 2 LEVEL2 BLOCKED N
8 2 LEVEL1 TRANSP N
3 2 LEVEL2 TRANSP Y
ANY 3 LEVEL1 TRANSP Y
Table 5 Display Number Modification Table
4.9 Business Groups

A Business Group (BG) is a group of related subscribers. Subscribers
may optionally belong to a Business Group Line (BGL). BGs present
new service features to BGLs as well as an easier method for managing
BGLs.
BGs have a status, main numbers, attendant numbers, message detail

recording (MDR) information, a private numbering plan, and service
access codes. Some features can be assigned to BGs.
If no Numbering Plan Name is provided when a BG is created, the BG

will use the system default (E164) Numbering Plan. Business Groups
cannot share Private Numbering Plans.
Once a BG is created with a numbering plan, it can be changed to

another numbering plan if there are no subscribers existing in the BG.
When creating a BG, the system generated Customer Id is used as the

Business Group Index. The user-specified Business Group Name is
used as the Customer Name.
A31003-H80A0-T101-1-7618, 11/2021
soap_concepts.fm
Concepts
Business Group Department and Services
4.10 Business Group Department and Services

Business Groups can be divided further into departments to which
Business Group Lines can then be assigned. Departments can be used
to control the display information for the various callerId service
features.
A Business Group may have services. The following sections define the
services that can be assigned at the Business Group level.
4.10.1 Main Numbers

A business group can have a maximum of 100 main numbers. The main
numbers can be normal lines or virtual DNs that are not associated with
physical lines. If the main number is virtual, it is related to an attendant
number. On an incoming call to one of the virtual main numbers, the
services will process this number and redirect it to an attendant. The
call will ring with a distinctive ringing tone to inform the attendant that
the call is from one of the main numbers.
A subscriber profile will be created for the virtual main numbers, but
the subscriber will not be allowed services or any physical connections.
The main and attendant numbers must fall within the allowable number
ranges of the BG.
Internally, the HomeDn destination of the Main (Virtual) Number is set

to MainNumberService. If the main number is a real DN, then you do
not need to specify an attendant number.
The attendant numbers must be provisioned before you provision the

main numbers (virtualDN). An auto-attendant number is the number
for redirecting calls that terminate at the main number if the auto-
attendant service is available. Auto-attendant availability is indicated
by the auto attendant status flag. If the auto-attendant flag is set to
true, then the auto-attendant number must be specified.
The attendant number, auto-attendant number, and auto attendant

status flags can be updated for a particular main number entry.
When a subscriber who has only a private number makes a external BG

call, the BG's DisplayNumber is presented as the calling number. The
DisplayNumber is required when the BG is created.
A31003-H80A0-T101-1-7618, 11/2021
soap_concepts.fm
Concepts
Business Group Department and Services
4.10.2 Attendant Numbers

You can assign one or more Attendant Numbers to a Business Group.
For example, a multi-location Business Group can have different
Attendant Numbers that correspond to different locations.
To create an Attendant Number for a BG, update the BGL’s BGAttendant

Number Flag to True in the subscriber’s Account management Info.
4.10.3 Message Detail Recording (MDR)

Information
MDR information is provisioned on the business group to provide
enough information in the Call Context call Detail Recording (CDR) to
support the generation of Billing AMA Format (BAF) MDR modules that
are appended to the BAF AMA base structure records, upon mediation
of these CDRs for calls originating/terminating from/to Business Group
facilities.
The MDR Customer Identification must be unique for each BG. The MDR
information is applicable to the BG only and cannot be provisioned at
the BGL level.
4.10.4 Business Group Subnet E911 LIN

Administration
SIP phones connect to the OpenScape Voice system via TCP/IP. With
TCP/IP, there is no location information available for the phone. E911
LIN Administration is provided to give the Business Group phone
location capability.
Subnet IP address ranges can be defined to identify location

information. When SIP Phones register, their locations can be
determined by the router or hub address through which they connect
to the network.
A phone connecting from an area not covered within the subnet

addresses defined can enter a temporary LIN address during the initial
phone registration.
A31003-H80A0-T101-1-7618, 11/2021
soap_concepts.fm
Concepts
Business Group Traffic Measurements
4.11 Business Group Traffic Measurements

The BG Traffic Measurements feature is provisioned on a per BG basis.
The feature is enabled by BgTM service. The measurements data will
be collected and recorded as CSV files by the Operational
Measurements Manager (OMM). The files will then be available to be
pulled via FTP to OpenScape Voice Assistant. When a request from the
Assistant for a BG measurements data, the BgTM service will return a
list of measurement file names with the date information associated
with each file and the directory name to the Assistant.
Administrative controls over data file retention periods and multiple

collection intervals are provided by CLI/OpenScape Voice Assistant.
Three different collection intervals are supported for BG measurements
group. The Administrable Interval can be configured to one of the
following durations: 5 minutes, 15 minutes or 30 minutes, Hourly
Interval is the sum of all of the administrable intervals that occurred
during the hour. Daily Interval contains the sum of all the hourly
intervals that took place during the day.
The per BG data files will always be produced as daily files that can be
accessible at any time throughout the day. Each BG's OMM data file
shall contain all the interval measurements for that BG. For example,
there will be 24 hourly entries, plus a 25th daily entry in each BG file.
The BgTM service is assigned to the BG only and cannot be provisioned

at the BGL level.
Note: The actual generation of the BG statistics files on the OpenScape

Voice system must be enabled via the OpenScape Voice Assistant/CLI
using the Operation Measurement Management (OMM) settings.
4.12 Numbering Plan

Numbering Plans (PNPs) have replaced Dialing Plans. The Numbering
Plan is provisioned as part of the Business Group data. If no
Numbering Plan Name is specified, the default is provisioned as the
system default Private Numbering Plan.
The system default Numbering Plan can only be provisioned and

maintained via the OpenScape Voice Assistant or CLI. Only the system
default Numbering Plan can be shared among different Business
Groups. A Private Numbering Plan associated with a BG cannot be
shared by another BG. The PNPs override the E.164 Numbering Plan,
but may also make use of the E.164 Numbering Plan to avoid
duplicating that data.
A31003-H80A0-T101-1-7618, 11/2021
soap_concepts.fm
Concepts
Keyset Information
In order to configure multiple private numbering plans within a single

BG, it is possible to assign a Number Plan Name to a Business Group
Line (BGL - Subscriber) or to an Endpoint Profile. If a BGL or EP is not
assigned a Number Plan Name then the Numbering Plan associated
with the BG is used.
By assigning the same Number Plan Name to group of BGLs, that group
can make calls and access features using their common numbering
plan.
4.12.1 Service Activation Codes

The service activation code table for Business Groups can be
provisioned through the OpenScape Voice Assistant. The table contains
the service feature activation codes that subscribers will enter to
initiate service features, such as *69 for Recall. There are no default
settings when the system is delivered and no service features can be
operated until this table is configured.
The service feature activation code settings are configured on a per

Business Group basis and are defined in the Numbering Plan section
(Section 12.1, “Numbering Plan”, on page 581) through the SOAP
interface.
4.13 Keyset Information

Subscribers and BGLs can be created with keyset information, if
desired. This section discusses the keyset-related attributes that may
be associated with a subscriber or BGL. There is also a keyset service
that is applicable at the Business Group level, but this is assigned
independently of the provisioning of keyset information on a
subscriber/BGL basis and is only provided as a way to store certain
data items at the BG level.
All of the following parameters apply to the UpdateKeysetInfo SOAP

request (Section 9.11, “Update Keyset Info”, on page 401) and the
KeysetUse parameter also applies to the CreateSubscriber SOAP
request (Section 9.1, “Create Subscriber”, on page 342).
4.13.1 Keyset Use (enum)

This attribute describes whether a DN is to be used for Keyset
Operation, and if so, in what way. The possible values are:
A31003-H80A0-T101-1-7618, 11/2021
soap_concepts.fm
Concepts
Keyset Information
• KeysetPrimaryLine: Indicates that the subscriber DN is to be

used as the Primary Line for a keyset, where primary line is defined
as the first line to register from a given SIP endpoint and the line
used by default when no secondary line key is pressed.
• KeysetPhantomLine: Indicates that the subscriber DN is to be

used as a Phantom Line for one or more keyset where Phantom Line
is defined as a line that does not appear as a Primary Line on any
keyset, but may have an appearance as a Secondary Line on one or
more keysets.
• KeysetNone: Indicates that the subscriber DN is not to be used as

for Keyset Operation and no additional keyset-related attributes will
apply. This is the default value for KeysetUse if the parameter is not
supplied on the CreateSubscriber SOAP request.
4.13.2 Manual Hold Timer (range 5..3600)

This timer is activated when the user places the line on manual hold.
If this line is picked up on any device where this DN has an appearance,
the timer is stopped. If the timer expires, the device where the call
was placed on hold is recalled. The valid range for this timer is from 5
to 3600 seconds, and the default value is 40 seconds. This default
value is always applied on the CreateSubscriber SOAP request, since
this parameter may not be input at the time of creation. This
parameter is only expected if the Keyset Use field is set to Primary or
Phantom.
4.13.3 Line Appearances

This parameter is only valid for Keyset Primary Lines as it represents a
list of DNs that can be associated with this DN. In other words, a list of
DNs that is allowed to register at the SIP endpoint where this DN is the
Primary Line. Up to 29 BGLs may be included as Line Appearances and
each Line Appearance must be a valid DN (no more than 20 digits in
length), representing an existing BGL that is a member of the same BG
as the Primary Line. This means that it is not possible to configure a DN
as a Line Appearance before the subscriber associated with the DN has
been created. A line may appear as a Line Appearance on up to 40
devices. For more information, refer to Section 9.5, “Get Keyset
Primary List”, on page 391.
Note: It is possible to retrieve a list of devices identified by the Keyset

Primary Line on the device on which a particular keyset line appears as
a Line Appearance. The GetKeysetPrimaryList SOAP request is defined
A31003-H80A0-T101-1-7618, 11/2021
soap_concepts.fm
Concepts
Office Codes
to accomplish this. Refer to Section 9.5, “Get Keyset Primary List”, on

page 391 for more information.
4.13.3.1 Keyset Operation Mode
The Keyset Operation feature allows lines on a keyset device to be

DeviceBased or LineBased. DeviceBased means that the data of the
Keyset Primary Line is used for call origination and features that require
that data and LineBased means that the data of this individual line is
used for those purposes.
For each entry in the Line Appearance list, there are two associated
fields that indicate the Originating and Terminating Keyset Operation
Modes for that secondary line on that particular device (the device
where the indexed subscriber is the Primary). This is because the
Keyset Operation Modes can vary on a per line, per device basis. That
is, a BGL that has an appearance on more than one device may be
LineBased on one and DeviceBased on another, and operation modes
may be different depending on whether the secondary line is the
originating or terminating side of a call. If not specified, the default
value is DeviceBased.
4.13.4 Call Forward LED Indication

This parameter is valid only for Keyset Primary Lines. It is used to
indicate whether the line key LEDs on the device where this subscriber
is the Keyset Primary will wink whenever those lines have call
forwarding activated. This parameter is optional when creating a
subscriber and when updating keyset info for a subscriber. If not
supplied by the operator, the default value True is used.
Whenever the value of the Call Forward LED Indication attribute is

changed by the operator, a function is called to send the
SRS_CFWD_INDICATION_CHG event to the SIP Signaling Manager (SIP-
SM), containing both the DN of the Primary Keyset subscriber being
updated, and (if the device is registered) the IP address of the device.
4.14 Office Codes

Office Codes must be created before subscribers can be allocated to the
system. Refer to Table 6 for office code field names, descriptions, and
examples.
A31003-H80A0-T101-1-7618, 11/2021
soap_concepts.fm
Concepts
Home DNs
Field Description Example

OfficeCode The digit sequence at the beginning of a range of directory 561981
numbers that represents the office in which these DNs are
defined.
AreaCodeLen The length of the Area Code. 3
Charge Area Mainly for Japan; indicates the charge information.
Table 6 Office Code Fields
4.15 Home DNs

HomeDNs are the Directory Numbers that are available on the
platform. HomeDN (Directory Numbers) must be created before
subscribers can be allocated onto the system. Refer to Table 7 for DN
fields, descriptions, and examples.
Field Description Example

OfficeCode The office code of the home switch for this Directory Number. 561981
DirectoryNumber The DN
Table 7 HomeDN Fields
4.16 SIP Endpoints

The OpenScape Voice system supports SIP Endpoints in two varieties:
• with subscriber profile (SIP Subscribers)
• with endpoint profile
A SIP Endpoint with Subscriber Profile (automatically created when the

Subscriber is created and automatically deleted when the subscriber is
deleted) is referred to as a SIP Subscriber.
A SIP Endpoint with Endpoint Profile (explicitly created as a SIP

Endpoint via SOAP or OpenScape Voice Assistant) is referred to as a
SIP Endpoint. Refer to Section 4.17, “EndPoint Profiles”, on page 70 for
more information.
4.17 EndPoint Profiles

Endpoint Profiles are used for SIP Network Servers such as SIP
Gateways (access to the PSTN, HiPath 4000, HiPath 3000, RG 8700),
SIP Proxy Servers (Comdasys), SIP Voice Mail Server (Xpressions), and
A31003-H80A0-T101-1-7618, 11/2021
soap_concepts.fm
Concepts
SIP Network Servers
SIP Conference Bridge. These profiles allow services and feature

settings to be defined for these endpoints that need specific services.
For example, some network servers require the OpenScape Voice
system to deliver Calling ID information.
Endpoint Profiles may be associated with a Business Group, and thus

with a Numbering Plan that is associated with the Business Group.
Endpoints are defined via the OpenScape Voice Assistant or CLI and
can be defined via different authentication methods, such as:
• Trusted (No_SVC) — indicates that the endpoint message is a

trusted network element. The endpoint messages are authenticated
as coming from that trusted IP address or alias. There are no
services or call routing definitions associated with that endpoint.
• Use Endpoint Profile and any Services (AUTH_EP) — indicates that

the endpoint message is authenticated using the via header or
entity name as being an alias. In this case, there exists an endpoint
profile that may define services and/or routing definitions such as
rate area or class or service.
Only those defined as AUTH_EP will use and execute EPP services.
Refer to Chapter 16, “Endpoint Profiles” for information regarding

managing and provisioning Endpoint Profiles for SIP Network Servers.
4.18 SIP Network Servers

The OpenScape Voice system supports SIP network servers. They are
defined on the OpenScape Voice system using the OpenScape Voice
Assistant but profiles and feature profiles are created using the
Assistant or the SOAP interface.
Before creating the SIP network server (or proxy server) via the
Assistant, create a profile using the SOAP interface defined in this
document. These SIP network server profiles are called Endpoint
Profiles (EPPs). The EPPs contain various CODEC, QOS, and carrier
information, as well as certain service attributes that apply to the SIP
network server. For example, some SIP network servers require the
system to provide the callerId information on their behalf or to
implement Toll (Code) Restrictions. These services may be controlled
using the SOAP interface defined in this document.
A31003-H80A0-T101-1-7618, 11/2021
soap_concepts.fm
Concepts
Dynamic CAC Router Management
4.19 Dynamic CAC Router Management

In order to support the management of dynamic CAC (Call Admission
Control) routers via an external Network Management System
application, the SOAP Server provides several operations specific to
this functional area in a separate interface definition (WSDL) file. The
supported interfaces provide the capability to:
• Query all the access routers which have a secondary link (i.e. these
are the access routers which are assigned to CAC groups in the
OpenScape Voice system). The response returns the router
addresses together with the interface names for the primary links
in a list.
• Update the status of the primary link associated to an access router

(i.e. main access link) to LinkUp/LinkDown. [R2210]
• Retrieve the current status of the primary link associated to a

specific access router OR to retrieve the status the primary links
associated to all access routers.
• Reset all Routers' link status to “LinkUp”.
For further details on performing these Dynamic CAC Router operations

via the SOAP/XML interface, refer to Chapter 18, “Dynamic CAC Router
Management”.
A31003-H80A0-T101-1-7618, 11/2021
soap_ext_interfaces.fm
External Interfaces
Interface (WSDL) Versions
5 External Interfaces
5.1 Interface (WSDL) Versions

The format of the version is <Release>.<Version>.<Internal
Revision>.
Beginning with Version 2.0, the interface version has been extended to
include the following four values:
<Release>.<Version>.<Build>.<Internal Revision>.
The internal revision is for internal use only and should not be used as
it may change without affecting the existing interface. Table 8 lists the
OpenScape Voice Versions and the corresponding WSDL versions.
Version/Patch Initial WSDL Version Current WSDL Version

Version 4R0 V4.00.12.01 V4.00.12.01
Version 4R1 V4.01.12.01 V4.01.31.01
Version 5 V5.00.15.01 V5.00.46.03
Version 6 V6.00.15.01 V6.00.31.02
Version 7R0 V7.00.14.02 V7.00.14.03
Version 7R1 V7.01.14.01 V7.01.14.01
Version 8
Table 8 Interface Versions
5.1.1 The Interface WSDL and Interface

Release Control
The interface WSDL version can be passed to some of the methods so
that only those fields that are supported by the requested WSDL are
returned. This assures the backward compatibility for SOAP clients that
do not support the latest WSDL version. The Interface WSDL that is
passed should follow the WSDL version format described above.
The InterfaceWSDL parameter has also been added to the SOAP/XML

header structure, so now it is possible to pass the parameter for ALL
requests if desired. Note that for APIs that already have an
"InterfaceWSDL" as part of their request structure, if both are passed
(i.e. in the header and in the request), the value in the request takes
precedence.
A31003-H80A0-T101-1-7618, 11/2021
External Interfaces
Obsolete Method Names
It is recommended that all SOAP clients that are concerned with strict
compliance ALWAYS specify the WSDL version in the SOAP header. This
guarantees that these clients never receive unexpected fields in SOAP
responses.
The following is a sample request that showing the use of the

InterfaceWSDL in the header:
<SOAP-ENV:Envelope
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/
envelope/"
xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/
encoding/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:unsp="urn:siemens-hiq8000"
SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/
soap/encoding/">
<SOAP-ENV:Header>
<unsp:hiqHEADER>
<InterfaceWSDL>@InterfaceWSDL@</InterfaceWSDL>
</unsp:hiqHEADER>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<unsp:GetFeatureList2>
<GetFeatureListRequest>
<ServiceFeatureType></ServiceFeatureType>
</GetFeatureListRequest>
</unsp:GetFeatureList2>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Table 9 lists the rules that control the Interface WSDL support level.
Release/Patch Interface Release WSDL for Support Check

Passed N/A Apply the passed Interface WSDL.
NIL Passed Apply the latest WSDL of the
release passed.
NIL NIL Apply the latest WSDL of the latest
release.
Table 9 Interface WSDL and Release Control Rules
5.2 Obsolete Method Names

All interfaces that accept multiple inputs are being changed to allow
one input parameter and one output parameter to conform to newer
industry standards.
The OpenScape Voice system supports the current and the previous
two (2) release levels of the interface specification. This is the last
release that supports the following obsolete methods. After this
release, they will no longer be supported.
A31003-H80A0-T101-1-7618, 11/2021
External Interfaces
Old Method New Method Comments

AddBGMainNumber AddBGMainNumber2 Industry standard
AddContactList AddContactList2 Industry standard
AddSubToMlhg AddSubToMlhg2 Industry standard
CancelJob CancelJob2 Industry standard
CreateBG CreateBG2 Industry standard
CreateBGDept CreateBGDept2 Industry standard
CreateBgSubnet CreateBgSubnet2 Industry standard
CreateDestCode CreateDestCode2 Industry standard
CreateEpProfile CreateEpProfile2 Industry standard
CreateFeatureProfile CreateFeatureProfile2 Industry standard
CreateMlhg CreateMlhg2 Industry standard
CreateMlhgTerm CreateMlhgTerm2 Industry standard
CreateNumberPlan CreateNumberPlan2 Industry standard
CreatePnpExtension CreatePnpExtension2 Industry standard
CreatePnpLocationCode CreatePnpLocationCode2 Industry standard
CreatePrefixAccessCode CreatePrefixAccessCode2 Industry standard
CreateQOSProfile CreateQOSProfile2 Industry standard
CreateSubscriber CreateSubscriber2 Industry standard
DeleteBG DeleteBG2 Industry standard
DeleteBGCpu DeleteBGCpu2 Industry standard
DeleteBGDept DeleteBGDept2 Industry standard
DeleteBGMainNumber DeleteBGMainNumber2 Industry standard
DeleteBgSubnet DeleteBgSubnet2 Industry standard
DeleteContactList DeleteContactList2 Industry standard
DeleteDestCode DeleteDestCode2 Industry standard
DeleteEpProfile DeleteEpProfile2 Industry standard
DeleteFeatureProfile DeleteFeatureProfile2 Industry standard
DeleteMlhg DeleteMlhg2 Industry standard
DeleteMlhgTerm DeleteMlhgTerm2 Industry standard
DeleteNumberPlan DeleteNumberPlan2 Industry standard
DeletePnpExtension DeletePnpExtension2 Industry standard
DeletePnpLocationCode DeletePnpLocationCode2 Industry standard
DeletePrefixAccessCode DeletePrefixAccessCode2 Industry standard
DeleteQOSProfile DeleteQOSProfile2 Industry standard
DeleteSubscriber DeleteSubscriber2 Industry standard
DisconnectSubscriber DisconnectSubscriber2 Industry standard
Table 10 Required Interface Support (Seite 1 von 3)
A31003-H80A0-T101-1-7618, 11/2021
External Interfaces

GetBGAttendantNumbers GetBGAttendantNumbers2 Industry standard
GetBGInfo GetBGInfo2 Industry standard
GetBGInfoByOptions GetBGInfoByOptions2 Industry standard
GetDestinationList GetDestinationList2 Industry standard
GetEpInfo GetEpInfo2 Industry standard
GetFeatureList GetFeatureList2 Industry standard
GetJobInfo GetJobInfo2 Industry standard
GetJobListByOption GetJobListByOption2 Industry standard
GetMlhgInfo GetMlhgInfo2 Industry standard
GetNumberPlanList GetNumberPlanList2 Industry standard
GetPnPExtensionList GetPnPExtensionList2 Industry standard
GetPnPLocationCodeList GetPnPLocationCodeList2 Industry standard
GetPrefixAccessCodeList GetPrefixAccessCodeList2 Industry standard
GetPrefixAccessCodeOne GetPrefixAccessCodeOne2 Industry standard
GetSubscriberInfo GetSubInfoByRel Release independent
i/f
GetSubscriberInfo2 GetSubInfoByRel Release independent
i/f
GetSubscriberInfoByOptio GetSubInfoByRel Release independent
n i/f
GetSubscriberInfoByOptio GetSubInfoByRel Release independent
n2 i/f
HotDeskingLogOff HotDeskingLogOff2 Industry standard
ModifyBGDept ModifyBGDept2 Industry standard
ModifyDestCode ModifyDestCode2 Industry standard
ModifyMlhgInfo ModifyMlhgInfo2 Industry standard
ModifyMlhgTermInfo ModifyMlhgTermInfo2 Industry standard
ModifyPnpExtension ModifyPnpExtension2 Industry standard
ModifyPnpLocationCode ModifyPnpLocationCode2 Industry standard
ModifyPrefixAccessCode ModifyPrefixAccessCode2 Industry standard
ModifyQOSProfile ModifyQOSProfile2 Industry standard
UpdateBGFeatures UpdateBGFeatures2 Industry standard
UpdateBGMainNumber UpdateBGMainNumber2 Industry standard
UpdateBGParms UpdateBGParms2 Industry standard
UpdateBGStatus UpdateBGStatus2 Industry standard
UpdateBgSubnet UpdateBgSubnet2 Industry standard
UpdateConnectionInfo UpdateConnectionInfo2 Industry standard
UpdateEpCapabilities UpdateEpCapabilities2 Industry standard
A31003-H80A0-T101-1-7618, 11/2021
External Interfaces
SOAP / XML Conventions

UpdateEpFeatures UpdateEpFeatures2 Industry standard
UpdateEpMgtInfo UpdateEpMgtInfo2 Industry standard
UpdateEpPics UpdateEpPics2 Industry standard
UpdateEpQos UpdateEpQos2 Industry standard
UpdateFeatureProfile UpdateFeatureProfile2 Industry standard
UpdateKeysetInfo UpdateKeysetInfo2 Industry standard
UpdateSubscriberAccount UpdateSubscriberAccountM Industry standard
MgtInfo gtInfo2
UpdateSubscriberAccount UpdateSubscriberAccountU Industry standard
UserInfo serInfo2
UpdateSubscriberBGInfo UpdateSubscriberBGInfo2 Industry standard
UpdateSubscriberCapabili UpdateSubscriberCapabiliti Industry standard
ties es2
UpdateSubscriberDn UpdateSubscriberDn2 Industry standard
UpdateSubscriberFeature UpdateSubscriberFeaturePr Industry standard
Profile ofile2
UpdateSubscriberFeature UpdateSubscriberFeatures2 Industry standard
s
UpdateSubscriberPICs UpdateSubscriberPICs2 Industry standard
UpdateSubscriberQOS UpdateSubscriberQOS2 Industry standard
UpdateSubscriberStatus UpdateSubscriberStatus2 Industry standard
5.3 SOAP / XML Conventions

The OpenScape Voice system supports WSDL 1.1, SOAP 1.1 and SOAP
1.2 over HTTP 1.0, supporting Doc/literal and RPC encoding.
The OpenScape Voice system makes use of a couple of exceptions to

standard XML that the client needs to be aware of:
• <Tag nil=true/> indicates that the tag has not been passed and is
treated as if the tag is not passed
• <Tag/> indicates same as nil=true
• <Tag></Tag> is treated as an empty tag. If the tag data type is int

or enum, the value passed is assumed to be 0. If the datatype if a
string, the value passed is considered to be the empty string.
A31003-H80A0-T101-1-7618, 11/2021
External Interfaces
Primitive Data Definitions
5.4 Primitive Data Definitions

The following fields are common in many methods.
5.4.1 Field Data Type

• Numeric / Number - a numeric field
• Enum - A field that accepts a value from an enumerated list.

Although XML allows the client to specify the corresponding numeric
value to be passed instead of the enumerated text, passing of the
numeric is discouraged.
• Character String - a string of any characters. Some fields have

restrictions on the character set allowed. A validity check that
compares any entered string parameters against the RTP parameter
Srx/Main/InvalidStringChars is performed. If a parameter contains
any characters that are in this string, the input request will be
rejected with an appropriate error response.
• There is a general restriction that the comma (,) may not be

included as a part of any string field due to the current
implementation of Subscriber Mass Provisioning (soapMassProv),
which uses commas as delimiters. The same applies to quote marks
(“). Some fields do allow commas and/or quote marks, those fields
indicate so in their descriptions.
• Numeric Character String - a character strings that accepts only

numerics. This field type allows leading Zeros.
• Note that in the Default Value column, the following definitions

apply:
• N/A (Not Applicable): This means that the concept of a default

value does not apply in this context. For example, if the field is
not entered and is not required, it simply doesn’t apply for the
request, and thus there is no default. Also, where output fields
are listed, this means that there is no default.
• required: This means that the field is mandatory in this

context. Since some value must be provided in the request,
there is no default.
• ““: The empty string, used for character string fields.
• Any other entry in the Default Value column represents the

actual default value that is used.
A31003-H80A0-T101-1-7618, 11/2021
External Interfaces
5.4.2 Field Definitions
Attention: To avoid redundancy, detailed information for the data

populated in the Length, Range or Default Value fields in Table 11 are
outlined in Section 5.4.1, “Field Data Type”, on page 78.
Field Name Description Length Range Default Value

AuthCode External network access 2..14 Numbers only. Must not N/A
Authorization code. Maximum have leading zeros.
50000 for each BG.
BGDeptName The name of the department. 1..20 Character String. N/A
BGName The name of a BG. 1..30 Character String N/A
(residential
subscriber)
Billing Indicates the type of billing. enum FlatRate, UsageSensitive N/A
FlatRate (monthly) or
UsageSensitive (per use). If not
specified, defaults to FlatRate.
COS (Class Of The Classes Of Service are used in Character String N/A
Service) call routing. The subscriber may
optionally belong to a class of
service. Outgoing calls are routed
using the ClassOfService. During
routing, if a subscriber belongs to
a class of service, those routes are
given preference; otherwise, the
switches default class of service
(unassigned) is used. If the
subscriber has no ClassOfService
assigned, the subscriber can
access default routes only.
Subscribers with COS specified will
access COS routes first (if defined
for the call that they make), if
none are available, the default
COS routes will be used. Defined
ClassesOfService are retrievable
using the GetCOSList interface
method. They are definable on the
switch using either the OpenScape
Voice Assistant or CLI.
Country Code The length of the country code integer 0
Length associated with the subscriber’s
Home DN
Enabled Indicates whether a feature is Boolean True, False False
enabled or not.
Table 11 Primitive Data Definitions (Seite 1 von 8)
A31003-H80A0-T101-1-7618, 11/2021
External Interfaces

FeatureProfileNa The name of a feature profile. 1..40 Character String N/A
me
Forwarding A directory number to be used as 1..30 Character String N/A
Destination a forwarding destination for any of
the call forward services or other
service features that include a
called party destination. In
general this is the same as Service
Id but the forwarding destination
may be a length of up to 30
characters instead of 15.
Interface The version for which information Enum Latest, Latest
Release needs to be retrieved. Release6
Release8
Note that the InterfaceWSDL, with Release9
its higher granularity, is now the Release10
preferred parameter to indicate Release10_1
what data should be returned. For Release10_
further details, please refer to
Section 5.1, “Interface (WSDL)
Versions”, on page 73.
InterfaceWSDL The WSDL version of the request. Any valid Character string N/A
This indicates that only data that WSDL
was introduced in the specified version.
WSDL version or later shall be
returned in response to this
request. For further details, please
refer to Section 5.1, “Interface
(WSDL) Versions”, on page 73.
Language The language associated with a 1..30 Character String. System default
subscriber or endpoint profile.
Local Local presence flags to display or Structure Local structure consists N/A
reset the locally overwritten of Boolean for each data
feature data field could be modified
locally.
A31003-H80A0-T101-1-7618, 11/2021
External Interfaces

locCode A digit string of {0-9} of max 14 1..14 See provisioned N/A
digits represents the location HomeDns
code.
The locCode consists of L2, L1,
and L0 codes. The user interfaces
will have the user enter the level
codes in separate digit strings.
The SOAP Server will concatenate
into one digit string and derive the
locL0Len, locL1Len, and locL2Len.
L1 and L2 are optional.
L1 cannot be administered without
L0.
L2 cannot be administered without
L1.
locL0Len - L0 code length, an
integer {1-4}. Mandatory;
defaults to 1.
defaults to 0.
defaults to 0.
locSkipDigits - An integer (>=0).
Defaults to 0. It indicates the
number of leading digits in the
location code to skip when
converting the fully qualified PNP
number to the extension.
NumberPlan The name of private Numbering 1..31 Character String N/A
Name Plan.
Operator ID The Operator ID field is not used 1..40 Character String N/A
as part of call processing. It is
used only for auditing and aiding
the telco in identifying the
subscriber. This field may be up to
20 characters in length. It is
required in most interfaces.
A31003-H80A0-T101-1-7618, 11/2021
External Interfaces

Rate Area The subscriber may optionally N/A
belong to a specific Rate Area. The
rate area defines a local call verses
a long distance call, as well as the
routing for outbound calls.
Outgoing calls are routed using
the RateArea. During routing, if a
subscriber belongs to a Rate Area,
those routes are given preference;
otherwise, the switch’s default
class of service (unassigned) is
used. If the subscriber has no Rate
Area assigned, the subscriber can
access default routes only.The
available list of Rate Areas can be
retrieved via the GetRateAreaList
interface method. They can be
defined using either the
OpenScape Voice Assistant or CLI.
Service Id The Directory Number for the 1..15 Character String N/A
subscriber. It is a fully qualified
national number (NSN or National
Significant Number). It does not
include any spaces, parentheses,
dashes, or access numbers.
Example: 5619817000.
ServiceIdType The OpenScape Voice system PrimaryDn – identifies PrimaryDn
supports a number of different residential or BG
types of subscriber Dns. subscribers, where the
subscriber owns the
connection.
NonDnMlhgTerm –
Identifies a MLHG
terminal that does not
have any DN, public or
private.
DisconnectDn - A DN
that has been
disconnected; it’s
subscriber data has
been removed and only
it’s Home DN
information remains.
A31003-H80A0-T101-1-7618, 11/2021
External Interfaces

Service The OpenScape Voice system PrimaryDn – normal PrimaryDn
FeatureType supports different feature sets for subscriber.
different types of objects. The BusinessGroup – a
following are the types of objects grouping of subscribers.
that the OpenScape Voice system Endpoint – SIP network
supports and that features are servers such as SIP
assignable to: gateways.
SvcFeatureProfileReside
ntial - identifies features
that apply to Residential
Feature Profiles
SvcFeatureProfileCentre
x - identifies features
that apply to Business
Group Feature Profiles
MlhgPIlot - identifies
features that apply to
MultiLine Hunt Group
Pilot DNs.
SIP - identifies features
that apply to subscribers
with connection type
SIP.
A31003-H80A0-T101-1-7618, 11/2021
External Interfaces

Subscribed Indicates the action to be taken Ignore – skip this Ignore
for the service feature. service/no action
AddReplace – Add this
feature and/or replace
any existing definition of
the feature that the
subscriber might have.
When a feature is
AddReplace, the
complete feature-
specific data must be
specified; missing fields
will default as described
in this document.
Modify – The feature
must already exist from
either being previously
provisioned at the
Feature Profile Level
(and inherited) or
provisioned directly.
Only the fields listed are
modified. The presence
fields may be sent to
reset overrides for fields.
Delete – Remove the
feature from the
subscriber. Inherited
features may not be
removed, although they
may be denied.
A31003-H80A0-T101-1-7618, 11/2021
External Interfaces

Subscribed, Denied – Deny this
continued feature to the
subscriber. Do not allow
the subscriber to inherit
the feature from a
Feature Profile.
Inherit – This is a read-
only setting returned in
the GetSubscriber
Info interface variants.
This value indicates that
the subscriber has the
feature from the
subscriber’s FP.
SwitchWide – This is a
read-only setting
returned in the
GetSubscriber Info
interface variants for a
small subset of available
features. This value
indicates that the
feature is set switch
wide and thus all
subscribers have access
to it.
TOY Date and Time fields are in 20 CCYY-MM-DDThh:mm N/A
xsd__datTime format. Whenever
a time of day applies without a
date, the date portion is specified
as 0000-00-00. Timezone offsets
are not supported. Seconds will
only be transmitted in the
ResultTOY field and not on any
subscriber data.
Voip. Bearer_ Indicates whether it supports this Boolean True, False True
Speech capability.
OBSOLETE IN V8
Voip. Indicates whether it supports this Boolean True, False False
Bearer_3_1K capability.
OBSOLETE IN V8
Voip. Bearer_56K Indicates whether it supports this Boolean True, False False
capability.
OBSOLETE IN V8
Voip. Bearer_64K Indicates whether it supports this Boolean True, False False
capability.
OBSOLETE IN V8
A31003-H80A0-T101-1-7618, 11/2021
External Interfaces
Paging

Voip. FaxMode Indicates the supported fax enum None, G711
modes. G711,
OBSOLETE IN V8 T38,
T38withG711FallBack
Voip. Echo Indicates whether it supports this Boolean True, False False
Cancellation capability.
OBSOLETE IN V8
Voip. Silence Indicates whether it supports this Boolean True, False False
Suppression capability.
OBSOLETE IN V8
Voip.Fax Indicates whether it supports this Boolean True, False False
Statistics capability.
OBSOLETE IN V8
Voip.Outband Indicates whether it supports this Boolean True, False False
DTMF capability.
Signaling OBSOLETE IN V8
Voip. Suppress Indicates whether to suppress Boolean True, False False
OutbandDTMFWit Outband DTMF if G711 codec is in
hG711 use.
OBSOLETE IN V8
5.5 Paging
For the SOAP requests that accomplish Get List functionality, it is
desirable that a paging mechanism be used to facilitate paging through
the result set of the returned data by SOAP clients, such as OpenScape
Voice Assistant that display the data graphically to the user. Therefore,
the following paging mechanism exists to be used by the various Get
List SOAP requests, as necessary.
For Get List SOAP requests, a paging structure is defined in the WSDL
interface that includes the following fields:
• Page Size — the number of rows to be shown on a page. This is the

number of rows displayed in the GUI. Must be >= 1 and the
maximum of 1000.
• Page Number — The page that will be shown in the GUI. Must be
>= 1 or be equal to -10, which indicates the last page.
Depending on the individual Get List request, there may be additional

input parameters, including filter criteria, to apply to the existing
objects on the system.
For Get List SOAP requests, a PaginatedInfo structure is defined in the

WSDL interface that includes the following fields:
A31003-H80A0-T101-1-7618, 11/2021
External Interfaces
Return Code Information
• Number of rows in the result set (total number of entries meeting

the filter criteria, if any)
• Number of pages in the result set (total number of pages of data,

given the number of rows and the Page Size)
• Page Size (same as Page Size in request)
• Page Number (same as Page Number in request)
Note that paging is optional in order to make GetList SOAP requests

backward compatible. If no paging information is sent, the entire list,
up to the maximum possible elements, is returned. The following
default behavior applies to paging requests:
• If PageSize is <= 0 or >= the total number of existing elements, no

paging is assumed and the entire list is returned.
• If PageNumber == -10, or >= the last page, the last page is

displayed (with the starting entry as it is specified with the last page
number, so the size of this page may be less than the specified
PageSize)
• If PageNumber <= 0, the first page is displayed.
The PaginatedInfo structure in the response will reflect the

CurrentPage info according to the default behavior, not according to the
actual user input for Paging.
Note: Sorting is a separate issue from Paging and is not addressed in

this document.
5.6 Return Code Information

All request responses contain return code information. These fields are
described in Section 26.1, “Result Code Information”, on page 971.
A31003-H80A0-T101-1-7618, 11/2021
soap_ext_interfaces_security.fm
Security on OpenScape Voice and the OS Voice SOAP Server Interface
6 Security on OpenScape Voice and the OS Voice

SOAP Server Interface
OpenScape Voice and the OpenScape Voice SOAP server provide the
following types of security:
• Client Authorization
The scope of these APIs is to provide authentication and
authorization when receiving XML requests from a SOAP client. This
will result in a secure TLS functionality along with a controlled
access to all SOAP APIs to provide insurance that clients cannot
perform any operation on the switch unless they are authorized to
do so.
• Authentication
The SOAP server shall enable TLS. The secured SOAP server using
TLS will run on starting port 8757, creating new instances. Both
starting port and number of instances are defined by
RTPparameters (Srx/Subp/StartingPortWithTLS and Srx/Subp/
NumberOfInstancesWithTLS). This means that on the switch there
will be secured (8757 - (8757 + number of instances)) and non-
secured (8767 - (8767 + number of instances)) ports.
• Authorization
There will be a new RTP parameter defined on the switch (Srx/
Subp/Authorization) which will define whether authorization is
required. For backwards compatibility, if this parameter is set to
false, all clients should have access to all APIs. If it set to true, this
means that the customer wants to authorize the SOAP clients on the
switch and all clients will be checked before performing any
operation through the SOAP APIs.
When authorization is requested there will be one IP address that
will belong to the super administrator. The super administrator will
have the authority to determine all the other clients' privileges on
the SOAP requests. This will be implemented via the client profile
concept. The super administrator will create a client profile for each
client and determine if this is a secured client or not, his role (or
roles if multiple), which can be SuperAdmin, SystemAdmin,
Residential, Network Admin, BG admin, CAC Admin, or LAES Admin,
the access state (Normal or Blocked) to the SOAP APIs, and the lists
of BGs and CAC groups that the client can access. If authorization
is required, ALL clients should have a client profile.
A31003-H80A0-T101-1-7618, 11/2021
Use of TLS with the OSV Soap Server
6.1 Use of TLS with the OSV Soap Server
6.1.1 Configuration of RTP Parameters for

TLS
The TLS functionality for the OSV SOAP/XML is enabled through the
following RTP parameters:
• Srx/Subp/StartingPortWithTLS default value: 8757
• Srx/Subp/NumberOfInstancesWithTLS default value: 1
By default the OSV SOAP/XML interface spawns one child process that
accepts TLS connections at port 8757. Up to 4 consecutive ports can
be opened, with variable offset.
The OSV SOAP/XML interface requires mutual authentication in SSL

handshaking. The certificate used for each of the (maximum 4)
children processes that can be spawned, may differ and it's the one to
be found in the path/filename specified by the following RTP
parameters:
RTP Parameter Description Default Value

SSL/Soap/Server/KeysPath The PATH of the directory where /usr/local/ssl/private
the certificate that the OSV SOAP
Server would use in TLS
connections, resides.
SSL/Soap/Server/Keys1 The FILENAME of the certificate server.pem
that the SOAP Server would use in
TLS connections on port [Srx/Subp/
StartingPortWithTLS] . This
certificate needs to be in PEM
format.
StartingPortWithTLS]+1 . This
format.
format.
Table 12 RTP Parameters for SOAP Server Keys (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021

format.
Table 12 RTP Parameters for SOAP Server Keys (Seite 2 von 2)
The certificate(s) above need to have been created and signed by the
CA authority whose signature is stored in the pem file under the path/
filename specified by the following RTP parameters:

SSL/Soap/Server/ The PATH of the directory where /usr/local/ssl/certs
CertificatesPath certificates from Certificate Authorities
are held for SOAP Servers. Please
check the man page for
[http:www.openssl.org/docs/ssl/
SSL_CTX_load_verify_locations.html
SSL_CTX_load_verify_locations] on
the format of certificates and how this
parameter is used in conjunction with
the parameter SSL/Soap/Server/
SupportedCertificates.
SSL/Soap/Server/Supported- The FILENAME of the file that contains root.pem
Certificates the list of certificates from Certificate
Authorities that are held for SOAP
Servers. Please check the man page
for [http:www.openssl.org/docs/ssl/
SSL_CTX_load_verify_locations.html
SSL_CTX_load_verify_locations] on
the format of certificates and how this
parameter is used in conjunction with
the parameter SSL/Soap/Server/
CertificatesPath. If this file is changed,
then TTUD needs to be restarted to re-
read the file.
Table 13 RTP Parameters for SOAP Server Certificates
6.1.2 Certificates and TLS Verification

A brief example of using the OSV soapServer and onboard test SOAP
client (TestSendSoapReq) to check TLS handshaking is described
below:
A31003-H80A0-T101-1-7618, 11/2021
1. Create a custom root certificate:
• openssl req -newkey rsa:1024 -sha1 -keyout

rootkey.pem -out rootreq.pem -config root.cnf
• openssl x509 -req -in rootreq.pem -sha1 -extfile

root.cnf -extensions v3_ca -signkey rootkey.pem -
out rootcert.pem -days 3650
• cp rootcert.pem root.pem
• mkdir soap_certs
• mv root.pem ./soap_certs
• Install the certificate from the soap_certs directory: /usr/

bin/c_rehash $PWD
2. Create a custom server certificate:

serverkey.pem -out serverreq.pem -config server.cnf
-reqexts v3_req -nodes
• openssl x509 -req -in serverreq.pem -sha1 -extfile

server.cnf -extensions v3_req -CA rootcert.pem -
CAkey rootkey.pem -CAcreateserial -out
servercert.pem -days 3650cat servercert.pem
• serverkey.pem rootcert.pem > server.pem
3. Create a custom client certificate (the client in this case will

be onboard OSV, i.e. its test tool TestSendSoapReq) :

clientkey.pem -out clientreq.pem -config client.cnf
–reqexts v3_req –nodes
• openssl x509 -req -in clientreq.pem -sha1 -extfile

client.cnf -extensions v3_req -CA rootcert.pem -
CAkey rootkey.pem -CAcreateserial -out
clientcert.pem -days 3650
• cat clientcert.pem clientkey.pem rootcert.pem >

client.pem
• Move the client.pem file inside /usr/local/ssl/private

which is the default directory for storing the client files
A31003-H80A0-T101-1-7618, 11/2021
4. Create a sample SOAP envelope (to be sent by the test-tool

TestSendSoapReq SOAP client, to the OSV soapServer) and
store it on a text file (e.g. inside /unisphere/srx3000/srx/
AAA.xml) with the following content::
<TEST SSL_HANDSHAKING>
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
envelope/"
encoding/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-
instance"
xmlns:unsp="urn:siemens-hiq8000">
<SOAP-ENV:Body encodingStyle="http://
schemas.xmlsoap.org/soap/encoding/">
<unsp:GetLicensingInfo>
<GetLicensingInfoRequest>
<OperatorID>username</OperatorID>
<LicensingType>EndUserLicense</LicensingType>
</GetLicensingInfoRequest>
</unsp:GetLicensingInfo>
</SOAP-ENV:Body>
</TEST SSL_HANDSHAKING>
5. Create two new folders under /usr/local/ssl
One will be used for storing the root.pem certificate: /usr/

local/ssl/soap_certs
The other will be used for storing the server.pem certificate: /
usr/local/ssl/soap_private
Usie Rtp Admin Cli to change the values of the following Rtp
Parameters
SSL/Soap/Server/CertificatesPath to /usr/local/ssl/
soap_certs
SSL/Soap/Server/KeysPath to/ usr/local/ssl/
soap_private
A31003-H80A0-T101-1-7618, 11/2021
6. Execute the following command on an OSV console to spawn a

private SSL OSV SOAP child with SSL support on port 8758:
$/unisphere/srx3000/UNSPsubp/soapServer –d –p=8758 –
child –ssl
7. Execute the following command on an OSV console to send a

SOAP envelope via the test SOAP client TestSendSoapReq to the
OSV soapServer child spawned in the previous step.
$/unisphere/srx3000/UNSPsubp/TestSendSoapReq –p=8758
–f=../srx/AAA.xml –format –ssl
A response that is similar to the following example is expected:
Host name is <grd424vm1n1> IP address is <10.4.242.10>

SSL connection using AES256-SHA
Server certificate:
subject: /C=GR/ST=ATHENS/L=KIFISIA/O=SIEMENS/
OU=SOAP/CN=DIMITRIS
issuer: /C=GR/ST=ATHENS/L=ATHENS/O=KIFISIA/
OU=SOAP/CN=DIMITRIS
HTTP/1.1 200 OK
Server: gSOAP
<ResultCode>0
<ResultText1>Success
<ResultText2>
<ResultText3>
<ResultText4>
<?xml>
<SOAP-ENV:Envelope>
<SOAP-ENV:Body>
<unsp:GetLicensingInfoResult>
<Result>
<ResultCode>0</ResultCode>
<ResultMsgNumber>0</ResultMsgNumber>
<ResultTOY>2009-07-02T16:11:32</ResultTOY>
<ResultText1>Success</ResultText1>
<ResultText2></ResultText2>
</Result>
<LicensingInfo>
<LicensingType>EndUserLicense</LicensingType>
<InstalledCount>100000</InstalledCount>
<UsedCount>11</UsedCount>
</LicensingInfo>
</unsp:GetLicensingInfoResult>
</SOAP-ENV:Body>
A31003-H80A0-T101-1-7618, 11/2021
Create Client Profile
8. If we log in on another OSV and repeat the process above

without having installed the proper client certificates and send
the request to the previous OSV SOAP host/port (given that the
port is not blocked by PFRs), the request should be rejected
(note that the command below now contains the IP of the host
of the SSL enabled OSV soapServer:
$/unisphere/srx3000/UNSPsubp/TestSendSoapReq -
h=10.4.242.10 -p=8757 -f=../srx/AAA.xml -format –ssl
A response that is similar to the following example is expected:
SSL Verify error with certificate at depth 1: self

signed certificate in certificate chain
certificate issuer /C=GR/ST=ATHENS/L=ATHENS/
O=KIFISIA/OU=SOAP/CN=DIMITRIS
certificate subject /C=GR/ST=ATHENS/L=ATHENS/
O=KIFISIA/OU=SOAP/CN=DIMITRIS
SSL connection using AES256-SHA
Server certificate:
subject: /C=GR/ST=ATHENS/L=KIFISIA/O=SIEMENS/
OU=SOAP/CN=DIMITRIS
issuer: /C=GR/ST=ATHENS/L=ATHENS/O=KIFISIA/
OU=SOAP/CN=DIMITRIS
6.2 Create Client Profile

This interface creates a new client profile on OpenScape Voice.
Table 14 lists the return codes for this method.
WSDL Obsolete in Return Codes

Version WSDL
Version
0 subRC_SUCCESS
subRC_APP_CP_NAME_LEN_INVALID 32200001
The client profile's name
has invalid length
subRC_DB_CP_PROFILE_LOOKUP_F 12200002
AILED Failed to find client profile
in the database
subRC_APP_CP_PROFILE_EXIST 32200005
Client profile doesn't exist
in the database
Table 14 Create Client Profile Return Codes (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021

Version WSDL
Version
subRC_APP_FEAT_CPLIST_ENTRY_M 32200006
AX_NUMBER_EXCEED The entries in the client
profile's list have exceeded
the maximum number
allowed.
subRC_APP_NUM_CLIENT_PROFILES 32200007
_OUT_OF_RANGE The number of client
profiles have exceeded the
maximum number allowed.
subRC_APP_CP_INSERTION_FAILED 32200008
Failed to insert the client
profile.
subRC_APP_FEAT_CPLIST_ENTRY_D 32200010
ATA_INVALID Entry data is invalid.
subRC_APP_CP_PROFILE_ROLE_NOT 32300015
_SPECIFIED The Role of the Client is
missing
subRC_APP_CP_BGLIST_ENTRY_DAT 32300016
A_MISSING BG List's entry not passed
but required
subRC_APP_CP_CACLIST_ENTRY_DA 32300017
TA_MISSING CAC List's entry not passed but
required
subRC_APP_CP_PROFILE_DATA_MIS 32300020
SING Client's Profile Information
missing
Table 14 Create Client Profile Return Codes (Seite 2 von 2)
Table 15 lists the input fields for this method.
Field Name Description Length Range Default

operatorId Please refer to Section 5.4, “Primitive Data Definitions”, on page 78. Appendix
Table 15 Create Client Profile Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021

AllOrNone A flag to indicate whether Boolean True/false false
atomic processing is
required or partial success
is allowed. If set to true,
when the processing of
one entry fails, the data is
rolled back to its state
prior to the request. If set
to false, when the
processing of one entry
fails, a best effort attempt
will be made, and the
subsequent entries will be
processed.
ClientId This can be an IP address 16 Character string
of the client or the name
(Owner) of the client.
ClientStatus The status of the client. enum CS_Blocked
CS_Active
isSecuredClient Indicates whether the Boolean true/false false
client runs in TLS mode so
it will adhere to the TLS
SOAP server.
ClientRole The role that the client has enum CR_SuperAdmin required
on the switch. CR_SystemAdmin
CR_ResidentialAdmin
CR_NetworkAdmin
CR_BusinessGroupAdmin
CR_CACAdmin
CR_CaleaAdmin
CR_ExecutiveAssistantAd
min
CR-AppsAdmin
BusinessGroupList The list of all business List Each entry of the list is a N/A
groups that the client can character string
access. representing the BG
name. Please refer to
Please refer to Section 5.4,
“Primitive Data
Definitions”, on page 78
for data type definitions.
CACGroupList The list of all CAC groups List Each entry of the list is a N/A
that the client can access. character string
representing the CAC
group name (max length
31).
Table 15 Create Client Profile Input Fields (Seite 2 von 2)
Table 16 lists the output fields for this method.
A31003-H80A0-T101-1-7618, 11/2021
Modify Client Profile

Result The result of the operation. Type unsp__ResultCodeStruct
Table 16 Create Client Profile Output Fields
6.3 Modify Client Profile

This interface modifies an existing client profile.

Version WSDL
Version
0 subRC_SUCCESS
subRC_APP_CP_DOES_NOT_EXIST 32200000
The client profile does not
exist.
has invalid length
in the database
subRC_APP_FEAT_CPLIST_ENTRY_M 32200006
AX_NUMBER_EXCEED The entries in the client
profile's list have exceeded
the maximum number
allowed.
subRC_APP_FEAT_CPLIST_ENTRY_D 32200010
ATA_INVALID Entry data is invalid.
subRC_APP_CP_PROFILE_ROLE_NOT 32300015
_SPECIFIED The Role of the Client is
missing
but required
TA_MISSING CAC List's entry not passed but
required
Table 17 Modify Client Profile Return Codes (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Modify Client Profile

Version WSDL
Version
subRC_APP_CP_PROFILE_MODIFICA 32300018
TION_FAILED Client Profile Data update
failed
missing
Table 17 Modify Client Profile Return Codes (Seite 2 von 2)

operatorId Please refer to Section 5.4, “Primitive Data Definitions”, on page 78.
AllOrNone A flag to indicate whether Boolean True/false false
atomic processing is
required or partial success
is allowed. If set to true,
when the processing of
one entry fails, the data is
rolled back to its state
prior to the request. If set
to false, when the
processing of one entry
fails, a best effort attempt
will be made, and the
subsequent entries will be
processed.
ClientStatus The status of the client. enum CS_Blocked CS_Active
isSecuredClient Indicates whether the Boolean true/false false
client runs in TLS mode so
it will adhere to the TLS
SOAP server.
ClientRole The role that the client has enum CR_SuperAdmin required
on the switch. CR_SystemAdmin
CR_ResidentialAdmin
CR_NetworkAdmin
CR_BusinessGroupAdmin
CR_CACAdmin
CR_CaleaAdmin
CR_ExecutiveAssistantAd
min
CR-AppsAdmin
Table 18 Modify Client Profile Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Delete Client Profile

BusinessGroupList The list of all business List Each entry of the list is a N/A
groups that the client can character string
access. representing the BG
name. Please refer to
Section 5.4, “Primitive
Data Definitions”, on page
78 for data type
definitions.
CACGroupList The list of all CAC groups List Each entry of the list is a N/A
that the client can access. character string
representing the CAC
group name (max length
31).
Table 18 Modify Client Profile Input Fields (Seite 2 von 2)
6.4 Delete Client Profile

This interface removes a client profile from OpenScape Voice.

Version WSDL
Version
0 subRC_SUCCESS
has invalid length
in the database
subRC_DB_CP_DELETE_FAILURE 12200013
Deletion of the client profile
has failed
missing
Table 19 Delete Client Profile Return Codes

Table 20 Delete Client Profile Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Get Client Profile
6.5 Get Client Profile

This interface displays the client authorization information of a specific
client.

Version WSDL
Version
0 subRC_SUCCESS
has invalid length
subRC_APP_CP_PROFILE_EXIST 32200005
Client profile doesn't exist
in the database
but required
TA_MISSING CAC List's entry not passed
but required
missing
Table 21 Get Client Profile Return Codes

Required
Table 22 Get Client Profile Input Fields
6.6 Get Client Profile List

This interface returns all the clients that have access to OpenScape
Voice.
A31003-H80A0-T101-1-7618, 11/2021
Create PFR (Packet Filter Rule)

Version WSDL
Version
0 subRC_SUCCESS
in the database.
subRC_SYS_CP_CONTACT_ALLOC_E 12200014
RR Allocation error.
Table 23 Get Client Profile List Return Codes

Paging Paging structure for get list requests. For more information, refer to Section 5.5,
“Paging”, on page 86.
Table 24 Get Client Profile List Input Fields
6.7 Create PFR (Packet Filter Rule)

This interface creates a new packet filter rule on OpenScape Voice.
Note that ‘system’ PFR entries (i.e. prefixed with ‘System’) cannot be
created they are pre-existing in the system.
WSDL Version Obsolete in Return Codes

WSDL Version
V7.00.16.01 N/A subRC_SUCCESS

subRC_APP_COMM_OPERATOR_INVALID
subRC_APP_PFR_ACCESS_SYSTEM_ENTRY
subRC_APP_PFR_NAME_LEN_INVALID
subRC_APP_PFR_DESCRIPTION_LEN_INVALID
subRC_APP_PFR_LOCAL_ALIAS_LEN_INVALID
subRC_APP_PFR_REMOTE_FQDN_INVALID
subRC_APP_PFR_REMOTE_IP_LEN_INVALID
subRC_APP_PFR_REMOTE_NEMASK_LEN_INVALID
subRC_APP_PFR_INVALID
Table 25 Create Packet Filter Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Create PFR (Packet Filter Rule)

Name The Packet Filter rules 1..63 string required
name.
Description User supplied text. 1..63 string N/A
Protocol The protocol for this PFR Enum PROTO-ICMP PROTO-ALL

PROTO-UDP
PROTO-TCP
PROTO-ALL
PROTO-ESP
PROTO-AH
PROTO-SCTP
Direction The direction for this PFR Enum DIR-INCOMING DIR-

DIR-OUTGOING INCOMING
DIR-BOTH-WAYS
Action Whether the rule permits Enum • ACTION-ALLOW
or blocks the packets • ACTION-DROP
LocalAlias Alias 1..63 string N/A
LocalPortBegin Local IP port begin N/A int 0
LocalPortEnd Local IP port end N/A int 0
LocalPortExpression Local Port Expression string N/A
RemoteFQDN Remote Fully Qualified 1..63 string N/A
Name
RemoteIP Remote IP Address 1..50 string N/A
RemoteNetmask Remote IP Netmask 1..15 string N/A
RemotePortBegin Remote IP port begin N/A int 0
RemotePortEnd Remote IP port end N/A int 0
Table 26 Create Packet Filter Input Fields

Table 27 Create Packet Filter Output Fields
A31003-H80A0-T101-1-7618, 11/2021
Modify PFR (Packet Filter Rule)
6.8 Modify PFR (Packet Filter Rule)

This interface modifies a packet filter rule on OpenScape Voice.
Note that ‘system’ PFR entries (i.e. prefixed with ‘System’) cannot be
created they are pre-existing in the system.

WSDL Version

subRC_APP_PFR_REMOTE_FQDN_INVALID
subRC_APP_PFR_REMOTE_IP_LEN_INVALID
subRC_APP_PFR_REMOTE_NEMASK_LEN_INVALID
Table 28 Modify Packet Filter Return Codes

name.
Description User supplied text. 1..63 string N/A
Protocol The protocol for this PFR Enum PROTO-ICMP PROTO-ALL

PROTO-UDP
PROTO-TCP
PROTO-ALL
PROTO-ESP
PROTO-AH
PROTO-SCTP
Direction The direction for this PFR Enum DIR-INCOMING DIR-

DIR-OUTGOING INCOMING
DIR-BOTH-WAYS
Action Whether the rule permits Enum • ACTION-ALLOW
or blocks the packets • ACTION-DROP
LocalAlias Alias 1..63 string N/A
LocalPortBegin Local IP port begin N/A int 0
Table 29 Modify Packet Filter Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Delete PFR (Packet Filter Rule)

LocalPortEnd Local IP port end N/A int 0
RemoteFQDN Remote Fully Qualified 1..63 string N/A
Name
RemoteIP Remote IP Address 1..50 string N/A
RemoteNetmask Remote IP Netmask 1..15 string N/A
RemotePortBegin Remote IP port begin N/A int 0
RemotePortEnd Remote IP port end N/A int 0
Table 29 Modify Packet Filter Input Fields (Seite 2 von 2)

Table 30 Modify Packet Filter Output Fields
6.9 Delete PFR (Packet Filter Rule)

This interface deletes a packet filter rule on OpenScape Voice.
Note that ‘system’ PFR entries (i.e. prefixed with System) cannot be
deleted.

WSDL Version

Table 31 Delete Packet Filter Return Codes

name.
Table 32 Delete Packet Filter Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Query PFR (Packet Filter Rule)

Table 33 Delete Packet Filter Output Fields
6.10 Query PFR (Packet Filter Rule)

This interface returns a list of information for packet filter rules on
OpenScape Voice.
Notice that in contrast to Create/Modify/Delete PFR APIs ‘system’ PFR

entries (i.e. prefixed with System) are queried and returned normally
so that the administrator can view all PFR entries of the system.

WSDL Version

subRC_APP_PFR_QUERY_ERROR
Table 34 Query Packet Filter Return Codes

OperatorId Please refer to Section 5.4, “Primitive Data Definitions”, on page 78.
InterfaceWSDL string
Paging
SortType Sort Type Enum • SortBy-LocalAlias SortBy-
• SortBy-LocalPortBegin LocalAlias
• SortBy-LocalPortEnd
SortOrder Desired sort order Enum • SortOrderAscending
• SortOrderDescending
Name The Packet Filter rule 1..63 string
name.
LocalAlias Alias 1..63 string
LocalPortBegin Local IP port begin N/A int
LocalPortEnd Local IP port end N/A int
Table 35 Query Packet Filter Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Query PFR (Packet Filter Rule)

LocalPortExpression Local Port Expression string N/A
Table 35 Query Packet Filter Input Fields (Seite 2 von 2)
Result The result of the operation. Type unsp ResultCodeStruct

PaginatedInfo
QueryPFRList The list of PFRs struct
QueryPFREleme Elements in the list
Name The Packet Filter rules 1..63 string
Description User supplied text. 1..63 string
Protocol The protocol for this PFR Enum PROTO-ICMP
PROTO-UDP
PROTO-TCP
PROTO-ALL
PROTO-ESP
PROTO-AH
PROTO-SCTP
Direction The direction for this PFR Enum DIR-INCOMING

DIR-OUTGOING
DIR-BOTH-WAYS
Action Whether the rule permits or Enum • ACTION-ALLOW
blocks the packets • ACTION-DROP
LocalAlias Alias 1..63 string
LocalPortBegin An IP port N/A int
LocalPortEnd An IP port N/A int
LocalPortExpress Local Port Expression string N/A
ion
RemoteFQDN Fully Qualified Name 1..63 string

RemoteIP IP Address 1..50 string
RemoteNetmask IP Netmask 1..15 string
RemotePortBegi An IP port N/A int
RemotePortEnd An IP port N/A int
Table 36 Query Packet Filter Output Fields
A31003-H80A0-T101-1-7618, 11/2021
Get PFR Symbolic Name List
6.11 Get PFR Symbolic Name List

This interface returns information for the PFR symbolic names on
OpenScape Voice.

WSDL Version

subRC_APP_SYMBOLIC_NAME_QUERY_ERROR
Table 37 Get PFR Symbolic Name Return Codes

OperatorId Please refer to Section 5.4, “Primitive Data Definitions”, on page 78.
InterfaceWSDL string
AliasName string
Table 38 Get PFR Symbolic Name List Input Fields

SymbolicNameList Symbolic Name list structure
SymbolicNameEle Elements in the lists
ment
SymbolicName Symbolic Name string
AliasElement1
.Alias Alias of Element 1 string
.IPAddressElemen IP Address string
t1.
t2
AliasElement2
.Alias Alias of Element 2 string
t1
t2
Table 39 Get PFR Symbolic Name List Output Fields
A31003-H80A0-T101-1-7618, 11/2021
Get PFR Symbolic Name List
A31003-H80A0-T101-1-7618, 11/2021
soap_ext_interfaces_util.fm
General Utility Interfaces
Get Version
7 General Utility Interfaces

This is a collection of Application Programming Interfaces (APIs) about
objects that are not necessarily provisioned by SOAP. Some of this
information, however, may be needed while provisioning other objects.
7.1 Get Version

The GetVersion method returns build and release information such that
the user of this interface may know what interface methods are
available on the system. See Section 5.1, “Interface (WSDL) Versions”,
on page 73 for a description of the WSDL numbering nomenclature.
Also refer to Section 3.6, “Requirements for Using this Interface”, on
page 41.

WSDL Version
1.0.6 subRC_SUCCESS
Table 40 Get Version Return Codes
Field Name Description

Version The WSDL version of the SOAP Server. For example, 10.00.08.01.
Starting in V8 the Fit4More version format is supported., for example, V8 R0.2.0.
MarketBuild The OpenScape Voice-build version. For example, 10.01.01.ALL.22.
SoftSwitch Enterprise or Carrier.
Environment
buildDateTime The time the SOAP Server process was built. For example, 2006-01-18T09:34.
Table 41 Get Version Output Fields
7.2 Get Feature List

The GetFeatureList method is used to obtain the list of features enabled
on the system for the specified category. If no category is specified, the
residential feature list is returned.
A31003-H80A0-T101-1-7618, 11/2021
Get Config Data

WSDL Version
1.0.5 subRC_SUCCESS
Table 42 Get Feature List Return codes

ServiceFeatureTy The category of Features to enum BusinessGroup_,
pe retrieve. Endpoint_,
BusinessGroupLine_,
SvcFeatureProfileCentrex
MlhgPilot
SIP
MlhgTerm
Table 43 Get Feature List Input Fields

ServiceFeatureT Feature Category as explained in the Input Field Description. E.g “PrimaryDn”
ype
GetService FeatureId - The internal feature Id. For example, “CfVM”.
FeatureList
FeatureNumber – The feature number For example, “99”.
Data (List)
FeatureDesc – Textual description of the Feature. For example, Voice Mail.
Table 44 Get Feature List Output Fields
7.3 Get Config Data

This API returns a list of all OpenScape Voice (RTP) configuration
parameters relevant to subscriber provisioning and their current
values. If a parameter could not be retrieved from RTP, the default
value used by subscriber provisioning is returned.

WSDL Version
04.04.02 subRC_SUCCESS
subRC_SYS_UTIL_CONF_DATA_ALLOC_ERR
Table 45 Get Config Data Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Set Config Parm Data

Value
unsp__ConfigDa • Name – The name Srx/Main/SvcAstsignedPerOfficeACR
ta (list) of the RTP Srx/Main/CustomerType
Parameters Srx/Main/SoftSwitchType
• Value – The value Srx/Xdm/DnCode/digits/minLen
associated with Srx/Xdm/DnCode/digits/maxLen
the RTP Srx/Xdm/DnCode/npa/minLen
Parameters. Srx/Xdm/DnCode/npa/maxLen
Srx/Xdm/HomeDn/digits/maxLen
Srx/Xdm/HomeDn/digits/minLen
Srx/Xdm/OfficeCode/digits/minLen
Srx/Xdm/OfficeCode/digits/maxLen
Srx/Xdm/OfficeCode/countryCode/minLen
Srx/Xdm/OfficeCode/countryCode/maxLen
Srx/Xdm/SupportUnreachableState
Srx/Sip/AuthEnabled
Srx/Sip/max_number_of_sessions
Srx/Sip/default_number_of_sessions
Srx/Sip/Timer_OCS
Srx/Sip/Timer_PBS
Srx/Sip/Timer_AS
Srx/Subp/Address
Srx/Subp/Port
Srx/Subp/NumberOfInstances
Srx/Subp/OverLoadCheckPeriod
Srx/Subp/JobCheckSleep
Srx/Subp/NumObjectsToPauseAfter
Srx/Subp/JobLoopSleepTime
Srx/Subp/JobClearTime
Srx/Subp/ClearJobDays
Srx/Subp/ClearErrorDays
Srx/Main/VMWIcapabilityDefault
Srx/Main/InvalidStringChars
Srx/Main/DisableCFDestValidation
Srx/Main/AllowCFDestEmergency
Srx/Main/SwitchFPRestrict
Srx/Main/SrxSwitchLangMode
Srx/Main/SrxDefaultLang
Srx/Main/SrxSupportedLangList
Srx/Main/SS7Variant
Srx/Main/hiQVariant
Srx/Main/ApplicationType
Srx/Main/AuthTRSOverride
Srx/Main/AuthTRSOverrideValues
Table 46 Get Config Data Output Fields
7.4 Set Config Parm Data

This function is used to set an RTP Parameter or list of RTP Parameters.
A31003-H80A0-T101-1-7618, 11/2021
Set Config Parm Data
Note that the list of RTP parameters that are provisionable via the SOAP
interface is not the complete list of existing RTP parameters in the
system, but rather is a limited set defined in the file
RtpParameters.conf, which is delivered on the system in the /
unisphere/srx3000/UNSPsubp directory.
If an RTP parameter is not included in this file then access to it via the
SOAP interface is denied, even if the RTP parameter is defined as
Customer type and is accessible via OpenScape Voice Assistant/CLI.
This approach allows different configuration files to be provided for
different solutions.
The format of each line of the file is as follows:
<parameterName> type: <type of parameter> endtype value:

<accepted values of the parameter according to its type> endtype
The <type of parameter> can be any of the following: IpAddress,

boolean, string, or integer, and string parameters contain the length in
braces {}.
For string parameters, if a range of numeric values is allowed, the valid

range is included in square brackets []; for example: [ 0-9 ]. If a range
of alphabetical values is allowed, it is included in angled brackets <>;
for example, < A-E >. If specific characters are allowed, these are
defined in parentheses () separated by commas; for example: ( *,# ).
For integer parameters, if a range of values is allowed, the valid range

is included in square brackets []; for example [ 0-180 ]. If specific
values are allowed, these are defined in parentheses () separated by
commas; for example: ( 1,2,3,6 ).
For Boolean parameters, the value should be defined as ( true,false ).
The following is an excerpt from the configuration file, showing several

example lines:
Srx/Main/OwnCountryCode type: string { 0-3 } endtype
value: [ 0-9 ] endvalue
Srx/Main/RACFCfmTreat type: integer endtype value: [ 1-
2 ] endvalue
Srx/Main/SS7Variant type: integer endtype value: (
1,2,3,6 ) endvalue
Srx/Main/SvcAssignedPerOfficeACR type: boolean endtype
value: ( true,false ) endvalue
If a parameter in the configuration file does not have a validation rule
defined, the operator cannot use the Set request to update the RTP
parameter, but it is possible to retrieve the value of it using the Get
request below.
A31003-H80A0-T101-1-7618, 11/2021
Get Config Parm Data
For the Set operation, the SOAP Server validates that the requested
parameter exists in the file and checks whether the value that has been
passed is valid according to the rules defined in the file for this
parameter.
Since a list of RTP parameters may be provided in the Set request,

there may be one or more parameters that could not be processed for
some reason; for example if the provided value is out of range. In this
case, those entries are skipped and processing continues in an attempt
to update the remaining parameters in the list. The response to the Set
request includes a list of any parameters that were not successfully
updated, and an error message describing the reason for the failure.

WSDL Version
10.02.03.02 N/A subRC_SUCCESS
Table 47 Set Config Parm Data Return Codes
Field Name Description Length Range/Values Default

Value
OperatorId The operator issuing the Please refer to the definition of
command. Operator ID inSection 5.4, “Primitive
Data Definitions”, on page 78
ConfigParmDataList An array of ConfigData elements, each consisting of the following attributes:
Name The name of the RTP Character String required
parameter.
Value The value to which the RTP Character String required
parameter is to be set.
Table 48 Get Config Parm Data Input Fields
7.5 Get Config Parm Data

This function is used to retrieve and display an RTP parameter or list of
RTP parameters. Its functionality is similar to the GetConfigData
interface, but with additional flexibility and additional available
parameters to display.
A31003-H80A0-T101-1-7618, 11/2021
Get COS List

WSDL Version
Table 49 Get Config Parm Data Return Codes

Value
command. Operator ID inSection 5.4, “Primitive
Data Definitions”, on page 78
ConfigDataNameList An array of strings, each Character String required
one being the name of the
RTP parameter.
Table 50 Get Config Parm Data Input Fields
7.6 Get COS List

This method retrieves a list of the Class of Services that are defined on
the system.

WSDL Version
1.0.5 subRC_INTERNAL_ERROR
subRC_DB_UTIL_COS_LOOKUP_FAILED
Table 51 Get COS List Return Codes

Paging Paging structure for Get List requests. For more information, refer to N/A
Section 5.5, “Paging”, on page 86.
Table 52 Get COS List Input Field Descriptions

COSList(List) A string list with the names of the Class of Service.
Table 53 Get COS List Output Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Get Rate Area List

PaginatedInfo Standard paging output
structure. For details, refer to
Section 5.5, “Paging”, on
page 86.
Table 53 Get COS List Output Fields (Seite 2 von 2)
7.7 Get Rate Area List

This method returns the list of RateAreas that have been defined on the
system.

WSDL Version
1.0.6 subRC_SUCCESS
subRC_DB_UTIL_RATEAREA_LOOKUP_FAILED
Table 54 Get Rate Area List Return Codes

Paging Paging structure for Get List requests. For more information, N/A
refer to Section 5.5, “Paging”, on page 86.
Table 55 Get Rate Area List Input Field Descriptions

GetRateArea A string list with all the rate area lists defined.
ListData (List)
page 86.
Table 56 Get Rate Area List Output Fields
7.8 Get Intercept List

This SOAP request provides the capability to display a list of currently
existing Intercept IDs, as is also possible via the OpenScape Voice
Assistant. For each entry, the Intercept Name is returned.
A31003-H80A0-T101-1-7618, 11/2021
Get Calling Location List

WSDL Version
subRC_DB_UTIL_INTERCEPT_LOOKUP_FAILED
subRC_SYS_UTIL_INTERCEPT_ALLOC_ERR
Table 57 Get Intercept List Return Codes

GetInterceptList The names of the intercepts. 1..15 List of character strings N/A
Data (list) (each list
element)
Table 58 Get Intercept List Output Fields
7.9 Get Calling Location List

This SOAP request provides the capability to display a list of existing
Calling Locations. For each entry, the Calling Location is returned.

WSDL Version
10.01.00.34 subRC_SUCCESS
subRC_DB_UTIL_CALLINGLOC_LOOKUP_FAILED
Table 59 Get Calling Location List Return Codes

Table 60 Get Calling Location List Input Field Descriptions

GetCallingLocati The IDs of the calling N/A
onListData locations.
(list)
Table 61 Get Calling Location List Output Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Get Associated SIP Endpoint List

page 86.
Table 61 Get Calling Location List Output Fields (Seite 2 von 2)
7.10 Get Associated SIP Endpoint List

This SOAP request provides the capability to display a list of Associated
SIP Endpoints. For each entry, the Associated SIP Endpoint Name is
returned.

WSDL Version
subRC_INVLD_FEATURE_DATA
subRC_SYS_UTIL_ASSOC_ENDPOINT_ALLOC_ERR
subRC_INTERNAL_ERROR
Table 62 Get Associated Sip Endpoint List Return Codes

Endpoint Name The name of the Endpoint. 16 char N/A
string
Table 63 Get Associated Sip Endpoint List Input Fields

Endpoint Name The name of the Endpoint. string
GetAssociatedSi The names of the SIP N/A
pEndpointListDa Endpoints.
ta(list)
Table 64 Get Associated Sip Endpoint List Output Fields
7.11 Get Licensing Info

This SOAP request provides the capability to display the following
information:
A31003-H80A0-T101-1-7618, 11/2021
Get Licensing Info
• Licensing Information on the OpenScape Voice system for “End

User” licenses.
• Licensing Information on the OpenScape Voice system for “Dynamic

Session” licenses. It controls the number of SIP subscribers that are
concurrently registered in the system.
• Licensing Information on the OpenScape Voice system for

“Trucking” licenses. The Trunking Session licenses control the
number of concurrent calls between two SIPQ endpoints.
• Licensing Information on the OpenScape Voice system for “Client

Access” licenses.
• Licensing Information on the OpenScape Voice system for OSMO

licenses. It controls the number of mobile devices subscribed to the
system.
• For End User licenses, the data returned will be the “Installed”
number of licenses and the count of the licenses that are currently
being “Used”. For Dynamic Session, Trunking, Client access and
OSMO licenses a variety of attributes are returned. Please refer to
the returned data in the functions below for further details.
For End User licenses, the data returned will be the “Installed” number
of licenses and the count of the licenses that are currently being
“Used”. For Dynamic Session and Trunking licenses, a variety of
attributes are returned. Please refer to the returned data in the
functions below for further details.
The Licensing Manager component is used to retrieve this information.

WSDL Version
subRC_APP_LICENSE_MANAGER_ERROR
Table 65 Get Licensing Info Return Codes

OperatorId Please refer to Table 10 on
page 78.
InterfaceWSDL The WSDL version being used For more information, refer to Section
by the requesting SOAP 5.1.1, “The Interface WSDL and Interface
client. Release Control”, on page 73.
Table 66 Get Licensing Info Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Get Licensing Info

LicensingType The type of licensing info enum AllLicense EndUserLicens
being requested. Option EndUserLicense e
AllLicense is used to retrieve TrunkingSessionLicense
the data of all license types in DynamicLicense
a single response. ClientAccessLicense
OSMOLicense
Table 66 Get Licensing Info Input Fields (Seite 2 von 2)
LicensingType The type of licensing info enum AllLicense N/A

being EndUserLicense
returned. TrunkingSessionLicense
DynamicLicense
ClientAccessLicense
OSMOLicense
InstalledCount The number of licenses of the integer any non-negative integer N/A
specified type currently
installed on the switch.
Note this attribute applies
only to EndUserLicense type.
UsedCount The number of licenses of the integer any non-negative integer N/A
specified type currently in use
on the switch.
Note this attribute applies
only to EndUserLicense type.
TrunkingLicensin OBSOLETE / REMOVED IN V8
gInfo
DynamicLicense A structure containing the following attributes:
Info
(DynamicLicens The number of available integer any non-negative integer N/A
eInfo) dynamic licenses.
Available
(DynamicLicens The number of dynamic integer any non-negative integer N/A
eInfo) licenses currently in use.
InUse
InUseMobile The number of dynamic integer any non-negative integer N/A
licenses currently in use for
mobile subscriptions, when
OSMO licensing is not
installed in the system. When
OSMO licensing is installed
this counter is set to 0.
Table 67 Get Licensing Info Output Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Get Licensing Info

(DynamicLicens The maximum value of the integer any non-negative integer N/A
eInfo) InUse attribute that has been
PreviousDayMax reported during the last 24
Used hours.
(DynamicLicens The maximum number of integer any non-negative integer N/A
eInfo) times the dynamic license
CustomerViolati usage may exceed the
onLimit number of dynamic licenses.
(DynamicLicens The number of times the integer any non-negative integer N/A
eInfo) dynamic license usage has
CustomerViolati exceeded the number of
onCounter dynamic licenses.
OSMOLicenseInf A structure containing the following attributes:
o
(OSMOLicenseIn The number of available integer any non-negative integer N/A
fo) OSMO licenses. When OSMO
Available licensing is not installed this
counter is set to 0.
(OSMOLicenseIn The number of OSMO licenses integer any non-negative integer N/A
fo) currently in use. When OSMO
InUse licensing is not installed this
(OSMOLicenseIn The maximum value of the integer any non-negative integer N/A
fo) InUse attribute that has been
Maximum24hUs reported during the last 24
age hours. When OSMO licensing
is not installed this counter is
set to 0.
(OSMOLicenseIn The maximum number of integer any non-negative integer N/A
fo) times the OSMO license
CustomerViolati usage may exceed the
ons number of available OSMO
licenses. When OSMO
licensing is not installed this
CustomerViolati usage has exceeded the
onLimit number of available OSMO
licenses. When OSMO
(OSMOLicenseIn A Boolean flag indicating boolean False, true N/A
fo) whether OSMO licensing is
Enabled installed in the system.
Table 67 Get Licensing Info Output Fields (Seite 2 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Get Licensing Usage Information
7.12 Get Licensing Usage Information

SOAP server supports the retrieval of Voice, OSMO and 3rdParty
Licensing Usage data.

WSDL Version

Table 68 Get Licensing Usage Codes

OperatorId Please refer to Table 10 on
page 80.
LicenseUsageDa The type of license usage enum VoiceAllData VoiceData
ta data being requested. Option VoiceData
VoiceAllData is used to VoiceUCData
retrieve all usage data in a VoiceOSMOData
single response.
Table 69 Get Licensing Usage Input Fields

LicenseUsageVoi A structure containing the following attributes:
ceData
(LicenseUsageV Billing periods are defined as integer any integer N/A
oiceData) monthly time intervals. The
BillingPeriodID billing period ID is the
number of the month where
the billing period starts.
(LicenseUsageV The maximum value set for integer any integer N/A
oiceData) used licenses. Any increment
HighWatermark which produces a current
value numerically greater
than the current 'high
watermark' should cause the
'high watermark' to increase
to the current value.
(LicenseUsageV An ID identifying the product Char 0..40 N/A
oiceData) instance. array
ProductInstance
ID
Table 70 Get Licensing Usage Output Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Get Licensing Usage Information

(LicenseUsageV The number of remaining integer any integer N/A
oiceData) days until the license is
RemainingDays expired.
LicenseUsageOS A structure containing the following attributes:
MOData
(LicenseUsageO Billing periods are defined as integer any integer N/A
SMOData) monthly time intervals. The
BillingPeriodID billing period ID is the
number of the month where
the billing period starts.
(LicenseUsageO The maximum value set for integer any integer N/A
SMOData) used licenses. Any increment
HighWatermark which produces a current
value numerically greater
than the current 'high
watermark' should cause the
'high watermark' to increase
to the current value.
(LicenseUsageO An ID identifying the product Char 0..40 N/A
SMOData) instance. array
ProductInstance
ID
(LicenseUsageO The number of remaining integer any integer N/A
SMOData) days until the license is
RemainingDays expired.
CustomerViolati usage has exceeded the
onLimit number of available OSMO
licenses. When OSMO
(OSMOLicenseIn A Boolean flag indicating boolean False, true N/A
fo) whether OSMO licensing is
Enabled installed in the system.
Table 70 Get Licensing Usage Output Fields (Seite 2 von 2)
The interface unsp__GetLogFiles has been implemented for

attaching the log file tar created by the unsp__CollectLogFiles() and
attach it to the SOAP envelope using SOAP with Attachments (SwA).
SwA is not a W3c recommendation and it is superseded by Message
Transfer Optimized Mechanism (MTOM) which was suggested in the
initial version of the LM. However current version of Axis does not
support this technology yet, so it was decided to choose the more
conventional DIME.
Along with the attachment the following parameters will be included in

the SOAP response of unsp__GetLogFiles:
A31003-H80A0-T101-1-7618, 11/2021
Get Destination List
• TotalNumberOfSuppressed : Each time a new record that

satisfies filtering criteria is found, then this number is increased
by num_prior_occurences.
• TotalNumberOfRecords : this number is increased by one

each time a record that satisfies input filtering criteria is found.
• Distinct Records: Each time a new record that satisfies

filtering criteria is found, and its error description is not found in
the pool of error descriptions then this generic counter is
increased by 1.
The following table represents the input parameters:

Operator Id
Log File Name Log File Name
7.13 Get Destination List

This SOAP request provides the capability to display a list of existing
destinations. For each entry, the name of the destination is returned.

WSDL Version
subRC_APP_UTIL_DEST_NP_NAME_LEN_INVALID
subRC_SYS_UTIL_DEST_ALLOC_ERR
subRC_DB_UTIL_DEST_LOOKUP_FAILED
Table 71 Get Destination List Return Codes

Table 72 Get Destination List Input Field Descriptions

DestinationListD The names of the N/A
ata(list) destinations.
Table 73 Get Destination List Output Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Translate Dialed Digits

page 86.
Table 73 Get Destination List Output Fields (Seite 2 von 2)
7.14 Translate Dialed Digits

This method provides the ability to perform a test translation of a given
dialed digit string from an existing subscriber on the system. It will test
the routing definitions and facilities of the platform. This method will
return the platform address translation and routing destination for a
subscriber dialing a specific set of digits. The BG Name is passed as
input, but not currently used. It may be used in the future to allow for
non-DID subscribers.
The result structure contains two sets of return information. The first
is that the request was proper and could be processed. The second (the
Translation Result) is the results of the translation itself.

WSDL Version
subRC_APP_SUB_DN_DOES_NOT_EXIST
subRC_DB_SUB_DN_LOOKUP_FAILED
Table 74 Translate Dialed Digits Return Codes

ServiceId Please refer to Table 10 on
page 78.
DialedDigits The DN of the potential 30 Numeric string ““
terminating destination.
Table 75 Translate Dialed Digits Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Translate Dialed Digits
Field Name Description Length Range/Value Default Value

Translation The result code returned by enum XLARC_Success, N/A
Result XLA for the attempted XLARC_Failure,
translation. XLARC_Error,
XLARC_InvalidAddr,
XLARC_InvalidAddrFormat,
XLARC_NotEnoughDigits,
XLARC_InvalidCAC,
XLARC_InvalidCACFormat,
XLARC_UnauthorizedCarrTraffic
,
XLARC_FGDInScreeningFailed,
XLARC_AllRoutesBusy,
XLARC_NoRoutesFound,
XLARC_InvalidIntcptId,
XLARC_UnallocatedNumber,
XLARC_DNDisconn,
XLARC_Enum,
XLARC_Misdialing,
XLARC_NoIntcptTrt,
XLARC_EPUnregistered,
XLARC_EmptyNpId,
XLARC_ErrorConvertType
DestType The destination type as enum XLADT_None, N/A
determined by the XLADT_Dest,
translation, if successful. XLADT_EP,
XLADT_Svc,
XLADT_Ln,
XLADT_TrkCircuit,
XLADT_MGCPMS,
XLADT_Vacant,
XLADT_HomeDN,
XLADT_DNDisconn,
XLADT_Enum,
XLADT_Intcpt,
XLADT_InvalidCode,
XLADT_TOD,
XLADT_E164,
XLADT_NpId,
XLADT_HomeExt,
XLADT_HomeLoc,
XLADT_EmrgLoc,
XXLADT_CallingLoc,
XLADT_Prefix_Dest
DestName The destination name as N/A
determined by the
translation, if successful.
Table 76 Translate Dialed Digits Output Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Get Supported Language List

CallType The call type as determined enum XLACT_None, N/A
by the translation, if XLACT_CallNonCarrier,
successful. XLACT_CallLECIntraLATA,
XLACT_CallLECOptr,
XLACT_CallLECOptrIntraLATA,
XLACT_CallCarrIntraLATA,
XLACT_CallCarrInterLATA,
XLACT_CallCarrIntl,
XLACT_CallCarrIntlZone1,
XLACT_CallCarrOptr00,
XLACT_CallCarrCutThruFGPD,
XLACT_CallCarrFGPB,
XLACT_CallSvc,
XLACT_CallCarrOptrIntraLATA,
XLACT_CallCarrOptrInterLATA,
XLACT_CallCarrOptrIntl,
XLACT_CallCarrOptrIntlZone1,
XLACT_CallCarrTollFree,
XLACT_CallDA411,
XLACT_CallDAHNPA,
XLACT_CallDAFNPA,
XLACT_CallEmrg,
XLACT_CallLECOptrLocal,
XLACT_CallCarrLD
DialingPattern The dialing pattern as enum XLADP_None, N/A
determined by the XLADP_Optr0Plus,
translation, if successful. XLADP_Optr0,
XLADP_Optr00,
XLADP_IntlOptr,
XLADP_IntlDDD,
XLADP_DDD,
XLADP_NP,
XLADP_FGPB,
XLADP_FGPD,
XLADP_TollFreeCode,
XLADP_CACHome,
XLADP_CACHomeNoCarrDesig,
XLADP_CACHomeCarrDesig,
XLADP_OffNetAC,
XLADP_OnNetAC,
XLADP_FacilityAC,
XLADP_AttdntAC,
XLADP_Extension
Table 76 Translate Dialed Digits Output Fields (Seite 2 von 2)
7.15 Get Supported Language List

This function is used to retrieve and display language information,
including the list of languages supported on the system.
A31003-H80A0-T101-1-7618, 11/2021
Get Total Number of Call Pickup Groups

WSDL Version
subRC_APP_UTIL_LANG_SWITCH_MODE_INVALID
subRC_APP_UTIL_LANG_SWITCH_LOOKUP_FAILED
subRC_APP_UTIL_LANG_DEFAULT_INVALID
subRC_APP_UTIL_LANG_INVALID
Table 77 Get Supported Language List Return Codes
There are no input fields for this method.

Value
SwitchLanguageMode An array of strings, each enum Single N/A
one being the name of the Multiple
RTP parameter.
SystemDefaultLanguage The default language for 1..30 Character String N/A
the switch.
GetSupportedLanguageListD An array of GetSupportedLanguageListEntry elements, each containing the
ata following fields:
GetSupportedLanguageListEn The name of a supported 1..30 Character String N/A
try. language.
Language
GetSupportedLanguageListEn The three digit code used 1..3 Character String N/A
try. to represent the supported
LanguageCode language.
Table 78 Get Supported Language List Output Fields
7.16 Get Total Number of Call Pickup Groups

This function is used to calculate the number of call pick up groups
among all BGs.
Call pick up groups with the same ID that belong to different BGs are
counted as independent entities. Call pick up groups of the same Id
that are assigned to multiple subscribers that belong to the same BG
are considered as a single entity. In V3.1, the function is added under
utilities menu (80) option 8o.
A31003-H80A0-T101-1-7618, 11/2021
Get Fully Qualified Number

WSDL Version
subRC_APP_BG_NAME_LEN_INVALID
subRC_APP_BG_DOES_NOT_EXIST
subRC_DB_BG_LOOKUP_FAILED,
Table 79 Get Total Number of Call PIckup Groups Return Codes

OperatorID The operator issuing the Please refer to the definition of Operator ID
command in Section 5.4, “Primitive Data Definitions”,
on page 78.
BGName The name of BG group When Character String Optional
NIL, ALL
BG
groups
are
included
Table 80 Get Total Number of Call PIckup Groups Input Fields

CPUCount The operator issuing the Integer N/A
command
BGName The name of BG group that Character String
contains the number of CPU
groups.
When NIL, ALL BG groups are
included for the calculation
Table 81 Get Destination List Output Fields
7.17 Get Fully Qualified Number

This interface is used in order to convert a specified sequence of digits
(DialedDigits) to a FQN (Fully Qualified Number) or CPN (Complete
Private Number) in the context of the InputFQN Numbering Plan.
A31003-H80A0-T101-1-7618, 11/2021
Get Fully Qualified Number

WSDL Version
12.00.04.08 N/A subRC_SUCCESS Success
subRC_APP_SUB_FQN_INFQN_INVALID Invalid Fully Qualified Number
(input)
subRC_APP_SUB_FQN_DIALEDDIGITS_INVALID Invalid Dialed Digits
(input)
subRC_APP_SUB_FQN_RSS_INFQN_DOES_NOT_EXIST Input fully
qualified number not found in RSS
subRC_APP_SUB_FQN_RSS_INFQN_INVALID Input fully qualified
number invalid
subRC_APP_SUB_FQN_XLA_TRANSLATION_INCOMPLETE Translation of
dialed digits from XLA not completed
subRC_APP_SUB_FQN_XLA_TRANSLATION_FAILED Translation of dialed
digits from XLA failed
subRC_APP_SUB_FQN_RSS_TRANSLATED_DN_DOES_NOT_EXIST
Translated number not found in RSS
subRC_APP_SUB_FQN_RSS_TRANSLATED_DN_INVALID Translated
number invalid
subRC_APP_SUB_FQN_NDAL_CONVERTION_FAILED Conversion from
NDAL to fully qualified number failed
Table 82 Get Fully Qualified Number Return Codes

OperatorId Please refer to Section 5.4, required
“Primitive Data Definitions”,
on page 78.
InputFQN The directory number that 32 character string required
has the numbering plan
defined in the OpenScape
Voice system.
DialedDigits The directory number that 32 character string required
would be converted to FQN or
CPN.
Table 83 Get Fully Qualified Number Input Fields

FullyQualifiedNu The number in FQN or CPN 32 Character String
mber format
Table 84 Get Fully Qualified Number Output Fields
A31003-H80A0-T101-1-7618, 11/2021
Get System Info
7.18 Get System Info

This interface is used in order to retrieve basic information on the
system such as CPU, memory usage and if the system is virtualized or
not.

WSDL Version
subRC_SUCCESS Success
Others ??
Table 85 Get System Info Return Codes

on page 78.
Table 86 Get System Info Input Fields

OvlMgrSysInfo A structure that consists of String
the following:
CpuUsed Amount of CPU usage String
MemoryUsed Amount of memory usage String
UpdateTime Time of last update String
BootTime When system was last booted String
Virtualized is the system virtual Boolean
Table 87 Get System Info Output Fields
7.19 Access EZIP Info

This interface is used to access parameters that normally are entered
via the EZIP / NCPE-tool. It permits the Assistant via SOAP to change
a subset of the EZIP parameters and makes for no-reboot / no-outage
changes of items such as
A31003-H80A0-T101-1-7618, 11/2021
Access EZIP Info
• DNS
• NTP
• superuser IP
• RSA IP, netmask, gateway
• mtc_ctl_url
• Default router IP
• Survival Authority IP
• snmp server IP and port
• license server IP and port

WSDL Version
subRC_SUCCESS Success
Others
Table 88 Access EZIP Parameter Return Codes

on page 78.
EZIPParmAction The action to perform. string
• Update
• Restore
EZIPDataListReq A list structure that consists of the following:
ues
EZIPData The data for the action required
Table 89 Access EZIP Parameter Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Contact Me

EZIPParmData Node.cfg parameters string
• DNS
• NTP
• rsa_1_ip
• rsa_2_ip
• first_node_rx (routing GWs)
• second_node_rx (routing
GWs)
• stand_alone_service_permitt
ed
• superuser IP
• RSA IP
• netmask
• gateway
• mtc_ctl_url
• Default router IP
• Survival Authority IP
• snmp server IP and port
• license server IP and port
Table 89 Access EZIP Parameter Input Fields (Seite 2 von 2)

Result The result code of the Type unsp__ResultCodeStruct
operation.
EZIPDataListRes A list structure that consists of the following:
ult
ZIPParmData The NCPE parms that were String
acted upon.
Table 90 Access EZIP Parameter Output Fields
7.20 Contact Me
This interface is a mechanism for a Generic Notification Service based
on SIP Notify message for SIP based subscriber endpoints (OSMO
Mobile, OSMO Tablet, NG Phone). The mechanism allows applications
like UC Server and DLS to notify the subscriber endpoints with server
updates and (optionally) ask for these applications to contact the
server upon receiving the event. A few applications for this mechanism
are:
• Presence Notifications
• New IMs
A31003-H80A0-T101-1-7618, 11/2021
Contact Me
• DLS Server updates (new configuration data, software upgrades

etc)
• New Voicemails
• Web Collaboration Events

on page 78.
ContactMeMess Used to create the Rtp message header when sending the message to SIP Signaling
ageHeader Manager. It is a structure that consists of the following:
EventType Determined from the EventTyp UcContactMeEvent

RtpMessage. e DlsContactMeEvent
ContactDN used in the Rtp message string
header to identify the AoR of
the contact
ContactIID This is typically the mac- string
address assigned to the SIP
device. This is an optional
attribute.
ContactMeMess Used to transparently When DLS:
agePayload retrieve the payload and • Contact request flag
include the payload into the • IP address of DLS
RtpMessage. • DLS socket port
When UC:
• Request ID
• Contact request flag
• Tpe of event (WU - WakeUp,
RE - Restart))
• Addr of UC Proxy
• UC Proxy port
Table 91 Contact Me Input Fields

Result The result code of the Type unsp__ResultCodeStruct
operation.
Table 92 Contact Me Output Fields
A31003-H80A0-T101-1-7618, 11/2021
soap_ext_interfaces_nm.fm
Network Management Interfaces via SOAP
Office Code
8 Network Management Interfaces via SOAP

For the requests in this section, note that query operations typically
include a parameter called “Specific”. This is a Boolean parameter that
is used to indicate whether a specific (single) object is being requested,
or a list of objects is being retrieved. If True, any other input
parameters are used to search for the exact object instance being
requested. If False, any other input parameters are used as filter
criteria and a list of objects matching the given parameters may be
returned. The default if the parameter is not passed is False.
8.1 Office Code
8.1.1 Create Office Code

This method creates an office code. Table 93 lists the return codes for
this method.

WSDL Version
10.00.01 N/A subRC_SUCCESS
Table 93 Create Office Codes Return Codes

OfficeCodeId Numeric identifier of a int 0
specific office code. Must
refer to an existing office
code.
OfficeCode The symbolic name of the Must be a digit sequence of
office code reference. maximum length 9.
N.America: 6 digits
Japan: 5 digits
Korea: 4 or 5 digits
Europe: 1 to9 digits
CountryCode Length of the country code int 0 – 4 in all markets 0
Length prefix in the office code.
AreaCode Length of the area code prefix int N.America: 3
Length in the office code. Japan: 1-5
Korea: 1-2
China: 2-3
Europe: 0-5
Table 94 Create Office Codes Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Office Code

Attributes Defines attributes of the AtrNo, AtrYes
office code. Enumerated type.
ChargeArea The charge area string (Japan 5-digit EmptyStr.
market only). In the Japan string
market, ChargeArea must
be provided; otherwise, it
must be an empty string.
Table 94 Create Office Codes Input Fields (Seite 2 von 2)
8.1.2 Modify Office Code

This method modifies an office code. Table 95 lists the return codes for
this method.

WSDL Version
Table 95 Modify Office Code Return Codes

specific office code.
OfficeCodeId must refer to an
existing office code.
OfficeCode The symbolic name of the of Must be a digit sequence of
the office code reference. maximum length 9.
N.America: 6 digits
Japan: 5 digits
CountryCode Length of the country code int 0 – 4 in all markets 0
Length prefix in the office code.
AreaCode Length of the area code prefix int N.America: 3
Length in the office code. Japan: 1 – 5
Korea: 1 – 2
China: 2 – 3
Europe: 0 – 5
Attributes Defines attributes of the AtrNo, AtrYes
office code. Enumerated type.
Table 96 Modify Office Code Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Office Code

ChargeArea The charge area string (Japan 5-digit EmptyStr
market only). In the Japan string
market, ChargeArea must be
provided; otherwise, it must
be an empty string.
Table 96 Modify Office Code Input Fields (Seite 2 von 2)
8.1.3 Delete Office Code

This method deletes an office code. Table 97 lists the return codes for
this method.

WSDL Version
Table 97 Delete Office Code Return Codes

N.America: 6 digits
Japan: 5 digits
Table 98 Delete Office Code Input Fields
8.1.4 Display Office Code

This method retrieves an office code and displays all information
related to it. Table 99 lists the return codes for this method.

WSDL Version
Table 99 Display Office Code Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Office Code

Specific Refer to the paragraph at the beginning of Chapter 8.
Paging Standard paging structure for Null
paged queries. For details
refer to Section 5.5, “Paging”,
on page 86.
N.America: 6 digits
Japan: 5 digits
Prefix Range of office codes. EmptyStr
Destination Type of destination; used only DtUnused: includes all office Optional
Type in query. If given, restricts codes.
the search to office codes Other destination types are not
with that type. used.
Filter Condition that must be held All: include all office codes. All
for retrieved office codes. It is DnDnNoCodeReference:
used for filtering office codes objects with no references in
retrieved in query. e164_code_t;
DnDnCodeReference: objects
with at least one reference in
e164_code_t;
DnHomeDn: objects with no
references in e164_dn_t
DnHomeDn: objects with at
least one reference in
e164_dn_t
DnNotImported: Objects that
do not set the IMPORT field.
DnImported: objects that do
set the IMPORT set.
Filter, cont. DnVacant: objects that have All
at least one home DN whose
destination type is VACANT
DnNotVacant: objects that
have no home DN whose
destination type is VACANT
CountActivate Indicates whether counts are CmdUnassigned CountActivate
retrieved. CmdYes
CmdNo
OfficeCode Sort Defines whether Sorting is Enum OfficeCodeStUnassigned, OfficeCodeStU
Type performed based on OfficeCodeStOfficeCode nassigned
OfficeCode ot not
Table 100 Display Office Code Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Home DN

SortOrder Determines the way the Enum SortOrderAscending - SortOrderAsce
objectsare sorted. Objects aresorted in nding
ascending order.
SortOrderDescending -
Objects are sorted in
descending order.
Table 100 Display Office Code Input Fields (Seite 2 von 2)
8.2 Home DN
8.2.1 Create Home Dn

This method creates a HomeDN. Table 101 lists the return codes for
this method.

WSDL Version
Table 101 Create Home DN Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Home DN

StartCode Mandatory digit string. 6 N.America: 4 digits EmptyStr
Indicates the first subscriber Japan: 4 digits
number in range. Korea: 4 digits
Europe: 3 – 6 digits
EndCode Optional digit string that N.America: 4 digits EmptyStr
indicates the last subscriber Japan: 4 digits
number in range. If provided, Korea: 4 digits
it must meet the same Europe: 3 – 6 digits
conditions as startCode. The
digit string must be greater
than or equal to that of
startCode.
specific office code. It must
code.
OfficeCode Symbolic name of the of the Must be a digit sequence of
office code reference. maximum length 9.
N.America: 6 digits
Japan: 5 digits
Europe: 1 – 9 digits
Table 102 Create Home DN Input Fields
8.2.2 Modify Home Dn

This method modifies a HomeDN. Table 103 lists the return codes for
this method.

WSDL Version
Table 103 Modify Home DN Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Home DN

ModifyType Used to identify the modify MtModify
command. MtAssign
MtUnassign
StartCodeId Numeric identifier of a int
specific StartCode. The first
Home DN to be modified is
identified by the StartCodeId
(or by the StartCode).
StartCode Mandatory digit string. The 6 N.America: 4 digits EmptyStrs
first Home DN to be modified Japan: 4 digits
is identified by the StartCode Korea: 4 digits
(or by the StartCodeId). Europe: 3 to 6 digits
EndCodeId Numeric identifier of a int
specific EndCode. The last
Home DN to modify is
identified by the EndCodeId
(or by the EndCode).
EndCode Optional digit string. The last N.America: 4 digits
Home DN to modify is Japan: 4 digits
identified by the EndCode (or Korea: 4 digits
by the EndCodeId). If Europe: 3 to 6 digits
provided, it must refer to an
existing Home DN that
represents a continuous
sequence.
OfficeCodeId Numeric identifier of a int
specific office code. Must
code.
OfficeCode The symbolic name of the Must be a digit sequence of
office code reference. The maximum length 9.
office code is identified either N.America: 6 digits
by OfficeCode or Japan: 5 digits
OfficeCodeId. Korea: 4 or 5 digits
Europe: 1 to 9 digits
DestinationId Numeric identifier of a int 0
destination.
Destination Name of the destination str EmptyStr
Name associated with this Home
DN.
Table 104 Modify Home DN Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Home DN

Destination Enumerate value that DtDest
Type represents the type of DtSvc
destination. Mandatory. The DtHomeDn
values that it can take vary DtEnum
for different markets. DtTod
DtIntcpt
DtInvalidCode
DtHomeLoc
DtHomeExt
DtPri
DtUnused
DtTrkCircuit
DtVacant
SubscriberId Numeric identifier of the int
subscriber profile.
Subscriber Symbolic name of the str
Name subscriber profile.
NewDn NewDn is a digit string of str EmptyStr
maximum length 15. It
provides the new DN code
with DNCHANGED
destination. Used only when
the ModifyType is set to
UNASSIGN.
EnableAssign Applies only to the North CmdUnassigned No
America market. Optional. If CmdNo
marked as No and one or CmdYes
more of the home DNs has
ExportTrgLnp, then the
command is rejected.
EnableMatch Indicates whether the EmNo True
assignment of a line requires EmYes
the digits of the line and
home DN objects to match.
Table 104 Modify Home DN Input Fields (Seite 2 von 2)
8.2.3 Delete Home Dn

This method deletes a HomeDN. Table 105 lists the return codes for this
method.

WSDL Version
Table 105 Delete Home DN Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Home DN

StartCodeId Numeric identifier of a int 0
specific StartCode. The first
Home DN to be deleted is
identified by either the
StartCodeId or the
StartCode.
StartCode Digit string. The first Home 6 N.America: 4 digits EmptyStr
DN to be deleted is identified Japan: 4 digits
by either the StartCode or the Korea: 4 digits
StartCodeId. Europe: 3 to 6 digits
EndCodeId Numeric identifier of a int 0
specific EndCode. The last
Home DN to delete is
identified by either the
EndCodeId or the EndCode.
EndCode Optional digit string. The last N.America: 4 digits EmptyStr
Home DN to delete is Japan: 4 digits
identified by either the Korea: 4 digits
EndCode or the EndCodeId. If Europe: 3 to 6 digits
provided, it must refer to an
existing Home DN that
represents a continuous
sequence.
OfficeCode It is the symbolic name of the 9 N.America: 6 digits EmptyStr
office code reference. The Japan: 5 digits
office code is identified either Korea: 4 or 5 digits
by OfficeCode or Europe: 1 to 9 digits
OfficeCodeId.
Table 106 Delete Home DN Input Fields
8.2.4 Query Home Dn

This method queries a HomeDN. Table 107 lists the return codes for
this method.

WSDL Version
Table 107 Query Home DN Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Home DN

paged queries. For details,
on page 86.
SortType Determines whether the • StReference – Objects are sorted by StReference
objects are retrieved with a 2- officeCode and code.
index or 4-index sort. • StDestnation – objects are sorted by
destinationType, destinationId,
officeCode, and code.
SortDirection Determines the way the • SortOrderAscending - Objects are SortOrderAsce
objects are sorted. sorted in ascending order. nding
• SortOrderDescending - Objects are
sorted in descending order.
OfficeCode Substring (or full string) str
Prefix identifying one or a set of
office codes. Supports
wildcarding (%).
StartCode Digit string. The first 6 N.America: 4 digits Emptystr
HomeDN to be retrieved is Japan: 4 digits
identified by StartCode. This Korea: 4 digits
field supports wildcarding Europe: 3 to 6 digits
when a specific OfficeCode
Prefix is given.
EndCode Optional digit string. The last N.America: 4 digits Emptystr
Home DN to retrieve is Japan: 4 digits
identified by the EndCode. It Korea: 4 digits
must refer to an existing Europe: 3 to 6 digits
HomeDN and is used in
combination with StartCode
to retrieve a range of
HomeDns. It does not
support wildcarding
sequence.
Destination If provided, restricts the DtDest
Type search to home DNs with that DtEp
type. DtLn
DtSvc
DtHomeDn
DtEnum
DtTod
DtIntcpt
DtInvalidCode
DtHomeLoc
DtHomeExt
DtPri
DtUnused
DtTrkCircuit
DtVacant
Table 108 Query Home DN Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Endpoint

Destination If provided, further restricts str EmptyStr
Name the search to home DNs with
that specific destination.
Filter Condition that must hold for DnAll: Retrieve all home DNs DnAll
retrieved home DNs. Used for DnVacant: objects whose
filtering office codes retrieved destination has type VACANT.
in Query. DnNotVacant: objects whose
destination type is not VACANT.
Note: This is a subset of the

complete list of filters. Only
these values are valid for Query
home DN.
BGName Please refer to Section 5.4,
on page 78 for a detailed
description. A string
containing the wildcard
character (%) can also be the
input. Matching entries will be
returned in this case
Table 108 Query Home DN Input Fields (Seite 2 von 2)
8.3 Endpoint
8.3.1 Create Endpoint

This method creates an endpoint. Table 109 lists the return codes for
this method.

WSDL Version
V5.00.18.01 subRC_APP_DSA_LOCATION_DOMAIN_NAME_SIP_PROXY_INVALID
Table 109 Create Endpoint Return Codes

Name CLI name of the endpoint. str
Table 110 Create Endpoint Input Fields (Seite 1 von 15)
A31003-H80A0-T101-1-7618, 11/2021
Endpoint

IpAddress Character string with the IP str ““
Address of the endpoint. If
the IP address and port are
provided with non-default
value, it must be unique in
the set of addresses that
include:
{ipAddress, port}
combinations for endpoint
{rasIpAddress,rasPort}
{ipAddress, port}
combinations for gatekeepers
AltIpAddress Optional secondary IP str
address of the endpoint. The
same uniqueness rule (as
above in IpAddress) applies
in AltIpAddress.
RasIpAddress IP address of the RAS channel str
for the SIP endpoint.
ManagementIp Character string for a str “”

Address separate address for the
endpoint allowing its
management using a
different IP address for its
configuration than the
signaling address
(IpAddress field).The
ManagementIpAddress can
Register RTP name of the process that

Process sends an RRQ request.
Port Port is the signaling address int 0
of the endpoint. If the IP
address and port are
include:
{ipAddress, port}
{ipAddress, port}
AltPort Optional secondary IP int
address of the endpoint.
A31003-H80A0-T101-1-7618, 11/2021
Endpoint

RasPort RasPort is an integer that int
represents the RAS port
number at the endpoint.
EndPointType Enumerated type that int EtUnassigned
represents the type of the EtSip
endpoint.
Registration An integer that represents int Default values:
bitwise assignments of five
attributes: Operstate: UNNASIGNED=0
Operational state of the adminState: ACTIVE=1
endpoint (highest 2 bits): authGranted:
UNNASIGNED, ACTIVE, NEITHER_SIDE=1
BLOCKED_NEW,
BLOCKED_ALL If the endpoint is static:
Administrative state of the rrqState:
dynamic endpoint (next 2 UN-REGISTERED=1
bits): UNNASIGNED, ACTIVE, rrqType: STATIC=1
BLOCKED_NEW,
BLOCKED_ALL If the endpoint is dynamic:
Authentication pre-granted: rrqState: REGISTERED=2
indicates whether rrqType: DYNAMIC =3
authentication is pregranted
for a dynamic endpoint (next
3 bits): UNNASIGNED,
NEITHER_SIDE, A_SIDE,
B_SIDE, BOTH_SIDES
RRQ state: indicates whether
a dynamic endpoint is (URQ,
RRQ) (next 2 bits):
UNNASIGNED,
UNREGISTERED,
REGISTERED
RRQ type: indicates whether
the endpoint is static or
dynamic (lowest 2 bits):
UNNASIGNED, STATIC,
DYNAMIC_PORT (static IP),
DYNAMIC
TimeToLive Expiration time for the int
endpoint (if dynamic).
RrqId Internal numeric identifier Int
used by the H.323 process to
identify the registered
endpoint.
A31003-H80A0-T101-1-7618, 11/2021
Endpoint

AccountAuth An enumeration of values for enum AccountAuthUnused, AccountAuthUn
endpoint account AccountAuthUnassigned, used
authorization. AccountAuthBasedOnSub,
Notes: AccountAuthBasedOnEp,
This field is not modifiable AccountAuthNoServices
after creation.
ccountAuthBasedOnSub
applies only to subscriber
type endpoints.
ProfileId Numeric identifier of the int
associated endpoint profile
object.
ProfileName Symbolic name of the str
association endpoint profile
object.
Sessions Maximum number of sessions Int For SIP endpoint, it has a 3
allowed for the endpoint. default value 3.
For non-SIP endpoint, it takes
Note that for non-PBX the default value 1.
subscriber endpoints, this Otherwise, it must take a value
represents the number of greater than 0 and less than a
messaging sessions, not the maximum that is provided as
number of voice (audio) an RTP configuration variable.
sessions.
Default and maximum values
are determined by the RTP
parameters: Srx/Sip/
default_number_of_sessions
and Srx/Sip/
max_number_of_sessions.
Transport Transport specifies the int One of TtUdp, TtTcp, and TtTls
transport protocol for a SIP
endpoint
SdesSrtpSuppor “Best-Effort SRTP with SDES” Enum SrtpUnassigned SrtpDisabled
t attribute to determine SrtpAutomatic
whether to include the SRTP SrtpEnabled
media in the SDP offer or not. SrtpDisabled
A31003-H80A0-T101-1-7618, 11/2021
Endpoint

AnatSupport Indicates whether the Enum AnatUnassigned If the
endpoint supports ANAT. AnatAuto registration of
AnatOn indicates that the AnatOn, the endpoint is
endpoint supports ANAT. AnatOff static: AnatOn
AnatOff means that the
endpoint does not support If the
ANAT. registration of
AnatAuto means whether the the endpoint is
endpoint supports ANAT shall dynamic:
be determined by the SIP AnatAuto
registrar during registration
of the endpoint. (For
AnatUnassigned indicates registration
that the default value should types please
be assigned, refer to
Endpoint
Registration
field)
Attributes A list of the following Boolean flags:
(Attributes) Indicates whether the boolean false false
SendAuthNumA AuthNum is send as PAI true
sPAI
(Attributes) Indicates whether for this boolean false false
CallingPartyCate endpoint, the incoming true
gory CallingPartyCategory (CPC) is
interpreted as the originating
class of service.
(Attributes) Indicates whether this boolean false false
UpdateOnConfir endpoint uses UPDATE for true
medDialaouge confirm dialogue support. If
false, only SIP:RE-INVITE is
used for confirm dialogue
support.
SendProvRespo endpoint sends a provisional true
nseOnUpdate response during session
updates.
QSigOverSip endpoint supports SIPQ true
signaling.
A31003-H80A0-T101-1-7618, 11/2021
Endpoint

ImsFor3GPP endpoint supports 3GPP IMS. true
If switch application type is
set to IMS MGCP then SIPSM
constructs RequestURI in TEL
URI format, and TO, FROM
and P-Asserted headers host
part are constructed with IMS
domain name.
Note that this attribute is not

associated with a SIP
subscriber, but with the SIP
endpoint, so it can only be set
(including being exported and
imported) using the Endpoint
provisioning requests, not the
Subscriber requests.
(Attributes) Indicates that the endpoint boolean false false
PreConditionalSi has precondition signaling true
gnalling enabled.
EarlySessionMe endpoint has early-session true
dia media signaling enabled.
TrustedSubscrib subscriber is located behind a true
er trusted endpoint.
OBSOLETE / REMOVED in
V8
GSMSubscribe endpoint is a GSM Mobile IP true
Centrex subscriber.
V8
SurvivableProxy endpoint is a survivable SIP true
proxy endpoint.
(Attributes) Indicates whether TEL URI boolean false false
URISupportReq must be used for sending true
uired addresses on this interface.
(Attributes) Indicates whether TEL URI is boolean false false
URISupportAllo allowed to be used for true
wed sending addresses on this
interface.
SendUriAsRecei address specification is sent true
ved as originally received.
A31003-H80A0-T101-1-7618, 11/2021
Endpoint

(Attributes) Indicates whether the TEL boolean false false
SendUriInTeleph URI is sent in telephone true
oneSubscriberFo subscriber (global number or
rmat local number) format
(including phone context for
local numbers).
(Attributes) Indicates whether the TEL boolean false true
SendUriWithout URI is send in local number true
PhoneContext format without phone
context.
Note that the default is true,

and this is the only currently
supported option for local
number format.
SendUriAsDialSt URI is send in local number true
ring format with phone context.
Note that the default is false,
and this option is not
currently supported.
(Attributes) Indicates whether or not to boolean false false
NumericUserIP treat all numeric user info true
(without user=phone) as
user=ip.
(Attributes) Indicates whether the size of boolean false false
TruncateMIME the MIME will truncated to true
reduce its size.
(Attributes) Indicates whether national or boolean false false
NationalOrInter international prefix should be true
NationalPrefix inserted.
PDCSBillingInfo sending of the STP P-DCS- true
Supported Billing-Info header
parameters is supported.
V8
GenerateReason endpoint a reason header is true
Header generated in response for
responses/release messages
without a reason header.
SendReasonHea endpoint a reason header is true
derForQ850 sent for Q.850 protocol - non-
2XX final responses mapped
to Q.850 protocol
specifications are allowed to
be sent.
A31003-H80A0-T101-1-7618, 11/2021
Endpoint

derForSip sent for SIP protocol - non-
2XX final responses which are
SIP-specific (without Q.850
protocol specifications) are
allowed to be sent.
DoNotSendReas endpoint a reason header is true
onHeader not to be sent - provides
backward compatibility by
filtering the reason header
from any response sent to a
SIP UA.
SipOliRequired endpoint the OLI is to be true
sent. (Supported
The format of the OLI to be until
sent depends on the V5.00.22.01)
IsupOliRequired attribute.
When WSDL is V5.00.22.01

or less this value is created/
modified/displayed.
When WSDL is greater than

V5.00.22.01, it is created/
modified/displayed as
VoiceMail
(Attributes) Indicates whether the OLI is boolean false false
IsupOliRequired to be signaled as an true
ISUP_OLI parameter or as an
OLI parameter.
IgnoreIngressC endpoint, the CPC, OLI, or true
pcOli ISUP OLI is ignored if
received in the incoming
SIP:INVITE.
(Attributes) Indicates whether the Answer Boolen false false
IgnoreAnswerFo for announcement should be true
rAnnouncement ignored
(Attributes) Indicates whether security is boolean false false
EndpointIsSecur enabled for this endpoint. true
e OBSOLETE / REMOVED in
V8.
A31003-H80A0-T101-1-7618, 11/2021
Endpoint

EndpointIsProxy endpoint is a SIP proxy true
server.
Note that this attribute

applies only to non-
subscriber endpoints.
(Attributes) Indicates whether all boolean false false
RouteViaProxy SIP:INVITE messages to SIP true
UAs that are registered via an
associated SIP endpoint are
sent to the associated SIP
endpoint.
Note that this attribute may

be true only if
EndpointIsProxy is also true.
EndpointIsInacc endpoint is in an inaccessible true
essible state.
Note that this attribute is

read-only and is only listed
here for completeness.
(Attributes) Indicates whether media boolean false false
MediaServerRed redirection is allowed for this true
irectionAllowed endpoint.
(Attributes) Indicates whether, in the boolean false false
RerouteToAltern scenario where the first true
ateIp destination
is not reachable, the switch
will look for an alternate
destination for the new
request.
V8.
(Attributes) Indicates whether to use the boolean false false
UseServerVirtua server virtual IP address for true
lIp SIP gateways,
SIP application server, and
SIP voice mail. If TLS is
selected as transport type
then server to server
communication is through
mutual authentication.
(Attributes) Indicates whether this is the boolean false false
StaticIMSSub endpoint of a static IMS true
subscriber.
V8.
A31003-H80A0-T101-1-7618, 11/2021
Endpoint

(Attributes)Call Indicates that the endpoint is boolean false false
CenterApplicati a call center application. true
on
(Attributes)End A SIP NNI endpoint assigned boolean false false
pointIsAssociate with this attribute set to true true
dServer shall be excluded from
Trunking Session licensing
scenarios.Note that this
attribute applies only in the
Enterprise environment.
(Attributes)Acce A charge number received in boolean false false
ptBillingNumber a X-Siemens-CDR header true
field of a SIP INVITE or REFER
request (for blind call
transfer) will be included as
the “ANI/Billing number”
(field13.) of the CDR for the
call.
(Attributes)Sen When a Referred-By header boolean false true
dInsecureReffer field is included in the initial true
edByHeader request sent to the transfer
target (for a blind transfer),
the Referred-By header
(including any generic-
parameters) will be passed
transparently from the
transferor to the transfer
target.
(Attributes) This attribute forces selection Boolean false false
OverrideIRMCod of codecs by overriding IRM true
ecRestrictions restrictions.
(Attributes) This attribute indicates Boolean false false
ReroutingSiptoS whether the subscriber true
ip rerouting of incoming calls
through the SIP endpoint to a
survivable SIP subscriber is
allowed.
ReroutingFwd whether subscriber rerouting true
of incoming calls through the
SIP endpoint that are
forwarded to a survivable SIP
subscriber is allowed.
(Attributes) If this attribute is set, calls Boolean false, true false
TransferHandoff can be transferred to the
Genesys.
A31003-H80A0-T101-1-7618, 11/2021
Endpoint

(Attributes) The purpose for this is to be Boolean True, False false
Reserved3 prepared for future urgent
requests requiring a new
endpoint attribute and where
new functionality via OSV
(e)patch is delivered but
there is no time to deliver the
corresponding Assistant
changes at the same time.
The intention is to use these
reserve attributes only in
exceptional cases where the
regular process of adding
endpoint attributes can not
be applied due to time
constraints. Usage of these
reserve attributes must be
explicitly approved by
development management
(Attributes) Boolean True, False false
Reserved4
TrafficIsPublicOf Separate endpoints will be Boolean false, true false
fNet provisioned to segregate SIP
NNI PSTN/off-net traffic from
on-net traffic. The flag is only
applicable to SIP NNIs. The
default of the flag is false;
i.e., not set.
SipPrivateNetwo A new endpoint attribute for
rk SIP private networking,
defined by UCE/UCE services.
SOAP will support this newly
introduced attribute which
will process originating and or
terminating calls over that
signaling interface.
(Attributes) Indicates if the Proxy will be Boolean TrueFalse False
AllowProxyByPa bypassed
ss
(Attributes) Indicates whether the ACCB Boolean TrueFalse False
AccbSupported attribute is supported or not
(Attributes) Enable/Disable Audit Boolean True, False False
DoNotAuditEndp Mechanism
oint
(Attributes) Enable/Disable Anat Setting Boolean True, False False
AnatSetting
(Attributes) Enable/Disable CallPath Boolean True, False False
SupportCallback reservation
PathReservation
A31003-H80A0-T101-1-7618, 11/2021
Endpoint

(Attributes) New name for the Boolean True, False false
SendInternation SendUriInTelephoneSubscrib
al erFormat attribute.
(Attributes) When enabled, the endpoint’s Boolean True, False false
UseEndpointDef default home DN is selected
aultHomeDnAsA as authentication number
uthNumber when sending the SIP INVITE
via the SIP NNI endpoint
sending the SIP INVITE via
the SIP NNI endpoint.
(Attributes) When enabled, the Boolean True, False false
UseSubscriberH subscriber’s home DN is
omeDnAsAuthN selected as authentication
umber number when sending the
SIP INVITE via the SIP NNI
endpoint.
(Attributes) When enabled, the long call Boolean True, False false
DisableLongCall duration timer is disabled.
Audit
SendReceiveIm If the attribute is false, then No Boolean False

pactLevel no ‘Impact Level’ notifications [False, True]
shall be sent to this endpoint
and any ‘Impact Level’
notifications received from
this endpoint shall be
ignored.
EnablePrack To provide support of the SIP bool True,False false

PRACK method. The first step
provides a limited support of
PRACK on a half-call basis for
the OSV as a B2BUA evolving
to a future step when end-to-
end support can be provided.
The first step limited PRACK
implementation referenced
herein as identified as
“PRACK-Lite”. Supported
from WSDL V5.00.40.01
(Attributes) TLS per RFC5626 ping bool
TlsRfc5626Ping
(Attributes TLS Dual Path Method bool
TlsDualPathMet
hod
(Attributes) Use the Endpoint Default bool
UseEndpointDef HomeDn As Authorization
aultHomeDnAsA Number
uthNumber
A31003-H80A0-T101-1-7618, 11/2021
Endpoint

(Attributes) If enabled, his attribute bool True,False false
DoNotSendAlph prevents SIPSM from sending
anumericSIPURI alphanumeric SIP URIs to the
endpoint.
(Attributes) If enabled, this attribute bool True,False false
SendAlphanume indicates that the endpoint
ricSIPURIWhenA prefers receiving
vailable alphanumeric SIP URIs.
SupportPeerDo allows an SBC to send its IP
mains address or FQDN in an maddr
Contact URI parameter in
case it receives a contact URI
from a dynamic peering
domain.
(Attributes) bool True,False false
MutualAuthentic
ation
SupportPeerDo
mains
(Attributes) Endpoint is a Central SBC. bool True,False false
CentralSBC Applicable only to proxy/SBC
endpoints
(Attributes) When this attribute is set, the bool True,False false
UseBillingNumb Accept Billing Number
erForDP attribute must be set as well
(not vice versa though, you
can set the Accept Billing
Number endpoint attribute
without setting the Use Billing
Number for Display Purposes
CFLoopExtende
d
Reserved5
(Attributes)Sen Send Receive Impact Level bool
dReceiveImpact
Level
(Attributes) Indicates whether the enum ICEAutomatic ICEEnabled

ICEEnabled endpoint supports ICE ICEEnabled
AddressOf The address used by SIP at 0..64 character string ““
Record registration of the endpoint.
SendPreferredId If this endpoint attribute is Boolean True False
entityHeader set then the preferred False
identity header is sent.
A31003-H80A0-T101-1-7618, 11/2021
Endpoint

SendDomainNa If this endpoint attribute is Boolean True False
meInFromHead set the host part of the From False
er header of the initial INVITE to
an Italtel SIP trunk will
contain the OpenScape Voice
domain name instead of the
IP address.
SendForwarding If this endpoint attribute is Boolean True False
NumberInHeade set the forwarding number False
rs will be send in headers.
DoNotSendDiver If this endpoint attribute is Boolean True False
sionHeader set then the diversion header False
will not be sent.
DoNotSendInvit If this endpoint attribute is Boolean True False
eWithoutSDP set then it will be not allowed False
to send an invite without SDP.
EnhancedSubscr Enhanced Subscriber Boolean TrueFalse False
iberRerouting Rerouting shall be attempted
for calls to an endpoint that is
provisioned with the new
"Enhanced Subscriber
Rerouting" attribute if the last
route in the route set towards
the endpoint is CAC
restricted.This endpoint
attribute only applies to non-
subscriber endpoints.Note:
this flag is intended to be set
for Voice Mail Servers.
ServerFailover Indicates whether network enum EpFailoverOff
server failover is enabled for EpFailoverOn
this endpoint.
KeysetUse Indicates whether this enum KeysetNone
subscriber is associated with KeysetPrimaryLine
a keyset device, either as a KeysetPhantomLine
primary or phantom line.
NumberAliases Number of aliases on list int
NodeName Symbolic identifier of str
endpoint that “owns” the alias
or suffix.
AliasName Name of an alias or alias str
suffix.
(AliasCreate Enumerated value that int AtSipUrl
Object) represents the type of the
AliasType alias.
A31003-H80A0-T101-1-7618, 11/2021
Endpoint

(AliasCreate Symbolic name of the str
Object) associated customer.
Customer
Name
(AliasCreate Symbolic name of the int
Object) associated customer.
Registration
EndpointLocatio The name of the endpoint Character 1…20 N/A
nName location String
EndpointLocatio The code of the endpoint Character 1…8 N/A
nCode location String
EndpointNNITyp The Type of the NNIType enum NNITypeUnused, NNITypeOpenS
e NNITypeUnassigned, capeVoice
NNITypeOpenScapeVoiceNNITy
pe,
Hipath4000,
NNITypePSTNGateway,
NNITypeOther
EndpointProvide The name of the Endpoint Character 1…12 N/A
rName Provider. Note that in order to String
set the provider the NNIType
should be set to
PSTNGateway
DnsSrv The type of the DnsSRV enum DnsSrvUnassigned DnsSrvDisable
DnsSrvDisabled d
DnsSrvEnabled
OutgoingCallSu For a dialog-initiating int System default
pervisionTimer outgoing INVITE, the if no value
maximum time for the supplied
transaction timer.
ProxyBypassSup If no timer is configured on int System default
ervisionTimer the SIP proxy, then the if no value
system-wide default for Proxy supplied
Bypass Supervision shall be
used.
8.3.2 Modify Endpoint

This method adds, deletes, and updates an endpoint. Table 111 lists
the return codes for this method.

WSDL Version
Table 111 Modify Endpoint Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Endpoint

WSDL Version
Table 111 Modify Endpoint Return Codes

Name CLI name of the endpoint. str
IpAddress Character string with the IP str ““
Address of the endpoint. If
the IP address and port are
include:
{ipAddress, port}
{ipAddress, port}
NewName New CLI name of the endpoint str
AltIpAddress Optional secondary IP str
address of the endpoint. The
same uniqueness rule (as
above in IpAddress) applies in
AltIpAddress.
RasIpAddress IP address of the RAS channel str
for the SIP endpoint.
ManagementIpA Character string for a str “”
ddress separate address for the
endpoint allowing its
management using a
different IP address for its
configuration than the
signaling address (IpAddress
field).The
ManagementIpAddress can
be provisioned in IPv4, IPv6
or FQDN format. If this field is
not configured, the IpAddress
of the endpoint is considered
Register RTP name of the process that

Process sends an RRQ request.
Table 112 Modify Endpoint Input Fields (Seite 1 von 15)
A31003-H80A0-T101-1-7618, 11/2021
Endpoint

Port Port is the signaling address int 0
of the endpoint. If the IP
address and port are provided
with non-default value, it
must be unique in the set of
addresses that include:
{ipAddress, port}
{ipAddress, port}
AltPort Optional secondary IP int
address of the endpoint.
RasPort RasPort is an integer that int
represents the RAS port
number at the endpoint.
EndPointType Enumerated type that int EtUnassigned
represents the type of the EtSip
endpoint.
A31003-H80A0-T101-1-7618, 11/2021
Endpoint

Registration An integer that represents int Default values:
bitwise assignments of five
attributes: Operstate: UNNASIGNED=0
Operational state of the adminState: ACTIVE=1
endpoint (highest 2 bits): authGranted:
UNNASIGNED, ACTIVE, NEITHER_SIDE=1
BLOCKED_NEW,
BLOCKED_ALL If the endpoint is static:
Administrative state of the rrqState:
dynamic endpoint (next 2 UN-REGISTERED=1
bits): UNNASIGNED, ACTIVE, rrqType: STATIC=1
BLOCKED_NEW,
BLOCKED_ALL If the endpoint is dynamic:
Authentication pre-granted: rrqState: REGISTERED=2
indicates whether rrqType: DYNAMIC =3
authentication is pregranted
for a dynamic endpoint (next
3 bits): UNNASIGNED,
NEITHER_SIDE, A_SIDE,
B_SIDE, BOTH_SIDES
RRQ state: indicates whether
a dynamic endpoint is (URQ,
RRQ) (next 2 bits):
UNNASIGNED,
UNREGISTERED,
REGISTERED
RRQ type: indicates whether
the endpoint is static or
dynamic (lowest 2 bits):
UNNASIGNED, STATIC,
DYNAMIC_PORT (static IP),
DYNAMIC
TimeToLive Expiration time for the int
endpoint (if dynamic).
RrqId Internal numeric identifier Int
used by the H.323 process to
identify the registered
endpoint.
AccountAuth An enumeration of values for enum AccountAuthUnused, AccountAuthUn
endpoint account AccountAuthUnassigned, used
Notes: AccountAuthBasedOnEp,
This field is not modifiable AccountAuthNoServices
after creation.
ccountAuthBasedOnSub
applies only to subscriber
type endpoints.
ProfileId Numeric identifier of the int
associated endpoint profile
object.
A31003-H80A0-T101-1-7618, 11/2021
Endpoint

ProfileName Symbolic name of the str
association endpoint profile
object.
Sessions Maximum number of sessions Int For SIP endpoint, it has a 3
allowed for the endpoint. default value 3.
For non-SIP endpoint, it takes
Note that for non-PBX the default value 1.
subscriber endpoints, this Otherwise, it must take a value
represents the number of greater than 0 and less than a
messaging sessions, not the maximum that is provided as
number of voice (audio) an RTP configuration variable.
sessions.
Default and maximum values
are determined by the RTP
parameters: Srx/Sip/
default_number_of_sessions
and Srx/Sip/
max_number_of_sessions.
Transport Transport specifies the int One of TtUdp, TtTcp, and TtTls
transport protocol for a SIP
endpoint
SdeSrtpSupport “Best-Effort SRTP with SDES” Enum SrtpUnassigned SrtpDisabled
attribute to determine whether to SrtpAutomatic
include the SRTP media in the SrtpEnabled
SDP offer or not. SrtpDisabled
AnatSupport Indicates whether the Enum AnatUnassigned If the
endpoint supports ANAT. AnatAuto registration of
AnatOn indicates that the AnatOn, the endpoint is
endpoint supports ANAT. AnatOff static: AnatOn
AnatOff means that the
endpoint does not support If the
ANAT. registration of
AnatAuto means whether the the endpoint is
endpoint supports ANAT shall dynamic:
be determined by the SIP AnatAuto
registrar during registration
of the endpoint. (For
AnatUnassigned indicates registration
that the default value should types please
be assigned, refer to
Endpoint
Registration
field)
Attributes A list of the following Boolean flags:
SendAuthNumA AuthNum is send as PAI true
sPAI
A31003-H80A0-T101-1-7618, 11/2021
Endpoint

CallingPartyCate endpoint, the incoming true
gory CallingPartyCategory (CPC) is
interpreted as the originating
class of service.
UpdateOnConfir endpoint uses UPDATE for true
medDialaouge confirm dialogue support. If
false, only SIP:RE-INVITE is
used for confirm dialogue
support.
SendProvRespo endpoint sends a provisional true
nseOnUpdate response during session
updates.
QSigOverSip endpoint supports SIPQ true
signaling.
ImsFor3GPP endpoint supports 3GPP IMS. true
If switch application type is
set to IMS MGCP then SIPSM
constructs RequestURI in TEL
URI format, and TO, FROM
and P-Asserted headers host
part are constructed with IMS
domain name.
Note that this attribute is not

associated with a SIP
subscriber, but with the SIP
endpoint, so it can only be set
(including being exported and
imported) using the Endpoint
provisioning requests, not the
Subscriber requests.
(Attributes) Indicates that the endpoint boolean false false
PreConditionalSi has precondition signaling true
gnalling enabled.
EarlySessionMe endpoint has early-session true
dia media signaling enabled.
TrustedSubscrib subscriber is located behind a true
er trusted endpoint.
V8
A31003-H80A0-T101-1-7618, 11/2021
Endpoint

GSMSubscribe endpoint is a GSM Mobile IP true
Centrex subscriber.
V8
SurvivableProxy endpoint is a survivable SIP true
proxy endpoint.
URISupportReq must be used for sending true
uired addresses on this interface.
(Attributes) Indicates whether TEL URI is boolean false false
URISupportAllo allowed to be used for true
wed sending addresses on this
interface.
SendUriAsRecei address specification is sent true
ved as originally received.
SendUriInTeleph URI is sent in telephone true
oneSubscriberFo subscriber (global number or
rmat local number) format
(including phone context for
local numbers).
(Attributes) Indicates whether the TEL boolean false true
SendUriWithout URI is send in local number true
PhoneContext format without phone
context.
Note that the default is true,

and this is the only currently
supported option for local
number format.
SendUriAsDialSt URI is send in local number true
ring format with phone context.
Note that the default is false,
and this option is not
currently supported.
(Attributes) Indicates whether or not to boolean false false
NumericUserIP treat all numeric user info true
(without user=phone) as
user=ip.
(Attributes) Indicates whether the size of boolean false false
TruncateMIME the MIME will truncated to true
reduce its size.
A31003-H80A0-T101-1-7618, 11/2021
Endpoint

(Attributes) Indicates whether national or boolean false false
NationalOrInter international prefix should be true
NationalPrefix inserted.
PDCSBillingInfo sending of the STP P-DCS- true
Supported Billing-Info header
parameters is supported.
V8
GenerateReason endpoint a reason header is true
Header generated in response for
responses/release messages
without a reason header.
derForQ850 sent for Q.850 protocol - non-
2XX final responses mapped
to Q.850 protocol
specifications are allowed to
be sent.
derForSip sent for SIP protocol - non-
2XX final responses which are
SIP-specific (without Q.850
protocol specifications) are
allowed to be sent.
DoNotSendReas endpoint a reason header is true
onHeader not to be sent - provides
backward compatibility by
filtering the reason header
from any response sent to a
SIP UA.
SipOliRequired endpoint the OLI is to be true
sent. (Supported
The format of the OLI to be until
sent depends on the V5.00.22.01)
IsupOliRequired attribute.
When WSDL is V5.00.22.01

or less this value is created/
modified/displayed.
When WSDL is greater than

V5.00.22.01, it is created/
modified/displayed as
VoiceMail
A31003-H80A0-T101-1-7618, 11/2021
Endpoint

(Attributes) Indicates whether the OLI is boolean false false
IsupOliRequired to be signaled as an true
ISUP_OLI parameter or as an
OLI parameter.
IgnoreIngressC endpoint, the CPC, OLI, or true
pcOli ISUP OLI is ignored if
received in the incoming
SIP:INVITE.
(Attributes) Indicates whether the Answer Boolen false false
IgnoreAnswerFo for announcement should be true
rAnnouncement ignored
(Attributes) Indicates whether security is boolean false false
EndpointIsSecur enabled for this endpoint. true
e OBSOLETE / REMOVED in
V8.
EndpointIsProxy endpoint is a SIP proxy true
server.
Note that this attribute

applies only to non-
subscriber endpoints.
(Attributes) Indicates whether all boolean false false
RouteViaProxy SIP:INVITE messages to SIP true
UAs that are registered via an
associated SIP endpoint are
sent to the associated SIP
endpoint.
Note that this attribute may

be true only if
EndpointIsProxy is also true.
EndpointIsInacc endpoint is in an inaccessible true
essible state.
Note that this attribute is

read-only and is only listed
here for completeness.
(Attributes) Indicates whether media boolean false false
MediaServerRed redirection is allowed for this true
irectionAllowed endpoint.
A31003-H80A0-T101-1-7618, 11/2021
Endpoint

(Attributes) Indicates whether, in the boolean false false
RerouteToAltern scenario where the first true
ateIp destination
is not reachable, the switch
will look for an alternate
destination for the new
request.
V8.
(Attributes) Indicates whether to use the boolean false false
UseServerVirtua server virtual IP address for true
lIp SIP gateways,
SIP application server, and
SIP voice mail. If TLS is
selected as transport type
then server to server
communication is through
mutual authentication.
(Attributes) Indicates whether this is the boolean false false
StaticIMSSub endpoint of a static IMS true
subscriber.
V8.
(Attributes)Call Indicates that the endpoint is boolean false false
CenterApplicati a call center application. true
on
(Attributes)End A SIP NNI endpoint assigned boolean false false
pointIsAssociate with this attribute set to true true
dServer shall be excluded from
Trunking Session licensing
scenarios.Note that this
attribute applies only in the
(Attributes)Acce A charge number received in boolean false false
ptBillingNumber a X-Siemens-CDR header true
field of a SIP INVITE or REFER
request (for blind call
transfer) will be included as
the “ANI/Billing number”
(field13.) of the CDR for the
call.
A31003-H80A0-T101-1-7618, 11/2021
Endpoint

(Attributes)Sen When a Referred-By header boolean false true
dInsecureReffer field is included in the initial true
edByHeader request sent to the transfer
target (for a blind transfer),
the Referred-By header
(including any generic-
parameters) will be passed
transparently from the
transferor to the transfer
target.
(Attributes) This attribute forces selection Boolean false false
OverrideIRMCod of codecs by overriding IRM true
ecRestrictions restrictions.
ReroutingSiptoS whether the subscriber true
ip rerouting of incoming calls
through the SIP endpoint to a
survivable SIP subscriber is
allowed.
ReroutingFwd whether subscriber rerouting true
of incoming calls through the
SIP endpoint that are
forwarded to a survivable SIP
subscriber is allowed.
(Attributes) If this attribute is set, calls Boolean false, true false
TransferHandoff can be transferred to the
Genesys.
TrafficIsPublicOf Separate endpoints will be Boolean false, true false
fNet provisioned to segregate SIP
NNI PSTN/off-net traffic from
on-net traffic. The flag is only
applicable to SIP NNIs. The
default of the flag is false;
i.e., not set.
SipPrivateNetwo A new endpoint attribute for
rk SIP private networking,
defined by UCE/UCE services.
SOAP will support this newly
introduced attribute which
will process originating and or
terminating calls over that
signaling interface.
(Attributes) Indicates if the Proxy will be Boolean TrueFalse False
AllowProxyByPa bypassed
ss
(Attributes) Indicates whether the ACCB Boolean TrueFalse False
AccbSupported attribute is supported or not
A31003-H80A0-T101-1-7618, 11/2021
Endpoint

(Attributes) Enable/Disable Audit Boolean True, False False
DoNotAuditEndp Mechanism
oint
(Attributes) Enable/Disable Anat Setting Boolean True, False False
AnatSetting
(Attributes) Enable/Disable CallPath Boolean True, False False
SupportCallback reservation
PathReservation
(Attributes) New name for the Boolean True, False false
SendInternation SendUriInTelephoneSubscrib
al erFormat attribute.
(Attributes) When enabled, the endpoint’s Boolean True, False false
UseEndpointDef default home DN is selected
aultHomeDnAsA as authentication number
uthNumber when sending the SIP INVITE
via the SIP NNI endpoint
sending the SIP INVITE via
the SIP NNI endpoint.
(Attributes) When enabled, the Boolean True, False false
UseSubscriberH subscriber’s home DN is
omeDnAsAuthN selected as authentication
umber number when sending the SIP
INVITE via the SIP NNI
endpoint.
(Attributes) When enabled, the long call Boolean True, False false
DisableLongCall duration timer is disabled.
Audit
SendReceiveIm If the attribute is false, then No Boolean False

pactLevel no ‘Impact Level’ notifications [False, True]
shall be sent to this endpoint
and any ‘Impact Level’
notifications received from
this endpoint shall be
ignored.
(Attributes) She purpose for this is to be Boolean True, False false

Reserved3 prepared for future urgent
requests requiring a new
(Attributes) Same as Reserved 2 Boolean True, False false
Reserved4
A31003-H80A0-T101-1-7618, 11/2021
Endpoint

(Attributes To provide support of the SIP bool True,False false
EnablePrack PRACK method. The first step
provides a limited support of
PRACK on a half-call basis for
the OSV as a B2BUA evolving
to a future step when end-to-
end support can be provided.
The first step limited PRACK
implementation referenced
herein as identified as
“PRACK-Lite”. Supported
from WSDL V5.00.40.01
(Attributes) TLS per RFC5626 ping bool
TlsRfc5626Ping
(Attributes TLS Dual Path Method bool
TlsDualPathMet
hod
(Attributes) Use the Endpoint Default bool
UseEndpointDef HomeDn As Authorization
aultHomeDnAsA Number
uthNumber
(Attributes)Use Use Subscriber HomeDn As bool
SubscriberHome Authorization Number
DnAsAuthNumb
er
(Attributes)Sen Send Receive Impact Level bool
dReceiveImpact
Level
(Attributes) If enabled, his attribute bool True,False false
DoNotSendAlph prevents SIPSM from sending
anumericSIPURI alphanumeric SIP URIs to the
endpoint.
SendAlphanume indicates that the endpoint
ricSIPURIWhenA prefers receiving
vailable alphanumeric SIP URIs.
domain.
A31003-H80A0-T101-1-7618, 11/2021
Endpoint

domain.
MutualAuthentic
ation
SupportPeerDo
mains
(Attributes) Endpoint is a Central SBC. bool True,False false
CentralSBC Applicable only to proxy/SBC
endpoints
(Attributes) When this attribute is set, the bool True,False false
UseBillingNumb Accept Billing Number
erForDP attribute must be set as well
(not vice versa though, you
can set the Accept Billing
Number endpoint attribute
without setting the Use Billing
Number for Display Purposes
CFLoopExtende
d
Reserved5
SendPPreferredI If this endpoint attribute is Boolean True False
dentityHeader set then the preferred False
identity header is sent.
SendDomainNa If this endpoint attribute is Boolean True False
meInFromHead set the host part of the From False
er header of the initial INVITE to
an Italtel SIP trunk will
contain the OpenScape Voice
domain name instead of the
IP address.
SendForwarding If this endpoint attribute is Boolean True False
NumberInHeade set the forwarding number False
rs will be sent in headers.
DoNotSendDiver If this endpoint attribute is Boolean True False
sionHeader set then the diversion header False
will not be sent.
DoNotSendInvit If this endpoint attribute is Boolean True False
eWithoutSDP set then it will be not allowed False
to send an invite without SDP.
A31003-H80A0-T101-1-7618, 11/2021
Endpoint

EnhancedSubscr Enhanced Subscriber Boolean TrueFalse False
iberRerouting Rerouting shall be attempted
for calls to an endpoint that is
provisioned with the new
"Enhanced Subscriber
Rerouting" attribute if the last
route in the route set towards
the endpoint is CAC
restricted.This endpoint
attribute only applies to non-
subscriber endpoints.Note:
this flag is intended to be set
for Voice Mail Servers.
AddressOf The address used by SIP at 0..64 character string ““
Record registration of the endpoint.
ServerFailover Indicates whether network enum EpFailoverOff
server failover is enabled for EpFailoverOn
this endpoint.
KeysetUse Indicates whether this enum KeysetNone
subscriber is associated with KeysetPrimaryLine
a keyset device, either as a KeysetPhantomLine
primary or phantom line.
NumberAliases Number of aliases on list int
NodeName Symbolic identifier of str
endpoint that “owns” the alias
or suffix.
AliasName Name of an alias or alias str
suffix.
AliasType Enumerated value that int Fill with AtE164
represents the type of the
alias.
EndpointLocatio The name of the endpoint Character 1…20 N/A
nName location String
EndpointLocatio The code of the endpoint Character 1…8 N/A
nCode location String
EndpointNNITyp The Type of the NNIType enum NNITypeUnused, NNITypeOpenS
e NNITypeUnassigned, capeVoice
NNITypeOpenScapeVoiceNNITy
pe,
Hipath4000,
NNITypePSTNGateway,
NNITypeOther
EndpointProvide The name of the Endpoint Character 1…12 N/A
rName Provider. Note that in order to String
set the provider the NNIType
should be set to
PSTNGateway
A31003-H80A0-T101-1-7618, 11/2021
Endpoint

DnsSrv The type of the DnsSRV enum DnsSrvUnassigned DnsSrvDisable
DnsSrvDisabled d
DnsSrvEnabled
OutgoingCallSu For a dialog-initiating int System default
pervisionTimer outgoing INVITE, the if no value
maximum time for the supplied
transaction timer.
ProxyBypassSup If no timer is configured on int System default
ervisionTimer the SIP proxy, then the if no value
system-wide default for Proxy supplied
Bypass Supervision shall be
used.
8.3.3 Delete Endpoint

This method deletes an endpoint. Table 113 lists the return codes for
this method.

WSDL Version
Table 113 Delete Endpoint Return Codes

EndpointId Unique identifier associated int
with an endpoint in the
database. Only this specific
endpoint with this id will be
removed.
EndpointType Type of endpoint to be int EtUnassigned
removed. EtH323Gw
EtH323Mcu
EtSip
EtH323All
Number Number of endpoint names int
Endpoints on list to remove.
Id Unique numeric identifier of int
the endpoint. Refers to an
existing endpoint in the
database. The identifiers can
not be modified.
Table 114 Delete Endpoint Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Endpoint

Name CLI name of the endpoint that str
will be removed.
Table 114 Delete Endpoint Input Fields (Seite 2 von 2)
8.3.4 Query Endpoint

This method retrieves the endpoint and displays its parameters. Table
115 lists the return codes for this method.
WSDL Version Obsolete in WSDL Return Codes

Version
Table 115 Query Endpoint Return Codes

Value
Paging Standard Paging structure for Null
queries. For details, refer to
page 86.
EndpointId Numeric identifier associated int
with an endpoint in the
database. Used to retrieve
the specific endpoint. If
EndpointId or EndpointType is
unspecified, then all
endpoints are retrieved.
EndpointType The type of the endpoint to int EtUnassigned
retrieve. If EndpointId or EtH323Gw
EndpointType is unspecified, EtH323Mcu
then all endpoints are EtSip
retrieved. EtH323All
NumberOf Number of endpoints to be int
Endpoints retrieved.
item Endpoint itself.
Table 116 Query Endpoint Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Endpoint

Value
EndpointIsAssocia A filter item to return only boolean false false
tedServer those endpoints which have true
been defined as associated
servers. These endpoints are
excluded from trunking
session licensing.
If not passed (or false), all
endpoints are returned.
QueryEndpointTyp Modifies the search type enum QueryEPTypeDefault QueryEPType
e • QueryEPTypeAssociatedEnd QueryEPTypeAssociatedEndpoi Default
points - Query will return nts
the list of endpoints QueryEPTypeCandidateRepEnd
associated to the EpName points
provided.
• QueryEPTypeCandidateRepE
ndpoints - Used in
combination with the BgId
tag in order to retrieve the
list of endpoints that can
be used as Representative
in a new Branch Office.
BGId The Business Group Index of integer N/A
the BGName we wish to
retrieve the candidates for BO
Representation
SortType Provides a means of sorting enum EndpointStUnassigned EndpointStID
the results based on a EndpointStID
number of endpoint EndpointStEpType
characteristics EndpointStAccountAuth
EndpointStEpName
SortDirection Determines the way the SortOrderAscending - Objects are sorted in SortOrderAsc
objectsare sorted. ascending order. ending
SortOrderDescending - Objects are sorted
in descending order.
AccountAuthentic An enumeration of values enum AccountAuthUnused, AccountAuth
ation forendpoint account AccountAuthUnassigned, BasedOnEp
AccountAuthBasedOnEp,
AccountAuthNoServices
CSTADeviceId The NID in Device Number int NA NA
format/ Read Only
WSDL version V7.00.01.10
Table 116 Query Endpoint Input Fields (Seite 2 von 2)
See Table 110 (Create Endpoint) for the fields in the Query Endpoint
Output.
A31003-H80A0-T101-1-7618, 11/2021
Destination
8.4 Destination
An E164 (or generic destination) is an object in the E.164 domain that
conceptually represents the destination of some particular route. A
destination is linked to a number of route lists, each of which maintains
a list of routes representing possible routes from the softswitch to that
destination.
8.4.1 Create Destination

The CreateDestination command allows us to provision one Generic
Destination and optionally one associated RouteList with one or more
routes.
In order to provision a Generic Destination then we must not pass a

number of RouteList and number of routes. The GenericDestination
may uniquely be identified by the Destination id (unique numeric
identifier generated by the database) and the DestinationName. The
fields SignalingType and BearerCap have to take values <=
Unassigned.
From the CreateDestination menu we can optionally provision a

RouteList to a GenericDestination. The RouteList may uniquely be
identified by the E164Destination, the Bearer capability and the
signaling type. The Bearer Cap and SignalingType may only take values
greater than or equal to UNDEFINED.
WSDL Version Obsolete in WSDL Return Codes

Version
Table 117 Create Destination Return Codes
Field Name Description Length Range/Values Default Value

Id Numeric identifier of the Int
generic destination
DestinationNam Symbolic name of the str
e destination, of length less
than or equal to 15. The pair
{Name, NumberPlan) is
unique in the table of generic
destinations.
Table 118 Create Destination Input Fields (Seite 1 von 3)
A31003-H80A0-T101-1-7618, 11/2021
Destination

DestinationSign Indicates the type of enum SigIgnored SigUnused
aling destination signaling. SigUnused
Basically when creating a SigUnassigned
generic destination, the SigIsup
signaling type should be of SigPri,
value SigUnused. Moreover, SigMgcp,
the SignalingType does not SigH323,
characterize a generic SigSip,
destination. SigSipt,
SigCas,
SigSipQ
Bearer Assigned bearer capability of enum
the route.
Destination DaNotMSDest
Attributes DaDest
Attributes SigSip
SigSipt
NumberPlanId Numeric identifier of the int
numbering plan.
NumberPlan Name of the numbering plan. str
Name
NumberRoutes Number of generic routes int
UniqueId The unique database-created int
identifier associated with this
route in the database.
ReferenceId Numeric identifier of the int
referenced object.
Reference
Number
Reference Symbolic name of the str
Name referenced object.
Reference Type of the referenced object. enum RtGateway: The referenced
Type endpoint must have the type
H323GW
RtSipEndpoint: The
referenced endpoint must
have the type SIP
RtTrunk: The referenceId
refers to the uniqueIndex of
the trunk group.
RtGatekeeper
RtPri
RtMediaGw: if and only if the
destination has MSDEST
attributes set.
DigitsToDelete Number of digits to delete. int Takes values between 0 and 0
15.
A31003-H80A0-T101-1-7618, 11/2021
Destination

DigitsToInsert Optional digit string with 6 (0-9,*,#) EmptyStr
characters in the set (0-
9,*,#).
NatureOf Resulting nature of address enum UNDEFINED UNDEFINED
Address (enumerated value). INTL
NATL
SUBS
NO_DN
NW
8.4.2 Modify Destination

This method adds, deletes, and modifies a destination. Table 119 lists

WSDL Version
Table 119 Modify Destination Return Codes

Id Numeric identifier of the int
generic destination to modify.
Name Symbolic name of the str
destination, of length less
than or equal to 15. The pair
{Name, NumberPlan) is
destinations.
NewName New Symbolic name of the str
destination,
of length less than or equal to
15.
The pair {Name,
NumberPlan) is
destinations
Signaling enum
Table 120 Modify Destination Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Destination

Bearer Assigned bearer capability to enum CapSpeech
the route. CapAudio
CapData64KB
CapRateAdapted
Cap64KBPreffered
Attributes DaDest
Attributes This toggles the “Prioritized” enum AtrYes
value in a Destination’s Route AtrNo
list
numbering plan.
Name
Table 120 Modify Destination Input Fields (Seite 2 von 2)
8.4.3 Delete Destination

This method deletes the current destination. Table 121 lists the return
codes for this method.

WSDL Version
Table 121 Delete Destination Return Codes

generic destination to
remove.
Name Symbolic name of the 15
destinationThe pair {Name,
NumberPlan) is unique in the
table of generic destinations.
Signaling
Bearer Assigned bearer capability to enum CapSpeech
the route CapAudio
CapData64KB
CapRateAdapted
Cap64KBPreffered
Attributes DaDest
Table 122 Delete Destination Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Destination

Attributes
NumberPlanId Numeric identifier of the Int
numbering plan.
NumberPlan Name of the numbering plan. Str
Name
Table 122 Delete Destination Input Fields (Seite 2 von 2)
8.4.4 Display Destination

This method retrieves and displays a destination and its parameters.

WSDL Version
Table 123 Display Destination Return Codes

queries.
SortingType Defines whether sorting is StReference StDestnation
done by {numberPlanName, StDestnation
destId} or destId alone.
generic destination to query.
Name Symbolic name of the 15
destination. The pair {Name,
NumberPlan) is unique in the
table of generic destinations.
Signaling
Bearer Bearer capability assigned to enum CapSpeech
the route. CapAudio
CapData64KB
CapRateAdapted
Cap64KBPreffered
CapUnused
Attributes DaDest
Attributes
Table 124 Display Destination Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Rate Area

numbering plan.
Name
UniqueId
referenced object.
Reference
Number
ReferenceName Symbolic name of the str
referenced object.
ReferenceType Type of the referenced object. enum RtGateway: The referenced
endpoint must have the
type H323GW.
RtSipEndpoint: The
referenced endpoint must
have the type SIP.
RtTrunk: The referenceId
refers to the uniqueIndex of
the trunk group.
RtGatekeeper
RtPri
RtMediaGw: if and only if
the destination has MSDEST
attributes set.
DigitsToDelete Number of digits to delete int Takes values between 0 and
15.
DigitsToInsert Optional digit string with 6 (0-9,*,#)
characters in the set (0-
9,*,#).
NatureOfAddress Resulting nature of address enum NoaUndefined
(enumerated value). NoaIntl
NoaNatl
NoaSubs
NoaNoDn
NoaNw
Table 124 Display Destination Input Fields (Seite 2 von 2)
8.5 Rate Area
8.5.1 Create Rate Area

This method creates a rate area. Table 125 lists the return codes for
this method.
A31003-H80A0-T101-1-7618, 11/2021
Rate Area

WSDL Version
Table 125 Create Rate Area Return Codes

Id
GroupId Numeric identifier of the rate Integer Greater than or equal to (+1) Optional
area group (always equal to
Group plus two).
Group Numeric identifier of the rate Integer Greater than or equal to (-1) Optional
area group.
Name Name of the rate area object Character String
NpaNxx Leftmost digit sequence A digit sequence of length less
indicating the area code and than 16.
the exchange for the rate
area.
Lata Associated LATA digits. 0..8 Character String ““
LocalTollName String
Table 126 Create Rate Area Input Fields
8.5.2 Remove Rate Area

This method deletes the current rate area. Table 127 lists the return

WSDL Version
Table 127 Delete Rate Area Return Codes

Id
GroupId Numeric identifier of the rate integer Greater than or equal to (+1)
area group to remove.
Group Numeric identifier of the rate integer Greater than or equal to (-1)
area group to remove
Table 128 Delete Rate Area Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Rate Area

to remove.
NpaNxx Leftmost digit sequence A digit sequence of less than 16
indicating the area code and digits
area.
Table 128 Delete Rate Area Input Fields (Seite 2 von 2)
8.5.3 Query Rate Area

This method retrieves and displays a rate area. Table 129 lists the
return codes for this method.

WSDL Version
Table 129 Display Rate Area Return Codes

queries.
Id
GroupId Numeric identifier of the rate integer Greater than or equal to (+1)
area group to remove.
Group Numeric identifier of the rate integer Greater than or equal to (-1)
area group to remove
to remove.
NpaNxx Leftmost digit sequence A digit sequence of less than 16
indicating the area code and digits
area.
Table 130 Display Rate Area Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Class of Service
8.6 Class of Service
8.6.1 Create Class of Service

This method creates a class of service. Table 131 lists the return codes
for this method.

WSDL Version
Table 131 Create Class of Service Return Codes

Name Symbolic name of the class of str
service.
Id Numeric identifier of the class int
of service.
Number User-supplied identifier of the int Greater than or equal to (-1) Optional
class of service.
DefaultCpcCos
DefaultCpcCosN
ame
Table 132 Create Class of Service Input Fields
8.6.2 Delete Class of Service

This method deletes a class of service. Table 133 lists the return codes
for this method.

WSDL Version
Table 133 Delete Class of Service Return Codes

service.
Table 134 Delete Class of Service Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Class of Service

of service.
Number User-supplied identifier of the int Greater than or equal to (-1)
class of service.
DefaultCpcCos
DefaultCpcCosN
ame
Table 134 Delete Class of Service Input Fields (Seite 2 von 2)
8.6.3 Modify Class of Service

This method modifies a class of service. Table 135 lists the return codes
for this method.

WSDL Version
Table 135 Modify Class of Service Return Codes

service.
NewName New Symbolic name of the str
class of Service
of service.
class of service.
DefaultCpcCos
DefaultCpcCosN
ame
Table 136 Modify Class of Service Input Fields
8.6.4 Query Class of Service

This method retrieves and displays a class of service. Table 137 lists the
A31003-H80A0-T101-1-7618, 11/2021
Routing

WSDL Version
Table 137 Display Class of Service Return Codes

queries.
Name Symbolic name of the class of Str
service to query.
Id Numeric identifier of the class Int
of service to query.
class of service.
Table 138 Display Class of Service Input Fields
8.7 Routing
This API adds routes to an existing route list. Otherwise, this command
creates a new route list for an existing destination.
8.7.1 Create Routing

This method creates a route. Table 139 lists the return codes for this
method.

WSDL Version
Table 139 Create Routing Return Codes

Operator Id
Id
Name
Table 140 Create Routing Input Fields (Seite 1 von 3)
A31003-H80A0-T101-1-7618, 11/2021
Routing

Signaling Specifies the A-side signaling string SigIgnored
type. If signaling type is SigUnused
assigned, the A-side signaling SigUnassigned
protocol must match the SigIsup
signaling type in order to use SigPri,
the route list. If a signaling SigMgcp,
type is not assigned, the SigH323,
route list can be used SigSip,
regardless of the A-side SigSipt,
signaling protocol. SigCas,
Signaling type SIPQ indicates SigSipQ
that the incoming call is from
the SIPQ SM and will be
tandemed to a route with
org_signaling_type=SIPQ.
Bearer Bearer capability assigned to enum CapIgnored
the route. CapUnused
CapUnassigned
CapSpeech
CapAudio
CapData64KB
CapRateAdapted
Cap64KB
Cap64KBPreffered
Destination Specifies whether the DaNotMSDest
Attributes destination is a media server DaDest
destination.
Attributes
NumberPlanId Numeric Identifier of the int
numbering plan.
Name
NumRoutes
UniqueId
referenced object
Reference
Number
Reference Symbolic name of the route str
Name referenced object
Reference Specifies an integer variable enum GW
Type indicating the type of the GK
route reference object. SIPEP
DigitsToDelete Number of leading digits to be Int Takes values between 0 and 15. 0
deleted from the destination
DN.
A31003-H80A0-T101-1-7618, 11/2021
Routing

DigitsToInsert Optional digit string with 6
characters in the set
(0,9,*,#). It represents the
leading digits to add at the
beginning of the destination
DN.
NatureOf Specifies the nature of Enum NoaUndefined Undefined (For
Address address of the destination DN NoaIntl PBX)
after digit deletion and/or NoaNatl
insertion. NoaSubs
NoaNoDn
NoaNw
CacSignaling
DigitsSubscriber String
DigitsNational String
DigitsInternatio String
nal
LocalNumbersO Boolean
nly
isPrefixed Boolean
8.7.2 Prioritize Routing

This method prioritizes routing. Table 141 lists the return codes for this
method.

WSDL Version
Table 141 Prioritize Routing Return Codes

OperatorId Please refer to the definition
of Operator ID in Section
5.4.2, “Field Definitions”, on
page 79.
UniqueId
Name
Table 142 Prioritize Routing Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Routing

DestinationId Specifies a unique, non int
reusable index number
assigned when a destination
is created
Destination Specifies an alphanumeric 15 Maximum length is 15
Name string that uniquely identifies character
a Destination.
Signaling Specifies the A-Side Signaling enum SigIgnored
Type. If signaling type is SigUnused
protocol must match the SigSip
signaling type in order to use SigSipt
the route list. If signaling type
is not assigned, the route list
can be used irrespective of
the A-Side signaling protocol.
CapUnassigned
CapSpeech
CapAudio
CapData64KB
CapRateAdapted
Cap64KB
Cap64KBPreffered
RouteIndex Specifies a unique, non-
reusable index assigned when
a route is created.
referenced object
Reference
Number
NewRoute
Index
Table 142 Prioritize Routing Input Fields (Seite 2 von 2)
8.7.3 Modify Routing

This method modifies routing. Table 143 lists the return codes for this
method.
A31003-H80A0-T101-1-7618, 11/2021
Routing

WSDL Version
Table 143 Modify Routing Return Codes
Table 144lists the input fields for this method.

page 79.
UniqueId
Name
Type. If a signaling type is SigUnused
can be used regardless of the
A-Side signaling protocol.
CapUnassigned
CapSpeech
CapAudio
CapData64KB
CapRateAdapted
Cap64KB
Cap64KBPreffered
Destination Specifies whether or not the DaNotMSDest
destination.
Attributes
numbering plan.
Name
UniqueId
Id
Name
referenced object
Table 144 Modify Routing Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Routing

Reference
Number
DigitsToDelete Number of leading digits to be int Takes values between 0 and 15 0
DN.
DigitsToInsert Optional digit string that 6 (0,9,*,#)
represents the leading digits
to add at the beginning of the
destination DN.
insertion. NoaSubs
NoaNoDn
NoaNw
CacSignaling
nal
nly
isPrefixed Boolean
Table 144 Modify Routing Input Fields (Seite 2 von 2)
8.7.4 Query Routing

This method queries routing. Table 145 lists the return codes for this
method.

WSDL Version
Table 145 Query Routing Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Routing

page 79.
PageSize
PageNumber
SortType Defines whether the objects
are retrieved with a 2-index
or 4-index sort.
Id
Name
Signaling Specifies the A-side signaling string SigIgnored
type. If signaling type is SigUnused
protocol must match the SigIsup
signaling type in order to use SigPri,
the route list. If a signaling SigMgcp,
type is not assigned, the SigH323,
route list can be used SigSip,
regardless of the A-side SigSipt,
signaling protocol. SigCas,
Signaling type SIPQ indicates SigSipQ
that the incoming call is from
the SIPQ SM and will be
tandemed to a route with
org_signaling_type=SIPQ.
CapUnassigned
CapSpeech
CapAudio
CapData64KB
CapRateAdapted
Cap64KB
Cap64KBPreffered
destination.
Attributes
numbering plan.
Name
UniqueId
Id
Table 146 Query Routing Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Routing

Name
referenced object
Reference
Number
DigitsToDelete Number of leading digits to be int Takes values between 0 and 15 0
DN.
DigitsToInsert Optional digit string that 6 (0,9,*,#)
represents the leading digits
to add at the beginning of the
destination DN.
insertion. NoaSubs
NoaNoDn
NoaNw
CacSignaling
NumRoutes
nal
nly
isPrefixed Boolean
Table 146 Query Routing Input Fields (Seite 2 von 2)
8.7.5 Unassign Routing

This method unassigns a route. Table 147 lists the return codes for this
method.
A31003-H80A0-T101-1-7618, 11/2021
Routing

WSDL Version
Table 147 Unassign Routing Return Codes

page 79.
Id
Name
Type. If signaling type is SigUnused
can be used irrespective of
the A-Side signaling protocol.
CapUnassigned
CapSpeech
CapAudio
CapData64KB
CapRateAdapted
Cap64KB
Cap64KBPreffered
destination.
Attributes
numbering plan.
Name
Table 148 Unassign Routing Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Media Server

RouteId Specifies a user-assigned int 0-255
integer value that uniquely
identifies the route in the
route list that is associated
with the Destination ID/
Bearer Capabilities pair.
NOTE: To create a destination
without a route, the Route ID
must be 0.
NumRoutes
Table 148 Unassign Routing Input Fields (Seite 2 von 2)
8.8 Media Server

The OpenScape Voice system supports the RG 8700, the HiPath 4000
and Mediatrix media gateways. Note that these are all SIP endpoints
and are therefore not configured using the “Create Media Gateway”
SOAP commands. For the OpenScape Voice system, the only Media
Gateway that can be created using this command is a Media Server
(supported: OpenScape Media Server, Convedia Media Server).
8.8.1 Create Media Server

This method creates a media Server. Table 149 lists the return codes
for this method.

WSDL Version
Table 149 Create Media Server Return Codes

OperatorId Operator information used for str Please refer to the definition of
logging. Operator ID in Section 5.4.2,
“Field Definitions”, on page 79.
GatewayName Name of the media gateway str
to create
Table 150 Create Media Server Input Fields (Seite 1 von 3)
A31003-H80A0-T101-1-7618, 11/2021
Media Server

GatewayProtoco Type of protocol associated enum GptUnknown, GptMgcp
lType with gateway to be created. GptUndefined,
GptMgcp,
GptSip,
GptOther
GatewayProtoco Version of the protocol used enum GpVerUnused GpVerMgcp1Do
lVersion to communicate with GpVerMgcp0Dot0 t0NCS1Dot0
gateway. GpVerMgcp0Dot1
GpVerMgcp1Dot0NCS1Dot0
GpVerMgcp1Dot0
GpVerMgcp0Dot5
GpVerMgcp1Dot0Tgcp1Dot0
GpVerMegaco1Dot0
MgListenPort Media Gateway listen ports. int array
MgReceivePort Media Gateway receive ports. int array
MgCircuitFormat Circuit format supported by str $/$
the gateway.
NetworkTypes Information on the type of Boolean { Internet,Atm,Local } false
network on which the
gateway is located.
MgAddrCallp Ip Address of the Media str
gateway controller (OS Voice
ccm).
MgAddrProvisio Ip Address of the Media str
n Gateway.
Timeout Timeout interval for MGCP uint 500
requests sent to gateway.
RetryCount Number of times to retry the uint 7
mgcp requests.
IpAddrAllocMeth IpAddress allocation method enum IpAmUndefined IpAmDnsQuery
od (DNS/Static/Dynamic). IpAmDnsQuery
IpAmStatic
Fqdn Fully qualified domain name str
for the media gateway.
LocalClli Common language location str
identifier
GwAssignMetho Method for choosing the enum GwAmUndefined GwAmAutomati
d gateway. GwAmAutomatic c
GwAmNodePrimary
GwAmNodeSecondary
TimerHist Transaction History timer int 30
TimerMax Maximum retransmission int 20
timer
TransmissionTim int 5
erLen
A31003-H80A0-T101-1-7618, 11/2021
Media Server

FaxT38Relay Fax info for gateway enum T38FaxUnassigned T38FaxDisable
T38FaxEnabled d
T38FaxDisabled
DtmfRelay DTMF info for the gateway. DtmfUnassigned DtmfDisabled
DtmfEnabled
DtmfDisabled
DtmfRelay DTMF info for the gateway. enum DtmfUnassigned DtmfDisabled
DtmfEnabled
DtmfDisabled
MultiHomingFlag Indicates whether enum MultiHomingEnabled
MultiHoming is enabled or MultiHomingDisabled
not. MultiHomingUndefined
NOTE: Note that this flag can
never be reset by a Modify
Media gateway command (it
can be set from false to true
but not from true to false - in
order to do this, the media
gateway must be removed
and then created again).
OverloadSuppor Indicates whether overload enum YnYes YnNo
t support is enabled or not. YnNo
YnUndefined
OverloadAllowC Not applicable to OpenScape enum YnYes YnNo
aleaCalls Voice. YnNo
Indicates whether or not YnUndefined
CALEA calls are allowed while
in overload.
OverloadAllowT Indicates whether or not enum YnYes YnNo
wCalls three way calls are allowed YnNo
while in overload. YnUndefined
OverloadReturn Associated Return Code - integer 0..9999999999 (seconds) 409
CodeOne Level 1
CodeTwo Level 2
CodeThree Level 3
OverloadGapInt Gap Interval - Level 1 integer 0, 400..499 5
ervalOne
ervalTwo
ervalThree
Location Domain Location Domain name Char [1…64] NA
array
A31003-H80A0-T101-1-7618, 11/2021
Media Server
8.8.2 Modify Media Server

This method modifies a media Server. Table 151 lists the return codes
for this method.

WSDL Version
Table 151 Modify Media Server Return Codes

Value
OperatorId Operator information used str Please refer to the
for logging. definition of Operator ID in
Section 5.4.2, “Field
Definitions”, on page 79.
AdminStatus Gateway Blocked or made enum RsUnassigned RsBlocked
active with this field. RsAvailable
RsBlocked
GatewayName Name of the media str
gateway to modify
NewGatewayName New Name of the media str
gateway
GatewayProtocolType Type of protocol enum GptUnknown, GptMgcp
associated with gateway GptUndefined,
to be modified. GptMgcp,
GptSip,
GatewayProtocolVersion Version of the protocol enum GpVerUnused, Non
used to communicate with GpVerMgcp0Dot0, modifiable
gateway. GpVerMgcp0Dot1, attribute.
GpVerMgcp1Dot0NCS1Dot
0
GpVerMgcp1Dot0,
GpVerMgcp0Dot5,
GpVerMgcp1Dot0Tgcp1Do
t0,
MgListenPort Media Gateway listen int array
ports.
MgReceivePort Media Gateway receive int array
ports.
MgCircuitFormat Circuit format supported str
by the gateway.
NetworkTypes Information on the type of Boolean { Internet,Atm,Local } false
network on which the
gateway is located.
Table 152 Modify Media Server Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Media Server

Value
MgAddrProvision Ip Address of the Media str
Gateway.
Timeout Timeout interval for MGCP uint preserved
requests sent to gateway.
RetryCount Number of times to retry uint preserved
the mgcp requests.
IpAddrAllocMethod IpAddress allocation enum IpAmUndefined preserved
menthod(DNS/Static/ IpAmDnsQuery
Dynamic). IpAmStatic
Fqdn Fully qualified domain str
name for the media
gateway.
LocalClli Common language str
location identifier
GwAssignMethod Method for choosing the enum GwAmUndefined preserved
gateway. GwAmAutomatic
GwAmNodePrimary
GwAmNodeSecondary
TimerHist Transaction History timer int 30
TimerMax Maximum retransmission int preserved
timer
TransmissionTimerLen int preserved
FaxT38Relay Fax info for gateway enum T38FaxUnassigned preserved
T38FaxEnabled
T38FaxDisabled
DtmfRelay DTMF info for the gateway. DtmfUnassigned preserved
DtmfEnabled
DtmfDisabled
Location Domain Location Domain name Char array [1…64] NA
Table 152 Modify Media Server Input Fields (Seite 2 von 2)
8.8.3 Remove Media Server

This method deletes the current media Server. Table 153 lists the

WSDL Version
Table 153 Remove Media Server Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Media Server

Value
gateway to remove
Table 154 Remove Media Server Input Fields
8.8.4 Block / Unblock Media Server

This method blocks or unblocks a media server.

WSDL Version
Table 155 Block / Unblock Media Server Return Codes

Value
gateway to remove
AdminStatus Admin status of gateway enum RsUnassigned, RsAvailable
RsAvailable,
RsBlocked,
Table 156 Block / Unblock Media Server Input Fields
8.8.5 Query Media Server

This method retrieves and displays a media server and its attributes.
A31003-H80A0-T101-1-7618, 11/2021
Media Server

WSDL Version
Table 157 Query Media Server Return Codes

Value
Specific Indicates type of query. Boolean
e.g. specific gateway or all
gateways,
Paging Standard paging structure
gateway to remove
Table 158 Query Media Server Input Fields
The response to the Query Media Gateway request contains the

attributes listed for the Create Media Gateway request, and in addition,
the read-only attributes listed in Table 159:

Value
MaxNumOfConfPortsPer Maximum number of integer 3000
Conf conference ports per
conference.
MaxNumOfConfPortsPer Maximum number of integer 16
ConfForSCC conference ports per
conference for Station
Controlled Conference.
SystemConfPorts Number of system integer 0
conference ports existing.
AvailableConfPorts Calculated number of integer 0
available conference ports.
Table 159 Query Media Gateway Attributes (Read Only)
A31003-H80A0-T101-1-7618, 11/2021
Media Server Circuits
8.9 Media Server Circuits
8.9.1 Create Media Server Circuits

This method creates media gateway circuits. Table 160 lists the return

WSDL Version
Table 160 Create Media Server Circuits Return Codes

Value
gateway circuit to create.
CircuitType Name of the media enum CircuitUnused CircuitDoesNo
gateway to remove CircuitDoesNotExist tExist
CircuitNone
CircuitTrunk
CircuitPri
CircuitLine
CircuitMedia
CircuitMsAnn
CircuitMsSurv
CircuitMsConf
CircuitMsConfAdhoc
CircuitMsAudit
StartCircuitId Name of the media str
gateway to remove
EndCircuitId Name of the media str
gateway to remove
Table 161 Create Media Server Circuits Input Fields
A31003-H80A0-T101-1-7618, 11/2021
8.9.2 Remove Media Server Circuits

This method creates media server circuits. Table 162 lists the return

WSDL Version
Table 162 Remove Media Server Circuits Return Codes

Value
gateway circuit to create
TrunkGroupInfo Name of the media enum TrunkGroupNoForMsUndef TrunkGroupNo
gateway to remove ined ForMsAny
TrunkGroupNoForMsAny
TrunkGroupNoForMsAnn
TrunkGroupNoForMsSurv
TrunkGroupNoForMsConf
TrunkGroupNoForMsConfA
dhoc
TrunkGroupNoForMsAudit
StartCircuitId Name of the media str
gateway to remove
EndCircuitId Name of the media str
gateway to remove
Table 163 Remove Media Server Circuits Input Fields
8.9.3 Query Media Server Circuits

This method retrieves and displays media server circuits. Table 164
lists the return codes for this method.

WSDL Version
Table 164 Query Media Server Circuits Return Codes
A31003-H80A0-T101-1-7618, 11/2021

Value
Specific Indicates type of query. Refer to the paragraph at the beginning of Chapter 8.
e.g. specific gateway
circuits or all gateway
circuits
gateway whose circuits
are to be displayed.
StartCircuitId Circuit id to query str
Table 165 Query Media Server Circuits Input Fields

Value
PaginatedInfo Standard paging
structure. For details, refer
to Section 5.5, “Paging”,
on page 86.
MediaGatewayCircuitRes An array of MediaGatewayCircuit entry items, each of which contains the following
ultData fields:
gateway to which the
displayed circuit belongs
CircuitType The type of the circuit enum CircuitUnused N/A
being displayed. CircuitDoesNotExist
CircuitNone
CircuitTrunk
CircuitPri
CircuitLine
CircuitMedia
CircuitMsAnn
CircuitMsSurv
CircuitMsConf
CircuitMsConfAdhoc
CircuitMsAudit
Table 166 Query Media Server Circuits Output Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
CAC Group

Value
GatewayType The type of the gateway to enum GwTypeUnkown N/A
which the circuit belongs. GwTypeSmx2100
GwTypeMgOther
GwTypeHig1100
GwTypeHig1400
GwTypeATA
GwTypeUndefined
StartCircuitId The ID of the circuit being str
displayed
EndCircuitId The ID of the circuit being str
displayed
Table 166 Query Media Server Circuits Output Fields (Seite 2 von 2)
8.10 CAC Group
8.10.1 Create CAC Group

This method creates a Call Admission Control (CAC) Group. Table 167

WSDL Version
N/A subRC_SUCCESS
subRC_APP_CAC_INVALID_BG_NAME
subRC_APP_CAC_INVALID_BO_NAME
Table 167 Create CAC Group Return Codes

Value
command. Operator ID in Section 5.4.2, “Field
CACGroupName The name of the CAC 1..31 Character String required
Group to be created.
CACGroupType Indicates what this CAC enum SubNetType, required
Group is based on. DNAddrType,
IpAddrType
ParentCACGroups
Table 168 Create CAC Group Input Fields (Seite 1 von 4)
A31003-H80A0-T101-1-7618, 11/2021
CAC Group

Value
AddressArray One or more address For (empty array)
strings. The valid values CACGroupType=SubNetTy
for these strings are based pe values like:
on CACGroupType 172.1.10.0/24
For
CACGroupType=IpAddrTy
pe, values like:
10.151.1.10
For
CACGroupType=DNAddrTy
pe, values like:
15615550110 (a specific
directory number)
or
1561556* (a directory
number prefix)
For ParentCACgroup=Add
CAC group NAME
DynamicCACRouterAddr An IP address string 1..30 Character string ““
ess.RouterIpAddress representing the single
data center router
associated with the CAC
group serving the WAN in
a collocated nodes
scenario or the first router
a geo-separated nodes
scenario.
Presence of the router IP
address combined with
CACAccessLinkType of the
first access link of
CACAccessLinkTypeWAN
(see below) indicates that
the policies associated
with this CAC group can be
configured with the
backup bandwidth values.
Note that the
RouterIPAddress must be
unique and must uniquely
identify only one CAC
group. If the IP address is
already used by a different
CAC group, an error is
returned.
A31003-H80A0-T101-1-7618, 11/2021
CAC Group

Value
DynamicCACRouterAddr Identifies the interface or 1..255 Character string ““
ess.InterfaceName GRE/IPSec tunnel within
the router. The string is of
the form “eth0”, “eth1”,
etc., if it characterizes an
interface name.
Note, this parameter is
required if the
RouterIpAddress is
provided. Both can also be
omitted.
CACAccessLinkType The first access link type enum Please refer to the
ofthe CAC group definition of
CACGroupName in
Section 8.10.1, “Create
CAC Group”.
DynamicCACRouterAddr The first access link type of enum CACAccessLinkTypeWAN, CACAccessLin
ess. CACAccessLinkType the CAC group. Possible CACAccessLinkTypeDataC kTypeWAN
values are: enter,
• CACAccessLinkTypeWAN CACAccessLinkTypeDataC
- Indicates either a enter1,
collocated nodes CACAccessLinkTypeDataC
scenario or a geo- enter2
separated nodes
scenario and a second
access link is not valid.
• CACAccessLinkTypeData
Center - Indicates a
collocated nodes
Center1 - Indicates a
geo-separated nodes
access link must be
defined.
Type CACAccessLinkType-
DataCenter2 is invalid for
the first access link.
GeoSeparatedDynamicC An IP address string 1..30 Character string ““
ACRouterAddress.Router representing the second
IPAddress data center router
the case of geo-separated
nodes scenario.
A31003-H80A0-T101-1-7618, 11/2021
CAC Group

Value
GeoSeparatedDynamicC A string that identifies the 1..255 Character string ““
ACRouterAddress.Interfa tunnel name that links the
ceName second data center router
with the branch office.
GeoSeparatedDynamicC The second access link enum CACAccessLinkTypeWAN, CACAccessLin
ACRouterAddress.CACAc type of the CAC group. CACAccessLinkTypeDataC kTypeWAN
cessLinkType The only possible value is: enter,
• CACAccessLinkTypeData CACAccessLinkTypeDataC
Center2 - Indicates a enter1,
geo-separated nodes CACAccessLinkTypeDataC
scenario and a first enter2
access link must have
been defined.
All remaining types are
invalid for the second
access link.
BGName Business Group Name to Char 0…30 optional
be associated with CAC
Group
BOName Branch Office Name to be char 0…30 Optional
associated with CAC Group
8.10.2 Delete CAC Group

This method deletes a Call Admission Control (CAC) Group. Table 169

WSDL Version
TBD N/A subRC_SUCCESS
Table 169 Delete CAC Group Return Codes

Value
CACGroupName The name of the CAC Please refer to the definition of required
Group to be deleted. CACGroupName in Section 8.10.1,
“Create CAC Group”.
Table 170 Delete CAC Group Input Fields
A31003-H80A0-T101-1-7618, 11/2021
CAC Group
8.10.3 Modify CAC Group

This method modifies a Call Admission Control (CAC) Group. Currently
only the CACGroupName attribute may be modified. Table 171 lists the

WSDL Version
N/A subRC_SUCCESS
Table 171 Modify CAC Group Return Codes

Value
BusinessGroupName The name of the Business 0..30 Character String “”
Group associated with the
Call Admission Control
(CAC) Group
BranchOfficeName The name of the Branch Character String “”
Office associated with the
(CAC) Group
Group to be modified. CACGroupName in Section 8.10.1,
newCACGroupName The new name for the CAC Please refer to the definition of N/A
Table 172 Modify CAC Group Input Fields
A31003-H80A0-T101-1-7618, 11/2021
CAC Group

Value
DynamicCACRouterAddr An IP Address string Please refer to the definition of N/A
ess. representing the single RouterIpAddress in Section 8.10.1,
RouterIpAddress Data Center router “Create CAC Group”.
a collocated nodes
scenario or the first router
a geo-separated nodes
scenario.
Presence of the Router IP
address combined with
CACAccessLinkType of the
first access link of
CACAccessLinkTypeWAN
(see below) indicates that
the policies associated
with this CAC group can be
configured with the
backup bandwidth values.
Note that the
RouterIPAddress must be
unique and must uniquely
identify only one CAC
group. If the IP address is
already used by a different
CAC group, an error is
returned.
DynamicCACRouterAddr This identifies the Please refer to the definition of N/A
ess. interface or GRE/IPSec InterfaceName in Section 8.10.1,
InterfaceName tunnel within the router. “Create CAC Group”.
The string is of the form
“eth0”, “eth1”, etc., if it
characterizes an interface
name.
A31003-H80A0-T101-1-7618, 11/2021
CAC Group

Value
DynamicCACRouterAddr The first access link type of Please refer to the definition of N/A
ess. CACAccessLinkType the CAC group. Possible CACAccessLinkType in Section 8.10.1,
values are: “Create CAC Group”.
• CACAccessLinkTypeWAN
- Indicates either a
collocated nodes
scenario or a geo-
separated nodes
Center - Indicates a
collocated nodes
geo-separated nodes
access link must be
defined.
Type CACAccessLinkType-
DataCenter2 is invalid for
the first access link.
GeoSeparatedDynamicC An IP address string Please refer to the definition of N/A
ACRouterAddress.Router representing the second RouterIpAddress in Section 8.10.1,
IPAddress data center router “Create CAC Group”.
the case of geo-separated
nodes scenario.
GeoSeparatedDynamicC A string that identifies the Please refer to the definition of N/A
ACRouterAddress.Interfa tunnel name that links the InterfaceName in Section 8.10.1,
ceName second data center router “Create CAC Group”.
with the branch office.
GeoSeparatedDynamicC The second access link Please refer to the definition of N/A
ACRouterAddress.CACAc type of the CAC group. CACAccessLinkType in Section 8.10.1,
cessLinkType The only possible value is: “Create CAC Group”.
geo-separated nodes
scenario and a first
access link must have
been defined.
All remaining types are
invalid for the second
access link.
Group
A31003-H80A0-T101-1-7618, 11/2021
CAC Group

Value
8.10.4 Query CAC Group

This function is used to query Call Admission Control (CAC) Group
information. Returned information is for either a single CAC Group or a
set of CAC Groups depending on the input filter parameters.
Note: If no filters are specified, all CAC Group information is returned.

WSDL Version
N/A subRC_SUCCESS
Table 173 Query CAC Group Return Codes

Value
BusinessGroupName The name of the Business 0..30 Character String “”
Group associated with the
(CAC) Group to be
queried. This is an
optional filter for the
query. If a
BusinessGroupName is
specified,
information is returned for
only
that particular business
group.
Table 174 Query CAC Group Input Fields (Seite 1 von 3)
A31003-H80A0-T101-1-7618, 11/2021
CAC Group

Value
BranchOfficeName The name of the Branch 0..30 Character String “”
Office associated with the
(CAC) Group to be
queried. This is an
optional filter for the
query. If a
BranchOfficeName is
specified,
information is returned for
only
that particular branch
office.
InterfaceWSDL Refer to Section 5.1.1,
“The Interface WSDL and
Interface Release Control”,
on page 73.
Paging Paging structure for Get
List requests. For more
information, refer to
page 86.
CACGroupName The name of the CAC Please refer to CACGroupName in N/A
Group to be queried. This Section 8.10.1, “Create CAC Group”
is an optional filter for the for these values.
query. If a
CACGroupName is
specified, information is
returned for only that
particular CAC Group.
CAC Group Name filter
also supports wildcards:
• * for 0 or more
matches, and,
• ? exact one match.
In this case, one or more
CAC Groups could be
returned. This input is
logical ANDed with all the
other filter inputs (if any).
A CACGroupName with
wildcards cannot co-exist
in the same filter with a
CACGroupMember filter
(see below description of
CACGroup Member).
A31003-H80A0-T101-1-7618, 11/2021
CAC Group

Value
CACGroupType Indicates the CAC Group enum SubNetType, N/A
Type to be queried. This is DNAddrType,
an optional filter for the IpAddrType
query. If a CAC Group Type
is specified, information is
returned only for CAC
Groups of the specified
type.
RouterIpAddress An IP Address string 1..30 Character string ““
representing the router
Group serving the WAN.
Providing this parameter
allows for the query of a
CAC Group based on a
known Router IP Address.
CACGroupMember The name of a CAC Group 1...31 Character String N/A
Member. With this filter,
the info of the CAC Group,
that this member is
belonging to, can be
retrieved. A specific
member can only belong
to one CAC Group.
Group
A31003-H80A0-T101-1-7618, 11/2021
CAC Group

Value
An array of CACGroupInfo elements, each consisting of the following attributes:
BusinessGroupName The name of the Business Please refer to the definition of N/A
Group associated with the BusinessGroupName in Section
Call Admission Control 8.10.1, “Create
(CAC) Group CAC Group”.
BranchOfficeName The name of the Branch Please refer to the definition of N/A
Office associated with the BusinessGroupName in Section
Call Admission Control 8.10.1, “Create
(CAC) Group CAC Group”
CACGroupName The name of the CAC Please refer to the definition of N/A
Group. CACGroupName in Section 8.10.1,
CACGroupType Indicates the CAC Group Enum CACGroupSubNetType, N/A
Type to be queried. This is CACGroupDNAddrType,
an CACGroupIpAddrType
optional filter for the CACGroupParentCACGrou
query. If a ps
CAC Group Type is CACGroupLocationDomain
specified, Type ( V5.00.18.01 )
information is returned
only for CAC Groups of the
specified
type..
AddressArray One or more address Please refer to the definition of N/A
strings. The valid values AddressArray in Section 8.10.1,
for these strings are based “Create CAC Group”.
on CACGroupType
DynamicCACRouterInfoD An IP Address string Please refer to the definition of N/A
ata.DynamicCACRouterA representing the router RouterIpAddress in Section 8.10.1,
ddress.RouterIpAddress associated with the CAC “Create CAC Group”.
DynamicCACRouterInfoD This identifies the Please refer to the definition of N/A
ata.DynamicCACRouterA interface within the router. InterfaceName in Section 8.10.1,
ddress.InterfaceName The string is of the form “Create CAC Group”.
“eth0”, “eth1” etc.
Table 175 Query CAC Group Output Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
CAC Group

Value
DynamicCACRouterInfoD The time when the status time N/A
ata.CACLinkStatusTimeS for the link was changed to stamp
tamp “LinkDown”. If the
CACGroup has been
created and no status
notification update is
provided, then this time
will default to an empty
string. When the link
status is changed to
“LinkUp”, this field will be
cleared.
DynamicCACRouterInfoD Indicates the status of the enum LinkUp N/A
ata.CACPrimaryLinkStat link. LinkDown
us
parentCACGroupName The name of the parent 1...31 N/A
CAC Group Name
Table 175 Query CAC Group Output Fields (Seite 2 von 2)
8.10.5 Add CAC Group Address

This method adds an address to a Call Admission Control (CAC) Group.

WSDL Version
Table 176 Add CAC Group Address Return Codes

Value
Table 177 Add CAC Group Address Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
CAC Group

Value
AddressArray One or more new address Please refer to the definition of N/A
strings to be added to the AddressArray in Table 166 on page 205
CAC Group. above.
Note that the addresses
specified in the
AddressArray should
conform to the existing
CACGroupType of the CAC
Group to be modified. For
example, to add new
addresses to a CAC Group
with
CACGroupType=IpAddrTy
pe, all the new addresses
specified in AddressArray
must be valid IP
addresses.
Table 177 Add CAC Group Address Input Fields (Seite 2 von 2)
8.10.6 Remove CAC Group Addr

This method removes an address from a Call Admission Control (CAC)
Group. Table 178 lists the return codes for this method.

WSDL Version
Table 178 Remove CAC Group Addr Return Codes

Value
AddressArray One or more new address Please refer to the definition of N/A
strings to be removed AddressArray in Table 166 on page 205
from the CAC Group. above.
Table 179 Remove CAC Group Addr Input Fields
A31003-H80A0-T101-1-7618, 11/2021
CAC Group
8.10.7 Get Ancestor Tree For CAC Group

For a given CAC Group, this function returns a list of ancestors (parent,
grandparent, etc.).

WSDL Version
subRC_APP_CAC_INVALID_CAC_GROUP_NAME
subRC_APP_CAC_GROUP_QUERY_GET_ANCESTOR_NDM_ERROR
subRC_APP_CAC_NON_EXISTENT_CAC_GROUP
subRC_INT_CAC_GROUP_DB_INCONSISTENCY
subRC_SYS_CAC_ALLOC_ERR
Table 180 Get Ancestor Tree for CAC Group Return Codes
Table 181 lists the input fields for this method. The output of this SOAP
request is an array of strings, each representing the name of a CAC
Group.

Value
OperatorId The operator issuing the Please refer to the
command. definition of Operator ID in
on page 73.
CACGroupName The name of the CAC Please refer to the N/A
Group to be queried. This definition of
is an optional filter for the CACGroupName in Section
query. If a 8.10.1, “Create CAC
CACGroupName is Group”.
Table 181 Get Ancestor Tree for CAC Group Input Fields
A31003-H80A0-T101-1-7618, 11/2021
CAC Policy
8.11 CAC Policy
8.11.1 Create CAC Policy

This method creates a Call Admission Control (CAC) Policy. Table 182

WSDL Version
V4.00.01.04 31700050 subRC_APP_CAC_POLICY_CREATE_ATTRIBUTES_ERRO

R
Error while creating attributes for a CAC policy.
Table 182 Create CAC Policy Return Codes

Value
OperatorId The operator issuing the Please refer to the definition of Operator ID
command. in Section 5.4.2, “Field Definitions”, on
page 79.
Group for which this policy CACGroupName in Section 8.10.1, “Create
is to be created. CAC Group”.
CACPolicyType Indicates the CAC policy integer 0x0004 (VideoPolicyType) required
type. Policy type is a 0x0005 (Voice &
bitmap, where its bits VideoPolicyType)
represent the FaxPolicy, 0x0006 (FaxPolicyType)
VoicePolicy, and 0x0007 (all three of the above)
VideoPolicy.
CACPolicyLimitType Indicates the type of limit enum CACBandwidthLimitType required
specified by the CAC CACNumCallsLimitType
policy. CACNumCallsAndBWLimitType
CallLimit If the CAC policy is to integer 0..2147483647 -1
impose a limit on the Note this parameter is
number of calls, this required if CACPolicyLimitType
parameter should be is CACNumCallsLimitType or
specified. CACNumCallsAndBWLimitType
BandWidthLimit If the CAC policy is to integer 0..2147483647 -1
impose a limit on the Note this parameter is
bandwidth, this parameter required if CACPolicyLimitType
should be specified. is CACBandwidthLimitType or
CACNumCallsAndBWLimitType
Table 183 Create CAC Policy Input Fields (Seite 1 von 5)
A31003-H80A0-T101-1-7618, 11/2021
CAC Policy

Value
CACPolicyOptionFlag CACMediaServerAllow enum Change value: CACNoOp
change to CACMediaServerAllow tion
CACMediaServerIgnore to
CACMediaServerIgnore
This field is deprecated
from WSDL version
V4.00.01.04 and above.
The field
CACPolicyAttributes
(please see below) should
be used instead.
CACPolicyAttributes This field replaces the array of CACPolicyIgnoreMediaServer all false
CACPolicyOptionFlag field. Boolean CACPolicyAllowAnsweredCalls
It is used to provision the flags CACPolicyAllowVideoCallsAsAu
available options to a dioOnly
policy. The existing
options:
1) Ignore calls to media

server for announcements
and tones
2) Allow answered calls
when there is not enough
bandwidth
3) Allow video call to
proceed as an audio only
call when not enough
bandwidth
DynamicCACPolicyInfo. Specifies the secondary integer -1
SecondaryCallLimit Call Limit capacity. This
parameter has the same
validations as the CallLimit
parameter with respect to
the CACPolicyLimitType.
It can be entered only if
the CACGroup has a
RouterIPAddress
configured.
This parameter is
mandatory if the
RouterIPAddress in the
CACGroup has been
configured and the
CACPolicyType is
“CallLimit” or “Both”.
A31003-H80A0-T101-1-7618, 11/2021
CAC Policy

Value
DynamicCACPolicyInfo. Specifies the secondary integer -1
SecondaryBandWidthLim Bandwidth Limit capacity.
it This parameter has the
same validations as the
BandWidthLimit
the CACGroup has a
RouterIPAddress
configured.
This parameter is
mandatory if the
RouterIPAddress in the
CACGroup has been
configured and the
CACPolicyType is
“BandwidthLimit” or
“Both”.
CACPolicyCodecsAllowed A list of CODEC flags, each array of CACPolicyAllCodec CACPolicy
one set to true or false to Boolean CACPolicyCodecG711ALaw AllCodec
indicate whether or not flags CACPolicyCodecG711ULaw = true
the CODEC is allowed for CACPolicyCodecG722
this CAC policy. CACPolicyCodecG7231
CACPolicyCodecG726_16
This information is used to CACPolicyCodecG726_24
limit the CODECs allowed CACPolicyCodecG726_32
for voice calls over the CACPolicyCodecG726_40
bandwidth-limited link to CACPolicyCodecG728
optimize the usage of the CACPolicyCodecG729
bandwidth and allow more CACPolicyCodecILBC
simultaneous connections CACPolicyCodecAMR
while still guaranteeing an CACPolicyCodecAMR_WB
acceptable quality of CACPolicyCodecAAC_LC
service. CACPolicyCodecG7221_24
IgnoreMediaServer This value is for ignoring Boolean True/False
the Media Server.
AllowAnsweredCalls This value is for allowing Boolean True/False
answered calls.
AllowVideoCallsAsAudio This value is for allowing Boolean True/False
Only Video Calls As Audio Only.
A31003-H80A0-T101-1-7618, 11/2021
CAC Policy

Value
GenerateAlarm Enable or disable Boolean True/False False
generation of alarms when
the CACPolicyLimitType
exceeds its thresholds.
Limit type policies are:

1). bandwidth limit and/or
2). number of calls
Optional.
AlarmLowThreshold Sets the low percentage Integer 0-90 60*
threshold for the selected
policy type. When
exceeded an alarm will be
generated if
GenerateAlarm is set to
true.
Optional.
AlarmHighThreshold Sets the high percentage Integer 10-100 80*
policy type. When
generated if
true.
Optional.
MaxVideoCodecBandWid Set the max video integer
th bandwidth
CACPolicyVideoCodecsAll A list of VIDEO CODEC array CACPolicyAllCodec; N/A
owed flags, eachone set to true ofBooleanf CACPolicyCodecH263;
or false toindicate whether lags CACPolicyCodecH264;
or not the VIDEO CODEC is CACPolicyCodecVP8
allowed for thisCAC
policy.This information is
used tolimit the VIDEO
CODECs allowed forcalls
over thebandwidth-limited
link tooptimize the usage
of thebandwidth and allow
moresimultaneous
connectionswhile still
guaranteeing
anacceptable quality of
service.
A31003-H80A0-T101-1-7618, 11/2021
CAC Policy

Value
MaximumProfileLevel A maximum allowed enum Level_Unknown=-1,Level_1, Level_2_
profile level for H.264 shall Level_1_b, Level_1_1, 1
be considered and this will Level_1_2, Level_1_3,
be effective regardless of Level_2, Level_2_1,
any codes restriction Level_2_2,
configuration.It is a series Level_3, Level_3_1,
of combination of bitrates Level_3_2,
for H264 Level_4, Level_4_1,
Level_4_2,
Level_5, Level_5_1
* In reality SOAP displays “0” for the defaults when they are in use. These defaults are 60/80.
8.11.2 Delete CAC Policy

This method deletes a Call Admission Control (CAC) Policy. Table 184

WSDL Version
Table 184 Delete CAC Policy Return Codes

Value
Group from which this CACGroupName in Section 8.10.1,
policy to be deleted. “Create CAC Group”.
VoicePolicy, and 0x0007 (all three of the
VideoPolicy. above)
Table 185 Delete CAC Policy Input Fields
A31003-H80A0-T101-1-7618, 11/2021
CAC Policy
8.11.3 Modify CAC Policy

This method modifies a Call Admission Control (CAC) Policy. Table 186

WSDL Version
V4.00.01.04 31700051 subRC_APP_CAC_POLICY_MODIFY_ATTRIBUTES_ERRO

R
Error while modifying attributes for a CAC policy.
Table 186 Modify CAC Policy Return Codes

Value
Group whose policy is to CACGroupName in Section 8.10.1,
be modified. “Create CAC Group”.
VideoPolicy. above)
CACPolicyLimitType Indicates the type of limit enum CACBandwidthLimitType N/A
specified by the CACPolicy. CACNumCallsLimitType
CACNumCallsAndBWLimit
Type
CallLimit If the CAC policy is to integer 0..2147483647 N/A
impose a limit on the
number of calls, this
parameter should be
specified.
BandWidthLimit If the CAC policy is to integer 0..2147483647 N/A
bandwidth, this parameter
should be specified.
Table 187 Modify CAC Policy Input Fields (Seite 1 von 4)
A31003-H80A0-T101-1-7618, 11/2021
CAC Policy

Value
CACPolicyOptionFlag CACMediaServerAllow enum Change value: CACNoOption
change to CACMediaServerAllow

from WSDL version
The field
CACPolicyAttributes
be used instead.
CACPolicyAttributes This field replaces the array of CACPolicyIgnoreMediaSer all false
CACPolicyOptionFlag field. Boolean ver
It is used to provision the flags CACPolicyAllowAnsweredC
available options to a alls
policy. The existing CACPolicyAllowVideoCalls
options: AsAudioOnly

and tones
bandwidth
bandwidth
DynamicCACPolicyInfo. Specifies the secondary integer N/A
SecondaryCallLimit Call Limit capacity. This
parameter has the same
validations as the CallLimit
the CACGroup has a
RouterIPAddress
configured.
DynamicCACPolicyInfo. Specifies the secondary integer N/A
SecondaryBandWidthLim Bandwidth Limit capacity.
it This parameter has the
same validations as the
BandWidthLimit
the CACGroup has a
RouterIPAddress
configured.
A31003-H80A0-T101-1-7618, 11/2021
CAC Policy

Value
IgnoreMediaServer Boolean True/False
AllowAnsweredCalls Boolean True/False
AllowVideoCallsAsAudio Boolean True/False
Only
GenerateAlarm Enable or disable Boolean True/False False
generation of alarms when
the CACPolicyLimitType
exceeds its thresholds.
Limit type policies are:

1). bandwidth limit and/or
2). number of calls
Optional.
AlarmLowThreshold Sets the low percentage Integer 0-90 60*
policy type. When
generated if
true.
Optional.
AlarmHighThreshold Sets the high percentage Integer 10-100 80*
policy type. When
generated if
true.
Optional.
MaxVideoCodecBandWid Set the max video integer
th bandwidth
or false to indicate lags CACPolicyCodecH264;
whether or not theVIDEO CACPolicyCodecVP8;
CODEC is allowed for
thisCAC policy.This
information is used tolimit
the VIDEO CODECs
allowed forcalls over
thebandwidth-limited link
tooptimize the usage of
thebandwidth and allow
moresimultaneous
guaranteeing
service.
A31003-H80A0-T101-1-7618, 11/2021
CAC Policy

Value
MaximumProfileLevel A maximum allowed enum Level_Unknown=- Level_2_1
profile level for H.264 shall 1,Level_1, Level_1_b,
be considered and this will Level_1_1,
be effective regardless of Level_1_2, Level_1_3,
any codes restriction Level_2, Level_2_1,
configuration.It is a series Level_2_2,
of combination of bitrates Level_3, Level_3_1,
for H264 Level_3_2,
Level_4, Level_4_1,
Level_4_2,
Level_5, Level_5_1
CACPolicyCodecsAllowed A list of CODEC flags, array CACPolicyAllCodec CACPolicyAllC
eachone set to true or ofBooleanf CACPolicyCodecG711ALaw odec =true
false toindicate whether or lags CACPolicyCodecG711ULa
not theCODEC is allowed w
for thisCAC policy.This CACPolicyCodecG722
information is used tolimit CACPolicyCodecG7231
the CODECs allowed CACPolicyCodecG726_16
forvoice calls over CACPolicyCodecG726_24
thebandwidth-limited link CACPolicyCodecG726_32
tooptimize the usage of CACPolicyCodecG726_40
thebandwidth and allow CACPolicyCodecG728
moresimultaneous CACPolicyCodecG729
connectionswhile still CACPolicyCodecILBC
guaranteeing CACPolicyCodecAMR
anacceptable quality of CACPolicyCodecAMR_WB
service. CACPolicyCodecAAC_LC
* In reality SOAP displays “0” for the defaults when they are in use. These defaults are 60/80.
Note: The absolute difference between low and high threshold must be
equal to or greater than 10%.
8.11.4 Query CAC Policy

This function is used to query Call Admission Control (CAC) Policy
information. Returned information is for either a single CAC Policy or a
set of CAC Policies depending on the input filter parameters.
Note that if neither CACGroupName nor CACPolicyType is specified, all

CAC Policy information is returned. Table 188 lists the return codes for
this method.
A31003-H80A0-T101-1-7618, 11/2021
CAC Policy

WSDL Version
Table 188 Query CAC Policy Return Codes

Value
on page 73.
page 86.
CACGroupName The name of the CAC Please refer to the definition of
Group to be queried. This CACGroupName in Section 8.10.1,
is an optional filter for the “Create CAC Group”.
query. If a
CACGroupName is
VideoPolicy. above)
Only
Table 189 Query CAC Policy Input Fields
A31003-H80A0-T101-1-7618, 11/2021
CAC Policy

Value
CACPolicyInfoArray An array of structures,
each of which contains all
attributes of a particular
CAC policy.
Please refer to the list of
attributes in Section
8.11.1, “Create CAC
Policy” for details.
Table 190 Query CAC Policy Output Fields
8.11.5 Get Bandwidth Usage for CAC Policy

This function is used to get the current bandwidth usage and number
of concurrent calls for a Call Admission Control (CAC) Policy. Table 191

WSDL Version
Table 191 Get Bandwidth Usage for CAC Policy Return Codes

Value
on page 73.
page 86.
Table 192 Get Bandwidth Usage for CAC Policy Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
CAC Policy

Value
Group to be queried. This CACGroupName in Section 8.10.1,
is an optional filter for the “Create CAC Group”.
query. If a
CACGroupName is
CACPolicyType Indicates the CAC Policy integer 0x0001 (VoicePolicyType) required
Type. Policy Type is a 0x0002 (FaxPolicyType)
bitmap, where the last two 0x0003
bits represent the (both of the above)
FaxPolicy and VoicePolicy
respectively. In the future
this bitmap may be
extended to support
additional types.
Table 192 Get Bandwidth Usage for CAC Policy Input Fields (Seite 2 von 2)

Value
BandWidthUse Actual bandwidth used for N/A
this CAC policy.
NumConCurrentCalls The number of current N/A
concurrent calls for this
CAC policy.
Table 193 Get Bandwidth Usage for CAC Policy Output Fields
8.11.6 Create Group To Group CAC Policy

This method creates a Group to Group Call Admission Control (CAC)
Policy. This SOAP request is very similar to the Create CAC Policy
request, except that in this case two CAC Group Names are specified
for which the GToGCACPolicy is to be defined.
A31003-H80A0-T101-1-7618, 11/2021
CAC Policy

WSDL Version
subRC_APP_CAC_GROUP_NAMES_SAME_FOR_GROUPTOGROUP_CA
CPOLICY
subRC_APP_CAC_INVALID_CAC_POLICY_TYPE
subRC_APP_CAC_INVALID_CAC_POLICY_LIMIT_TYPE
subRC_APP_CAC_BANDWIDTH_LIMIT_NOT_SPECIFED
subRC_APP_CAC_INVALID_CAC_POLICY_BAND_LIMIT
subRC_APP_CAC_CALL_LIMIT_NOT_SPECIFED
subRC_APP_CAC_INVALID_CAC_POLICY_NUM_CALL_LIMIT
subRC_APP_CAC_INVALID_CAC_POLICY_OPTION_FLAG
subRC_APP_GROUPTOGROUP_CAC_POLICY_CREATE_ERROR
V4.00.01.04 31700052 subRC_APP_GTOC_POLICY_CREATE_ATTRIBUTES_ERR
OR
Error while creating attributes for a group-to-group CAC policy.
Table 194 Create Group to Group CAC Policy Return Codes

Value
command. in Section 5.4.2, “Field Definitions”, on page
79.
CACGroup1Name The name of the first CAC Please refer to the definition of required
Group for which this policy CACGroupName in Section 8.10.1, “Create
is to be created. CAC Group”.
CACGroup2Name The name of the second Please refer to the definition of required
CAC Group for which this CACGroupName in Section 8.10.1, “Create
policy is to be created. CAC Group”.
VoicePolicy, and 0x0007 (all three of the above)
VideoPolicy.
CACPolicyLimitType Indicates the type of limit enum CACBandwidthLimitType required
CallLimit If the CAC policy is to integer 0..2147483647 -1
impose a limit on the Note this parameter is required
number of calls, this if CACPolicyLimitType is
parameter should be CACNumCallsLimitType or
specified. CACNumCallsAndBWLimitType
Table 195 Create Group to Group CAC Policy Input Fields (Seite 1 von 3)
A31003-H80A0-T101-1-7618, 11/2021
CAC Policy

Value
BandWidthLimit If the CAC policy is to integer 0..2147483647 -1
impose a limit on the Note this parameter is required
bandwidth, this parameter if CACPolicyLimitType is
should be specified. CACBandwidthLimitType or
CACPolicyOptionFlag CACMediaServerAllow enum Change value: CACNoO
change to CACMediaServerAllow ption
from WSDL version
The field
CACPolicyAttributes
be used instead.
CACPolicyAttributes This field replaces the array of CACPolicyIgnoreMediaServer all false
CACPolicyOptionFlag field. Boolean CACPolicyAllowAnsweredCalls
It is used to provision the flags CACPolicyAllowVideoCallsAsAud
available options to a ioOnly
policy. The existing
options:

and tones
bandwidth
bandwidth
CACPolicyCodecsAllowed A list of CODEC flags, each array of CACPolicyAllCodec CACPolic
one set to true or false to Boolean CACPolicyCodecG711ALaw yAllCode
indicate whether or not flags CACPolicyCodecG711ULaw c = true
A31003-H80A0-T101-1-7618, 11/2021
CAC Policy

Value
Only
or not theVIDEO CODEC is CACPolicyCodecVP8;
allowed for thisCAC
moresimultaneous
guaranteeing
service.
MaximumProfileLevel A maximum allowed enum Level_Unknown=-1, Level_1, Level_2_
be effective regardless of Level_2, Level_2_1, Level_2_2,
any codes restriction Level_3, Level_3_1, Level_3_2,
configuration.It is a series Level_4, Level_4_1, Level_4_2,
of combination of bitrates Level_5, Level_5_1
for H264
8.11.7 Delete Group To Group CAC Policy

This method deletes a Group To Group Call Admission Control (CAC)
Policy. This SOAP request is very similar to the Delete CAC Policy
request, except that in this case two CACGroup Names are required to
identify the GToGCACPolicy.

WSDL Version
subRC_APP_CAC_POLICY_DELETE_NDM_ERROR
Table 196 Delete Group to Group CAC Policy Return Codes
A31003-H80A0-T101-1-7618, 11/2021
CAC Policy

Value
Group for this policy. CACGroupName in Section 8.10.1,
CAC Group for this policy. CACGroupName in Section 8.10.1,
VideoPolicy. above)
Table 197 Delete Group to Group CAC Policy Input Fields
8.11.8 Modify Group To Group CAC Policy

This method modifies a Group To Group Call Admission Control (CAC)
Policy. This SOAP request is very similar to the Modify CAC Policy
request, except that in this case two CACGroup Names are required to
identify the GToGCACPolicy.

WSDL Version
subRC_APP_CAC_INVALID_CAC_POLICY_NUM_CALL_LIMIT
subRC_APP_CAC_INVALID_CAC_POLICY_BAND_LIMIT
subRC_APP_CAC_INVALID_CAC_POLICY_OPTION_FLAG
subRC_APP_CAC_POLICY_MODIFY_NDM_ERROR
V4.00.01.04 31700052 subRC_APP_GTOC_POLICY_MODIFY_ATTRIBUTES_ERR
OR
Error while modifying attributes for a group-to-group CAC policy.
V4.01.04.01 subRC_APP_CAC_INVALID_MAX_PROFILE_LEVEL
Table 198 Modify Group to Group CAC Policy Return Codes
A31003-H80A0-T101-1-7618, 11/2021
CAC Policy

Value
command. in Section 5.4.2, “Field Definitions”, on page
79.
Group for this policy. CACGroupName in Section 8.10.1, “Create
CAC Group”.
CAC Group for this policy. CACGroupName in Section 8.10.1, “Create
CAC Group”.
bitmap, where the last two 0x0003 (both of the above)
bits represent the
this bitmap may be
extended to support
additional types.
CACPolicyLimitType Indicates the type of limit enum CACBandwidthLimitType N/A
CallLimit If the CAC policy is to integer 0..2147483647 N/A
number of calls, this
parameter should be
specified.
BandWidthLimit If the CAC policy is to integer 0..2147483647 N/A
bandwidth, this parameter
should be specified.
CACPolicyOptionFlag Specifies options for the enum CACNoOption CACNoO
CAC policy. The CACIgnoreMediaServerCalls ption
IgnoreMediaServerCalls CACNumCallsLimitType
option implies that for this CACMediaServerIgnoreNumCall
policy the Media Server sExcedAllow
calls should not be
counted against the used
bandwidth and number of
calls for the policy. The
NumCallsLimitType option
allows the number of
answered calls to exceed
the limit. The third option
indicates both of the above
options.
Table 199 Modify Group to Group CAC Policy Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
CAC Policy

Value
CACPolicyCodecsAllowed A list of CODEC flags, each array of CACPolicyAllCodec CACPolic
one set to true or false to Boolean CACPolicyCodecG711ALaw yAllCode
indicate whether or not flags CACPolicyCodecG711ULaw c = true
Only
or not theVIDEO CODEC is CACPolicyCodecVP8;
allowed for thisCAC
moresimultaneous
guaranteeing
service.
MaximumProfileLevel A maximum allowed enum Level_Unknown=-1, Level_1, Level_2_
be effective regardless of Level_2, Level_2_1, Level_2_2,
any codes restriction Level_3, Level_3_1, Level_3_2,
configuration.It is a series Level_4, Level_4_1, Level_4_2,
of combination of bitrates Level_5, Level_5_1
for H264
Table 199 Modify Group to Group CAC Policy Input Fields (Seite 2 von 2)
A31003-H80A0-T101-1-7618, 11/2021
CAC Policy
8.11.9 Query Group To Group CAC Policy

This function is used to query Group To Group Call Admission Control
(CAC) Policy information. Returned information is for either a single
CAC Policy or a set of CAC Policies depending on the input filter
parameters. This SOAP request is very similar to the Query CAC Policy
request, except that in this case two CACGroup Names may be
provided as filter criteria for the query.
Note that if neither CACGroup1Name, CACGroup2Name, nor

CACPolicyType is specified, all Group To Group CAC Policy information
is returned.

WSDL Version
subRC_APP_CAC_POLICY_QUERY_NDM_ERROR
subRC_SYS_CAC_ALLOC_ERR
Table 200 Query Group to Group CAC Policy Return Codes

Value
on page 73.
page 86.
CACGroup1Name The name of the first CAC Please refer to the definition of ““
Group on which to filter for CACGroupName in Section 8.10.1,
the query. “Create CAC Group”.
If a CACGroup1Name is
returned for only policies
having that particular
CACGroup1Name.
Table 201 Query Group to Group CAC Policy Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
CAC Policy

Value
CACGroup2Name The name of the second Please refer to the definition of ““
CAC Group on which to CACGroupName in Section 8.10.1,
filter for the query. “Create CAC Group”.
If a CACGroup2Name is
returned for only policies
having that particular
CACGroup2Name.
VideoPolicy. above)
Only
Table 201 Query Group to Group CAC Policy Input Fields (Seite 2 von 2)

Value
GToGCACPolicyInfoArray An array of structures,
each of which contains all
attributes of a particular
Group To Group CAC
Policy.
Please refer to the list of
attributes in Section
8.11.6, “Create Group To
Group CAC Policy” for
details.
Table 202 Query Group to Group CAC Policy Output Fields
8.11.10 Get Bandwidth Usage for Group to

Group CAC Policy
of concurrent calls for a Group To Group Call Admission Control (CAC)
Policy. This SOAP request is very similar to the Get Bandwidth Usage
For CAC Policy request, except that in this case two CACGroup Names
are required to identify the GToGCACPolicy
A31003-H80A0-T101-1-7618, 11/2021
CAC Policy

WSDL Version
subRC_APP_CAC_POLICY_QUERY_BW_USAGE_NDM_ERROR
subRC_APP_CAC_NON_EXISTENT_GROUPTOGROUP_CAC_POLICY
Table 203 Get BW Usage for Group to Group CAC Policy Return Codes

Value
on page 73.
page 86.
Group for this policy CACGroupName in Section 8.10.1,
whose bandwidth usage “Create CAC Group”.
information is to be
retrieved.
CAC Group for this policy. CACGroupName in Section 8.10.1,
bitmap, where the last two 0x0003 (both of the
bits represent the above)
this bitmap may be
extended to support
additional types.
Table 204 Get BW Usage for Group to Group CAC Policy Input Fields
A31003-H80A0-T101-1-7618, 11/2021
CAC Policy

Value
BandWidthUse Actual bandwidth used for N/A
this CAC policy.
NumConCurrentCalls The number of current N/A
concurrent calls for this
CAC policy.
Table 205 Get BW Usage for Group to Group CAC Policy Output Fields
8.11.11 Query CAC Monitoring

of concurrent calls for a Group To Group Call Admission Control (CAC)
Policy. This SOAP request is very similar to the Get Bandwidth Usage
For CAC Policy request, except that in this case two CACGroup Names
are required to identify the GToGCACPolicy
A Soap Server interface that shall return the following information for
each configured CAC Policy:
• CAC Policy ID
• CAC Policy Type (Traffic Type)
• CAC Group 1 Name
• CAC Group 2 Name
• CAC Policy Limit Type
• Call Limit (The API returns the limit which in currently in effect,
primary or secondary)
• Bandwidth Limit (The API returns the limit which in currently in

effect, primary or secondary)
• Number of Concurrent Calls
• Bandwidth Used
The same API is utilized to retrieve both the regular CAC Policies and
the Group-To-Group CAC Policies.
A31003-H80A0-T101-1-7618, 11/2021
Time Destination

WSDL Version
V5.00.01.09 N/A subRC_APP_SORM_OPERATOR_INVALID
subRC_APP_CP_ERROR_GET_CAC_LIST
subRC_APP_CAC_MONITORING_QUERY_ERROR
subRC_APP_CAC_MONITORING_PAGING_OUT_OF_BOUNDS
Table 206 QueryCacMonitoring Return Codes

Value
OperatorId The operator issuing the Please refer to the definition of required
on page 73.
Page Number number of the retrieved Integer
result set
Page Size Page size of the retrieved Integer
result set
Table 207 QueryCacMonitoring Input Fields
8.12 Time Destination
8.12.1 Create Time Destination

This function is used to create a Time Destination.
The following relationships exist among Time Destinations and their

related objects:
A Time Destination is created first, then one or more Day Schedules are
created within a particular Time Destination. A Period Schedule is a
period of time within a particular day, so a Day Schedule is made up of
a set of Period Schedules. When a Day Schedule is full of Period
Schedules such that the periods specified cover the entire day, the Day
Schedule is assigned to a particular day of the week. Day Schedules
can later be unassigned or modified if desired. If a Day Schedule is not
assigned, it can be removed. To see the complete set of assignments
of Day Schedules to the days of the week for a particular Time
A31003-H80A0-T101-1-7618, 11/2021
Time Destination
Destination, the QueryWeeklySchedule request is used. See the

following subsections for detailed information about all of these
operations.

WSDL Version
Table 208 Create Time Destination Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Time Destination

Value
Name The name of the Time 1..15 Character String required
Destination to create.
Table 209 Create Time Destination Input Fields
8.12.2 Remove Time Destination

This function is used to create a Time Destination. Table 210 lists the

WSDL Version
Table 210 Remove Time Destination Return Codes

Value
Name The name of the Time 1..15 Character String required
Destination to remove.
Table 211 Remove Time Destination Input Fields
8.12.3 Query Time Destination

This function is used to retrieve and display a Time Destination. If the
Name parameter is supplied, only that Time Destination is retrieved;
otherwise the complete list of existing Time Destination is retrieved.

WSDL Version
Table 212 Query Time Destination Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Day Schedule

Value
Specific Indicates type of query. If Refer to the paragraph at the beginning of Chapter 8.
True, the request is for a
specific TimeDestination;
if False, for all
TimeDestinations.
page 86.
Name The name of the Time 1..15 Character String N/A
Destination to retrieve.
Table 213 Query Time Destination Input Fields
8.13 Day Schedule
8.13.1 Create Day Schedule

This function is used to provision a specific Day Schedule within a Time
Destination. The schedules assigned within the time destination should
cover one whole week. Note that the name of the Day Schedule itself
need not be unique in the system - the day schedule is uniquely
identified by the combination of Day Schedule and Time Destination.
Note that this operation does not assign a Day Schedule to the Time
Destination, it only creates it and uniquely identifies it within the Time
Destination so that it can be assigned using the AssignDaySchedule
operation.

WSDL Version
Table 214 Create Day Schedule Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Day Schedule

Value
Name The name of the Day 1..15 Character String required
Schedule to create. This
uniquely identifies a day
schedule within a time
destination.
TimeDestinationName The name of an existing 1..15 Character String required
Time Destination.
Table 215 Create Day Schedule Input Fields
8.13.2 Assign Day Schedule

This function is used to assign one or more Day Schedules to a Time
Destination.
Note that any day schedule that is assigned must be fully allocated,
meaning that it must contain period schedules that cover exactly 24
hours (1440 minutes).

WSDL Version
Table 216 Assign Day Schedule Return Codes

Value
TimeDestinationName The name of the Time 1..15 Character String required
Destination to which Day
Schedules are to be
assigned.
DayScheduleNameSun The name of an existing 1..15 Character String N/A
Day Schedule to assign to
the Time Destination for
Sunday.
Table 217 Assign Day Schedule Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Day Schedule

Value
DayScheduleNameMon The name of an existing 1..15 Character String N/A
Monday.
DayScheduleNameTue The name of an existing 1..15 Character String N/A
Tuesday.
DayScheduleNameWed The name of an existing 1..15 Character String N/A
Wednesday.
DayScheduleNameThu The name of an existing 1..15 Character String N/A
Thursday.
DayScheduleNameFri The name of an existing 1..15 Character String N/A
Friday.
DayScheduleNameSat The name of an existing 1..15 Character String N/A
Saturday.
Table 217 Assign Day Schedule Input Fields (Seite 2 von 2)
8.13.3 Unassign Day Schedule

This function is used to unassign one or more Day Schedules from a
Time Destination.
Note that this operation only unassigns the Day Schedule, but does not
remove it—it will still be available within the Time Destination for future
assignments.

WSDL Version
Table 218 Unassign Day Schedule Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Day Schedule

Value
Destination from which
Day Schedules are to be
unassigned.
UnassignAll If True, indicates that all Boolean True, False False
Day Schedules are to be
unassigned.
UnassignSun If True, indicates that the Boolean True, False False
Day Schedule specified as
DayScheduleNameSun is
to be unassigned.
UnassignMon If True, indicates that the Boolean True, False False
DayScheduleNameMon is
to be unassigned.
UnassignTue If True, indicates that the Boolean True, False False
DayScheduleNameTue is
to be unassigned.
UnassignWed If True, indicates that the Boolean True, False False
DayScheduleNameWed is
to be unassigned.
UnassignThu If True, indicates that the Boolean True, False False
DayScheduleNameThu is
to be unassigned.
UnassignFri If True, indicates that the Boolean True, False False
DayScheduleNameFri is to
be unassigned.
UnassignSat If True, indicates that the Boolean True, False False
DayScheduleNameSat is
to be unassigned.
Table 219 Unassign Day Schedule Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Day Schedule
8.13.4 Modify Day Schedule

This function is used to modify one or more Day Schedules for a Time
Destination. In other words, it changes the existing assignment for
each specified day from one Day Schedule to another, accomplishing
the same functionality that could be done by using Unassign Day
Schedule followed by Assign Day Schedule.

WSDL Version
Table 220 Modify Day Schedule Return Codes

Value
Destination to which Day
Schedules are assigned.
DayScheduleNameSun The name of an existing 1..15 Character String N/A
Sunday.
DayScheduleNameMon The name of an existing 1..15 Character String N/A
Monday.
DayScheduleNameTue The name of an existing 1..15 Character String N/A
Tuesday.
DayScheduleNameWed The name of an existing 1..15 Character String N/A
Wednesday.
DayScheduleNameThu The name of an existing 1..15 Character String N/A
Thursday.
Table 221 Modify Day Schedule Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Day Schedule

Value
DayScheduleNameFri The name of an existing 1..15 Character String N/A
Friday.
DayScheduleNameSat The name of an existing 1..15 Character String N/A
Saturday.
Table 221 Modify Day Schedule Input Fields (Seite 2 von 2)
8.13.5 Remove Day Schedule

This function is used to remove a Day Schedule and all of its Period
Schedules, provided it is not assigned to a Time Destination.
Note that this operation completely removes the Day Schedule; it will
no longer be available for future assignment.

WSDL Version
Table 222 Remove Day Schedule Return Codes

Value
Name The name of the Day 1..15 Character String required
Schedule to remove.
Destination from which the
Day Schedule is to be
removed.
Table 223 Remove Day Schedule Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Day Schedule
8.13.6 Query Day Schedule

This function is used to retrieve and display a Day Schedule. If the
Name parameter is supplied, only that Day Schedule is retrieved;
otherwise the Day Schedules are retrieved. Likewise, if the Time
Destination parameter is specified, only the Day Schedules for that
Time Destination are retrieved; if not, the complete list of existing Day
Schedules is retrieved.

WSDL Version
Table 224 Query Day Schedule Return Codes

Value
Specific Indicates type of query. If Refer to the paragraph at the beginning of Chapter 8.
True, the request is for a
specific DaySchedule; if
False, for all DaySchedules
within the specified
TimeDestination.
page 86.
Name The name of the Day 1..15 Character String N/A
Schedule to retrieve.
TimeDestinationName The name of the Time 1..15 Character String N/A
Destination for which the
Day Schedule(s) are to be
retrieved.
Table 225 Query Day Schedule Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Period Schedule
8.14 Period Schedule
8.14.1 Create Period Schedule

This function is used to create a Period Schedule. The Start and Stop
Times for a set of Period Schedules created for a particular Day
Schedule should cover the complete 24 hour day and cannot overlap.
For example, PS1 can be created with StartTime 00:00 and StopTime
13:00. Then PS2 could be created for 13:01-16:00 and PS3 for 16:01-
23:59. A PS2 for 12:00-16:00 would not be allowed.

WSDL Version
Table 226 Create Period Schedule Return Codes

Value
Name The name of the Period 1..15 Character String required
Schedule to create.
DayScheduleName The name of an existing 1..15 Character String required
Day Schedule.
Destination to which the
specified Day Schedule
belongs.
StartTime The starting time of the Character String required
period in the form
“HH:MM”
StopTime The stop time of the period Character String required
in the form “HH:MM”
DestinationName The generic destination Character String required
with which this period is
associated.
Table 227 Create Period Schedule Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Period Schedule
8.14.2 Remove Period Schedule

This function is used to remove a Period Schedule, provided its parent
Day Schedule is not explicitly assigned to a Time Destination with the
Assign Day Schedule command.

WSDL Version
Table 228 Remove Period Schedule Return Codes

Value
Schedule to remove.
DayScheduleName The name of the Day 1..15 Character String required
Schedule to which the
Period Schedule belongs.
Day Schedule belongs.
StartTime The starting time of the Character String required
period in the form
“HH:MM”
Table 229 Remove Period Schedule Input Fields
8.14.3 Modify Period Schedule

This function is used to modify a Period Schedule. Table 230 lists the

WSDL Version
Table 230 Modify Period Schedule Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Period Schedule

Value
Schedule to modify.
DayScheduleName The name of the Day 1..15 Character String required
StartTime The starting time of the Character String N/A
period in the form
“HH:MM”
StopTime The stop time of the period Character String N/A
in the form “HH:MM”
DestinationName The generic destination Character String N/A
with which this period is
associated.
Table 231 Modify Period Schedule Input Fields
8.14.4 Query Period Schedule

This function is used to retrieve and display a Period Schedule. If the
Time Destination is given and/or the Day Schedule is given, they act as
a filter on the set of Period Schedules that are retrieved.
Note that if a specific Period Schedule object is identified by the

combination of the Day Schedule and the StartTime, the Day Schedule
is NOT used as a filter.

WSDL Version
Table 232 Query Period Schedule Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Weekly Schedule

Value
Name The name of the Period 1..15 Character String N/A
Schedule to remove.
DayScheduleName The name of the Day 1..15 Character String N/A
StartTime The starting time of the Character String N/A
period in the form
“HH:MM”
Table 233 Query Period Schedule Input Fields
8.15 Weekly Schedule
8.15.1 Query Weekly Schedule

This function is used to retrieve and display a Weekly Schedule. The
Time Destination Name must be provided, and the day of the week may
be provided as a filter option.
The response consists of an array of Weekly Schedule elements, each

of which contains the Time Destination, the day of the week, and the
Day Schedule Name. Note that Day Schedules may appear more than
once in a Weekly Schedule, in particular when the Day Schedule is
assigned to more than one day for a Time Destination.

WSDL Version
Table 234 Query Weekly Schedule Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Weekly Schedule

Value
page 86.
TimeDestinationName The name of an existing 1..15 Character String N/A
Time Destination.
DayOfWeek The day of the week for enum DayIgnored N/A
which to return the DayUnused
schedule. DayUnassigned
Sun
Mon
Tue
Wed
Thu
Fri
Sat
Table 235 Query Weekly Schedule Input Fields

Value
An array of WeeklySchedule elements, each consisting of the following attributes:
Name An identifier that is 1..15 Character String N/A
automatically generated
by the system to identify
the weekly schedule for
display purposes.
Day The day of the week for enum DayIgnored N/A
which to this schedule DayUnused
element. DayUnassigned
Sun
Mon
Tue
Wed
Thu
Fri
Sat
TimeDestinationName The name of an existing 1..15 Character String N/A
Time Destination.
Table 236 Query Weekly Schedule Output Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Intercept

Value
DayScheduleName The name of the Day 1..15 Character String N/A
Table 236 Query Weekly Schedule Output Fields (Seite 2 von 2)
8.16 Intercept
8.16.1 Create Intercept

This function is used to create an Intercept, which is a series of
treatments, where each treatment is a recorded announcement, a
tone, an operator, or some combination of these. The sequence of
treatments can be repeated for a certain number of cycles. Intercepts
are provided for calls that cannot be completed as dialed.

WSDL Version
Table 237 Create Intercept Return Codes

Value
command. Operator ID in Table 10 on page 78.
CreateName A flag that is set to True if Boolean False False
only the intercept name is True
to be created or False if
the Intercept Name
already exists and this
request is to provide the
treatment data for it.
Note that if CreateName is

True, any Treatment
information that is
included in the request is
ignored.
Table 238 Create Intercept Input Fields (Seite 1 von 6)
A31003-H80A0-T101-1-7618, 11/2021
Intercept

Value
InterceptData. The name of an Intercept. 1..15 Character String required
InterceptInfo.
Name
InterceptData. The number of times that integer 1
Cycle the intercept treatment
sequence is applied. This
value is the same for all
treatments assigned to the
same intercept.
InterceptData. The time that silence integer 0
Interval between cycles shall last.
This value is the same for
all treatments assigned to
the same intercept.
InterceptData. Indicates whether or not Boolean False False
IsDefault the intercept may be used True
as default.
InterceptData. Identifies a default 1..15 Character String required
DefaultName intercept entry. If a
DefaultName is assigned,
then all of its
corresponding assigned
treatments also become
the treatments used,
unless they are explicitly
modified to be different.
NumberTreatments The number of treatments integer 0..3 N/A
in the following array.
Treatment An array of TreatmentDataInfoelements, each consisting of the following
attributes:
TreatmentDataInfo. The name of the 0..15 Character string ““
TreatmentInfo. treatment.
Name
TreatmentDataInfo. This parameter specifies a enum TreatmentOrder required
TreatmentInfo. user-assigned value Unused,
TreatmentOrder describing the desired TreatmentOrderFirst,
ordering of the new TreatmentOrder
treatment to be created in Second,
relation to existent TreatmentOrder
treatments. Third
TreatmentDataInfo. The name of an intercept. 0..15 Character string ““

TreatmentInfo.
InterceptId.
Name
A31003-H80A0-T101-1-7618, 11/2021
Intercept

Value
TreatmentDataInfo. The number of times that integer required
same intercept.
TreatmentDataInfo. The time that silence integer 0
the same intercept.
TreatmentDataInfo. The type of treatment. enum TreatmentTypeUnused required
TreatmentType Note that if TreatmentTypeUnassigned
TreatmentTypeTone is TreatmentTypeTone
specified, the contents of TreatmentTypeAnnounce
the Tone structure below ment
should be provided; if TreatmentTypeRelCall
TreatmentTypeAnnounce
ment is specified, the
contents of the Announce
structure below should be
provided.
TreatmentDataInfo. Identifies a tone. 0..15 Character string required
Tone.
ToneName
TreatmentDataInfo. The length of time in integer 0
Tone. milliseconds for which the
Duration tone is to be played.
A31003-H80A0-T101-1-7618, 11/2021
Intercept

Value
TreatmentDataInfo. This parameter specifies 0..63 Character string ““
Tone. the Destination name.
DestinationName NOTES:
• If 'Destination Type'
equals 'MGCPMS', the
'Destination Name' is a
user-assigned
alphanumeric string
identifying a Media
Gateway.
equals 'DEST', the
user-assigned
alphanumeric string
identifying a Destination
with a 'Destination Id' of
type 'MSDEST'.
• This object is optional
for Tone treatments, and is
mandatory for
Announcement
treatments.
equals 'ORIGDEST_MS',
the 'Destination Name' is a
user-assigned,
alphanumeric string
identifying an Origin
Destination.
TreatmentDataInfo. This parameter specifies enum DtUnassigned DtUnassigned
Tone. the destination type. DtDest
DestinationType DtMediaGateway
DtOrigDestMs
Tone. the Treatment Destination
DestinationCircuit Circuit name
(MG_CIRCUIT_ID of the
destination). The
Destination Circuit Name
is a user-assigned
alphanumeric string
identifying a Media
Gateway Circuit.
TreatmentDataInfo. Identifies an 0..511 Character string required
Announce. announcement.
Name
A31003-H80A0-T101-1-7618, 11/2021
Intercept

Value
TreatmentDataInfo. This parameter specifies enum YnYes YnNo
Announce. the answer YnNo
Answer announcement. In SIP YnUndefined
terminology, the
announcement is “early
media.”
Possible values are:
• No - the call is treated
as unanswered, and the
indication is not returned.
• Yes - an indication will
be returned to the calling
party before the
announcement.
TreatmentDataInfo. This parameter specifies enum YnYes YnNo
Announce. whether or not the Barge- YnNo
BargeIn In announcement is YnUndefined
applied.
• No - Non-Barge-In
announcement implies
that a call is connected to
a recorded announcement
only at the beginning of
the recorded message
cycle.
• Yes - Barge-In
the recorded
announcement
immediately.
A31003-H80A0-T101-1-7618, 11/2021
Intercept

Value
Announce. the Destination name.
user-assigned
alphanumeric string
identifying a Media
Gateway.
equals 'DEST', the
user-assigned
alphanumeric string
type 'MSDEST'.
mandatory for
Announcement
treatments.
user-assigned,
alphanumeric string
Destination.
TreatmentDataInfo. This parameter specifies enum ICDtUnused DtUnassigned
Announce. the destination type. ICDtUnassigned
DestinationType ICDtDest
ICDtMediaGateway
ICDtOrigDestMs
Announce. the Treatment Destination
destination). The
is a user-assigned
alphanumeric string
identifying a Media
Gateway Circuit.
SipReasonId An optional SIP reason integer
header that may be
provided if TreatmentType
is TreatmentTypeRelCall.
A31003-H80A0-T101-1-7618, 11/2021
Intercept
8.16.2 Remove Intercept

This function is used to remove an Intercept. Table 239 lists the return

WSDL Version
Table 239 Remove Intercept Return Codes

Value
RemoveName A flag that is set to True if Boolean False False
only the intercept name is True
to be removed.
If RemoveName is False,
the Treatment data for the
Intercept is unassigned,
but the Intercept itself is
not deleted.
If RemoveName is True,
the Intercept is deleted,
providing that it has no
Treatment data assigned.
If there is Treatment data
assigned and
RemoveName is True, the
request is rejected.
InterceptInfo. The name of an Intercept. 1..15 Character String required
Name
Table 240 Remove Intercept Input Fields
8.16.3 Modify Intercept

This function is used to modify an Intercept. Table 241 lists the return

WSDL Version
Table 241 Modify Intercept Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Intercept

Value
InterceptInfo. The name of an Intercept. 1..15 Character String required
Name
NewName The new name of an 1…15 Character String required
Intercept
Cycle The number of times that integer 1
the intercept treatment
same intercept.
Interval The time that silence integer 0
between cycles shall last.
the same intercept.
IsDefault Indicates whether or not Boolean False False
the intercept may be used True
as default.
DefaultName Identifies a default 1..15 Character String required
intercept entry. If a
then all of its
Table 242 Modify Intercept Input Fields
8.16.4 Query Intercept

This function is used to retrieve and display an Intercept. Table 243 lists

WSDL Version
Table 243 Query Intercept Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Intercept

Value
page 86.
FilterSet Indicates that only enum FilterSetUnused FilterSetAll
intercepts matching the FilterSetAll
specified filter condition FilterSetAbstract
should be returned. FilterSetConcrete
FilterSetSystem
Note that FilterSetAbstract FilterSetUser
indicates those Intercepts FilterSetDefault
without treatments, while
FilterSetConcrete
indicates those with
treatments.
InterceptInfo. The name of an Intercept. 1..15 Character String ““
Name If provided, only the
matching intercept is
retried.
DefaultName Identifies a default 1..15 Character String ““
intercept entry. If a
then all of its
Table 244 Query Intercept Input Fields

Value
An array of Intercept elements, each consisting of the following attributes:
InterceptData. The name of the Intercept. 1..15 Character String N/A
InterceptInfo.
Name
Table 245 Query Intercept Output Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Treatment

Value
InterceptData. The number of times that integer N/A
same intercept.
InterceptData. The time that silence integer N/A
the same intercept.
InterceptData. Indicates whether or not Boolean False N/A
IsDefault the intercept may be used True
as default.
InterceptData. Identifies a default 1..15 Character String N/A
DefaultName intercept entry. If a
then all of its
Table 245 Query Intercept Output Fields (Seite 2 von 2)
8.17 Treatment
8.17.1 Assign Treatment

This function is used to assign a Treatment to an existing Intercept. A
treatment can be defined as a tone or announcement. Each tone is
identified by a system defined tone ID and lasts for a given duration.

WSDL Version
Table 246 Assign Treatment Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Treatment
Field Name Description Length Range/Value Default

Value
TreatmentInfo. The name of the 0..15 Character string ““
Name treatment.
TreatmentInfo. This parameter specifies a enum TreatmentOrder required
TreatmentOrder user-assigned value Unused,
describing the desired TreatmentOrderFirst,
ordering of the treatment. TreatmentOrder
Second,
TreatmentOrder
Third
InterceptId. The name of an Intercept. 1..15 Character String required

Name
Cycle The number of times that integer required
same intercept.
the same intercept.
TreatmentType The type of treatment. enum TreatmentTypeUnused required
Note that if TreatmentTypeUnassigned
provided.
Tone. Identifies a tone. 0..15 Character string required
ToneName
Tone. The length of time in integer 0
Duration milliseconds for which the
tone is to be played.
Table 247 Assign Treatment Input Fields (Seite 1 von 4)
A31003-H80A0-T101-1-7618, 11/2021
Treatment

Value
Tone. This parameter specifies 0..63 Character string ““
DestinationName the Destination name.
NOTES:
user-assigned
alphanumeric string
identifying a Media
Gateway.
equals 'DEST', the
user-assigned
alphanumeric string
type 'MSDEST'.
mandatory for
Announcement
treatments.
user-assigned,
alphanumeric string
Destination.
Tone. This parameter specifies enum DtUnassigned DtUnassigned
DestinationType the destination type. DtDest
DtMediaGateway
DtOrigDestMs
Tone. This parameter specifies 0..63 Character string ““

DestinationCircuit the Treatment Destination
Circuit name
destination). The
is a user-assigned
alphanumeric string
identifying a Media
Gateway Circuit.
Announce. Identifies an 0..511 Character string required
Name announcement.
A31003-H80A0-T101-1-7618, 11/2021
Treatment

Value
Announce. This parameter specifies enum YnYes YnNo
Answer the answer YnNo
announcement. In SIP YnUndefined
terminology, the
media.”
party before the
announcement.
BargeIn whether or not the Barge- YnNo
In announcement is YnUndefined
applied.
cycle.
• Yes - Barge-In
the recorded
announcement
immediately.
A31003-H80A0-T101-1-7618, 11/2021
Treatment

Value
TreatmentData. This parameter specifies 0..63 Character string ““
user-assigned
alphanumeric string
identifying a Media
Gateway.
equals 'DEST', the
user-assigned
alphanumeric string
type 'MSDEST'.
mandatory for
Announcement
treatments.
user-assigned,
alphanumeric string
Destination.
TreatmentData. This parameter specifies enum DtUnassigned DtUnassigned
Announce. the destination type. DtDest
DtOrigDestMs

destination). The
is a user-assigned
alphanumeric string
identifying a Media
Gateway Circuit.
header that may be
A31003-H80A0-T101-1-7618, 11/2021
Treatment
8.17.2 Modify Treatment

This function is used to modify a Treatment. Note that TreatmentType
cannot be modified. If the TreatmentType is Tone, the Tone Name and
Duration may be modified. If the TreatmentType is Announce, any of
the Announcement related parameters may be modified. If the
TreatmentType is Relcall, only the SipReasonId may be modified.

WSDL Version
Table 248 Modify Treatment Return Codes

Value
Name treatment.
TreatmentInfo. This parameter specifies a enum TreatmentOrder required
TreatmentOrder user-assigned value Unused,
describing the desired TreatmentOrderFirst,
ordering of the treatment. TreatmentOrder
Second,
TreatmentOrder
Third

Name
Cycle The number of times that integer required
same intercept.
the same intercept.
Tone. Identifies a tone. 0..15 Character string required
ToneName
Table 249 Modify Treatment Input Fields (Seite 1 von 3)
A31003-H80A0-T101-1-7618, 11/2021
Treatment

Value
Tone. The length of time in integer 0
Duration milliseconds for which the
tone is to be played.
Announce. Identifies an 0..511 Character string required
Name announcement.
Answer the answer YnNo
announcement. In SIP YnUndefined
terminology, the
media.”
party before the
announcement.
BargeIn whether or not the Barge- YnNo
In announcement is YnUndefined
applied.
cycle.
• Yes - Barge-In
the recorded
announcement
immediately.
A31003-H80A0-T101-1-7618, 11/2021
Treatment

Value
user-assigned
alphanumeric string
identifying a Media
Gateway.
equals 'DEST', the
user-assigned
alphanumeric string
type 'MSDEST'.
mandatory for
Announcement
treatments.
user-assigned,
alphanumeric string
Destination.
DtOrigDestMs

destination). The
is a user-assigned
alphanumeric string
identifying a Media
Gateway Circuit.
header that may be
A31003-H80A0-T101-1-7618, 11/2021
Treatment
8.17.3 Unassign Treatment

This function is used to unassign a Treatment from an existing
Intercept. If no remaining treatments are assigned to the Intercept
after the Unassign operation, the Cycle and Interval parameters are
reset to default values.

WSDL Version
Table 250 Unassign Treatment Return Codes

Value
TreatmentInfo. The name of the 0..15 Character string required
Name treatment.
TreatmentInfo. This parameter specifies enum TreatmentOrder required
TreatmentOrder the ordering of the Unused,
treatment. TreatmentOrderFirst,
TreatmentOrder
Second,
TreatmentOrder
Third
InterceptId. The name of the Intercept 1..15 Character String required

Name from which the Treatment
is to be unassigned.
Table 251 Unassign Treatment Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Treatment

Value
user-assigned
alphanumeric string
identifying a Media
Gateway.
equals 'DEST', the
user-assigned
alphanumeric string
type 'MSDEST'.
mandatory for
Announcement
treatments.
user-assigned,
alphanumeric string
Destination.
DtOrigDestMs

destination). The
is a user-assigned
alphanumeric string
identifying a Media
Gateway Circuit.
header that may be
Table 251 Unassign Treatment Input Fields (Seite 2 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Treatment
8.17.4 Query Treatment

This function is used to retrieve and display existing Treatments. Table
252 lists the return codes for this method.

WSDL Version
Table 252 Query Treatment Return Codes

Value
page 86.
InterceptInfo. The name of an Intercept. 1..15 Character String ““
Name If provided, only the
matching intercept is
retried.
Name treatment.
TreatmentInfo. This parameter specifies enum TreatmentOrder N/A
TreatmentOrder the ordering of the Unused,
TreatmentOrder
Second,
TreatmentOrder
Third
Table 253 Query Treatment Input Fields

Value
Treatment An array of TreatmentData elements, each consisting of the following attributes:
TreatmentData. The name of the 0..15 Character string ““
TreatmentInfo. treatment.
Name
Table 254 Query Treatment Output Fields (Seite 1 von 5)
A31003-H80A0-T101-1-7618, 11/2021
Treatment

Value
TreatmentData. This parameter specifies a enum TreatmentOrder required
TreatmentInfo. user-assigned value Unused,
TreatmentOrder describing the desired TreatmentOrderFirst,
ordering of the new TreatmentOrder
treatment to be created in Second,
relation to existent TreatmentOrder
treatments. Third
TreatmentData. The name of an intercept. 0..15 Character string ““

TreatmentInfo.
InterceptId.
Name
TreatmentData. The number of times that integer required
same intercept.
TreatmentData. The time that silence integer 0
the same intercept.
TreatmentData. The type of treatment. enum TreatmentTypeUnused required
TreatmentType Note that if TreatmentTypeUnassigned
provided.
TreatmentData. Identifies a tone. 0..15 Character string required
Tone.
ToneName
TreatmentData. The length of time in integer 0
Tone. milliseconds for which the
Duration tone is to be played.
A31003-H80A0-T101-1-7618, 11/2021
Treatment

Value
Tone. the Destination name.
user-assigned
alphanumeric string
identifying a Media
Gateway.
equals 'DEST', the
user-assigned
alphanumeric string
type 'MSDEST'.
mandatory for
Announcement
treatments.
user-assigned,
alphanumeric string
Destination.
Tone. the destination type. DtDest
DtOrigDestMs

Tone. the Treatment Destination
destination). The
is a user-assigned
alphanumeric string
identifying a Media
Gateway Circuit.
TreatmentData. Identifies an 0..511 Character string required
Announce. announcement.
Name
A31003-H80A0-T101-1-7618, 11/2021
Treatment

Value
TreatmentData. This parameter specifies enum YnYes YnNo
Announce. the answer YnNo
Answer announcement. In SIP YnUndefined
terminology, the
media.”
party before the
announcement.
TreatmentData. This parameter specifies enum YnYes YnNo
Announce. whether or not the Barge- YnNo
BargeIn In announcement is YnUndefined
applied.
cycle.
• Yes - Barge-In
the recorded
announcement
immediately.

DtOrigDestMs
A31003-H80A0-T101-1-7618, 11/2021
Treatment

Value
user-assigned
alphanumeric string
identifying a Media
Gateway.
equals 'DEST', the
user-assigned
alphanumeric string
type 'MSDEST'.
mandatory for
Announcement
treatments.
user-assigned,
alphanumeric string
Destination.
destination). The
is a user-assigned
alphanumeric string
identifying a Media
Gateway Circuit.
header that may be
A31003-H80A0-T101-1-7618, 11/2021
Treatment
8.17.5 Prioritize Treatment

This function is used to change the ordered priority of a Treatment.

WSDL Version
Table 255 Prioritize Treatment Return Codes

Value
NewOrder This parameter specifies enum TreatmentOrder required
the desired ordering of the Unused,
TreatmentOrder
Second,
TreatmentOrder
Third

Name treatment.
TreatmentInfo. This parameter specifies enum TreatmentOrder required
TreatmentOrder the existing ordering of Unused,
the treatment whose order TreatmentOrderFirst,
is to be changed. TreatmentOrder
Second,
TreatmentOrder
Third

Name
Table 256 Prioritize Treatment Input Fields
8.17.6 Bulk Assign Treatments

This function Creates all default treatments for all default
announcement intercepts, and/or conferencing intercepts, and/or
CALEA intercepts using the specified destination(s). Administrator has
the option to select assignment to the Default Destination or to a
preconfigured Custom Destination (of type "Origin Destination",
"Destination" or “MediaServer").
A31003-H80A0-T101-1-7618, 11/2021
Treatment

WSDL Version
Table 257 Bulk Assign Treatments Return Codes

Value
Announcement Container for bulk See the four fields which follow. optional
creating
announcements.
DestinationType Specifies whether the enum • BulkTreatmentDestTy
default or a custom peDefault
destination will be used • BulkTreatmentDestTy
for the default peCustom
Announcement
treatments.
(CustomDestination). An Intercept enum • ICDtUnused
DestinationType Destination Type • ICDtUnassigned
• ICDtDest
• ICDtMediaGateway
• ICDtOrigDestMs
(CustomDestination). The name of the string
DestinationName destination
Conference Container for bulk See the four fields which follow. optional
creating conference
treatments.
Announcement
treatments.
• ICDtDest
• ICDtOrigDestMs
Table 258 Bulk Assign Treatments Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Treatment

Value
ES Container for bulk See the four fields which follow. optional
creating treatments for
CALEA Intercepts.

Announcement
treatments.
• ICDtDest
• ICDtOrigDestMs
Table 258 Bulk Assign Treatments Input Fields (Seite 2 von 2)
8.17.7 Bulk Modify Treatments

This function modifies all default treatments for all default

WSDL Version
Table 259 Bulk Modify Treatments Return Codes

Value
Table 260 Bulk Modify Treatments Input Fields (Seite 1 von 3)
A31003-H80A0-T101-1-7618, 11/2021
Treatment

Value
Announcement Container for bulk See the four fields which follow. optional
modification of
announcements.
Announcement
treatments.
• ICDtDest
• ICDtOrigDestMs
Conference Container for bulk See the four fields which follow. optional
modification of
conference treatments.
Announcement
treatments.
• ICDtDest
• ICDtOrigDestMs
ES Container for bulk See the four fields which follow. optional
modification of CALEA
Intercept treatments.
Announcement
treatments.
A31003-H80A0-T101-1-7618, 11/2021
Treatment

Value
• ICDtDest
• ICDtOrigDestMs
8.17.8 Bulk Unassign Treatments

This function unassigns all default treatments for all default

WSDL Version
Table 261 Bulk Unassign Treatments Return Codes

Value
Announcement To bulk unassign/delete boolean True optional
all default False
announcement
intercept treatments.
Conference To bulk unassign/delete boolean True optional
all default conference False
ES To bulk unassign/delete boolean True optional
all default CALEA False
Table 262 Bulk Unassign Treatments Input Fields
A31003-H80A0-T101-1-7618, 11/2021
SIP Trusted Entity Ports
8.18 SIP Trusted Entity Ports
8.18.1 Add SIP Trusted Entity Ports

This function is used to add port ranges to a SIP Entity.
A list of port ranges may be provided in this request, and there may be
cases in which some port ranges cannot be successfully assigned to the
given SIP Entity. In this case, those ports are skipped and processing
continues in an attempt to assign the remaining port ranges in the list
provided. The response to the operator includes a list of port ranges
that could not be added along with an error message indicating the
reason for the failure.

WSDL Version
Table 263 Add SIP Trusted Entity Ports Return Codes
A31003-H80A0-T101-1-7618, 11/2021

Value
SipEntityIPAddress The IP address of the SIP 7..16 A valid IP address. required
Entity.
PortRangeList An array of PortRangeEntry elements, each consisting of the following attributes:
minPort The lower end of the port integer 0..65535 required
range to add.
If minPort=0 then the

entire range of ports for
the specified IP address is
defined as trusted.
maxPort The upper end of the port integer 0..65535 required
range to add.
If maxPort=0 then only

the single port specified by
minPort is defined as
trusted.
Table 264 Add SIP Trusted Entity Ports Input Fields
8.18.2 Remove SIP Trusted Entity Ports

This function is used to remove port ranges from a SIP Entity.
A list of port ranges may be provided in this request, and there may be
cases in which some port ranges cannot be successfully removed from
the given SIP Entity. In this case, those ports are skipped and
processing continues in an attempt to remove the remaining port
ranges in the list provided. The response to the operator includes a list
of port ranges that could not be removed along with an error message
indicating the reason for the failure.

WSDL Version
Table 265 Remove SIP Trusted Entity Ports Return Codes
A31003-H80A0-T101-1-7618, 11/2021

Value
Entity.
range to add.

defined as trusted.
range to add.

trusted.
Table 266 Remove SIP Trusted Entity Ports Input Fields
8.18.3 Get SIP Trusted Entity Ports List

This function is used to retrieve and display the list of port ranges
assigned to a SIP Entity.
If the IP address of a SIP Entity is provided, the list of port ranges that
are assigned to this entity will be displayed. If the IP address is
omitted, the entire list of existing SIP Entities will be displayed along
with all of their corresponding port ranges.

WSDL Version
Table 267 Get SIP Trusted Entity Ports List Return Codes
A31003-H80A0-T101-1-7618, 11/2021

Value
page 86.
Entity.
range to add.

defined as trusted.
range to add.

trusted.
Table 268 Get SIP Trusted Entity Ports List Input Fields

Value
PortRangeListData An array of PortRangeListDataEntry elements, each consisting of the following
attributes:
Entity.
range to add.

defined as trusted.
Table 269 Get SIP Trusted Entity Ports Lists Output Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
System SIP Entry

Value
range to add.

trusted.
Table 269 Get SIP Trusted Entity Ports Lists Output Fields (Seite 2 von 2)
8.19 System SIP Entry
8.19.1 Add System SIP Entry

This function is used to create an entry in the system SIP security table.

WSDL Version
Table 270 Add System SIP Entry Return Codes

Value
SipEntityID This identifies the HTTP 0..255 A character string required
Digest Authentication representing a valid IP
entry; typically it is an IP address or FQDN.
address or a Fully
Qualified Domain Name
(FQDN).
RealmIDType This identifies the HTTP enum Ip Ip
Digest identification type fqdn
being used.
TrustedEntity Indicates whether the boolean false, true false
SystemSipEntry being
created is to be a trusted
entity or not.
Table 271 Add System SIP Entry Input Fields (Seite 1 von 3)
A31003-H80A0-T101-1-7618, 11/2021
System SIP Entry

Value
Scheme The type of security enum digest-authentication digest-
scheme that is being authentication
implemented. In this
release, only the
digest_authentication
form of security is
supported.
LocalRealm This identifies the local 0..128 Character string ““ OR if
realm. A realm is a string subscriber is
to be displayed to users for OSMO, then it
association with its is assigned the
username and password. LocalRealm
For a trusted entity, this value of the
parameter should not be DeskPhone
provisioned. For a non-
trusted entity, if this
parameter is not
provisioned, the default
localhost entry
information is used.
LocalUserName This identifies a user 0, 6..64 Character string ““ OR if
within the local realm. For subscriber is
a trusted entity, this OSMO, then it
parameter should not be is assigned the
provisioned. For a non- OSMO
trusted entity, if this Subscriber DN
parameter is not value
localhost entry
LocalPassword The password for the local 6..20 Character string ““ OR if
user within the local subscriber is
realm. For a trusted entity, OSMO, then it
this parameter should not is assigned the
be provisioned. For a non- LocalPassword
trusted entity, if this value of the
parameter is not DeskPhone
localhost entry
A31003-H80A0-T101-1-7618, 11/2021
System SIP Entry

Value
RemoteRealm This identifies the remote 0..128 Character string ““
realm. A realm is a string
to be displayed to users for
association with its
username and password.
For a trusted entity, this
parameter should not be
trusted entity, this
parameter must be
provisioned.
RemoteUserName This identifies a user 0, 6..64 Character string ““
within the remote realm.
provisioned. For a non-trusted
entity, this parameter must be
provisioned.
RemotePassword The password for the 6..20 Character string ““
remote user within the
remote realm. For a trusted
entity, this parameter should
not be provisioned. For a non-
trusted entity, this parameter
must be provisioned.
8.19.2 Modify System SIP Entry

This function is used to modify an entry in the system SIP security
table.

WSDL Version
Table 272 Modify System SIP Entry Return Codes

Value
Table 273 Modify System SIP Entry Input Fields (Seite 1 von 3)
A31003-H80A0-T101-1-7618, 11/2021
System SIP Entry

Value
address or a Fully
(FQDN).
TrustedEntity Indicates whether the boolean false, true N/A
entity or not.
Scheme The type of security enum digest-authentication N/A
scheme that is being
release, only the
form of security is
supported.
LocalRealm This identifies the local 0..128 Character string N/A
parameter is not
localhost entry
LocalUserName This identifies a user 0, 6..64 Character string N/A
within the local realm. For
a trusted entity, this
parameter is not
localhost entry
LocalPassword The password for the local 6..20 Character string N/A
user within the local
realm. For a trusted entity,
this parameter should not
be provisioned. For a non-
parameter is not
localhost entry
A31003-H80A0-T101-1-7618, 11/2021
System SIP Entry

Value
RemoteRealm This identifies the remote 0..128 Character string N/A
Note that if the
TrustedEntity parameter is
being modified to false,
this parameter must be
provided.
RemoteUserName This identifies a user 0, 6..64 Character string N/A
Note that if the TrustedEntity
parameter is being modified to
false, this parameter must be
provided.
RemotePassword The password for the 6..20 Character string N/A
remote realm. Note that if
the TrustedEntity parameter is
being modified to false, this
parameter must be provided.
8.19.3 Delete System SIP Entry

This function is used to delete an entry from the system SIP security
table.

WSDL Version
Table 274 Delete System SIP Entry Return Codes

Value
Table 275 Delete System SIP Entry Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
System SIP Entry

Value
address or a Fully
(FQDN).
Table 275 Delete System SIP Entry Input Fields (Seite 2 von 2)
8.19.4 Get System SIP Entry Info

This function is used to retrieve and display a single system SIP
security entry. Table 276 lists the return codes for this method.

WSDL Version
Table 276 Get System SIP Entry Info Return Codes

Value
Entity.
Table 277 Get System SIP Entry Info Input Fields

Value
SipEntityID This identifies the HTTP 0..255 A character string N/A
address or a Fully
(FQDN).
RealmIDType This identifies the HTTP enum Ip N/A
Digest identification type fqdn
being used.
Table 278 Get System SIP Entry Info Output Fields (Seite 1 von 3)
A31003-H80A0-T101-1-7618, 11/2021
System SIP Entry

Value
TrustedEntity Indicates whether the boolean false, true N/A
entity or not.
Scheme The type of security enum digest-authentication N/A
scheme that is being
release, only the
form of security is
supported.
LocalRealm This identifies the local 0..128 Character string N/A
parameter is not
localhost entry
LocalUserName This identifies a user 0, 6..64 Character string N/A
within the local realm. For
a trusted entity, this
parameter is not
localhost entry
LocalPassword The password for the local 6..20 Character string N/A
user within the local
realm. For a trusted entity,
this parameter should not
be provisioned. For a non-
parameter is not
localhost entry
A31003-H80A0-T101-1-7618, 11/2021
System SIP Entry

Value
RemoteRealm This identifies the remote 0..128 Character string N/A
trusted entity, this
parameter must be
provisioned.
RemoteUserName This identifies a user 0, 6..64 Character string N/A
RemotePassword The password for the 6..20 Character string N/A
remote realm.
8.19.5 Get System SIP Entry List

This function is used to retrieve and display the list of existing system
SIP security entries.
The result data contains a list of SIP Entity IDs. For detailed information
about one of the SIP Entity IDs in the list, the GetSystemSIPEntryInfo
operation can be used.

WSDL Version
Table 279 Get System SIP Entry List Return Codes

Value
Table 280 Get System SIP Entry List Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Stat Counter

Value
page 86.
Table 280 Get System SIP Entry List Input Fields
8.20 Stat Counter
8.20.1 Get Stat Counter Info

This function is used to retrieve and display a single RTP Statistics
Counter, including its value and status. Table 281 lists the return codes
for this method.

WSDL Version
Table 281 Get Stat Counter Info Return Codes

Value
CounterName The name of the RTP 1..32 Character string that may required
Statistics Counter to contain only letters, digits,
retrieve. and underscores.
Table 282 Get Stat Counter Info Input Fields

Value
CounterName The name of the RTP 1..32 Character string that may N/A
Statistics Counter. contain only letters, digits,
and underscores.
CounterValue The value of the RTP integer N/A
Statistics Counter.
Table 283 Get Stat Counter Info Output Fields
A31003-H80A0-T101-1-7618, 11/2021
Database Job

Value
CounterStatus An indication of whether Boolean False, True N/A
the RTP Statistics Counter
is active or not.
Table 283 Get Stat Counter Info Output Fields
8.20.2 Get Stat Counter List

This function is used to retrieve and display the list of all RTP Statistics
Counters.
The result data contains a list of RTP Statistics Counter names. For
detailed information about one of the RTP Statistics Counters in the list,
the GetStatCounterInfo operation can be used.

WSDL Version
Table 284 Get Stat Counter List Return Codes

Value
page 86.
Table 285 Get Stat Counter List Input Fields
8.21 Database Job
8.21.1 Create Database Job

This function is used to create a job to initiate a database backup or
restore.
A31003-H80A0-T101-1-7618, 11/2021
Database Job
The response to this request includes a JobId that has been assigned
to the request and can be used later in order to cancel or query this
specific job.

WSDL Version
Table 286 Create Database Job Return Codes

Value
DatabaseJobName Indicates the requested enum backup required
action. restore
DatabaseEntity The name of the database enum all required
component to which the oracle_rtp
job applies. oracle_src
oracle_all
omni
solid
Table 287 Create Database Job Input Fields
8.21.2 Cancel Database Job

This function is used to cancel an existing database backup or restore
job. Table 288 lists the return codes for this method.

WSDL Version
Table 288 Cancel Database Job Return Codes

Value
Table 289 Cancel Database Job Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Database Job

Value
JobId The ID that identifies the integer A valid JobId. required
job to be canceled.
Table 289 Cancel Database Job Input Fields
8.21.3 Delete Database Job

This function is used to delete an existing database backup or restore
job. Table 290 lists the return codes for this method.

WSDL Version
Table 290 Delete Database Job Return Codes

Value
JobId The ID that identifies the integer A valid JobId. required
job to be canceled.
Table 291 Delete Database Job Input Fields
8.21.4 Get Database Job List

This function is used to retrieve and display an existing database
backup or restore job, or a list of such jobs.
If the JobId is provided, the information about only that job is returned;
otherwise, information about the complete list of existing database
jobs is returned.

WSDL Version
Table 292 Get Database Job List Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Database Job

Value
page 86.
JobId The ID that identifies the integer A valid JobId. 0
job to be retrieved.
Table 293 Get Database Job List Input Fields

Value
JobId The ID that identifies the integer A valid JobId. N/A
job.
DatabaseJobName Indicates the requested enum backup required
action. restore
ExecPath Indicates the path to the Character string N/A
job’s executable.
Type A bitmask that describes Character string N/A
the job attributes. The
type may contain one or
more attributes such as:
BASIC (no attributes)
CANCELABLE (job may be
canceled)
SCHEDULABLE (job may
be scheduled)
BLOCK_ON_DONE (job is
blocked when completed)
BLOCK_ON_ERR (job is
blocked when an error
occurs)
TRAP_ON_ERR (trap is
sent when job ends in
error)
WRITES_LOG (log file is
written upon completion of
the job)
AvgRunTime Indicates the estimated Character string N/A
average run time (in
seconds) required for the
job to complete.
Table 294 Get Database Job List Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Calling Location

Value
MaxRunTime Indicates the estimated Character string N/A
maximum run time (in
seconds) required for the
job to complete.
State Indicates whether the job Character string N/A
is:
running
overdue
cancelling
cancelled
done
error
ReportName Indicates the path and Character string N/A
name of the report
generated for this job.
Information contain in a
log is brief.
LogName Indicates the path and Character string N/A
name of the log generated
for this job. Information
contain in a log is detailed.
Not currently supported.
StartTime Indicates the start time of Character string N/A
the job.
StopTime Indicates the stop time of Character string N/A
the job.
DatabaseEntity The name of the database enum all required
component to which the oracle_rtp
job applies. oracle_src
oracle_all
omni
solid
Table 294 Get Database Job List Input Fields (Seite 2 von 2)
8.22 Calling Location
8.22.1 Create Calling Location

This function is used to create a Calling Location. Table 295 lists the
A31003-H80A0-T101-1-7618, 11/2021
Calling Location

WSDL Version
Table 295 Create Calling Location Return Fields

Value
Code The calling location code. Character String required
Name The calling location name. Character String required
Table 296 Create Calling Location Input Fields
8.22.2 Modify Calling Location

This function is used to to modify the name of a Calling Location.

WSDL Version
Table 297 Modify Calling Location Return Fields

Value
Name The calling location name. Character String required
Table 298 Modify Calling Location Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Calling Location
8.22.3 Remove Calling Location

This function is used to delete an existing Calling Location.Table 299

WSDL Version
Table 299 Remove Calling Location Return Fields

Value
Table 300 Remove Calling Location Input Fields
8.22.4 Query Calling Location

This function is used to retrieve and display existing Calling
Locations.Table 301 lists the return codes for this method.

WSDL Version
Table 301 Query Calling Location Return Fields

Value
Specific Indicates whether a Please refer to the paragraph at the beginning of
specific Calling Location is Chapter 8.
being requested, or a list
of Calling Locations.
Table 302 Remove Calling Location Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Origin Destination

Value
page 86.
Code The calling location code. Character String N/A
Table 302 Remove Calling Location Input Fields (Seite 2 von 2)
8.23 Origin Destination
8.23.1 Create Origin Destination

This function is used to create an Origin Destination. Table 303 lists the

WSDL Version
Table 303 Create Origin Destination Return Fields

Value
Name The name of the origin Character String required
destination.
Type The type of origin Enum OrigDestCarrier required
destination. OrigDestMs
OrigDestUndefined
OrigDestIgnored
Table 304 Create Origin Destination Input Fields
8.23.2 Modify Origin Destination

This function is used to modify an Origin Destination.Table 305 lists the
A31003-H80A0-T101-1-7618, 11/2021
Origin Destination

WSDL Version
Table 305 Modify Origin Destination Return Fields

Value
destination to modify.
Type The type of origin enum OrigDestCarrier N/A
destination. OrigDestMs
OrigDestUndefined
OrigDestIgnored
Table 306 Modify Origin Destination Input Fields
8.23.3 Remove Origin Destination

This function is used to delete an existing Origin Destination. Table 307

WSDL Version
Table 307 Remove Origin Destination Return Fields

Value
destination to remove.
Table 308 Remove Origin Destination Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Origin Route
8.23.4 Query Origin Destination

This function is used to retrieve and display existing Origin
Destinations.Table 309 lists the return codes for this method.

WSDL Version
Table 309 Query Origin Destination Return Fields

Value
page 86.
Name The name of the origin Character String N/A
destination to retrieve.
Table 310 Query Origin Destination Input Fields
8.24 Origin Route
8.24.1 Create Origin Route

This function is used to create an Origin Route. Table 311 lists the

WSDL Version
Table 311 Create Origin Route Return Fields
A31003-H80A0-T101-1-7618, 11/2021
Origin Route

Value
OriginDestinationName The name of the origin Character String required
destination with which to
associate the route.
RateAreaName The name of a Rate Area Character String required
with which to associate the
route.
DestinationName The name of the Character String required
destination to which calls
will be translated.
OriginDestinationType The type of origin enum OriginRouteDtIgnored OriginRouteDt
destination. OriginRouteDtUnused Dest
OriginRouteDtDest
OriginRouteDtMediaGatew
ay
Table 312 Create Origin Route Input Fields
8.24.2 Modify Origin Route

This function is used to modify an Origin Route.Table 313 lists the

WSDL Version
Table 313 Modify Origin Route Return Fields

Value
destination associated
with the route.
RateAreaName The name of the Character String N/A
associated Rate Area.
Table 314 Modify Origin Route Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Origin Route

Value
DestinationName The name of the Character String N/A
will be translated.
OriginDestinationType The type of origin enum OriginRouteDtIgnored OriginRouteDt
destination. OriginRouteDtUnused Unused
OriginRouteDtDest
ay
Table 314 Modify Origin Route Input Fields (Seite 2 von 2)
8.24.3 Remove Origin Route

This function is used to delete an existing Origin Route.Table 315 lists

WSDL Version
Table 315 Remove Origin Route Return Fields

Value
destination to remove.
Table 316 Remove Origin Route Input Fields
8.24.4 Query Origin Route

This function is used to retrieve and display existing Origin
Routes.Table 317 lists the return codes for this method.

WSDL Version
Table 317 Query Origin Route Return Fields
A31003-H80A0-T101-1-7618, 11/2021
Get Generic Object Attributes

Value
page 86.
OriginDestinationName The name of the origin Character String N/A
destination associated
with the route.
DestinationName The name of the Character String N/A
will be translated.
OriginDestinationType The type of origin enum OriginRouteDtIgnored N/A
destination. OriginRouteDtUnused
OriginRouteDtDest
ay
Table 318 Query Origin Route Input Fields
8.25 Get Generic Object Attributes

Given an object name, this query returns a list of valid attributes for
that object.Table 319 lists the return codes for this method.

WSDL Version
Table 319 Get Generic Object Attributes Return Fields
A31003-H80A0-T101-1-7618, 11/2021
Get Generic Object Attributes

Value
ObjectName The object for which the 1..64 Character String required
The list of supported list of attributes is representing a supported
objects is as follows: required. object.
E164_DESTINATION
SUBSCRIBER
PREFIX_ACCESS_CODE
MLHG
SUBSCRIBER_SIP_PROF
ILE
BUSINESS_GROUP
COS
DESTINATION
E164_CODE
E164_DN
E164_IP_DESTINATION
E164_ROUTE
ENDPOINT
NUMBER_PLAN
PNP_LOCATION_CODE
PNP_LOCATION_EXTENS
ION
RATE_AREA
FEATURE
ROUTE
CALLING_LOCATION
DEPARTMENT
BG_ATTENDANT_NUM
SUBSCRIBER_BG_DESTI
NATION
PAC_DESTINATION
SUBSCRIBER_BG_ENDP
OINT
SUBSCRIBER_KEYSET_I
NFO
NUMBER_PLAN_EP
Table 320 Get Generic Object Attributes Input Fields

Value
TableRowDescriptions This is an array of elements, each of which describes one attribute of the given
object and has the following fields:
TableRowDescription The name of the attribute. Character String N/A
RowAttributeName
Table 321 Get Generic Object Attributes Output Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Generic Query

Value
TableRowDescription The type of the attribute. enum attrString_ N/A
RowAttributeType attrDate_
attrNumber_
attrUnsigned_
attrFloat_
TableRowDescription The maximum length of integer N/A
RowAttributeLength the attribute.
Table 321 Get Generic Object Attributes Output Fields (Seite 2 von 2)
8.26 Generic Query

Given an object name and a list of attributes, this query returns the
values of those attributes for that object. Optionally, conditions may be
applied so that the data is only returned for those objects that match
the conditions.
Note: by default all the conditions in the array of ConditionObjects are

joined with an “AND”. The parameter ConditionRelationString is
provided in order to allow conditions to be joined with “AND”, “AND
NOT”, or “OR”, as well as to allow condition to be grouped in
parentheses. Each GenericConditionObject is represented in the
ConditionRelationString by its ConditionName, so if
ConditionRelationString is specified in a query, each
GenericConditionObject should have a ConditionName specified. Also
note that the CondtionNames and the join strings (AND/AND NOT/OR)
should be separated by spaces in the ConditionRelationString.

WSDL Version
subRC_APP_DSA_GENERIC_QUERY_DB_ERROR
subRC_APP_DSA_GENERIC_QUERY_INIT_ERROR
subRC_APP_DSA_GENERIC_QUERY_UNKNOWN_OBJECT
subRC_APP_DSA_GENERIC_QUERY_UNKNOWN_ATTRIBUTE
subRC_APP_DSA_GENERIC_QUERY_UNKNOWN_CONDITION_ATTRI
BUTE
subRC_APP_DSA_GENERIC_QUERY_ILLEGAL_OBJECT_NAME
subRC_APP_DSA_GENERIC_QUERY_ILLEGAL_CONDITION
subRC_APP_DSA_GENERIC_QUERY_ILLEGAL_CONDITION_VALUE
subRC_APP_DSA_GENERIC_QUERY_ILLEGAL_RELATION_STRING
Table 322 Generic Query Return Fields
A31003-H80A0-T101-1-7618, 11/2021
Generic Query

Value
page 86.
ObjectName The object for which the 1..64 Character String required
query is to be performed. representing a supported
object. The list of
supported objects is as
follows:
E164_DESTINATION
SUBSCRIBER
PREFIX_ACCESS_CODE
MLHG
SUBSCRIBER_SIP_PROFIL
E
BUSINESS_GROUP
COS
DESTINATION
E164_CODE
E164_DN
E164_IP_DESTINATION
E164_ROUTE
ENDPOINT
NUMBER_PLAN
PNP_LOCATION_CODE
PNP_LOCATION_EXTENSI
ON
RATE_AREA
FEATURE
ROUTE
CALLING_LOCATION
BG_DEPARTMENT
BG_NAME
BG_ATTENDANT_NUM
SUBSCRIBER_BG_DESTIN
ATION
PAC_DESTINATION
SUBSCRIBER_BG_ENDPOI
NT
SUBSCRIBER_KEYSET_IN
FO
NUMBER_PLAN_EP
Table 323 Generic Query Input Fields (Seite 1 von 4)
A31003-H80A0-T101-1-7618, 11/2021
Generic Query

Value
AttributeNames An array of attributes in 1..64 Character String (all)
the object whose value is representing a valid object
to be retrieved and attribute.
displayed. This is an A list of all currently valid
optional parameter, and attribute names for a
the default behavior if no supported object can be
AttributeNames are obtained using the
provided is to return the GetGenericObjectAttribute
values of all attributes. s request (see
Section 8.25). Also note, a
special attribute $COUNT
is available. If this
attribute name is
specified, the query just
returns the number of
elements.
OrderByAttribute This is an optional 1..64 Character String N/A

parameter that the query representing a valid object
results are to be sorted by attribute.
the specified attribute. A list of all currently valid
If not specified the order attribute names for a
of the result will be as supported object can be
present in the database obtained using the
table. GetGenericObjectAttribute
s request (see
Section 8.25).
ResultsInAscendingOrde This parameter applies Boolean True True

r only if the False
OrderByAttribute
parameter is provided,
and indicates whether the
results are to be sorted in
ascending or descending
order. The default is True
(ascending order).
ConditionObjects This is an array of GenericConditionObject elements and is used to specify the
query conditions. This is an optional parameter. If no ConditionObject is specified,
all rows for the given ObjectName are returned. Each GenericConditionObject has
the following fields:
A31003-H80A0-T101-1-7618, 11/2021
Generic Query

Value
ConditionObject An attribute of the object 1..64 Character String N/A
AttributeName to be used in a condition. representing a valid object
attribute.
A list of all currently valid
attribute names for a
supported object can be
obtained using the
GetGenericObjectAttribute
s request (see
Section 8.25). Also note, a
special attribute $COUNT
is available. If this
attribute name is
specified, the query just
returns the number of
elements.
ConditionObject Indicates the logical enum equalTo_ N/A

Logic operation that shall be notqualTo_ greaterThan_
applied using the lesserThan_
AttributeName. in_
like_
greaterThanEqualTo_
lesserThanEqualTo_
ConditionObject The value that shall be 1..1000 Character String N/A
AttributeValue compared with the
provided AttributeName Note:
using the provided Logic If Logic is “like” then the
operation to form this wildcard symbol % can be
condition. present in AttributeValue;
e.g.: “1561%” matches all
values, which begins with
“1561”.
If Logic is “in” - then the

user can specify comma
separated AttibuteValues;
e.g. “15615161008,
15615161009" matches
values “15615161008” &
“15615161009”
Also note:
If a date value is to be
specified, the expected
format is CCYY-MM-
DDThh:mm[:ss]
A31003-H80A0-T101-1-7618, 11/2021
Generic Query

Value
ConditionObject This is an optional 1..64 Character String N/A
ConditionName parameter. It should be
specified only if the The ConditionName can be
ConditionRelationString is any string, “Condition1”
specified. See below for for example, but may not
details on the use of the contain spaces or special
ConditionRelationString characters.
ConditionRelationString This is a string to be 1..1000 Character String N/A
provided if a complex representing a valid
condition is required in the combination of the
query. provided conditions.

Value
NumRows The number of rows of integer N/A
data in the current
response.
TableRowDescriptions This is an array of elements, each of which describes one attribute of the given
object and has the following data:
TableRowDescription The name of the attribute. Character String N/A
RowAttributeName
TableRowDescription The type of the attribute. enum attrString_ N/A
RowAttributeType attrDate_
attrNumber_
attrUnsigned_
attrFloat_
A31003-H80A0-T101-1-7618, 11/2021
Code Process

Value
TableRowValues A two dimensional array of array of N/A
all the requested attribute Character String
values of the given
ObjectName which
matches the given
condition(s). It consists of
an array of TableRow. Each
TableRow has an array of
Attribute values.
All attribute values
irrespective of type are
returned as character
strings.
The position of an
Attribute in the
TableRowDescriptions
matches exactly with the
position of the attribute in
each TableRow. e.g. if
SUBSCRIBER_ID is the 5th
attribute in
TableRowDescriptions, the
value of SUBSCRIBER_ID
is present as the 5th
element in each TableRow.
8.26.1 Generic Query Enhanced

GenericQueryEnhanced shall handle the queries for MLHG,
SUBSCRIBER and PREFIX ACCESS CODE entities. It will act as a
wrapper and use the existing mechanics of GenericQuery. The request
and response structures will be the same with Generic Query
(which means that xml data will be returned as usual). The internal
functionality will add on top of GenericQuery post processing
capabilities on the result set of Generic Query.
8.27 Code Process

The Code Process SOAP requests allow provisioning of the Code
Processing Table. The user is able to create, delete or query a code
processing entry. The modify operation is also allowed after the
creation of the code processing with the precondition that the code
process entry is not being used (referenced).
A31003-H80A0-T101-1-7618, 11/2021
Code Process
In order to create a new code processing entity the user should specify
the digit position that he will start to add or delete digits from the called
number. Then he has the option to delete a number of digits starting
from that position or to add a new digit sequence starting again from
the defined digit position. A code processing entity can contain up to
four operations (additions or deletions) with the precondition that the
maximum number of additions or deletions is two. This means that if a
code processing table contains four entries, then two additions and two
deletions should occur. During the “digit manipulation”, all the entries
for the particular “Code Process” object will apply in the sequence they
are provisioned.
8.27.1 Create Code Process

This SOAP request is used to create a Code Processing entry.

WSDL Version
Table 325 Create Code Process Return Codes

Value
command. Operator Operator ID in Section 5.4.2, “Field
information used for Definitions”, on page 79.
logging.
CodeProcessName This parameter specifies a 1..31 Character string required
user-assigned
alphanumeric string that
identifies the Code
Processing Entry.
Table 326 Create Code Process Input Fields (Seite 1 von 3)
A31003-H80A0-T101-1-7618, 11/2021
Code Process

Value
NatureOfAddress Any valid nature of enum NoaIgnored NoaUnkown
address value. NoaUnused
NoaUnassigned
NoaUndefined
NoaUnkown
NoaSubs
NoaNatl
NoaIntl
NoaLrn
NoaNw
NoaPrfxBased
NoaNoDn
NoaTest
NoaL0
NoaL1
NoaL2
NoaExt
NoaPrfxBasedNoTns
NoaCallingLoc
Retranslate Indicates whether Boolean false false
retranslation will occur. true
For cases where
Retranslate is False, a
DestinationName and
DestinationType must be
provided; if it is True, they
should not be provided.
DestinationName A name identifying a 0..64 Character string ““
destination.
DestinationType This attribute is only valid enum DestCodeDtIgnored N/A
if Retranslate is False. It is DestCodeDtUnused
allowed for E164 codes. DestCodeDtNone
DestCodeDtDest
DestCodeDtSvc
DestCodeDtHomeDn
DestCodeDtEnum
DestCodeDtIntcpt
DestCodeDtTod
NumberOfOperations The number of code integer 1..4 N/A
processing entries in the
following list.
OperationList An array of CodeOperation elements, each containing the following attributes:
(CodeOperation) The index position in the integer 0..31 (for DigitsToInsert) 0
DigitPosition called number string at
which to start to insert or OR
delete digits.
1..32 (for DigitsToDelete)
A31003-H80A0-T101-1-7618, 11/2021
Code Process

Value
(CodeOperation) An alphanumeric string 0..30 Character string ““
DigitsToInsert that identifies the digits to
be added starting at
DigitPosition.
Supported characters are
A-F, 0-9, # and *.
Note that both Insert and
Delete are not possible in
the same entry.
(CodeOperation) The number of digits to integer 0..31 0
DigitsToDelete delete starting at
DigitPosition.
8.27.2 Modify Code Process

This SOAP request is used to modify an existing Code Processing entry.

WSDL Version
Table 327 Modify Code Process Return Codes

Value
user-assigned
identifies the Code
Processing Entry.
NewName The new name of a 1..31 Character String optional
CodeProcess
Table 328 Modify Code Process Input Fields (Seite 1 von 3)
A31003-H80A0-T101-1-7618, 11/2021
Code Process

Value
NatureOfAddress Any valid nature of enum NoaIgnored N/A
address value. NoaUnused
NoaUnassigned
NoaUndefined
NoaUnkown
NoaSubs
NoaNatl
NoaIntl
NoaLrn
NoaNw
NoaPrfxBased
NoaNoDn
NoaTest
NoaL0
NoaL1
NoaL2
NoaExt
NoaPrfxBasedNoTns
NoaCallingLoc
Retranslate Indicates whether Boolean false N/A
retranslation will occur. true
For cases where
Retranslate is False, a
DestinationName and
DestinationType must be
provided; if it is True, they
should not be provided.
DestinationName A name identifying a 0..64 Character string N/A
destination.
DestinationType This attribute is only valid enum DestCodeDtIgnored N/A
if Retranslate is False. It is DestCodeDtUnused
allowed for E164 codes. DestCodeDtNone
DestCodeDtDest
DestCodeDtSvc
DestCodeDtHomeDn
DestCodeDtEnum
DestCodeDtIntcpt
DestCodeDtTod
NumberOfOperations The number of code integer 1..4 N/A
processing entries in the
following list.
OperationList An array of CodeOperation elements, each containing the following attributes:
(CodeOperation) The index position in the integer 0..31 (for DigitsToInsert) N/A
DigitPosition called number string at
which to start to insert or OR
delete digits.
1..32 (for DigitsToDelete)
A31003-H80A0-T101-1-7618, 11/2021
Code Process

Value
(CodeOperation) An alphanumeric string 0..30 Character string N/A
DigitsToInsert that identifies the digits to
be added starting at
DigitPosition.
Supported characters are
A-F, 0-9, # and *.
Note that both Insert and
Delete are not possible in
the same entry.
(CodeOperation) The number of digits to integer 0..31 N/A
DigitsToDelete delete starting at
DigitPosition.
8.27.3 Remove Code Process

This SOAP request is used to delete an existing Code Processing entry.

WSDL Version
Table 329 Remove Code Process Return Codes

Value
user-assigned
identifies the Code
Processing Entry.
Table 330 Remove Code Process Input Fields
8.27.4 Query Code Process

This SOAP request is used to retrieve and display existing Code
Processing entries.
A31003-H80A0-T101-1-7618, 11/2021
Code Process

WSDL Version
Table 331 Query Code Process Return Codes
Field Definition Description Length Range/Values Default

Value
Specific Indicates whether a Please refer to the note at the beginning of Chapter 8.
specific object or a list of
objects is being requested.
page 86.
CodeProcessName This parameter specifies a 1..31 Character string ““
user-assigned
identifies the Code
Processing Entry.
Table 332 Query Code Process Input Fields
The output fields for this method are the same as the input fields for
the Create Code Process SOAP request. Please refer to Section 8.27.1,
“Create Code Process” for details.
8.27.5 List Code Process

This SOAP request is used to retrieve a list of existing Code Processing
entries.

WSDL Version
Table 333 List Code Process Return Codes
Table 334 lists the input fields for this method. The output of the
request consists of a list of CodeProcess elements.
A31003-H80A0-T101-1-7618, 11/2021
ENUM Provisioning

Value
specific object is being
requested, or a list of
objects.
page 86.
CodeProcessName This parameter specifies a 1..31 Character string ““
user-assigned
identifies the Code
Processing Entry.
Table 334 List Code Process Input Fields
8.28 ENUM Provisioning

The ENUM (E164 (or TElephone) NUmber Mapping) system is used to
convert telephone numbers into service specific URIs via DNS lookup.
This mechanism allows the routing of calls to other networks through
IP-based means instead of through the PSTN.
Through the SOAP interface, the configuration of two ENUM related

objects are supported: ENUM Server and Operator ENUM.
8.28.1 Create Enum Server

This SOAP request is used to create an ENUM Server entry. Note that
a maximum of six (6) ENUM Servers may be created.

WSDL Version
Table 335 Create Enum Server Return Codes
A31003-H80A0-T101-1-7618, 11/2021
ENUM Provisioning

Value
EnumServerName A unique name identifying 1..31 Character string required
an ENUM server.
PrimaryIpAddress The primary IP address of 1..260 Character string required
the ENUM server.
SecondaryIpAddress The secondary IP address 1..260 Character string ““
of the ENUM server.
CacheSize The size of the ENUM integer 0..10 1
server’s cache, in
multiples of 1 MB.
Table 336 Create Enum Server Input Fields
8.28.2 Modify Enum Server

This SOAP request is used to modify an ENUM Server entry.

WSDL Version
Table 337 Modify Enum Server Return Codes

Value
an ENUM server.
NewName The new name of the 1..31 Character string optional
Enum Server
PrimaryIpAddress The primary IP address of 1..260 Character string required
the ENUM server.
of the ENUM server.
Table 338 Modify Enum Server Input Fields
A31003-H80A0-T101-1-7618, 11/2021
ENUM Provisioning

Value
multiples of 1 MB.
Table 338 Modify Enum Server Input Fields
8.28.3 Remove Enum Server

This SOAP request is used to delete an existing ENUM Server entry.

WSDL Version
Table 339 Remove Enum Server Return Codes

Value
an ENUM server.
Table 340 Remove Enum Server Input Fields
8.28.4 Query Enum Server

This SOAP request is used to retrieve and display existing ENUM Server
entries.

WSDL Version
Table 341 Query Enum Server Return Codes
A31003-H80A0-T101-1-7618, 11/2021
ENUM Provisioning

Value
page 86.
QryEnumServer A structure containing the following attributes, any of which may be provided as
filter criteria for the query.
EnumServerName A unique name identifying 1..31 Character string ““
an ENUM server.
PrimaryIpAddress The primary IP address of 1..260 Character string ““
the ENUM server.
of the ENUM server.
multiples of 1 MB.
Table 342 Query Enum Server Input Fields
the Create Enum Server SOAP request. Please refer to Section 8.28.1
for details.
8.28.5 List Enum Server

This SOAP request is used to retrieve a list of existing ENUM Server
entries.

WSDL Version
Table 343 List Enum Server Return Codes
A31003-H80A0-T101-1-7618, 11/2021
ENUM Provisioning

Value
objects.
page 86.
LstEnumServer A structure containing the following attributes, any of which may be provided as
EnumServerName A unique name identifying 1..31 Character string ““

an ENUM server.
PrimaryIpAddress The primary IP address of 1..260 Character string ““
the ENUM server.
of the ENUM server.
multiples of 1 MB.
Table 344 List Enum Server Input Fields
The output of the request consists of a list of ENUM Server elements.
8.28.6 Create Operator Enum

This SOAP request is used to create an ENUM Server entry. Note that
a maximum of six (6) ENUM Servers may be created.

WSDL Version
Table 345 Create Operator Enum Return Codes
A31003-H80A0-T101-1-7618, 11/2021
ENUM Provisioning

Value
OperatorEnumName A unique name identifying 1..15 Character string required
an operator ENUM.
OperatorEnumTier0Zone A unique name identifying 1..64 Character string required
Name an operator ENUM.
EnumServerName The name of an ENUM 1..31 Character string required
server.
Table 346 Create Operator Enum Input Fields
8.28.7 Modify Operator Enum

This SOAP request is used to modify an Operator ENUM entry.

WSDL Version
Table 347 Modify Operator Enum Return Codes

Value
an operator ENUM.
New The new name of a 1…15 Character string optional
OperatorEnumName Operator Enum
OperatorEnumTier0Zone A unique name identifying 1..64 Character string required
EnumServerName The name of an ENUM 1..31 Character string required
server.
OperatorEnumUpdateFla A bitmap attribute that integer Character string required
gs indicates which fields are
being modified.
Table 348 Modify Operator Enum Input Fields
A31003-H80A0-T101-1-7618, 11/2021
ENUM Provisioning
8.28.8 Remove Operator Enum

This SOAP request is used to delete an existing Operator ENUM entry.

WSDL Version
Table 349 Remove Operator Enum Return Codes

Value
an operator ENUM.
Table 350 Remove Operator Enum Input Fields
8.28.9 Query Operator Enum

This SOAP request is used to retrieve and display existing Operator
ENUM entries.

WSDL Version
Table 351 Query Operator Enum Return Codes

Value
Table 352 Query Operator Enum Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
ENUM Provisioning

Value
page 86.
QryOperatorEnum A structure containing the following attributes, any of which may be provided as
OperatorEnumName A unique name identifying 1..15 Character string ““
an operator ENUM.
OperatorEnumTier0Zone A unique name identifying 1..64 Character string ““
EnumServerName The name of an ENUM 1..31 Character string ““
server.
Table 352 Query Operator Enum Input Fields (Seite 2 von 2)
the Create Operator Enum SOAP request. Please refer to Section
8.28.6, “Create Operator Enum” for details.
8.28.10 List Operator Enum

This SOAP request is used to retrieve a list of existing Operator ENUM
entries.

WSDL Version
Table 353 List Operator Enum Return Codes

Value
objects.
Table 354 List Operator Enum Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
File System Backup

Value
page 86.
LstOperatorEnum A structure containing the following attributes, any of which may be provided as
OperatorEnumName A unique name identifying 1..15 Character string ““
an operator ENUM.
OperatorEnumTier0Zone A unique name identifying 1..64 Character string ““
EnumServerName The name of an ENUM 1..31 Character string ““
server.
Table 354 List Operator Enum Input Fields (Seite 2 von 2)
The output of the request consists of a list of Operator ENUM elements.
8.29 File System Backup
8.29.1 Create File System Backup

This function is used to request a file system backup. An interface with
the Maintenance Manager component of the system is used to perform
the operation and a Job ID is returned to the operator so that the status
of the backup operation can be queried.

WSDL Version
subRC_APP_DSA_FSBACKUP_NODEID_INVALID
subRC_APP_DSA_FSBACKUP_CREATE_FAILED
subRC_APP_DSA_FSBACKUP_REMOTEIPADDRESS_INVALID
subRC_APP_DSA_FSBACKUP_USERLOGIN_INVALID
subRC_APP_DSA_FSBACKUP_USERPASSWD_INVALID
subRC_APP_DSA_FSBACKUP_REMOTEDIR_INVALID
Table 355 Create File System Backup Return Codes
A31003-H80A0-T101-1-7618, 11/2021
File System Backup

command. Operator ID in Section 5.4.2,
“Field Definitions”, on page 79.
NodeId The host name of the node 1..16 Character string required
being addressed
FSRetrievalMethod An enumerated value enum FSB_pull FSB_pull
describing how the backup FSB_push
file is to be handled.
If FSB_pull is selected, the
data will remain on the
local host machine for
retrieval.
If FSB_push is selected,
the additional parameters
below must be provided.
RemoteIPAddress The IP address of the 1..24 Character string ““
remote location to which
the backup file should be For FSB_push, this
sent. parameter is
mandatory; for
FSB_pull, this
parameter is not
allowed.
FSRemoteProtocol The protocol by which the enum FSB_sftp FSB_sftp
backup file is to be FSB_ftp
transferred to the For FSB_pull, this
RemoteIPAddress. parameter is not
allowed.
UserLogin The login ID of the user to 1..24 Character string ““
access the remote host.
For FSB_push, this
parameter is
mandatory; for
FSB_pull, this
parameter is not
allowed.
UserPassword The password of the user 1..24 Character string ““
to access the remote host.
For FSB_push, if
FSRemoteProtocol is
FSB_ftp; otherwise
this parameter is not
allowed.
Table 356 Create File System Backup Input FIelds (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
File System Backup

RemoteDirectory The directory on the 1..1024 Character string ““
remote host in which the
backup file is to be placed. For FSB_push, this
parameter is
mandatory; for
FSB_pull, this
parameter is not
allowed.
Table 356 Create File System Backup Input FIelds (Seite 2 von 2)
8.29.2 Cancel File System Backup

This function is used to cancel a previously requested file system
backup. An interface with the Maintenance Manager component of the
system is used to perform the operation.

WSDL Version
subRC_APP_DSA_FSBACKUP_CANCEL_FAILED
Table 357 Cancel File System Backup Return Codes

Value
being addressed
JobId A Job ID identifying the file integer any valid integer value required
system backup operation
that is to be canceled.
Must match the value that
was returned from the
original request to perform
the operation.
Table 358 Cancel File System Backup Input FIelds
A31003-H80A0-T101-1-7618, 11/2021
File System Backup
8.29.3 Query File System Backup

This function is used to retrieve the status of a previously requested file
system backup. An interface with the Maintenance Manager component
of the system is used to perform the operation.

WSDL Version
subRC_APP_DSA_FSBACKUP_QUERY_FAILED
subRC_APP_DSA_MEMORY_ALLOCATION_ERROR
Table 359 Query File System Backup Return Codes

Value
Paging The standard paging input Please refer to Section 5.5, N/A
structure. “Paging”, on page 86.
being addressed
JobId A Job ID identifying the file integer any valid integer value required
system backup operation
that is to be queried. Must
match the value that was
returned from the original
request to perform the
operation.
Table 360 Query File System Backup Input Fields

Value
PaginatedInfo The standard paging For details, refer to Section 5.5, N/A
output structure. “Paging”, on page 86.
FileSystemJobList A list of FileSystemJobEntry elements, each consisting of the following attributes:
(FileSystemJobEntry) A Job ID identifying the file integer any valid integer value N/A
JobId system backup operation
being queried.
Table 361 Query File System Backup Output Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
File System Backup

Value
(FileSystemJobEntry) Absolute path to the system Character string N/A
ExecPath executable (usually a shell dependent
script).
(FileSystemJobEntry) Flags that provide 1..256 Character string N/A
Type information about the
job’s attributes. For the file
system backup job), the
flags indicate that the job
can be cancelled, can be
scheduled, creates a log
file and traps on an error.
(FileSystemJobEntry) The average time that the 1..20 Character string N/A
AvgRunTime job is expected to take. For
the file system backup job,
this is 3600, and this is
intended only as a guide
for the operator.
(FileSystemJobEntry) The maximum time that 1..20 Character string N/A
MaxRunTime the job is expected to
take. For the file system
backup job, this is 14400,
and this is intended only
as a guide for the operator.
(FileSystemJobEntry) The state of the job - 1..256 Character string N/A
State normally one of the
following:
RUNNING,
DONE,
CANCELLED or
ERROR.
(FileSystemJobEntry) The file name for the system Character string N/A
ReportName report file for the job. dependent
(FileSystemJobEntry) The file name for the log system Character string N/A
LogName file for the job. This file dependent
should be referred to if the
job has a state of ERROR
as it will indicate what the
error is.
(FileSystemJobEntry) Start time of job. 1..26 Character string N/A
StartTime
(FileSystemJobEntry) Stop time of job. 1..26 Character string N/A
StopTime
(FileSystemJobEntry) Arguments passed to 1..1024 Character string N/A
MArgs executable to execute a
job.
Table 361 Query File System Backup Output Fields (Seite 2 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Get DB Version
8.30 Get DB Version
8.30.1 Get DB Version Info

Database versioning in the OpenScape Voice system database is a
means to validate if a database restore can be performed from a
database backup file. The restore is allowed to be executed if the
database version of the OpenScape Voice system database and the
database version of the database backup file are an exact match. The
database version is a combination of the software release ID combined
with the database iteration number (i.e ReleaseId.DbId). Each time
the database is modified and delivered by means of a software build or
a patch, the database version is incremented. This takes place for the
entire lifecycle of the release. The software release ID stays constant
throughout the entire lifespan of the software release regardless of
what build ID is applied to the release. Once a new release is
established, a new version ID is associated with that new release.
Database iteration IDs are incremented from the starting point of that
release.
When a database backup is taken the database version is put into the
backup file so that a comparison can be made to the OpenScape Voice
system database should a database restore take place. When a
database restore is performed the restore script will first check to see
that the database version of the backup file and the database version
of the OpenScape Voice system are an exact match. If the versions are
not an exact match, the restore will be rejected.

WSDL Version
Table 362 Get DB Version Info Return Codes

Value
command. Operator ID in Table 10 in Section 5.4,
“Primitive Data Definitions” .
Table 363 Get DB Version Info Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Endpoint Location
8.31 Endpoint Location

This function is used to provision an Endpoint Location. The endpoint
Location expresses the geographical location of an endpoint. Once
created it can be associated with an NNI Endpoint.
8.31.1 Create Endpoint Location
Field Name Description Mandator Length Range Default

y Value
OperatorId The operator issuing the No 1..40 Character String N/A
command.
EndpointLocationNam The endpoint location No 1….20 Character String N/A
e name
EndpointLocationCode The endpoint location No 1…8 Character String N/A
Table 364 Create Endpoint Location Input Fields
8.31.2 Modify Endpoint Location

y Value
command.
e name
Table 365 Modify Endpoint Location Input Fields
8.31.3 Query Endpoint Location

y Value
command.
e name
Table 366 Query Endpoint Location Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Endpoint Provider

y Value
“The Interface WSDL
and Interface Release
Control”, on page 73
OperatorID The operator issuing the No 1..40 Character String N/A
command
Specific Indicates whether a
specificEndpoint
Location is
beingrequested, or a list
of EndpointLocations.
PageSize Paging Standard paging
structure forqueries.
QryEndpointLocationE The name of the No 1…20 Character String N/A
ndpointLocationName endpoint location
QryEndpointLocationE The code of the No 1…8 Character String N/A
ndpointLocationCode endpoint location
Table 366 Query Endpoint Location Input Fields
8.31.4 Remove Endpoint Location

y Value
command.
e name
Table 367 Remove Endpoint Location Input Fields
8.32 Endpoint Provider

This function is used to provision an Endpoint Provider. The endpoint
Provider expresses the telecom service provider for a NNI Endpoint.
Note that once a Provider is created it can be associated with an NNI
Endpoint only if the NNIType of the specific Endpoint is set to
PSTNGateway.
A31003-H80A0-T101-1-7618, 11/2021
Endpoint Provider
8.32.1 Create Endpoint Provider

Value
OperatorId The operator issuing the 1..40 Character String
command.
EndpointProviderName The name of the Endpoint 1…12 Character String N/A
Provider
Table 368 Create Endpoint Provider Input Fields
8.32.2 Modify Endpoint Provider

Value
command.
OldEndpointProviderNam The old name of the 1…12 Character String N/A
e Endpoint Provider
NewEndpointProviderNa The new name of the 1…12 Character String N/A
me Endpoint Provider
Table 369 Modify Endpoint Provider Input Fields
8.32.3 Query Endpoint Provider

Value
on page 73
OperatorId The operator issuing the 1…40 Character String
command
Specific Indicates type of query. If
True,the request is for a
specificEndpoint Provider;
if its is set to False
allEndpoint Provider shall
be returned.
Table 370 Query Endpoint Provider Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Endpoint Provider

Value
Listrequests. For
moreinformation, refer to
page 86
QryEndpointProvider- The name of the Endpoint 1…12 Character String N/A
EndpointProviderName Provider
Table 370 Query Endpoint Provider Input Fields
8.32.4 Remove Endpoint Provider

Value
command.
EndpointProviderName The name of the Endpoint 1…12 Character String N/A
Provider
Table 371 Remove Endpoint Provider Input Fields
A31003-H80A0-T101-1-7618, 11/2021
soap_ext_interfaces_sub.fm
Subscriber
Create Subscriber
9 Subscriber
Subscribers are identified by their DN. The subscriber may have many
attributes and the following methods are used to manipulate the
subscriber and any of their attributes.
9.1 Create Subscriber


WSDL
Version
subRC_APP_SUB_LEN_INVALID
subRC_APP_SUB_DN_INVALID
subRC_APP_SUB_BILLING_ID_LEN_INVALID
subRC_APP_BG_LINE_NAME_LEN_INVALID
subRC_APP_BG_EXTENSION_LEN_INVALID
subRC_APP_BG_EXTENSION_INVALID
subRC_APP_BG_DEPT_NAME_LEN_INVALID
subRC_APP_SUB_ACCOUNT_LEN_INVALID
subRC_APP_SUB_ACC_USER_INFO_PIN_LEN_INVALID
subRC_APP_SUB_ACC_USER_INFO_PIN_INVALID
subRC_APP_SUB_ACC_USER_INFO_PUBLIC_PIN_LEN_INVALID
subRC_APP_SUB_ACC_USER_INFO_PUBLIC_PIN_INVALID
subRC_APP_SUB_USER_INFO_DISPLAY_NAME_OUT_OF_RANGE
subRC_APP_UTIL_LANG_LEN_INVALID
subRC_APP_UTIL_LANG_NOT_ALLOWED
subRC_APP_SUB_RETAILER_ID_LEN_INVALID
subRC_APP_SUB_STATUS_EXPORT_NOT_ALLOWED
subRC_APP_SUB_INTERCEPT_NEW_SERVICE_CONFLICT
subRC_APP_SUB_DN_EXIST
subRC_APP_SUB_HOME_DN_DOES_NOT_EXIST
subRC_DB_SUB_HOME_DN_LOOKUP_FAILED
subRC_APP_SUB_HOME_DN_ALREADY_ALLOCATED
subRC_APP_SUB_HOME_DN_REUSE_NOT_ALLOWED
subRC_APP_SUB_INTERCEPT_CONNECTION_CONFLICT
subRC_APP_SUB_NEW_SERVICE_ID_CONNECTION_CONFLICT
subRC_APP_SUB_RCF_CONNECTION_CONFLICT
subRC_APP_EP_PROFILE_LEN_INVALID
subRC_DB_XDM_EP_LOOKUP_FAILED
subRC_APP_EP_SIP_CONNECTION_INVALID
subRC_APP_EP_SIP_SIGNALING_IP_ADDRESS_INVALID
Table 372 Create Subscriber Return Codes (Seite 1 von 4)
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Create Subscriber

WSDL
Version
subRC_APP_EP_SIP_SIGNALING_PORT_INVALID
subRC_APP_EP_SIP_REG_TYPE_INVALID
subRC_APP_EP_LATADigit_LEN_INVALID
subRC_APP_EP_LATADigit_INVALID
subRC_APP_EP_PROFILE_EXIST
subRC_APP_EP_REG_TYPE_INVALID
subRC_APP_EP_IP_LEN_INVALID
subRC_APP_EP_IP_INVALID
subRC_APP_EP_PORT_INVALID
subRC_APP_EP_STATIC_REG_TYPE_NOT_ALLOWED
subRC_APP_EP_SIP_DYNAMIC_IP_CONFLICT
subRC_APP_EP_PRE_REG_TYPE_DYNAMIC_CONFLICT
subRC_APP_EP_SIP_MAX_SESSIONS_INVALID
subRC_DB_EP_SIP_XDM_ALIAS_LOOKUP_FAILED
subRC_APP_EP_SIP_XDM_ALIAS_EXIST
subRC_APP_EP_SIP_SECURITY_SCHEME_MISSING
subRC_APP_EP_SIP_REALM_LEN_INVALID
subRC_APP_EP_SIP_USER_NAME_LEN_INVALID
subRC_APP_EP_SIP_PASSWORD_LEN_INVALID
subRC_APP_EP_SIP_SECURITY_MISSING
subRC_APP_SUB_IP_ATTRIBUTES_CONFLICT
subRC_APP_EP_ALIAS_LEN_INVALID
subRC_DB_COMM_RTM_LOOKUP_FAILED
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Create Subscriber

WSDL
Version
subRC_APP_EP_VOIP_MISSING
subRC_APP_EP_56QOS_INVALID
subRC_APP_EP_QOS_QOSPROFILE_CONFLICT
subRC_APP_QOS_PROFILE_LEN_INVALID
subRC_APP_EP_QOSPRIM_MISSING
subRC_APP_EP_PRIM_PKT_CABLE_DYNAMIC_QOS_DATA_MISSING
subRC_APP_EP_SEC_PKT_CABLE_DYNAMIC_QOS_DATA_MISSING
subRC_APP_EP_QOSTHRD_QOSSEC_CONFLICT
subRC_APP_EP_QOSTHRD_QOS4TH_CONFLICT
subRC_APP_EP_QOS4TH_QOS5TH_CONFLICT
subRC_APP_EP_THRD_PKT_CABLE_DYNAMIC_QOS_DATA_MISSING
subRC_APP_EP_4TH_PKT_CABLE_DYNAMIC_QOS_DATA_MISSING
subRC_APP_SUB_USER_INFO_TIME_ZONE_INVALID
subRC_DB_SUB_USER_INFO_TIME_ZONE_LOOKUP_FAILED
subRC_DB_BG_LOOKUP_FAILED
subRC_APP_BG_SUB_OUT_OF_RANGE
subRC_APP_BG_CPU_ID_INVALID
subRC_APP_BG_CPU_ID_BG_ID_MISSING
subRC_DB_BG_NUMBER_CPU_LOOKUP_FAILED
subRC_APP_BG_CPU_SUB_OUT_OF_RANGE
subRC_APP_SUB_BG_NAME_MISSING
subRC_APP_BG_EXTENSION_BG_NAME_MISSING
subRC_APP_BG_ATT_NUM_BG_NAME_MISSING
subRC_DB_BG_ATT_NUM_INSERTION_FAILED
subRC_APP_BG_DEPT_BG_NAME_MISSING
subRC_DB_BG_DEPT_DOES_NOT_EXIST
subRC_DB_SUB_PIC_LOOKUP_FAILED
subRC_APP_EP_T38_ECH_CAN_CONFLICT
subRC_APP_QOS_PROFILE_SUB_CONFLICT
subRC_APP_EP_QOSPRIM_PACK_PER_INVALID
subRC_APP_EP_QOSCLASS_QOSVALUE_INVALID
subRC_APP_EP_QOSSEC_PACK_PER_INVALID
subRC_APP_EP_QOSSEC_TOS_INVALID
subRC_APP_EP_QOSTHRD_PACK_PER_INVALID
subRC_APP_EP_QOSTHRD_TOS_INVALID
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Create Subscriber

WSDL
Version
subRC_APP_EP_QOS4TH_PACK_PER_INVALID
subRC_APP_EP_QOS4TH_TOS_INVALID
subRC_APP_EP_CODEC_PACK_PER_INVALID
subRC_APP_FP_NAME_LEN_INVALID
subRC_APP_SUB_NUM_SUBSCRIBER_OUT_OF_RANGE
subRC_DB_SUB_INSERTION_FAILED
subRC_APP_SUB_NUM_SUBSCRIBER_OUT_OF_RANGE
subRC_APP_EP_NUMBER_SUB_OUT_OF_RANGE
subRC_DB_EP_INSERTION_FAILED
subRC_APP_EP_SIP_SECURITY_NUMBER_OUT_OF_RANGE
subRC_DB_EP_SIP_SEC_INSERTION_FAILED
subRC_DB_COMM_RTM_CREATION_FAILED
subRC_DB_SUB_XDM_UNASSIGN_FAILED
subRC_DB_SUB_XDM_ASSIGN_FAILED
subRC_APP_SUB_FP_PROPAGATION_FAILED
subRC_APP_SUB_CREATION_CPU_FAILED
subRC_APP_SUB_KEYSET_NUMBER_OUT_OF_RANGE
subRC_DB_SUB_KEYSET_INSERTION_FAILED
subRC_APP_SUB_USER_INFO_UNICODE_DISPLAY_NAME_OUT_OF_RAN
GE
subRC_APP_UNICODE_BG_LINE_NAME_LEN_INVALID
subRC_APP_NOT_ALLOWED_SETTING_CPU_TO_MOBILEDN
subRC_APP_NOT_ALLOWED_SETTING_KEYSET_TO_MOBILEDN
subRC_APP_SUB_MOBL_RING_DUR_INVALID
subRC_APP_SUB_MAIN_RING_DUR_INVALID
subRC_APP_SUB_CELL_RING_DUR_INVALID
subRC_APP_FEATURES_AND_OSMO_CONFLICT
subRC_APP_FEATURE_PROFILE_OSMO_CONFLICT
subRC_APP_SUB_OSMO_FP_CONFLICT
subRC_APP_SUB_OSMO_CPG_MEMBER_CONFLICT
subRC_APP_SUB_OSMO_COM_MEMBER_CONFLICT
subRC_APP_SUB_OSMO_EA_MEMBER_CONFLICT
subRC_APP_SUB_OSMO_KEYSET_CONFLICT
subRC_APP_OSMO_TLS_CONFLICT
subRC_APP_OSMO_EXTERNAL_DN_FLAG_CONFLICT
subRC_APP_EP_INSECURE_REFERRED_BY_HEADER_OSMO_CONFLICT
subRC_APP_SUB_ROUTETOCELL_CELLDEVICENUMBER_CONFLICT
Table 373 lists and describes the CreateSubscriber fields. Included are
the Length, Range/Values, and Default Values for each field.
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Create Subscriber

Value
“Primitive Data Definitions”, on page
78.
ServiceId Please refer to Section 5.4, required
78.
AccountMgtInfo
Account ID Used only for auditing and aiding the 1..20 Character string. ““
telco in identifying the subscriber.
This is an optional parameter and
there is no default
Billing ID A DN to which charges are assigned Please refer to Section 5.4, “Primitive ““
in the generated CDRs. It is optional Data Definitions”, on page 78.
and if not present, the subscriber's
DN is used.
Retailer Id Used as an auditing field for the 1..16 Character string. ““
telco to help the customer identify
the owner of the subscriber. The
retailer is optional and there is no
default as part of the subscriber
definition. The value is not required
to match data in the Retailer/Carrier
table.
COS (Class of Outgoing calls are routed using the 1..15 Character string ““
Service) Class of Service. During routing, if a representing any existing
subscriber belongs to a class of ClassOfService.1
service, those routes are given
preference; otherwise, the switch’s
default class of service (unassigned)
is used. If the subscriber has no
Class of Service assigned, the
subscriber can access default routes
only. Subscribers with COS specified
will access COS routes first (if
defined for the call that they make),
if none are available, the default
COS routes will be used.
Table 373 Create Subscriber Field Definitions (Seite 1 von 16)
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Create Subscriber

Value
RateArea The subscriber can belong to a 1..15 Character string ““
specific Rate Area. This Rate Area representing any existing
defines what constitutes a local call RateArea.2
verses a long distance call, as well
as the routing for outbound calls.
Outgoing calls are routed using the
Rate Area. During routing, if a
otherwise, the switch’s default rate
area (unassigned) is used. If the
subscriber has no Rate Area
assigned, the subscriber can access
default routes only.
TestLineFlag Indicates whether the line is a test Boolean True, False False
line. Outbound calls do not behave
any differently from non-test lines
except that the test line indication is
set in the calling party category
(SS7 message). CDRs will be
generated but there should be no
charges generated for the call.
Supported in Japan only.
Support Removed in V8
ExternalDN Indicates that the subscriber DN is a Boolean True, False True
Flag Direct Inward Dialing (DID) number. Must be true when
The subscriber can receive direct subscriber is OSMO.
incoming calls. If the External DN
Flag is set to False, the BGL has a
private (non-external) number. This
means the number cannot be dialed
from outside of the BG and is not
displayed as a calling party on calls
directed outside the BG.
Note that this flag is also used by
the MLHG service when an MLHG
member originates a call. If True,
the terminal’s own data is used as
the calling party; otherwise, the
Pilot DN’s data is used.
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Create Subscriber

Value
CountryCode To support international dialing and integer 1..4 N/A
Len multiple countries being served by
the same OpenScape Voice system,
the country code will be part of the
subscriber DN. The country code is
required to be created as part of the
office code in the Home Dn. The
subscriber country code length must
match the office code country code
length. The format and valid range
are controlled by the RTP
parameters specified by the
SrxDigitLen.parm file.
The Country Code Length is
automatically retrieved from the
HomeDn and assigned to the
subscriber during subscriber
creation. Therefore, it is no longer
an input parameter. It cannot be
modified and will be displayed as
part of the subscriber information.
CallingLoc Indicates the subscriber’s location. 1..15 Any existing Calling ““
Used for routing emergency calls to Location.3
the answering point that serves the
Calling Location.
FeatureProfile Identifies the subscriber’s Feature For further details, see definition of ““
Id, FeatureProfile Profile, a defined set of features that FeatureProfileName in Section 5.4,
Name is inherited by the subscriber by “Primitive Data Definitions”, on page
virtue of association with the 78.
Feature Profile.
FeatureProfile The name of the Business Group For further details, see definition of ““
Id, BGName with which the Feature Profile is BGName in Section 5.4, “Primitive Data
associated. A key field for Definitions”, on page 78.
identification of a Feature Profile.
It must be the same as the
subscriber’s BGName
NumberPlanName The name of the Private Numbering 1..31 Character string. ““
Plan to associate with this BGL. If
none is provided, this BGL uses the
BG’s numbering plan.
For residential subscribers, only the
system default numbering plan
applies.
ExternalCallerID Char 15 N/A
array (1…15)
UseMainPilotDN boolean True false
False
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Create Subscriber

Value
ImpactLevel The security zone of a subscriber. enumerat ImpactLevelZero,
WSDL V7.00.15.01 ion ImpactLevelOne,
ImpactLevelTwo,
ImpactLevelThree,
ImpactLevelFour,>
ImpactLevelFive,
ImpactLevelSix,
ImpactLevelSeven,
ImpactLevelEight
ImpactLevelNine
ImpactLevelUnclassified
SubscriberBGInfo
BGName Business Group Name: optional for 0..30 Up to 30 characters, required
this request. For further details, see including apostrophes,
Section 5.4, “Primitive Data commas, and other special
Definitions”, on page 78. characters.
BGLineName Business Group Line Name is the 0..20 Character string ““
subscriber member name.
UnicodeBGLineNa A BG Line name for use in markets 1..24 Wide character string. ““
me such as China where multi-byte
characters are allowed.
BGAttendant A business group attendant number Boolean True, False False
Number flag indicates the DN is used for the
Attendant Number function of the
Business Group.
CpuId A Call Pickup group Id to which this integer 1..10000 0 (no CPU
subscriber (BGL) belongs. There can Id)
be only one CPU group ID per
subscriber. The CfCPU service must
be provisioned either by explicit
assignment or Feature Profile
inheritance in order for the CPU
service to be effective. A value of 0
indicates that the subscriber is not
part of any CPU.
CpuName Character string
Extension This field indicates the Extension 1..7 Numeric string ““
number of the subscriber (BGL).
Optional; used for intra BG calls
display only.
BGDeptName The department name associated 1..20 Character string ““
with the subscriber.
BGEmergencyDep The emergency department that the Character string ““
tName subscriber belongs to.
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Create Subscriber

Value
AccountUserInfo
DisplayName Used for in-switch and VPN dialing 1..20 Character string. ““
to present the calling party’s name.
Used in installations where the SCP
is unavailable or the switch is
configured to use this field instead
of the SCP. This field may be up to
20 characters in length; note,
however, that in some networks,
ISUP supports only 15 characters. In
these environments, only the first
15 characters of the field will be
sent. SIP phones may populate a
generic name field that contains an
alphabetical name to be associated
with the number. If populated, that
field will be used instead of this field.
Optional.
UnicodeDisplayNa A display name for use in markets 1..24 Wide character string. ““
TimeZone Specifies the subscriber’s time zone Any valid time zone.4 “Local”
location and determines how the
subscriber’s time-dependent
services work. In general, most
subscribers will be in the switch’s
local time zone, but SIP & H323
phones can be anywhere and the
switch could border a time zone
edge and serve multiple time zones.
Pin An optional field specifying the 1..10 Character string ““
subscriber’s Personal Identification
Number. This code is available for
use by various service features
where a PIN has meaning, unless
that feature has its own PIN. The
subscriber PIN may be up to 10
characters long. Service feature pins
may be up to 7 characters long.
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Create Subscriber

Value
Pin2 Optional field specifying additional 1..10 Character string ““
Pin3 1..10 Character string ““
Numbers. All PINs (Pin-Pin5) are
Pin4 unique to a subscriber. PINs Pin2- 1..10 Character string ““
Pin5 Pin5 are available for use only 1..10 Character string ““
during COSS service activation/
deactivation. During COSS service
activation and deactivation, the
COSS service will validate the dialed
PIN from all the PINs configured for
that subscriber. Pin2-Pin5 may be up
to 10 characters long. The valid
characters for PINs are digits 0 to 9
PublicPin A Public PIN provided by the 1..10 Character string ““
subscriber that can be used by users
who dial in. For example, the ACR
service requests a PIN before
allowing the call to terminate to a
subscriber. The Public PIN
associated with the destination
subscriber is expected to be input.
Note: added in WSDL version
10.00.08.01.
Language Please refer to Section 5.4, “System
“Primitive Data Definitions”, on page Default”
78.
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Create Subscriber

Value
Status
Subscriber The administrative state of the enum Active, Blocked Active
Status subscriber. For more information on
SubscriberStatus, refer to
UpdateSubscriberStatus request in
Section 9.7, “Update Subscriber
Status”, on page 393.
Intercept The intercept announcement to enum None, N/A
Announcement which calling parties are routed if Disconnect, NumberChange
this subscriber’s number is
disconnected or changed.
NewServiceId This field is used when a subscriber’s See definition of ServiceId in Section ““
ServiceId has changed. It may 5.4, “Primitive Data Definitions”, on
optionally be played during the page 78.
NumberChange announcement.
ConnectionInfo The subscriber may be a “profile-only” subscriber (no real phone) or may have a physical
phone. If the subscriber has a physical phone, it must be defined during the create. Only
one type of phone connection may be specified.
The following parameters are prefixed with the substructure that specifies the type of
connection for which they apply. These substructures are called IPPhone
(IPPhone) Name The name that the phone will 1..15 Character string required
register with. An internal switch
alias is created of type
GUI_ALIAS_TYPE_SIPURL.
Note that if the SIP device is
configured to register by number,
this Name must exactly match the
DN of the subscriber in order for
registration to be successful.
Otherwise, this Name should match
the name that the SIP device
registers with.
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Create Subscriber

Value
(IPPhone) The Registration type. enum Static, Dynamic required
RegType Static: – For Static registration, the
Signaling port and IP of the phone
must be sent. IP phones connected
through a Gateway may be pre-
registered. Note that Static
registration is not supported for
Keyset subscribers.
Dynamic – The signaling Port may
be sent. If it is not, it will default to
5060. If the IPConnectionType is set
to TLS the port will default to 5061.
The request will be rejected if the IP
Address is sent. Note that if the
registration type is changed from
Static to Dynamic via the
UpdateConnectionInfo request, the
IP Address, if any was present, will
be cleared, and the Port, if not sent,
will be set back to the default
(5060).
(IPPhone) IPAddr The IP address or domain name of 1..256 standard IP address N/A
the phone. Allowed to be set if the convention:
SIP phone is defined to be statically 0.0.0.0..255.255.255.255
registered.
(IPPhone) Port The static port number used for standard port number 5060
registration. Meant for convention: If the
RegType=Static. 1..9999 IPConnecti
onType is
set to TLS,
the port
will default
to 5061.
(IPPhone) Identifies the LATA to which the 0..3 Numeric string ““
LataDigits subscriber belongs. (The switch may
serve subscribers across multiple
latas.) This information is used
during SCP 800 number translations
to an SCP.
Removed in V8
(IPPhone) When the RegType is Static, the Boolean True, False False
Register phone may be pre-registered and
not required to register when it is
powered on. The setting of this
parameter is blocked if RegType is
Dynamic.
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Create Subscriber

Value
(IPPhone) The time left from when the phone A timestamp (seconds since N/A
TimeToLive registers to when it must reregister 1970) when the phone will
before being forcibly unregistered expire.
by the switch.
Note: Read-only parameter, no

longer supported in
CreateSubscriber request.
(IPPhone) Indicates the maximum number of 1..10000 3
MaxSessions conversation sessions that should (expected to be limited to
be allowed simultaneously - note 10 for an individual SIP
these are messaging sessions, not subscriber, but the actual
voice (audio) sessions. upper limit is the value
defined in the RTP
parameter “Srx/Sip/
max_number_of_sessions”
(IPPhone, The domain of the SIP Phone. If the 1..128 Character string ““
SIPSecurity5) switch is configured to require SIP
Realm Authentication
(Srx/Sip/AuthEnabled), this field is
required
(IPPhone, The SIP User Name. This value may 1..64 Character string ““
SIPSecurity) be different from the Directory
UserName Number.
(IPPhone, The password that is used in 1..20 Character string ““
SIPSecurity) conjunction with the UserName.
Password
(IPPhone, The type of security scheme that is enum digest_authentication, no_
SIPSecurity) being implemented. In this release, no_security security
Scheme only digest_authentication form of
security is implemented. Specifying
no security removes any previously
configured security information for
this subscriber.
(IPPhone, SRTP Support Enum SrtpUnassigned SrtpDisabl
SIPSecurity) SrtpAutomatic ed
SrtpSupport SrtpEnabled
SrtpDisabled
(IPPhone, “Best-Effort SRTP with SDES” Enum SrtpUnassigned SrtpDisabl
SIPSecurity) attribute to determine whether to SrtpAutomatic ed
SdesSrtpSupport include the SRTP media in the SDP SrtpEnabled
offer or not. SrtpDisabled
(IPPhone) The type of connection used. enum UDP, TCP, TLS UDP
IPConnection
Type
(IPPhone) Statically registered phones may N/A
ContactInfoList have multiple lists.
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Create Subscriber

Value
(IPPhone) Indicates that the subscriber is Boolean True, False
TrustedSub behind a trusted host. If a False
subscriber is provisioned as
subscriber located behind a trusted
host, a P-Asserted-Identity header
will be sent always by the signaling
manager.
Note that this attribute only applies
when the OpenScape Voice system
is configured with the Customer
Type of Communication Server or
Real Time Server.
OBSOLETE / REMOVED in V8
(IPPhone Indicates whether this SIP Boolean True, False
Attributes) subscriber is configured as a static False
MediaReDirection IMS subscriber.
Allowed It is used for static subscribers who
don’t register to indicate that the
route header URL providing a route
to the IMS is stored in the
LooseRoutingURI attribute.
(IPPhone Indicates whether this SIP Boolean True, False
StaticIMSSub IMS subscriber.
OBSOLETE / REMOVED in V8.
(IPPhone) The name of the SIP Endpoint that 1..15 Character string ““
AssociatedSipEnd can handle calls between registered
pointName SIP subscribers in case the
OpenScape Voice system is not
accessible for call control. Displays a
list of all the SIP Endpoints that
don't have a subscriber profile. Also
known as the SIP Survivable Proxy.
(IPPhone) A string of up to 256 characters 1..256 Character string The text
LooseRoutingURI representing the contact URI of the defined in
subscriber. Valid only for a static the RTP
subscriber when application type is parameter
2 (voice application server for FMC) : Srx/Sip/
and the StaticIMSSub attribute is default_s_
true. cscf_URI
By default, if not provided on
creation, the text populated in the
RTP parameter Srx/Sip/
default_s_cscf_URI
is used.
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Create Subscriber

Value
(IPPhone) A charge number received in a Boolean false false
AcceptBillingNum XSiemens-CDR header field of a SIP true
ber INVITE or REFER request (for blind
call transfer) will be included as the
“ANI/Billing number” (field13.) of
the CDR for the call.
Support is removed in V8.
(IPPhone) When a Referred-By header field is Boolean false true
SendInsecureRefe included in the initial request sent to true
rredByHeader the transfer target (for a blind Must be true when
transfer), the Referred-By header subscriber is OSMO.
(including any generic parameters)
will be passed transparently from
the transferor to the transfer target.
(IPPhone Force selection of Codecs by Boolean false false
Attribute) overriding IRM restrictions true
OverrideIRMCode
cRestrictions
(IPPhone If this attribute is set, calls can be Boolean false, true false
Attributes) transferred to the Genesys
TransferHandoff
Video Call Allowed If the attribute is set the Video Call Boolean false, true false
are allowed
(IPPhone Indicates whether Proxy/SBC ANAT Boolean false, true false
Attributes) settings for calls to subscribers are
AnatSetting used. The attribute is applicable
only to proxy endpoints (‘SIP proxy’
attribute set).
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Create Subscriber

Value
(IPPhone) Indicates whether the subscriber’s Enum AnatUnassigned If the
AnatSupport endpoint supports ANAT. AnatOn AnatAuto registratio
indicates that the endpoint supports AnatOn, n of the
ANAT. AnatOff subscriber
AnatOff means that the endpoint is static:
does not support ANAT. AnatOn
AnatAuto means whether the
endpoint supports ANAT shall be If the
determined by the SIP registrar registratio
during registration of the endpoint. n of the
AnatUnassigned indicates that the subscriber
default value should be assigned, is
dynamic:
AnatAuto
(For the
subscriber’
s
registratio
n type
please
refer to
IPPhone
RegType
field)
OutgoingCallSupe For a dialog-initiating outgoing int System
rvisionTimer INVITE, the maximum time for the default if
transaction timer. no value
supplied
Reserved3 The purpose for this is to be Boolean True, False
prepared for future urgent requests False
requiring a new endpoint attribute
and where new functionality via OSV
(e)patch is delivered but there is no
time to deliver the corresponding
Assistant changes at the same time.
The intention is to use these reserve
attributes only in exceptional cases
where the regular process of adding
endpoint attributes can not be
applied due to time constraints.
Usage of these reserve attributes
must be explicitly approved by
development management before
proceeding.
Reserved4 Boolean True, False

False
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Create Subscriber

Value
(IPPhone If the attribute is set , the TEL URI is Boolean false, true false
Attributes) sent in telephone subscriber (global
SendUriInTelepho number or local number) format
neSubscriberForm (including phone context for local
at numbers)
(Attribute) New name for the Boolean True, False false
SendInternational SendUriInTelephone
NumberInGNF SubscriberFormat attribute
RegistViaCentralS When SIP receives a registration Boolean True, False false
BC request via a centralized SBC (new
attribute "SBC endpoint"=true)
from a remote user it this attribute
to determine whether the
registration request should be
accepted or rejected.
DoNotSendAlphan If enabled, his attribute prevents Boolean True, False false
umericSIPURI SIPSM from sending alphanumeric
SIP URIs to the endpoint.
SendAlphanumeri If enabled, this attribute indicates Boolean True, False false
cSIPURIWhenAvai that the endpoint prefers receiving
lable alphanumeric SIP URIs.
Reserved5 The purpose for this is to be Boolean True, False false
prepared for future urgent requests
requiring a new endpoint attribute .
(IPPhone When enabled, the long call Boolean True, False false
Attributes) duration timer is disabled.
DisableLongCallA
udit
ExternalCallerID Char (1…15) N/A
array
UseMainPilotDNIn Optional. Set 1 means that main boolean True false
ternalCalls pilot DN is used for internal calls. False
When set 0 means that main pilot
DN is not used for internal calls.
UseMainPilotDNEx Optional. Set 1 means that main boolean True false
ternalCalls pilot DN is used for external calls. False
When set 0 means that main pilot
DN is not used for external calls.
MobileFlag Enables OSMO capability Boolean False false
true
MainDeviceDN The associated Deskphone Please refer to Section 5.4, “Primitive
Data Definitions”, on page 80.
CellDeviceNumbe Cell phone number of an OSMO. string [1-29] NA
r V7.00.20.01 ‘+’ before number is
and forward required
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Create Subscriber

Value
RouteToCell Option to route the call to the mobile boolean [false,true] NA
phone (cell device number) Must not be true when
V7.01.01.01 CellDeviceNumber is not
defined
MobileDeviceRing Ring duration for the Mobile integer 5,10,15 up to V7.00.23.01) NA

Duration subscriber 1-25 from V7.00.24.01
MainDeviceRingD Ring duration for the Deskphone integer 5,10,15 up to V7.00.23.01) NA
uration 1-25 from V7.00.24.01
CellDeviceRingDu Ring duration for the cellular phone integer 5,10,15 up to V7.00.23.01) NA
ration 1-25 from V7.00.24.01
SubscriberLicense Indicates the current dynamic enum UndefinedSubscriberLicense N/A
Type license status usage for this DynamicSubscriberLicense
subscriber.
Normally corresponds to the
registered status of the subscriber -
if the subscriber is registered, it’s
status is
DynamicSubscriberLicense;
otherwise it is
UndefinedSubscriberLicense.
VOIP - Not for OpenScape Voice. OBSOLETE / REMOVED in V8
Bearer_Speech Please refer to Section 5.4, True
78.
Bearer_3_1K Please refer to Section 5.4, False
78.
Bearer_56K Please refer to Section 5.4, False
78.
Bearer_64K Please refer to Section 5.4, False
on page 78.
FaxMode Please refer to Section 5.4, G711
78.
Echo Please refer to Section 5.4, True
Cancellation “Primitive Data Definitions”, on page
78.
Silence Please refer to Section 5.4, False
Suppression “Primitive Data Definitions”, on page
78.
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Create Subscriber

Value
FaxStatistics Please refer to Section 5.4, False
78.
OutbandDTMF Please refer to Section 5.4, False
Signaling “Primitive Data Definitions”, on page
78.
Suppress Please refer to Section 5.4, False
OutbandDTMFWit “Primitive Data Definitions”, on page
hG711 78.
PIC1 Obsolete ““
78.
78.
78.
78.
KeysetInfo
KeysetUse Describes whether a DN is to be enum KeysetPrimaryLine Keyset
used for Keyset Operation and, if so, KeysetPhantomLine None
in what way. For descriptions of the KeysetNone
possible values, refer to Section
4.13, “Keyset Information”, on page
67 for more information.
ListOfFeatures
A list of service features to be applied to the created subscriber/BGL. For more information, refer to SOAP
request UpdateSubscriberFeatures in Section 9.13, “Update Subscriber Features”.
Note that if a FeatureProfile is provided as part of the same CreateSubscriber request, validation of feature
interactions between the features in the FeatureProfile and the features included in this list is not currently
supported. If a subscriber is to have both an associated FeatureProfile and directly assigned features, it is
recommended that the subscriber be created first with the FeatureProfile and any additional features added
later using the UpdateSubscriberFeatures SOAP request.
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Get Subscriber Info

Value
Notes:
1Defined ClassesOfService can be retrieved using the GetCOSList interface method (see Section 7.6, “Get COS List”). They
can be defined on the switch using either the OpenScape Voice Assistant or CLI.
2
The available list of Rate Areas can be retrieved using the GetRateAreaList interface method (see
Section 7.7, “Get Rate Area List”). They can be defined using either the OpenScape Voice Assistant or CLI.
3The available list of Calling Locations can be retrieved using the GetCallingLocationList interface method (see Section 7.9,
“Get Calling Location List”).
4For a list of valid time zones, refer to Appendix 31, “Time Zones”.
5The following structure contains fields for when SIP Authentication has been enabled on the platform. These fields are
required when the RTPParm “Srx/Sip/Authentication-Enabled” = RtpTrue
9.2 Get Subscriber Info

The GetSubscriberInfo SOAP request is used to retrieve the subscriber
profile. Note that the most current request is GetSubInfoByRel; the
others are retained for backward compatibility with older clients, but
are not expected to be used by new clients.
A ServiceId is required to query a subscriber’s information, and this is

normally the subscriber’s DN (Directory Number). However, it is also
possible to provide an Alias in the ServiceId field, if the subscriber has
been provisioned with one or more alphanumeric aliases. If the input
ServiceId is numeric only, the method will assume it is a DN, while if it
is in valid Alias URI format (see definition of the AliasURI parameter in
the Create Subscriber request), the Alias will be used to query the
subscriber. The subscriber DN will be returned, and the Alias
information will be in the ConnectionInfo substructure.
• GetSubscriberInfo — returns only the tags common to older

clients.
• GetSubscriberByOption — supports fixed clients that require the

latest interface.
• GetSubInfoByRel — The request contains release version and a

list of the attributes for which data is to be returned. If no attribute
descriptors are provided, ALL attributes are returned.
Note: It is possible to perform a GetSubscriberInfo request with a

disconnected DN, but there is no data stored in the subscriber profile
table for these DNs, so the only information returned is the status
information that can be obtained from the Home DN table. These are
the following attributes: SubscriberStatus (always Blocked),
InterceptAnnouncement, and NewServiceId, if any.
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Get Subscriber Info
Table 374 lists the data returned in response to the GetSubscriberInfo

requests:

Value
ServiceId Please refer to Section 5.4, N/A
78.
OfficeCodeInfo
OfficeCode Numeric identifier of a specific office Must be a digit sequence of
code. maximum length 9.
N.America: 6 digits
Japan: 5 digits
CountryCodeLeng Length of the country code prefix in Int 0 - 4 in all markets 0
th the office code.
AreaCodeLength Length of the area code prefix in the Int N.America: 3
office code. Japan: 1-5
Korea: 1-2
China: 2-3
Europe: 0-5
Attributes Defines attributes of the office code. 5-digit
Enumerated type. string
AccountMgmtInfo
Account ID Used only for auditing and aiding the 1..20 Character string. N/A
telco in identifying the subscriber.
This is an optional parameter and
there is no default
Billing ID A DN to which charges are assigned Please refer to Section 5.4, N/A
in the generated CDRs. It is optional “Primitive Data Definitions”, on
and if not present, the subscriber's page 78.
DN is used.
Retailer Id Used as an auditing field for the 1..16 Character string. N/A
telco to help the customer identify
the owner of the subscriber. The
retailer is optional and there is no
default as part of the subscriber
definition. The value is not required
to match data in the Retailer/Carrier
table.
Table 374 Get Subscriber Info Data Returned (Seite 1 von 15)
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Get Subscriber Info

Value
COS (Class of Outgoing calls are routed using the 1..15 Character string N/A
Service) Class of Service. During routing, if a representing any existing
subscriber belongs to a class of ClassOfService.
service, those routes are given
preference; otherwise, the switch’s
default class of service (unassigned)
is used. If the subscriber has no
Class of Service assigned, the
subscriber can access default routes
only. Subscribers with COS specified
will access COS routes first (if
defined for the call that they make),
if none are available, the default
COS routes will be used.
RateArea The subscriber can belong to a 1..15 Character string N/A
specific Rate Area. This Rate Area representing any existing
defines what constitutes a local call RateArea.
verses a long distance call, as well
as the routing for outbound calls.
Outgoing calls are routed using the
Rate Area. During routing, if a
otherwise, the switch’s default rate
area (unassigned) is used. If the
assigned, the subscriber can access
default routes only.
TestLineFlag Indicates whether the line is a test Boolean True, False N/A
line. Outbound calls do not behave
any differently from non-test lines
except that the test line indication is
set in the calling party category
(SS7 message). CDRs will be
generated but there should be no
charges generated for the call.
Supported in Japan only.
Support removed in V8.
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Get Subscriber Info

Value
ExternalDN Indicates that the subscriber DN is a Boolean True, False N/A
Flag Direct Inward Dialing (DID) number.
The subscriber can receive direct
incoming calls. If the External DN
Flag is set to False, the BGL has a
private (non-external) number. This
means the number cannot be dialed
from outside of the BG and is not
displayed as a calling party on calls
directed outside the BG.
Note that this flag is also used by
the MLHG service when an MLHG
member originates a call. If True,
the terminal’s own data is used as
the calling party; otherwise, the
CountryCode To support international dialing and integer 1..4 N/A
Len multiple countries being served by
the same hiQ, the country code will
be part of the subscriber DN.
The country code is required to be
created as part of the office code in
the HomeDN. The subscriber
country code length must match the
office code country code length. The
format and valid range are
controlled by the RTP parameters
specified by the SrxDigitLen.parm
file.
The Country Code Length is
automatically retrieved from the
HomeDN and assigned to the
subscriber during subscriber
creation. Therefore, it is no longer
an input parameter. It cannot be
modified and will be displayed as
part of the subscriber information.
CallingLoc Indicates the subscriber’s location. 1..15 Any existing Calling N/A
Used for routing emergency calls to Location.
the answering point that serves the
Calling Location.
FeatureProfile Identifies the subscriber’s Feature For further details, see definition of N/A
Id, FeatureProfile Profile, a defined set of features that FeatureProfileName in Section 5.4,
Name is inherited by the subscriber by “Primitive Data Definitions”, on
virtue of association with the page 78.
Feature Profile.
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Get Subscriber Info

Value
FeatureProfile The name of the Business Group For further details, see definition of N/A
Id, BGName with which the Feature Profile is BGName in Section 5.4, “Primitive
associated. A key field for Data Definitions”, on page 78.
identification of a Feature Profile.
NumberPlanName The name of the Private Numbering 1..31 Character string. N/A
Plan to associate with this BGL. If
none is provided, this BGL uses the
BG’s numbering plan.
For residential subscribers, only the
system default numbering plan
applies.
SubscriberBGInfo
BGName Business Group Name: optional for 0..30 Up 30 characters, including required
this request. For further details, see apostrophes, commas, and
Section 5.4, “Primitive Data other special characters.
BGLineName Business Group Line Name is the 0..20 Character string N/A
subscriber member name.
UnicodeBGLineNa A BG Line name for use in markets 1..24 Wide character string. N/A
BGAttendant A business group attendant number Boolean True, False N/A
Number flag indicates the DN is used for the
Attendant Number function of the
Business Group.
CpuId A Call Pickup group Id to which this integer 1..10000 N/A
subscriber (BGL) belongs. There can
be only one CPU group ID per
subscriber. The CfCPU service must
be provisioned either by explicit
assignment or Feature Profile
inheritance in order for the CPU
service to be effective. A value of 0
indicates that the subscriber is not
part of any CPU.
CpuName Character string
Extension This field indicates the Extension 1..7 Numeric string N/A
number of the subscriber (BGL).
Optional; used for intra BG calls
display only.
BGDeptName The department name associated 1..20 Character string N/A
with the subscriber.
BGEmergencyDep The emergency department that the Character string ““
tName subscriber belongs to.
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Get Subscriber Info

Value
BGBranchOfficeNa The name of the Branch Office the 1-30 Character String ""
me subscriber queried for belong to.
DoNotSendAlphan If enabled, his attribute prevents bool True,False false
umericSIPURI SIPSM from sending alphanumeric
SIP URIs to the endpoint.
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Get Subscriber Info

Value
AccountUserInfo
DisplayName Used for in-switch and VPN dialing 1..20 Character string. N/A
to present the calling party’s name.
Used in installations where the SCP
is unavailable or the switch is
configured to use this field instead
of the SCP. This field may be up to
20 characters in length; note,
however, that in some networks,
ISUP supports only 15 characters. In
these environments, only the first
15 characters of the field will be
sent. SIP phones may populate a
generic name field that contains an
alphabetical name to be associated
with the number. If populated, that
field will be used instead of this field.
Optional.
UnicodeDisplayNa A display name for use in markets 1..24 Wide character string. N/A
TimeZone Specifies the subscriber’s time zone Any valid time zone. N/A
location and determines how the
subscriber’s time-dependent
services work. In general, most
subscribers will be in the switch’s
local time zone, but SIP & H323
phones can be anywhere and the
switch could border a time zone
edge and serve multiple time zones.
Pin An optional field specifying the 1..10 Character string N/A
Number. This code is available for
use by various service features
where a PIN has meaning, unless
that feature has its own PIN. The
subscriber PIN may be up to 10
characters long. Service feature pins
may be up to 7 characters long.
PublicPin A Public PIN provided by the 1..10 Character string N/A
subscriber that can be used by users
who dial in. For example, certain
services, such as EACR may request
a PIN before allowing the call to
terminate to a subscriber. The Public
PIN associated with the destination
subscriber is expected to be input.
Note: added in WSDL version
10.00.08.01.
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Get Subscriber Info

Value
Language Please refer to Section 5.4, N/A
on page 78.
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Get Subscriber Info

Value
Status
Subscriber The administrative state of the enum Active, Blocked N/A
Status subscriber.
Intercept The intercept announcement to enum None, N/A
Announcement which calling parties are routed if Disconnect, NumberChange
this subscriber’s number is
disconnected or changed.
NewServiceId This field is used when a subscriber’s See definition of ServiceId in Section N/A
ServiceId has changed. It may 5.4, “Primitive Data Definitions”,
optionally be played during the on page 78.
NumberChange announcement.
ConnectionInfo The subscriber may be a “profile-only” subscriber (no real phone) or may have a physical
phone. If the subscriber has a physical phone, it must be defined during the create. Only
one type of phone connection may be specified.
The following parameters are prefixed with the substructure that specifies the type of
connection for which they apply. These substructures are called IPPhone.
(IPPhone) Name The name that the phone will 1..15 Character string N/A
register with. An internal switch
alias is created of type
GUI_ALIAS_TYPE_SIPURL.
Note that if the SIP device is
configured to register by number,
this Name must exactly match the
DN of the subscriber in order for
registration to be successful.
Otherwise, this Name should match
the name that the SIP device
registers with.
(IPPhone) The Registration type. enum Static, Dynamic N/A
RegType Static: – For Static registration, the
Signaling port and IP of the phone
must be sent. IP phones connected
through a Gateway may be pre-
registered. Note that Static
registration is not supported for
Keyset subscribers.
Dynamic – The signaling Port may
be sent. If it is not, it will default to
5060. The request will be rejected if
the IP Address is sent. Note that if
the registration type is changed
from Static to Dynamic via the
UpdateConnectionInfo request, the
IP Address, if any was present, will
be cleared, and the Port, if not sent,
will be set back to the default
(5060).
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Get Subscriber Info

Value
(IPPhone) IPAddr The IP address or domain name of 1..256 standard IP address N/A
the phone. Allowed to be set if the convention:
SIP phone is defined to be statically 0.0.0.0..255.255.255.255
registered.
(IPPhone) Port The static port number used for standard port number N/A
registration. Meant for convention:
RegType=Static. 1..9999
(IPPhone) Identifies the LATA to which the 0..3 Numeric string N/A
LataDigits subscriber belongs. (The switch may
serve subscribers across multiple
during SCP 800 number translations
to an SCP.
Removed in V8
(IPPhone) When the RegType is Static, the Boolean True, False N/A
Register phone may be pre-registered and
not required to register when it is
powered on. The setting of this
parameter is blocked if RegType is
Dynamic.
(IPPhone) The time left from when the phone A timestamp (seconds since N/A
TimeToLive registers to when it must reregister 1970) when the phone will
before being forcibly unregistered expire.
by the switch.
Note: Read-only parameter, no

longer supported in
CreateSubscriber request.
(IPPhone) Indicates the maximum number of 1..10000 N/A
MaxSessions sessions that should be allowed (expected to be limited to
simultaneously - note that these are 10 for an individual SIP
messaging sessions, not voice subscriber, but the actual
(audio) sessions. upper limit is the value
defined in the RTP
parameter Srx/Sip/
max_number_of_sessions
(IPPhone, The domain of the SIP Phone. If the 1..128 Character string N/A
SIPSecurity5) switch is configured to require SIP
Realm Authentication
(Srx/Sip/AuthEnabled), this field is
required
(IPPhone, The SIP User Name. This value may 1..64 Character string N/A
SIPSecurity) be different from the Directory
UserName Number.
(IPPhone, The password that is used in 1..20 Character string N/A
SIPSecurity) conjunction with the UserName.
Password
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Get Subscriber Info

Value
(IPPhone, The type of security scheme that is enum digest_authentication, N/A
SIPSecurity) being implemented. In this release, no_security
Scheme only digest_authentication form of
security is implemented. Specifying
no security removes any previously
configured security information for
this subscriber.
SrtpSupport SRTP Support Enum SrtpUnassigned SrtpDisabl
SrtpAutomatic ed
SrtpEnabled
SrtpDisabled
SdesSrtpSupport “Best-Effort SRTP with SDES” Enum SrtpUnassigned SrtpDisabl
attribute to determine whether to SrtpAutomatic ed
include the SRTP media in the SDP SrtpEnabled
offer or not. SrtpDisabled
(IPPhone) The type of connection used. enum UDP, TCP, TLS N/A
IPConnection
Type
(IPPhone) Statically registered phones may N/A
ContactInfoList have multiple lists.
(IPPhone Indicates that the subscriber is Boolean True, N/A
Attributes) behind a trusted host. If a False
TrustedSub subscriber is provisioned as
subscriber located behind a trusted
host, a P-Asserted-Identity header
will be sent always by the signaling
manager.
when the hiQ is configured with the
Customer Type of Communication
Server or Real Time Server.
(IPPhone Indicates that the subscriber is a Boolean True, N/A
Attributes) GSM Mobile IP Centrex subscriber. If False
GSMSub both the Calling and Called Party are
GSM subscribers, a configurable
prefix will be inserted before
sending an INVITE to the trusted
host by the signaling manager to
avoid the Called party route to the
SIP network a second time. A P-
Asserted Identity header will also be
sent by the signaling manager for a
GSM Subscriber.
when the hiQ is configured with the
Customer Type of Communication
Server or Real Time Server.
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Get Subscriber Info

Value
(IPPhone Indicates whether or not media Boolean True, N/A
Attributes) redirection is allowed for this SIP False
MediaReDirection subscriber.
Allowed
(IPPhone Indicates whether this SIP Boolean True, N/A
StaticIMSSub IMS subscriber.
It is used for static subscribers who
don’t register to indicate that the
route header URL providing a route
to the IMS is stored in the
(IPPhone Allows the support of single and Boolean True, N/A
Attributes) multiple registration subscribers on False
AORPerContact the same switch.
If set to False, the switch will only
allow one AoR per endpoint, either
statically or dynamically registered.
If set to True, the switch will accept
one AoR per DN and per each of the
two aliases, store them in the
contact and use them for
terminating calls.
(IPPhone) The name of the SIP Endpoint that 1..15 Character string N/A
AssociatedSipEnd can handle calls between registered
pointName SIP subscribers in case the
OpenScape Voice system is not
accessible for call control. Also
known as the SIP Survivable Proxy.
(IPPhone) A string of up to 256 characters 1..256 Character string N/A
LooseRoutingURI representing the contact URI of the
subscriber. Valid only for a static
subscriber when application type is
2 (voice application server for FMC)
and the StaticIMSSub attribute is
true.
By default, if not provided on
creation, the text populated in the
RTP parameter Srx/Sip/
default_s_cscf_URI
is used.
(IPPhone) An array of up to 2 AliasEntry elements. Note that in order for a subscriber to make use
AliasList of these entries, the parameter AORPerContact must be True.
Each element contains the following attribute:
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Get Subscriber Info

Value
(AliasEntry) A string of representing the alias 1..60 Character string N/A
AliasURI URI of the subscriber. Please refer to
the definition of AliasURI in the
Create Subscriber request for
information about valid strings for
this field.
(IPPhone) If provisioned, indicates that the enum UIAnalog N/A
SIPUserInterfaceT subscriber is a trusted virtual
ype subscriber located in the TDM
network. Corresponds internally to
the connection type
SIPanalogUserIF.
This attribute cannot be modified
after creation.
(IPPhone) A charge number received in a Boolean false false
AcceptBillingNum XSiemens-CDR header field of a SIP true
ber INVITE or REFER request (for blind
call transfer) will be included as the
“ANI/Billing number” (field13.) of
the CDR for the call.
(IPPhone) When a Referred-By header field is Boolean false true
SendInsecureRefe included in the initial request sent to true
rredByHeader the transfer target (for a blind
transfer), the Referred-By header
(including any generic parameters)
will be passed transparently from
the transferor to the transfer target.
(IPPhone Force selection of Codecs by Boolean false false
Attribute) overriding IRM restrictions. true
OverrideIRMCode
cRestrictions
(IPPhone If this attribute is set, calls can be Boolean false, true false
Attributes) transferred to the Genesys.
TransferHandoff
(IPPhone Indicates whether Proxy/SBC Boolean false, true false

Attributes) ANAT settings for calls to
AnatSetting subscribers are used. The attribute
is applicable only to proxy
endpoints (‘SIP proxy’ attribute
set).
VideoCallAllowed If the attribute is set the Video Call Boolean false, true false
are allowed
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Get Subscriber Info

Value
SubscriberLicense Indicates the current license status Enum UndefinedSubscriberLicense N/A
Type usage for this subscriber. Normally DynamicSubscriberLicense
corresponds to the registered status OSMOSubscriberLicense
of the subscriber - if the subscriber
is registered, it’s status is
DynamicSubscriberLicense. If the
subscriber is registered as an OSMO
device it’s status is
OSMOSubscriberLicense. Otherwise
it Is UndefinedSubscriberLicense.
(IPPhone) Refers to the VIPType of the enum VIPNo, VIPNo
VIPType subscriber. VIPYes
(IPPhone) Indicates whether the subscriber’s Enum AnatUnassigned If the
AnatSupport endpoint supports ANAT. AnatOn AnatAuto registratio
indicates that the endpoint supports AnatOn, n of the
ANAT. AnatOff subscriber
AnatOff means that the endpoint is static:
does not support ANAT. AnatOn
AnatAuto means whether the
endpoint supports ANAT shall be If the
determined by the SIP registrar registratio
during registration of the endpoint. n of the
AnatUnassigned indicates that the subscriber
default value should be assigned, is
dynamic:
AnatAuto
(For the
subscriber’
s
registratio
n type
please
refer to
IPPhone
RegType
field)
OutgoingCallSupe For a dialog-initiating outgoing int System
rvisionTimer INVITE, the maximum time for the default if
transaction timer. no value
supplied
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Get Subscriber Info

Value
SubscriberLicense Indicates the current dynamic enum UndefinedSubscriberLicense N/A
Type license status usage for this DynamicSubscriberLicense
subscriber.
Normally corresponds to the
registered status of the subscriber -
if the subscriber is registered, it’s
status is
DynamicSubscriberLicense;
otherwise it is
UndefinedSubscriberLicense.
VOIP Not for OpenScape Voice.
Bearer_Speech Please refer to Section 5.4, N/A
78.
Bearer_3_1K Please refer to Section 5.4, N/A
78.
Bearer_56K Please refer to Section 5.4, N/A
78.
Bearer_64K Please refer to Section 5.4, N/A
78.
FaxMode Please refer to Section 5.4, N/A
78.
Echo Please refer to Section 5.4, N/A
Cancellation “Primitive Data Definitions”, on page
78.
Silence Please refer to Section 5.4, N/A
Suppression “Primitive Data Definitions”, on page
78.
FaxStatistics Please refer to Section 5.4, N/A
78.
OutbandDTMF Please refer to Section 5.4, N/A
Signaling “Primitive Data Definitions”, on page
78.
Suppress Please refer to Section 5.4, N/A
OutbandDTMFWit “Primitive Data Definitions”, on page
hG711 78.
PIC1 Please refer to the definition of N/A
InterExchange.PIC1 in Section 5.4,
78.
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Get Subscriber Info

Value
78.
78.
78.
KeysetInfo
KeysetUse Describes whether a DN is to be enum KeysetPrimaryLine N/A
used for Keyset Operation and, if so, KeysetPhantomLine
in what way. KeysetNone
ListOfFeatures
A list of service features to be applied to the created subscriber/BGL. For more information, refer to SOAP
request UpdateSubscriberFeatures in Section 9.13 on page 9-405.
Attention: This request is superseded by the Get Sub Info By Rel

request in Section 9.2.2, “Get Sub Info By Rel” below, but the
information about input and output data included here still applies.
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Get Subscriber Info

WSDL Version
subRC_DB_SUB_OFFICE_CODE_LOOKUP_FAILED
subRC_DB_SUB_TEEN_LOOKUP_FAILED
subRC_DB_SUB_FEATURE_LOOKUP_FAILED
subRC_APP_SUB_PROFILE_TYPE_INVALID
subRC_DB_BG_DEPT_LOOKUP_FAILED
subRC_DB_UTIL_LANG_LOOKUP_FAILED
subRC_DB_EP_H323_XDM_ALIAS_LOOKUP_FAILED
subRC_DB_EP_SIP_XDM_ALIAS_LOOKUP_FAILED
subRC_DB_EP_SIP_SECURITY_DATA_LOOKUP_FAILED
subRC_DB_EP_XDM_CONTACT_LOOKUP_FAILED
subRC_DB_SUB_KEYSET_LOOKUP_FAILED
subRC_DB_MLHG_FEAT_DATA_LOOKUP_FAILED
subRC_DB_MLHG_PILOT_DN_LOOKUP_FAILED
subRC_DB_MLHG_TERM_LOOKUP_FAILED
Table 375 Get Subscriber Info Return Codes
Table 376 lists the field descriptions for this method.

Value
on page 78.
GetSubData Select a list of all data List of IncludeAccountMgtInfo_, All values
Options information needed from the enums IncludeAccountUserInfo_, included
Get subscriber profile. IncludeStatus_,
Subscriber IncludeConnectionInfo_,
DataOption IncludeVOIP
List IncludeQualityOfService_,
Get IncludeSubscriberAuditInfo_,
Subscriber IncludeListOfFeatures_,
DataOption IncludeBGInfo_,
IncludeKSInfo_,
IncludeMlhgInfo_,
IncludeContactInfo_,
Table 376 Get Subscriber Info Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Get Subscriber Info
9.2.1 Get Subscriber Info By Option

This method retrieves selected portions of the subscriber profile.
Attention: This request is superseded by the Get Sub Info By Rel

request in Section 9.2.2, “Get Sub Info By Rel” below.

WSDL Version
1.0.1 N/A Same as GetSubscriberInfo above.
Table 377 Get Subscriber Info By Option Return Codes

on page 78.
GetSubData Select a list of all data List of Same as GetSubscriberInfo
Options. Get information needed from the enums above.
Subscriber subscriber profile.
DataOption
List. Get
Subscriber
DataOption
Table 378 Get Subscriber Info By Option Input Fields
9.2.2 Get Sub Info By Rel

This method retrieves all or part of a subscriber’s data based on an
interface release version.

WSDL Version
Table 379 Get Sub Info By Rel Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Get Subscriber Info

Interface The release version being Please refer to the definition of Latest
Release used by the requesting SOAP InterfaceRelease in Section 5.1.1, “The
client. Interface WSDL and Interface Release
Control”, on page 73.
on page 78.
GetSubData Select a list of all data List of Same as GetSubscriberInfo
Options. information needed from the enums above.
Get subscriber profile.
Subscriber
DataOption
List.
Get
Subscriber
DataOption
Table 380 Get Sub Info By Rel Field Descriptions
9.2.3 Get Subscriber RG Request

The GetSubscriberRGRequest SOAP request is used to retrieve part of
the subscriber data. A ServiceId is required to query a subscriber's
information, and this is normally the subscriber's DN (Directory
Number). Additionally, it is possible to send the operator ID, which is a
non-mandatory field.
Attention: It is also possible to retrieve a disconnected subscriber

through this new API. A message is displayed indicating that the
requested subscriber is disconnected. The other data related to the
subscriber status, InterceptAnnouncement, and the new service ID
cannot be displayed through this API. To display all data, refer to the
previous GetSubscriber Info SOAP method (Section 9.2, “Get
Subscriber Info”, on page 361)

WSDL Version
Table 381 Get Subscriber RG Request Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Get Subscriber Info

on page 78.
User Name The SIP User Name. This 1..64 Character String N/A
value may be different from
the Directory Number.
Password The password that is used in 1..20 Character String N/A
conjunction with the
UserName.
Realm The domain of the SIP Phone. 1..128 Character String N/A
Rate Area The subscriber can belong to 1..15 Character string representing any N/A
a specific Rate Area. This Rate existing RateArea.
Area defines what constitutes
a local call vs. a long distance
call, as well as the routing for
outbound calls.
Outgoing calls are routed
using the Rate Area. During
routing, if a subscriber
belongs to a Rate Area, those
routes are given preference;
otherwise, the system's
default rate area
(unassigned) is used. If the
assigned, the subscriber can
access default routes only.
BGName Business Group Name: 0..30 Up 30 characters, including required
optional for this request. For apostrophes, commas, and other
further details, Please refer to special characters.
Section 5.4, “Primitive Data
MlhgOwner Indicates if the subscriber is a Boolean True, False false
MLHG owner.
PrimaryPilotS The service id of the 1..15 Character String N/A
erviceId PrimaryPilot
MlhgList Returns the list of MLHG the 1 …2048 N/A
requested subscriber belongs list
to members
Table 382 Get Subscriber RG Request Field Descriptions (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Get Subscriber List

SubMediaReD Indicates whether this SIP Boolean True, False
irectionAllowe subscriber is configured as a
d static IMS subscriber. It is
used for static subscribers
who do not register to
indicate that the route header
URL providing a route to the
IMS is stored in the
Table 382 Get Subscriber RG Request Field Descriptions (Seite 2 von 2)
9.3 Get Subscriber List

The GetSubscriberList method is used to retrieve the list of subscribers
on the switch. A starting subscriber can be provided or part of a
subscriber ID containing the wildcard character (%), and a maximum
count to be retrieved.
The default behavior is that subscribers are returned in numerical order

from lowest DN to highest. Sorting can also be performed on several
other characteristics that can be filled in the GetSubListSortElement list
of the request. A number of filter criteria are possible so that a
particular subset of existing subscribers can be retrieved. When a
specific filter is implemented as a list, multiple filter value selection is
available. Wildcarding is also available for string attributes and range/
min/max is implemented for the CpuID attribute. All conditions
specified are AND-ed together.
The highest supported and default maximum number of subscribers to

retrieve is 1000. However, the total number of existing subscribers that
meet the given filter criteria is returned in the TotalSubsFound field so
that if there are more than 1000 existing subscribers, the client
application can send multiple requests, each one with starting
subscriber greater than the last one returned and thus obtain all
existing subscribers.
The response list will contain disconnected DNs only if the

InterceptAnnouncement filter criterion is provided. Disconnected DNs
are not stored in the subscriber profile table, but will have their
InterceptAnnouncement set to either Disconnect or NumberChange in
the Home DN table.
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Get Subscriber List

WSDL Version
subRC_APP_SUB_SQL_FILTER_OUT_OF_RANGE
subRC_APP_SUB_GET_LIST_OUT_OF_RANGE
subRC_DB_UTIL_COS_LOOKUP_FAILED
subRC_APP_UTIL_COS_DOES_NOT_EXIST
subRC_DB_UTIL_RATEAREA_LOOKUP_FAILED
subRC_APP_UTIL_RATEAREA_DOES_NOT_EXIST
subRC_DB_UTIL_CALLINGLOC_LOOKUP_FAILED
subRC_APP_UTIL_CALLINGLOC_DOES_NOT_EXIST
subRC_APP_BG_DEPT_BG_ID_MISSING
subRC_APP_SUB_PROVISIONING_DATE_INVALID
subRC_APP_QOS_PROFILE_DOES_NOT_EXIST
subRC_APP_FP_DOES_NOT_EXIST
subRC_APP_SUB_FEAT_FILTER_NOT_ALLOWED
subRC_APP_SUB_FEAT_HD_DUPLICATE
subRC_SYS_SUB_LIST_ALLOC_ERR
subRC_SYS_SUB_FEAT_HD_ALLOC_ERR
subRC_SYS_SUB_LIST_ALLOC_ERR
subRC_APP_BG_CPU_ID_FILTER_COMBINATION_INVALID
Table 383 Get Subscriber List Return Codes
Attention: The Default Value column is N/A for most parameters, since
these input parameters are filter criteria. If a parameter is not
provided, the default behavior is that there is no filtering performed
based on that particular parameter.
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Get Subscriber List

InterfaceWSDL The WSDL version of the
request. This indicates that
only data that was introduced
in the specified WSDL version
or later shall be returned in
response to this request. For
further details, please refer to
Section 5.1, “Interface
(WSDL) Versions”, on page
73.
Paging Paging structure for Get List N/A
requests. For more
information, refer to Section
5.5, “Paging”, on page 86.
on page 78.
MaxSubscribers The maximum number of integer N/A 1000
subscribers to be returned in
the response list.
COS Class of Service. During Refer to CreateSubscriber in Section 9.1, N/A
routing, if a subscriber “Create Subscriber”, on page 342.
belongs to a class of service,
those routes are given
preference; otherwise, the
switch’s default class of
service (unassigned) is used.
If the subscriber has no Class
of Service assigned, the
subscriber can access default
routes only.
RateArea Defines what constitutes a Refer to CreateSubscriber in Section 9.1, N/A
local call verses a long “Create Subscriber”, on page 342.
distance call, as well as the
routing for outbound calls.
AccountId Used only for auditing and Refer to CreateSubscriber in Section 9.1, N/A
aiding the telco in identifying “Create Subscriber”, on page 342.
the subscriber.
RetailerId Used as an auditing field to Refer to CreateSubscriber in Section 9.1, N/A
help the customer identify the “Create Subscriber”, on page 342.
owner of the subscriber.
BillingId The BGL/DN to which charges Refer to CreateSubscriber in Section 9.1, N/A
are assigned in the CDRs. “Create Subscriber”, on page 342.
Table 384 Get Subscriber List Field Descriptions (Seite 1 von 6)
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Get Subscriber List

TestLineFlag Indicates whether the line is a Refer to CreateSubscriber in Section 9.1, N/A
test line. Outbound calls do “Create Subscriber”, on page 342.
no behave any differently
from non-test lines except
that the test line indication is
set in the calling party
category (SS7 message).
Japan only.
Support removed in V8.
Subscriber Indicates whether a Refer to CreateSubscriber in Section 9.1, N/A
Status subscriber's calls are active or “Create Subscriber”, on page 342.
blocked.
Intercept Refer to CreateSubscriber in N/A
Announcement Section 9.1, “Create
Subscriber”, on page 342.
PIC1 Obsolete N/A
Refer to CreateSubscriber in
Section 9.1, “Create
PIC2 Obsolete N/A
PIC3 Obsolete N/A
PIC4 Obsolete N/A
BGName Please refer to Section 5.4, required
on page 78.
BranchOfficeNa The name of the Branch 1-30 Character String ""
me Office the subscribers queried
for belong to
CpuId Indicates the call pickup Int 1..10000 N/A
group to which this subscriber
(BGL) belongs. There can be
only one CPU group ID per
subscriber. The CfCPU service
must be provisioned either by
explicit assignment or
Feature Profile inheritance in
order for the CPU service to
be effective. A value of 0
indicates that the subscriber
is not part of any CPU.
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Get Subscriber List

MinCpuId If filled in alone, the function Int 1..10000 N/A
will return all subscribers with
CPU group ID above the one
specified. In conjuction with
MaxCpuid a range is
provided. Cannot be used
concurrently with CpuId
MaxCpuId If filled in alone, the function Int 1..10000 N/A
will return all subscribers with
CPU group ID below the one
specified. In conjuction with
MaxCpuid a range is
provided. Cannot be used
concurrently with CpuId
ProvDateOp Records returned will be xsd__dat Any valid data/time string. N/A
Last entries logged after this eTime
specified date.
CallingLoc A location, such as an area 1 – 15 N/A
code.
BGDeptName The Business Group Please refer to the definition of
Department name on which BgDeptName in Table 507
to filter.
BgDeptNameLis Used to provide multiple filter
t value selection for
BGDeptName. Cannot be
used concurrently with
BGDeptName
isMlhgPilot If true, specifies that only Boolean True, N/A
MLHG Pilot DNs should be False
returned.
isMlhgMember If true, specifies that only Boolean True, N/A
MLHG Members should be False
returned.
SILMATagIsEnab Filters by Subscribers that Boolean True, N/A
led have SILMA Tag enabled False
(WSDL V7.00.09.01)
NumberPlanNa The name of the Private 1..31 Character string. ““
me Numbering Plan on which to
filter. Only BGLs that have
been explicitly assigned this
Number Plan will be returned.
NumberPlanNa Used to provide multiple filter List of Char strings
meList value selection for
NumberPlanName. Cannot be
used concurrently with
BGDeptName
ConnectionType The type of connection used. enum UDP, TCP, TLS UDP
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Get Subscriber List

ResrcMgmtType Specifies the Resource enum ResourceMgmtType_None ResourceMgmt
Management Type of the QoS ResourceMgmtType_PCMM Type_None
Profile. The value PCMM
indicates that this QoS Profile
is used for Packet Cable
MultiMedia. NOTE - PCMM
does not apply to OpenScape
Voice.
OBSOLETE in V8.
GetSubListSortL Used to provide multiple filter enum N/A
ist value selection for
GetSubListSortT Sorting elements. Please
ype refer to Table 385 for a list of
possible values.
GetSubListSortL Provides selection of sorting enum SortOrderAscending, SortOrderAsce
ist order SortOrderDescending nding
SortOrder
DataOptionList Provides selection of extra enum N/A
GetSubscriberLi data fields to be included in
stDataOption the result structure.
Please refer to Table 386 for a
list of possible values.
GetSubscriberLi Select a list of additional data enum SubListDataInclExtCallerID_ N/A
stDa from the SubListDataInclBOName_,
taOptionList subscriber profile database SubListDataInclMobileDN_
GetSubscriberLi table. SubListDataInclAssocEpIP_
stDa SubListDataInclTransportType_
taOption SubListDataInclSipSecurity
SubListDataInclIsMainDevice_
SubListDataInclCpuName
SubListDataInclMlhgList
Assigned A list of features on which to Following features supported: N/A

Features filter. Only subscribers that BgLC
have the given features CCBS(V7.00.01.02)
assigned will be returned. CCNR (V7.00.01.02)
Filter by A list of features on which to List of pointers to all possible N/A
Assigned filter. Only subscribers that features on which filtering can
Features have the given features be performed.
assigned will be returned.
Excluded A list of Business Group N/A
BGNames Names that will be filtered out
from the results of
GetSubscriberList
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Get Subscriber List

BGLineName The subscriber member 0..20 Character string ““
name. A string containing the
wildcard (%) character can
also be provided. The
function will then return
matching entries.
UnicodeBGLineN A BG Line name for use in 1..24 Wide character string. ““
ame markets such as China where
multi-byte characters are
allowed. A string containing
the wildcard (%) character
can also be provided. The
matching entries.
Extension This field indicates the 7 Numeric string ““
Extension number of the
subscriber (BGL). It is an
optional field and being used
for intra BG calls display only.
DisplayName Please refer to Section 5.4, 1..20 Character string N/A
on page 78. A string
containing the wildcard (%)
character can also be
provided. The function will
then return matching entries.
UnicodeDisplay A display name for use in 1..24 Character string. ““
Name markets such as China where
allowed. A string containing
the wildcard (%) character
can also be provided. The
matching entries.
FeatureProfile Identifies the subscriber’s For further details, see definition of N/A
Id, Feature Profile, a defined set FeatureProfileName in Section 5.4,
FeatureProfile of features that is inherited by “Primitive Data Definitions”, on page 78.
Name the subscriber by virtue of
association with the Feature
Profile.
FeatureProfile The name of the Business For further details, see definition of N/A
Id, BGName Group with which the Feature BGName in Section 5.4, “Primitive Data
Profile is associated. A key Definitions”, on page 78.
field for identification of a
Feature Profile.
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Get Subscriber List

KeysetUse Describes whether a DN is to enum KeysetPrimaryLine N/A
be used for Keyset Operation KeysetPhantomLine
and, if so, in what way. For KeysetNone
descriptions of the possible
values, refer to Section 4.13,
“Keyset Information”, on
page 67.
KeysetUseList Used to provide multiple filter enum N/A
value selection for KeysetUse.
Table 385 lists the input fields for GetSubListSortType.

Value
GetSubListSortLis Select a list of all sorting elements enum SubListSortServiceID_ N/A
t. needed from the subscriber profile. SubListSortBGLineName_
GetSubListSortTy SubListSortUnicodeBGLineN
pe ame_
SubListSortCpuid_
SubListDataInclCpuId_
SubListSortBGDeptName_
SubListSortDisplayName_
SubListSortUnicodeDisplayN
ame_
SubListSortFeatureProfileId
_
SubListSortNumberPlanNam
e_
Table 385 GetSubListSortType Input Fields
Table 386 lists the input fields for GetSubscriberListDataOption.
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Get TombStone Subscriber List

Value
GetSubscriberList Select a list of additional data from enum SubListDataInclBGName_ N/A
DataOptionList the subscriber profile database SubListDataInclBGLineNam
GetSubscriberList table. e_
DataOption SubListDataInclUnicodeBGLi
neName_
SubListDataInclCpuId_
SubListDataInclCpuName_
SubListDataInclExtension_
SubListDataInclBGDeptNam
e_
SubListDataInclDisplayNam
e_
SubListDataInclUnicodeDisp
layName_
SubListDataInclFeatureProfil
eId_
SubListDataInclNumberPlan
Name_
SubListDataInclMlhgOwner_
SubListDataInclMlhgMembe
r_
SubListDataInclKeysetUse_
SubListDataInclOfficeCode_
SubListDataInclMobileDn_]
SubListDataInclAssocEpIP_
SubListDataInclTransportTy
pe_
SubListDataInclSipSecurity_
SubListDataInclIsMainDevic
e
SubListDataInclCpuName
SubListDataInclMlhgList
Table 386 GetSubscriberListDataOption Input Fields
9.4 Get TombStone Subscriber List

This SOAP request provides the ability to display a list of subscribers
deleted after a specified date and/or the list of subscribers that has had
a specific service unassigned (currently only CSTA is supported) after
a specified date.
The tombstone table is a table used to log deleted subscriber entries

and unassigned service entries for a DN.
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Get TombStone Subscriber List

WSDL Version
10.00.03.03 subRC_APP_UTIL_TOMB_ENTRY_TIME_INVALID
subRC_APP_UTIL_TOMB_SQL_FILTER_OUT_OF_RANGE
subRC_APP_UTIL_TOMB_ENTRY_TYPE_FILTER_NOT_ALLOWED
subRC_SYS_UTIL_TOMB_ALLOC_ERR
subRC_SUCCESS
Table 387 Get TombStone Subscriber List Return Codes
Attention: The Default Value column is N/A for most parameters, since these
input parameters are filter criteria. If a parameter is not provided, the default
behavior is that there is no filtering performed based on that particular
parameter.

Paging Paging structure for Get List
requests. For more information,
refer to Section 5.5, “Paging”, on
page 86.
EntryTimeStamp Records returned will be entries xsd__dat Any valid data/time N/A
logged after this specified date. eTime string.
EntryType Filtering condition. If the EntryType TombStoneDeleteSubs N/A
is not specified, all records are criber,
returned. Else the user can choose to TombStoneDeleteServi
request DeletedSubscribers or ce
ServiceRemoved.
Features Valid only when the EntryType = N/A List of pointers to all N/A
TombStone_DeleteService. Filtering possible features on
Condition. Only unassigned features which filtering can be
that match any of the input features performed.
will be returned.
78.
Table 388 Get TombStone Subscriber List Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Get Keyset Primary List
9.5 Get Keyset Primary List

Given a particular DN, returns a list of all subscribers that are Keyset
Primary Lines having the given DN as a Secondary Line Appearance. A
maximum of 40 subscribers are returned, since that is the maximum
number of devices on which a particular DN can appear as a Secondary
Line Appearance.

WSDL Version
04.04.08 N/A subRC_SYS_SUB_KEYSET_ALLOC_ERR
subRC_APP_SUB_KEYSET_LINE_INVALID
subRC_APP_SUB_KEYSET_LINE_MISSING
subRC_DB_SUB_KEYSET_LINE_LOOKUP_FAILED
subRC_SUCCESS
Table 389 Get Keyset Primary List Return Codes

Line The DN of a keyset line See definition of ServiceId in Section 5.4, N/A
Appearance appearance for which the list “Primitive Data Definitions”, on page 78.
of primary keyset lines is
being requested.
StartingSub A DN with which to start. If See definition of ServiceId in Section 5.4, “”
none is provided, starts with “Primitive Data Definitions”, on page 78.
the first subscriber in the
switch.
Max The maximum number of Int 1 to 40 40
Subscribers result entries to return.
Table 390 Get Keyset Primary List Input Fields

TotalSubs The number of keyset Int 0 to 40 N/A
Found primary lines that met the
search criteria.
Keyset The DN of a keyset primary See definition of ServiceId in Section 5.4, N/A
PrimaryId line that met the search “Primitive Data Definitions”, on page 78.
criteria (an array of up to 40
of these returned).
Table 391 Get Keyset Primary List Output Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Delete Subscriber

page 86.
Table 391 Get Keyset Primary List Output Fields (Seite 2 von 2)
9.6 Delete Subscriber

The DeleteSubscriber method is used to remove the subscriber entry.
The subscriber may optionally have been disconnected prior to calling
this routine by calling the DisconnectSubscriber method.
This method removes any aliases, lines, services and other data that
are associated with the DN. If there is a failure, it will continue and
delete everything that it can (in case the tables are inconsistent). It will
set the HomeDn entry to vacant and remove any existing profile or
services data for the subscriber.
If a subscriber is set to be the callback number of a BG subnet, any

attempt to delete the subscriber fails. Additionally any attempt to
remove a DN number which is used as a default callback number in a
Bg subnet is prohibited.
The DeleteSubscriber method may return warnings if it encountered

problems.

WSDL
Version
1.0.1 N/A subRC_APP_SUB_LEN_INVALID
subRC_APP_SUB_DN_IN_USE
subRC_WAR_SUB_TEEN_DELETION_FAILED
subRC_TEEN_LINE_CONFLICT
subRC_APP_SUB_MLHG_OWNER_CANNOT_BE_DELETED
subRC_APP_SUB_MAIN_NUM_CANNOT_BE_DELETED
subRC_APP_SUB_EMERGENCY_NUM_CANNOT_BE_DELETED
subRC_APP_BG_ATT_NUM_DELETION_FAILED
subRC_WAR_SUB_DELETION_FAILED
subRC_SUCCESS
Table 392 Delete Subscriber Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Update Subscriber Status

on page 78.
on page 78.
Table 393 Delete Subscriber Input Fields
9.7 Update Subscriber Status

The UpdateSubscriberStatus method is used to change the status of a
subscriber.

WSDL Version
subRC_APP_SUB_STATUS_INVALID
subRC_APP_SUB_TEEN_UPDATE_STATUS_NOT_ALLOWED
subRC_APP_FEAT_HD_HOT_DESKING_INPROGRESS
subRC_DB_SUB_MODIFY_FAILED
subRC_SUCCESS
Table 394 Update Subscriber Status Return Codes

on page 78.
on page 78.
Status The new administrative enum Active, Blocked required
status of the subscriber
Table 395 Update Subscriber Status Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Update Subscriber Account Mgt Info
9.8 Update Subscriber Account Mgt Info

The UpdateSubscriberAccountMgtInfo method changes the
management information of the subscriber's basic profile.

WSDL Version
V5.00.20.01 N/A subRC_APP_SUB_LEN_INVALID
subRC_APP_SUB_TEEN_UPDATE_ACCOUNT_MGT_NOT_ALLOWED
subRC_APP_FEAT_HD_MODIFICATION_NOT_ALLOWED
subRC_APP_SUB_ACCOUNT_LEN_INVALID
subRC_APP_SUB_BILLING_ID_LEN_INVALID
subRC_APP_SUB_BILLING_ID_INVALID
subRC_DB_SUB_XDM_COS_LOOKUP_FAILED
subRC_APP_SUB_RETAILER_ID_LEN_INVALID
subRC_APP_SUB_XDM_COS_DOES_NOT_EXIST
subRC_DB_SUB_XDM_RATE_AREA_LOOKUP_FAILED
subRC_APP_SUB_XDM_RATE_AREA_DOES_NOT_EXIST
subRC_DB_SUB_XDM_CALL_LOC_LOOKUP_FAILED
subRC_APP_SUB_XDM_CALL_LOC_DOES_NOT_EXIST
subRC_APP_SUB_EXTERNAL_DN_FLAG_INVALID
subRC_APP_NOT_ALLOWED_SETTING_CPU_TO_MOBILEDN
subRC_SUCCESS
Table 396 Update Subscriber Account Mgt Info Return Codes

on page 78.
on page 78.
AccountId Please refer to Section 5.4, N/A
on page 78.
BillingId Please refer to Section 5.4, N/A
on page 78.
Table 397 Update Subscriber Account Mgt Info Input Fields (Seite 1 von 3)
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Update Subscriber Account Mgt Info

RetailerId Please refer to Section 5.4, N/A
on page 78.
ClassOfService Please refer to Section 5.4, N/A
on page 78.
RateArea Please refer to Section 5.4, N/A
on page 78.
TestLineFlag Support removed in V8. N/A
ExternalDNFlag Indicates that the boolean True,false N/A

subscriber DN is a Direct
Inward Dialing (DID)
number. The subscriber can
receive direct incoming
calls. If the External DN Flag
is set to False, the BGL has
a private (non- external)
number. This means the
number cannot be dialed
from outside of the BG and
is not displayed as a calling
party on calls directed
outside the BG. Note that
this flag is also used by the
MLHG service when an
MLHG member originates a
call. If True, the terminal’s
own data is used as the
calling party; otherwise, the
CountryCodeLen Please refer to Section 5.4, N/A
on page 78.
CallingLoc Please refer to Section 5.4, N/A
on page 78.
FeatureProfileId Please refer to Section 5.4, N/A
on page 78.
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Update Subscriber BG Info

NumberPlanName The name of the Private Please refer to Section 5.4, N/A
Numbering Plan to associate “Primitive Data Definitions”, on
with this BGL. In order to page 78.
remove an existing Number
Plan Name assignment, the
parameter can be sent as an
empty string. Thereafter, the
BG’s numbering plan applies.
If the parameter is not sent,
no change is made to the
existing assignment,
ExternalCallerID Char 15 N/A
array (1…15)
UseMainPilotDNInte Optional. Set 1 means that boolean True false
rnalCalls main pilot DN is used for False
internal calls.
When set 0 means that main
pilot DN is not used for
internal calls.
UseMainPilotDNExte Optional. Set 1 means that boolean True false
rnalCalls main pilot DN is used for False
external calls.
When set 0 means that main
pilot DN is not used for
external calls.
ImpactLevel The security zone of a enum ImpactLevelZero,
subscriber. ImpactLevelOne,
V7.00.15.01 ImpactLevelTwo,
ImpactLevelThree,
ImpactLevelFour,>
ImpactLevelFive,
ImpactLevelSix,
ImpactLevelSeven,
ImpactLevelEight
ImpactLevelNine
ImpactLevelUnclassifie
d
9.9 Update Subscriber BG Info

The UpdateSubscriberBGInfo method enables the user to change the
BG Info related to the subscriber.
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Update Subscriber BG Info

WSDL Version
04.07.01 11.00.01.01 subRC_APP_SUB_LEN_INVALID
subRC_APP_BG_LINE_NAME_LEN_INVALID
subRC_APP_BG_EXTENSION_LEN_INVALID
subRC_APP_BG_DEPT_NAME_BG_NAME_CONFLICT
subRC_APP_BG_LINE_NAME_BG_NAME_MISSING
subRC_APP_BG_EXTENSION_BG_NAME_MISSING
subRC_APP_BG_ATT_NUM_BG_NAME_MISSING
subRC_APP_BG_CPU_ID_OUT_OF_RANGE
subRC_DB_BG_CPU_ID_NUMBER_LOOKUP_FAILED
subRC_APP_BG_CPU_ID_NUMBER_OUT_OF_RANGE
subRC_DB_BG_NUMBER_CPU_LOOKUP_FAILED
subRC_APP_BG_CPU_SUB_OUT_OF_RANGE
subRC_APP_BG_ATT_NUM_DELETION_FAILED
subRC_DB_SUB_INSERTION_FAILED
subRC_SUCCESS
subRC_APP_UNICODE_BG_LINE_NAME_LEN_INVALID
Table 398 Update Subscriber BG Info Return Codes

on page 78.
on page 78.
on page 78.
BGLineName The subscriber member 20 Character string ““
name.
Table 399 Update Subscriber BG Info Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Update Subscriber Account User Info

UnicodeBGLineN A BG Line name for use in 1..24 Wide character string. ““
ame markets such as China where
allowed.
BGAttendantNu Indicates the DN is used for Boolean True, False False
mber the Attendant Number
function of the BG.
CpuId A Call Pickup group Id to Int 1-10000 0 – no CPU Id
which this subscriber (BGL)
belongs. There can be only
one CPU group ID per
subscriber. The CfCPU service
must be provisioned either by
explicit assignment or
Feature Profile inheritance in
order for the CPU service to
be effective. A value of 0
indicates that the subscriber
is not part of any CPU.
CpuName Call Pickup group name Character string
CpuNotification Notification Timer for Call Pick Int 0…60 0
DelayTimer Up
Extension This field indicates the 7 Numeric string ““

Extension number of the
subscriber (BGL It is an
optional field and being used
for intra BG calls display only.
BGDeptName The department name 20 Character string ““
associated with the
Subscriber.
Table 399 Update Subscriber BG Info Input Fields (Seite 2 von 2)
9.10 Update Subscriber Account User Info

The UpdateSubscriberAccountUserInfo method changes the user-
controlled information of the subscriber's basic profile.
A31003-H80A0-T101-1-7618, 11/2021
Subscriber

WSDL Version
subRC_APP_SUB_ACC_USER_INFO_TEEN_NOT_ALLOWED
subRC_APP_SUB_USER_INFO_DISPLAY_NAME_OUT_OF_RANGE
subRC_APP_SUB_USER_INFO_TIME_ZONE_LEN_INVALID
subRC_APP_SUB_USER_INFO_TIME_ZONE_INVALID
subRC_DB_SUB_USER_INFO_TIME_ZONE_LOOKUP_FAILED
subRC_APP_SUB_ACC_USER_INFO_PIN_LEN_INVALID
subRC_APP_SUB_ACC_USER_INFO_PIN_INVALID
subRC_APP_SUB_HD_PIN_CONFLICT
subRC_SUCCESS
subRC_APP_SUB_USER_INFO_UNICODE_DISPLAY_NAME_OUT_OF_
RANGE
Table 400 Update Subscriber Account User Info Return Codes

on page 78.
on page 78.
Note that for this request, if
the OperatorId is equal to
the ServiceId, this is treated
as an indication that the
request is from the iSSC
(Subscriber Self-Care), and
thus the subscriber’s profile
is not updated to reflect the
time of the update and the
ID of the operator, since
these fields are intended to
record updates by
operators other than the
end user (subscriber).
DisplayName Please refer to Section 5.4, N/A
on page 78.
Table 401 Update Subscriber Account User Info Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Subscriber

UnicodeDisplay A display name for use in 1..24 Character string. ““
Name markets such as China where
allowed.
TimeZone Please refer to Section 5.4, N/A
on page 78.
Pin1 Please refer to the definition N/A
of Pin in Section 9.1, “Create
of Pin
in Section 9.1, “Create
of Pin
of Pin
of Pin
PublicPin Please refer to the definition N/A
of PublicPin in Section 9.1,
“Create Subscriber”, on page
342. Note: added in WSDL
version 10.00.08.01.
Language Please refer to Section 5.4, N/A
on page 78.
BusinessAuthCo Subscriber can make char 2…14
de Business call
PrivateAuthCode Subscriber can make private char 2…14

call
Table 401 Update Subscriber Account User Info Input Fields (Seite 2 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Update Keyset Info
9.11 Update Keyset Info

The UpdateKeysetInfo method is used to update the keyset-related
data for a keyset subscriber. Data that can be modified includes:
KeysetUse (None, Primary, or Phantom); KeysetOperationMode
(DeviceBased or LineBased); ManualHoldTimer; and
KeysetLineAppearances (full list must be provided).

WSDL Version
05.04.02a subRC_APP_SUB_LEN_INVALID
10.00.01.34b subRC_APP_SUB_DN_INVALID
V5.00.20.01 subRC_APP_COMM_OPERATOR_INVALID
subRC_APP_EP_TYPE_INVALID
subRC_APP_SUB_KEYSET_USE_MISSING
subRC_APP_SUB_KEYSET_USE_INVALID
subRC_APP_SUB_KEYSET_REG_TYPE_INVALID
subRC_APP_SUB_KEYSET_DATA_MISSING
subRC_DB_SUB_KEYSET_LINE_DATA_INCONSISTENCY
subRC_APP_SUB_KEYSET_LINE_APP_CONFLICT
subRC_APP_SUB_KEYSET_CALL_FRW_LED_IND_CONFLICT
subRC_APP_SUB_KEYSET_MANUAL_HOLD_TIMER_INVALID
subRC_APP_SUB_KEYSET_LINE_NUMBER_OUT_OF_RANGE
subRC_APP_SUB_KEYSET_LINE_INVALID
subRC_APP_SUB_KEYSET_LINE_DOES_NOT_EXIST
subRC_DB_SUB_KEYSET_LINE_LOOKUP_FAILED
subRC_APP_SUB_KEYSET_LINE_APP_NOT_KEYSET
subRC_APP_SUB_KEYSET_LINE_APP_BG_CONFLICT
subRC_APP_SUB_KEYSET_LINE_ZERO_LENGTH_INVALID
subRC_APP_SUB_KEYSET_SUB_NUM_OUT_OF_RANGE
subRC_DB_COMM_INTERNAL_RECOVERY_ERROR
subRC_DB_SUB_KEYSET_MODIFY_FAILED
subRC_APP_SUB_KEYSET_MANUAL_HOLD_TIMER_OUT_OF_RANGE
subRC_DB_SUB_KEYSET_INFO_DELETION_FAILED
subRC_APP_SUB_KEYSET_SHARED_MEM_FAILED
subRC_DB_EP_XDM_DELETION_FAILED
subRC_DB_EP_XDM_CREATE_FAILED
subRC_APP_KEYSET_OSMO_CONFLICT
aAdded KeysetUse as a modifiable parameter.
bAdded CallForwardLEDIndication.
Table 402 Update Keyset Info Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Update Keyset Info

OperatorId Please refer to Section 5.4,
on page 78.
KeysetUse Describes whether a DN is to enum KeysetPrimaryLine N/A
be used for Keyset Operation KeysetPhantomLine
and, if so, in what way. For KeysetNone
descriptions of the possible
values, refer to Section 4.13,
“Keyset Information”, on
page 67.
KeysetManualHo Activated when the user integer 5..3600 (seconds) 401
ldTimer places the line on manual
hold. If this line is picked up
on any device where this DN
has an appearance, the timer
is stopped. If the timer
expires, the device on which
the call was placed on hold is
recalled.
KeysetLine Applicable only when 1..630 See Section 4.13, “Keyset N/A
Appearances KeysetUse is Information”, on page 67.
KeysetPrimaryLine. A list of
DNs to be associated as
secondary lines on the device
where the subscriber/BGL
being updated is the
KeysetPrimaryLine. Along
with each DN is an Originating
Operation Mode and a
Terminating Operation Mode.
Refer to Section 4.13, “Keyset
Information”, on page 67 for
more information.
CallForward Indicates whether the line Boolean True, False True1
LEDIndication key LEDs on the device where
this subscriber is the Keyset
Primary shall wink whenever
those lines have call
forwarding active. This
parameter is optional when
creating a subscriber and
when updating keyset info for
a subscriber.
1The default value for this parameter applies only to the CreateSubscriber SOAP request. For the UpdateKeysetInfo SOAP
request, the default is not used. If the tag is sent, the value is applied; if not, the existing value is left unchanged.
Table 403 Update Keyset Info Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Update Subscriber Dn
9.12 Update Subscriber Dn

The UpdateSubscriberDn method is used to change the DN of a
subscriber. The new DN must have been defined as available on the
switch and Available (vacant).
Calls to the old number will produce either a disconnect or NewNumber

announcement. A flag is used to control the announcement, because
the new number may be nonpublished.
If a subscriber is changed to a DN number that already exists as a

callback number of a BG subnet, any attempt to delete the subscriber
fails. Additionally any attempt to change a DN number which is used as
a default callback number in a Bg subnet is prohibited.
See subscriber interactions for potential consequences of using this

method.

WSDL Version
06 N/A subRC_SUCCESS
subRC_APP_SUB_DN_EXIST
subRC_APP_SUB_TEEN_UPDATE_CONNECTION_NOT_ALLOWED
subRC_APP_SUB_MLHG_OWNER_CONFLICT
subRC_APP_SUB_MLHG_MEMBER_CONFLICT
subRC_APP_SUB_OFFICE_CODE_DOES_NOT_EXIST
subRC_APP_SUB_HOME_DN_DOES_NOT_EXIST
subRC_DB_SUB_FEATURE_MODIFY_ERROR
Table 404 Update Subscriber Dn Return Codes (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Update Subscriber Dn

WSDL Version
subRC_DB_EP_SIP_LOOKUP_FAILED
subRC_DB_EP_SIP_INSERTION_FAILED
subRC_DB_COMM_RTM_DELETION_FAILED
subRC_DB_COMM_RTM_CREATION_FAILED
subRC_DB_COMM_XDM_ALIAS_LOOKUP_FAILED
subRC_DB_EP_XDM_DELETION_FAILED
subRC_APP_SUB_NOT_BELONG_BG
subRC_APP_FEAT_CPS_REQUIRES_CT
subRC_APP_FEAT_CPS_INVALID_CPS_SETTINGS
subRC_APP_LOTID_ASSIGN_TO_FP_FAILURE
subRC_APP_LOTID_UNASSIGN_FROM_FP_FAILURE
subRC_APP_LOTID_CHANGE_IN_FP_FAILURE
subRC_APP_LOTID_RETRIEVE_FAILURE
Table 404 Update Subscriber Dn Return Codes (Seite 2 von 2)

on page 78.
on page 78.
InterceptAnnou The intercept announcement Enum None, N/A
ncement to which calling parties are Disconnect,
routed after this subscriber’s NumberChange
number is changed.
NewServiceId This field is used when a See definition of ServiceId in Section 5.4, required
subscriber’s ServiceId has “Primitive Data Definitions”, on page 78.
changed. It may optionally be
played during the
NumberChange
announcement.
Table 405 Update Subscriber Dn Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Update Subscriber Features
9.13 Update Subscriber Features

The UpdateSubscriberFeatures method is used to add, edit, remove, or
deny features to a subscriber.
WSDL Obsolete in Return Codes Comments

Version WSDL
Version
subRC_DB_SUB_FEAT_XDM_RCF_ERROR
subRC_APP_FEAT_RCF_CONFLICT
subRC_APP_FEAT_BGCNAM_DENY_NOT_ALLOWED
subRC_APP_FEAT_BGCNAM_MODIFY_NOT_ALLOWED
subRC_APP_FEAT_BGCNAM_NAMEDB_SCP_INVALID
subRC_APP_SUB_NOT_BELONG_BG
subRC_APP_FEAT_BGCT_DENY_NOT_ALLOWED
subRC_APP_FEAT_BGCT_MODIFY_NOT_ALLOWED
subRC_APP_FEAT_BGDAPPS_DENY_NOT_ALLOWED
subRC_APP_FEAT_BGDAPPS_MODIFY_NOT_ALLOWED
subRC_APP_FEAT_BGDAPPS_INTA_BG_DISPLAY_CONFLICT
subRC_APP_FEAT_BGDNPPS_DENY_NOT_ALLOWED
subRC_APP_FEAT_BGDNPPS_MODIFY_NOT_ALLOWED
subRC_APP_FEAT_BGDNPPS_PPS_CALLER_ID_CONFLICT
subRC_APP_FEAT_BGDNPPS_CALLER_ID_INVALID
subRC_SYS_UTIL_GET_TIME_FAILED
subRC_APP_FEAT_BGCISNAME_NAMEDB_SCP_INVALID
subRC_APP_FEAT_CNAM_DENY_NOT_ALLOWED
subRC_APP_FEAT_CNAM_MODIFY_NOT_ALLOWED
subRC_APP_FEAT_CT_DENY_NOT_ALLOWED
subRC_APP_FEAT_DAPPS_DENY_NOT_ALLOWED
subRC_APP_FEAT_DAPPS_MODIFY_NOT_ALLOWED
subRC_APP_FEAT_DNPPS_DENY_NOT_ALLOWED
Table 406 Update Subscriber Features Return Codes (Seite 1 von 3)
A31003-H80A0-T101-1-7618, 11/2021
Subscriber

Version WSDL
Version
subRC_APP_FEAT_ECF_DAY_INVALID
subRC_APP_FEAT_ECF_START_TIME_INVALID
subRC_APP_FEAT_ECF_STOP_TIME_INVALID
subRC_APP_FEAT_ECF_START_STOP_TIME_CONFLICT
subRC_APP_FEAT_ECF_TIME_RANGE_OVERLAPPED
subRC_APP_FEAT_IN_PROFILE_NAME_DOES_NOT_EXIST
subRC_DB_FEAT_IN_REF_COUNT_MODIFY_FAILED
subRC_DB_FEAT_PRES_MODIFY_FAILED
subRC_APP_FEAT_SPCALL1_DN_INVALID
subRC_APP_FEAT_SPCALL1_CODE_INVALID
subRC_APP_FEAT_SPCALL2_DN_INVALID
subRC_APP_FEAT_SPCALL2_CODE_INVALID
subRC_APP_FEAT_TRS_RESTRICTED_DN_INVALID
subRC_VMWI_NOTIFY_FAILURE
subRC_APP_FEAT_VM_NOTIFY_FAILED
subRC_APP_FEAT_HD_LOOKUP_FAILED
subRC_APP_FEAT_HD_SIDE_NOT_ALLOWED
subRC_APP_FEAT_HD_ROUTING_ERROR
subRC_APP_FEAT_HD_REMOTE_ASSIGN_NOT_ALLOWED
subRC_APP_FEAT_SCC_ASSIGN_NOT_ALLOWED
subRC_APP_FEAT_SCC_BG_LARGE_CONFERENCE_REQUIRE
D
V4.00.04.0 subRC_APP_SUB_NOT_BELONG_BG 30100006
1 Attempt to assign
CPS feature, but
subscriber not part
of BG
subRC_APP_FEAT_CPS_REQUIRES_CT 31158000
Feature CPS
require CT.
subRC_APP_FEAT_CPS_INVALID_CPS_SETTINGS 31158001
Setting both
Parking Allowed
and Retrieval
Allowed to false
is forbidden
A31003-H80A0-T101-1-7618, 11/2021
Subscriber

Version WSDL
Version
subRC_APP_LOTID_ASSIGN_TO_FP_FAILURE 33000019
Failure to assign
lot index to
feature profile
subRC_APP_LOTID_UNASSIGN_FROM_FP_FAILURE 33000020
Failure to
unassign lot
index from
feature profile
subRC_APP_LOTID_CHANGE_IN_FP_FAILURE 33000021
Failure to change
lot index to
feature profile
subRC_APP_LOTID_RETRIEVE_FAILURE 33000022
Failure to get Lot
Data Entry

on page 78.
on page 78.
Note that for this request, if
the OperatorId is equal to
the ServiceId, this is treated
as an indication that the
request is from the iSSC
(Subscriber Self-Care), and
thus the subscriber’s profile
is not updated to reflect the
time of the update and the
ID of the operator, since
these fields are intended to
record updates by
operators other than the
end user (subscriber).
ListOfFeatures The list of features to be A list of pointers to the data N/A
modified. structures of all the features to
be modified. The supported
features are discussed in
Chapter 10, “Features”
Table 407 Update Subscriber Features Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Get Sub Tran Status
9.14 Get Sub Tran Status

The Get Sub Tran Status SOAP request is used to retrieve the transient
status of a subscriber. The information about the current status of the
specified subscriber is obtained from the PDM (Port Data Manager)
component.

WSDL Version
subRC_SYS_RTP_CONNECTION_ERROR
subRC_APP_SUB_PDM_TRAN_STATUS_RESPONSE_ERROR
subRC_APP_SUB_PDM_TRAN_STATUS_TOKEN_ERROR
Table 408 Get Sub Tran Status Return Codes

OperatorId The operator issuing the Please refer to the definition of Operator ID required
command. in Table 10 in Section 5.4.2, “Field
Definitions” .
ServiceId The DN for which the status is Please refer to Section 5.4, “Primitive Data required
being requested. Definitions”, on page 78.
Table 409 Get Sub Tran Status Input Fields

Value
ServiceId The DN for which the status Please refer to Section 5.4, “Primitive Data N/A
has been requested. Definitions”, on page 78.
CallLegDataList A list of CallLegDataEntry elements, each consisting of the following attributes:
(CallLegData An integer value identifying integer 1..max number of possible call N/A
Entry) the call leg to which this data legs
Id entry element applies.
Table 410 Get Sub Tran Status Output Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Update Connection Info

Value
(CallLegData An enumerated value enum Idle, N/A
Entry) describing the current state BLV_Active,
Status of the call. CallSetupOutgoing,
Ringing,
BusyOutgoing,
BusyIncoming,
Releasing
(CallLegData The DN of the original called Please refer to Section 5.4, “Primitive Data N/A
Entry) party for this call leg. Definitions”, on page 78.
OriginalCalled
PartyDn
(CallLegData The DN of the calling party for Please refer to Section 5.4, “Primitive Data N/A
Entry) this call leg. Definitions”, on page 78.
CaliingPartyDn
Table 410 Get Sub Tran Status Output Fields (Seite 2 von 2)
9.15 Update Connection Info

The UpdateConnectionInfo method is used to change the subscriber's
connection information. Not all fields can be updated. The Connection
information is SIP. Table 411 lists the return codes for this method.
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Update Connection Info

WSDL Version
subRC_APP_EP_TYPE_INVALID
subRC_APP_EP_DISCONNECTED
subRC_DB_COMM_RTM_MODIFY_FAILED
subRC_APP_SUB_MLHG_OWNER_CONFLICT
subRC_APP_SUB_MLHG_MEMBER_CONFLICT
subRC_DB_SUB_XDM_UNASSIGN_FAILED
subRC_APP_EP_IP_INVALID
subRC_DB_EP_MODIFY_FAILED
subRC_APP_EP_SIP_CONNECTION_INFO_MISSING
subRC_APP_EP_SIP_DYNAMIC_IP_CONFLICT
subRC_APP_EP_SIP_STATIC_IP_PORT_MISSING
subRC_APP_EP_PRE_REG_TYPE_DYNAMIC_CONFLICT
subRC_APP_EP_IPPHONE_MAX_SESSIONS_INVALID
subRC_APP_EP_SIP_SCHEME_SECURITY_CONFLICT
subRC_APP_EP_SIP_REALM_LEN_INVALID
subRC_APP_EP_SIP_USER_NAME_LEN_INVALID
subRC_APP_EP_SIP_PASSWORD_LEN_INVALID
subRC_APP_EP_SIP_SECURITY_NUMBER_OUT_OF_RANGE
subRC_DB_EP_SIP_SECURITY_MODIFY_FAILED
Table 411 Update Connection Info Return Codes

“Primitive Data Definitions”, on
page 78.
page 78.
IPPhoneUpdateI Please refer to ConnectionInfo
nfo (IPPhone) definitions in Section
9.1, “Create Subscriber”, on page
342
Table 412 Update Connection Info Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Update Subscriber Feature Profile
9.16 Update Subscriber Feature Profile

This method associates a subscriber with a feature profile. To remove
a subscriber’s association with a feature profile, specify a blank
FeatureProfileName and do not specify a FeatureProfile BgName.

WSDL Version
subRC_APP_FP_NAME_MISSING
subRC_DB_SUB_FP_RESTORE_ORIGINAL_FAILED
subRC_APP_SUB_FP_UPDATE_FAILED
Table 413 Update Subscriber Feature Profile Return Codes

ServiceId The subscriber whose Please refer to Section 5.4, “Primitive Data required
association to a feature Definitions”, on page 78.
profile is being altered.
on page 78.
PreserveLoc If set and the new feature Boolean True, False False
Pres profile has some of the same
service features as the old
feature profile, the
subscriber’s local settings will
be maintained, otherwise, if
false, the subscriber’s
settings for the features
inherited from the feature
profile, will be set to the
values from the feature
profile.
FeatureProfile Identifies the Feature Profile; comprises the Feature Profile Name and the BGName.
ID
Table 414 Update Subscriber Feature Profile Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Add Contact List

(FeatureProfile The name of the feature Please refer to Section 5.4, “Primitive Data required
ID) profile Definitions”, on page 78.
Feature Profile
Name
(FeatureProfile The name of the business Please refer to Section 5.4, “Primitive Data ““
ID) group with which the feature Definitions”, on page 78.
BG Name profile is associated.
Comments: Update the subscriber to the New Feature Profile.
An empty tag of the Feature Profile Name and BGName means to un-assign the subscriber
from the Feature Profile.
Table 414 Update Subscriber Feature Profile Input Fields (Seite 2 von 2)
9.17 Add Contact List

This method adds a contact to a SIP connection.

WSDL Version
subRC_APP_EP_CONTACT_INVALID
subRC_APP_EP_CONTACT_OUT_OF_RANGE
subRC_APP_EP_CONTACT_ADDR_LEN_INVALID
subRC_APP_EP_CONTACT_ADDR_INVALID
subRC_APP_EP_CONTACT_PORT_MISSING
subRC_APP_EP_CONTACT_PORT_INVALID
subRC_APP_EP_CONTACT_TYPE_MISSING
subRC_APP_EP_CONTACT_TYPE_INVALID
subRC_APP_EP_CONTACT_MODIFY_FAILED
Table 415 AddContactList Return Codes

ServiceId Please refer to Section 5.4,
on page 78.
on page 78.
Table 416 AddContactList Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Delete Contact List

HostAddr Host address for Static SIP 255 Valid host address
subscriber.
Port Signaling port of the host Int Valid Port value
address.
IPConnection IPConnectionType – transport Enum UDP, TCP, TLS UDP
Type type
MediaType Mediatype. Display only. Enum mtAudio, mtAudio
mtVideo,
mtInstantMessage
Priority Priority. Not supported yet. Int
TimeToLive Display only. Refer to Section Int (-1..2147483647) -1
9.1, “Create Subscriber”, on -1 = unregistered
page 342. 0 = static registered
(never expired)
ExpirationTime Display only. xsd_dateTime TimeToLive in date and N/A
time format.
Comments: The contact list is allowed only to provision for SIP static subscriber.
Table 416 AddContactList Input Fields (Seite 2 von 2)
9.18 Delete Contact List

This method deletes a contact list.

WSDL Version
subRC_APP_EP_CONTACT_INVALID
subRC_APP_EP_CONTACT_MODIFY_FAILED
Table 417 Delete Contact List Return Codes

on page 78.
Table 418 Delete Contact List Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Get Contact List

on page 78.
HostAddr Host address for static SIP 255 Valid host address
subscriber.
Port Signaling port of the host Int Valid Port value
address.
IPConnection IPConnectionType – transport Enum UDP, TCP, TLS UDP
Type type.
MediaType Mediatype. Display only. Enum mtAudio, mtAudio
mtVideo,
mtInstantMessage
Priority Priority. Not supported yet. Int
TimeToLive Display only. Refer to Section Int (-1..2147483647) -1
9.1, “Create Subscriber”, on -1 = unregistered
page 342. 0 = static registered (never
expired)
ExpirationTime Display only. xsd_date TimeToLive in date and time N/A
Time format.
Comments: The contact list is allowed only to provision for SIP static subscriber.
Table 418 Delete Contact List Input Fields (Seite 2 von 2)
9.19 Get Contact List

This method retrieves a contact list.

WSDL Version
subRC_SYS_EP_CONTACT_ALLOC_ERR
subRC_DB_EP_XDM_CONTACT_LOOKUP_FAILED
Table 419 Get Contact List Return Codes

on page 78.
Table 420 Get Contact List Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Update Mobile Info

on page 78.
requests. For more
information, see Section 5.5,
InterfaceWSDL Refer to Section 5.1.1, “The
Interface WSDL and Interface
Release Control”, on page 73.
Table 420 Get Contact List Input Fields (Seite 2 von 2)
9.20 Update Mobile Info

This method updates mobile info.

WSDL Version
V5.00.20.01 subRC_APP_NOT_ALLOWED_SETTING_KEYSET_TO_MOBILEDN
subRC_APP_FEAT_OSMO_ONS_NOT_ASSIGNED_TO_DESK_PHONE
_DN
subRC_APP_FEAT_OSMO_DESK_PHONE_NUMBER_IN_USE
subRC_APP_SUB_OSMO_FEATURES_CONFLICT
subRC_APP_SUB_OSMO_MLHG_MEMBER_CONFLICT
subRC_APP_SUB_OSMO_REMOVAL_FAILURE
subRC_APP_FEAT_OSMO_CSTA_NOT_ASSIGNED_TO_DESK_PHONE
_DN
Table 421 Update Mobile Info Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Update Mobile Info
Field Name Description Require Length Range Default Value

d
Operator ID Please refer to Section 5.4, “Primitive
Service ID The subscriber to whom will yes Please refer to Section 5.4, “Primitive
assign/remove OSMO Data Definitions”, on page 80.
capability
MobileFlag Enables OSMO capability No Boolean False false
true
MainDeviceDN The associated Deskphone No (yes Please refer to Section 5.4, “Primitive
when Data Definitions”, on page 80.
MonileFla
g = true)
CellDeviceNumb Cell phone number of an no string [1-29] NA
er OSMO ‘+’ before number is
required
RouteToCell Option to route the call to the No boolean [false,true] NA
mobile phone (cell device Must not be true
number) when
V7.01.01.01 CellDeviceNumber
is not defined
MobileDeviceRin Ring duration for the Mobile No integer 5,10,15 up to 10 up to

gDuration subscriber V7.00.23.01) V7.00.23.01)
1-25 from 15 from
V7.00.24.01 V7.00.24.01
MainDeviceRing Ring duration for the No integer 5,10,15 up to 10 up to
Duration Deskphone V7.00.23.01) V7.00.23.01)
1-25 from 15 from
V7.00.24.01 V7.00.24.01
CellDeviceRingD Ring duration for the cellular no integer 5,10,15 up to 10 up to
uration phone V7.00.23.01) V7.00.23.01)
1-25 from 15 from
V7.00.24.01 V7.00.24.01
· OSMO – DeskPhone Synchronization:

When assigning OSMO service to a subscriber, the following Subscriber OSMO fields are inherited from tthe
DeskPhone subscriber:
Table 422 Update Mobile Info Input Fields (Seite 1 von 3)
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Update Mobile Info

d
LocalRealm This identifies the local realm. 0..128 Character “” OR if subscriber is LocalRealm
A realm is a string to be string OSMO, then it is
displayed to users for assigned the
association with its username LocalRealm value of
and password. For a trusted the DeskPhone
entity, this parameter should
not be provisioned. For a
nontrusted
entity, if this parameter
is not provisioned, the default
localhost entry information is
used.
LocalUserName This identifies a user within 0, 6..64 Character “”OR if subscriber is LocalUserName
the string OSMO, then it is
local realm. For a trusted assigned the OSMO
entity, this parameter should Subscriber DN value
not be provisioned. For a
nontrusted
entity, if this parameter
is not provisioned, the default
localhost entry information is
used.
LocalPassword The password for the local 6..20 Character “” OR if subscriber is LocalPassword
user within the local realm. string OSMO, then it is
For assigned the
a trusted entity, this LocalPassword
parameter value of the
should not be provisioned. DeskPhone
For
a non-trusted entity, if this
parameter is not provisioned,
the default localhost entry
BGLineName Business Group Line Name is 0-20 Character “” OR if subscriber is BGLineName
the string OSMO, then it is
subscriber member name. assigned the
LocalRealm value of
the DeskPhone
UnicodeBGLineN A BG Line name for use in 1…24 Wide “”OR if subscriber is UnicodeBGLine
ame markets such character OSMO, then it is Name
as China where multi-byte string. assigned the OSMO
characters are Subscriber DN value
allowed.
A31003-H80A0-T101-1-7618, 11/2021
Subscriber
Update Mobile Info

d
DisplayName Used for in-switch and VPN 1…20 Character “” OR if subscriber is DisplayName
dialing to string OSMO, then it is
present the calling party’s assigned the
name. Used in LocalPassword
installations where the SCP is value of the
unavailable or the switch is DeskPhone
configured to
use this field instead of the
SCP. This field
may be up to 20 characters in
length;
note, however, that in some
networks,
ISUP supports only 15
characters. In
these environments, only the
first 15
characters of the field will be
sent. SIP
phones may populate a
generic name
field that contains an
alphabetical name
to be associated with the
number. If
populated, that field will be
used instead
of this field. Optional
UnicodeDisplay A display name for use in 1…24 Wide “” OR if subscriber is UnicodeDisplay
Name markets such character OSMO, then it is Name
as China where multi-byte string. assigned the
characters are LocalPassword
allowed. value of the
DeskPhone
A31003-H80A0-T101-1-7618, 11/2021
soap_ext_interfaces_svc.fm
Features
Account Code (CfAcctCode)
10 Features
This chapter describes the list of the features available on the system
for provisioning with the SOAP/XML interface. Only subscribers with the
compatible attributes can subscribe to features. For example, Call
Waiting is not applicable to SIP subscribers and Busy Line
Verification is not applicable for Enterprise customers. For more
detailed descriptive information on OpenScape Voice features, refer to
the OpenScape Voice Feature Description Guide.
In addition to the “Subscribed” parameter (in the Field Name column

in the following sections), features that have attributes will also have a
“Local” parameter. The Local parameter consists of a list of local
presence flags that apply when a feature is inherited from a feature
profile. They are used when displaying data to indicate the attributes
that are overwritten locally (at the subscriber/BGL level), and are used
when updating data to reset the locally overwritten feature data to the
values at the feature profile level. To avoid redundancy, this Local
parameter is not listed for every feature. For further information, refer
to the definition of “Local” in Table 11 on page 79.
Attention: The acronyms that follow the feature name are the tags
used when developing the SOAP client. Some do not match the feature
title as the feature names have been modified for the OpenScape Voice
environment. Note: Cf = calling feature
The features without an “Enabled” attribute default to ‘Active’ when

assigned as there is no way to activate them later. Features having an
“Enabled” attribute default to inactive when assigned without passing
the Enabled attribute, except in a few cases in which the Enabled
attribute was not existing and was added later. In these cases, the
default remains active in order to avoid changing pre-existing behavior.
10.1 Account Code (CfAcctCode)

The Business Group Account Codes feature lets the subscriber add a
number (the account code) into the CDR record for allocation of
charges on billable calls (incoming or outgoing).
The system administrator specifies the number of digits of the account

code. It can be from 2 to 14 digits long; its length is the same for all
stations in a business group.
Table 423 lists the input and output parameters associated with this
feature.
A31003-H80A0-T101-1-7618, 11/2021
Features
Anonymous Caller Rejection (CfACR)

Subscribed Please refer to Section 5.4, required
on page 78.
Enabled Please refer to Section 5.4, False
on page 78.
Table 423 CfAcctCode – Account Code Input and Output Parameters
10.2 Anonymous Caller Rejection (CfACR)

The Anonymous Call Rejection feature provides subscribers the
capability to reject calls from parties who have a privacy feature active
(such as caller ID blocking) that prevents the delivery of the calling
number to the called party.
feature.

on page 78.
on page 78.
SwitchControl Specifies the allowable range enum IntraSwitch UseSwitch
of callback destinations. The InterSwitch Setting
UseSwitchSetting value UseSwitchSetting
indicates that this option is
controlled by a switch wide
RTP configuration parameter
and its setting should be
used. The switch wide
parameter is
Srx/Service/ACAR/
PerSPCSBlkARMsgWICNInfo
Billing Please refer to Section 5.4, FlatRate
on page 78.
Table 424 CfACR – Anonymous Caller Rejection Input and Output Parameters
A31003-H80A0-T101-1-7618, 11/2021
Features
Attendant Answering Position (CfBgNBCPU)
10.3 Attendant Answering Position (CfBgNBCPU)

This feature may be provisioned for a Business Group and is applicable
to the entire business group. It may not be provisioned against
individual subscribers or Business Group Lines and the feature-related
data is not propagated to the subscriber/BGL level.
One of the possible destinations for the Hunt Group Night Service DN
present in the Hunt Group SOAP requests described in Section 15.2,
“Hunt Group Phone Services”, on page 696 is a “Attendant Answering
Position”. The attendant answering position (AAP) feature provides
support for a SIP-based AAP using a DFT, keyset telephone, or a soft
client. The AAP functionality includes night service (automatic and
manual control) to route calls to predefined night stations or other
answering device- for example, to voice messaging, to an automated
attendant application, or to a night bell device.
This is accomplished by the following provisioning steps.
1. BGL_A is created using the CreateSubscriber SOAP request.
2. One or more additional BGLs, BGL_B, BGL_C, and so on, are

created.
3. The Simultaneous Ringing (SRS) feature is assigned to BGL_A using

the UpdateSubscriberFeatures SOAP request.
4. The Attendant Answering Position feature is assigned to the BG,

providing a Night Bell CPU ID.
5. BGL_A, BGL_B, BGL_C, etc are all added to the Night Bell CPU
Group using the UpdateSubscriberBGInfo SOAP request.
The result is a group of lines, all of which ring simultaneously and are
members of the same CPU Group. When a Hunt Group is configured
with the DN of BGL_A as the Night Service DN and Night Service is
active, incoming calls are diverted to BGL_A and all DNs in the Night
Bell CPU Group ring. Any BGL in the BG may then dial a new Night Bell
CPU access code to pick up the incoming call. In this scenario, the
service logic for the Night Service feature must determine the Night
Bell CPU ID for the BG. The SOAP Server allows the provisioning
BgNightBellCPU service with the attribute described in the following
table.
feature.
A31003-H80A0-T101-1-7618, 11/2021
Features
Authorization Code (CfAuthCode)

Night Bell CPU The CPU ID of the Night Bell int 1..10000 N/A
ID CPU Group. The SOAP Server
verifies that the specified
value is within the valid
range. Note that the provided
CPU ID may represent the ID
of an already existing CPU
Group – the administrator
should be aware of this.
This feature is only applicable
at the BG level, and the data
associated with this feature is
not propagated to the BGLs.
Table 425 CfBgNBCPU – Night Bell CPU Input and Output Parameters
10.4 Authorization Code (CfAuthCode)

The Business Group Authorization Codes feature provides the
capability to control access to calls to parties outside the business
group. The system administrator specifies the number of digits of the
account code. It can be from 2 to 14 digits long; its length is the same
for all stations in a business group.
To access this feature, the subscriber dials the public network access
code (usually 9), followed by the destination digits. The system then
prompts the subscriber to enter the authorization code. After the
subscriber does so, one of the following events takes place:
• If the authorization code is valid: The call completes normally.
• If the authorization code is invalid: The system prompts the

subscriber to re-enter the authorization code. If the second entry is
also invalid, the call is given intercept treatment.
This service is available only for BGLs and not for residential
subscribers.
feature.

page 78.
Table 426 CfAuthCode – Authorization Code Input and Output Parameters (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Features
Call Transfer for Endpoint (SIP Applications) (CfEpCT)

page 78.
CORName Class Of Restrictions Name 32 (1…32) N/A
AuthCodeCDR Specifies how Authorization Enum NoAuthAcctCode NoAuthAcct
Code is to be saved in CDR AuthCode Code
records. It may be saved as an AcctCode
authorization code, as an BothAuthAcctCode
account code, as both
authorization code and account
code, or may not be saved at
all.
OffnetAuthCode Specifies which traffic types Structure False
require Off-Net Authorization.
Table 426 CfAuthCode – Authorization Code Input and Output Parameters (Seite 2 von 2)
10.5 Call Transfer for Endpoint (SIP Applications) (CfEpCT)

SIP Endpoints, configured with the endpoint profile, were restricted
from invoking the call transfer feature. As an alternative, such
endpoints employed the re-invite mechanism with the result that two
channels were held up for the duration of the call. In an IVR or voice
mail system, such a mechanism had a huge impact on performance
and capacity. The call transfer mechanism is needed for Genesys and
other IVRs and Xpressions. In the case of Xpressions, if the call transfer
feature functionality is available, all SIP ports on XPressions could use
a single SIP connection for the calls. Further, this single SIP connection
could be secured by TLS. The CfEpCT feature is applicable only to
endpoint profiles.
feature.

Subscribed Please refer to Section 5.4, “Primitive required
Enabled Please refer to Section 5.4, “Primitive False
Comments CfEpCT feature was introduced in WSDL version 12.00.01.23
Table 427 Call Transfer for Endpoint (SIP Applications) Input and Output Parameters
A31003-H80A0-T101-1-7618, 11/2021
Features
Completion of Calls on Busy Subscriber (CfCCBS)
10.6 Completion of Calls on Busy Subscriber (CfCCBS)

The Completion of Calls on Busy Subscriber service (CCBS) enables
calling subscriber A to be recalled when called subscriber B becomes
free. When subscriber A accepts the CCBS recall, a call is re-initiated
to destination B. The CCBS is introduced as a new service to meet the
overall requirement, even though its functionality is similar to the
existing features Automatic Callback (AC) and Automatic Recall (AR).
The CCBS service can be provisioned to all subscribers on a switch-wide
basis or to individual subscriber per subscription basis. When the CCBS
service is subscribed, the generic features Completion of Calls (CCS)
and Deactivate Completion of Calls (DCCS) are also automatically
assigned to the subscriber. Likewise, the removal of both CCBS and
CCNR unassigns CCS and DCCS from the subscriber automatically.
feature.

on page 78.
Table 428 CfCCBS – Completion of Calls on Busy Subscriber Input and Output Parameters
10.7 Completion of Calls on No Reply (CfCCNR)

The Completion of Calls on No Reply service (CCNR) enables calling
subscriber A to be notified when called subscriber B does not answer
and has became free after having initiated an activity. When subscriber
A accepts the CCNR recall, a call is re-initiated to destination B. The
CCNR is introduced as a new service to meet the overall requirement,
even though its functionality is similar to the existing feature Automatic
Callback (AC). The CCNR service can be provisioned to all subscribers
on a switch-wide basis, or to individual subscriber per subscription
basis. When the CCNR service is subscribed, the generic features CCS
and DCCS are automatically assigned to the subscriber. Likewise, the
removal of the CCNR service unassigns CCS from the subscriber
automatically.
feature.
A31003-H80A0-T101-1-7618, 11/2021
Features
Call Forward Invalid (CfCFID)

Subscribed Please refer to Section 5.4.2, required
“Field Definitions”, on page
79.
Table 429 Completion of Calls on No Reply Parameters
10.8 Call Forward Invalid (CfCFID)

The CFID feature is an endpoint profile feature that will allow the
administrator to select an alternate target. The specified alternate
target will be any dialable DN (number) and should successfully
translate into valid destinations routable via the OpenScape Voice
system. If the translation of the alternate target fails, the legacy
capability (routing to media server intercept) will be retained. If no
alternate target is specified, the service will remain disabled, although
assigned to the Endpoint Profile.
feature.

ServiceId Alternate Target (DialableDN) that char 1..30 N/A
should successfully translate into valid array
destinations routable via OpenScape
Voice. This field is mandatory in case of
Enabled=true.
Table 430 Call Forward Invalid Information Parameters
10.9 Call Forward System Internal External (CfCFSIE)

This feature allows the subscriber to configure different forwarding
destinations to be used for calls that are internal to the subscriber’s
Business Group and calls that are external to the Business Group.
Separate destinations can be configured for the forwarding of all calls,
forwarding of calls when the subscriber is busy, forwarding of calls
when the subscriber does not answer, and forwarding of calls when the
subscriber has “do not disturb” active.
A31003-H80A0-T101-1-7618, 11/2021
Features
Call Forward System Internal External (CfCFSIE)
These scenarios correspond to those scenarios that would be handled

by the Call Forwarding - All Calls (CFV), Call Forwarding Busy Line
(CFB), Call Forwarding Don’t Answer (CFDA), and Do Not Disturb
(DND) services respectively, but note that the CFSIE feature is
separate and distinct from those services, and the data related to CFV,
CFB, CFDA, and DND, including the Enabled state of the feature, is
configured as part of the CFSIE feature, and not by assignment of those
services separately.
Also note, however, that the Voice Mail (VM) service does interact with
this service, in that if the destination to which the DN is forwarded in
the CFSIE service and the subscriber desires the message waiting
indications to be enabled (VMWI and AMWI), the VM feature must be
subscribed separately and those attributes set accordingly. The VM
feature does not need to be active, nor is the destination associated
with VM used by CFSIE.
This feature is allowed only for Business Group Lines and does not
apply to residential subscribers.
feature.

DetermineCallBas Works with the following 2 fields. Boolean True, false
edOnTransferring
Num
RingDurationIntC Indicates the duration for which the Boolean True, false
all phone will ring before (if not
answered) the call will be redirected.
Used in connection with the “no
answer” portion of this service feature.
RingDurationExtC Indicates the duration for which the Boolean True, false
all phone will ring before (if not
Used in connection with the “no
answer” portion of this service feature.
CFAllInternalDest The number to which internal calls are Please refer to the definition of required if the
forwarded when Enabled is true and Forwarding Destination in feature is
CFAllEnabled is true. Section 5.4, “Primitive Data Enable
Table 431 CfCFSIE – Call Forward System Internal External Input and Output Parameters (Seite 1 von
3)
A31003-H80A0-T101-1-7618, 11/2021
Features
Call Forward System Internal External (CfCFSIE)

CFAllExternalDest The number to which external calls are Please refer to the definition of required if the
forwarded when Enabled is true and Forwarding Destination in feature is
CFAllEnabled is true. Section 5.4, “Primitive Data Enable
CfAllEnabled Indicates whether the forwarding of all Please refer to Section 5.4, False
calls is Enabled. “Primitive Data Definitions”, on
page 78.
CFAllPriviledgedIn Indicates whether phones are
ternal privileged to set CfAllEnabledInternal.
CFAllPriviledgedE Indicates whether phones are
xternal privileged to set CfAllEnabledExternal.
CFBusyInternalDe The number to which internal calls are Please refer to the definition of At least one
st forwarded when Enabled is true and Forwarding Destination in destination
CFBusyEnabled is true and the Section 5.4, “Primitive Data (either internal
subscriber's phone is busy. Definitions”, on page 78. or external) is
required if the
CFBusyExternalD The number to which external calls are Please refer to the definition of
feature is
est forwarded when Enabled is true and Forwarding Destination in
Enabled.
CFBusyEnabled is true and the Section 5.4, “Primitive Data
subscriber's phone is busy. Definitions”, on page 78.
CFBusyEnabled Indicates whether the forwarding of Please refer to Section 5.4, False
busy calls is Enabled. “Primitive Data Definitions”, on
page 78.
CFBusyPriviledge Indicates whether phones are
dInternal privileged to set
CFBusyPriviledgedInternal.
CFBusyPriviledge Indicates whether phones are
dExternal privileged to set
CFBusyPriviledgedIExternall.
CFNoAnswerInter The number to which internal calls are Please refer to the definition of At least one
nalDest forwarded when Enabled is true and Forwarding Destination in destination
CFNoAnswerEnabled is true and the Section 5.4, “Primitive Data (either internal
subscriber does not answer. Definitions”, on page 78. or external) is
required if the
CFNoAnswerExter The number to which external calls are Please refer to the definition of
feature is
nalDest forwarded when Enabled is true and Forwarding Destination in
Enabled.
CFNoAnswerEnabled is true and the Section 5.4, “Primitive Data
subscriber does not answer. Definitions”, on page 78.
CFNoAnswerEnabl Indicates whether the forwarding of Please refer to Section 5.4, False
ed not answered calls is Enabled. “Primitive Data Definitions”, on
page 78.
CFNoAnswerPrivil Indicates whether phones are
edgedInternal privileged to set
CFNoAnswerPriviledgedInternal.
CFNoAnswerPrivil Indicates whether phones are
edgedExternal privileged to set
CFNoAnswerPriviledgedExternal
3)
A31003-H80A0-T101-1-7618, 11/2021
Features
Call Forward Unreachable (CfCFD)

CFDNDInternalDe The number to which internal calls are Please refer to the definition of At least one
st forwarded when Enabled is true and Forwarding Destination in destination
CFDNDEnabled is true and the Section 5.4, “Primitive Data (either internal
subscriber is in the “do not disturb” Definitions”, on page 78. or external) is
state. required if the
feature is
CFDNDExternalDe The number to which external calls are Please refer to the definition of
Enabled.
st forwarded when Enabled is true and Forwarding Destination in
CFDNDEnabled is true and the Section 5.4, “Primitive Data
subscriber is in the “do not disturb” Definitions”, on page 78.
state.
CFDNDEnabled Indicates whether the “do not disturb” Please refer to Section 5.4, False
state is Enabled and calls are to be “Primitive Data Definitions”, on
forwarded. page 78.
3)
10.10 Call Forward Unreachable1 (CfCFD)

This feature provides call forwarding capability to take place when a
subscriber’s phone is unreachable due to being unregistered, not
responding, or audit blocked. Note that this is not absolute, as there
are features with higher priorities that supersede this forwarding.
This service applies to SIP subscribers, and SIP keysets, both primary
and phantom keyset lines. BGLs can subscribe to the feature, and it can
also be assigned to feature profiles.
feature.

ServiceId Indicates the destination number. Can Please refer to the definition of required if the
be specified only if subscribed to; must Forwarding Destination in feature is
be specified when this feature is Section 5.4, “Primitive Data Enabled
subscribed to and enabled. Can be up Definitions”, on page 78.
to 30 digits in length. Is validated
against any existing TRS Code
restrictions.
Table 432 Call Forward unreachable Information Parameters
1. Call forward unreachable is sometimes known as call forward dependable.
A31003-H80A0-T101-1-7618, 11/2021
Features
Call Forwarding - All Calls (CfCFV)

ExternalServiceID Indicates an external destination Please refer to the definition of Not Mandatory
number that can be specified in the Forwarding Destination in
request. Please note that the service Section 5.4, “Primitive Data
ID specified here should be a routable Definitions”, on page 78.
service ID.
Table 432 Call Forward unreachable Information Parameters
10.11 Call Forwarding 1- All Calls (CfCFV)

The OpenScape Voice system-based Call Forwarding - All Calls feature
provides the capability to redirect calls intended for the subscriber to
another destination. The subscriber activates and deactivates the
feature and specifies the forwarding destination.
This feature can be provisioned at the business group level with a

denied option at the subscriber level. Also known as Call Forwarding
Variable or Call Forward Unconditional. This feature overrides CfCFB
and CfCFDA.
feature.

restrictions.
Table 433 CfCFV – Call Forward Unconditional Input and Output Parameters (Seite 1 von 3)
1. Can be referred to as Station Call Forwarding All Calls.
A31003-H80A0-T101-1-7618, 11/2021
Features
Call Forwarding - All Calls (CfCFV)

SubActivatable Indicates the method by which the enum • None — All
subscriber can activate/deactivate this Subscriber cannot
feature. May be one of the following activate or
values: deactivate this
feature
• Phone — The
subscriber can
activate or
deactivate this
feature via the
Phone
• Web — The
subscriber can
activate or
deactivate this
feature via the
Web.
• All — The
subscriber can
activate or
deactivate this
feature via either
the Web or phone
interfaces.
DestServiceId Indicates the method by which the enum • None — None
SubControllable subscriber can change the destination Subscriber may
of Call Forwarding. This field can be set not change the
to Phone only if SubActivatable is set destination for this
to Phone or All since the subscriber can feature.
change only the destination when the • Phone — The
feature is activated. May be one of the subscriber may
following values. change the
destination for this
feature via the
Phone
• Web — The
subscriber may
change the
feature via the
Web.
• All — The
subscriber may
change the
feature via either
the Web or Phone
interfaces.
A31003-H80A0-T101-1-7618, 11/2021
Features
Call Forwarding Busy Line (CfCFB)

CFNotifyCallingPa If set to CfNotifyCallingPtyNone, no enum CfNotify
rty announcement is played to the calling CallingPty
party. If set to None
CfNotifyCallingPtyWithFwdNumber, an
announcement with the forwarding
number is played to the calling party. If
set to
CfNotifyCallingPtyNoFwdNumber, the
announcement played to the calling
party does not include the forwarding
number. There are three values for the
parameter:
CfNotifyCallingPtyNone
CfNotifyCallingPtyWithFwdNumber
CfNotifyCallingPtyNoFwdNumber
NotifySubCallFwd If this parameter is set to True, a Boolean True, False False
Occurred splash ring will notify the called party
that their call is being forwarded. The
default value is False.
NotifySubCallFwd If set to True, the user is reminded that Boolean True, False False
Active forwarding is currently active. The
notification method can be either tone
or announcement, which is part of the
treatment provisioning, not part of the
feature provisioning.
10.12 Call Forwarding Busy Line (CfCFB) 1
The OpenScape Voice system-based Call Forwarding Busy Line (CFBL)

feature provides the capability to redirect calls intended for the
subscriber to another destination when the subscriber's station is in
use. The subscriber activates and deactivates the feature, and specifies
the forwarding destination.

denied option at the subscriber level.
feature.

page 78.
Table 434 CfCFB – Call Forward Busy Input and Output Parameters (Seite 1 von 3)
1. Can be referred to as Station Call Forwarding Busy Line.
A31003-H80A0-T101-1-7618, 11/2021
Features
Call Forwarding Busy Line (CfCFB)

page 78.
ServiceId Indicates the destination Please refer to the definition of required if the
number. Can be specified only if Forwarding Destination in Section feature is
subscribed to; must be specified 5.4, “Primitive Data Definitions”, on Enabled
when this feature is subscribed to page 78.
and enabled. Can be up to 30
digits in length. Is validated
restrictions.
SubActivatable Indicates the method by which • None — subscriber None.
the subscriber can activate/ cannot activate or
deactivate this feature. May be deactivate this
one of the following values. If not feature.
specified, will default to None. • Phone — the
subscriber can
activate or deactivate
this feature via the
phone.
• Web — the subscriber
can activate or
deactivate this feature
via the Web.
• All — the subscriber
can activate or
deactivate this feature
via either the Web or
phone interfaces.
DestServiceIdSub Indicates the method by which • None — Subscriber None
Controllable the subscriber can change the may not change the
destination of Call Forwarding. destination for this
Can be one of the following feature. Default.
values. This field may only be set • Phone — The
to Phone only if SubActivatable is subscriber may
set to Phone or All as the change the
subscriber can only change the destination for this
destination when the feature is feature via the Phone
activated. • Web — The subscriber
may change the
feature via the Web.
• All — The subscriber
may change the
feature via either the
Web or phone
interfaces.
A31003-H80A0-T101-1-7618, 11/2021
Features
Call Forwarding Don’t Answer (CfCFDA)

CFNotifyCalling There are 3 values for the CfNotifyCalling
Party parameter: PtyNone
• CfNotifyCallingPtyNone
• CfNotifyCallingPtyWithFwd
Number
• CfNotifyCallingPtyNoFwd
Number
If set to CfNotifyCallingPtyNone,
no announcement is played to
the calling party. If set to
CfNotifyCallingPtyWithFwd
Number, an announcement with
the forwarding number is played
to the calling party. If set to
CfNotifyCallingPtyNo
FwdNumber, the announcement
that is played to the calling party
does not include the forwarding
number.
NotifySubCallFwdA If set to True, the served user is True, False False
ctive reminded that call forwarding is
currently active. The notification
method can be either tone or
announcement, which is part of
the treatment provisioning, not
part of the feature provisioning.
10.13 Call Forwarding Don’t Answer (CfCFDA) 1
The OpenScape Voice system-based Call Forwarding Don't Answer

(CFDA) feature provides the capability to redirect calls intended for the
subscriber to another destination if the call is not answered after a
preset number of rings. The subscriber activates and deactivates the
feature and specifies the forwarding destination.

feature.

Table 435 CfCFDA – Call Forwarding Don’t Answer Input and Output Parameters (Seite 1 von 3)
1. Can be referred to as Station Call Forwarding Don’t Answer.
A31003-H80A0-T101-1-7618, 11/2021
Features

restrictions.
NumberOfRings This parameter is obsolete and has 1 – 10 4 (24 seconds)
been replaced with RingDuration,
which indicates the number of ring
cycles after which the call will be
redirected. Assumes six-second ring
cycles at phone.
RingDuration Indicates the duration for which the 0-60 24 seconds
phone will ring before (if not
SubActivatable Indicates the method by which the • None — None
subscriber can activate/deactivate this Subscriber cannot
feature. May be one of the following activate or
values: deactivate this
feature
• Phone — The
subscriber can
activate or
deactivate this
feature via the
Phone
• Web — The
subscriber can
activate or
deactivate this
feature via the
Web.
• All — The
subscriber can
activate or
deactivate this
feature via either
the Web or phone
interfaces.
A31003-H80A0-T101-1-7618, 11/2021
Features

DestServiceId Indicates the method by which the • None — None
SubControllable subscriber can change the destination Subscriber may
of Call Forwarding. This field can be set not change the
to Phone only if SubActivatable is set destination for this
to Phone or All since the subscriber can feature.
change only the destination when the • Phone — The
feature is activated. May be one of the subscriber may
following values. change the
feature via the
Phone
• Web — The
subscriber may
change the
feature via the
Web.
• All — The
subscriber may
change the
feature via either
the Web or Phone
interfaces.
CFNotifyCallingPa If set to CfNotifyCallingPtyNone, no CfNotify
rty announcement is played to the calling CallingPty
party. If set to None
CfNotifyCallingPtyWithFwdNumber, an
announcement with the forwarding
number is played to the calling party. If
set to
CfNotifyCallingPtyNoFwdNumber, the
announcement played to the calling
party does not include the forwarding
number. There are three values for the
parameter:
CfNotifyCallingPtyNone
CfNotifyCallingPtyWithFwdNumber
CfNotifyCallingPtyNoFwdNumber
NotifySubCall If set to True, the user is reminded that True, False False
FwdActive forwarding is currently active. The
notification method can be either tone
or announcement, which is part of the
treatment provisioning, not part of the
feature provisioning.
A31003-H80A0-T101-1-7618, 11/2021
Features
Call Forwarding Voice Mail (CfVM)
1
10.14 Call Forwarding Voice Mail (CfVM)
This service indicates that the subscriber has Voice Mail. VoiceMail is a
combination of CfCFDA and CfCFB. These services are mutually
exclusive and an attempt to add VM or either CFDA or CFB when the
other is provisioned will result in an error. The removal of CfCFDA or
CfCFB will not effect CfVM and vice versa.
feature.

on page 78.
on page 78.
NumberOfRings This parameter is obsolete integer 1 – 10 4 (24 seconds)
and has been replaced with
RingDuration, which
Indicates the number of ring
cycles after which (if not
answered) the call will be
redirected to the Voice Mail
server. Assumes that the
device has six-second ring
cycles.
RingDuration Indicates the duration that integer 0-60 24 seconds
the phone will ring before (if
not answered) the call will be
server.
ServiceId Indicates the destination Please refer to definition of Forwarding N/A
number. Can be specified only Destination in Section 5.4, “Primitive
if subscribed to; must be Data Definitions”, on page 78.
specified when this feature is
subscribed to and enabled. Is
validated against any existing
TRS Code restrictions.
Table 436 CfVM – Voice Mail Input and Output Parameters (Seite 1 von 2)
1. Can be referred to as Station Call Forwarding Voice Mail.
A31003-H80A0-T101-1-7618, 11/2021
Features
Call Forwarding Override (CfCFO)

VMWI Indicates the visual message Boolean False (0) — no VMWI The default
waiting indication capability capability value is based
(lamp capability). This is True (1) — has VMWI on a RTP
applicable only to MGCP capability parameter Srx/
subscribers. Main/VMWI
Not for OpenScape Voice. capability
Default. The
default for the
parameter is
True.
AMWI Indicates whether the audible Boolean False (0) — AMWI disabled True
message waiting indication True (1) — AMWI enabled
(stutter dial tone) is enabled
or disabled. This is applicable
only to MGCP subscribers.
Not for OpenScape Voice.
FwdOnCallReject If the user uses the Reject Boolean False (0) — disabled True
option on the phone, they True (1) — enabled
expect the call to go to voice
mail. That is the default of
this attribute.
FwdOnDND If the user uses DND, they Boolean False (0) — disabled True
expect the call to go to voice True (1) — enabled
mail. That is the default of
this attribute.
Table 436 CfVM – Voice Mail Input and Output Parameters (Seite 2 von 2)
10.15 Call Forwarding Override (CfCFO)

Call Forwarding Override" (CFO) allows a OSV subscriber to dial a Prefix
Access Code + DN in order to reach a called party, and meanwhile
bypass all call forwarding features configured for that called party.
feature.

on page 78.
Table 437 CfCFO – Call Forward Override Input and Output Parameters
A31003-H80A0-T101-1-7618, 11/2021
Features
Call Pickup (CfBgCPU)
10.16 Call Pickup (CfBgCPU)

The Group Call Pickup feature permits stations to be combined into
pickup groups. Pickup groups permit a member to answer a call on
behalf of another member of the group.
feature.

on page 78.
on page 78.
Table 438 CfBgCPU – Call Pickup Input and Output Parameters
10.17 Call Pickup Directed (CfCPUD)

This feature allows a station user to answer a call on another telephone
from their telephone. The feature is allowed only for Business Group
Lines and Feature Profile level (FP). The feature is applicable only to SIP
subscribers with an OpenStage SIP device. Only OpenStage phones
support this feature.
Additionally, only calls to BGLs within the same BG can be picked up,
and only a single dialog can be picked up. Call pickup directed can be
used to pick up calls in the following states:
• Ringing
• Camped on (Call waiting)
Upon subscription, CPUD shall be considered inactive. A field named

“Enabled” shows that the service is inactive for a subscriber when its
value is “false” and active when its value is “true”. The default will be
“false” (considered inactive), when CPUD is subscribed to a BGL.
feature.

on page 78.
Table 439 Call Pickup Directed Parameters
A31003-H80A0-T101-1-7618, 11/2021
Features
Called Party Name Delivery (CfCISNAME)

on page 78.
Table 439 Call Pickup Directed Parameters
10.18 Called Party Name Delivery (CfCISNAME)

Obsolete
10.19 Called Party Number Delivery (CfCISNUM)

Obsolete
10.20 Calling Identity Delivery and Suppression (CfCIDS)

The Calling Identity Delivery and Suppression (CIDS) feature provides
subscribers the capability to deliver or suppress their calling identity
parameters (name and number).

denied option at the subscriber level. Counters are provided for feature
activation attempts. Also known as Outgoing CID Suppression.
feature.

on page 78.
Table 440 CfCIDS – Outgoing Caller ID Suppression Input and Output Parameters
10.21 Calling Name Delivery (CfCNAM)

since V5.
10.22 Calling Name Delivery (BG) (CfBgCNAM)

Obsolete since V5.
A31003-H80A0-T101-1-7618, 11/2021
Features
Calling Name Delivery Blocking (CfCNAB)
10.23 Calling Name Delivery Blocking (CfCNAB)

Obsolete since V5.
10.24 Calling Number Delivery (CfCND)

Obsolete since V5.
10.25 Calling Number Delivery Blocking (CfCNDB)

Obsolete since V5.
10.26 CSTA for ComAssistant (CfCSTA)

This feature indicates the ability of the subscriber to use third-party call
control using the Computer Supported Telephony Application,
ComAssistant. A subscriber can place calls and receive them using the
ComAssistant application. This feature can be subscribed to by
residential subscribers or individual BGLs.
Attention: Whenever the CSTA service is removed from or denied to

a subscriber or BGL, a message is sent to the CSTA Signaling Manager
to tell it to stop monitoring. Likewise, if a subscriber or BGL with the
CSTA service assigned is deleted, the CSTASM is informed via a
message.
feature.

page 78.
Table 441 CfCSTA – CSTA for ComAssistant Input and Output Parameters (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Features
Customer Originated Trace (CfMCT)

CSTAType Indicates the capabilities of the May be one of the following CstaTypeNorm
endpoint. values: al
CstaTypeNorma
CstaTypeSiemensType1
CstaTypeMGCPResidential
CstaTypeMGCPBusiness
CstaTypeCstaOverSip
CstaTypeSpecial2
CstaTypeSpecial3
CstaTypeSpecial4
CstaTypeSpecial5
Monitoring Indicates the current status of
Status a third-party application. This
parameter is read-only. It is
returned in the feature list of
subscribers, but not of the BG.
It cannot be set. It will be
either Active or Inactive.
Table 441 CfCSTA – CSTA for ComAssistant Input and Output Parameters (Seite 2 von 2)
10.27 Customer Originated Trace (CfMCT)

The Customer-Originated Trace feature provides subscribers the
capability to generate an automatic trace of the last call received.
Subscribers typically use this feature in response to malicious,
harassing, or nuisance calls, in order to provide a trace over time of
such activity. Also known as Malicious Call Trace.
A classmark at the subscriber level is required for access to this

feature.
feature.

on page 78.
Enabled Please refer to Section 5.4, boolean true true
“Primitive Data Definitions”, false
on page 78.
Note that unlike some other
features, the default value for
Enabled is true, not false.
on page 78.
Table 442 CfMCT – Malicious Call Trace (Customer Originated Trace) Input and Output Parameters
A31003-H80A0-T101-1-7618, 11/2021
Features
Deny Terminating Feature (CfDTF)
10.28 Deny Terminating Feature (CfDTF)

The Deny Terminating Feature (CfDTF) enables the administrator to
enable or disable Callback Monitoring from a specific subscriber.
Attention: In the future more features will be supported. Currently,

there are three attributes (every new feature that can be denied will
become a new attribute).
feature.

on page 78.
Enabled Please refer to Section 5.4, boolean true false
“Primitive Data Definitions”, false
on page 78.
Note that unlike some other
features, the default value for
Enabled is true, not false.
Callback This attribute, is a Boolean false
Monitoring attribute that if set TRUE, it
shall indicate that callback
monitoring of this subscriber
as a result of the CCBS/CCNR
features invoked by another
subscriber is not allowed.
Table 443 CfDTF – Deny Terminating Feature Input and Output Parameters
10.29 E9-1-1 LIN Administration (CfBgE911LIN)

E9-1-1 LIN Administration indicates that the E9-1-1 service is to be

used to accomplish the routing of emergency calls from BGLs that are
members of this Business Group. Also, the assignment of this service
to a BG is expected to be done only by the authorized overall BG
Controller for the system. The provisioning of this service to a BG
indicates that the BG Administrator for that BG has the capability to use
the BG Subnet commands (see Section 11.14, “Business Group
Subnets”, on page 499).
A31003-H80A0-T101-1-7618, 11/2021
Features
E9-1-1 LIN Administration (CfBgE911LIN)
feature.

Subscribed Subscribe to the service. required
See Section 5.4, “Primitive
E911 Default If an emergency call cannot Please refer to definition of ServiceId in ““
Emergency be routed to a PSAP operator, Section 5.4, “Primitive Data Definitions”, on
Number the call is routed to this page 78. Must be the DN of an existing
number if it exists. This field BGL.
is optional when assigning the
E9-1-1 LIN Administration
feature via the
UpdateBgFeatures request. If
it is supplied, the SOAP
Server verifies through XLA
that the number is routable,
and also verifies that it
corresponds to a BGL that is a
member of the BG being
updated. If these checks fail,
the request is rejected. Note
that the BGL whose DN is
specified as the E9-1-1
Default Emergency Number
may not be deleted unless
this service is updated to
remove the specification of
that DN.
E911 Intercept In case an emergency call 15 Character string; must required
ID cannot be routed to the BG represent a valid intercept.1
default emergency number,
the call is routed to this
intercept. This field is
mandatory when assigning
the E9-1-1 LIN
Administration feature via the
UpdateBgFeatures request.
The SOAP Server verifies that
the specified intercept exists
in the intercept table
(administered via the
OpenScape Voice Assistant);
if it does not, the request is
rejected.
1The list of valid existing intercepts is available using the GetInterceptList SOAP request (see Section 7.8, “Get Intercept
List”).
Table 444 CfBgE911LIN – E9-1-1 LIN Administration Input and Output Parameters
A31003-H80A0-T101-1-7618, 11/2021
Features
Executive Override (CfEXO)
10.30 Executive Override (CfEXO)

This feature may be used to allow a subscriber to barge in to a call in
progress, to prevent other subscribers from using the Executive
Override feature to barge into their calls, or both. The feature is only
allowed for Business Group Lines, not for residential subscribers.
feature.

on page 78.
on page 78.
EXOOption This parameter specifies enum EXO_OvrRide EXO_OvrRide
whether the subscriber shall EXO_BlockOvrRide
be able to use the feature to EXO_OvrRideAndBlockOvrRid
barge in, to block barge in, or e
both.
Table 445 CfECF – Enhanced Call Forward Input and Output Parameters
10.31 Distinctive Ringing (CfBgDR)

The Distinctive Ringing feature may be provisioned for a Business
Group and is applicable to the entire business group. It may not be
provisioned against individual subscribers or Business Group Lines and
the feature-related data is not propagated to the subscriber/BGL level.
This feature provides the ability for the optiPoint 410 S and optiPoint
420 S user to hear different ringing indications for internal and external
calls.
The internal ringing pattern is used for calls received from users within
the business group. The external ringing pattern is used for calls
received from parties outside the business group. The actual ringing
cadences for a given type are defined in the telephone.
The business group administrator controls internal and external ringing

for the entire business group. If this capability is not provisioned, the
ringing configured locally at the telephone is provided.
feature.
A31003-H80A0-T101-1-7618, 11/2021
Features
Do Not Disturb (CfDND)

on page 78.
on page 78.
Comments: The feature is added from the WSDL version 10.00.03.01.
Table 446 CfBgDR – BG Distinctive Ringing Input and Output Parameters
10.32 Do Not Disturb (CfDND)

Do Not Disturb (DND) provides a system-based feature that allows a
subscriber, who does not want to be disturbed with calls terminating to
them, to have the terminating calls immediately diverted to an
announcement indicating the reason for not completing the call to the
expected destination. The diversion of the terminating call occurs
regardless of the busy/idle status of the DND subscriber. The subscriber
with this feature activates the feature to prevent the terminations and
deactivates it to allow calls to terminate.
The diversion can be modified to go to other destinations (i.e., not just

to an intercept) based on the setting of the RTP parameter Srx/Main/
CFSIECompatibility.
Originating calls are still possible when DND is active.
Note the following interactions between the DND feature and the CFSIE
feature in Section 10.9, “Call Forward System Internal External
(CfCFSIE)”:
• DND and CFSIE-DND can be assigned to the same subscriber.
• If DND is not active, then the status of CFSIE-DND is not checked

in the processing of a call.
• If DND is active, then routing occurs based on the setting of the RTP
parameter Srx/Main/CFSIECompatibility,
• When set to Yes,
• If CFSIE-DND is assigned and active, and the type of call

(internal/external) has a forward-to DN provisioned, then
the call is routed to that forward-to DN.
• Otherwise if CFDA is assigned and active, then the call is

routed to that forward-to DN.
A31003-H80A0-T101-1-7618, 11/2021
Features
Hot Desking (CfHotDesk)
• Otherwise if CFVM is assigned and active, then the call is

routed to that forward-to DN.
Note: CFVM cannot be active at the same time as any of the 4

CFSIE features.
• Otherwise if CFSIE-DA is assigned and active, and the type

of call (internal/external) has a forward-to DN provisioned,
then the call is routed to that forward-to DN.
• Otherwise, DND intercept treatment will occur.
• When set to No, DND Intercept Treatment will occur.
When a call is forwarded to a DN with DND active, normal feature

interaction processing occurs, as mentioned above.
feature.

on page 78.
Enabled Indicates whether the feature False
is active or inactive. If not
specified initially, defaults to
False (inactive). Please refer
to Section 5.4, “Primitive
Table 447 CfDND - Do Not Disturb Input and Output Parameters
10.33 Hot Desking (CfHotDesk)

The Hot Desking feature provides subscribers the capability to log on
to and use a telephone in another office. The telephone in the other
office (the remote office telephone) then has all of the same
OpenScape Voice system-provided features and capabilities as the
telephone in the subscriber's office (the home office telephone). This
feature is also known as hoteling.
To operate, Hot Desking must be assigned to both the home office

telephone and on the remote office telephone. Telephone-based
features are not transferred from the home office telephone to the
remote office telephone. The remote office telephone and the home
office telephone must be hosted by the same OpenScape Voice system,
and must both be SIP telephones.
A31003-H80A0-T101-1-7618, 11/2021
Features
Keyset Operation (CfBgKS)
feature.

on page 78.
on page 78.
HotDeskSide The type of hot desking Enum HDRemote required
feature to be assigned to the HDHomeBase
DN.
SessionStatus This is a read-only field that Boolean True, False
displays the session status of
the Hotdesking session.
Table 448 CfHotDesk – Hot Desking Input and Output Parameters
10.33.1 Hot Desking (BG) (CfBgHotDesk)

This feature needs to be assigned at the BG level before any DN in the
BG can be assigned the Hot Desking Feature.
feature.

page 78.
autoLogoffTime The time at which all BGLs Hot TOD Hh:mm format.
desking session will be
automatically terminated.
DisableAutoLogOf Indicates whether auto logoff is boolean true false
f enabled or disabled for hot false
desking subscribers in the
business group.
Table 449 CfBgHotDesk – BG Hot Desk Input and Output Parameters
10.34 Keyset Operation (CfBgKS)

A31003-H80A0-T101-1-7618, 11/2021
Features
Keyset Operation (CfBgKS)
Keyset Operation indicates that the Business Group Lines (BGLs) that
are members of this Business Group may be configured as keyset
devices and use keyset operations, which encompass the following
capabilities:
• SIP telephones may be provisioned with multiple Directory

Numbers (DNs) and a DN may be provisioned on multiple SIP
telephones.
• Calls may be originated from any DN that appears on the telephone.

Calls to a DN are signaled simultaneously at all telephones where
the DN appears and can be answered from any of those telephones.
• The appearances on a telephone are typically associated with line

keys, which have LEDs to show the status of the line (busy, alerting,
holding).
• A call can be placed on hold at one telephone and retrieved from

hold at another telephone that has an appearance of the DN.
Note: The SOAP Server does not restrict the provisioning of keyset
information to only those BGLs that are members of a BG that has this
service subscribed. A SOAP client, however, could do so. For further
information about provisioning keyset information to a sub/BGL, refer
to Section 4.13, “Keyset Information”, on page 67.
feature.

on page 78.
ManualHold The time during which recall int 5..3600 18
RecallTimer is performed after the
expiration of the BGL-level
ManualHoldTimer. After the
timer expires, the call can be
sent to intercept.
Line Used to unreserve the line in int 10..300 120
Reservation cases where the line needs to
Timer be cleared due to non-use.
Table 450 CfBgKS – Keyset Operation Input and Output Parameters
A31003-H80A0-T101-1-7618, 11/2021
Features
Station Controlled Conference (CfBgLC or CfSCC)
10.35 Station Controlled Conference1 (CfBgLC or CfSCC)

The station-controlled conference feature provides subscribers the
capability to establish a conference call with up to 16 participants on
an ad-hoc (on-demand) basis. Conference participants can be
members of the same business group, another business group, or in
the public network.
SCC ad-hoc conference can be initiated by any station with the service
subscribed. Any participant in a large conference with this feature
assigned is considered controller or initiator and as result can add other
participants to the conference. Participants with SCC assigned are
active participants and can add others to the conference. A SIP
subscriber without SCC assigned can be added to the conference, but
then is considered a passive participant and cannot add others to the
conference.
feature.

on page 78.
Minimum The number of reserved ports int 0.. number of available 0
Number of Ports for large conference service conference ports not already
for the BG. reserved by other BGs
Maximum The maximum number of int 0.. number of available 200

Number of Ports large conference ports that conference ports not already
the BG can use reserved by other BGs
simultaneously
Maximum Maximum number of int 1.. maximum number of ports / 1
Number of conferences in simultaneous 3
Conferences per BG.
Maximum Maximum number of int 3.. 16 or maximum number of 3
Number of participants in a conference, ports if minor than 16
Conference defined per BG.
Members
Conference Timer that a recall to int 1..254 30
Recall conference will ring at the
Disconnect device before disconnecting
Timer the call.
PlayEntryExitTo Play tone on conference bool true true
ne entry/exit. false
Table 451 CfBgLC – Station Controlled Conference Input and Output Parameters (Seite 1 von 2)
1. Station Controlled Conference is also known as Large Conference.
A31003-H80A0-T101-1-7618, 11/2021
Features
Music On Hold (CfMOH)

BlockTransferTo Allows or disallows the check bool true false
RestrictedParty whether a subscriber based false
on its TRS settings is allowed
to call another party, based
on its Traffic type. If the
option is activated and two
parties remain in a
conference, where one party
is restricted to call the second
party, the conference is
forced to be released.
Table 451 CfBgLC – Station Controlled Conference Input and Output Parameters (Seite 2 von 2)
Considerations for validation:

Minimum Number of Conference Ports <= Maximum Number of
Conference Ports
Number of available conference ports = Number of System
Conference Ports - summation of (Minimum Number of Conference
Ports) where the summation is taken over all provisioned BGs
10.36 Music On Hold (CfMOH)

The music on hold line and group options feature provides the
capability for subscribers to hear music when they are placed on hold.
The feature can be assigned to an individual user, an entire business
group, or an entire hunt group. When provisioned, music is provided
for all instances when a subscriber places a caller on hold. This includes
consultation hold, call hold, manual hold, CSTA-initiated hold, and
queuing. The source of the music is be specified by an intercept name.
As with any intercept name, this is provisioned via the OpenScape
Voice Assistant/CLI.
A31003-H80A0-T101-1-7618, 11/2021
Features
One Number Service (CfONS)
feature.

Intercept Name Identifies the intercept to be 15 Character string – must MOH_Default_
used to provide the music represent a valid intercept.1 Tr
source. The SOAP Server
verifies that the specified
intercept exists in the
intercept table (administered
via the OpenScape Voice
Assistant); if it does not, the
request is rejected. This field
is optional and, if not
specified, the
MOH_Default_Tr intercept is
used. The default intercept
cannot be administered by
the OpenScape Voice
Assistant/CLI operator, but is
created by the MOH service at
startup. Note that although
the interface includes the
intercept name as a character
string, the internal storage of
this data is the intercept ID,
which is a numeric value.
Therefore, the SOAP Server
reads the INTERCEPT_T table,
given the intercept name
provided, to determine the
corresponding intercept ID,
which is stored in the
SERVICE_DATA_T table.
List”).
Table 452 CfMOH – Music On Hold Input and Output Parameters
10.37 One Number Service (CfONS)

The One Number Service via Associated Devices (CfONS) provides the
service for the subscriber to originate and receive calls using an
associated device other than the subscriber’s own DN. The associated
devices could be the home phone, cell phone, and so on, and the
devices could be resided outside of the OpenScape Voice platform.
ONS Outbound allows calls to be originated from an associated device,

and ONS Inbound allows calls to be received at an associated device.
For ONS Inbound, the incoming call is offered to an application for
routing instructions, and the application can accept the call at the
subscriber's registered device, or specify an associated device to
A31003-H80A0-T101-1-7618, 11/2021
Features
One Number Service (CfONS)
receive the call. In either variant, only the subscriber DN is made

known to the other party regardless of whether any of the associated
devices are in use.
This service is applies only to SIP subscribers. It is required to have the

CSTA service before it can assign the One Number Service to the
subscriber.
feature.

on page 78.
on page 78.
ONSType The type of ONS service to be enum OutboundOnly OutboundOnly
provided. OutboundOnly InboundAndOutbound
enables a subscriber to
originate a call via a CSTA
application user interface
through an associated device
(such as a mobile phone or
hotel phone).
InboundAndOutbound allows
both the above functionality
and inbound functionality,
which enables a subscriber to
receive and answer a call at
an associated device (such as
a mobile phone or home
phone) when the subscriber
DN is called.
The ONS subscriber must be
a SIP device.
Including non-registering
subscriber support for all new
CSTA services requires SOAP
to not restrict ONS-IO
provisioning on provisioned-
only DNs.
StaticOND V7.00.18.01
upwards
Enabled Indication of the status of the Boolean True False

Call Forwarding – Static OND False
ServiceId The preferred device target No See definition of ServiceId in
for ONS binding on inbound Section 5.4, “Primitive Data
calls. By default its value Definitions”, on page 65.
should be left blank, meaning
Table 453 CfONS – One Number Service Input and Output Parameters
A31003-H80A0-T101-1-7618, 11/2021
Features
Remote Activation of Call Forwarding (CfRACF)
1
10.38 Remote Activation of Call Forwarding (CfRACF)
The Remote Activation Call Forwarding (RACF) feature is an optional
capability of the Call Forwarding - All Calls feature. It provides the
subscriber the capability to activate, deactivate, and change the
redirect number for call forwarding-all calls from a locations other than
the subscriber's station. This capability permits the subscriber to
manage call forwarding options and change forwarding destinations
from home or from another work location.
To subscribe to this feature, the subscriber must also have the call
forwarding-all calls feature.
feature.

on page 78.
Pin The Personal Identification 8 Character string ““
Number (PIN) that the
subscriber must enter for
authorization. If not
specified, the service uses the
PIN from the subscriber
profile. If this PIN is specified,
it overrides the PIN in the
profile.
Table 454 CfRACF – Remote Activation of Call Forward Variable Input and Output Parameters
10.39 Remote Call Forwarding (CfRCF) 2
The OpenScape Voice system-based Remote Call Forwarding (RCF)

feature provides the capability to redirect calls intended for subscriber
to a fixed destination. RCF cannot be enabled or disabled by
subsequent SOAP requests; it is always on. If RCF is provisioned, no
other service feature can be assigned to the subscriber. The calling
party receives no indication that the call terminates at a remote
location.
This feature is similar to Call Forwarding - All Calls, with the following
exceptions:
1. Can be referred to as Station Call Forwarding Remote Activation.

2. Can be referred to as Station Remote Call Forwarding.
A31003-H80A0-T101-1-7618, 11/2021
Features
Selective Call Acceptance (CfSCA)
• RCF can only be assigned to a profile-only subscriber: there is no

actual phone associated with this DN and the subscriber cannot
make calls from this number.
• A specified number of simultaneous calls can be forwarded to the

remote station from the RCF base DN.
feature.

on page 78.
ServiceId The number to which all See definition of Forwarding Destination in required
incoming calls are to be Section 5.4, “Primitive Data Definitions”, on
routed. page 78.
Max The maximum number of integer 0 to 2500 32
Simultaneous calls allowed to be forward at
Calls any one time. This field can
be a maximum of 32.
Table 455 CfRCF – Remote Call Forward Input and Output Parameters
10.40 Selective Call Acceptance (CfSCA)

The Selective Call Acceptance feature provides the capability to build a
list of numbers (known as a screening list) from which the subscriber
wants to accept incoming calls. Callers who are not on the screening
list hear a denial announcement that they are being forwarded to
another number or being played a denial announcement.

feature.

on page 78.
on page 78.
on page 78.
Table 456 CfSCA – Selective Caller Accept Input and Output Parameters (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Features
Selective Call Forwarding (CfSCF)

ScreenList The list of DNs from which 32 List of numeric strings. N/A
calls are to be accepted. The entries;
entries should be fully up to 15
qualified national numbering digits
plan formatted numbers. The each
individual entries are not
editable and the entire list
must be specified.
Pin Defines the priority code that 8 Character string. N/A
a caller can use to be placed
through to the subscriber
even though they are calling
from a phone that is not on
the screening list.
Sca Indicates the denial enum ScaTerminationDenialAnnounce Sca
Termination treatment for callers who are ment, Termination
Treatment not on the list; either ScaTerminationToRemoteDn Denial
announcement or forwarding Announce-
is possible. ment
ServiceId Indicates the destination See definition of Forwarding Destination in ““
number to forward denied Section 5.4, “Primitive Data Definitions”, on
calls to when ScaTermination page 78.
Treatment = Sca
TerminationToRemoteDn. Is
validated against any existing
TRS Code restrictions.
Table 456 CfSCA – Selective Caller Accept Input and Output Parameters (Seite 2 von 2)
1
10.41 Selective Call Forwarding (CfSCF)
The Selective Call Forwarding feature provides the capability to build a
list of numbers (a screening list) which the subscriber wants to
automatically forward to another destination. When a caller's number
matches a number on the forwarding list, the call is forwarded to the
redirect number. This can be another telephone, another subscriber,
voice mail, or an announcement. When the caller's number is not on
the forwarding list, the call is completed as usual.

feature.
1. Can be referred to as Station Selective Call Forwarding.
A31003-H80A0-T101-1-7618, 11/2021
Features
Selective Call Rejecting (CfSCR)

on page 78.
on page 78.
ServiceId Indicates the destination See definition of Forwarding Destination in required if
number to which calls are Section 5.4, “Primitive Data Definitions”, on Enabled is True
forward when callers are page 78.
found to be in the screening
list. Is validated against any
existing TRS Code
restrictions.
SplashRing Indicates whether the Boolean True, False
subscriber's phone will ring False
once as a reminder when a
call is forwarded.
ScreenList List of calling numbers to 32 List of numeric strings. N/A
forward. Callers on this list entries;
will not be put through to the up to 15
subscriber, but instead will be digits
forwarded to the specified each
destination. The entries
should be fully qualified
national numbering plan
formatted numbers. The
individual entries cannot be
edited and the entire list must
be specified.
BlackList Specifies whether the Boolean True, False
ScreeningList of DNs False
associated with the SCF
feature is a white list (only
calling DNs on the list are
forwarded) or a black list (all
calling DNs are forwarded
except those on the list).
NOTE: This attribute is
not supported for Version
2.2.
Table 457 CfSCF – Selective Call Forward Input and Output Parameters
10.42 Selective Call Rejecting (CfSCR)

The Selective Call Rejection feature provides the capability to build a
list of numbers (known as a screening list) from which the subscriber
does not want to accept incoming calls. When a caller's number does
not match a number on the rejection list, the call is completed. When
A31003-H80A0-T101-1-7618, 11/2021
Features
Serial Ringing (CfSERRNG)
the caller's number matches a number on the rejection list, the caller
hears an announcement that indicates the subscriber does not accept
calls from the number.

feature.

on page 78.
on page 78.
SubControlled Indicates whether the Boolean True, False false
subscriber can enable/disable
the service or whether it is
controlled by the telco only. If
not specified, defaults to telco
only.
on page 78.
ScreenList List of calling numbers to 32 List of numeric strings. N/A
reject. Callers on this list will entries;
not be put through to the up to 15
subscriber. The entries should digits
be fully qualified national each
numbering plan formatted
numbers. The individual
entries cannot be edited and
the entire list must be
specified.
Table 458 CfSCR – Selective Caller Rejection Input and Output Parameters
10.43 Serial Ringing (CfSERRNG)

The serial ringing feature provides subscribers the capability to be
sequentially rung at a series of locations. The subscriber or the system
administrator creates a serial ringing list that contains up to six DNs.
These DNs represent the additional locations that ring when an
incoming call arrives at the main DN, and the sequence in which they
are rung.
A31003-H80A0-T101-1-7618, 11/2021
Features
Simultaneous Ringing (CfSRS)
This feature optionally includes the ability for the caller to instantly
transfer to the caller's voice mailbox, rather than waiting for the call to
progress through all locations to do so.
feature.

Subscribed Subscribe to the service. required
Refer to Section 5.4,
on page 78.
on page 78.
Duration Period of time the primary integer 1–120 18
phone rings before the DNs in
the list are dialed.
SerialDNList A list of up to six entries, each with the attributes listed below.
(SerialDNList A DN to be rung serially. Please refer to the definition of Forwarding ““

Entry) Destination in Section 5.4, “Primitive Data
ServiceId Definitions”, on page 78.
(SerialDNList Indicates whether this DN is Please refer to definition of Enabled in False

Entry) to be rung (True) or skipped Section 5.4, “Primitive Data Definitions”, on
DNActive (False). page 78.
(SerialDNList Period of time this entry’s integer 1-120 18
Entry) phone rings before the next
Duration DN in the list is dialed.
(SerialDNList Indicates whether the this enum Public, Private Public
Entry) entry’s DN is public or private.
PPSState
(SerialDNList Indicates that the DN is an Boolean True, False False
Entry) extension, or intercom dialing
Extension code (True). If False, the
number is not an extension,
but a fully qualified national
number.
Table 459 CfSERRNG – Serial Ringing Input and Output Parameters
10.44 Simultaneous Ringing (CfSRS)

The Simultaneous Ringing feature provides subscribers the capability
to be simultaneously rung at multiple locations. The subscriber or the
system administrator creates a simultaneous ringing list that contains
up to six DNs. These DNs represent the additional locations that ring
A31003-H80A0-T101-1-7618, 11/2021
Features
Station Restrictions (Business Group) (CfSR)
when an incoming call arrives at the main DN. After the feature is
activated, incoming calls cause the main DN and each destination DN
to ring. The first DN to answer is connected; ringing then stops on the
other DNs. If the call is forwarded to another DN, such as voice mail, it
rings until answered.
Remote Feature Access (RFA) was designed to activate/deactivate the

SRS feature from a “remote” telephone (any DN other than the one to
which the features are subscribed). RFA can only be used in
conjunction with SRS; therefore, subscriber provisioning will block the
assignment of RFA if SRS is not also subscribed or being subscribed in
the same request.
feature.

on page 78.
on page 78.
DNList A list of up to six entries, each with the attributes below, to be simultaneously rung.
(DNList Entry) A DN to be simultaneously Please refer to the definition of Forwarding ““

ServiceId rung. Destination in Section 5.4, “Primitive Data
(DNList Entry) Indicates that the DN is an Boolean True, False False

Extension extension, or intercom dialing
code (True). If False, the
number is not an extension,
but a fully qualified national
number.
Table 460 CfSRS – Simultaneous Ringing Service Input and Output Parameters
10.45 Station Restrictions (Business Group) (CfSR)

The Station Restrictions’ feature lets the system administrator restrict
the calls permitted to and from a given station. Originating line
restrictions refers to restrictions on calls placed from a station;
terminating line restrictions refers to restrictions on calls being
terminated to a station.
The system administrator can assign this feature to the entire business
group or to individual users.
A31003-H80A0-T101-1-7618, 11/2021
Features
Station Speed Calling (CfSPCALL)
Table 461 lists the input and output parameters for this service.

on page 78.
OriginatingLineR Indicates the restriction level enum SemiRestrictedLine NoRestriction
estriction for calls the subscriber FullyRestrictedLine
Type originates. Must be one of FullyRestrictedWithAttendant
these values. NoRestriction
Terminating Indicates the restriction level enum SemiRestrictedLine NoRestriction
LineRestrictionT for calls terminating to the FullyRestrictedLine
ype subscriber. The restriction FullyRestrictedWithAttendant
type must be one of these NoRestriction
values.
Table 461 CfSR – Station Restriction (BG) Input and Output Parameters
10.46 Station Speed Calling (CfSPCALL)

The OpenScape Voice system-based Station Speed Calling feature
provides the capability to place frequently dialed numbers in a
centralized speed calling list. This feature can be provisioned at the
business group level with a denied option at the subscriber level.
Attention: This feature is separate from, and not to be confused with,

the System Speed Dial feature (see Section 10.47, “System Speed Dial
(CfBgSpDial)”) that is only available to BGLs (not residential
subscribers).
The following are the types of station speed calling:
• One-digit station speed calling
• Two-digit station speed calling
Each of the speed calling lists can be provided to a subscriber as

follows:
• A private list is used by one subscriber, who can modify any entry.
• A shared list is owned by one subscriber, but can be used by many

subscribers. Only the owner can modify the list entries.
A subscriber can have both a one-digit and a two-digit list. They can
both be private, both be shared, or one can be private with the other
one shared.
A31003-H80A0-T101-1-7618, 11/2021
Features
Station Speed Calling (CfSPCALL)
feature.

CascadeListToB Indicates whether any initial enum None None
GLs list created at the FP will be One
copied to the subscribers to Two
initialize the subscriber's Both
speed dial list. The
subscribers can edit their list,
but it can be pre-populated
with the lists from the BG. If
not specified, defaults to
None. The BG must have a list
if it is to be cascaded to the
BGLs.
ShareListWithB Indicates that the subscriber enum None None
GLs does not have his or her own One
list, but will use the list from Two
the FP. The subscriber may
not edit the list and any
changes to the list will affect
them. May be: None, One,
Two. The FP must have a list
if it is to be cascaded to the
BGLs.
OneDigit Indicates whether the
subscriber has his or her
own list or shares the
list from another entity.
This field may also
contain the literal BG to
indicate that the list is
shared from the
Business Group. Used
only when this feature
can be provisioned at
the BGL.
Table 462 CfBgSPCALL – Speed Call (Speed Dial) (BG) Input and Output Parameters (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Features
System Speed Dial (CfBgSpDial)

TwoDigit Indicates whether the
subscriber has his or her
own list or shares a list
from another entity.
This field can also
contain the literal BG to
indicate that the list is
shared from the BG.
Used only when this
feature can be
provisioned at the BGL.
Table 462 CfBgSPCALL – Speed Call (Speed Dial) (BG) Input and Output Parameters (Seite 2 von 2)
10.47 System Speed Dial (CfBgSpDial)

This feature allows a station user to access pre-defined list(s) of
numbers/destinations that are configured and stored at the Business
Group level and have those numbers/destinations dialed by the
system. The lists are accessed by the user via separately configured
Prefix Access Codes, one for ListIdOne and one for ListIdTwo. The
feature applies only to Business Group Lines, not to residential
subscribers.
Attention: This feature is separate from, and not to be confused with,

the Station Speed Calling feature (see Section 10.46, “Station Speed
Calling (CfSPCALL)”) that is available at the business group level with
a denied option at the subscriber level.
feature.

on page 78.
on page 78.
Table 463 CfBgSpDial – BG System Speed Dial Input and Output Parameters (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Features
Time-of-Day Call Forwarding (CfECF)
ListIdOne The ID of one of the 10 integer 0-10 0

possible speed dial lists
configured at the BG level
using the BgSpeedDialList
requests. See Section 11.18,
“Business Group System
Speed Dial Lists” for further
details on these requests. A
value of 0 means that none of
the lists is accessible using
ListIdOne.
ListIdTwo The ID of one of the 10 integer 0-10 0
possible speed dial lists
configured at the BG level
using the BgSpeedDialList
requests. See Section 11.18,
“Business Group System
Speed Dial Lists” for further
details on these requests. A
value of 0 means that none of
the list accessible using
ListIdTwo.
Table 463 CfBgSpDial – BG System Speed Dial Input and Output Parameters (Seite 2 von 2)
10.48 Time-of-Day Call Forwarding (CfECF) 1
The OpenScape Voice system-based Time-of-Day Call Forwarding

feature provides a scheduling capability to use in conjunction with the
call forwarding-all calls, CFBL, and CFDA features. It can also be used
with the selective call forwarding feature in some circumstances. The
subscriber defines the schedules, activates and deactivates the
feature, and specifies the forwarding destination. Also known as
Enhanced Call Forwarding.
feature.

on page 78.
on page 78.
Table 464 CfECF – Enhanced Call Forward Input and Output Parameters (Seite 1 von 2)
1. Can also be referred to as Time of Day Station Call Forwarding.
A31003-H80A0-T101-1-7618, 11/2021
Features
Time-of-Day Call Forwarding (CfECF)

ScreenList An optional list of DNs to 32 List of numeric strings N/A
forward. A maximum of 32 entries;
entries is allowed. Screening up to 15
List entries can be up to 15 digits
digits long. each
NumberOfRings This parameter is obsolete integer 1-10 4
and has been replaced with
RingDuration, which
Indicates the number of ring
cycles after which (if not
answered) the call will be
server. Assumes that the
device has six-second ring
cycles.
RingDuration Indicates the duration that integer 0-60 24 seconds
the phone will ring before (if
not answered) the call will be
server.
ECF List A list of ECF entries. Each entry represents a time period for a specific day of the week.
(ECFList Entry) The day of the week to which enum Sunday, Monday, Tuesday, Sunday
DayOfWeek the forwarding data defined in Wednesday, Thursday,
this entry applies. Friday, Saturday
StartTime The time at which the xsd__dat A valid time/date string. required
forwarding data defined in eTime
this entry applies, in
subscriber’s local timezone.
StopTime The time at which the xsd__dat A valid time/date string. required
forwarding data defined in eTime
this entry no longer applies,
in subscriber’s local timezone.
CallFwdType The type of call forwarding enum Always, Busy, Always
performed for this entry. NoAnswer,
BusyAndNoAnswer
ScreeningList Indicates which calls will be enum AllNumbers AllNumbers
Option forwarded. ScrListNumbers
NonScrListNumbers
ServiceId Indicates the destination to See definition of Forwarding Destination required
which calls are forwarded for in Section 5.4, “Primitive Data
the time specified in this Definitions”, on page 78.
entry.
Table 464 CfECF – Enhanced Call Forward Input and Output Parameters (Seite 2 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Features
Toll and Call Restrictions (CfTRS)
10.49 Toll and Call Restrictions (CfTRS)

The Toll and Call Restrictions feature provides destination limitations on
calls originated at designated stations and private facilities.
The limitations shall be able to be provisioned through Classes of

Restrictions and Alternate Classes of Restrictions, both of which shall
be associated with a List of Traffic Types.
The Alternate Restriction will consist of a Class of Restriction, a

Duration Switch Over Time, a Day Schedule and a Date Schedule. The
Duration Switch Over specifies the activation/Deactivation of the
Switch over scenario. The range of the switchover duration is between
0 to 60,000 minutes. By default, the switchover duration is 120
minutes. It will be possible to provision a predefined time every day
during which the users/endpoint Profile will change from the standard
Class Of Restriction to the alternate and vice versa. This provisioning
will be optional.
The provisioning of the Standard Class of Restriction shall require an

existing Class of Restriction Name. The provisioning of the Alternate
Class of Restriction requires a Date and Day Schedule. The Date
Schedule shall consist of a Starting Date with a format of:
(YYYY - MM - DD T HH : MM:SS)
and an End Time. Assistant shall be responsible for providing the

administrator with the option to enter the End Date and then split the
range between the Start Date and the End Date into separate Date
Schedules. It is important to note that range between the Start Date
and End Date cannot be greater than 14 (14 separate Date Schedules).
If one Date Schedule has a range of 5 days (Assistant shall send 5
consequent Date Schedules), then it shall not be possible to create
another one within the same month.
Similarly, the Day Schedule shall consist of a specific Staring Day of the
Week, a Start Time and an End Time. Assistant shall be responsible for
providing the administrator with the option to enter the End Day and
then split the range between the Start Day and End Day into separate
Day Schedules.
Validations to be performed:
1. It shall not be possible to assign Date and Day Schedules unless

there is an Alternate Class of Restriction already provisioned.
2. It is possible to provision an alternate Class of Restriction without

Date/Day Schedules.
A31003-H80A0-T101-1-7618, 11/2021
Features
Toll and Call Restrictions (CfTRS)
3. Soap Server shall perform checks for the overlapping in Date/Day

Schedules. It shall not be possible to create more than 14 Date
Schedules per month.
feature.

on page 78.
RestrictedLineLi The subscriber cannot make A maxi- Each entry may be a numeric N/A
st calls to the numbers in this mum of string of up to 30 digits long
list. The list may contain 10
partial numbers, such as 212, numbers
that prevent the caller from can be
calling any number that starts specified
with 212. Individual entries in
this list cannot be edited. The
list must be completely
specified.
Alternate COR
Alternate Class of
Restrictions:
Consists of :
AlternateCORName
SwitchOverDuration Timer
AlternateCORDay
ScheduleList
AlternateCORDate
ScheduleList
Alternate Alternate Class of restrictions 32 (1…32) N/A
CORName
Duration of the Switch over 0 to 60,000 minutes 0
Switch Over timer for activation/
Duration Time deactivation
EnableDurationT Enables or disables the Boolean False/true False
imer switchover duration to
override the day schedule
AllowCOSSFeatu Enables users to dial COSS Boolean False/true False
reAccessCodes Feature Access Codes.
ScheduleOverrid Allows users to override the Boolean False/true false

esDuration schedule by dialing the
feature access codes.
Table 465 CfTRS – Toll Restrictions Input and Output Parameters (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Features
Traffic Measurement (CfBgTM)

Alternate Consists of up to 49 Day (0 …49)
COR Schedule Entries. Each Day
DayScheduleList Schedule Entry has a Day Of
Week a Start Time and Stop
Time
Alternate Consists of up to 168 Date (0…168)
COR Schedule Entries. Each Date
DateScheduleLis Schedule has a Start
t Date_Time and an End Time
Table 465 CfTRS – Toll Restrictions Input and Output Parameters (Seite 2 von 2)
10.50 Traffic Measurement (CfBgTM)

The Traffic Measurement feature provides the ability to display traffic

measurements data on a per Business Group basis. This feature can be
provisioned against the BG and will not cascade to the BGLs.
Unassigning this feature disables the measurement data collection.
feature.

on page 78.
Table 466 CfBgTM – Traffic Measurement Input and Output Parameters
10.51 BG Silent Monitoring (CfBgSILM)

This business group feature is responsible for counting the
MonitorTagLimit and the CurrentTagUsed. The CurrentTagUsed is the
current number of tags that have been used. This is a read-only field
and there is no need to provision this field.
Table 467 lists the output parameters associated with this feature.
A31003-H80A0-T101-1-7618, 11/2021
Features
Silent Monitoring Protection Feature (CfSILMProtection)

Subscribed Please refer to Section 5.4, “Primitive Data Definitions”, on page 78.
Required.
MonitorTagLimit Indicates the limit for Integer Valid values 0-100 0
monitoring subscribers per
BG. If the MonitorTagLimit is
10 then only 10 subscribers
can be tagged for monitoring.
Define the maximum Integer 0-10 5

number of allowed of
Continuous monitoring
MaxNumOfSup supervisors and the per-Call
ervisors monitoring supervisors
(added via CSTA)
independently.
V7.00.09.01
Table 467 cfBgSLIM – BG Silent Monitoring Input and Output Parameters
10.52 Silent Monitoring Protection Feature (CfSILMProtection)

The SILMProtection is used to protect a subscriber against monitoring.
Subscribers provisioned with the SILM service should be also
provisioned with the SILMProtection service and this service must be
enabled.
feature.

Supported up to V7.00.08.01 From V7.00.09.01 and upwards is replaced
by SILMS/SILMA
Table 468 cfSLIMProtection – Silent Monitoring Protection Input and Output Parameters
10.53 Silent Monitoring Feature (CfSILM)

Supported up to V7.00.08.01. From V7.00.09.01 and upwards is
replaced by SILMS/SILMA.
The silent monitoring feature is provisioned for users who can monitor
other users within the business group. Before a subscriber can be
assigned the CfSILM feature, that subscriber’s business group must be
assigned the BGSILM feature. The SILMProtection and CSTA must also
be assigned to the business group.
A31003-H80A0-T101-1-7618, 11/2021
Features
Silent Monitoring Tag Feature (CfSILMTag)
feature.

Required.
Enabled Please refer to Section 5.4, “Primitive Data Definitions”, on page 78. False
Table 469 cfSLIMProtection – Silent Monitoring Input and Output Parameters
10.54 Silent Monitoring Tag Feature (CfSILMTag)

Supported up to V7.00.08.01. From V7.00.09.01 and upwards is
replaced by SILMS/SILMA.
The SILMTag feature can be assigned to a BGL subscriber. Assigning

this feature to a BGL subscriber means that the BGL is tagged for
monitoring.
• If a Subscriber is being provisioned with SILMTag (AddReplace

Operation and the value of Srx/Service/SilmToneIntervals = -
1, the assignment of the Feature shall succeed but the value of the
Periodic Tones shall be false.
• Supposing a Subscriber or a Feature Profile has the SILM Tag

Feature assigned and EnablePeriodic Tones = true. If the Rtp
Parameter Srx/Service/SilmToneIntervals changes to -1,
Subscriber or Feature Profile shall remain as it was. (i.e.
EnablePeriodicTones = true)
• If attempting to modify SILMTag on the Subscriber or Feature

Profile, the EnablePeriodicTones flag shall change to false.
feature.

Required.
Table 470 cfSLIMProtection – Silent Monitoring Protection Input and Output Parameters (Seite 1 von
2)
A31003-H80A0-T101-1-7618, 11/2021
Features
Call Forwarding Restrictions (CfCFR)

Enable Periodic Enable/Disable periodic tone Boolean True, False
Tones intervals False
Table 470 cfSLIMProtection – Silent Monitoring Protection Input and Output Parameters (Seite 2 von
2)
10.55 Call Forwarding Restrictions (CfCFR)

When assigned to a BGL, the call forwarding restrictions (CFR) feature
restricts the type of destination for which this BGL can forward calls.
Its arguments represent the types of calls that can be restricted as call
forwarding destinations.
feature.

Subscribed Please refer to Section 5.4, “Primitive Data Definitions”, on page 78. required
Enabled Indicates whether the feature Please refer to Section 5.4, “Primitive Data False
is active or inactive when Definitions”, on page 78.
billing is UsageSensitive. If
not specified initially, defaults
to inactive. If CfCNAM has
been or is being provisioned
(with
Billing=UsageSensitive), the
Enabled flag settings must be
the same for both features.
EmergencyTraffi Indicates whether call True, False False
cType forwarding to a destination
that will create an emergency
call is blocked.
Table 471 cfCFR – Call Forwarding Restrictions Input and Output Parameters
10.56 Call Park to Server (CfCPS)

The CPS feature is applicable at the subscriber and feature profile level.
Subscribers to this feature must be a business group line. The business
group call transfer feature must be enabled before assigning the CPS
feature to a business group line or to a feature profile with the Parking
Allowed field set to true. If the call transfer feature is not active, it will
not be possible to provision the CPS service. It is not possible to set
both the Parking Allowed field and the Retrieval Allowed field to false.
A31003-H80A0-T101-1-7618, 11/2021
Features
Automatic Collect Call Blocking for Brazil
feature.

Required.
Parking Lot The name of the parking lot in 1 ... 20 string required
Name which CPS service will be
applied.
Parking Allowed When set to true, the Boolean True, False True
administrator is able to park
the call to server.
Retrieval When set to true, the Boolean True, False True
Allowed administrator is able to
retrieve a previously parked
call.
Table 472 cfCPS – Call Park to Server Input and Output Parameters
10.57 Automatic Collect Call Blocking for Brazil

The new ACCB service will work (only) with AudioCodes Gateways or
HiPath4000/RG8300 that already include the necessary ACCB signaling
procedures to work within the Brazilian PSTN. The ACCB feature is only
applicable to the original called OSCV subscriber. If the call is forwarded
or redirected (transferred) any ACCB service assigned to the new
target subscriber is not applied i.e. if the original called OSCV
subscriber does not have ACCB but the new target (due to forwarding/
transfer) does have ACCB then ACCB will not be applied.
OpenScape Voice administrators may wish to automatically block

incoming collect calls to some OpenScape Voice users but still allow
other users to receive collect calls and make their own choice to accept
or reject the call.
feature.

Required.
Table 473 ACCB – Automatic Collect Call Blocking for Brazil Input and Output Parameters
A31003-H80A0-T101-1-7618, 11/2021
Features
Openscape Mobile Service (OSMO)
10.58 Openscape Mobile Service (OSMO)

OpenScape Server has the capability to provision OpenScape Mobile
(OSMO) clients. Such type of clients allows mobile workers to register
with Openscape Voice with their own Address of Record and manage
calls through the mobile client.
The basic configuration for an Openscape Mobile user is:
1. A desk phone. The desk phone is configured with the user's ONS
number. The desk phone may be located on campus with direct
connectivity to OpenScape Voice or in a home office with access to
OSV through an SBC.
2. A dual band Android mobile phone capable of running the Unify

Openscape Mobile application.
3. The Openscape Mobile VoIP agent will be provisioned with its own
DN (Openscape Mobile WiFi OND), and static ONS binding in OSV.
4. Cellular phone number.
5. An Xpressions voicemail box.
An Openscape Mobile user shall only expose his ONS number for all his
communications. This includes calls made or received from the user's
DeskPhone, Mobile over WiFi, or Mobile over Cellular. Step 1 provides
inbound ONS service, and outbound ONS service over WiFi.
The mobile device is the user's remote control for his enterprise
communications. While connected over WiFi with Openscape Mobile the
user can control device selection for incoming calls:
1. Answer call on Mobile over WiFi
2. Answer call on Mobile over Cellular
3. Answer call on DeskPhone
4. Decline Call
5. Send to voicemail
The basic routing for incoming is to successively send the call to:
1. The mobile device over WIFI
2. The desk phone
3. The mobile device over Cellular
4. The Xpression voice mail
A31003-H80A0-T101-1-7618, 11/2021
Features
Openscape Mobile Service (OSMO)
While connected over WiFi with Openscape Mobile, the user can
handover an active ONS call (call in connected state) between his
mobile WiFi, mobile Cellular, and desk phone devices.
Android Use cases:
1. Local Campus/Corporate WiFi.

Mobile client and Deskphone register with OSV using SIP.
2. WiFi hotspot.
Mobile client registers with OSV using SIP through SBC.
3. Remote Campus/ Corporate WiFi.

Mobile client registers with OSV using SIP.
4. Home Office/ Home WiFi.

Mobile client and Deskphone register with OSV using SIP through
SBC.
Important:
To successfully assign OSMO service, the subscriber must NOT:
• "Belong to a feature profile
• "Be part of an MLHG
• "Have other services assigned
• "Be an Executive/Assistant Group member
• "Has keyset provisioned
• "Its Deskphone is already associated with another OSMO

subscriber
• "Be profile only subscriber
• "Be a call pick up group member
• "Be a community group member
• "Define as a Main Device which is already associated with an

existing OSMO.
• Define as Main Device, a subscriber DN which has OSMO service

assigned
Additionally, to successfully assign OSMO service, the subscriber MUST:
• Have ExternalDn flag set to false
A31003-H80A0-T101-1-7618, 11/2021
Features
Routing Service
• Have SIP security enabled
• Send Insecure referred by Header flag set to true
For provisioning of OSMO please refer to section 9.1 "Create

Subscriber" and 9.23 "Update Mobile Info"

WSDL Version
V5.00.20.01 subRC_APP_FEAT_OSMO_ONS_NOT_ASSIGNED_TO_DESK_PHONE
_DN
subRC_APP_NOT_ALLOWED_REMOVING_ONS_WITH_MOBILEDN_R
EFERENCE
subRC_APP_FEAT_OSMO_CSTA_NOT_ASSIGNED_TO_DESK_PHONE
_DN
V7 subRC_APP_OSMO_EXTERNAL_DN_FLAG_CONFLICT
subRC_APP_EP_INSECURE_REFERRED_BY_HEADER_OSMO_CONFLI
CT
subRC_APP_SUB_ROUTETOCELL_CELLDEVICENUMBER_CONFLICT
Table 474 OSMO Service Provisioning Return Codes
10.59 Routing Service

The purpose of this service is to expose CSTA Routing registration and
call control services and meet the basic functional requirements
defined in the ECMA 269 CSTA standard.
feature.

.
Table 475 Routing Service Input and Output Parameters (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Features
Network Wide Call Park to Server (Endpoint Profiles)

Enabled Indicates whether the feature Please refer to Section 5.4, “Primitive Data False
is active or inactive when Definitions”, on page 78.
billing is
UsageSensitive. If not
specified initially, defaults to
inactive. If
CfCNAM has been or is being
provisioned (with
Billing=UsageSensitive), the
Enabled flag settings must
be the same for both
features
Table 475 Routing Service Input and Output Parameters (Seite 2 von 2)
10.60 Network Wide Call Park to Server (Endpoint Profiles)

Network Wide Call Park to Orbit is an extension of the existing feature
Call Park to Server introduced with FRN3293. While Call Park to Server
is applicable to subscriber level and Feature profile level only, NW Call
Park to Orbit is applicable to Endpoint Profiles.
NW Call Park to Orbit shares the same logic and structure of Call Park
to Server:
Thus the following data will be provisioned with CPO feature:
• Parking allowed: YES/NO (default is YES)
• Retrieval allowed: YES/NO (default is YES)
• Parking Lot: The name of the Parking Lot in which CPO service
will be applied.
• Business group: The business group which contains the Parking

Lot.
Administrator provisions the feature by defining an existing parking lot

and setting Boolean flags Park and Retrieve allow. The scope of this
feature is to provide users outside the Openscape Voice with the
capability of parking and retrieving calls to/from a central parking lot.
Prerequisites/Restrictions:
• Setting both fields Parking allowed and Retrieval allowed to
false is not allowed.
A31003-H80A0-T101-1-7618, 11/2021
Features
CSTA Application external device name provider (Endpoint Profiles)
• Network Wide Call Park to Server is only applicable to endpoint

profiles that are assigned to private numbering plans. Any
attempt to assign it to E164NANP endpoint profile will issue an
error.
• Network Wide Call Park to Server is only applicable to an

endpoint profile that is inside a business group.
Validation for inappropriate combinations of Business groups and

Parking Lots will be performed before assigning the feature.
feature.

.
Parking Lot The name of the parking lot in 1-20 String Required
Name which CPS service will be
applied
Parking Allowed When set to true, the Boolean True,False True
administrator is able to park
the call to server.
Retrieval When set to true, the boolean True,False True
Allowed administrator is able to
retrieve a previously parked
call.
Table 476 NWfCPS – Network Wide Call Park to Server Input and Output Parameters
10.61 CSTA Application external device name provider (Endpoint

Profiles)
CSTA Network Interface Monitoring service (CNIM). CNIM enables the
support CSTA on OSV Network Interface Devices (NID). CNIM supports
a subset of services and events that can be used by CSTA-enabled
adjunct application to detect the presence of an inbound and outbound
off-network call; lookup a name string based on the calling/called
device number and associate the calling/called device name within the
OSV call context via CSTA service. CNIM is applicable to Endpoint
Profiles.
The Endpoint page in CLI and Assistant shall be enhanced to present

the CSTA NID deviceID. The NID shall be presented in the Device
Number (DeN) format. DeN format is a non-dialable 4-byte integer
value. OpenScape Voice shall adopt the DeN format used by
HiPath4000. HiPath4000 uses the most significant byte to identify the
A31003-H80A0-T101-1-7618, 11/2021
Features
Silent Monitoring Supervisor Feature (CfSILMS)
device type and the least significant 3-bytes for the device number.
The device number shall be based on the least significant 3-bytes of
the existing internal endpoint identifier (EPID) assigned in the endpoint
database record. The internal EPID is updated by one each time an
endpoint device is added to the system. EPID values are not re-used
when an endpoint is deleted. Please refer to Endpoints sections for
details regarding the new data returned.
feature.

NameProvider V7.00.01.10 boolean True / False True
This option is used to activate
/ deactivate CSTA services
that enable applications to
associate a calling device
name with the off-net calling
device.
Table 477 CNIM – CSTA Application external device name provider Input and Output Parameters
10.62 Silent Monitoring Supervisor Feature (CfSILMS)

The SILMS feature can be assigned to a BGL subscriber. Assigning this
feature allows users to monitor other users. The monitoring is
continuous, regardless they are in a call or not. The monitoring session
remains active as long as user desires and not for a specific call. Users
provisioned with SILMS, gain the capability of monitoring other users
that have SILM Agent feature provisioned.
• HoldCallWhenInactive, InactiveIntercept and SecureConnection are

provisionable only when SilentMonitoring = True
feature.

Required.
Table 478 CfSILMS – Silent Monitoring Supervisor Input and Output Parameters
A31003-H80A0-T101-1-7618, 11/2021
Features
Silent Monitoring Agent Feature (CfSILMA)

SilentMonitoring Indication of whether a Boolean True, False True
Supervisor is allowed to
invoke Silent Monitoring
Barge-In Indication of whether a Boolean True, False True

invoke Barge-In
Whisper Indication of whether Boolean False, True False

invoke whisper from a silent
monitoring session.
Applicable when
SilentMonitoring=True
V7.00.23.01 and forward.

Monitoring Available when
Sessions Data SilentMonitoring = True
Local CfSILMS- • Enabled

locPres • SilentMonitoring
• BargeIn
• HoldCallWhenInactive
• SecureConnection
• InactiveIntercept
HoldCallWhenIn Indication of whether Boolean True, False False
active Supervisor shall be placed on
hold when the monitoring
session is inactive
InactiveIntercep The provisioned intercept for String list of character strings , length MSSLM_SESSI
t the inactive monitoring : 1-15 or empty string ON_INACTIVE
session
SecureConnecti Indication of whether Boolean True, False False

on Supervisor connection with
Media Server shall be
considered secure
Table 478 CfSILMS – Silent Monitoring Supervisor Input and Output Parameters
10.63 Silent Monitoring Agent Feature (CfSILMA)

The SILMA feature can be assigned to a BGL subscriber. Assigning this
feature allows users to be monitored by other users. The monitoring
is continuous, regardless they are in a call or not. The monitoring
session remains active as long as user desires and not for a specific
call. Users provisioned with SILMA, can be monitored by other users
that have SILM Supervisor feature provisioned.
A31003-H80A0-T101-1-7618, 11/2021
Features
Silent Monitoring Agent Feature (CfSILMA)
• SILMTag and ToneMonitorActivate provisionable only when

SilentMonitoring = True
• ToneMonitorInterval and NotifyPartnerDevices provisionable only

when ToneMonitorActivate = true
feature.

Required.
SilentMonitoring Indication of whether a Boolean True, False True
invoke Silent Monitoring
Barge-In Indication of whether a Boolean True, False True
invoke Barge-In
WhisperTo Indication of whether Agent is Boolean False, True False
allowed to be whispered-to
Applicable when
V7.00.23.01 and forward.

SILMTag Indication of whether Tone Boolean True, False False
Monitoring is enabled.
Applicable when
Tone Monitoring
Data
ToneMonitorActi Indication of whether Tone Boolean True, False False

vate Monitoring is enabled.
Applicable when
ToneMonitorInte Indication of interval in Integer [0…100] 30
rval seconds in which the tone
shall be played to the Agent
or the partner devices. A
NotifyPartnerDe Notify Partner Devices. Boolean True, False True

vices Applicable when
ToneMonitorActivate =True
Table 479 CfSILMS – Silent Monitoring Agent Input and Output Parameters
A31003-H80A0-T101-1-7618, 11/2021
soap_ext_interfaces_bg.fm
Business Groups
Create BG
11 Business Groups
A Business Group (BG) is an entity of related subscribers. (Subscribers
may optionally belong to a business group.) It is necessary to provide
a BG Name in the CreateSubscriber request in order to assign the
subscriber to the BG. When subscribers are created with an associated
BG, they are also referred to as Business Group Lines (BGLs). Please
refer to Section 4.9, “Business Groups”, on page 63 for more
information.
11.1 Create BG
Used to create a Business Group. When creating and deleting a
Business Group, the system generated-CustomerId from the Customer
table will be re-used for the Business Group Index. The Business Group
Name is stored as the Customer Name.
The maximum number of Business Groups supported on the system is

controlled by an RTP parameter, Srx/Main/MaxNumberBGSupported,
with a predefined upper limit of 6000.

WSDL Version
04.02.01 supersuccessful
11.00.01 subRC_APP_BG_NAME_LEN_INVALID
subRC_APP_BG_DISPLAY_NUM_LEN_INVALID
subRC_APP_PNP_NAME_LEN_INVALID
subRC_APP_BG_NUMBER_PLAN_DOES_NOT_EXIST
subRC_DB_BG_NUMBER_PLAN_LOOKUP_FAILED
subRC_APP_BG_NUMBER_PLAN_OUT_OF_RANGE
subRC_APP_BG_NUMBER_PLAN_DUPLICATE
subRC_APP_BG_OUT_OF_RANGE
subRC_APP_BG_DUPLICATE
subRC_DB_BG_INSERTION_FAILED
subRC_APP_BG_SERVICES_MODIFY_FAILED
Table 480 Create BG Return Codes

BGName Business Group name. Please refer to Section 5.4, “Primitive Data
Table 481 Create BG Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Update BG Status

on page 78.
NumberPlan Private Number Plan. Refer to 1-31 Character String System Default
Name Section 5.4, “Primitive Data NP
Definitions”, on page 78. PSTN –
E164NANP –
PNP
DEFAULT
Display Number When a subscriber with only a 15 Numeric string required
private number makes a
external BG call, the BG’s
DisplayNumber is presented
as the calling number.
BGAccessCode Indicates the BG Access Code 1..15 Numeric string (0..9), plus * N/A (Not
for the specifig BG. and #. mandatory
field)
Trusted When true the subscribers Boolean
and endpoints configured
within the BG are treated as
internal towards subscribers
and endpoints of other BGs -
i.e. they become shared
resources of all other BGs.
Table 481 Create BG Input Fields (Seite 2 von 2)
11.2 Update BG Status

This method updates a BG’s status.

WSDL Version
subRC_DB_BG_MODIFICATION_FAILED
Table 482 Update BG Status Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Add BG Main Number

BGName Business Group Name. Please refer to Section 5.4, “Primitive Data
on page 78.
BGStatus The status of the Business enum Active, Blocked N/A
Group.
Table 483 Update BG Status Input Fields
11.3 Add BG Main Number

The AddBGMainNumber method adds the Main Number for the BG, with
Attendant Number, auto Attendant Number and Auto Attendant Status.
The Main Number can be a virtual number or real number. The
Attendant must be created before it can be assigned to the BG.

WSDL Version
subRC_APP_BG_NAME_INVALID
subRC_APP_BG_MAIN_NUM_LEN_INVALID
subRC_APP_BG_MAIN_NUM_DOES_NOT_EXIST
subRC_DB_BG_MAIN_NUM_LOOKUP_FAILED
subRC_APP_BG_MAIN_NUM_ATTENDANT_LEN_INVALID
subRC_DB_BG_MAIN_NUM_ATTENDANT_LOOKUP_FAILED
subRC_APP_BG_MAIN_NUM_AUTOATT_LEN_INVALID
subRC_APP_BG_MAIN_NUM_AUTOATT_MISSING
subRC_DB_BG_MAIN_NUM_MODIFY_FAILED
Table 484 Add BG MainNumber Return Codes

on page 78.
Table 485 Add BG Main Number Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Delete BG Main Number

BGMainNumber The Main Number to be 30 Numeric string required
added. For further details
about Main Numbers, please
refer to Section 4.10.1, “Main
Numbers”, on page 64.
BGMainNumber The BG Attendant to which 30 Numeric string ““
Attendant calls to the Main Number are
directed. For further details
about BG Attendants, please
refer to Section 4.10.2,
“Attendant Numbers”, on
page 65.
AutoAttendantN The number for redirecting 30 Numeric string ““
umber calls that terminate at the
main number if the auto-
attendant service is available.
If the auto-attendant flag is
set to true, then the auto-
attendant number must be
specified. For further details
about the auto-attendant
service, please refer to
Section 4.10.1, “Main
AutoAttendantSt Indicates auto-attendant enum Enabled, Disabled Disabled
atus availability.
Table 485 Add BG Main Number Input Fields (Seite 2 von 2)
11.4 Delete BG Main Number

The DeleteBGMainNumber method is used to remove a Main Number
from a BG.

WSDL Version
subRC_DB_BG_MAIN_NUM_ASSIGN_FAILED
Table 486 Delete BG Main Number Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Update BG Main Number

on page 78.
Table 487 Delete BG Main Number Input Fields
11.5 Update BG Main Number

The UpdateBGMainNumber method is used to add, replace, or delete a
BG’s main number.

WSDL Version
subRC_APP_BG_MAIN_NUM_ATTENDANT_LEN_INVALID
subRC_DB_BG_MAIN_NUM_ATTENDANT_LOOKUP_FAILED
subRC_APP_BG_MAIN_NUM_AUTOATT_LEN_INVALID
subRC_DB_BG_MAIN_NUM_MODIFY_FAILED
Table 488 Update BG Main Number Return Codes

Table 489 Update BG Main Number Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Update BG Features

on page 78.
BGMainNumber The BG Attendant to which 30 Numeric string N/A
Attendant calls to the Main Number are
directed. For further details
about BG Attendants, please
refer to Section 4.10.2,
“Attendant Numbers”, on
page 65.
AutoAttendantN The number for redirecting 30 Numeric string N/A
umber calls that terminate at the
main number if the auto-
attendant service is available.
If the auto-attendant flag is
set to true, then the auto-
attendant number must be
specified. For further details
about the auto-attendant
service, please refer to
Section 4.10.1, “Main
AutoAttendantSt Indicates auto-attendant enum Enabled, Disabled N/A
atus availability.
Table 489 Update BG Main Number Input Fields (Seite 2 von 2)
11.6 Update BG Features

The UpdateBGFeatures method is used to add to, replace, or delete a
feature from a Business Group. Only a small number of features apply
at the BG level, and these are features that only apply at that level -
that is, the associated data is not propagated to the BGLs and is not
displayed at the BGL level, although the data associated with the BG
features is used during call processing for the BGLs where applicable.
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Update BG Features

WSDL Version
subRC_APP_FEAT_FEATURE_NOT_ENABLED
subRC_APP_BG_FEATURE_DENIED
subRC_DB_BG_CUSTOMER_TABLE_LOOKUP_FAILED
subRC_APP_BG_FEAT_BGE911LIN_DEFAULT_INT_MISSING
subRC_APP_BG_FEAT_BGE911LIN_EMERGENCY_LEN_INVALID
subRC_APP_BG_FEAT_BGE911LIN_EMERGENCY_DOES_NOT_EXIST
subRC_APP_BG_FEAT_BGE911LIN_EMERGENCY_LOOKUP_FAILED
subRC_APP_BG_FEAT_BGKS_MAN_HOLD_REC_TIME_OUT_OF_RAN
GE
subRC_APP_BG_FEAT_BGKS_LINE_RES_TIME_OUT_OF_RANGE
subRC_APP_BG_FEAT_NBCPU_ID_OUT_OF_RANGE
subRC_APP_BG_FEAT_NBCPU_ID_MISSING
subRC_APP_BG_FEAT_HD_AUTO_LOGOFF_TIME_INVALID
subRC_APP_BG_DELETE_BGLS_HD_ASSIGNED
subRC_SYS_BG_LC_MAX_CONF_MEMBERS
subRC_APP_BG_LC_MIN_PORTS_OUT_OF_RANGE
subRC_APP_BG_LC_MIN_PORTS_NOT_AVAILABLE
subRC_APP_BG_LC_MIN_MAX_PORTS_CONFLICT
subRC_APP_BG_LC_MAX_PORTS_OUT_OF_RANGE
subRC_APP_BG_LC_MAX_PORTS_NOT_AVAILABLE
subRC_APP_BG_LC_MAX_CONF_OUT_OF_RANGE
subRC_APP_BG_LC_MAX_CONF_MEMBERS_OUT_OF_RANGE
subRC_APP_BG_LC_CONF_RECALL_DISC_TIMER_OUT_OF_RANGE
subRC_APP_BG_LC_MAX_CONF_MAX_PORT_INVALID
subRC_APP_BG_LC_MAX_CONF_MEMBERS_MAX_PORT_INVALID
subRC_APP_BG_FEAT_BGLC_DOES_NOT_EXIST
subRC_APP_BG_LC_SCC_ASSIGNED
Table 490 Update BG Features Return Codes

on page 78.
ListOfBGFeature The list of features to be A list of pointers to the data N/A
s modified. structures of all the features to
be modified. The supported
features are discussed in
Chapter 10, “Features”
Table 491 Update BG Features Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Get BG Info
11.7 Get BG Info

The GetBGInfo method is used to retrieve BG-related information, such
as BG Name, Main Number, and Dialing Plan, as well as the features
that are assigned to the BG.

WSDL Version
04.02.01 subRC_APP_BG_NAME_LEN_INVALID
subRC_DB_BG_CPU_LOOKUP_FAILED
subRC_APP_BG_ATT_NUM_LOOKUP_FAILED
Table 492 Get BG Info Return Codes

BGName Business Group Name. Please refer to the definition of BGName in
Section 5.4, “Primitive Data Definitions”, on
page 78.
Table 493 Get BG Info Input Fields
11.7.1 Get BG Info By Options

This method returns the BG info based on options being options
specified in the SOAP request. The options include a list of features,
CPUs, MainNumber and Number Plan, and BGService Access Codes.

WSDL Version
subRC_DB_BG_CPU_LOOKUP_FAILED
subRC_APP_BG_ATT_NUM_LOOKUP_FAILED
Table 494 Get BG Info By Options Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Get BG List

page 78.
Interface The release version being Please refer to the definition of Latest
Release used by the requesting SOAP InterfaceRelease in Section 5.4, “Primitive
client. Data Definitions”, on page 78.
GetBGData Information to be included for Structure IncludeCpu__, ALL
Options display of Enum IncludeListOfFeatures__
IncludeBgMainNumberList__
IncludeBgTrafficInfo__
Table 495 Get BG Info By Options Input Fields
11.8 Get BG List

The GetBGList method is used to retrieve the list of BGs created on the
system. Filtering is performed on NumberPlanName, BGName
(supporting wildcarding) and Resource Management Type. If Number
Plan Name is provided, only BGs that are associated with the given
Numbering Plan are returned.
Sorting is also supported by BGName if the GetBGListSortList list is

filled. ascending/descending ordering option is provided. If left empty
sorting is by default on bg_index.

WSDL Version
04.02.01 subRC_DB_BG_LIST_COUNT_LOOKUP_FAILED
subRC_SYS_BG_LIST_ALLOC_ERR
Table 496 Get BG List Return Codes

on page 78.
Table 497 Get BG List Input Field Descriptions (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Delete BG

requests. For more
BGName Business Group Name. Please refer to the definition of BGName in ““
Optional. Provided for Section 5.4, “Primitive Data Definitions”, on
filtering. A string containing page 78.
the wildcard character (%)
can also be the input.
Matching entries will be
returned in this case.
NumberPlanNa The name of the Private 1..31 Character string. N/A
filter. Only BGs that are
associated with this Number
Plan will be returned.
DefaultResrcMg Specifies the Resource enum N/A
mtType Management Type of the QoS
Profile.
OBSOLETE IN V8
GetBGListSortLi Provides selection on sorting enum BGListSortBGName N/A
st. type. Currently only sorting
GetBGListSortTy by BGName is provided.
pe
GetBGListSortLi Provides selection of sorting enum SortOrderAscending, SortOrderAsce
st order SortOrderDescending nding
11.9 Delete BG
The DeleteBG method is used to delete a BG. The BG cannot have any
existing subscribers or endpoint profiles or associated numbering plans
or BG subnets. Other BG-dependent objects, such as BG departments,
are deleted automatically upon successful completion of this request.
WSDL Obsolete Return Codes

Version in WSDL
Version
V4.00.04.01 subRC_SUCCESS
Table 498 Delete BG Return Codes (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Delete BG
WSDL Obsolete Return Codes

Version in WSDL
Version
subRC_APP_BG_SUB_IN_USE
subRC_APP_BG_DP_IN_USE
subRC_DB_BG_EP_PROFILE_LOOKUP_FAILED
subRC_APP_BG_EP_PROFILE_IN_USE
subRC_DB_BG_SUBNET_LOOKUP_FAILED
subRC_APP_FP_LIST_LOOKUP_FAILED
subRC_APP_FP_DELETION_FAILED
subRC_DB_BG_DEPT_NUM_LOOKUP_FAILED
subRC_DB_BG_DEPT_DELETION_FAILED
subRC_APP_BG_AUTH_CODE_DELETION_FAILE
D
subRC_APP_BG_SERVICES_MODIFY_FAILED
subRC_DB_BG_MAIN_NUM_DELETION_FAILED
subRC_DB_BG_DELETION_FAILED
subRC_APP_BG_PKLOT_QUERYLIST_FAILURE 30301062
Delete BG was aborted. Failure
while retrieving Parking Lot List
subRC_APP_BG_PARKING_LOT_EXIST 30301061
Delete BG was aborted.BG has
Parking Lot(s) associated with it
Table 498 Delete BG Return Codes (Seite 2 von 2)

page 78.
on page 78.
Table 499 Delete BG Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Get BG Attendant Numbers
11.10 Get BG Attendant Numbers

The GetBGAttendantNumbers method is used to retrieve the list of DNs
provisioned as Attendant Numbers for the BGs.

WSDL Version
subRC_DB_BG_ATT_LOOKUP_FAILED
Table 500 Get BG Attendant Numbers Return Codes

page 78.
Table 501 Get BG Attendant Numbers Input Fields
11.11 Delete BG Cpu

This method deletes the list of CPUs (call pickup groups) that belong to
this BG. All the BGLs that belong to this BG and that have the
corresponding CPUId will have their CPUIds set to zero (0). All the BGLs
will have this subscriber feature set to inactive.

WSDL Version
Table 502 Delete BG Cpu Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Delete BG Cpu

page 78.
on page 78.
CpuId The ID of the Call Pickup See definition of CpuId in Section 9.1,
Group to remove. “Create Subscriber”, on page 342.
Table 503 Delete BG Cpu Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Update BG Parms
11.12 Update BG Parms

This request is used to modify the values of BG-related parameters for
an existing Business Group.

WSDL Version
subRC_APP_BG_DISPLAY_NUM_LEN_INVALID
subRC_DB_BG_MODIFICATION_FAILED
subRC_APP_BG_MDR_CUST_ID_LEN_INVALID
subRC_APP_BG_MDR_CUST_ID_MISSING
subRC_APP_BG_MDR_CUST_ID_DUPLICATE
subRC_DB_BG_MDR_CUST_ID_LOOKUP_FAILED
subRC_APP_BG_NUM_PLAN_MOD_NOT_ALLOWED
subRC_APP_BG_NUMBER_PLAN_NAME_LEN_INVALID
subRC_APP_PNP_LOOKUP_FAILED
subRC_DB_BG_CUSTOMER_TABLE_LOOKUP_FAILED
subRC_APP_BG_MEDIA_SVR_RETRY_OUT_OF_RANGE
subRC_APP_BG_MEDIA_SVR_RETRY_OUT_OF_RANGE
subRC_APP_BG_INPUT_RETRY_OUT_OF_RANGE
Table 504 Update BG Parms Return Codes

BGName Business Group Name. Please refer to the definition of
BGName in Section 5.4, “Primitive
on page 78.
MDRIndicator Message Detail Recording enum Off, On Off
Indicator. This parameter is
set as On/Off to indicate the
insertion of the MDR
Customer
ID in the CDR records. To
enable this feature, the MDR
Customer ID must be
provided.
Table 505 Update BG Parms Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Update BG Parms

MDRCustID Message Detail Recording 1..10 Numeric string N/A
Customer ID. A string of
digits associated with a BG
that must be unique in the
switch.
NumberPlanName The new Number Plan Name. Please refer to Section 5.4, “Primitive N/A
BGCommonNumber The name of a common Please refer to Section 5.4, “Primitive N/A
PlanName numbering plan to be used Data Definitions”, on page 78.
when BGLs “escape” from a
BG private numbering plan.
Only one
BGCommonNumberPlanNam
e is allowed per BG, and it is
optional.
Note that the specified
numbering plan must be
reserved for the BG before it
can be assigned as the BG
Common Numbering Plan.
DisplayNumber The new Display Number. See definition of DisplayNumber in N/A
Section 11.1, “Create BG”, on page
480.
MediaSvrRetry Media Server Retry Count. integer 1..5 3 (on BG
Count Specifies the number of times creation - for
to re-try a failed media server this request, N/
request for digit collection. A)
Specific to the HotDesking
feature.
MediaSvrTimeout Media Server Timeout integer 1..60 15 (on BG
Interval Interval. Timeout period for creation - for
media server requests. this request, N/
Specific to the HotDesking A)
feature.
InputRetryCount Input Retry Count. The integer 1..5 3 (on BG
maximum number of times to creation - for
retry in response to invalid this request, N/
subscriber input. Specific to A)
the HotDesking feature.
NewBGName The new BG Name Please refer to the definition of
BGName in Section 5.4, “Primitive
BGAccessCode Indicates the BG Access Code 1..15 Numeric string (0..9), plus N/A (Not
for the specifig BG. * and #. mandatory
field)
Trusted Boolean True, False
ReverseMlhgHMBTo Boolean True, False
ggleLED
Table 505 Update BG Parms Input Fields (Seite 2 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Business Group Departments
11.13 Business Group Departments

Business Groups can further be divided into departments and BGLs can
then be assigned to them. The following functionality for departments
is supported.
• Create department — Every BG can have a maximum of 50

departments, with any number of BGLs assigned to them. The
name of a department is restricted to twenty characters.
• Delete department — Departments which do not have any BGLs

assigned to them can be deleted. If a department has BGLs
assigned to them the request for deletion will be rejected.
• Modify department name — Change the name of an existing

department.
• Retrieve a list of departments — This returns the list of departments

created for the particular BG.
• Retrieve a list of subscribers assigned to a department.
• Assign/Unassign a BGL to a department.
11.13.1 Create BG Dept

This method is used to create a BG Department.

WSDL Version
10.00.01.06 subrc_SUCCESS
subRC_APP_BG_DEPT_OUT_OF_RANGE
subRC_APP_BG_DEPT_DUPLICATE
subRC_APP_BG_DEPT_EXIST
subRC_DB_BG_DEPT_INSERTION_FAILED
Table 506 Create BG Dept Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Business Groups

on page 78.
BGName The name of an existing BG Please refer to the definition of BGName in Null
for which a department is Section 5.4, “Primitive Data Definitions”, on
being created. page 78.
BGDeptName The name of the department 1..20 Character string. Null
being created. Limited to 50
departments for a single BG.
BGDeptVariant Attribute (per department) enum • BGDeptVariantBilling
which defines if a department • BGDeptVariantEmergency
is used for the current billing
purposes or for emergency
calling group purposes.
Table 507 Create BG Dept Input Fields
11.13.2 Delete BG Dept

This method enables you to delete a BG department.

WSDL Version
subRC_APP_BG_DEPT_IN_USE
subRC_DB_BG_DEPT_DELETION_FAILED
Table 508 Delete BG Dept Return Codes

on page 78.
Table 509 Delete BG Dept Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Business Groups

being deleted. page 78.
being deleted. Limited to 50
Table 509 Delete BG Dept Input Fields (Seite 2 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
11.13.3 Modify BG Dept

This method adds, modifies, or removes a BG department.

WSDL Version
subRC_APP_BG_DEPT_DUPLICATE
subRC_DB_BG_DEPT_MODIFY_FAILED
Table 510 Modify BG Dept Return Codes

on page 78.
being created. Limited to 50
Table 511 Modify BG Dept Input Fields
11.13.4 Get BG Dept List

This method retrieves a list of BGs.
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Business Group Subnets

WSDL Version
subRC_SYS_BG_DEPT_ALLOC_ERR
Table 512 Get BG Dept List Return Codes

Table 513 Get BG Dept List Input Fields
11.14 Business Group Subnets

Business group subnet administration provides the BG administrator
with the ability to provision the E9-1-1 Subnet Table on a per-BG basis.
The purpose of a BG subnet is to associate one or more LINs (Location
Identification Numbers) with a particular physical location to be used
by an emergency operator, also known as a PSAP (Public Safety
Answering Point). The physical location is expressed with either an IP
address/ Subnet mask and/or Location Domain name. Location Domain
and IP address/Mask must be unique. It is not allowed to create a Bg
Subnet which either IP/Mask or Location Domain is already
provisioned. Registered endpoints may have their own associated LIN
that determines not only the BG subnet but also the caller that placed
an emergency call. Initially, the caller starts an E911 call. After
OpenScape Voice identifies the called digits as an emergency number,
it retrieves a LIN from the list and the corresponding route number. Its
Address Of Record is also stored to allow callbacks from Public Safety
Answering Point (PSAP). The route number is used to lead the call to
an appropriate gateway, which routes the call to the appropriate PSAP
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
center. The PSAP center uses the LIN as a key to trigger its database
(ALI) and retrieve correct information on the caller's location. If PSAP
is not available, the call can be redirected to a default callback number
(DCBN entry). Originally, PSAP uses the callback number (CBN entry)
stored in the ALI database. OpenScape Voice identifies an incoming call
from the PSAP as an emergency call and checks who has to be called
by using the AoR. This call bypasses all features that prevent a call
from being delivered to the station that placed an E911 emergency call.
The callback number must be defined for each LIN entry, but a default
callback number does not. It is not possible to provisioning a callback
number that is already a registered DN, and vice versa. Only a
registered DN can be used as a valid default callback number. With the
SOAP requests described in the following section, the SOAP server
provides the ability to create, update, delete, and retrieve information
about BG subnets.
Attention: BG Subnets are intended for use in the Enterprise

environment.
11.14.1 Get Bg Subnet Info

This method retrieves information about a BG’s subnets.

WSDL Version
subRC_APP_BG_SUBNET_OR_IP_LEN_INVALID
subRC_APP_BG_SUBNET_IP_INVALID
subRC_APP_BG_SUBNET_MASK_LEN_INVALID
subRC_APP_BG_SUBNET_MASK_INVALID
subRC_APP_BG_SUBNET_DOES_NOT_EXIST
subRC_APP_BG_SUBNET_MEMORY_ALLOCATION_ERROR
Table 514 Get Bg Subnet Info Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Business Groups

BGName Business Group Name. Please refer to the definition of BGName in required
page 78.
SubnetOrIp A string in IP address format 45 Any valid IP address. required
that represents the subnet or
individual IP address.
SubnetMask A string in IP address format 45 Any valid IP address. required
that represents the subnet
mask.
Location Domain Location Domain name No 64 [1…64]
BOName V7.00.01.0: char 0…30 Optional
Branch Office Name to be
associated with BGSubnet
IpV6Address IPV6 address. char Any valid IP address. N/A
V7.00.19.01
IpV6PrefixLen IPV6 mask. integer N/A

V7.00.19.01
Table 515 Get Bg Subnet Info Input Fields

BGName Business Group Name. Please refer to the definition of BGName in N/A
page 78.
SubnetOrIp A string in IP address format 1..45 Any valid IP address. N/A
SubnetMask A string in IP address format 1..45 Any valid IP address. N/A
mask.
OBSOLETE/REMOVED in
V8
ScanRate Used by a background task to integer 0..999 (seconds) 0
determine how often to scan
a subnet for L2 changes.
OBSOLETE/REMOVED in
V8
ScanResponseTi Determines the timeout value integer 1..9999 (ms) 5
meout used when waiting for
responses from L2 switches.
Description Alphanumeric string 0..128 Character string. ““
describing this BG Subnet
entry.
Table 516 Get Bg Subnet Info Output Fields (Seite 1 von 3)
A31003-H80A0-T101-1-7618, 11/2021
Business Groups

LIN The Location Identification 0..20 Numeric string. ““
Number for the subnet; used
for all L2 switches discovered
on this subnet. Optional. If
not entered, defaults to blank
(in this case indicating that
this Subnet/IP is to be
specifically excluded from a
LIN that covers other entries
of which this Subnet/IP would
normally be a part).
Callback The Callback Number. 0..25 Numeric string N/A
Number (CBN) Mandatory.
Default Callback When PSAP is not available, 0..25 Numeric string N/A
Number (DCBN) the call is redirected to a
default callback number.
Optional.
Use Default If set to true, the default Boolean false, true false
Callback callback number is used
Number instead of the callback
number. Optional.
RouteNumber Appended to the subscriber- 0..4 Numeric string. 0
dialed number for
retranslation and routing of
the call to the PSAP operator.
Passcode Enables administrators to 6..20 Character string. N/A
secure access to their subnet
table. This is for use in a
future phase when data for
multiple OpenScape Voice
system’s is aggregated at a
higher level and the
aggregate table is accessed
Assistant. The administrator
will have access only to data
for which the matching
Passcode is supplied.
OBSOLETE/REMOVED in
V8
ALIDBID Automatic Location integer 0..9999 0
Identification Database ID.
For use by components
external to the OpenScape
Voice system to organize BG
Subnet data.
OBSOLETE/REMOVED in
V8
A31003-H80A0-T101-1-7618, 11/2021
Business Groups

SendLINInstead If true, indicates that the LIN Boolean false, true false
CPN is to be sent instead of the
CPN (Calling Party Number)
for E911 calls.
Note: All of the calling

subnets must be defined
since endpoints can reside in
different locations other than
the gateway. Therefore, if the
BGL's number is to be sent on
a E911 Call, leave the Send
LIN instead of CPN parameter
as the default (false) value.
However, if the BG main
number (or any other number
other than the BGL) is to be
sent on a E911 Call, set this
parameter, Send LIN instead
of CPN, to true.
The endpoint profile for the
outbound gateway must have
the full privacy service
flagged.
V7.00.19.01

V7.00.19.01

A31003-H80A0-T101-1-7618, 11/2021
Business Groups
11.14.2 Create Bg Subnet

This method creates a BG subnet.

WSDL Version
V5.00.18.01 subRC_APP_LOCATION_DOMAIN_LEN_INVALID
subRC_APP_DSA_LOCATION_DOMAIN_NAME_SIP_PROXY_INVALID
subRC_APP_BG_SUBNET_PASSCODE_LEN_INVALID
subRC_APP_BG_SUBNET_DESCRIPTION_LEN_INVALID
subRC_APP_BG_SUBNET_LIN_LEN_INVALID
subRC_APP_BG_SUBNET_ROUTE_NUMBER_LEN_INVALID
subRC_APP_BG_SUBNET_SCAN_RATE_INVALID
subRC_APP_BG_SUBNET_SCAN_RES_OUT_OF_RANGE
subRC_APP_BG_SUBNET_ALIDBID_INVALID
subRC_APP_BG_SUBNET_EXIST
subRC_DB_BG_SUBNET_INSERTION_FAILED
subRC_BG_SUBNET_ALREADY_EXISTS
subRC_APP_BG_SUBNET_MAX_LINS_NUMBER_EXCEED
subRC_APP_BG_SUBNET_LIN_INVALID
subRC_APP_BG_SUBNET_CBN_INVALID
subRC_APP_BG_SUBNET_DCBN_INVALID
subRC_APP_BG_SUBNET_USEDCBN_INVALID
subRC_APP_BG_SUBNET_LIN_LIST_ENTRIES_FAIL
Table 517 Create Bg Subnet Return Codes

page 78.
Table 518 Create Bg Subnet Input Fields (Seite 1 von 3)
A31003-H80A0-T101-1-7618, 11/2021
Business Groups

mask.
on page 78.
OBSOLETE IN V8
entry.
Enter the Number of LIN entries to 6 1-100000 N/A
number of delete, If set 0 the whole
LINList BgSubnet is deleted with all
of its LIN entries
normally be a part).
Callback The Callback Number. 0..25 Numeric string N/A
Number Mandatory.
(CBN)
Default Callback When the PSAP is not 0..25 Numeric string ““
Number available, the call is
(DCBN) redirected to a default
callback number. Optional.
Use Default If set to true, the default Boolean true, false false
number.
A31003-H80A0-T101-1-7618, 11/2021
Business Groups

AllOrNone If set to true, no LIN entries Boolean true, false false
are provisioned, even if only
one entry fails. If set to false,
only valid entries are
provisioned.
dialed number for
multiple 8000s is aggregated
at a higher level and the
OBSOLETE in V8.
Subnet data. Optional.
OBSOLETE in V8.
V7.00.19.01

V7.00.19.01
11.14.3 Get Bg Subnet List

This method retrieves and lists subnets.
A31003-H80A0-T101-1-7618, 11/2021
Business Groups

WSDL Version
subRC_SYS_BG_SUBNET_ALLOC_ERR
Table 519 Get Bg Subnet List Return Codes

requests. For more
BGName Business Group name. Please refer to the definition of BGName in ““
filtering. page 78.
Provided for filtering.
mask. Provided for filtering.
IpV6Address A IPV6 Address string
IpV6PrefixLen IPV6 prefix length Integer
Table 520 Get Bg Subnet List Input Fields (Seite 1 von 3)
A31003-H80A0-T101-1-7618, 11/2021
Business Groups

LIN The Location Identification 0..20 Numeric string.* N/A
normally be a part). Provided
for filtering.
Callback The callback number. 0..25 Numeric string N/A
Number Mandatory.
(CBN)
Default Callback When the PSAP is not 0..25 Numeric string N/A
Use Default If set to true, the default Boolean true, false false
number.
RouteNumber Appended to the subscriber- 0..4 Numeric string. N/A
dialed number for
ALIDBID Automatic Location int 0..9999 N/A
OBSOLETE in V8.
A31003-H80A0-T101-1-7618, 11/2021
Business Groups

CPN (Calling Party
Number) for E911 calls.

of CPN, to true.
flagged.
GetBgSubnetLis A list of extra BG Subnet enum BgSubnetListDataInclDescrip

tD fields to be retrieved tion _ (V7.00.01.06)
ataOptionList BgSubnetListDataInclBONam
e (V7.00.01.09)
* One or more occurrences of the asterisk (*) are allowed within the LIN string on this request only to represent a wild card
character. BG Subnet entries whose LIN string matches the entered string with any character in the position(s) specified
by the * will be returned.
Table 521 lists the output fields for this method. A list of elements, each
containing the following data items, is returned.

page 78.
mask.
Table 521 Get Bg Subnet List Output Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Business Groups

V7.00.01.09
entry. V7.00.01.06
11.14.4 Delete Bg Subnet

This method deletes BG Subnets from the OpenScape Voice system.

WSDL Version
subRC_DB_BG_SUBNET_DELETION_FAILURE
subRC_DB_BG_SUBNET_DELETION_FAILURE
Table 522 Delete Bg Subnet Return Codes

page 78.
Mandatory for this request.
Table 523 Delete Bg Subnet Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Business Groups

mask. Mandatory for this
request.
number of delete, If set to 0, the entire
of its LIN entries
V7.00.19.01

V7.00.19.01
Table 523 Delete Bg Subnet Input Fields (Seite 2 von 2)
11.14.5 Update Bg Subnet

This method modifies a BG subnet

WSDL Version
subRC_APP_BG_SUBNET_PASSCODE_LEN_INVALID
subRC_APP_BG_SUBNET_DESCRIPTION_LEN_INVALID
Table 524 Update Bg Subnet Return Codes (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Business Groups

WSDL Version
subRC_DB_BG_SUBNET_MODIFY_FAILED
subRC_APP_BG_SUBNET_MAX_LINS_NUMBER_EXCEED
subRC_APP_BG_SUBNET_LIN_LIST_ENTRIES_FAIL
Table 524 Update Bg Subnet Return Codes (Seite 2 von 2)

page 78.
Mandatory for this request.
mask. Mandatory for this
request.

V7.00.01.09
EmergencyBGD string
eptName

V7.00.19.01

V7.00.19.01

on page 78.
Optional.
OBSOLETE in V8
Table 525 Update Bg Subnet Input Fields (Seite 1 von 4)
A31003-H80A0-T101-1-7618, 11/2021
Business Groups

entry.
number of delete, If set to 0, the entire
of its LIN entries
for filtering.
Callback The callback number. 0..25 Numeric string N/A
Number Mandatory.
(CBN)
Default Callback When the PSAP is not 0..25 Numeric string N/A
Use Default If set to true, the default Boolean true, false N/A
number.
provisioned.
dialed number for
Optional. Defaults to 0.
A31003-H80A0-T101-1-7618, 11/2021
Business Groups

Mandatory.
OBSOLETE in V8.
OBSOLETE in V8.
NewEmergency New Emergency BG Dept string
BGDeptName Name
NewSubnetOrIp Update is for the subnet or IP string
NewSubnetMas New Netmask string
k
NewIpV6Addres New IPv6 address string
s
NewIpV6PrefixL New IPv6 prefix integer
en
NewLocationDo New location domain. string
main
AllOrNone If set to true, no LIN entries Boolean
provisioned.
A31003-H80A0-T101-1-7618, 11/2021
Business Groups

CPN (Calling Party
Number) for E911 calls.

of CPN, to true.
flagged.
11.14.6 Get Bg Subnet And LIN List

This method retrieves and lists subnets and their Location Identity
Numbers.

WSDL Version
subRC_SYS_BG_SUBNET_ALLOC_ERR
Table 526 Get Bg Subnet List Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Business Groups

requests. For more
OperatorId
BGName Business Group name. Please refer to the definition of BGName in ““

filtering. page 78.
LastSyncTime Time when last synched dateTime

Optional.
OBSOLETE in V8
entry.
Number of Number of LIN entries to get, 6 1-100000 N/A
LINList
for filtering.
provisioned.
Table 527 Get Bg Subnet and LIN List Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Business Groups

dialed number for
Optional. Defaults to 0.
Mandatory.
OBSOLETE in V8.
OBSOLETE in V8.
SendLINInstead Bool
CPN
AssociatedEndp string
ointIP
RepresentativeE string
ndpointName
Table 527 Get Bg Subnet and LIN List Input Fields (Seite 2 von 2)
Table 521 lists the output fields for this method. A list of elements, each
containing the following data items, is returned.

page 78.
mask.
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Business Group Authorization Codes

V7.00.01.09
entry. V7.00.01.06
11.15 Business Group Authorization Codes

Depending on the traffic type, an off-network authorization code may
be required to allow external calls. The authorization codes are defined
at the BG level, not at the BGL level. Each BG can have 50,000
authorization codes defined. The maximum number of authorization
codes that can be defined on the switch is 100,000. Each time a BG
subscriber dials a number that corresponds to an external call, an
authorization code may be provided. If provided, it is validated by call
processing to determine whether the subscriber is authorized to make
the call. With the SOAP requests described in the following section, the
SOAP Server provides the ability to create, delete, and retrieve BG
authorization codes. All of these requests can be done for one
authorization code or a list of authorization codes.
11.15.1 Create Auth Code

This method creates authorization codes. It supports the association of
an Authorization Code with a Subcriber DN and a type (business or
private). If the crafts person enters a Subscriber DN then he/she shall
also have to select a type and vice versa.
A31003-H80A0-T101-1-7618, 11/2021
Business Groups

WSDL Version
10.00.01.17 subRC_APP_COMM_OPERATOR_INVALID
subRC_APP_BG_AUTH_CODE_LEN_INVALID
subRC_APP_BG_AUTH_CODE_MISSING
subRC_APP_BG_AUTH_CODE_INVALID
subRC_APP_BG_AUTH_CODE_SYS_OUT_OF_RANGE
subRC_APP_BG_AUTH_CODE_OUT_OF_RANGE
subRC_APP_BG_AUTH_CODE_EXIST
subRC_DB_BG_AUTH_CODE_LOOKUP_FAILED
subRC_DB_BG_AUTH_CODE_INSERTION_FAILED
subRC_WAR_BG_AUTH_CREATION_FAILED
subRC_SUCCESS
Table 529 Create Auth Code Return Codes

on page 78.
page 78.
*__ptrAuth Pointer to the first auth code N/A N/A N/A
CodeEntry of the list to be created.*
__size Number of the elements in int 1..50000 N/A
the list of auth codes to be
created.*
*Member of the unsp_AuthCodeList.
ServiceId Service DN Char N/A
AuthCodeType The type of the Authorization Enum Undefined, N/A

Business,
Private
Table 530 Create Auth Code Input Fields
11.15.2 Delete Auth Code

This method deletes an authorization code.
A31003-H80A0-T101-1-7618, 11/2021
Business Groups

WSDL Version
subRC_APP_BG_AUTH_CODE_NUMBER_DEL_INVALID
subRC_APP_BG_AUTH_CODE_INVALID
subRC_APP_BG_AUTH_CODE_DOES_NOT_EXIST
subRC_APP_BG_AUTH_CODE_DELETION_FAILED
subRC_WAR_BG_AUTH_DELETION_FAILED
subRC_SUCCESS
Table 531 DeleteAuthCode Return Codes

on page 78.
page 78.
*__ptrAuth Pointer to the first auth code N/A N/A N/A
CodeEntry of the list to be created.*
__size Number of the elements in int 1..50000 N/A
the list of auth codes to be
created.*
*Member of the unsp_AuthCodeList.
Table 532 Delete Auth Code Input Fields
11.15.3 Get Auth Code List

This method supports the retrieval of the list of Authorization Codes
with their associated SubscriberDN and type. Paging, sorting
(Ascending/Descending) and filtering on SubscriberDN and Type.
A31003-H80A0-T101-1-7618, 11/2021
Business Groups

WSDL Version
subRC_APP_BG_AUTH_CODE_OUT_OF_RANGE
subRC_SYS_BG_AUTH_CODE_ALLOC_ERR
subRC_SUCCESS
Table 533 Get Auth Code List Return Codes

on page 78.
page 78.

Business,
Private
requests. For more
Table 534 Get Auth Code List Input Fields
11.15.3.1 Get Auth Code
This method retrieves an authorization code.
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Modify Auth Code

WSDL Version
subRC_APP_BG_AUTH_CODE_MISSING
subRC_SUCCESS
Table 535 Get Auth Code Return Codes

on page 78.
page 78.
AuthCode Authorization Code. Refer to
Table 536 Get Auth Code Input Fields
11.16 Modify Auth Code

Interface for supporting the update of an Authorization Code and/or
the associated SubscriberDN and/or the Type. If the crafts person
enters a Subscriber DN then he/she shall also have to select a type and
vice versa. Validations shall be performed by both RSS/SOAP.

OperatorId Yes I/F Char array 40 (1…40)
operator
BGName Business Group Name to be Char 1…30 mandatory

associated with Authorization
Code
AuthCode Authorization Code to be Char 2…14 mandatory

modified
Table 537 Get Auth Code Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Private Numbering Plan

NewAuthCode New Authrization Code Char 2…14 optional

Business,
Private
Table 537 Get Auth Code Input Fields (Seite 2 von 2)
11.17 Private Numbering Plan

A Private Numbering Plan may be used to define allowable dialing,
translation, and routing for a Business Group. The Numbering Plan
Name is provisioned as part of the Business Group data. If no
Numbering Plan ID/Numbering Plan Name are provided, the default is
provisioned as the system default Private Numbering Plan (1).
The specified Business Group Name is provisioned internally as the

Customer Name. The Numbering Plan information cannot be modified.
The provisioning of Private Numbering Plans for Business Groups is

accomplished through the OpenScape Voice Assistant. The system
default Numbering Plan can also be used to assign to a Business Group.
The Number Plan is defined when the BG is created and may not be
changed. If not specified on BG creation, the system default will apply.
The system defaults are provisioned as follows:

- PSTN Switch: NumberPlanId: 9999 NumberPlanNAme:
E164DEFAULT
NumberPlanType: NPTypeE164NANP
Only the system default Numbering Plan can be shared among different
BGs. A Private Numbering Plan associated with a BG cannot be shared
by another BG.
For more information about Numbering Plans, refer to Chapter 12,

“Numbering Plans”.
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Business Group System Speed Dial Lists
11.18 Business Group System Speed Dial Lists

The SOAP requests in this section allow a Business Group administrator
to define, populate, and manage BG Speed Dial lists. Out of a system
pool of 10,000 BG System Speed Dial lists and 1,000,000 Speed Dial
entries, a BG can be assigned up to 10,000 (1..10,000) BG System
Speed Dial lists, where a list may have up to 1,000 entries (0..999).
When the available pool of lists or of entries is exhausted, the BG
administrator is informed during provisioning.
The lists are then usable by Business Group Lines who have the
CfBgSpDial feature (see Section 11.17, "Business Group System Speed
Dial Lists") subscribed and active. Each user has access to up to two of
the 10,000 BG level lists via separately defined Prefix Access Codes.
The user dials the appropriate Prefix Access Code followed by an Entry
Id to access a particular entry on a list, and the number stored for that
entry is dialed, whether it consists of a destination, an account code,
etc. The Speed Dial list is available anytime the user can dial, and not
limited to idle, talk, conference and all consultation dial states.
Attention: This feature is separate from, and not to be confused with

the Speed Calling feature (see Section 10.47, “System Speed Dial
(CfBgSpDial)”) that is also available to subscribers and BGLs.
A list entry may contain access codes for account codes, the account
code itself, feature access codes, and the dialed party number (private
or public). Each list entry may be up to 30 characters in length,
consisting of digits, # and *. Each list has its own entries, they are not
shared.
A Speed Dial list is accessible anytime a user attempts to dial another

destination. The Speed Dial list entry is processed until the sequence
is completed or an error condition is reached.
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
11.18.1 Create Bg Speed Dial List

This request creates a BG Speed Dial List.
Table 538 lists the return codes for this request.

WSDL Version
subRC_APP_FEAT_BGSPDIAL_NO_ENTRY_LIST_PASSED
subRC_APP_FEAT_BGSPDIAL_LIST_NAME_LEN_INVALID
subRC_APP_FEAT_BGSPDIAL_LIST_ID_MISSING
subRC_APP_FEAT_BGSPDIAL_LIST_ID_INVALID
subRC_APP_FEAT_BGSPDIAL_LIST_ID_ALREADY_EXISTS
subRC_APP_FEAT_BGSPDIAL_LIST_NAME_ALREADY_EXISTS
subRC_APP_FEAT_BGSPDIAL_LIST_CREATE_FAILED
subRC_APP_FEAT_BGSPDIAL_ENTRY_MAX_NUMBER_EXCEED
subRC_APP_FEAT_BGSPDIAL_ENTRY_ID_MISSING
subRC_APP_FEAT_BGSPDIAL_ENTRY_ID_INVALID
subRC_APP_FEAT_BGSPDIAL_ENTRY_DATA_LEN_INVALID
subRC_APP_FEAT_BGSPDIAL_ENTRY_DATA_MISSING
subRC_APP_FEAT_BGSPDIAL_ENTRY_DATA_INVALID
subRC_APP_FEAT_BGSPDIAL_ENTRY_CREATE_FAILED
subRC_APP_FEAT_BGSPDIAL_ENTRIES_CREATE_COMPLETE_WITH_
ERRORS
Table 538 Create Bg Speed Dial List Return Codes
Table 539 lists the input fields for this request.

on page 78.
page 78.
ListName A name to associate with the 0..30 Character String ““
BG Speed Dial List. This
attribute is optional, and is
not used as a key to identify
the list; it is for informational
purposes only. However, it
must be unique within the
BG.
Table 539 Create Bg Speed Dial List Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
AllOrNone A flag to indicate whether Boolean True, False

atomic processing is required False
or partial success is allowed.
If True, when the processing
of one entry fails, the data is
rolled back to its state prior to
the request. If False, when
the processing of one entry
fails, a best effort attempt will
be made, and the subsequent
entries will be processed.
Note: If AllOrNone is False,
and errors occur, a list of
errors is returned identifying
which entries could not be
processed successfully.
BgSpeedDialList A structure containing the following attributes:
Create
BgSpeedDialList The numeric identifier of the integer 1..10,000 mandatory
Create. list to be created.
ListId
BgSpeedDialListCreate. An optional list of entries to assign to the list at creation.
BgSpeedDialListOfEntries Each entry contains the following attributes:
BgSpeedDialList The numeric identifier of the integer 0..999 N/A
Create. entry.
BgSpeedDialList
OfEntries.
EntryId
BgSpeedDialList The content of the entry, 1..30 Character String N/A
Create. which may consist of digits, *
BgSpeedDialList or #.
OfEntries.
EntryData
Table 539 Create Bg Speed Dial List Input Fields (Seite 2 von 2)
11.18.2 Update Bg Speed Dial List

This request updates the name of a BG Speed Dial List.
A31003-H80A0-T101-1-7618, 11/2021
Business Groups

WSDL Version
subRC_APP_FEAT_BGSPDIAL_LIST_ID_NOT_EXISTS
subRC_APP_FEAT_BGSPDIAL_LIST_NAME_ALREADY_EXISTS
Table 540 Update Bg Speed Dial List Return Codes

on page 78.
page 78.
ListId The numeric identifier of the integer 1..10,000 mandatory
list to be updated.
ListName A name to associate with the 0..30 Character String N/A
BG. To remove a ListName,
the empty string may be
provided.
Table 541 Update Bg Speed Dial List Input Fields
11.18.3 Update Bg Speed Dial List Entries

This request adds entries to a BG Speed Dial List or updates existing
entries.
A31003-H80A0-T101-1-7618, 11/2021
Business Groups

WSDL Version
subRC_APP_FEAT_BGSPDIAL_ENTRY_DATA_LEN_INVALID
subRC_APP_FEAT_BGSPDIAL_ENTRY_DATA_MISSING
subRC_APP_FEAT_BGSPDIAL_ENTRY_DATA_INVALID
subRC_APP_FEAT_BGSPDIAL_ENTRY_CREATE_FAILED
subRC_APP_FEAT_BGSPDIAL_ENTRY_UPDATE_FAILED
subRC_APP_FEAT_BGSPDIAL_ENTRIES_UPDATE_COMPLETE_WITH
_ERRORS
Table 542 Update Bg Speed Dial List Entries Return Codes

on page 78.
page 78.
Update
Table 543 Update Bg Speed Dial List Entries Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Business Groups

Update. list to be updated.
ListId
BgSpeedDialListUpdate. The list of entries to be added to the list or to be updated in
BgSpeedDialListOfEntries the list if they exist already. Each entry contains the
following attributes:
Update. entry.
BgSpeedDialList
OfEntries.
EntryId
BgSpeedDialList The content of the entry, 1..30 Character String N/A
Update. which may consist of digits, *
BgSpeedDialList or #.
OfEntries.
EntryData
Table 543 Update Bg Speed Dial List Entries Input Fields (Seite 2 von 2)
11.18.4 Delete Bg Speed Dial List Entries

This request deletes entries from a BG Speed Dial List.

WSDL Version
subRC_APP_FEAT_BGSPDIAL_ENTRY_ID_NOT_EXISTS
subRC_APP_FEAT_BGSPDIAL_ENTRY_REMOVE_FAILED
subRC_APP_FEAT_BGSPDIAL_ENTRIES_DELETE_COMPLETE_WITH_
ERRORS
subRC_APP_FEAT_BGSPDIAL_DB_LOOKUP_ERROR
Table 544 Delete Bg Speed Dial List Entries Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Business Groups

on page 78.
page 78.
Delete
Delete. list to be updated.
ListId
BgSpeedDialListDelete. The list of entries to be deleted from the list. Each entry
BgSpeedDialListOfEntries contains the following attributes:
Delete. entry.
BgSpeedDialList
OfEntries.
EntryId
Table 545 Delete Bg Speed Dial List Entries Input Fields
11.18.5 Delete Bg Speed Dial List

This request deletes an entire BG Speed Dial List including all its
entries.
A31003-H80A0-T101-1-7618, 11/2021
Business Groups

WSDL Version
subRC_APP_FEAT_BGSPDIAL_ENTRY_NUMBER_RETRIEVE_ERROR
subRC_APP_FEAT_BGSPDIAL_LIST_REMOVE_FALIED
Table 546 Delete Bg Speed Dial List Return Codes

on page 78.
page 78.
list to be updated.
Table 547 Delete Bg Speed Dial List Input Fields
11.18.6 Get Bg Speed Dial List

This request retrieves a BG Speed Dial List.

WSDL Version
subRC_APP_FEAT_BGSPDIAL_STARTING_INDEX_INVALID
Table 548 Get Bg Speed Dial List Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Business Groups

on page 78.
InterfaceWSDL The WSDL version of the Refer to Character string Latest
request. Section
5.1,
“Interface
(WSDL)
Versions”,
on page
73.
page 78.
list to be updated.
StartingIndex The entry ID of the entry with integer 0..999 0
which to start. By default, the
starting index is the
beginning of the list.
requests. For more
SortType Provides sorting on EntryId Enumerat SortByEntryId, SortByEntryId
and on EntryData or SortByEntryData
SortOrder Provides selection of sorting Enumerat SortOrderAscending, SortOrderAsce
order or SortOrderDescending nding
FilterType Provides filtering on EntryId Enumerat FilterBgSpeedListEntryId, FilterBgSpeedLi
and on EntryData or FilterBgSpeedListEntryData stEntryId
Table 549 Get Bg Speed Dial List Input Fields
Table 550 lists the output fields for this request.

page 78.
Table 550 Get Bg Speed Dial List Output Fields
A31003-H80A0-T101-1-7618, 11/2021
Business Groups

ListName A name to associate with the 0..30 Character String N/A
BG. To remove a ListName,
the empty string may be
provided.
. list.
ListId
BgSpeedDialList. The list of entries in the list. Each entry contains the
BgSpeedDialListOfEntries following attributes:
. entry.
BgSpeedDialList
OfEntries.
EntryId
Table 550 Get Bg Speed Dial List Output Fields
11.18.7 Get Bg Speed Dial List Ids

This request retrieves BG Speed Dial List Ids.

WSDL Version
subRC_DB_FEAT_BGSPDIAL_DB_LOOKUP_ERROR
Table 551 Get Bg Speed Dial List Ids Return Codes

on
page 80.
Table 552 Get Bg Speed Dial List Ids Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Business Groups

InterfaceWSDL The WSDL version of the Refer to Section Character
request. 5.1, “Interface string
(WSDL) Versions”, on page 75.
BGName Business Group Name. Please refer to the definition of BGName in Section 5.4,
“Primitive Data Definitions”, on page 80.
ListId The numeric identifier of the integer 1..10,000
list to
be updated.
ListName The name of the Speed Dial Character 0..30
List. String
requests. For more
information,
on
page 88.
SortType Provides sorting on List Id, Enumerat SortByListId,
List Name, Number of Entries or SortByListName,
SortByNumberOfEntries
SortOrder Provides selection of sorting Enumerat SortOrderAscending,
order or SortOrderDescending
FilterType Provides filtering on List Id Enumerat FilterBgSpeedListIds,
and List Name or FilterBgSpeedListIdsName
Table 552 Get Bg Speed Dial List Ids Input Fields (Seite 2 von 2)

page 80.
BgSpeedDialList The numeric identifier of the Integer 1..10,000 N/A
Ids list.
.ListId
BgSpeedDialList The name of the Speed Dial 0..30 Character String N/A
Ids List
.ListName
BgSpeedDialList The number of entries of the Integer 0..999 N/A
Ids Speed Dial List
.NumberOfEntri
es
Result A typical structure containing return codes (indicating success/failure/error cases),
invocation timestamp along with various informative messages. Return code list is displayed
below.
Result
Table 553 Get Bg Speed Dial List Ids Output Fields
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Business Group Parking Lots

PaginatedInfo A common paging structure containing Current Page/ Num of Pages / Page Size etc.
PaginatedInfo
BgSpeedDialList A List containing the List ID, List Name and Number of Entries for each List ID
Ids
Table 553 Get Bg Speed Dial List Ids Output Fields
11.19 Business Group Parking Lots
11.19.1 Create Parking Lot

Unsp__CreateParkingLot creates parking lot entries inside a business
group. It is placed in the Business Group menu (400) in soapCli under
the general ParkingLot menu (480). The administrator can provision a
parking lot through a single Unsp__CreateParkingLot request. The
SOAP server returns success or failure along with the error message
describing the reason for the failure.
Unsp__CreateParkingLotResult
Attribute Name Values Messages
Unsp__ResultCodeStruct Success Parking Lot <name> created Successfully
Failure No Parking Lot was created
• Invalid BG name
• Invalid Parking Lot name
• Parking Lot already exists
• Invalid Recall timer Value. Allowed values
30-600 with stepping of 30
• Invalid ParkSpaceStart value. Value length
must not exceed 5 digits.
• Invalid ParkSpaceEnd value. Value length
• Limit of 10000 Parking Spaces per system
is exceeded.
Table 554 Create Parking Lot Result Fields
Unsp__CreateParkingLotRequest
Attribute Name Type Default Description
Value
BGName unsp__BGName NA Mandatory. The BG where the parking lot is
assigned. Length is 30 chars maximum.
Table 555 Create Parking Lot Request Fields
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Unsp__CreateParkingLotRequest
Value
ParkingLotName xsd__string NA Mandatory. The parking lot name. Length is
20 chars maximum.
RecallTimer int 180 Optional. A value in steps of 30. Minimum
value: 30. Maximum value: 600
ParkSpaceStart int 0 Optional. 5 digits long at maximum. When not
set starting space is at position 0
ParkSpaceEnd int 9 Optional. 5 digits long at maximum. When not
set, ending space is at position 9
Table 555 Create Parking Lot Request Fields
11.19.2 Update Parking Lot

unsp__UpdateParkingLot updates existing parking lot entities inside a
business group, with one entry per request. It is placed in the Business
Group menu (400) in soapCli under the general ParkingLot menu
(480). New parking lots cannot be provisioned from this interface.
Furthermore, there is no capability to move a parking lot to a different
business group. The administrator can modify all values of the request
structure except for the BG name. Unsp__UpdateParkingLot is used to
modify the values of the following fields:
• RecallTimer
• ParkSpaceStart
• ParkSpaceEnd
• ParkingLotName
Note: When the administrator modifies the parking lot name, all
parked calls are lost. SOAP will proceed with the update and issues a
message that will inform about the loss of parked calls.
Unsp__UpdateParkingLotResult
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Unsp__ResultCodeStruct Success Parking Lot(s) updated Successfully

Failure No Parking Lot was updated
• Invalid BG name
• Invalid Parking Lot name
• Parking Lot does not exist
• Invalid Recall timer Value. Allowed values
30-600 with stepping of 30
• Invalid ParkSpaceStart value. Value length
• Invalid ParkSpaceEnd value. Value length
• Limit of 10000 Parking Spaces per system
is exceeded(Req[3008])
• Proposed name for ParkingLotName
already exists. Please use a different
ParkingLotName or delete the existing one.
Unsp__UpdateParkingLotRequest
Value
ParkingLotName xsd__string NA Mandatory. The parking lot name length is 20
chars maximum.
newParkingLotName xsd__string NA Optional. A NULL value leaves the parking lot
name as is. The parking lot name length is 20
chars maximum.
RecallTimer int 180 Optional. Field that is allowed to be modified.
A NULL value leaves the current value
unchanged. A value in steps of 30. Minimum
value: 30. Maximum value: 600
ParkSpaceStart int 0 Optional. Field that is allowed to be modified.
unchanged. Value length must not exceed 5
digits. When not set starting space is at
position 0
ParkSpaceEnd int 9 Optional. Field that is allowed to be modified.
unchanged. Value length must not exceed 5
digits. When not set, ending space is at
position 9
Table 557 Update Parking Lot Request Fields
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
11.19.3 Delete Parking Lot

unsp__DeleteParkingLot deletes an existing parking lot entry inside a
business group. It is placed in the Business Group menu (400) in
soapCli under the general Parking Lot menu (480). SOAP performs
validation of BGName and ParkingLotName. If validation is passed,
SOAP destroys any association of CPS feature with parking lot. There
are two type of associations:
Subscribers with CPS feature assigned indirectly with feature profiles:
• Before deleting a parking lot, SOAP will use SDAL API

getLotFeatureProfileList() to query all feature profiles that use this
parking lot.
• For all feature profiles associated with this parking lot, a call to the
UpdateFeatureProfile2() function will take place and the CPS
feature is removed. The CPS feature is removed from the feature
profiles using RSS API remProfile(). Any association of feature
profiles and the parking lot marked for deletion is then destroyed.
• SOAP calls the existing SDAL API

removeSvcEntryFromDbAndCache() to remove the CPS feature
from each subscriber that has the CPS feature propagated through
feature profile. Any association of business group subscribers (that
used the CPS feature through feature profiles) and the parking lot
marked for deletion is then destroyed.
Subscribers with CPS feature assigned directly:
• SDAL API getLotSubscriberList() is used to query all BGL

subscribers that have the CPS feature assigned with this parking
lot.
• SOAP calls the existing SDAL API

removeSvcEntryFromDbAndCache() to remove the CPS feature
from each BGL subscriber previously found. Any association of
business group subscribers and the parking lot marked for deletion
is then destroyed.
Unsp__DeleteParkingLotResult
Table 558 Delete Parking Lot Result Fields
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Unsp__ResultCodeStruct Success Parking Lot <name> deleted Successfully

Failure Parking Lot was not deleted
• Invalid BG name
• Invalid Parking Lot name (syntax validation
failed)
• Parking Lot does not exist
• BG does not exist
Table 558 Delete Parking Lot Result Fields
Unsp__DeleteParkingLotRequest
Value
chars maximum.
Table 559 Delete Parking Lot Request Fields
11.19.4 Query Parking Lot Information

Unsp__QueryParkingLotInfo queries the details of parking lot entity
inside a business group. Unsp__QueryParkingLotInfo is placed in the
Business Group menu (400) in soapCli under the general ParkingLot
menu (480).
When calling this method, SDAL API getLotFeatureProfileList() is used

to query all feature profiles that use this parking lot. The size of the
returned list is saved to the AssociatedFPListSize.
SDAL API getLotSubscriberList() is then used to query all BGL

subscribers that have the CPS feature assigned with this parking lot.
The size of the returned list is saved to the AssociatedBGLListSize.
SDAL API getLotDataList() is used for the query with the parking lot
name and the BG index as inputs, and the desired parking lot structure
information is returned at the output.
Below a table for the required/optional elements of the request and a

table for the result is presented.
Unsp__QueryParkingLotInfoResult
Table 560 Query Parking Lot Info Result Fields
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Unsp__ResultCodeStruct Success
Failure 1. BG is found:
– Invalid BG name
2. BG is found Lot is not found
– Parking Lot was not found
Unsp__ParkingLotEntryResult
Unsp__ParkingLotEntry • BGName
• ParkingLotName
Unsp__ParkingLotEntryData • RecallTimer
• ParkSpaceStart
• ParkSpaceEnd
• AssociatedFPListSize : Number of Feature
Profiles using current Lot (see note)
• AssociatedBGLListSize: Number of
business group subscribers using current
Lot (see note)
Unsp__ResultCodeStruct Success,
Failure
Table 560 Query Parking Lot Info Result Fields
Unsp__QueryParkingLotInfoRequest
Value
BGName unsp__BGName NA Mandatory. The BG where the Parking OT is
chars maximum.
Table 561 Query Parking Lot Info Request Fields
11.19.5 Query Parking Lot List

Unsp__QueryParkingLotList queries the list of parking lot entries. It is
placed in the Business Group menu (400) in soapCli under the general
ParkingLot menu (480).
Wildcards are utilized in order to provide a more versatile way for

queries. Paging mechanism is supported in order to display multiple
entries appropriately. SDAL API getLotDataList() is used for list query
with arguments of the following table as input.
The design will supports querying by using only BG name and parking
lot name.
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Unsp__QueryParkingLotListResult
Unsp__ResultCodeStruct Success Parking Lot <name> deleted Successfully
Failure • No Parking Lot was found
Unsp__ParkingLotEntriesResult
LotEntry ParkingLotNa • Invalid BG name
me • Invalid Parking Lot name
Unsp__ResultCodeStruct Success,
Failure
Table 562 Query Parking Lot Info and Parking Lot Entries Result Fields
Unsp__QueryParkingLotListRequest
Value
BGName unsp__BGName NA Mandatory. The BG where the Parking OT is
ParkingLotName xsd__string NA Optional. The parking lot name length is 20
chars maximum. NIL selects all parking lots.
(passes NULL to SDAL).
Supports Wildcards "*" and "?" at the end of
the word. The parking lot name length is 20
chars maximum.
Table 563 Query Parking Lot Info Request Fields
Note: List method displays the names of only parking lots contained in
the business group. Use the QueryParkingLotInfo for additional details
on each parking lot.
11.19.6 Query Parking Lot Usage List

QueryLotUsageList API provides the clients with the list of Lots. There
shall be provided two different criteria for filtering the list of parking
lots.
Filter by Subscriber: All Lots allocated for Subscribers are displayed.
• Filter by providing Endpoint Profile: All Lots allocated for Endpoint

Profiles are displayed.
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
The API will support sorting by either Subscriber Name or Endpoint

Profile. Also paging will be supported.
When subscriber is used as a filter, the result is a list of entries where

each entry consists of the subscriber name and its internal display
name.
WSDL Obsolete Return Codes Messages

Version in WSDL
Vers.
V4.00.04.01 subRC_SUCCESS 0
subRC_APP_BG_DOES_NOT_EXIST 30301000 BG does not exist
subRC_APP_BG_NAME_LEN_INVALID 30301001 Invalid BG name

length
subRC_DB_BG_LOOKUP_FAILED 30301002 BG name look up failed
subRC_APP_BG_NAME_INVALID 30301003 Invalid BG name:
subRC_APP_PARKING_LOT_NAME_INVALID 33000000 Invalid Parking Lot

name:
subRC_APP_PARKING_LOT_NAME_ 33000001 Parking Lot does not
DOES_NOT_EXIST exist
subRC_APP_PARKING_LOT_NAME_ 33000002 Parking Lot already
ALREADY_EXISTS exists
subRC_APP_PARKING_LOT_NAME_INVALID 33000003 Invalid Parking Lot
_LENGTH name length:
subRC_APP_RECALL_TIMER_INVALID 33000004 Invalid Recall timer
Value. Allowed values
30-600 with stepping
of 30
subRC_APP_PARKING_SPACE_START_ 33000005 Invalid ParkSpaceStart
INVALID value. Value length
must not exceed 5
digits
subRC_APP_ 33000006 Invalid ParkSpaceEnd
PARKING_SPACE_END_INVALID value. Value length
must not exceed 5
digits
subRC_APP_PARKING_SPACES_EXCEED_ 33000007 Fail to create Parking
THRESHOLD Lot. Limit of 10000
Parking Spaces per
system is exceeded.
Table 564 Parking Lot Request Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
WSDL Obsolete Return Codes Messages

Version in WSDL
Vers.
subRC_APP_NEW_PARKING_LOT_NAME_ 33000008 Proposed name for
ALREADY_EXISTS ParkingLotName
already exists. Please
use a different
ParkingLotName or
delete the existing
one.
subRC_APP_SUB_NOT_BELONG_BG 30100006 Attempt to assign CPS
feature, but subscriber
not part of BG
subRC_APP_FEAT_CPS_DEP_MISSING 33000015 CPS requires BgCT
when Parking Allowed
is set true
subRC_APP_FEAT_CPS_INVALID_SETTING 31158001 Setting both Parking
S Allowed and Retrieval
Allowed to false is
forbidden
subRC_APP_FEAT_CPS_INVALID_PARKING 33000016 Parking Lot Name is
_ Invalid
LOT_NAME
subRC_APP_FEAT_CPS_MISSING_PARKING 33000017 Parking Lot Name is
_LOT_NAME Required
Table 564 Parking Lot Request Return Codes
Value
OperatorId I/F operator yes Char array
ParkingLotName Parking Lot Name yes xsd__string
BGName Business Group Name yes Xsd__string
UsageType Select all Subscribers yes enum
or Endpoint profiles
that a lot belongs to by
specifying the usage
type
SortDirection Provide means of no enum
sorting the results in
ascending
or descending order.
Table 565 Query Parking Lot Usage Request Fields
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Multiple Media Servers per Branch Office
Value
Paging Paging structure for no struct
Get List requests. For
more information,
refer to Section
5.5,“Paging”
Table 565 Query Parking Lot Usage Request Fields
11.20 Multiple Media Servers per Branch Office

Media Servers are used by OpenScape Voice to provide tones,
announcements and conference channels. In order to service the
subscribers within a branch, the following functionality is provided,
which will assist the modifications required for setting up multiple
media servers, with an option to support one or more media servers
per branch controlled by the OpenScape Voice in the Data Center:
• Assign Media Server to Branch Office
• Unassign Media Server from Branch Office
• Get Media Server Assignment List
11.20.1 Assign Media Server to Branch Office

This method is used to assign a media server to a specific branch office.
WSDL Version Return Codes

subRC_APP_MS_MULTIPLE_BO_FOUND
subRC_APP_MS_ENDPOINT_NOT_FOUND
subRC_APP_MS_QUERY_ROUTES_FAILED
subRC_APP_MS_MULTIPLE_DESTINATIONS_FOUND
subRC_APP_MS_NO_DESTINATIONS_FOUND
subRC_APP_MS_ENDPOINT_QUERY_ERROR
subRC_APP_MS_DESTINATION_QUERY_ERROR
subRC_APP_MS_DESTINATION_CREATION_ERROR
subRC_APP_MS_ROUTE_CREATION_ERROR
Table 566 Assign Media Server to Branch Office Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Business Groups

subRC_APP_MS_ROUTE_QUERY_ERROR
subRC_APP_MS_NO_ROUTE_FOUND
subRC_APP_MS_NO_RATE_AREA_FOUND
subRC_APP_MS_MEDIA_SERVER_NOT_FOUND
subRC_APP_MS_RTP_PARAM_READ_ERROR
subRC_APP_MS_ORIG_DEST_DOES_NOT_EXIST
subRC_APP_BO_BRANCH_OFFICE_NAME_INVALID
subRC_APP_GW_NAME_INVALID
subRC_APP_BO_QUERY_ERROR
subRC_APP_BO_DOES_NOT_EXIST
subRC_APP_BO_COULD_NOT_RETRIEVE_REPEPID
Table 566 Assign Media Server to Branch Office Return Codes

Field Name Description Type Default Value

Operator ID Please refer to Section 5.4, “Primitive Data Str Required
BranchOfficeName The name of an existing branch office that will Str Required
be unassigned
BGName The name of an existing BG in which the branch Str Required
office is included.
Media Server Name The name of the media gateway to which the Str Required
branch office will be associated.
Table 567 Assign Media Server to Branch Office Input Fields
11.20.2 Unassign Media Server from Branch

Office
This method is used to unassign a media server from a specific branch
office.
A31003-H80A0-T101-1-7618, 11/2021
Business Groups

subRC_APP_MS_ROUTE_REMOVE_ERROR
Table 568 Unassign Media Server from Branch Office Return Codes

BranchOfficeName The name of an existing branch office for which the Str Required
assignment will occur.
BGName The name of an existing BG in which the branch Str Required
office is included.
Table 569 Unassign Media Server from Branch Office Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Business Groups

MediaServerName The name of the media gateway to which the branch Str Required
office will be associated.
Table 569 Unassign Media Server from Branch Office Input Fields
11.20.3 Get Media Server Assignment List

This method returns a list of media server associations for a specified
branch office. If no filters are provided, the result is a list of unassigned
media servers (used with the default Rate Area -1).

Table 570 Get Media Server Assignment List Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Branch Office

BranchOfficeName The name of an existing branch office for which the Str N/A
assignment list is required.
BGName The name of an existing BG in which the branch Str N/A
office is included.
Table 571 Get Media Server Assignment List Output Fields
11.21 Branch Office

A branch office is an entity of related subscribers and endpoints and a
sub entity of a business group (BG). Subscribers and endpoints
belonging to a BG may optionally belong to a branch office. It is
necessary to provide the name of the representative endpoint of the
branch office to the createSubscriber or createEndpoint request in
order to assign the subscriber/endpoint to the branch office. Please
refer to Section 4.3, “Branch Offices”, on page 46 for more information.
Table 572 lists common return codes introduced for the branch office
related methods. Other pre-existing return codes can also be returned.

Version WSDL
Version
7
subRC_APP_BO_BGNAME_INVALID
subRC_APP_BO_BRANCH_OFFICE_NAME_INVA
LID
subRC_APP_BO_ENDPOINT_INVALID
subRC_APP_BO_ENDPOINT_NOT_FOUND
subRC_APP_BO_OFC_NOT_FOUND
subRC_APP_BO_RA_NOT_FOUND
subRC_APP_BO_SET_NP_FAILED
subRC_APP_BO_NP_NOT_RESERVED
subRC_APP_BO_USERNAME_INVALID
subRC_APP_BO_PASSWORD_INVALID
subRC_DB_BO_EADM_INTERNAL_ERROR
subRC_APP_BO_CREATE_ERROR
Table 572 Common Branch Office Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Branch Office

Version WSDL
Version
subRC_APP_BO_MODIFY_ERROR
subRC_APP_BO_REMOVE_ERROR
subRC_APP_BO_REQUIRED_FIELD_NOT_SPECI
FIED
subRC_APP_BO_ISOPENBRANCH_NOT_SPECIFI
ED
subRC_APP_BO_DIDDN_NOT_SPECIFIED
Table 572 Common Branch Office Return Codes
11.21.1 Create Branch Office

Used to create a branch office. The maximum number of branch offices
supported on the system is 3000.

Operator ID Please refer to Section 5.4, Str
page 78.
BranchOfficeNa The name of the branch 1-30 Character String
me office to be created.
Required
BGName The name of an Please refer to Section 5.4, “Primitive Data Definitions”, on page
existing BG in which 78.
the BO will be included.
Required
RepresentativeE The name of the 1-16 Str
ndpointName endpoint that branch
office members are to
be associated with
Executive Assistant
group.
Required
DIDPoolUpdate Provides a means of enum DIDPoolUpdtDoNotUpdate DIDPoolUpdtDoNotUpdate
specifying the DidDIDPoolUpdtAddDidDN, Did
operation to be DIDPoolUpdtRemoveDidDN
performed on the DID
pool
DidDn HomeDn to be added as Str
DID pool member
Table 573 Create Branch Office Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Branch Office

OfficeCode Default office code to Str. Must be a digit
be used across the sequence of maximum
branch office length 9.
N.America: 6 digits
Japan: 5 digits
RateAreaName Default rate area to be Str
used across the branch
office.
NumberPlanNa Default name of the 1..31 Character string.
me numbering plan to be
office.
Attributes A list of the following Boolean flags: (Attributes)
IsOpenBranch Indicates whether the boolean false true false
branch office is of
“OpenBranch” type
Username Username for the 1-30 Str
administration of
OpenBranch type
branch offices.
Password Password for the 8-30 Str
administration of
OpenBranch type
branch offices.
Table 573 Create Branch Office Input Fields
11.21.2 Modify Branch Office

The modifyBranchOffice method is used to alter the data of a branch
office belonging to a BG.

page 78.
BranchOfficeNa The name of the 1-30 Character String
me branch office to be
created.
Required
NewBranchOffic The new name of the 1…30 Character String optional
eName Branch Office
Table 574 Modify Branch Office Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Branch Office

BGName The name of an Please refer to Section 5.4, “Primitive Data Definitions”, on page
existing BG in which 78.
the BO will be
included.
Required
DIDPoolUpdate Provides a means of enum DIDPoolUpdtDoNotUpdate DIDPoolUpdtDoNotUpdate
specifying the Did, Did
operation to be DIDPoolUpdtAddDidDN,
performed on the DID DIDPoolUpdtRemoveDidD
pool N
DidDn HomeDn to be added Str
as DID pool member
OfficeCode Default office code to Str. Must be a digit
be used across the sequence of maximum
branch office length 9. N.America: 6
digits Japan: 5 digits
RateAreaName Default rate area to be Str
office.
NumberPlanNa Default name of the 1..31 Character string.
me numbering plan to be
office.
IsOpenBranch Indicates whether the boolean false / true false
branch office is of
“OpenBranch” type
Username Username for the 1-30 Str
administration of
OpenBranch type
branch offices.
Password Password for the 8-30 Str
administration of
OpenBranch type
branch offices.
Table 574 Modify Branch Office Input Fields
11.21.3 Query Branch Office

The queryBranchOffice method is used to retrieve a list of branch
offices that match the filtering criteria passed on its interface.
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Branch Office

Operator ID Please refer to Section 5.4, “Primitive Str
BranchOfficeNam The name of the branch office to be 1-30 Character String
e created.
BGName The name of an existing BG in which Please refer to Section 5.4, “Primitive Data
the BO will be included. Definitions”, on page 78.
RepresentativeE The name of the endpoint that branch 1-16 Str
ndpointName office members are to be associated
with Executive Assistant group.
RepresentativeE The IP address of the endpoint that Str
ndpointIpAddres branch office members are to be
s associated with Executive Assistant
group.
RepresentativeE The Management IP address of the Str
ndpointManagem endpoint that branch office members
ent IpAddress are to be associated with Executive
Assistant group.
DIDPool.ArrayOf An Array of DidDn strings. See the following field for the definition of the
DidDn array elements.
DidDn DidDn array entry Str
OfficeCode Default office code to be used across Str. Must be a digit
the branch office sequence of
maximum length 9.
N.America: 6 digits
Japan: 5 digits
RateAreaName Default rate area to be used across the Str
branch office.
NumberPlanNam Default name of the numbering plan 1..31 Character string.
e to be used across the branch office.
IsOpenBranch Indicates whether the branch office is boolean false true
of “OpenBranch” type
Username Username for the Administration of 1-30 Str
OpenBranch type branch offices.
Password Password for the Administration of 8-30 Str
OpenBranch type branch offices.
SortOrder Defines the order by which the results enum SortOrderAscending SortOrderAscen
are sorted (by name) , ding
SortOrderDescendi
ng
Table 575 Query Branch Office Output Fields
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Remove Branch Office
11.22 Remove Branch Office

The removeBranchOffice function is used to delete a specific branch
office that belongs to the BG passed on its interface.

Operator ID Please refer to Section 5.4, “Primitive Data Definitions”, Str
on page 78.
BranchOfficeNa The name of the branch office to be 1-30 Character
me created. Required String
BGName The name of an existing BG in which Please refer to Section 5.4, “Primitive Data
the BO will be included. Definitions”, on page 78.
Required
Table 576 Remove Branch Office Input Fields
11.23 Remote Call Pickup Groups

This chapter describes the Remote Call Pickup Groups. For every Local
Call pickup group it shall be possible to create a list of Remote Pickup
groups located in HiPath 4000 and/or HiPath 8000 private SIPQ
network, i.e., a CPU Group may span across the SIPQ as long as the
groups are administered within the same BG. Remote groups may
belong to only one local group.
11.23.1 Add CPU Group

The AddCpuGroup API is used to create a new Call Pickup Group. The
following table shows the format of AddCpuGroupRequest:
Field Name Description Mandatory Type Default Value

[Range]
OperatorId I/F operator yes Char array NA [1…40]
BGName The Name of the BG where the CPU yes Char array NA [1..30]
belongs
CpuGroupId A unique Id for the Cpu Group no Integer NA [1..10000]
CpuGroup A structure containing the following data
GroupName A unique name for the CPU group. no Char array NA [1..24]
Unicode characters are supported.
NotificationDela The notification delay timer for the no Integer 0 [0..60]
yTimer CPU Group
Table 577 Add CPU Group Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Remote Call Pickup Groups

[Range]
CIDPresentatio This field controls whether the caller no Enumeration CpuGroupCIDPresenta
n ID for all calls to the CPU group tionAllowed,
members, can be presented in the CpuGroupCIDPresenta
pickup notifications. tionRestricted
Table 577 Add CPU Group Input Fields
11.23.2 Modify CPU Group

The ModifyCpuGroup API is used to modify an existing Call Pickup
Group. The following table shows the format of
ModifyCpuGroupRequest:

[Range]
belongs
CpuGroupId A unique Id for the Cpu Group no Integer NA [1..10000]
CpuGroup A structure containing the following data
GroupName A unique name for the CPU group. no Char array NA [1..24]
Unicode characters are supported.
NotificationDela The notification delay timer for the no Integer 0 [0..60]
yTimer CPU Group
CIDPresentatio This field controls whether the caller no Enumeration CpuGroupCIDPresenta
n ID for all calls to the CPU group tionAllowed,
members, can be presented in the CpuGroupCIDPresenta
pickup notifications. tionRestricted
Table 578 Modify CPU Group Input Fields
11.23.3 Add Local CPU Members

Adds members to the local call pickup group.The Output fields are
shown in the following table:

[Range]
Table 579 Add Local CPU Group Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Business Groups

[Range]
belongs
CpuGroupId The unique Id for the Cpu Group yes Integer NA [1..10000]
LocalCpuMembe A structure containing a list of LocalCpuMemberData.
rDataList
(LocalCpuMemb A structure containing the following data
erDataList)
LocalCpuMembe
rData
(LocalCpuMemb The ServiceId of the local member no Char array NA [1..30]
erData)
ServiceID
(LocalCpuMemb This field controls whether the caller no Enumeration CpuGroupCIDPresenta
erData) ID for calls to the specific member, tionAllowed,
CIDCallsToMem can be presented in the notifications CpuGroupCIDPresenta
ber to the other CPU group members. tionRestricted
Table 579 Add Local CPU Group Input Fields
11.23.4 Modify Local CPU Members

The ModifyLocalCpuMembers API is used to modify the configuration of
subscribers that are members of a Call Pickup Group. The following
table shows the format of ModifyLocalCpuMembersRequest:

[Range]
belongs
rDataList
(LocalCpuMemb structure containing the following data
erDataList)
LocalCpuMembe
rData
erData)
ServiceID
(LocalCpuMemb This field controls whether the caller no Enumeration CpuGroupCIDPresenta
erData) ID for calls to the specific member, tionAllowed,
CIDCallsToMem can be presented in the notifications CpuGroupCIDPresenta
ber to the other CPU group members. tionRestricted
Table 580 Modify Local CPU Group Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
11.23.5 Remove Local CPU Members

The RemoveLocalCpuMembers API is used to remove subscribers from
a Call Pickup Group The following table shows the format of
RemoveLocalCpuMembersRequest:

[Range]
belongs
rDataList
(LocalCpuMemb structure containing the following data
erDataList)
LocalCpuMembe
rData
erData)
ServiceID
Table 581 Remove Local CPU Group Input Fields
11.23.6 Add Remote Call Pickup Groups

The AddRemoteCpuGroups API is used to add remote cpu groups to a
local cpu group. The following table shows the format of
AddRemoteCpuGroupsRequest:

[Range]
belongs
RemoteCpuGrou A structure containing a list of RemoteCpuGroupData.
pDataList
(RemoteCpuGro A structure containing the following data
upDataList)
RemoteCpuGrou
pData
Table 582 Add Remote Call Pickup Groups Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Business Groups

[Range]
(RemoteCpuGro The Number/ID of the Remote Call yes Integer NA [1.10000]
upData) Pickup Group. This value must be
RemoteCpuGrou administered as a local CPU group in a
p remote node.
Number
(RemoteCpuGro The Destination Access Code of the yes Char array NA [1..15]
upData) Remote Call Pickup Group.
RemoteCpuGrou
p
AccessCode
(RemoteCpuGro A descriptor for the Remote Call no Char array NA [1..30]
upData) Pickup Group.
RemoteCpuGrou
p
Descriptor
(RemoteCpuGro Notification Timer for Call Pick Up no Integer 0 [0…60]
upData) Objects
RemoteCpuGrou
p
NotificationDelay
T imer
(RemoteCpuGro Indicates whether the remote call pick no Boolean false/true
upData) up group belongs to a HiPath DX
HipathDxGroup system.
Table 582 Add Remote Call Pickup Groups Input Fields
11.23.7 Modify Remote Call Pickup Groups

The ModifyRemoteCpuGroups API is used to modify the remote cpu
groups that have been provisioned for alocal cpu group. The following
table shows the format of ModifyRemoteCpuGroupsRequest:

[Range]
belongs
RemoteCpuGrou A structure containing a list of RemoteCpuGroupData.
pDataList
Table 583 Modify Remote Call Pickup Groups Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Business Groups

[Range]
upDataList)
RemoteCpuGrou
pData
upData) Pickup Group. This value must be
p remote node.
Number
upData) Remote Call Pickup Group.
RemoteCpuGrou
p
AccessCode
(RemoteCpuGro A descriptor for the Remote Call no Char array NA [1..30]
upData) Pickup Group.
RemoteCpuGrou
p
Descriptor
(RemoteCpuGro Notification Timer for Call Pick Up no Integer 0 [0…60]
upData) Objects
RemoteCpuGrou
p
NotificationDelay
T imer
(RemoteCpuGro Indicates whether the remote call pick no Boolean false/true
upData) up group belongs to a HiPath DX
HipathDxGroup system.
Table 583 Modify Remote Call Pickup Groups Input Fields
11.23.8 Remove Remote Call Pickup Groups

The RemoveRemoteCpuGroups API is used to remove remote cpu
groups that have been provisioned for alocal cpu group. The following
table shows the format of RemoveRemoteCpuGroupsRequest:

[Range]
belongs
Table 584 Remove Remote Call Pickup Groups Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Business Groups

[Range]
RemoteCpuGrou A structure containing a list of RemoteCpuGroupId.
pIdsList
upIdsList)
RemoteCpuGrou
pId
upId) Pickup Group. This value must be
p remote node.
Number
upId) Remote Call Pickup Group.
RemoteCpuGrou
p
AccessCode
Table 584 Remove Remote Call Pickup Groups Input Fields
11.23.9 Get Call Pickup Group List

The GetCpuGroupList API is used to retrieve the list of CPU groups that
are provisioned for a Business Group. The following table shows the
format of GetCpuGroupListRequest:
Field Name Description Mandatory Type Length / Range

OperatorId I/F operator Yes Char array 1..40
BGName The Business Group name. Yes Char array 1..30
CpuGroupId Allows filtering by the Call Pickup No Integer 1.10000
group Id.
CpuGroupName Allows filtering by the Call Pickup No Integer 1..24
group Name.
LocalMember Allows filtering by the ServiceId of the No Char array 1..30
Local Member
RemoteGroupNu Allows filtering by the Remote Group No Integer 1.10000
mber Number
RemoteGroupAcc Allows filtering by the Remote Group No Char array 1..15
essCode Access Code.
Table 585 Get Call Pickup Group List Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Business Groups

SortType The sorting column. No Enum SortByLcpgID/
SortByCountOfLocalM
embers/
SortByCountOfRemot
eMembers/
SortByTotalCount/
SortByCpuGroupNam
e/
SortByCpuNotificatio
nDelayTimer
SortOrder The type of sort ordering. No Enum Ascending /
Descending
Table 585 Get Call Pickup Group List Input Fields
11.23.10 Get Call Pickup Group Member List

The GetCpuGroupMemberList API is used to retrieve the list of CPU
groups that are provisioned for a Business Group along with the list of
local members and remote Call Pickup Groups. The following table
shows the format of GetCpuGroupMemberListRequest:

CpuGroupId Allows filtering by the Call Pickup No Integer 1.10000
group Id.
CpuGroupName Allows filtering by the ServiceId of the No Integer 1..24
Local Member
LocalMember Allows filtering by the Remote Group No Char array 1..30
Number
RemoteGroupNu Allows filtering by the ServiceId of the No Integer 1.10000
mber Local Member
RemoteGroupAcc Allows filtering by the Remote Group No Char array 1..15
essCode Access Code.
Table 586 Get Call Pickup Group Member Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Business Groups

SortByCountOfLocalM
embers/
SortByCountOfRemot
eMembers/
SortByTotalCount/
SortByCpuGroupNam
e/
SortByCpuNotification
DelayTimer
Descending
Table 586 Get Call Pickup Group Member Input Fields
11.23.11 Get Local CPU Members List

The GetLocalGroupMembersList API is used to retrieve the list of the
local members of a Call Pickup Group. The following table shows the
format of GetLocalCpuMemberList:

CpuGroupId The Call Pickup group Id. Yes Integer 1.10000
Descending
SortByCountOfLocalM
embers/
SortByCountOfRemot
eMembers/
SortByTotalCount/
SortByCpuGroupNam
e/
SortByCpuNotification
DelayTimer
Descending
Table 587 Get Local Call Pickup Group Member Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Community Groups
11.23.12 Get Remote CPU Members List

The GetRemoteCpuGroupList API is used to retrieve the list of
the remote groups of a Call Pickup Group. The following table
shows the format of GetRemoteCpuGroupList:

CpuGroupId The Call Pickup group Id. Yes Integer 1.10000
RemoteCpuGrou The Number/ID of the Remote Call Yes Integer 1.10000
p Pickup Group. This value must be
Number administered as a local CPU group in a
remote node.
RemoteCpuGrou The Destination Access Code of the Yes Char array 1..15
p Remote Call Pickup Group.
AccessCode
Descending
SortType The sorting column. No Enum SortByGroupNumber/
SortByGroupAccessC
ode/
SortByHiPathDXGrou
p
Table 588 Get Remote Call Pickup Group Member Input Fields
11.24 Community Groups

Community Groups are used to configure bilateral Intercom Calling
capabilities and to provide fast dialing for Intercom Calls. Any OSV
subscriber that shall originate or terminate Intercom calls, has to be
provisioned with a personal Community Group, defining the allowed
Intercom targets/origins. Each OSV subscriber can be provisioned with
no more that one community group.Table 572 lists common return
codes introduced for the branch office related methods. Other pre-
existing return codes can also be returned.
Table 589 lists common return codes introduced for the community
group related methods. Other pre-existing return codes can also be
returned.
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Community Groups

WSDL Version
subRC_APP_COM_GROUP_INVALID_PERIODIC_TONE
subRC_APP_COM_GROUP_SDAL_ERROR
subRC_APP_COM_GROUP_ALREADY_EXISTS
subRC_APP_COM_GROUP_CREATION_FAILED
subRC_APP_COM_GROUP_NOT_FOUND
subRC_APP_COM_GROUP_MODIFICATION_FAILED
subRC_APP_COM_GROUP_REMOVAL_FAILED
subRC_APP_COM_GROUP_MEMBER_INVALID_COM_NR
subRC_APP_COM_GROUP_MEMBER_INVALID_DEST_NR
subRC_APP_COM_GROUP_MEMBER_INVALID_DEST_NAME
subRC_APP_COM_GROUP_MEMBER_SDAL_ERROR
subRC_APP_COM_GROUP_MEMBER_CREATION_FAILED
subRC_APP_COM_GROUP_MEMBER_COM_NR_IN_USE
subRC_APP_COM_GROUP_MEMBER_NOT_FOUND
Table 589 Common Community Groups Return Codes
11.24.1 Add Community Group

The AddCommunityGroup function is used to create a new Community
Group and assign it to a subscriber. A subscriber may have only one
community group assigned.

d
OperatorId I/F operator Yes Char 40 (1…40) N/A
array
SubscriberDN The subscriber that the Yes
community group will
be assigned to. Please
refer to field Service Id
of Table 10 on page 80.
Table 590 Add Community Group Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Community Groups

d
PeriodicTone The interval of the No Integer 0=none 120
periodic tone in 5-180
seconds used to
indicate that an
intercom call is active.
The periodic tone
applies to all
terminating two-way
Intercom Calls.
Table 590 Add Community Group Input Fields
11.24.2 Modify Community Group

The ModifyCommunityGroup function is used to modify an existing
Community Group.

d
array
community group is
assigned to. Please
PeriodicTone The interval of the No Integer 0=none 120
periodic tone in 5-180
seconds used to
indicate that an
Table 591 Modify Community Group Input Fields
11.24.3 Remove Community Group

The RemoveCommunityGroup function is used to delete an existing
Community Group.

d
array
Table 592 Remove Community Group Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Community Groups

d
community group is
assigned to. Please
Table 592 Remove Community Group Input Fields
11.24.4 Query Community Group

The QueryCommunityGroup function is used to retrieve the information
about the community groups that belong to a business group. The
function requires that a business group is provided in order to query for
its community groups.

d
OperatorId I/F operator Yes Char 1…40 N/A
array
BgName The Business Group Yes
that the Community
Group belongs. Please
refer to Section 5.4,
“Primitive Data
Definitions”, on page 80
for a detailed
description.
SubscriberDN The subscriber that the No
community group is
assigned to. Used for
filtering for a specific
community group.
Please refer to field
Service Id of Table 10
on page 80.
SortOrder Defines the order by No enum SortOrderAscending, SortOrderAscend
which the results are SortOrderDescending ing
sorted (by name)
Paging Standard paging N/A
structure for Paged
queries.
Table 593 Query Community Group Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Community Groups

d
PaginatedInfo Standard paging Char 1…40 N/A PaginatedInfo
structure. For details, array
ComGroupList An array of ComGroupElement items, each of which contains the ComGroupList
following fields:
ComGroupElem The subscriber that the ComGroupEleme
ent.SubscriberD community group is nt.SubscriberDN
N assigned to. Please
ComGroupElem The interval of the Integer 0=none 120 ComGroupEleme
ent.PeriodicTon periodic tone in 5-180 nt.PeriodicTone
e seconds used to
indicate that an
Table 594 Query Community Group Output Fields
11.24.5 Add Community Group Member

The AddCommunityGroupMember function is used to add members to
a Community Group

d
array
community group is
assigned to. Please
COMNumber The COM# of the Yes Integer 0..99 0
community group
member is the (index)
number to be dialed
after the one-way or
two-way intercom
access code.
Table 595 Add Community Group Member Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Community Groups

d
DestinationNum The destination Yes Char 30 (0..30) N/A
ber number corresponding array
to the member of the
community group. The
destination number
must refer to a
translatable/routable
OSV destination.
DestinationNam A description to the No Char 50 (0..50) N/A
e destination number. array
IncomingBlock Indicates whether an No Boolean False, false
intercom call from this True
number is allowed or
blocked.
Table 595 Add Community Group Member Input Fields
11.24.6 Modify Community Group Member

The ModifyCommunityGroupMember function is used to modify
members in a Community Group

d
array
community group is
assigned to. Please
member of the
community group that
is modified.
NewCOMNumbe The new COM# that will Yes Integer 0..99 0
r be assigned to the
community group
member.
Table 596 Modify Community Group Member Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Community Groups

d
DestinationNum The destination Yes Char 30 (0..30) N/A
community group. The
destination number
must refer to a
translatable/routable
OSV destination.
DestinationNam A description to the No Char 50 (0..50) N/A
e destination number. array
IncomingBlock Indicates whether an No Boolean False, false
intercom call from this True
number is allowed or
blocked.
Table 596 Modify Community Group Member Input Fields
11.24.7 Remove Community Group Member

The RemoveCommunityGroupMember function is used to remove
members from a Community Group

d
array
community group is
assigned to. Please
member of the
community group to be
deleted.
Table 597 Remove Community Group Member Input Fields
11.24.8 Query Community Group Member

The QueryCommunityGroupMember function is used to retrieve the
information about the members of a community group.
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Community Groups

d
OperatorId I/F operator Yes Char 1…40 N/A
array
community group is
assigned to. Used for
filtering for a specific
community group.
Please refer to field
Service Id of Table 10
on page 80.
DestinationNum The destination No Char 30 (0..30) N/A
community group.
Allows filtering for
querying a specific
member.
sorted (by name)
SortType Defines whether the No enum COM_SortBy_ComNumbe COM_SortBy_Co
returned members will r, mNumber
be sorted by their COM_SortBy_DestNumbe
COMNumber or their r
Destination Number.
Paging Standard paging N/A
structure for Paged
queries.
Table 598 Query Community Group Member Input Fields

d
PaginatedInfo Standard paging Char 1…40 N/A PaginatedInfo
structure. For details, array
ComGroupMem An array of ComGroupMemberElement items, each of which contains the ComGroupMemb
berList following fields: erList
ComGroupMem The COM# of the Integer 0..99 N/A ComGroupMemb
berList. community group erList.
COMNumber member. COMNumber
ComGroupMem The destination Char 30 N/A ComGroupMemb
berList. number of the array (0..30) erList.
DestinationNum community group DestinationNumb
ber member. er
Table 599 Query Community Group Member Output Fields
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Broadcast Groups

d
ComGroupMem The description of the Char 50 N/A ComGroupMemb
berList. destination number. array (0..50) erList.
DestinationNam DestinationName
e
ComGroupMem Indicates whether an Boolean False, N/A ComGroupMemb
berList. intercom call from this True erList.
IncomingBlock member is allowed or IncomingBlock
blocked
Table 599 Query Community Group Member Output Fields
11.25 Broadcast Groups

Broadcast groups, are of OpenScape Voice subscribers belonging on
the same business group. Each member has a role indicating whether
it can initiate, receive (or both) a 1-way speaker broadcast call to/from
the other members of its group. A 1-way speaker broadcast call shall
be initiated by dialing the 1-way speaker broadcast feature access code
followed by the group's id. A successful broadcast call initiation
automatically opens the speakers of the phones of the other members
(with receiver role) and establishes a one-way speech stream from the
initiator towards the receivers
Table 600 lists common return codes introduced for the community
group related methods. Other pre-existing return codes can also be
returned.

WSDL Version
V8 subRC_SUCCESS
<Others>
Table 600 Broadcast Group Return Codes
11.25.1 Add Bcast Group

The AddBcastGroup function is used to create a new Broadcast Group
and assign it to a BG.
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Broadcast Groups

d
OperatorId I/F operator No Char 40 (1…40) N/A
array
BGName Business Group name. No Please refer to the definition of Business Group
Optional. Provided for BGName in Section 5.4, “Primitive name.
filtering.
BcastGroupNam Unicode characters No Char 48 chars (1..48) N/A
e encoded in UTF-8 array
format up to 48
characters
BcastGroupNum Mandatory field. Value Yes int 1-9999 N/A
ber range [1-9999]
Timer Connection Establish Yes int 2,3,4,5,6,7 3
Timer
Table 601 Add Bcast Group Input Fields
11.25.2 Modify Bcast Group

The ModifyBcastGroup function is used to modify Broadcast Group
settings including its name.

d
array
filtering.
format up to 48
characters
ber range [1-9999]
NewBcastGroup Optional. To change the No Char 48 chars (1..48) N/A
Name Bcast group name. array
Timer Connection Establish Yes int 2,3,4,5,6,7 3
Timer
Table 602 Modify Broadcast Group Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Broadcast Groups
11.25.3 Remove Bcast Group

The RemoveBcastGroup function is used to delete an existing
Broadcast group.

d
OperatorId I/F operator Char 40 (1…40) N/A
array
Optional. BGName in Section 5.4, “Primitive name.
BcastGroupNam Brpadcast Group No Char 48 chars (1..48) N/A
e Name. array
optional.
ber range [1-9999]
Table 603 Remove Broadcast Group Input Fields
11.25.4 Query Bcast Group

The QueryBcastGroup function is used to retrieve the information
about the Bcast groups that belong to a business group. The function
requires that a business group is provided in order to query for its
community groups.

d
array
filtering.
format up to 48
characters
ber range [1-9999]
MemberDn No Char
array
Paging Standard paging
structure for Paged
queries.
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Broadcast Groups

d
sorted (by name)
SortType Whether the sort will be No Char Bcast-SortBy-
by Group Number or array GroupNumber
Group Name. Bcast-SortBy-GroupName

d
ResultCode Standard Result Code
structure
PaginatedInfo Standard paging structure. For details, refer to Section 5.5, “Paging”, on PaginatedInfo
page 88.
BcastGroupList An array of BcastGroupElement items, each of which contains the BcastGroupList
following fields:
filtering.
BcastGroupNam Mandatory field. It shall No Char 48 chars (1..48) N/A
e support Unicode array
characters encoded in
UTF-8 format up to 48
characters
ber range [1-9999]
Timer Connection Establish Yes int 2,3,4,5, 6, 7 3
Timer
MemberCount Number of members in Yes int
the Bcast Group..
Table 605 Query Bcast Group Output Fields
11.25.5 Add Bcast Members

The AddBcastMembers function is used to add members to a Broadcast
Group.

d
array
Table 606 Add Bcast Members Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Broadcast Groups

d
filtering.
format up to 48
characters
ber range [1-9999]
BcastMemberLis Structure containing member data.
tData
MemberDn Bcast member DN. No Char string
array
Role Members role in the No • Initiator Initiator/Receiver
Bcast Group. • Receiver
• Initiator/Receiver
Table 606 Add Bcast Members Input Fields
11.25.6 Modify Bcast Members

The ModifyBcastMembers function is used to modify members in a
Broadcast Group.

d
array
filtering.
format up to 48
characters
ber range [1-9999]
tData
array
Table 607 Modify Bcast Members Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
Broadcast Groups

d
Table 607 Modify Bcast Members Input Fields
11.25.7 Remove Bcast Member

The Remove Bcast Members function is used to remove members from
a Broadcast Group

d
array
filtering.
format up to 48
characters
ber range [1-9999]
tData
array
Table 608 Remove Bcast Members Input Fields
11.25.8 Query Bcast Members

The QueryBcastMembers function is used to retrieve the information
about the members of a Broadcast group.

d
array
Table 609 Query Bcast Members Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
BG Suite

d
filtering.
format up to 48
characters
ber range [1-9999]
Paging Standard paging
structure for Paged
queries.
sorted (by name)
SortType Whether the sort will be No Char Bcast-SortBy-
by Group Number or array GroupNumber
Group Name. Bcast-SortBy-GroupName
Table 609 Query Bcast Members Input Fields

d
ResultCode Standard Result Code
structure
PaginatedInfo Standard paging structure. For details, refer to Section 5.5, “Paging”, on PaginatedInfo
page 88.
BcastMemberQ An array of Bcast Member Element items, each of which contains the BcastGroupList
ueryList following fields:
array
Table 610 Query Bcast Members Output Fields
11.26 BG Suite
This feature will allow configuring Business Group (BG) in Small Office
Home Office (SOHO) with an objective of easy creation, very simple
Private Number Plan (PNP) etc.
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
BG Suite
Creation of BG in SOHO will be in one or two steps with all the features
unlike Business Connect (BC) solution that is used to create large and
sophisticated Business Groups. Configuration of BG Services and BG
lines will be same as before. However, during the BG creation, DNs
can be reserved to be used by a BG so that no others can use these
DNs and avoid overlapped extension dialing. While creating a BGL only
one of the reserved DNs can be requested to be associated with the
BGL.
The BG Suite concept composes of several existing Business Group

related objects, and the new DN Reservation object, and groups them
into in one single request. This aims to simply the Business Group
Administrator task.
Reservation of HomeDNs and creation of routing entries at the time the

Business Group is created is provided as an option. For this purpose,
the CreateBGSuite supports creation of a BG and respective routing
entries even when the DNReserveEnabled is set to false. All HomeDNs
defined in this field must be unreserved and Vacant, else the operation
shall fail.
During un-reservation of a HomeDN range, a validation of the range

that is already reserved for the Business Group is performed. If the
HomeDN range is reserved for a different Business Group than the one
provided in the request the operation fails.
It should be noted that although private numbering plan field is

optional when omitted, a new private numbering plan is created with
the following convention name: NP_<<BGNAME>> with all additional
provisioning of prefix access codes, destination codes and extensions.
In case the creation of private numbering plan fails, BG Suite creation
is aborted.
11.26.1 Create BG Suite

Version WSDL
Version
21 subRC_APP_BG_BGINFO_DOES_NOT_EXIST
V5.00.01.1 subRC_APP_BG_OVERLAP_INVALID
0
Table 611 Return Code List for Create BG Suite
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
BG Suite

OperatorId Please refer to Section 5.4, “Primitive Data Definitions”, on page 80
BGName Please refer to Section 5.4, “Primitive Data Definitions”, on page 80
NumberPlan Private Number Plan. no Char array System Default
Name Refer to Section 5.4, NP
“Primitive Data PSTN –
Definitions”, on page E164NANP
80. – PNP
DEFAULT [1-31]
Display Number When a subscriber with yes numeric NA
only a private number
makes a external BG
call, the BG’s
DisplayNumber is
presented as the calling
number.
BGAccessCode Indicates the BG no Numeric string (0..9), plus NA
Access Code for the * and #.
specifig BG.
OfficeCode The digit sequence at no Numeric string (0..9) NA
the beginning of a
range of directory
numbers that
represents the office in
which these DNs are
defined.
StartCode / Starting Home Dn no Numeric string (0..9) NA
Directory
Number Start
EndCode/ Ending Home Dn no Numeric string (0..9) NA
Directory
Number End
Extension The extension that the no Numeric string (0..9) [Start/End Home DN Width
Length user will dial …12 ]
Default : Equal to the width
of Start/End Home Dn Code
Extention Prefix Prefix access codes to no Numeric string (0..9) [0…15]
Code facilitate extension
dialing
Public Network Numeric string (0..9) 9
Access Code
DNReserveEnab Reserve DN Numbers. no boolean false
led (WSDL V5.00.01.10)
Table 612 Create BG Suite Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
BG Suite
11.26.2 Configuration of the Extension

Dialing
During the Quick Add Business Group Task the administrator has the
option to provide the Public Network Access Code and the Extension
Length under the Routing Entries section. If the administrator doesn't
provide input for the Extension Length, this will be interpreted by the
SOAP server as setting an Extension Length value such that when
added to the Office Code Length, the result is equal to the length of the
full DN (Overlap=0). CreateBGSuite SOAP command configures the
extension dialling by creating Prefix Access Code(s), Destination
Code(s) and Extensions.
11.26.3 Prefix Access Codes

A Prefix Access Code is created for the digit located in the Extension
Length position within the HomeDn directory number starting counting
from the end. The digits of starting Home Dn and ending Home Dn are
extracted and compared. If they match, only one Prefix Access Code is
created. If they are not the same both values and their intermediaries
are created.
PAC configuration for all cases above is the following:
Prefix Access Code min/max length Digit Prefix Nature Of Address

position Type
Digit extracted from DN at Extension Length/ 0 Extension PNP Extension
digit position: ‘Extension Extension Length Dialing
Length’, counting from the
end
Table 613 Prefix Access Code Configuration
11.26.4 Destination Codes for Extension

dialing
For each of created Prefix Access Codes a Destination Code is created
with the following configuration:
Destination Code Nature Of Address Destination

Type
ExtensionCode (Prefix Access PNP Extension Home Extension
Code)
Table 614 Prefix Access Code Configuration
A31003-H80A0-T101-1-7618, 11/2021
Business Groups
BG Suite
11.26.5 Extensions
For each of the created Destination Codes an Extension is created. The
Extension is calculated by finding the overlap first. The overlap is the
number of digits that overlaps the extension code. It is basically the
difference of Extension Length and Extension Code (starting/ending
Home Dn). For the case where Extension Length is set to the minimum
allowed value, that is the width of the Starting/Ending Home Dn code,
(overlap =0) the first digit from Home Dn range defines the Extension
Code. Additionally, if the first digit of Starting Home Dn code is not
equal to the first digit of the Ending Home Dn code, multiple extensions
are created by combining starting digit, ending digit and all
intermediate values. For example, if Starting Dn = 2000 and Ending Dn
= 5000 the produced Extensions are the 2, 3, 4 and 5. The width of the
Extension is equal to the value of the overlap when the latter is
positive. When overlap is zero, the Extension width is one. This means
that the produced Extension Code omits always the rightmost
(Extension Length -1) digits and the maximum width can be as big as
the (DN total width -1).
The table below helps in understanding the rules of extension creation

with an example:
Country Area Code Local Office Start Dn End Dn Extension Extensions

code Code Length
4
30 210 456 1234 5678 1,2,3,4,5
(min)
30 210 456 1234 5678 5 6
30 210 456 1234 5678 6 56
30 210 456 1234 5678 11 (max) 0210456

Table 615 Extensions configuration
The overlap cannot be a negative number, thus administrator is not

allowed to define an extension length less than the width of the
Extension Code. If this is the case, SOAP automatically defines an
extension length equal to the width of the extension code, producing a
zero overlap. From Assistant side, administrator is informed about the
allowed range of values with an error message located at the Extension
Length field.
A31003-H80A0-T101-1-7618, 11/2021
soap_ext_interfaces_np.fm
Numbering Plans
Numbering Plan
12 Numbering Plans
A numbering plan refers to either a Private Numbering Plan (PNP) or
the System Default Numbering Plan (E164NANP). The SOAP requests
described in the following subsections may be used for both PNPs and
for the E164NANP, where applicable.
12.1 Numbering Plan

The NumberPlanId (optional) and NumberPlanName are the keys that
logically define all the related dialing objects and tables. The
Numbering Plan is the first object to be created for a PNP. All other
related dialing objects, such Prefix Access Code, will be assigned with
the particular NumberPlanName to be part of the PNP.
The Numbering Plan system defaults are not provisioned. A Private

Numbering Plan (PNP) must be unique for each BG, except for the
system default number plan.
This section describes parameters that are associated with the PNP
information. The Numbering Plan specifies the format, patterns, and
structure of the numbers (DN and/or Extension) used within the PNP.
A PNP is used in a private network or used by a BG in a PSTN network.
12.1.1 Create Number Plan

This method creates a Number Plan.

WSDL Version
subRC_APP_PNP_NAME_MISSING
subRC_APP_PNP_ID_OUT_OF_RANGE
subRC_APP_PNP_NAME_DUPLICATE
subRC_DB_PNP_INSERTION_FAILED
Table 616 Create Number Plan Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
Numbering Plan

NumberPlanId Numbering Plan Id. integer 2 – 999 (1 is reserved for the N/A
PNP system and is the default)
NumberPlan Name of the number plan. 1..31 Character string. N/A
Name Required and cannot be
changed.
on page 78.
NumberPlan Defines Numbering Plan type. enum NPTypePNP, NPTypePNP
Type For a PNP associated with a NPTypeE164NANP
Business Group, the only
value supported is
NPTypePNP. Therefore, it is
not necessary to be
provisioned. Read-only.
BGName Indicates the name of the Please refer to the definition of BGName in ““
Business Group that this Section 5.4, “Primitive Data Definitions”, on
Number Plan will be reserved page 78.
for.
Table 617 Create Number Plan Input Fields
12.1.2 Update Number Plan

This method is used to update the BG reservation information of the
Number Plan.
If the specified numbering plan is not reserved for a BG originally, it can

be updated to be reserved for an existing BG. If it is already reserved
for a BG, but not assigned to a BGL, it can be reserved for another
existing BG or un-reserved from the currently reserved-for BG.
If the numbering plan provided is already reserved for a BG and already

assigned to some BGL, it can not be reserved for another BG or un-
reserved from the currently reserved-for BG.
The method can also be used for updating the Name of the Number
Plan.
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
Numbering Plan

WSDL Version
subRC_APP_BG_NUMBER_PLAN_NAME_LEN_INVALID
subRC_APP_PNP_MOD_SYSTEM_DEF_NOT_ALLOWED
subRC_DB_PNP_RESERVATION_INSERTION_FAILED
subRC_DB_PNP_RESERVATION_DELETION_FAILED
subRC_APP_PNP_DOES_NOT_EXIST
subRC_APP_PNP_MODIFY_FAILURE
subRC_APP_PNP_RSS_DB_GENERAL_FAILURE
Table 618 Update Number Plan Return Codes

NumberPlan Name of the number plan. 1..31 Character string. required
Name
NewNumberPlan New Name of the number 1…31 Character string optional
Name plan.
BGName This field is optional and is Please refer to the definition of BGName in N/A
used to indicate the Name of Section 5.4, “Primitive Data Definitions”, on
the BG that this Number Plan page 78.
will be reserved for
If an empty string is passed
the NP will be unreserved
from the BG that it is
reserved.
Table 619 Update Number Plan Input Fields
12.1.3 Delete Number Plan

This method deletes a number plan with the NumberPlanName
provided. Note that a number plan cannot be deleted if there are
existing references to it, including if it is configured as the BG Common
Number Plan for any BG.
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
Numbering Plan

WSDL Version
subRC_APP_PNP_ID_OUT_OF_RANGE
subRC_APP_PNP_NAME_DUPLICATE
Table 620 Delete Number Plan Return Codes

NumberPlan Name of the number plan. 1..31 Character string. required
Name
on page 78.
Table 621 Delete Number Plan Input Fields
12.1.4 Get Number Plan List

This method retrieves the specified Numbering Plan information or a
list of all existing Number Plans.
If a Number Plan Name is specified, only the specified Number Plan is

returned if it exists. If the Number Plan Name is not specified, all the
Number Plans are retrieved.

WSDL Version
subRC_SYS_PNP_GET_ALLOC_ERR
subRC_NUMBER_PLAN_DATA_MISSING
subRC_APP_PNP_DOES_NOT_EXIST
subRC_APP_PNP_LOOKUP_FAILED
subRC_DB_PNP_LOOKUP_FAILED
Table 622 Get Number Plan List Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
Numbering Plan

NumberPlan Name of the number plan. 1..31 Character string. ““
Name
InterfaceWSDL The WSDL version of the Refer to Section 5.1.1, “The Interface N/A
request. This allows the SOAP WSDL and Interface Release Control”, on
Server to avoid returning page 73.
fields that were introduced
after the specified WSDL
version.
requests. For more
BGName The name of the Business Please refer to Section 5.4, “Primitive Data N/A
Group on which to filter. Definitions”, on page 78.
CombinedList If a BG Name is specified, Boolean True, False
CombinedList indicates False
whether the returned list
should include system wide
Numbering Plans as well as
those associated with the
specified BG.
If no BG Name is specified,
CombinedList indicates
whether the returned list
should include all BG-related
Numbering Plans as well as
the system wide Numbering
Plans.
BGCommon Indicates whether the list of Boolean True, False
BG Common Number Plans is False
to be retrieved.
If the BGCommon tag is not

passed, there shall be no
filtering on BG Common
Numbering Plan.
If the BGCommon tag is

passed, and the value is
False, only Numbering Plans
that are not BG Common
Numbering Plans will be
returned.
If the BGCommon tag is

passed, and the value is True,
only Numbering Plans that
are BG Common Numbering
Plans will be returned.
Table 623 Get Number Plan List Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
Numbering Plan
12.1.5 Get Number Plan ID Info

This method retrieves the information about Numbering Plan IDs
currently in use on the OpenScape Voice system.Table 624 lists the

WSDL Version
Table 624 Get Number Plan ID Info Return Codes

on page 78.
Table 625 Get Number Plan ID Info Input Fields

NumberOfUsed The number of Numbering integer N/A N/A
NPs Plans that have been
assigned and/or reserved on
the switch.
NumberOfCreat the total number of integer N/A N/A
edNPs Numbering Plans that have
been created on the switch.
TotalNumberPla The total number of integer N/A N/A
nID Numbering Plans the switch
can support.
NextAvailableNu The lowest available integer N/A N/A
mberPlanID Numbering Plan ID the user
can use when creating the
next NumberingPlan.
Table 626 Get Number Plan ID Info Output Fields
12.1.6 Get Extended Numbering Plan

Currently, in order to retrieve the list of Private Numbering Plans, the
following requests are made by the Assistant: GenericQuery,
GetBGInfo, GenericQuery, and GetSubscriberList. From this feature on,
a single new SOAP function will be introduced to handle the list of NPs,
unsp__GetNumberPlanListExtended. This function will return as a
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
Numbering Plan
minimum the following fields: NP name, Number of subscribers,

whether it is default for the BG, whether it is common for the BG. Also,
we need sorting and filtering on NP Name (currently sorting is not
provided) and paging of the results. RSS will provide sorting/filtering/
paging facilities plus the full result-set to SOAP.
Input Parameters for Get Extended Number Plan List

Operator ID I/F Operator Char 40 (1…40)
array
NPName Name of the Number Plan Char 31(1…31)
Array
BGName Name of the Business Group Please refer to Section 5.4, “Primitive Data
on which to filter Definitions”, on page 80.
N/A
Interface WSDL The WSDL version of the
request. This allows the SOAP
Server to avoid returning
after the specified WSDL
version.
Page Number No number of the retrieved result set Integer
Page Size No Page size of the retrieved result set Integer
NPSortingType Sorting Options for Number Enum NumberPlanSt
Plan Unassigned
NumberPlanSt
NPName,
Table 627 Get Extended Numbering Plan Input Fields
Field Name Description Type Range

NPName Name of the Number Plan Char 31(1…31)
Array
NPId Number Plan Id stored in Int

Database
NPType Indication of whether NP is Enum NPTypePNP,

private or Global (E164NANP) NPTypeE164NANP
Table 628 Get Extended Numbering Plan Input Output Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
Destination Codes

BGName Name of the Business Group
on which to filter
isDefault Indication of whether the boolean

Number Plan is default for the
BG
isCommon Indication of whether the Boolean
Number Plan is common for
the BG
subCount Number of Susbcribers int
associated with the Number
Plan
Table 628 Get Extended Numbering Plan Input Output Fields (Seite 2 von 2)
12.2 Destination Codes
12.2.1 Create Dest Code

This method is used to create an E.164 Destination Code for the PNP.
This enables the association of an E.164 Destination Code to the
appropriate destination. Each E.164 Code is uniquely defined by the
E.164 Code, the Numbering Plan Id, the Nature of Address, the
Originating Class of Service, and the Originating Rate Area.
Note, the provisioning of the CodeIndex object is overlaid on the

destination code (E164 DN code). To qualify the object being
administered as a CodeIndex, a new field is introduced,
CodeIndexName, which will differentiate the object from the E164 code
objects.
The following parameters are applicable for administering the

CodeIndex:
• Code Index Name: The symbolic name for the CodeIndex object.
• Number Plan Name: It is required to qualify the CodeIndex with the

numbering plan name;
• Nature Of Address: new value, NOA_Code_Index;
• DestType: existing rules apply, plus DT_Code_Index is allowed for

up to two levels of indirection CodeIndex mapping;
• The same rules apply to NPA, TrafficType, RateArea, ClassOfService,

Triggers, Attributes, DestinationType, and Destination as the
existing E164 codes.
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
Destination Codes
• The provisioning of the E164 code object is enhanced to allow

assigning the CodeIndex to the E164 code as a template for
extending the routing object.
• The following parameters are applicable for provisioning an E164

code with CodeIndex:
• Digit Code: E164 digit code, 1 - 15 digits. It is required for E164

code digit and mutually exclusive of codeIndexName;
• Number Plan Name: It is required to qualify the digit code with the
numbering plan name. Only a CodeIndex with the same numbering
plan may be assigned to the E164 code;
• DestType: new value, DT_Code_Index, to indicate the CodeIndex

mapping;
• Destination: the symbolic name of the CodeIndex to be used;
• Rate Area: allowed;
• Class Of Service: allowed;
• Triggers: allowed;
• Traffic Type: not allowed;
• Flags (attributes): not allowed.
Traffic Type Selection is applicable for administering both Destination

Codes and Code Indices.

WSDL Version
04.01.14 subRC_APP_COMM_OPERATOR_INVALID
subRC_APP_PNP_DEST_CODE_MISSING
subRC_APP_PNP_DEST_CODE_LEN_INVALID
subRC_APP_PNP_DEST_CODE_NATURE_ADDR_MISSING
subRC_APP_PNP_DEST_CODE_NPA_LEN_INVALID
subRC_APP_PNP_DEST_CODE_RATE_AREA_LEN_INVALID
subRC_APP_PNP_DEST_CODE_COS_LEN_INVALID
subRC_APP_PNP_DEST_CODE_NAME_LEN_INVALID
subRC_APP_PNP_DEST_CODE_TYPE_MISSING
subRC_APP_PNP_DEST_CODE_OFFICECODE_LEN_INVALID
subRC_APP_PNP_DEST_CODE_NEWCODE_LEN_INVALID
subRC_APP_PNP_DEST_CODE_NEWCODE_CODEINDEX_MUTUAL_E
XCLUSIVE
Table 629 Create Dest Code Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
Destination Codes

(DestCodeId) The symbolic name of the 1..31 Character string ““
CodeIndexName code index. It is required for
CodeIndex and mutually
exclusive of the DestCode
parameter. That is, either
Code index name or
DestCode is allowed for
administering the Destination
Code, but not both.
(DestCodeId) Name of the number plan. 1..31 Character string. required
NumberPlanName
(DestCodeId) Nature of address for this enum NOA_None, NOA_None
NatureOfAddress destination. NOA_Unknown,
NOA_Subscriber,
NOA_National,
NOA_International,
NOA_LRN_,
NOA_NoDN,
NOA_Test,
NOA_L0,
NOA_L1,
NOA_L2,
NOA_Extension,
NOA_CallingLoc,
NOA_APPServer,
NOA_NRN_CPN,
NOA_NRN_NSN
NOA_Code_Index
(DestCodeId) The rate area for this 1..15 Character string ““
RateArea destination.
(DestCodeId) The class of service for this 1..15 Character string ““
COS destination.
on page 78.
DestCodeData A structure containing the following attributes associated with a Destination Code.
(DestCodeData) Numbering Plan Area (NPA) 3 Numeric string ““
NPA code for this destination. (also see
Note that min and max descriptio
lengths for this parameter are n)
controlled by the RTP
parameters “Srx/Xdm/
DnCode/npa/minLen” and
“Srx/Xdm/DnCode/npa/
maxLen”. The default value
for both is 3.
Table 630 Create Dest Code Input Fields (Seite 1 von 3)
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
Destination Codes

(DestCodeData) The traffic type for this enum TT_None, TT_None
TrafficType destination. TT_International,
TT_InternationalZone1,
TT_Interlata,
TT_Intralata,
TT_TollFree,
TT_DA411,
TT_DAHomeNPA,
TT_DAForeignNPA,
TT_Emergency
(DestCodeData) Traffic Type selection can be Enum BasedOnTrafficType, N/A
TrafficType Selection either Traffic Type based or BasedOnLocalToll
Local Toll based
(DestCodeData) Destination Type enum DT_None, required
DestType DT_Destination,
DT_TimeOfDay,
DT_Service,
DT_HomeDN,
DT_EnumDestination,
DT_InvalidCode,
DT_Intercept,
DT_HomeExtension,
DT_HomeLocation,
DT_CallingLocation,
DT_CarrierDest,
DT_PrefixDest
DT_Code_Index,
DT_NewCode
DT_CodeProcessing
(DestCodeData) The name of the destination. 1..15 Character string ““
DestName
(DestCodeData) The office code of the Home 4..5 Numeric string ““
HomeDNOfficeCode DN for this destination. Note (also see
that min and max lengths for descriptio
this parameter are controlled n)
by the RTP parameters “Srx/
Xdm/HomeDn/digits/minLen”
and “Srx/Xdm/HomeDn/
digits/maxLen”. The default
values are 4 and 5
respectively.
(DestCodeData) A structure containing the following list of Boolean attributes to provide further data
Flags about the destination code. Applicable only for system default numbering plan
(E164NANP).
(DestCodeData.Flag Indicates whether an boolean true, false false
s) operator prefix is allowed for
OperPrefixNotAllowe the specified destination
d code.
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
Destination Codes

(DestCodeData.Flag Indicates whether a national boolean true, false false
s) prefix is allowed for the
NationalPrefixNotAll specified destination code.
owed
(DestCodeData.Flag Indicates whether a national boolean true, false false

s) prefix is required for the
NationalPrefixRequir specified destination code.
ed
(DestCodeData.Flag Indicates whether a boolean true, false false

s) Customer Access Code (CAC)
CACNotAllowed is allowed for the specified
destination code.
(DestCodeData.Flag Indicates whether a IN trigger boolean true, false false
s) processing is required for the
INTrigProcRequired specified destination code.
(DestCodeData) A DN to be used in support of 1..30 Character String ““

NewCode the “new code” translation
and routing capability. Calls
to this destination are
retranslated using the
number in this field based on
the calling party’s rate area.
Only allowed (and required) if
DestType is NewCode. May
contain the characters 0-9, A-
E, * and #.
(DestCodeData) A country code for the 1..4 Character String ““
CountryCode destination.
12.2.2 Modify Dest Code Info

This method is used to change the Destination Code information. Only
the NPA, the Destination Name, Destination Type, the TrafficType, and/
or the Home DN Office Code can be updated when changing the
Destination Code information.
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
Destination Codes

WSDL Version
subRC_APP_PNP_DEST_CODE_MISSING
subRC_APP_PNP_DEST_CODE_NPA_LEN_INVALID
subRC_APP_PNP_DEST_CODE_TYPE_MISSING
subRC_INT_COMM_XDM_INTERNAL_ERROR
subRC_APP_PNP_DEST_CODE_NEWCODE_LEN_INVALID
subRC_APP_PNP_DEST_CODE_NEWCODE_CODEINDEX_MUTUAL_E
XCLUSIVE
Table 631 Modify Dest Code Info Return Codes

DestCodeId A structure that uniquely identifies a Destination Code by the attributes below.
(DestCodeId) The numeric code of the 1..15 Numeric string required
DestCode destination. Note that min (also see
and max lengths for this descriptio
parameter are controlled by n)
the RTP parameters “Srx/
Xdm/DnCode/digits/minLen”
and “Srx/Xdm/DnCode/
values are 1 and 15
respectively.
(DestCodeId) For Code Index entries, the 1..31 Character string ““
CodeIndexName symbolic name of the code
index.
NumberPlanNa
me
Table 632 Modify Dest Code Info Input Fields (Seite 1 von 3)
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
Destination Codes

(DestCodeId) Nature of address for this enum NOA_None, required
NatureOfAddres destination. NOA_Unknown,
s NOA_Subscriber,
NOA_National,
NOA_International,
NOA_LRN_,
NOA_NoDN,
NOA_Test,
NOA_L0,
NOA_L1,
NOA_L2,
NOA_Extension,
NOA_CallingLoc
NOA_APPServer,
NOA_NRN_CPN,
NOA_NRN_NSN,
NOA_Code_Index
COS destination.
on page 78.
DestCodeData A structure containing the following attributes associated with a Destination Code.
(DestCodeData) Numbering Plan Area (NPA) 3 Numeric string ““
NPA code for this destination. (also see
Note that min and max descriptio
lengths for this parameter are n)
controlled by the RTP
parameters “Srx/Xdm/
DnCode/npa/minLen” and
“Srx/Xdm/DnCode/npa/
maxLen”. The default value
for both is 3.
(DestCodeData) The traffic type for this enum TT_None, TT_None
TrafficType destination. TT_International,
TT_InternationalZone1,
TT_Interlata,
TT_Intralata,
TT_TollFree,
TT_DA411,
TT_DAHomeNPA,
TT_DAForeignNPA,
TT_Emergency
TrafficType Traffic Type selection can be Enum BasedOnTrafficType, N/A
Selection either Traffic Type based or BasedOnLocalToll
Local Toll based
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
Destination Codes

(DestCodeData) Destination Type enum DT_None, required
DestType DT_Destination,
DT_TimeOfDay,
DT_Service,
DT_HomeDN,
DT_EnumDestination,
DT_InvalidCode,
DT_Intercept,
DT_HomeExtension,
DT_HomeLocation,
DT_CallingLocation,
DT_CarrierDest,
DT_PrefixDest
DT_Code_Index,
DT_NewCode
DT_CodeProcessing
(DestCodeData) The name of the destination. 1..15 Character string ““
DestName
(DestCodeData) The office code of the Home 4..5 Numeric string ““
HomeDNOfficeC DN for this destination. Note (also see
ode that min and max lengths for descriptio
this parameter are controlled n)
by the RTP parameters “Srx/
Xdm/HomeDn/digits/minLen”
and “Srx/Xdm/HomeDn/
values are 4 and 5
respectively.
(DestCodeData) A DN to be used in support of 1..30 Character String N/A
NewCode the “new code” translation
and routing capability. Calls
to this destination are
retranslated using the
number in this field based on
the calling party’s rate area.
Only allowed (and required) if
DestType is NewCode. May
contain the characters 0-9, A-
E, * and #.
12.2.3 Delete Dest Code

This method deletes the specified Destination Code.
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
Destination Codes

WSDL Version
Table 633 Delete Dest Code Return Codes

DestCodeId A structure that uniquely identifies a Destination Code by the attributes below.
(DestCodeId) The numeric code of the 1..15 Numeric string required
DestCode destination. Note that min (also see
and max lengths for this descriptio
parameter are controlled by n)
the RTP parameters “Srx/
Xdm/DnCode/digits/minLen”
and “Srx/Xdm/DnCode/
values are 1 and 15
respectively.
(DestCodeId) For Code Index entries, the 1..31 Character string ““
CodeIndexName symbolic name of the code
index.
NumberPlanNa
me
(DestCodeId) Nature of address for this enum NOA_None, required
NatureOfAddres destination. NOA_Unknown,
s NOA_Subscriber,
NOA_National,
NOA_International,
NOA_LRN_,
NOA_NoDN,
NOA_Test,
NOA_L0,
NOA_L1,
NOA_L2,
NOA_Extension,
NOA_CallingLoc
NOA_APPServer,
NOA_NRN_CPN,
NOA_NRN_NSN,
NOA_Code_Index
Table 634 Delete Dest Code Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
Destination Codes

COS destination.
on page 78.
Table 634 Delete Dest Code Input Fields (Seite 2 von 2)
12.2.4 Get Dest Code List

This method is used to retrieve a specified Destination Code or a list of
Destination Codes. The following filters can be specified:
• Number Plan Name
• Nature Of Address
• Originating Rate Area
• Originating Class Of Service
• Destination Name
• Destination Type
When filters are provided, all the Destination Codes that belong to the
specified filter are retrieved. If a Destination Code is specified, all the
Destination Codes are retrieved. Entering a filter is available with this
option. If a Destination Code is specified with a wild card, all the
Destination Codes that start with the specified Destination Code digits
are retrieved. Entering a filter is available with this option. If neither
the Destination Code nor a filter is specified, all the Destination Codes
are retrieved.
If max Destination Codes is specified, all the Destination Codes are

retrieved up to the maximum number of Destination Codes specified.
If the max Destination Code is not specified, the maximum number of
Destination Codes retrieved is 100.
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
Destination Codes

WSDL Version
subRC_APP_PNP_DEST_CODE_EXIST
subRC_APP_PNP_DEST_CODE_DOES_NOT_EXIST
subRC_SYS_PNP_DEST_CODE_ALLOC_ERROR
subRC_APP_PNP_DEST_CODE_NUM_OUT_OF_RANGE
subRC_SYS_PNP_DEST_CODE_ALLOC_ERROR
Table 635 Get Dest Code List Return Codes

DestCode The numeric code of the 1..15 Numeric string N/A
destination to display.
NumberPlanNa Name of the number plan to 1..31 Character string. N/A
me filter on.
NatureOfAddres Nature of address to filter on. enum NOA_None, N/A
s NOA_Unknown,
NOA_Subscriber,
NOA_National,
NOA_International,
NOA_LRN_,
NOA_NoDN,
NOA_Test,
NOA_L0,
NOA_L1,
NOA_L2,
NOA_Extension,
NOA_CallingLoc,
NOA_APPServer,
NOA_NRN_CPN,
NOA_NRN_NSN,
NOA_Code_Index
RateArea The rate area to filter on. 1..15 Character string N/A
COS The class of service to filter 1..15 Character string N/A
on.
MaxDestCodes The maximum number of integer 1..100 N/A
entries to display in the result
list.
requests. For more
Table 636 Get Dest Code List Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
Destination Codes
12.2.5 Get Dest Code

This method retrieves and displays the specified Destination Code.

WSDL Version
Table 637 Delete Dest Code Return Codes

DestCode The numeric code of the 1..15 Numeric string required
destination.
NumberPlanNa Name of the number plan. 1..31 Character string. required
me
NatureOfAddres Nature of address for this enum NOA_None, N/A
s destination. NOA_Unknown,
NOA_Subscriber,
NOA_National,
NOA_International,
NOA_LRN_,
NOA_NoDN,
NOA_Test,
NOA_L0,
NOA_L1,
NOA_L2,
NOA_Extension,
NOA_CallingLoc,
NOA_APPServer,
NOA_NRN_CPN,
NOA_NRN_NSN,
NOA_Code_Index
RateArea The rate area for this 1..15 Character string ““
destination.
COS The class of service for this 1..15 Character string ““
destination.
InterfaceWSDL The WSDL version of the Refer to Section 5.1, “Interface (WSDL) N/A
request. This allows the SOAP Versions”, on page 73.
Server to avoid returning
after the
specified WSDL version.
Table 638 Delete Dest Code Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
Prefix Access Code
12.2.6 Get Dest Service List

This method retrieves a list of service destinations.

WSDL Version
subRC_SYS_PNP_DEST_SERVICE_PAC_ALLOC_ERROR
subRC_DB_PNP_DEST_SERVICE_LOOKUP_FAILED
Table 639 Get Dest Service List Return Codes

Table 640 Get Dest Service List Input Field Descriptions
The output is a list of destination service entries, identified by name

and type.
12.3 Prefix Access Code

Prefix Access Codes define the dialing sequence of a dialing and
number plan; it is used for E.164 and PNP. This table is used to
translate prefix codes, feature access codes, speed codes, other access
codes, and determines the nature of address (NOA). The numberPlanId
defines the prefix access codes for each numbering plan logically.
12.3.1 Create Prefix Access Code

This method creates a Prefix Access Code. The Digits, DNMinLen and
DNMaxLen must identify a unique Prefix Access Code within the
specified numbering plan. The remaining parameters represent
additional attributes of the Prefix Access Code to be created.
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
Prefix Access Code

WSDL Version
subRC_APP_PNP_PAC_DIGITS_LEN_INVALID
subRC_APP_PNP_PAC_DIGITS_INVALID
subRC_APP_PNP_PAC_PREFIXTYPE_MISSING
subRC_APP_PNP_PAC_NOA_MISSING
subRC_APP_PNP_PAC_DEST_TYPE_PAC_DEST_INVALID
subRC_APP_PNP_PAC_DEST_TYPE_PAC_SERVICE_INVALID
subRC_APP_PNP_PAC_DEST_TYPE_PAC_INVALIDCODE_INVALID
subRC_APP_PNP_PAC_OPERATION_INVALID
subRC_APP_PNP_PAC_OPERATION_FAILED
Table 641 Create Prefix Access Code Return Codes

me
Digits Prefix and access code. Tuple 1..15 Numeric string (0..9), plus * required
<digits, dnMinLen, and #. (also see description)
dnMaxLen> is the unique key
to the table.
For the ETSI market, the
digits string value allows for
alphabetical characters from
A to E as there is a
requirement for supporting
Hex digits. Thus, Hex digits
apply only where the market
variant is ETSI.
DnMinLen The minimum length of the integer 0..30 0
digits used for digit matching.
DnMaxLen The maximum length of the 30 Numeric string. 0
If the DnMinLen is 0,
DnMaxLen must be 0 also. If
the <digits> are the same for
the different entries, the
<dnMinLen, dnMaxLen>
must not overlap. The
<digits> with dnMinLen/
dnMaxLen has priority the
same <digits> without
DnMinLen/DnMaxLen when
checking for a match.
Table 642 Create Prefix Access Code Input Fields (Seite 1 von 5)
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
Prefix Access Code

on page 78.
PrefixType Indicates the type of prefix enum PAC_Operator0Plus, required
and access code. For PNP, the PAC_Operator0,
valid values are: PAC_Operator00,
• OPTR0PLUS(1) PAC_OperatorIntl,
• OPTR0(2) PAC_FGD,
• OPTR00(3) PAC_IDDD,
• INTLOPTR(4) PAC_DDD,
• IDDD(5) PAC_NoPrefix,
• DDD(6) PAC_VerticalSvcCode,
• NP(7) – Default PNP plan PAC_SpeedCode,
only. Not provisioned for PAC_CarrierCode,
customer-defined PNP. PAC_InvalidCode_,
• FGD(8) PAC_Extension,
• VSC(9) PAC_OffNetAc,
• SC(10) PAC_OnNetAc,
• CAC(11) – Can be an PAC_FacilityAc,
integral part of the called PAC_AttendantAc,
party number for non- PAC_HomeCarrierCode
North American Numbering PAC_HomeNRN,
Plan. PAC_PreventINTriggering
• INVALIDCODE(17)
• EXT(18) – For extension
dialing, it applies to PNPs
only. For system default
PNP, the destId and
destType do not apply. For
customer-defined PNP
(planId 2-999), destType is
optional; only allowed
value is E164DEST.
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
Prefix Access Code

PrefixType • OFFNETAC(19) – public
cont. access code for PSTN
outgoing calls. Applies to
PNP only. For system
default PNP, destId and
(planId 2-999), destId and
destType are optional; only
allowed value is E164DEST.
• ONNETAC(20) – access
code for on-net calls;
applies to PNPs only. The
destId and destType are
not applicable.
• FACILITYAC(21) – private
facility access code;
applies to PNPs only.
destType must be DEST;
destId must refer to a
destination in the
e164_dest_t table.
• ATTDNTAC(22 – attendant
access code; applies to
PNPs only. For the system
default PNP, the destId and
destType are not
applicable. For customer
defined PNP (planId 2-
999), the destId and
destType is optional and
the only allowed value is
E164DEST.
• HomeCarrierCode (23) —
Indicates that the CAC of a
particular call belongs to
the owner of the switch.
Release 9 only.
DigitPos Indicates the number of integer 0
leading digits to be stripped
from the destination DN
before translating the
resulting DN. If digitPos = 0,
the prefix digits are not
dropped from the called
number.
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
Prefix Access Code

CACLength Indicates the length of the integer 0
Carrier Access Code (CAC)
after the digit position. In the
case of a CAC prefix type, it is
allowed values between 0 and
6 and has a default value of 0.
This is an optional field for
non-CAC Prefix Type and
mandatory for CAC Prefix
Type. R9 only.
DigitsInsert Inserted after the digitPos. 1..15 Numeric string ““
TrailingDigit Indicates the position at integer Unsigned integer of range 1..30 31
Pos which to delete extraneous
trailing digits.
noa Indicates the Nature of enum PAC_Unknown, required
Address of the DN resulting PAC_Subscriber,
from the digit editing. The PAC_National,
digit editing is based on the PAC_International,
digitPos, digitsInsert, and PAC_PrefixBased,
trailingDigitPos. For PNP, the PAC_NoDn,
valid values are: PAC_L0,
UNKNOWN(0), SUBS(1), PAC_L1,
NATL(2), INTL(3), PAC_L2,
PRFXBASED(6), NODN(7), PAC_NoaExtension,
L0(21), L1(22), L2(23), PAC_PrefixBasedNoTNS
EXT(24),
PRFXBASEDNOTNS(25)
• L0 – the number of PNP
Level 0 (Subscriber)
number.
Level 1 (National) number.
Level 2 (International)
number.
EXT – the number of an
extension; applies to PNP
only. The prefixType EXT
along with dnMinLen and
dnMaxLen should determine
an EXT number.
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
Prefix Access Code

destType Valid values are: enum PAC_Undefined, N/A
• PAC_Dest – the call is PAC_Dest,
routed PAC_Service,
to an outgoing destination. PAC_InvalidCode,
Applicable only if the PAC_E164Dest,
prefixType is PAC_BGCommonDestPAC_Loca
FACILITYAC(21). lToll
• PAC_Service – Applicable
only
if the prefixType is VSC(9) or
SC(10).
• PAC_InvalidCode –
Applicable
only if the prefixType is
INVALIDCODE(17).
• PAC_E164Dest – the
destination is determined by
translation in the E.164 plan
or
the system default PNP.
E164DEST is applicable only
to the customer-defined PNP,
plan Id (2-999). The noa
must
be UNKNOWN(0).
• PAC_BGCommonDest -
directs the translation to
“jump”
to the BG Common
Numbering
Plan for further translation.
Only the BG Numbering Plan
is
allowed to escape to the BG
Common Numbering Plan,
i.e.
this Destination Type is not
applicable to non-BG
Numbering Plans
• PAC_LocalToll -
12.3.2 Modify Prefix Access Code

This method modifies the specified prefix access code.
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
Prefix Access Code

WSDL Version
subRC_APP_PNP_PAC_PREFIXTYPE_MISSING
subRC_APP_PNP_PAC_NOA_MISSING
subRC_APP_PNP_PAC_DEST_TYPE_PAC_DEST_INVALID
subRC_APP_PNP_PAC_DEST_TYPE_PAC_SERVICE_INVALID
subRC_APP_PNP_PAC_DEST_TYPE_PAC_INVALIDCODE_INVALID
subRC_APP_PNP_PAC_OPERATION_INVALID
subRC_APP_PNP_PAC_OPERATION_FAILED
Table 643 Modify Prefix Access Code Return Codes

me
to the table.
variant is ETSI.
Table 644 Modify Prefix Access Code Input Fields (Seite 1 von 5)
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
Prefix Access Code

on page 78.
PrefixType Indicates the type of enum PAC_Operator0Plus, N/A
prefix and access code. PAC_Operator0,
For PNP, the valid values PAC_Operator00,
are: PAC_OperatorIntl,
• OPTR0PLUS(1) PAC_FGD,
• OPTR0(2) PAC_IDDD,
• OPTR00(3) PAC_DDD,
• INTLOPTR(4) PAC_NoPrefix,
• IDDD(5) PAC_VerticalSvcCode,
• DDD(6) PAC_SpeedCode,
• NP(7) – Default PNP plan PAC_CarrierCode,
only. Not provisioned for PAC_InvalidCode_,
customer-defined PNP. PAC_Extension,
• FGD(8) PAC_OffNetAc,
• VSC(9) PAC_OnNetAc,
• SC(10) PAC_FacilityAc,
• CAC(11) – Can be an PAC_AttendantAc,
integral part of the called PAC_HomeCarrierCode,
party number for non- PAC_HomeNRN,
North American Numbering PAC_PreventINTriggering
Plan.
• INVALIDCODE(17)
• EXT(18) – For extension
dialing, it applies to PNPs
only. For system default
PNP, the destId and
(planId 2-999), destType is
optional; only allowed
value is E164DEST.
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
Prefix Access Code

PrefixType • OFFNETAC(19) – public
cont. access code for PSTN
outgoing calls. Applies to
PNP only. For system
default PNP, destId and
(planId 2-999), destId and
destType are optional; only
allowed value is E164DEST.
• ONNETAC(20) – access
code for on-net calls;
applies to PNPs only. The
destId and destType are
not applicable.
• FACILITYAC(21) – private
facility access code;
applies to PNPs only.
destType must be DEST;
destId must refer to a
destination in the
e164_dest_t table.
• ATTDNTAC(22 – attendant
access code; applies to
PNPs only. For the system
default PNP, the destId and
destType are not
applicable. For customer
defined PNP (planId 2-
999), the destId and
destType is optional and
the only allowed value is
E164DEST.
• HomeCarrierCode (23) —
Indicates that the CAC of a
particular call belongs to
the owner of the switch.
Release 9 only.
DigitPos Indicates the number of integer N/A
leading digits to be stripped
from the destination DN
before translating the
resulting DN. If digitPos = 0,
the prefix digits are not
dropped from the called
number. Optional.
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
Prefix Access Code

CACLength Indicates the length of the integer N/A
Carrier Access Code (CAC)
after the digit position. In the
case of a CAC prefix type, it is
allowed values between 0 and
6 and has a default value of 0.
This is an optional field for
non-CAC Prefix Type and
mandatory for CAC Prefix
Type. R9 only.
DigitsInsert Inserted after the digitPos. 1..15 Numeric string N/A
TrailingDigit Indicates the position at integer Unsigned integer of range 1.. N/A
Pos which to delete extraneous 31
trailing digits. Optional.
noa Indicates the Nature of enum PAC_Unknown, N/A
Address of the DN resulting PAC_Subscriber,
from the digit editing. The PAC_National,
digit editing is based on the PAC_International,
digitPos, digitsInsert, and PAC_PrefixBased,
trailingDigitPos. For PNP, the PAC_NoDn,
valid values are: PAC_L0,
UNKNOWN(0), SUBS(1), PAC_L1,
NATL(2), INTL(3), PAC_L2,
PRFXBASED(6), NODN(7), PAC_NoaExtension,
L0(21), L1(22), L2(23), PAC_PrefixBasedNoTNS
EXT(24),
PRFXBASEDNOTNS(25)
Level 0 (Subscriber)
number.
Level 1 (National) number.
Level 2 (International)
number.
EXT – the number of an
extension; applies to PNP
only. The prefixType EXT
along with dnMinLen and
dnMaxLen should determine
an EXT number. Required.
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
Prefix Access Code

destType Valid values are: enum PAC_Undefined, N/A
• PAC_Dest – the call is PAC_Dest,
routed PAC_Service,
to an outgoing destination. PAC_InvalidCode,
Applicable only if the PAC_E164Dest,
prefixType is PAC_BGCommonDestPAC_Loca
FACILITYAC(21). lToll
• PAC_Service – Applicable
only
if the prefixType is VSC(9) or
SC(10).
• PAC_InvalidCode –
Applicable
only if the prefixType is
INVALIDCODE(17).
• PAC_E164Dest – the
destination is determined by
translation in the E.164 plan
or
the system default PNP.
E164DEST is applicable only
to the customer-defined PNP,
plan Id (2-999). The noa
must
be UNKNOWN(0).
• PAC_BGCommonDest -
directs the translation to
“jump”
to the BG Common
Numbering
Plan for further translation.
Only the BG Numbering Plan
is
allowed to escape to the BG
Common Numbering Plan,
i.e.
this Destination Type is not
applicable to non-BG
Numbering Plans
• PAC_LocalToll -
destName Indicates the name of the 1..15 Character string N/A
destination.
12.3.3 Delete Prefix Access Code

This method deletes the specified Prefix Access Code.
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
Prefix Access Code

WSDL Version
subRC_APP_PNP_PAC_DELETION_FAILED
Table 645 Delete Prefix Access Code Return Codes

me
to the table.
variant is ETSI.
on page 78.
Table 646 Delete Prefix Access Code Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
Prefix Access Code
12.3.4 Get Prefix Access Code List

This method retrieves all Prefix Access Codes on the system. It h as
enhanced sorting capabilities based on Code and filtering by all the
fields of unsp__PrefixAccessCodeEntry. The Result List accommodates
the Nature of Address.

WSDL Version
subRC_SYS_PNP_PAC_ALLOC_ERROR
subRC_APP_PNP_PAC_XDM_LOOKUP_FAILED
Table 647 Get Prefix Access Code List Return Codes

me
requests. For more
SortType Sorting options criteria for Enum SortByUnassigned = -1, N/A
Prefix Access Codes SortByCode = 1
SortOrder Determines the way the Enum SortOrderAscending - SortOrderAsce
Objects are sorted. Objects aresorted in nding
ascending order.
SortOrderDescending -
Objects aresorted in
descending order.
Prefix Access Code Entry Structure
Table 648 Get Prefix Access Code List Input Fields (Seite 1 von 3)
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
Prefix Access Code

Digits Prefix and access code. Tuple Please refer to the definition of Digits in Section
<digits, dnMinLen, 12.3.1, “Create Prefix Access Code”, on page
dnMaxLen> is the unique key 483
to the table.
alphabetical characters
from A to E as there is a
Hex digits. Thus, Hex Digits
variant is ETSI.
DnMinLen The minimum length of the Please refer to the definition of DnMinLen in
digits Section 12.3.1, “Create Prefix Access Code”, on
used for digit matching. page 483
DnMaxLen The maximum length of the Please refer to the definition of DnMaxLen in
digits Section 12.3.1, “Create Prefix Access Code”, on
used for digit matching. If the page 483
DnMinLen
is 0, DnMaxLen must be 0
also. If the <digits> are the
same for the different
entries, the <dnMinLen,
dnMaxLen> must not
overlap. The <digits> with
dnMinLen/dnMaxLen has
priority the same <digits>
without DnMinLen/
DnMaxLen when checking
for a match.
PrefixType Indicates the type of prefix Please refer to the definition of PrefixType in
and Section 12.3.1, “Create Prefix Access Code”, on
access code.
Dest Type Indicates the type of Enum PAC_Undefined,
Destination for the prefix PAC_Dest,
access code PAC_Service,
PAC_InvalidCode,
PAC_E164Dest,
PAC_BGCommonDest,
PAC_LocalToll,
Name of Destination char 1…68
DestName
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
Prefix Access Code

Natureofaddress Nature of Address for the Enum PAC_Unassigned = -1,
Destination of Prefix Access PAC_Unknown,
Code PAC_Subscriber,
PAC_National, PAC_International,
PAC_PrefixBased,
PAC_NoDn,
PAC_L0,
PAC_L1,
PAC_L2, PAC_NoaExtension,
PAC_PrefixBasedNoTNS, PAC_NRN_CPN

PrefixAccessCodeList, a list of elements of type PrefixAccessCodeEntry, each of which contains the
following attributes, uniquely identifying a prefix access code:
Digits Prefix and access code. Tuple Please refer to the definition of Digits in NA
<digits, dnMinLen, Section 12.3.1, “Create Prefix Access
dnMaxLen> is the unique key Code”, on page 600
to the table.
alphabetical characters
from A to E as there is a
apply only where the
market variant is ETSI.
DnMinLen The minimum length of the Please refer to the definition of DnMinLen in 0
digits used for digit matching. Section 12.3.1, “Create Prefix Access
Code”, on page 600
DnMaxLen The maximum length of the Please refer to the definition of DnMaxLen 0
digits used for digit matching. in Section 12.3.1, “Create Prefix Access
If the DnMinLen Code”, on page 600
is 0, DnMaxLen must be 0
also. If the <digits> are the
same for the different
entries, the <dnMinLen,
dnMaxLen> must not
overlap. The <digits> with
dnMinLen/dnMaxLen has
priority the same <digits>
without DnMinLen/
DnMaxLen when checking
for a match.
PrefixType Indicates the type of prefix Please refer to the definition of PrefixType required
and access code. in Section 12.3.1, “Create Prefix Access
Code”, on page 600
Table 649 Get Prefix Access Code List Output Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
Prefix Access Code

Natureofaddress Nature of Address for the Enum PAC_Unassigned = -1,
Destination of Prefix Access PAC_Unknown,
Code PAC_Subscriber,
PAC_National, PAC_International,
PAC_PrefixBased,
PAC_NoDn,
PAC_L0,
PAC_L1,
PAC_L2, PAC_NoaExtension,
PAC_PrefixBasedNoTNS, PAC_NRN_CPN
Table 649 Get Prefix Access Code List Output Fields (Seite 2 von 2)
12.3.5 Get Prefix Access Code One

This method retrieves an individual Prefix Access Code.

WSDL Version
subRC_DB_PNP_PAC_LOOKUP_FAILED
Table 650 Get Prefix Access Code One Return Codes

to the table.
variant is ETSI.
me
Table 651 Get Prefix Access Code One Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
Private Numbering Plan Location Codes

DnMinLen The minimum length of the 30 Numeric string. 0
Optional.
Table 651 Get Prefix Access Code One Input Fields (Seite 2 von 2)
12.4 Private Numbering Plan Location Codes

The PNP location defines the location part of the PNP. Note that these
requests apply only to private numbering plans, not the public system
default numbering plan.
12.4.1 Create PNP Location Code

This method creates a PNP Location Code.

WSDL Version
subRC_APP_PNP_LOC_CODE_LEN_INVALID
subRC_APP_PNP_LOC_CODE_INVALID
subRC_APP_PNP_LOC_CODE_LOCL0LEN_INVALID
subRC_APP_PNP_LOC_CODE_MODIFY_ERROR
subRC_APP_PNP_LOC_CODE_OPERATION_INVALID
subRC_APP_PNP_LOC_CODE_OPERATION_FAILED
Table 652 Create Pnp Location Code Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans

locCode Consists of L2, L1, and L0 1..14 Numeric string. required
codes. The user interfaces will
have the user enter the level
codes in separate digit strings
that the SOAP Server will
concatenate into one digit
string and derive the
locL0Len, locL1Len, and
locL2Len.
• L1 and L2 are optional.
• L1 cannot be administered
without L0.
without L1.
me
on page 78.
locL0Len L0 code length. integer 1..4 1
locSkipDigits Indicates the number of integer 0
leading digits in the location
code to skip when converting
the fully qualified PNP
Table 653 Create Pnp Location Code Input Fields
12.4.2 Modify PNP Location Code

This method modifies the specified PNP Location Code.

WSDL Version
subRC_APP_PNP_LOC_CODE_LOCL0LEN_INVALID
subRC_APP_PNP_LOC_CODE_MODIFY_ERROR
subRC_APP_PNP_LOC_CODE_OPERATION_INVALID
subRC_APP_PNP_LOC_CODE_OPERATION_FAILED
Table 654 Modify Pnp Location Code Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans

locL2Len.
without L0.
without L1.
me
on page 78.
locSkipDigits Indicates the number of integer 0
leading digits in the location
code to skip when converting
the fully qualified PNP
Table 655 Modify Pnp Location Code Input Fields
12.4.3 Delete PNP Location Code

This method deletes the specified PNP Location Code.

WSDL Version
subRC_APP_PNP_LOC_CODE_DELETION_FAILED
Table 656 Delete Pnp Location Code Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans

locL2Len.
without L0.
without L1.
me
on page 78.
Table 657 Delete Pnp Location Code Input Fields
12.4.4 Get PNP Location Code List

This method retrieves a list of all PNP location codes on the switch.

WSDL Version
subRC_SYS_PNP_LOC_CODE_ALLOC_ERROR
subRC_APP_PNP_LOC_CODE_NOT_EXIST
subRC_DB_PNP_LOC_CODE_LOOKUP_FAILED
subRC_APP_PNP_LOC_CODE_NOT_EXIST
Table 658 Get PNP Location Code List Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
PNP Extension

locCode Consists of L2, L1, and L0 1..14 Numeric string. ““
locL2Len.
without L0.
without L1.
me
Table 659 Get PnP Location Code List Input Fields
12.5 PNP Extension

The PNP Extension defines the extension part of the Private Numbering
Plan. Note that these requests apply only to private numbering plans,
not the public system default numbering plan.
12.5.1 Create PNP Extension

This method creates a PNP Extension.

WSDL Version
subRC_APP_PNP_EXT_CODE_LEN_INVALID
subRC_APP_PNP_EXT_CODE_INVALID
subRC_APP_PNP_EXT_CODE_TYPE_MISSING
subRC_APP_PNP_EXT_CODE_TYPE_INVALID
Table 660 Create Pnp Extension Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
PNP Extension

extPrefix Represents a range of integer 0..9 required
extension numbers or a single
extension number with the
extPrfx as the leading digits.
The length of extPrfx must
not be greater than extLen.
Must be unique within the
numbering plan.
me
on page 78.
extLen Extension number length. integer 1..7 required
locCode Consists of L2, L1, and L0 1..14 Numeric string. 0
locL2Len.
without L0.
without L1.
e164Prefix Represents the E.164 DN 1..15 Numeric string ““
(national number) assigned
to the range of extension
numbers. This is to be
provisioned if the extension
numbers of the range have
E.164 DNs assigned. It must
be unique within the table.
e164OfficeCode Unused.
destType Type of destination enum PnpExt_HomeDn required
designated by the destId. The
only valid value is Note that the following
HOMEDN(12). The destId additional values are defined
must be an officeCodeId in but not currently supported:
the e164_office_code_t table.
The e164Prfx must contain PnpExt_EndPoint,
the officeCode as the leading PnpExt_Line,
substring. When e164Pfx is PnpExt_Service,
entered, the destType must PnpExt_Vacant,
be HOMEDN and the destId is PnpExt_Intercept
to be the e164officeCodeId.
Table 661 Create Pnp Extension Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
PNP Extension

destName Indicates the name of the 1..15 Character string. ““
destination.
Table 661 Create Pnp Extension Input Fields (Seite 2 von 2)
12.5.2 Modify PNP Extension

This method modifies an existing PNP Extension.

WSDL Version
subRC_APP_PNP_EXT_CODE_TYPE_MISSING
subRC_APP_PNP_EXT_CODE_TYPE_INVALID
subRC_APP_PNP_EXT_CODE_MODIFY_ERROR
Table 662 Modify Pnp Extension Return Codes

numbering plan.
me
on page 78.
extLen Extension number length. integer 1..7 required
Table 663 Modify Pnp Extension Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
PNP Extension

locCode Consists of L2, L1, and L0 1..14 Numeric string. 0
locL2Len.
without L0.
without L1.
e164Prefix Represents the E.164 DN 1..15 Numeric string ““
(national number) assigned
to the range of extension
numbers. This is to be
provisioned if the extension
numbers of the range have
E.164 DNs assigned. It must
be unique within the table.
e164OfficeCode Unused.
destType Type of destination enum PnpExt_HomeDn required
designated by the destId. The
only valid value is Note that the following
HOMEDN(12). The destId additional values are defined
must be an officeCodeId in but not currently supported:
the e164_office_code_t table.
The e164Prfx must contain PnpExt_EndPoint,
the officeCode as the leading PnpExt_Line,
substring. When e164Pfx is PnpExt_Service,
entered, the destType must PnpExt_Vacant,
be HOMEDN and the destId is PnpExt_Intercept
to be the e164officeCodeId.
destName Indicates the name of the 1..15 Character string. ““
destination.
Table 663 Modify Pnp Extension Input Fields (Seite 2 von 2)
12.5.3 Delete PNP Extension

This method deletes the specified PNP Extension.
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
PNP Extension

WSDL Version
subRC_APP_PNP_EXT_CODE_DELETION_FAILED
Table 664 Delete Pnp Extension Return Codes

numbering plan.
me
on page 78.
Table 665 Delete Pnp Extension Input Fields
12.5.4 Get PNP Extension List

This method retrieves a list of all PNP Extensions on the system.

WSDL Version
subRC_SYS_PNP_EXT_CODE_ALLOC_ERROR
subRC_APP_PNP_EXT_CODE_DOES_NOT_EXIST
subRC_DB_PNP_EXT_CODE_LOOKUP_FAILED
Table 666 Get PnP Extension List Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
Domain Codes

numbering plan.
me
Table 667 Get PnP Extension List Input Fields
12.6 Domain Codes

Domain Codes introduce a new translation table that allows an
administrator to provision routing based on the hostname received in
a SIP URI rather than based on digits contained in the username of the
SIP URI. Routing based on the entire SIP URI rather than just the
userinfo part of the SIP URI is especially useful when the Request URI
of an incoming SIP request does not contain numbers within the
domain for which the OSV is responsible or contains alphanumeric
characters in the userinfo part of the URI.
12.6.1 Create Domain Code

This method creates a Domain Code.
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
Domain Codes
WSDL Return Codes Message

Version
subRC_APP_COMM_OPERATOR_INVALID Invalid Operator name. Length
invalid or characters not allowed.
subRC_APP_DOMCODE_DOMAIN_CODE_INVALID Invalid domain code provided
subRC_APP_DOMCODE_CLASS_SERVICE_INVALID Invalid class of service provided
subRC_APP_DOMCODE_ROUTING_AREA_INVALID Invalid routing area provided
subRC_APP_DOMCODE_PREFIX_TYPE_INVALID Invalid prefix type provided
subRC_APP_DOMCODE_NUMBER_INVALID Invalid number provided
subRC_APP_DOMCODE_TRAFFIC_TYPE_INVALID Invalid traffic type provided
subRC_APP_DOMCODE_DEST_TYPE_INVALID Invalid destination type provided
subRC_APP_DOMCODE_DEST_NAME_INVALID Invalid destination name provided
Table 668 Create Domain Code Return Codes
Field Name Description Require Type Default Value

d
(DomainCodeInfo) A structure containing the identifier fields
DomainCodeIdentific
ation
(DomainCodeIdentific Provides the domain code name of yes Char array NA [1..128]
ation) the retrieved entry
DomainCode
(DomainCodeIdentific Provides the class of service of the yes Char array NA [1..16]
ation) retrieved entry
ClassOfService
(DomainCodeIdentific Provides the routing area of the yes Char array NA [1..16]
RoutingArea
(DomainCodeInfo) A structure containing the data fields
DomainCodeData
(DomainCodeData) Provides the prefx type of the no Enumeration DCPrefixTypeOnNet
PrefixType retrieved entry. Access (default)
DCPrefixTypeOffNet
Access
(DomainCodeData) Provides the RedirectTo type for ths no Enumeration DCRedirectToNone
RedirectTo domain code. (default)
DCRedirectToComm
onNP
DCRedirectToGlobal
NP
(DomainCodeData) Provides whether we want no bool Default: false
Retranslate retranslation for ths domain code.
(DomainCodeData) Provides the number associated with no Unsigned -
Number this domain code. Integer
Table 669 Create Domain Code Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
Domain Codes

d
(DomainCodeData) Provides whether the traffic type is no Enumeration BasedOnTrafficType
TrafficTypeSelection based on local toll or not. (default)
BasedOnLocalToll
(DomainCodeData) Provides the traffic type name –valid no Char array 1...32
TrafficTypeName if TrafficTypeSelection is
BasedOnTrafficType
Table 669 Create Domain Code Input Fields (Seite 2 von 2)
12.6.2 Modify Domain Code

This method modifies a Domain Code.

Version
subRC_APP_DOMCODE_PREFIX_TYPE_INVALID Invalid prefix type provided
subRC_APP_DOMCODE_NUMBER_INVALID Invalid number provided
subRC_APP_DOMCODE_TRAFFIC_TYPE_INVALID Invalid traffic type provided
subRC_APP_DOMCODE_DEST_NAME_INVALID Invalid destination name provided
Table 670 Modify Domain Code Return Codes
Field Name Description Required Type Default Value

DomainCodeIdentific
ation
DomainCode
ClassOfService
RoutingArea
Table 671 Modify Domain Code Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
Domain Codes

(DomainCodeInfo) A structure containing the data fields
DomainCodeData
(DomainCodeData) Provides the prefx type of the no Enumeration DCPrefixTypeOnN
PrefixType retrieved entry. etAccess (default)
DCPrefixTypeOffN
etAccess
(DomainCodeData) Provides the RedirectTo type for ths no Enumeration DCRedirectToNon
RedirectTo domain code. e (default)
DCRedirectToCom
monNP
DCRedirectToGlob
alNP
(DomainCodeData) Provides whether we want no bool Default: false
Retranslate retranslation for ths domain code.
(DomainCodeData) Provides the number associated with no Unsigned -
Number this domain code. Integer
(DomainCodeData) Provides whether the traffic type is no Enumeration BasedOnTrafficTyp
TrafficTypeSelection based on local toll or not. e (default)
BasedOnLocalToll
(DomainCodeData) Provides the traffic type name –valid no Char array 1...32
TrafficTypeName if TrafficTypeSelection is
BasedOnTrafficType
Table 671 Modify Domain Code Input Fields (Seite 2 von 2)
12.6.3 Query Domain Code

The QueryDomainCode API allows the retrieval of the list of Domain
Codes provisioned in the system. SOAP provides the facilities sorting,
paging, filtering, etc).

Version
Table 672 Query Domain Code Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
Domain Codes

d
DomainCode Allows filtering of the result per no Char array NA [1…128]
Domain Code
RoutingArea Allows filtering of the result per no Char array NA [1…16]
Routing Area
ClassOfService Allows filtering of the result per Class no Char array NA [1…16]
of Service
DestinationType Allows filtering of the result per No Enumeration DCDestTypeDestinat
Destination Type ion (default)
DCDestTypeIntercep
t
DCDestTypeRestrict
edCode
DCDestTypeFallback
ToLocalNP
SortOrder Standard sorting structure
Table 673 Query Domain Code Input Fields
Field Name Description Type Range - Length

ResultCodeStruct A typical structure containing return codes (indicating success/failure/error cases),
invocation timestamp along with various informative messages. Return code list is
displayed below.
DomainCodeList A list of ApplicationData elements
(DomainCodeList) A structure containing the following data
DomainCodeInfo
(DomainCodeInfo) A structure containing the identifier fields of the result
DomainCodeIdentific
ation
(DomainCodeIdentifi Provides the domain code name of the Char 1..128
cation) retrieved entry array
DomainCode
(DomainCodeIdentifi Provides the class of service of the Char 1..16
cation) retrieved entry array
ClassOfService
(DomainCodeIdentifi Provides the routing area of the retrieved Char 1..16
cation) entry array
RoutingArea
Table 674 Query Domain Code Output Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
Domain Codes
Field Name Description Type Range - Length

(DomainCodeData) Provides the prefix type of the retrieved Enumerat DCPrefixTypeOnNetAccess
PrefixType entry. ion DCPrefixTypeOffNetAccess
(DomainCodeData) Provides the RedirectTo type for ths Enumerat DCRedirectToNone

RedirectTo domain code. ion DCRedirectToCommonNP
DCRedirectToGlobalNP
(DomainCodeData) Provides whether we want retranslation bool -
Retranslate for ths domain code.
(DomainCodeData) Provides the number associated with this Unsigned -
Number domain code. Integer
(DomainCodeData) Provides whether the traffic type is based Enumerat BasedOnTrafficType
TrafficTypeSelection on local toll or not. ion BasedOnLocalToll
(DomainCodeData) Provides the traffic type name –valid if TrafficTypeSelection is BasedOnTrafficType
TrafficTypeName
(DomainCodeData) Provides the destination type for the Enumerat DCDestTypeDestination
DestType destination below ion DCDestTypeIntercept
DCDestTypeRestrictedCode
DCDestTypeFallbackToLocalNP
(DomainCodeData) Provides the destination name of the Char 1..68
DestName associated desetination for the domain array
code
Table 674 Query Domain Code Output Fields (Seite 2 von 2)
12.6.4 Delete Domain Code

This method deletes a Domain Code.

Version
subRC_APP_DOMCODE_DOMAIN_CODE_NOT_PRESEN No domain code with the specified
T identification exists
Invalid domain code provided
subRC_APP_DOMCODE_DOMAIN_CODE_INVALID Invalid class of service provided
subRC_APP_DOMCODE_CLASS_SERVICE_INVALID Invalid routing area provided
subRC_APP_DOMCODE_ROUTING_AREA_INVALID
Table 675 Delete Domain Code Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Numbering Plans
Domain Codes

DomainCodeIdentific
ation
DomainCode
ClassOfService
RoutingArea
Table 676 Delete Domain Code Input Fields
A31003-H80A0-T101-1-7618, 11/2021
soap_ext_interfaces_number_mod.fm
Number Modification
DNM Prefixes
13 Number Modification
From the end user perspective, it is useful for the called party to see a
number being displayed that can be used exactly to call back the calling
party (instead of prefixing the public access code, country code, etc. to
the display number before calling back). In order to support the display
of a dialable number, there are administrative tables for number
modification.
The dialable display number feature is per numbering plan based. It is

applicable for all markets, all solutions. All these display number
related tables are optional.
Any existing features or future features which have the number display
functionality shall interact with the dialable display number feature.
The dialable display number feature applies only if the display number
supporting tables are provisioned. If they are not provisioned, then the
current display number function will be used with no modification
applied. To disable the dialable display number feature, the entries in
these tables need to be removed.
The following subsections describe the SOAP/XML interfaces that exist

for the provisioning of the Number Modification tables
13.1 DNM Prefixes

This table specifies the network access codes and prefixes that are
defined for a specific numbering plan, a specific business group or
system wide.
This table is consulted 2 ways:
• One way is to find out the type of number for an unknown digit
string. It will find the prefixes table entry with the longest digit
string match on network access code (PNAC) and prefix, strip
the network access code and prefix and return the stripped
number together with the type of number (TON) that is defined
for that network access code and prefix.
• Another way is to find the PNAC and prefix digits for a specific
type of number. It will find the number prefix entry for the
specified numbering plan and business group.
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Prefixes
13.1.1 Create DNM Prefix

Addition of DNM Prefix entries will be assisted through the use of the
aforementioned web service. If BgName is empty, meaning the 'ANY'
value, the NpName should be empty as well. The craft person will have
to provide the corresponding Prefix attributes (see input field
definitions below). Validation of a new DNM Prefix entry will ensure that
all NPI/TON combinations in the list of data objects are unique. SOAP
will support a series of validations regarding the input parameters
(presence of mandatory fields, usage of invalid characters, exceeding
parameter length, invalid business group name etc). SOAP will
communicate the outcome of the operation through the use of return
codes.

V5.00.20.01 subRC_APP_NOT_ALLOWED_SETTING_KEYSET_TO_MOBILEDN
subRC_APP_FEAT_OSMO_ONS_NOT_ASSIGNED_TO_DESK_PHONE_DN
subRC_APP_SUB_OSMO_MLHG_MEMBER_CONFLICT
subRC_APP_SUB_OSMO_REMOVAL_FAILURE
subRC_APP_FEAT_OSMO_CSTA_NOT_ASSIGNED_TO_DESK_PHONE_DN
Table 677 Create DNM Prefix Return Codes
Field Name Required Description Length Range Default Value

OperatorId Yes I/F operator Char 40 (1…40) N/A
array
DnmPrefixKey Yes This structure has the mandatory fields which define uniquely in the OSCV a
DNM Prefix entry. These fields are given below
DnmPrefixDataL No This structure is a list containing instances that have all the other fields apart
ist from the key that comprise a DNM Prefix entry. These fields are given below
Table 678 "Create DNM Prefix Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Prefixes

(DnmPrefixKey) Yes The name of the Business Char 30 (1…30) N/A
BgName Group. When the array
corresponding XML tag has
no value (tag is empty) the
‘ANY’ BgName will be used
instead.
(DnmPrefixKey) Yes The name of the Char 30 (1…30) N/A
NpName Originating Numbering array
Plan for this DN Prefix
entry. Empty XML tag
implies usage of NP ‘ANY’
(DnmPrefixKey) No The type of Network Enumerat DNM_TON_Internat DNM_TON_Inte
TypeOfNumber Access Code and Prefix or ional, rnational
definitions DNM_TON_National
, DNM_
TON_Subscriber,
DNM_TON_L2,
DNM_TON_L1,
DNM_TON_L0
(DnmPrefixData No Describes the public or Numeric 15 (1…15) Empty String
) private network access string
NetworkAccessC digits. represent
ode ing a valid
dialable
network
access
code.
(DnmPrefixData No The prefixed digits for the Numeric 15 (1…15) Empty String
) particular call type. string
PrefixCode represent
ing a
valid
dialable
prefix.
Table 678 "Create DNM Prefix Input Fields (Seite 2 von 2)
13.1.2 Modify DNM Prefix

Brief Service description: The craft person will be able to modify the
Network Access Code and Prefix code of an already existing DNM Prefix
entry using this specific web service. The craft person will still have to
provide mandatory field/filters (see input field definitions below). SOAP
will support a series of validations similar to the ones performed during
the add operation. SOAP will communicate the outcome of the
operation through the use of return codes which will differentiate
depending on the case (see return code list below).
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Prefixes

V5.00.01.03 subRC_APP_DSA_BLOCKED_BY_OP_MODE
subRC_APP_CONGESTION_OVERLOAD
subRC_APP_INSUFFICIENT_PERMISSIONS
subRC_APP_DNM_DEFINITION_NP_INVALID
subRC_APP_DNM_PNAC_INVALID
subRC_APP_DNM_PREFIX_INVALID
subRC_APP_DNM_PREFIX_ALREADY_EXISTS
subRC_APP_DNM_PREFIX_COULD_NOT_BE_CREATED
subRC_DB_NDM_DATABASE_ERROR
subRC_APP_NDM_ERROR
subRC_SUCCESS
Table 679 Modify DNM Prefix Return Codes

array
DnmPrefixKey Yes This structure has the mandatory fields which define uniquely in the OSCV a
DNM Prefix entry. These fields are given in the Create DNM Prefix operation.
None of these fields are modifiable
DnmPrefixModK No This structure has the mandatory fields which define uniquely in the OSCV a
ey DNM Prefix entry. These fields are given in the Create DNM Prefix operation.
These fields are modifiable
DnmPrefixData Yes A list structure containing instances that have all the other fields apart from
the key that comprise a DNM Prefix entry. These fields are given in the Create
DNM Prefix description. Note: For all these fields, if the tag is not passed then
the previous value of the field remains intact. Moreover, at least one of these
fields need to exist in the structure.
Table 680 Modify DNM Prefix Input Input Fields
13.1.3 Delete DNM Prefix

Brief Service description: The deletion of existing DNM Prefix entries
will be assisted through the use of this web service. The craft person
will have to provide the key fields/filters (see input field definitions
below). SOAP will communicate the outcome of the removal through
the use of different return codes depending on the case (see return
code list below).
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Prefixes

subRC_APP_DNM_PREFIX_WAS_NOT_FOUND
subRC_APP_DNM_PREFIX_COULD_NOT_BE_DELETED
subRC_APP_NDM_ERROR
subRC_SUCCESS
Table 681 Delete DNM Prefix Return Codes

array
Transactional No This flag indicates whether Boolean [true|false] false
processing of requested
list of Definitions is to be
treated as a transactional
block where all entries are
expected to succeed or fail
as a whole. When set to
True, atomic operations
will be followed by a
Commit/Rollback
statement allowing them
to be treated as a single
block. Potential failed
atomic operations are
identified and displayed as
part of the result of this
API when Transactional
field set to False
DeleteDnmPrefi Yes A list specifying all the entries to be deleted. At least one element should be
xList given for deletion. Each element of the list is of type DnmPrefixKey described
in the Create DNM Prefix operation
Table 682 Delete DNM Prefix Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Prefixes

displayed below.
ErrorList A structure that will be filled with the entries for which their deletion failed. If the
operation was successful for all the entries, this structure will not be returned.
Table 683 Delete DNM Prefix Output Fields
13.1.4 Query DNM Prefix

Brief Service description: A list of DNM Prefixes will be included in the
result of this web service. The craft person will have to provide a
Business Group Name and/or a Number Plan name (see input field
definitions below). SOAP will return the list of Prefix entries (if any)
along with the outcome of the operation in case an error occurred (see
return code list below). This operation will support paging and sorting
(Order: ascending / descending - Type: by NDAL Weight / by Business
Group / by Number Plan).

V5.00.01.03 subRC_APP_CONGESTION_OVERLOAD
subRC_APP_DNM_NDM_ERROR
subRC_APP_DNM_PREFIX_NOT_FOUND
subRC_SYS_SUB_FEATURE_NO_MEMORY
subRC_SUCCESS
Table 684 Query DNM Prefix Return Codes

array
DmmQueryOpti No A structure containing query options for all the DNM Library’s objects
ons
Table 685 Query DNM Prefix Input Fields(Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Prefixes

BlockSystemWid No Indicates whether system boolean TRUE/FALSE FALSE
eEntries wide entries will also be
part of the result list.
(DmmQueryOptio No Optional Paging structure that will be used when part of the result is required
ns)
Paging
(DmmQueryOptio No Page size of the retrieved Unsigned [1-1000] 0 (No paging)
ns) result set Integer
(Paging)
PageSize
(DmmQueryOptio No Page number of the Unsigned [1-1000] 0 (No paging)
ns) retrieved result set Integer
(Paging)
PageNumber
(DmmQueryOptio No The sort column of the Enumerat DNM_SortType_Wei DNM_SortType_
ns) retrieved result set or ghts, Weights
SortType DNM_SortType_Bg
Name,
DNM_SortType_Np
Name,
(DmmQueryOptio No The sort order of the Enumerat Ascending Ascending
ns) retrieved result set or Descending
SortOrder
DnmPrefixKey No This structure has the mandatory fields which define uniquely in the OSCV a
DNM Prefix entry. These fields are given in the Create DNM Prefix operation
For the query operation all fields are optional. Empty BG tag implies ANY BG.
No BG tag implies ALL BGs.
Table 685 Query DNM Prefix Input Fields(Seite 2 von 2)

displayed below.
QueryDnmPrefixLi A list containing Prefix entries according to the provided criteria. List elements are
st instances consist of a DnmPrefixKey and a DnmPrefixData described in the DNM Create
Prefix operation. Returned only in success.
Table 686 Query DNM Prefix Output Fields
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Prefixes
13.1.5 Query DNM PrefixList

Brief Service description: A list of DNM Prefixes analyzed per type of
number will be included in the result of this web service. The craft
person will have to provide a Business Group Name and/or a Number
Plan name (see input field definitions below). SOAP will return the list
of Prefix entries (if any) along with the outcome of the operation in case
an error occurred (see return code list below). This operation will
support paging and sorting (Order: ascending / descending - Type: by
NDAL Weight / by Business Group / by Number Plan)

subRC_APP_DNM_PREFIX_NOT_FOUND
subRC_SUCCESS
Table 687 Query DNM PrefixList Return Codes

array
DmmQueryOptio No A structure containing query options for all the DNM Library’s objects
ns
BlockSystemWide No Indicates whether system boolean TRUE/FALSE FALSE
Entries wide entries will also be
(DmmQueryOption No Optional Paging structure that will be used when part of the result is required
s)
Paging
(DmmQueryOption No Page size of the retrieved Unsigned [1-1000] 0 (No paging)
s) result set Integer
(Paging)
PageSize
Table 688 Query DNM PrefixList Input Fields(Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Definitions

(DmmQueryOption No Page number of the Unsigned [1-1000] 0 (No paging)
s) retrieved result set Integer
(Paging)
PageNumber
(DmmQueryOption No The sort column of the Enumerat DNM_SortType_Wei DNM_SortType_
s) retrieved result set or ghts, Weights
Name,
DNM_SortType_Np
Name,
(DmmQueryOption No The sort order of the Enumerat Ascending Ascending
s) retrieved result set or Descending
SortOrder
BgName No The Name of the Business Group
NpName No The Name of the Number Plan
Table 688 Query DNM PrefixList Input Fields(Seite 2 von 2)

displayed below.
QueryDnmPrefixLi A list containing enhanced Prefix entries according to the provided criteria. Returned only
st in success.
Table 689 Query DNM Prefix Output Fields
13.2 DNM Definitions

This table specifies the number definition entries that exist within a
numbering plan, business group or even system wide.
The definitions table should only be populated with all the office codes
that are created in the OpenScape Voice database. This includes public
office codes and also office codes created for private Home DNs. It
should never be necessary to repeat office code definitions; therefore,
it is now also possible to create business group specific and even
system wide definitions.
The 'old' definitions table also contained number normalization and

number conversion entries. These entries have been moved to the
Normalizations and Conversions tables.
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Definitions
The definitions table has now a new column to specify whether the
definition is for a private or a public office code. This column is called
the Numbering Plan Identifier (NPI). This is the same identifier that is
also supported by ISDN and can have the values Public or Private.
Another new column in this table is the Local Toll column. This column
allows the administrator specifying how public numbers are defined for
users of this specific definition table entry. Per default it is assumed
that users that have a specific public number actually follow the basic
rules that they need to dial local numbers within their own area code,
national numbers within their country and international numbers
elsewhere. As long as these rules apply, there's no need for a local toll
entry on the public number definition. However, if these rules change,
as they certainly can in the American market, then the local toll table
entry specified on the number definition will be used to find out how a
number received from the public network can be optimized to the
national or subscriber level for the subscribers of that office code.
There are 2 situations where the local toll table is mandatory:
1. When a standalone private office code is created without a number

conversion entry that allows the DNM library to find the
accompanying public number then the local toll table entry will
allow the DNM library to optimize incoming public numbers correctly
for these users. E.g. if a branch office has a single access number
and all branch office members have private extensions not
reachable directly from the public network, then the subscribers of
the branch office need to be provisioned with private numbers and
the private number definition table entry needs a local toll entry to
define the local and national public numbers in the context of the
private number subscribers.
2. When a public office code is created with subscribers that need to

dial within split or overlapping area codes. This is the case in e.g.
Boca Raton, FL in case the numbers presented to the subscribers
need to be in the exact format as specified by the public network.
13.2.1 Create DNM Definition

Brief Service description: DNM Definition entries will be created using
the aforementioned web service. The craft person will have to provide
the corresponding Definition attributes (see input field definitions
below). SOAP will support a series of validations regarding the input
parameters (presence of mandatory fields, usage of invalid characters,
exceeding parameter length, invalid business group name etc).
However, SOAP will have no control over logical errors including cases
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Definitions
where L2, L1 or L0 parts become mandatory as this will be a feature of

the NDM component. SOAP will communicate the outcome of the
operation through the use of return codes which will differentiate
depending on the case (see return code list below).

subRC_APP_DNM_CODE2_INVALID
subRC_APP_DNM_SKIP_DIGITS_INVALID
subRC_APP_DNM_MIN_DIGITS_INVALID
subRC_APP_DNM_MAX_DIGITS_INVALID
subRC_APP_DNM_LOCAL_TOLL_NAME_INVALID
subRC_APP_DNM_DEFINITION_ALREADY_EXISTS
subRC_APP_DNM_DEFINITION_COULD_NOT_BE_CREATED
subRC_APP_NDM_ERROR
subRC_SUCCESS
Table 690 Create DNM Definition Return Codes

array
DnmDefinitionKey Yes This structure has the mandatory fields which define uniquely in the OSCV a
DNM Normalization entry. These fields are given below
DnmDefinitionDat No This structure has all the other fields apart from the key that comprise a DNM
a Normalization entry. These fields are given below
(DnmDefinitionKe Yes The name of the Business Char 30 (1…30) N/A
y) Group. array
BgName When the corresponding
XML tag has no value (tag
is empty) the ‘ANY’
BgName will be used
instead.
Table 691 Create DNM Definition Input Fields(Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Definitions

(DnmDefinitionKe Yes The name of the Char 30 (1…30) N/A
y) Originating Numbering array
NpName Plan for this DN Definition
entry. Empty XML tag
implies usage of NP ‘ANY’.
(DnmDefinitionKe Yes The type of numbering Enumerat DNM_NPI_Public, DNM_NPI_Public
y) plan format to apply. or DNM_NPI_Private
Npi
(DnmDefinitionKe Yes Represents a Country code Char 15 (1…15) N/A
y) when the NP indicator is array
Code2 set to ‘Public’ or a Level 2
code when the NP indicator
is set to ‘Private’.
(DnmDefinitionKe Yes Represents an Area code Char 15 (1…15) N/A
y) when the NP indicator is array
Code1 set to ‘Public’ or a Level 1
code when the NP indicator
is set to ‘Private’.
(DnmDefinitionKe Yes Represents a Local office Char 15 (1…15) N/A
y) code when the NP indicator array
Code0 is set to ‘Public’ or a Level
0 code when the NP
indicator is set to ‘Private’.
(DnmDefinitionDat No Skip Digit value for the Integer [1-15] 0
a) Definition entry. Specifies
SkipDigit the number of digits which
are to be skipped to
extract the Local Office/L0
code when extension
number overlaps.
(DnmDefinitionDat No Minimum digits of the Integer Within the ranges of -1
a) defined number. the definition
MinDigits
(DnmDefinitionDat No Maximum digits of the Integer Within the ranges of -1
a) defined number. the definition
MaxDigits
(DnmDefinitionDat No The name of Local Toll Char 30 (0…30) Empty String
a) table. array
LocalTollName
Table 691 Create DNM Definition Input Fields(Seite 2 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Definitions

displayed below.
Table 692 Create DNM Definition Output Fields
13.2.2 Modify DNM Definition

Brief Service description: DNM Definition entries will be modified using
the aforementioned web service. The craft person will have to provide
a number of filters (see input field definitions below). SOAP will support
a series of validations regarding the input parameters (presence of
mandatory fields, usage of invalid characters, exceeding parameter
length, invalid business group name etc). However, SOAP will have no
control over logical errors including cases where L2, L1 or L0 parts
become mandatory as this will be a feature of the NDM component.
SOAP will communicate the outcome of the operation through the use
of return codes which will differentiate depending on the case (see
return code list below).

subRC_APP_DNM_DEFINITION_WAS_NOT_FOUND
subRC_APP_DNM_DEFINITION_COULD_NOT_BE_DELETED
subRC_APP_NDM_ERROR
subRC_SUCCESS
Table 693 Modify DNM Definition Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Definitions

array
DnmDefinitionKe Yes This structure has the mandatory fields which define uniquely in the OSCV a
y DNM Definition entry. These fields are given in the Create DNM Definition
operation. All but BgName, NpName fields are modifiable
DnmDefinitionMo No This structure has the modified set of values for the mandatory fields which
dKey define uniquely in the OSCV a DNM Definition entry and are partially
modifiable.
DnmDefinitionDa Yes This structure has all the other fields apart from the key that comprise a DNM
ta Definition entry. These fields are given in the Create DNM Definition
description. Note: The optional fields, if omitted will remain intact
Table 694 Modify DNM Definition Input Fields

displayed below.
Table 695 Modify DNM Definition Output Fields
13.2.3 Delete DNM Definition

Brief Service description: The deletion of existing DNM Definition
entries will be assisted through the use of this web service. The craft
person will have to provide the key fields/filters (see input field
definitions below). SOAP will communicate the outcome of the removal
through the use of different return codes depending on the case (see
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Definitions

subRC_APP_DNM_DEFINITION_WAS_NOT_FOUND
subRC_APP_DNM_DEFINITION_COULD_NOT_BE_DELETED
subRC_APP_NDM_ERROR
subRC_SUCCESS
Table 696 Delete DNM Definition Return Codes

array
Commit/Rollback
field set to False
DeleteDnmDefin Yes A list specifying all the entries to be deleted. Each element of the list is of type
itionList DnmDefinitionKey described in the Create DNM DefinitionKey operation. At
least one element should be specified in the request
Table 697 Delete DNM Definition Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Definitions

displayed below.
Table 698 Delete DNM Definition Output Fields
13.2.4 Query DNM Definition

Brief Service description: A list of DNM Definitions will be included in
the result of this web service. The craft person will have to provide a
definitions below). SOAP will return the list of Definition entries (if any)

subRC_APP_DNM_DEFINITION_NOT_FOUND
subRC_SUCCESS
Table 699 Query DNM Definition Return Codes

array
Table 700 Query DNM Definition Input Fields(Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Definitions

ons
(DmmQueryOpti No Optional Paging structure that will be used when part of the result is required
ons)
Paging
(DmmQueryOpti No Page size of the retrieved Unsigned [1-1000] 0 (No paging)
ons) result set Integer
(Paging)
PageSize
(DmmQueryOpti No Page number of the Unsigned [1-1000] 0 (No paging)
ons) retrieved result set Integer
(Paging)
PageNumber
(DmmQueryOpti No The sort column of the Enumerat DNM_SortType_Wei DNM_SortType_
ons) retrieved result set or ghts, Weights
Name,
DNM_SortType_Np
Name,
(DmmQueryOpti No The sort order of the Enumerat Ascending Ascending
ons) retrieved result set or Descending
SortOrder
DnmDefinitionK No This structure has the mandatory fields which define uniquely in the OSCV a
ey DNM Definition entry. These fields are given in the Create DNM Definition
operation
For the query operations all fields are optional. Empty BG tag implies ANY BG.
No BG tag implies all BGs. If any of the fields is left blank all matching values
will be returned. E.g. if npi = public and CC=1 then all public definitions for
the USA will be returned in a list.

displayed below.
QueryDnmDefiniti A list containing the actual Definition objects stored in DB. Each item of the list is of type
onList QueryDnmDefinitionEntry which consists of a part of type DNMDefinitionKey and another
of type DNMDefinitionData and the index of the entry stored in DB. Returned only in
success.
Table 701 Query DNM Definition Output Fields
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Definitions
13.2.5 Query DNM Definition

Brief Service description: A list of DNM Definitions will be included in
the result of this web service. The craft person will have to provide a
definitions below). SOAP will return the list of Definition entries (if any)

subRC_APP_DNM_DEFINITION_NOT_FOUND
subRC_SUCCESS
Table 702 Query DNM Definition Return Codes

array
ons
ons)
Paging
(Paging)
PageSize
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Modification

(Paging)
PageNumber
(DmmQueryOpti No The sort column of the Enumerat DNM_SortType_Wei DNM_SortType_
ons) retrieved result set or ghts, Weights
Name,
DNM_SortType_Np
Name,
SortOrder
DnmDefinitionK No This structure has the mandatory fields which define uniquely in the OSCV a
ey DNM Definition entry. These fields are given in the Create DNM Definition
operation
For the query operations all fields are optional. Empty BG tag implies ANY BG.
No BG tag implies all BGs. If any of the fields is left blank all matching values
will be returned. E.g. if npi = public and CC=1 then all public definitions for
the USA will be returned in a list.

displayed below.
QueryDnmDefiniti A list containing the actual Definition objects stored in DB. Each item of the list is of type
onList QueryDnmDefinitionEntry which consists of a part of type DNMDefinitionKey and another
of type DNMDefinitionData and the index of the entry stored in DB. Returned only in
success.
Table 704 Query DNM Definition Output Fields
13.3 DNM Modification

This table specifies the number modification rules that are applied for
creating a dialable number.
The administrator gets full flexibility on specifying very specific rules

that only apply for number modification from a specific numbering plan
to a specific endpoint or very general rules that apply system wide.
Other changes include specification of:
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Modification
• Allow specifying a rule that applies to all Private Networking

endpoints (ALL-PN) or to all endpoints (ALL) of a specific
numbering plan, a specific business group or system wide. In
order to allow ALL-PN to be specified there must be at least one
Private Networking (SIP or SIP-Q) endpoint configured with the
specified numbering plan, business group or system wide. In
order to allow ALL to be specified there must be at least one
non-subscriber endpoint configured with the specified
numbering plan, business group or system wide.
• Use of a Prefix flag on a rule instead of specifying it on the

output type of number field.
• Use of a Presentation Restricted flag on a rule instead of

specifying it in the Number Transmission field.
• Renaming the Number Transmission field to Number Source field

with 3 possible values: Input Number (formerly known as
Transparent or Blocked), Default Home DN and BG Display
Number.
• Use of a Default Home DN number provisioned on the specified

endpoint instead of the provided input number. This only
succeeds if the dialable number is created for an endpoint that
has a Default Home DN number defined. This is done by
selecting the Default Home DN Number Source. It will not be
allowed to specify a Default Home DN rule without having either
the specified endpoint or one of the private networking and/or
trunking endpoints (ALL-PN/ALL) in the numbering plan with a
defined Default Home DN.
• The ALL input type of number is not used anymore. Instead up

to 3 ANY rules (prioritized 1 to 3) can be specified that take an
output type of number that is not ANY. The output type of
number ANY automatically receives reserved priority number 4.
It shall not be possible to enter 2 modification rules with the
same number source field value that only differ on priority. E.g.
an ANY (input) / INT (output) / 1 (priority) / Input Number
(Number Source) rule precludes creating an ANY (input) / INT
(output) / 2 (priority) or 3 (priority) / Input Number (Number
Source) rule. The priorities 1 to 4 will also apply to the rules
with a defined input type of number.
• Maximum optimization level that applies to a modification rule.

This replaces the previous rules that just allowed optimization
one level down or optimization all the way to an extension.
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Modification
• Fallback rules that apply when a higher priority rule fails. The
number modification library does not necessarily fail anymore
when the first matching rule does not deliver a result. Instead
the next best rule is searched and applied until either no rules
are available anymore or a rule ends up into a positive
modification.
There are a few additional output types of numbers. For all the
following rules, Optimize Type of Number must be None and the Prefix
Required flag must not be set (both fields are to be grayed out by the
OpenScape Voice Assistant):
• FQPN: request to modify the number to a fully qualified private

number (L2, L1 or L0 number).
• EXT: request to modify the number to an extension number.
• NORMALIZED: request to return the fully qualified number for

the input number. This is a fully qualified private number if the
input number is a private number or a fully qualified public
number if the input number is a public number.
For inter business group rules (where 2 different business group names
are specified), the output type of number must be a public type of
number: one of Any, International, National, Subscriber or Normalized.
Inter business group rules with non-public number outputs will be
skipped.
13.3.1 Create DNM Modification

Brief Service description: Creation of DNM Modification entries will be
accommodated by this specific web service. The craft person will have
to provide the Modification attributes according to the input field
definitions presented below. SOAP will support a series of validations
regarding the input parameters (presence of mandatory fields, usage
of invalid characters, exceeding parameter length, invalid business
group name etc). The outcome of the operation will be communicated
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Modification

subRC_APP_DNM_DEFINITION_ALREADY_EXISTS
subRC_APP_DNM_DEFINITION_COULD_NOT_BE_CREATED
subRC_APP_NDM_ERROR
subRC_SUCCESS
Table 705 Create DNM Modification Return Codes

array
DnmModificatio Yes This structure has the mandatory fields which define uniquely in the OSCV a
nKey DNM Modification entry. These fields are given below
DnmModificatio Yes This structure has all the other fields apart from the key that comprise a DNM
nData Modification entry. These fields are given below
(DnmModificatio Yes The name of the Char 30 (1…30) N/A
nKey) Originating Business array
FromBgName Group. When the
instead.
nKey) Terminating Business array
ToBgName Group. When the
instead.
Table 706 Create DNM Modification Input Fields(Seite 1 von 4)
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Modification

nKey) Originating Numbering array
FromNpName Plan for this DN
Modification entry. Empty
XML tag implies usage of
NP ‘ANY’.
nKey) Terminating Numbering array
ToNpName Plan for this DN
Modification entry. Empty
XML tag implies usage of
NP ‘ANY’.
(DnmModificatio Yes A struct of type DnmEndpoint specifying the type of the Terminating Endpoint.
nKey)
ToEndpoint
(DnmModificatio No The type of the Enumerat DNM_EpType_N
nKey) terminating endpoint or DNM_EpType_None one
(DnmEndpoint) DNM_EpType_ALL
EnpointType DNM_EpType_ALL_
PN
DNM_EpType_EpNa
me
(DnmModificatio No The name of the Endpoint Char 16 (0…16) Empty string
nKey) that this entry belongs. array
(DnmEndpoint)
EpName
(DnmModificatio Yes A part of the key used to Enumerat DNM_TON_nternati DNM_TON_Inter
nKey) qualify the type of number or onal, national
InputTON for which this Number DNM_TON_National
Modification entry applies. ,
DNM_
TON_Subscriber,
DNM_
TON_LocationLevel
2,
DNM_
TON_LocationLevel
1,
DNM_
TON_LocalSubscrib
er,
DNM_ TON_Any
(DnmModificatio Yes The value of priority that Unsigned [1-4] 1
nKey) applies to the Input TON. Integer
Priority
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Modification

(DnmModificatio Yes Defines the conversion of Enumerat DNM_TON_Unknow DNM_
nData) an explicit “calling or n, TON_Internation
OutputTON number” to a desired DNM_ al
format before the number TON_International,
is transmitted to the DNM_
destination. TON_National,
DNM_
TON_Subscriber,
DNM_
TON_LocationLevel
2,
DNM_
TON_LocationLevel
1,
DNM_
TON_LocalSubscrib
er,
DNM_ TON_Any,
DNM_ TON_FQPN,
DNM_
TON_Normalized
DNM_
TON_Extension
(DnmModificatio No Defines which number Enumerat DNM_NS_InputNu DNM_NS_Input
nData) shall be taken as number or mber, Number
NumberSource source for this DNM DNM_
Modification rule. NS_BGDisplayNum
ber,
DNM_
NS_DefaultHomeD
N
(DnmModificatio No The optimization rule for Enumerat DNM_ TON_None, DNM_TON_None
nData) this DNM Modification or DNM_
OptimizeTON entry. TON_International,
DNM_
TON_National,
DNM_
TON_Subscriber,
DNM_
TON_LocationLevel
2,
DNM_
TON_LocationLevel
1,
DNM_
TON_LocationLevel
0,
DNM_
TON_Extension
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Modification

(DnmModificatio No Defines whether Boolean [True | False] False
nData) presentation should be
RestrictPresenta restricted.
tion
(DnmModificatio No Defines whether a prefixed Boolean [True | False] False
nData) number is to be returned.
PrefixRequired

displayed below.
Table 707 Create DNM Modification Output Fields
13.3.2 Modify DNM Modification

Brief Service description: Modification of DNM Modification entries will
be assisted by this specific web service. The craft person will have to
provide the Modification attributes according to the input field
definitions presented below. SOAP will support a series of validations
regarding the input parameters (presence of mandatory fields, usage
of invalid characters, exceeding parameter length, invalid business
group name etc). The result of the operation will be communicated
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Modification

subRC_APP_DNM_ENDPOINT_INVALID
subRC_APP_DNM_TYPE_OF_NUMBER_INVALID
subRC_APP_DNM_PRIORITY_INVALID
subRC_APP_DNM_NUMBER_SOURCE_INVALID
subRC_APP_DNM_MODIFICATION_ALREADY_EXISTS
subRC_APP_DNM_MODIFICATION_COULD_NOT_BE_CREATED
subRC_APP_NDM_ERROR
subRC_SUCCESS
Table 708 Modify DNM Modification Return Codes

OperatorId Yes I/F operator Char 40 (1…40) Required
array
DnmModificatio Yes This structure has the mandatory fields which define uniquely in the OSCV a
nKey DNM Modification entry. These fields are given in the Create DNM Modification
operation.
DnmModificatio No This structure has the modified set of values for the mandatory fields which
nModKey define uniquely in the OSCV a DNM Modification entry. Besides fields “Input
Ton” and “Priority” everything else is non modifiable.
DnmModificatio Yes This structure has all the other fields apart from the key that comprise a DNM
nData Modification entry. These fields are given in the Create DNM Modification
description. Note: The optional fields, if omitted, will remain intact. At least
one field of this structure should exist in the request.
Table 709 Modify DNM Modification Input Fields

displayed below.
Table 710 Modify DNM Modification Output Fields
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Modification
13.3.3 Delete DNM Modification

Brief Service description: The deletion of existing DNM Modification
entries will be assisted through the use of this web service. The craft
person will have to provide the key fields/filters (see input field
definitions below). The output of this API will contain a proper return
code indicating whether the operation resulted in success or failure
(see return code list below).

subRC_APP_DNM_MODIFICATION_WAS_NOT_FOUND
subRC_APP_DNM_MODIFICATION_COULD_NOT_BE_REMOVED
subRC_APP_NDM_ERROR
subRC_SUCCESS
Table 711 Delete DNM Modification Return Codes

array
Table 712 Delete DNM Modification Input Fields(Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Modification

Commit/Rollback
field set to False
DeleteDnmModif No A list specifying all the entries to be deleted. Each element of the list is of type
icationList DnmModificationKey described in the Create DNM Modification operation
Table 712 Delete DNM Modification Input Fields(Seite 2 von 2)

displayed below.
Table 713 Delete DNM Modification Output Fields
13.3.4 Query DNM Modification

Brief Service description: A list of DNM Modification will be included in
the result of this web service. The craft person will be able to provide
a list of Business Groups that an OSV Administrator has access to. This
will allow for a BG-restricted view of the DNM Modifications. SOAP will
return the list of Modification entries along with the result of the
operation (see return code list below). This operation will support
paging and sorting (Order: ascending / descending - Type: by NDAL
Weight / by Originating BG -NP / by Terminating BG - NP - EP).
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Modification

subRC_APP_DNM_MODIFICATION_WAS_NOT_FOUND
subRC_APP_DNM_MODIFICATION_COULD_NOT_BE_REMOVED
subRC_APP_NDM_ERROR
subRC_SUCCESS
Table 714 Query DNM Modification Return Codes

array
BlockSystemWid No Indicates whether system Boolean TRUE / FALSE FALSE
eEntries wide entries will be
included in the result list.
ons
ons)
Paging
(Paging)
PageSize
(Paging)
PageNumber
Table 715 Query DNM Modification Input Fields(Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Normalizations

(DmmQueryOpti No The sort column of the Enumerat DNM_SortType_No DNM_SortType_
ons) retrieved result set or Sorting, Weights
SortType DNM_SortType_Wei
ghts,
DNM_SortType_Bg
Name,
DNM_SortType_Np
Name,
SortOrder
DnmBgAccessLi No A list of Business Groups that the Administrator has access to. Unauthorized
st BG / NP entries in the originating context will be obfuscated. Each list element
contains a BGName attribute having the same characteristics as the other BG
attributes in the request.
DnmModificatio No This structure has the mandatory fields which define uniquely in the OSCV a
nKey DNM Modification entry. These fields are given in the Create DNM Modification
operation
For the query operation all fields are optional. Empty BG tags implies ANY BG.
No BG tag implies all BGs.
Table 715 Query DNM Modification Input Fields(Seite 2 von 2)

ResultCodeStruct A typical structure containing return codes (indicating success/failure/error cases),
displayed below.
QueryDnmModifica A list containing the actual Normalization objects stored in DB. Each item of the list is of
tionList type QueryDnmModificationElement which consists of a part of type DnmModificationKey
and another of type DnmModificationData. Returned only in success
Table 716 Query DNM Modification Output Fields
13.4 DNM Normalizations

This is a new table that specifies the entries to normalize any type of
input number to a fully qualified public (international) or private (L2,
L1 or L0) number.
The administrator can specify endpoint specific, numbering plan

specific, business group wide and even system wide entries. The
purpose of this table is to normalize the numbers received from
gateways and other trunking endpoints. Therefore, most likely, the
administrator will be entering endpoint specific entries in this table.
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Normalizations
This table and the local toll table are the only tables that require
knowledge beyond the boundaries of the OpenScape Voice system
being administered. This table contains information about the format
of the presentation numbers sent by specific endpoints. Note that this
table is consulted after the prefixes table has been consulted, so it
usually works on defined numbers (not unknown) unless the PNAC and
prefixes are not added by the gateway, at which point this table
requires normalization entries for Unknown type of numbers.
This table allows specifying an Input Pattern and Type of Number used
for matching the number to be normalized and then specifying a
modification rule and the resulting type of number of the normalized
number. The input pattern allows using wildcards and regular
expressions and contains information on how to split the matching digit
string in fields that can then be repeated in the modification rule.
This table is also used when a translation results in a call to a specific

gateway. If the result of the translation (output of prefix access codes
table) is not a fully qualified number then the Normalization table is
used to try normalizing the number for presentation purposes in case
the gateway does not provide a busy, alerting or connected number.
13.4.1 Input Patterns

In order to limit and even hide the complexity of regular expressions,
the input patterns use the following wildcard syntax for pattern
elements:
Wildcard Equivalent element

N [2-9]
X [0-9]
Z 0 or more X’s
Z{n,m} Between n and m X’s; n must be smaller than m.
Z{n} Exactly n X’s
Table 717 Pattern Wildcards
Furthermore, it will not be allowed to enter patterns that would result

in regular expressions that would invoke backtracking. This means
that the "|" delimiter used to indicate a choice of elements in regular
expressions is forbidden from use in the input patterns.
The only other pattern elements allowed are:
• [nm]: n or m with n and m any digit between 0 and 9, *, #.
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Normalizations
• [n-m]: n through m with n and m a digit between 0 and 9. It

can be combined with the previous [nm] regular expression.
E.g. [04-79] means 0, 4, 5, 6, 7 or 9.
• n: a digit between 0 and 9, * or #.
Pattern elements are joined in pattern fields through the use of the '-'
delimiter between 2 pattern elements. Note that the '-' is also allowed
inside a pattern element's square brackets and will then not be counted
as field numbers.
The maximum length of an input pattern shall be 64 characters.
Examples of input patterns are:
Pattern Description
8011-Z 8011 followed by an open-ended number of digits. Split in
2 fields:
Field1 is 8011.
Field2 contains the remaining digits of the matching input
string.
81-Z{10} 81 followed by a fixed length 10 digit number. Split in 2
fields:
Field1 is 81.
Field2 contains a 10 digit number.
00-Z{10,11} 00 followed by a variable length 10 or 11 digit number.
Split in 2 fields:
Field1 is 00.
Field2 contains a 10 or 11 digit number.
XXXX A 4 digit number in a single field.
Table 718 DNM Definition Pattern Examples
If multiple entries could apply to the same input digit string, a

weighting factor attributed to the wildcards ensures that specific digits
have higher weight then N, followed by X and lastly Z wildcards. In the
example in Figure 2 7 a 7-digit input digit string matches both the first
(NXX-XXXX) and the last entry (Z). Because of the weighting, the NXX-
XXXX entry will be the first matching entry.
13.4.2 Output Expression

An output expression is a series of elements and fields where the fields
reference the matching digits of the corresponding field in the input
pattern. The '-' delimiter is allowed anywhere in the output expression
and is ignored in the resulting element string.
The maximum length of an output expression shall be 64 characters.
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Normalizations
Examples of output expressions with the previous examples would be:
Pattern Expression Description

8011-Z {2} Return contents of field 2.
81-Z{10} 1{2} Return ‘1’ followed by the contents of
field 2. This would create a US
international number from a prefixed
national US number.
00-Z{10,11} 32{2} Return ‘32’ followed by the contents of
field 2. This would create a BE
international number from a prefixed
national BE number.
XXXX 1561555-{1} Return 1561555 followed by the
contents of field 1 (the ‘-’ is ignored).
This would create a US international
number from a 4 digit extension.
Table 719 DNM Definition Expression Examples
The following web services implemented from the OSCV soapServer

component accommodate this new interface's functionality. They are
described in following sections.
Web Service Description

unsp__CreateDnmNormalization Allows the creation of a new DNM Normalization entry
unsp__ModifyDnmNormalization Allows the modification of an existing DNM Normalization entry
unsp__DeleteDnmNormalization Allows the deletion of one or more (list) DNM Normalization
entries
unsp__QueryDnmNormalization Allows the retrieval of one or more (list) DNM Normalization
entries
13.4.3 Create DNM Normalization

Brief Service description: Using this web service, the craft person will
be able to create an entry in the display_number_normalization_t table
of DB through NDM. The only optional fields when triggering this
interface are the input/output TONs, which, if not passed in the request
will have the default values of DNM_TON_Unknown and
DNM_TON_International respectively.
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Normalizations

subRC_APP_DNM_NP_INVALID
subRC_APP_DNM_EP_INVALID
subRC_APP_DNM_INPUT_PATTERN_INVALID
subRC_APP_DNM_INPUT_TON_INVALID
subRC_APP_DNM_NORMALIZED_TON_INVALID
subRC_APP_DNM_OUTPUT_EXPRESSION_INVALID
subRC_APP_DNM_NORMALIZATION_ALREADY_EXISTS
subRC_APP_NDM_ERROR
subRC_SUCCESS
Table 720 Create DNM Normalization Return Codes

array
DnmNormalizati Yes This structure has the mandatory fields which define uniquely in the OSCV a
onKey DNM Normalization entry. These fields are given below
DnmNormalizati Yes This structure has all the other fields apart from the key that comprise a DNM
onData Normalization entry. These fields are given below
(DnmNormalizat Yes The name of the Business Char 30 (0…30) N/A
ionKey) Group. Empty XML tag array
BgName implies usage of BgName
‘ANY’
(DnmNormalizat Yes The name of the Char 30 (0…30) N/A
ionKey) Numbering Plan. Empty array
NpName XML tag implies usage of
NP ‘ANY’
(DnmNormalizat Yes The name of the Endpoint Char 16 (0…16) N/A
ionKey) that this entry belongs array
EpName
(DnmNormalizat Yes The pattern based on Char 64 (1…64) N/A
ionKey) which the input number array
InputPattern will be normalized
Table 721 Create DNM Normalization Input Fields(Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Normalizations

(DnmNormalizat Yes The input type of number Enumerat DNM_TON_Unknow DNM_TON_Unkn
ionKey) or n, own
InputTypeOfNu DNM_TON_Internat
mber ional,
DNM_TON_National
,
DNM_TON_Subscri
ber, DNM_TON_L2,
DNM_TON_L1,
DNM_TON_L0
(DnmNormalizat No The normalized (output) Enumerat DNM_TON_Internat DNM_TON_Inter
ionData) type of number or ional, national
NormalizedType DNM_TON_L2,
OfNumber DNM_TON_L1,
DNM_TON_L0
Table 721 Create DNM Normalization Input Fields(Seite 2 von 2)

displayed below.
Table 722 Create DNM Normalization Output Fields
13.4.4 Modify DNM Normalization

be able to modify an existing entry in the
display_number_normalization_t table of DB through NDM. If the
optional input/output TONs are not passed in this request, the previous
values would remain intact. All other fields are mandatory. Because of
the fact that for a given endpoint, more than one inputPattern are
allowed to be defined, the search of the existing entry to be modified
is based on its index, stored in the DB. This index is returned from the
query operation.
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Normalizations

subRC_APP_DNM_NORMALIZED_TON_INVALID
subRC_APP_DNM_NORMALIZATION_WAS_NOT_FOUND
subRC_APP_NDM_ERROR
subRC_SUCCESS
Table 723 Modify DNM Normalization Return Codes

array
DnmNormalizati Yes This structure has the mandatory fields which define uniquely in the OSCV a
onKey DNM Normalization entry. These fields are given in the Create DNM
Normalization operation.
DnmNormalizati No The same type as the above. This is used in order to be able to modify the key
onModKey structure. InputPattern and InputTON field are modifiable
DnmNormalizati Yes This structure has all the other fields apart from the key that comprise a DNM
onData Normalization entry. These fields are given in the Create DNM Normalization
description. Note: In case the optional enumerator values
(NormalizedTypeOfNumber) are not passed (the tag doesn’t exist in the
request), then the old values remain intact
Table 724 Modify DNM Normalization Input Fields

displayed below.
Table 725 Modify DNM Normalization Output Fields
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Normalizations
13.4.5 Delete DNM Normalization

be able to delete one or more (list) entries of the
display_number_normalization_t table of DB. In case of success an
informative message will be returned. In case of an error, the exact
entry(ies) for which the error was raised will be returned along with the
error. Rollback of the entire operation is supported through a flag
present in the request (Transactional, please see below)

subRC_APP_NDM_ERROR
subRC_SUCCESS
Table 726 Delete DNM Normalization Return Codes

array
Table 727 Delete DNM Normalization Input Fields(Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Normalizations

Commit/Rollback
field set to False
DeleteDnmNor Yes A list specifying all the entries to be deleted. Each element of the list is of type
malizationList DnmNormalizationKey described in the Create DNM Normalization operation
Table 727 Delete DNM Normalization Input Fields(Seite 2 von 2)

displayed below.
Table 728 Delete DNM Normalization Output Fields
13.4.6 Query DNM Normalization

be able to retrieve one or more (list) entries of the
display_number_normalization_t table of DB through NDM. In case of
success, the requested object or a series of objects (list) matching the
input filtering criteria (please see below) will be returned. In case of an
error, the error will be returned. This interface will support filtering on
Business Group Name and/or Number Plan Name and/or Endpoint
Name. Furthermore, this web service will support paging and sorting;
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Normalizations
The default sorting will be based on the weights calculated by NDM for
each Normalization entry stored in DB. Sorting based on Business
Group Name, Number Plan Name or Endpoint Name will also be
supported.

subRC_APP_NDM_ERROR
subRC_SUCCESS
Table 729 Query DNM Normalization Return Codes

OperatorId Yes I/F operator Char 40 (1..40) N/A
array
ons
ons)
Paging
(Paging)
PageSize
(Paging)
PageNumber
Table 730 Query DNM Normalization Input Fields(Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Conversions

ons) retrieved result set or Sorting, Weight
ghts,
DNM_SortType_Bg
Name,
DNM_SortType_Np
Name,
DNM_SortType_Ep
Name
SortOrder
DnmNormalizati No This structure has the mandatory fields which define uniquely in the OSCV a
onKey DNM Normalization entry. These fields are given in the Create DNM
Normalization operation
For the query operation, all field are optional.
Table 730 Query DNM Normalization Input Fields(Seite 2 von 2)

invocation timestamp along with various informative messages.
PaginatedInfo A common paging structure containing Current Page/Number of Pages/Page Number/
Page Size/. Returned only in the case of retrieval of more than one objects.
DNMQueryNormali A list containing the actual Normalization objects stored in DB. Each item of the list is of
zationList type QueryDnmNormalizationElement which consists of a part of type
DNMNormalizationKey and another of type DNMNormalizationData. Returned only on
success.
Table 731 Query DNM Normalization Output Fields
13.5 DNM Conversions

This is a new table that specifies the number conversion entries that
can be created to convert a public normalized number to a private
normalized number or a private normalized number to a public
normalized number. A special Auto-Reverse parameter allows the
administrator to request an automatic creation of the reverse entry;
i.e. if a public to private conversion is specified then setting the auto-
reverse option will trigger the system to automatically create the
private to public number conversion.
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Conversions
The administrator can specify numbering plan specific, business group

wide and system wide entries. If the input type of number indicates a
public number (International) then the output type of number must
indicate a private number (L2, L1 or L0) and vice versa if the input type
of number indicates a private number (L2, L1 or L0) then the output
type of number must indicate a public number (International).
This table allows specifying an input pattern used for matching the
number to be converted and then specifying an output modification
rule and the resulting type of number of the converted output number.
Just like the input pattern of the normalizations table, this input pattern
allows the same wildcards and regular expressions to be used and
contains information on how to split a matching digit string in fields
that can be repeated in the output modification rule.
For each entry in the conversions table, the DNM library automatically
creates an entry for matching an international public number and
converting it to a fully qualified private number (FQPN) and another
entry for matching an FQPN and converting it to an international public
number if the auto-reverse option is used.
The same weighting as used for the DNM Normalization table ensures
that the 498972231212 input pattern entry takes precedence over the
less specific 4989722-31XXX entry which also matches for the given
input number.
The following web services will be implemented from the OSCV

soapServer component to accommodate this new interface's
functionality.
Web Service Description

unsp__CreateDnmConversio Allows the creation of a new DNM Conversion
n entry
unsp__ModifyDnmConversio Allows the modification of an existing DNM
n Conversion entry
unsp__DeleteDnmConversio Allows the deletion of one or more (list) DNM
n Conversion entries
unsp__QueryDnmConversion Allows the retrieval of one or more (list) DNM
Conversion entries
Table 732 DNM Conversion Web Services
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Conversions
13.5.1 Create DNM Conversion

be able to create an entry in the display_number_conversion_t table of
DB through NDM. On success, the specified entry will be created and
an informative message will be returned to the client. On failure, the
error will be returned.

subRC_APP_DNM_CONVERTED_TON_INVALID
subRC_APP_DNM_CONVERSION_ALREADY_EXISTS
subRC_APP_NDM_ERROR
subRC_SUCCESS
Table 733 Create DNM Conversion Return Codes
Field Name Required Description Type Range Default Value

array
DnmConversion Yes This structure has the mandatory fields which define uniquely in the OSCV a
Key DNM Conversion entry. These fields are given below
DnmConversion Yes This structure has all the other fields apart from the key that comprise a DNM
Data Conversion entry. These fields are given below
(DnmConversio Yes The name of the Business Char 30 (0…30) N/A
nKey) Group. Empty XML tag array
‘ANY’
(DnmConversio Yes The name of the Char 30 (0…30) N/A
nKey) Numbering Plan. Empty array
NpName XML tag implies usage of
NP ‘ANY’
Table 734 Create DNM Conversion Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Conversions

(DnmConversio Yes The pattern based on Char 64 (1…64) N/A
nKey) which the input number array
InputPattern will be converted
(DnmConversio Yes The input type of number Enumerat DNM_TON_Internat DNM_TON_Inter
nKey) or ional, national
InputTypeOfNu DNM_TON_L2,
mber DNM_TON_L1,
DNM_TON_L0
(DnmConversio No The converted (output) Enumerat DNM_TON_Internat DNM_TON_L2
nData) type of number or ional,
ConvertedTypeO DNM_TON_L2,
fNumber DNM_TON_L1,
DNM_TON_L0
(DnmConversio Yes This pattern based on the Char 64 (1…64) N/A
nData) inputPattern defines the array
OutputExpressio format of the converted
n number
(DnmConversio No if a public to private Boolean [true|false] false
nData) conversion is specified
AutoReverse then setting the auto-
reverse option will trigger
the system to
automatically create the
private to public number
conversion and vice versa
Table 734 Create DNM Conversion Input Fields (Seite 2 von 2)

Table 735 Create DNM Conversion Output Fields
13.5.2 Modify DNM Conversion

be able to modify an existing entry in the
display_number_conversion_t table of DB through NDM On success,
the specified entry will be modified and an informative message will be
returned to the client. On failure, the error will be returned. Because of
the fact that for a given Business Group and Numbering Plan, different
inputPatterns are allowed to be defined, the search of the existing entry
to be modified is based on the index of it stored in the DB. This index
is returned from the query operation.
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Conversions

subRC_APP_DNM_CONVERTED_TON_INVALID
subRC_APP_DNM_CONVERSION_WAS_NOT_FOUND
subRC_APP_NDM_ERROR
subRC_SUCCESS
Table 736 Modify DNM Conversion Return Codes

array
DnmConversion Yes This structure has the mandatory fields which define uniquely in the OSCV a
Key DNM Conversion entry. These fields are given in the Create DNM Conversion
operation. Only the InputPattern field is modifiable
DnmConversion No The same type as the above. This is used in order to be able to modify the key
ModKey structure. Only the InputPattern field is modifiable
DnmConversion Yes This structure has all the other fields apart from the key that comprise a DNM
Data Conversion entry. These fields are given in the Create DNM Conversion
operation. Note: In case the two optional enumerator fields are not passed
(InputTypeOfNumber, ConvertedTypeOfNumber) (the tag doesn’t exist in the
request), then the old values remain intact. The same goes for the field
(AutoReverse)
Table 737 Modify DNM Conversion Input Fields

Table 738 Modify DNM Conversion Output Fields
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Conversions
13.5.3 Delete DNM Conversion

be able to delete one or more (list) entries of the
display_number_conversion_t table of DB. In case of success an
informative message will be returned. In case of an error, the exact
entry for which the error was raised will be returned along with the
error. Rollback of the entire operation is supported in case an error is
detected, through a flag present in the request (Transactional, please
see below).

subRC_APP_NDM_ERROR
subRC_SUCCESS
Table 739 Delete DNM Conversion Return Codes

array
Table 740 Delete DNM Conversion Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Conversions

Commit/Rollback
field set to False
DeleteDnmConv A list specifying all the entries to be deleted. Each element of the list is of type
ersionList DnmConversionKey described in the Create DNM Conversion operation
Table 740 Delete DNM Conversion Input Fields (Seite 2 von 2)

Table 741 Delete DNM Conversion Output Fields
13.5.4 Query DNM Conversion

be able to retrieve one or more (list) entries of the
display_number_conversion_t table of DB through NDM. In case of
success, the requested object or a series of objects (list) matching the
input filtering criteria (please see below) will be returned. In case of an
error, the error will be returned. This interface will support filtering on
Business Group Name and/or Number Plan Name. Furthermore, this
web service will support paging and sorting; Default sorting will be
based on the weights calculated by NDM for each Conversion entry
stored in DB. Sorting based on Business Group Name or Number Plan
will also be supported.
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Conversions

subRC_APP_NDM_ERROR
subRC_SUCCESS
Table 742 Query DNM Conversion Return Codes

OperatorId Yes I/F operator Char 40 (1..40) N/A
array
ons
ons)
Paging
(Paging)
PageSize
(Paging)
PageNumber
ons) retrieved result set or Sorting, Weights
ghts,
DNM_SortType_Bg
Name,
DNM_SortType_Np
Name

SortOrder
Table 743 Query DNM Conversion Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Local Toll

DnmConversion No This structure has the mandatory fields which define uniquely in the OSCV a
Key DNM Conversion entry. These fields are given in the Create DNM Conversion
operation
For the query operation all fields are optional.
Table 743 Query DNM Conversion Input Fields (Seite 2 von 2)

PaginatedInfo A common paging structure containing Current Page/Number of Pages/Page Number/
Page Size/. Returned only in the case of retrieval of more than one objects.
QueryDnmConvers A list containing the actual Conversion objects stored in DB. Each item of the list is of
ionList type QueryDnmConversionEntry which consists of a part of type DnmConversionKey and
another of type DnmConversionData. Returned only in success.
Table 744 Query DNM Conversion Output Fields
13.6 DNM Local Toll

This is a new table that specifies a list of local exchange codes that are
local within a specified area code and country code and also includes
an indication on whether the area code (AC) needs to be included as
part of the Subscriber level number or not.
The following table shows some examples of numbers presented to the

local toll table and how the table treats the number:
International Number Resulting Number Description

International, 498972211111 International, 498972211111 The country codes don’t match; therefore
the number remains international
International, 15615551212 National, 5615551212 Country code 1 and area code 561 match,
but 555 is not found in the local exchange
code list. Therefore, the output number is
a national number.
International, 15615581212 Subscriber, 5581212 Country code 1 and area code 561 match,
and 558 is found in the local exchange
a subscriber number. The area code is not
part of the subscriber number because the
check box Include AC is not checked.
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Local Toll
International Number Resulting Number Description

International, 19542341111 Subscriber, 9542341111 Country code 1 and area code 954 match,
and 234 is found in the local exchange
a subscriber number. The area code is
part of the subscriber number because the
check box Include AC is checked.
International, 19542221111 National, 9542221111 Country code 1 and area code 954 match,
but 222 is not found in the local exchange
a national number.
Table 745 Local Toll Table Examples
The default rule for a local toll table is that all local exchange codes are
local within the specified area code and country code and that the area
code is not part of the local number. This rule can be specified using
the single wildcard '*' for the list of matching local exchange codes.
No other wildcards or regular expressions are supported on the list of

local exchange codes.
Local Toll tables can be specified system wide or business group

specific.
The exchange codes recorded in a local toll table must all have the
same length. It will be allowed to have multiple local toll exchange
codes entries with the same area code for the same local toll table. E.g.
in the example above it would be allowed to enter another local
exchange codes table with the area code 561.
Local Toll table entries can be assigned to entries in the definitions table
(see 2.2.1.2) with the following restrictions:
• A Local Toll table specified for a specific business group cannot

be assigned to a system wide definition entry. The reason for
this is that system wide definition entries can be seen by every
administrator and administrators of other business groups may
not have access to other business group resources.
• A Local Toll table specified for a specific business group cannot

be assigned to a definition that is specific to another business
group for the same reasons as above.
13.6.1 Create DNM LocalToll

be able to create an entry in the local_toll_t table and one or more
entries in the local_toll_area_exchange_codes_t table of DB through
NDM. On success, the specified entry will be created and an informative
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Local Toll
message will be returned to the client. In case of an error, the exact

entry for which the error was raised will be returned along with the
error. Rollback of the entire operation is supported in case of error
through a flag present in the request (Transactional, please see below).

subRC_APP_DNM_COUNTRY_CODE_INVALID
subRC_APP_DNM_AREA_CODE_INVALID
subRC_APP_DNM_EXCHANGE_CODE_INVALID
subRC_APP_DNM_LOCAL_TOLL_ALREADY_EXISTS
subRC_APP_NDM_ERROR
subRC_SUCCESS
Table 746 Create DNM LocalToll Return Codes

array
DnmLocalTollKe Yes This structure has the mandatory fields which define uniquely in the OSCV a
y DNM LocalToll entry. These fields are given below
(DnmLocalTollKe Yes The name of the Business Char 30 (1…30) N/A
y) Group. Empty XML tag array
‘ANY’
(DnmLocalTollKe Yes The name of the Local Toll Char 30 (1…30) N/A
y) Entry array
LocalTollName
(DnmLocalTollD No The Country Code of the Char 16 (1…16) N/A
ata) entry array
CountryCode
(DnmLocalTollD No Area code of the Entry Char 16 (1…16) N/A
ata) array
HomeAreaCode
Table 747 Create DNM LocalToll Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Local Toll

(DnmLocalTollD No Exchange code of the Char 10(1… 10) N/A
ata) entry array
HomeExchange
Code
(DnmLocalTollD No International Traffic Type String
ata)
TTInternational
(DnmLocalTollD NO Long Distance Traffic Type String
ata)
TTLongDistance
(DnmLocalTollD NO Extended Calling Area string
ata) Traffic Type
TTExtendedCalli
ngArea
(DnmLocalTollAr No Dialing Pattern Enum DNM_DP_Unknown, DNM_DP_Unkno
eaCodeList) determination DNM_DP_National, wn
DialPattern DNM_DP_Subscribe
rWithAreaCode,
DNM_DP_Subscribe
r
DnmLocalTollAre Yes A list consisting of one or more items of type DnmLocalTollAreaCodeElement
aCodeList specifying the Area Code with its Exchange Codes defined for this entry
(DnmLocalTollAr Yes The Area Code of this Char 16 (1…16)
eaCodeList) entry array
AreaCode
(DnmLocalTollAr Yes The first Local Exchange Char 6 (1…6)
eaCodeList) Code element of a possible array
FirstLocalExcha list that would follow. If
ngeCode this is the special character
‘*’ the list should be
empty. This entry is unique
for a specific area code
inside a Local Toll Entry
(DnmLocalTollAr No The area code field needs Boolean [true|false]
eaCodeList) to be included as part of
IncludeAreaCod the Subscriber level
e number (true) or not
(false)
(DnmLocalTollAr No A list of comma or space Char 2500 (0…2500)
eaCodeList) separated digit strings array
LocalExchangeC
odes
(DnmLocalTollAr No Dialing Pattern Enum
eaCodeList) determination DNM_DP_Unknown,
DialPattern DNM_DP_National,
DNM_DP_SubscriberWithAreaCode,
DNM_DP_Subscriber
Table 747 Create DNM LocalToll Input Fields (Seite 2 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Local Toll

Table 748 Create DNM LocalToll Output Fields
13.6.2 Modify DNM LocalToll

be able to modify an existing entry in the local_toll_t table of DB
through NDM. On success, the specified entry will be modified and an
informative message will be returned to the client. On failure, the error
will be returned.The LocalExchangeCodes list will actually be deleted
and created will the new entries specified in the modification request.
If the list containing the LocalExchangeCodes.

subRC_APP_DNM_AREA_CODE_INVALID
subRC_APP_DNM_EXCHANGE_CODE_INVALID
subRC_APP_DNM_LOCAL_TOLL_WAS_NOT_FOUND
subRC_APP_NDM_ERROR
subRC_SUCCESS
Table 749 Modify DNM LocalToll Return Codes

array
Table 750 Modify DNM LocalToll Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Local Toll

DnmLocalTollKe Yes This structure has the mandatory fields which define uniquely in the OSCV a
y DNM Local Toll entry. These fields are given in the Create DNM Local Toll
operation.
DnmLocalTollMo No The same type as the above. Contains the new possible key for this object. All
dKey but the BgName field are modifiable
DnmLocalTollAre Yes A list consisting of one or more items specifying the new Area Code objects
aCodeList along their Local Exchange Codes defined for this entry. This type is given in
the Create DNM Local Toll operation.
ata)
TTInternational
ata)
TTLongDistance
ata) Traffic Type
TTExtendedCalli
ngArea
Table 750 Modify DNM LocalToll Input Fields (Seite 2 von 2)

Table 751 Modify DNM LocalToll Output Fields
13.6.3 Delete DNM LocalToll

be able to delete one or more (list) entries of the local_toll_t table of
DB. All the etries from local_toll_area_echange_codes_t table having
references to the one that is deleted from local_toll_t table will be
deleted also. In case of success an informative message will be
returned. In case of an error, the exact entry for which the error was
raised will be returned along with the error. Rollback of the entire
operation is supported in case of an error through a flag present in the
request (Transactional, please see below).
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Local Toll

subRC_APP_NDM_ERROR
subRC_SUCCESS
Table 752 Delete DNM LocalToll Return Codes

array
Commit/Rollback
field set to False
DeleteDnmLocal A list specifying all the entries to be deleted. Each element of the list is of type
TollList DnmLocalTollKey which is given in the Create DNM Local Toll operation
Table 753 Delete DNM LocalToll Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Local Toll

Table 754 Delete DNM LocalToll Output Fields
13.6.4 Query DNM LocalToll

be able to retrieve one or more (list) entries of the local_toll_t table of
DB through NDM. In case of success, the requested object or a series
of objects (list) matching the input filtering criteria (please see below)
will be returned. In case of an error, the error will be returned. This
interface will support filtering on Business Group Name. Furthermore,
this web service will support paging and sorting on Business Group
Name.

subRC_APP_NDM_ERROR
subRC_SUCCESS
Table 755 Query DNM Local Toll Return Codes

OperatorId Yes I/F operator Char array 40 (1…40)
ons
Table 756 Query DNM Local Toll Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Number Modification
DNM Local Toll

ons)
Paging
(Paging)
PageSize
(Paging)
PageNumber
ons) retrieved result set or Sorting, NoSorting
Name

SortOrder
DnmLocalTollKe No This structure has the mandatory fields which define uniquely in the OSCV a
y DNM Local Toll entry. These fields are given in the Create DNM Local Toll
operation
For the query operation all fields are optional
ata)
TTInternational
ata)
TTLongDistance
ata) Traffic Type
TTExtendedCalli
ngArea
Table 756 Query DNM Local Toll Input Fields (Seite 2 von 2)

Table 757 Query DNM Local Toll Output Fields
A31003-H80A0-T101-1-7618, 11/2021
soap_ext_interfaces_fp.fm
Feature Profiles
Create Feature Profile
14 Feature Profiles
Feature Profiles contain a set of features grouped together that can be
assigned to subscribers for inheriting the features. It allows the scale
of inheriting features to be more flexible and not controlled by the
Business Group. It also adds the Modify subscribed status to update
individual feature data. See Section 4.2, “Feature Profiles”, on page 44.
14.1 Create Feature Profile

This method creates a feature profile.
Once created, the Feature Profile Id, Feature Profile Type, and Feature
Profile Connection Type cannot be changed.

WSDL Version
10.00.03.01 subRC_APP_FP_NAME_LEN_INVALID
subRC_APP_FP_ALREADY_EXIST
subRC_APP_FP_BG_NAME_TYPE_CONFLICT
subRC_DB_FP_INSERTION_FAILED
Comments: 10.00.03.01 – added the Feature Profile Connection Type.
Table 758 CreateFeatureProfile Return Codes

on page 78.
ID
Feature Profile
Name
Table 759 CreateFeatureProfile Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Feature Profiles
Update Feature Profile

FeatureProfileTy Governs the set of features Enum FeatureProfileResidential, FeatureProfileR
pe and types of subscribers FeatureProfileCentrex esidential
allowed to assign to the
feature profile.
FeatureProfileCo Determines whether the Enum ConnectionTypeNA, Connection
nnection profile is applicable for which ConnectionTypeSIP, TypeNA –
Type connection type. ConnectionTypeMGCP applies to all
Note that normally a connection
connection type other than types.
ConnectionTypeNA should be
provided. ConnectionTypeNA
is not recommended to be
used in a live environment
since the mixture of
subscribers with different
connection types in the same
Feature Profile may result in
inconsistencies if features are
assigned that only apply to
one or the other.
ConnectionTypeMGCP is not
for OpenScape Voice.
ListofFeatures List of features to assign to Structure List of valid features Null
the Feature Profile
Table 759 CreateFeatureProfile Input Fields (Seite 2 von 2)
14.2 Update Feature Profile

This method modifies the features associated with a feature profile.
Once created, the Feature Profile Id, Feature Profile Name, Feature
Profile Type, and Feature Profile Connection Type cannot be changed.
Only the features for the Feature Profile are to be updated.

WSDL Version
Table 760 UpdateFeatureProfile Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Feature Profiles
Delete Feature Profile

on page 78.
ID
(FeatureProfile The new name of the feature Please optional (FeatureProfile
ID) profile refer to ID)
NewFeature Section NewFeature
Profile 5.4, Profile
Name Name
Feature Profile
Name
ListofFeatures List of features to assign to Structure List of valid features Null.
the Feature Profile
Comments: All the subscribers associated with the Feature Profile will be updated for the inheritance if
the Feature Profile is updated successfully.
Table 761 UpdateFeatureProfile Input Fields
14.3 Delete Feature Profile

This method deletes the specified feature profile. A feature profile may
not be deleted if it is referenced by a subscriber. The GetSubscriberList
may be used to obtain information about subscribers that reference a
Feature Profile

WSDL Version
subRC_APP_FP_DOES_NOT_EXIST
subRC_DB_FP_DELETE_FAILURE
subRC_APP_FP_DELETION_FAILED
subRC_APP_FEAT_IN_PROFILE_NAME_DOES_NOT_EXIST
subRC_DB_FEAT_IN_PROFILE_NAME_LOOKUP_FAILED
subRC_DB_FP_DELETE_FAILURE
Table 762 DeleteFeatureProfile Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Feature Profiles
Get Feature Profile List

on page 78.
ID
Feature Profile
Name
Comments: The feature profile cannot be deleted if there is any reference to it.
Table 763 DeleteFeatureProfile Input Fields
14.4 Get Feature Profile List

This method retrieves a list of all feature profiles on the OpenScape
Voice system.

WSDL Version
subRC_SYS_FP_ALLOC_ERR
subRC_DB_FP_LIST_SWITCH_WIDE_FAILED
subRC_DB_FP_LIST_LOOKUP_FAILED
subRC_SYS_FP_ALLOC_ERR
Table 764 GetFeatureProfileList Return Codes
Field Name Description Length Range/ Default

Values Value
Paging Paging structure for Get List requests. For further N/A
details, see Section 5.5, “Paging”, on page 86.
BGName Business Group Name. Refer to Section 5.4, ““
“Primitive Data Definitions”, on page 78 for
further details.
Table 765 GetFeatureProfileList Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Feature Profiles
Get Feature Profile
Field Name Description Length Range/ Default

Values Value
FeatureProfileNa Feature profile name. Refer to Section 5.4, ““
me “Primitive Data Definitions”, on page 78 for
further details.
CombinedList Indicator to combine the switchwide and BG Boolean True, False False
profile for retrieving the profile list.
BGName CombinedList RetrievalList
NIL True Switchwide +
all BGs profile
list.
NIL False Switchwide
List
Bg Name True Switchwide +
BG-specific
profile list
Bg Name False BG-specific
profile list
FProfileListSortT Defines the FP attribute to be used for sorting enum FPSortTypeFPN FPSortTypeF
ype results (currently only FPName is supported) ame_ PName_
SortOrder Defines the order by which results will be enum SortOrderAsce SortOrderAs
returned nding, cending
SortOrderDesc
ending
Table 765 GetFeatureProfileList Input Fields (Seite 2 von 2)
14.5 Get Feature Profile

This method retrieves the details of one feature profile. The
GetSubscriberList may be used to obtain information about subscribers
that reference a Feature Profile.

WSDL Version
subRC_SYS_FP_AUTH_CODE_ALLOC_ERR
subRC_DB_FP_LOOKUP_FAILED
Table 766 GetFeatureProfile Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Feature Profiles
Get Feature Profile

on page 78.
NewFeature Identifies the Feature Profile; comprises the Feature Profile Name and the BGName.
ProfileID
Feature Profile
Name
Table 767 GetFeatureProfile Input Fields
A31003-H80A0-T101-1-7618, 11/2021
soap_ext_interfaces_mlhg.fm
Hunt Groups
15 Hunt Groups
The OpenScape Voice system supports Hunt Groups (MLHG). An Hunt
Group is a collection of phones that have a common pilot directory
number (Pilot DN) and specific processing. An Hunt Group is identified
by its Pilot DN.
A subscriber or BGL can be a member of multiple Hunt Groups. In this

case, one Hunt Group is designated as the primary Hunt Group. If
subscriber S is a member of Hunt Group A and is also the Pilot DN of
Hunt Group B, hunting through Hunt Group B takes place only if
subscriber S is called directly, not if the call is presented to subscriber
S as a result of hunting after an incoming call to Hunt Group A's Pilot
DN. When a subscriber or BGL is a member of multiple Hunt Groups
and its primary Hunt Group is removed, the member’s primary Hunt
Group designation is updated to refer to one of the still existing Hunt
Groups (the next one in chronological order in which the member was
added to the Hunt Groups).
Hunt Groups can consist of residential phones or BG phones, but not a

combination within a single Hunt Group.
The DN to be used as a Hunt Group Pilot DN or a Hunt Group terminal

DN must be created as a subscriber before being converted into a Hunt
Group Pilot or terminal. The subscriber can have a connection (phone).
If the Hunt Group Pilot subscriber has a phone, then that phone is the
master phone for the Hunt Group and controls the Hunt Group services
(CFB, CFDA, and so on). If the subscriber does not have any connection
info, then the Hunt Group is just a container with its service features.
Service features can be applied to the Hunt Group Pilot DN or an Hunt

Group Member (DN). When a caller calls a subscriber that is an Hunt
Group Pilot DN, the services of the Pilot DN (with some exceptions) are
executed — not the services of the member or terminal to which the
call actually hunts and terminates to. On the other hand, when a caller
directly calls a subscriber that is a member of one or more Hunt
Groups, the subscriber's services are executed and not those of any
Hunt Group of which the subscriber may be a member.
An exception to the above statement is Keyset Operation. A
subscriber can be a keyset phone and also be a member of a Hunt
Group. In this case, it is desirable that when an incoming call
reaches a keyset Hunt Group member via hunting, the call should
be presented to all devices where the subscriber has a line
appearance. To accomplish this, it is necessary for the Hunt Group
service to start the keyset service on each individual Hunt Group
member, if it is a keyset subscriber, and also to stop the service if
the No Advance timer expires and hunting must continue.
A31003-H80A0-T101-1-7618, 11/2021
Hunt Groups
Terminals
Outgoing calls, which some exceptions, invoke the subscriber's

features, and not those of the Hunt Group.
The OpenScape Voice system can support 25K Hunt Groups and 150K
terminals system-wide. Each Hunt Group can have up to 2000
terminals. The maximum queue size for an Hunt Group is 511.
15.1 Terminals
MemberServiceId – represents a phone within a Hunt Group. It
must be an E164 DN.
The MLHG contains a list of phones in a specified order, as well as the

following attributes:
Position – Terminals are in an ordered list. When inserting and/or
moving a terminal in the list, 1 indicates that the terminal should be
inserted in the first position (at the head of the list) 0, negative, a
number greater than the list size, or no position specified, indicates
that the terminal is to be inserted at the end of the list. Any other
number indicates the position to insert the terminal into. For Master
Hunt Groups, a terminal is not allowed to be assigned to position 1.
Also, the Pilot of the Master Hunt group is only allowed to be
assigned to position 1.
MlhgMakeBusyStatus – indicates whether the subscriber has
marked the phone as busy and not available for new incoming calls.
If not defined, defaults to NotBusy.
MlhgStopHuntStatus – indicates whether the subscriber has
marked the phone as StopHunt and that new incoming calls should
not keep searching for an open phone beyond this one. If not
defined, defaults to NotStopHunt.
StopHuntSubControlled – indicates whether the terminal
(phone) is capable of controlling its StopHunt Status. This
information is common to all Hunt Groups that the terminal is part
of. Thus, changing this setting for the terminal in one Hunt Group
will change this capability of the terminal in all Hunt Groups that the
terminal is part of. If not specified when adding the terminal to a
Hunt Group, it defaults to false and updates any existing capability
to false.
MakeBusySubControlled – indicates whether the terminal
(phone) is capable of controlling its MakeBusy Status. This
information is common to all Hunt Groups that the terminal is part
of. Thus, changing this setting for the terminal in one Hunt Group
changes this capability in all Hunt Groups that the terminal is part
of. If not specified when adding the terminal to a Hunt Group, it
defaults to false and updates any existing capability to false.
A31003-H80A0-T101-1-7618, 11/2021
Hunt Groups
Hunt Group Phone Services
15.2 Hunt Group Phone Services

Some services are not supported for provisioning to Hunt Group Pilot
DNs and/or Hunt Group members. Table 768 lists these services,
where X indicates that the feature IS NOT supported.
Service Feature MLHG Pilot MLHG Member

CW — Call Waiting X
CCW — Cancel Call Waiting X
CIDCW — Calling Identity Delivery on Call Waiting X
CSTA — ComAssistant X (but see below)
SRS — Simultaneous Ringing X
RFA — Remote Feature Access (Supports configuration of SRS) X
SERRNG — Serial Ringing X
RCF — Remote Call Forward X X
HotDesk — Hot Desking X X
Table 768 Services that Cannot be Provisioned for MLHG Pilot DNs and MLHG Members
If an attempt is made to assign any of the features listed above to a

Hunt Group Pilot DN (or, in the case of RCF or HotDesk, to a Hunt Group
member), the request is rejected. Likewise, an attempt to create a
Hunt Group using an existing subscriber or BGL as the Pilot DN will fail
if the existing DN already has one or more of the above features
subscribed as AddReplace or Inherited. If the DN is denied the feature,
the Hunt Group can be created.
The Speed Calling services (SPCALL and BgSPCALL) are allowed for
Hunt Group Pilot DNs. The user should bear in mind, however, that
these services can be used only if the Hunt Group Pilot DN is also a
Hunt Group Member, or terminal. So, while a Speed Calling list can be
assigned to a nonterminal Pilot DN, is cannot be used by other Hunt
Group Members.
CT (Call Transfer) service is allowed for both Hunt Group members and
Pilot DNs, but it must be assigned to both the Hunt Group member and
the Pilot DN in order to function properly for the Hunt Group member.
For CSTA (ComAssistant), a special situation exists. It is possible to

assign the CSTA service to a Hunt Group Pilot DN only if it is not also a
Hunt Group Member, or terminal. When a Hunt Group is created with a
Pilot DN that has connection info, it is automatically also added as a
terminal. Therefore, in order to assign the CSTA service to a Hunt
Group Pilot DN, the DN must be a profile-only subscriber (having no
connection info).
A31003-H80A0-T101-1-7618, 11/2021
Hunt Groups
The SOAP Server provides the capability for the operator to create a
Hunt Group using and existing subscriber/BGL as the Pilot DN. The
interface also allows the operator to delete and update Hunt Groups,
as well as to add an existing subscriber/BGL as a member (terminal) of
a Hunt Group and update the attributes for each member.
15.2.1 Create Mlhg

This method creates a Hunt Group.

WSDL Version
10.00.01.181 subRC_APP_MLHG_PILOT_DN_LEN_INVALID
10.00.01.192 subRC_APP_MLHG_PILOT_DN_INVALID
subRC_APP_MLHG_EXTERNAL_DN_LEN_INVALID
subRC_APP_MLHG_OVERFLOW_DN_LEN_INVALID
subRC_APP_MLHG_MAX_QUEUE_SIZE_OUT_OF_RANGE
subRC_APP_MLHG_CONF_QUEUE_SIZE_OUT_OF_RANGE
subRC_APP_MLHG_MAX_CONF_QUEUE_SIZE_CONFLICT
subRC_APP_MLHG_NO_ANS_ADV_TIME_INVALID
subRC_APP_MLHG_AUTO_MAKE_BUSY_NO_ANS_ADV_TIME_CONF
LICT
subRC_APP_MLHG_INTERCEPT_LEN_INVALID
subRC_APP_MLHG_NIGHT_SVC_DN_LEN_INVALID
subRC_APP_MLHG_MAX_TIME_QUEUE_OUT_OF_RANGE
subRC_APP_MLHG_NIGHT_SVC_DN_MANUAL_CONFLICT
subRC_APP_MLHG_NIGHT_SVC_AUTO_STATUS_INVALID
subRC_APP_MLHG_POST_CALL_TIMER_INVALID
subRC_APP_MLHG_PILOT_DN_DOES_NOT_EXIST
subRC_APP_MLHG_PILOT_DN_H323_CONFLICT
subRC_APP_MLHG_PILOT_DN_TERM_CONFLICT
subRC_APP_MLHG_PILOT_DN_EXIST
subRC_APP_MLHG_PILOT_DN_PARENT_TEEN_CONFLICT
subRC_APP_MLHG_PILOT_DN_FEATURE_CONFLICT
subRC_APP_MLHG_PILOT_DN_CONNECTION_CSTA_CONFLICT
subRC_APP_MLHG_OVERFLOW_DN_INVALID
subRC_APP_MLHG_NIGHT_SVC_DN_INVALID
subRC_APP_MLHG_PILOT_DN_BG_ID_CONFLICT
subRC_APP_MLHG_MANUAL_HUNT_CSTA_CONFLICT
subRC_DB_MLHG_INSERTION_FAILED
subRC_DB_MLHG_OFFICE_CODE_LOOKUP_FAILED
subRC_DB_MLHG_HOME_DN_ASSIGN_FAILED
subRC_DB_MLHG_INSERTION_FAILED
Table 769 Create Mlhg Return Codes (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Hunt Groups

WSDL Version
V5.00.20.01 subRC_APP_MLHG_PILOT_DN_OSMO_CONFLICT
1Added attributes introduced for FRN0124 and FRN0944.
2
Added TMStatus, introduced for FRN0617.
Table 769 Create Mlhg Return Codes (Seite 2 von 2)

BgName Business Group Name. See definition of BGName in Section 5.4,
Mandatory if the “Primitive Data Definitions”, on page 78.
PilotServiceId is a BGL.
on page 78.
PilotServiceId The DN of the subscriber/BGL See definition of ServiceId in Section 5.4, N/A
that represents the Pilot DN “Primitive Data Definitions”, on page 78.
of the MLHG. That is, the
number that when dialed will
cause hunting through the
MLHG members to take place.
BOName Branch Office Name to be char 0…30 Must coincide
associated with MLHG with BOName of
V7.00.01.09 the Pilot DN.
Table 770 Create Mlhg Input Fields (Seite 1 von 5)
A31003-H80A0-T101-1-7618, 11/2021
Hunt Groups

HuntType The type of hunting algorithm enum Linear Linear
used by the MLHG to CircularWithHunt
determine which MLHG UCD
member should be presented Manual
with incoming calls to the Parallel
Pilot DN.
Notes:
Linear: The default hunting
method, in which each MLHG
terminal is checked in
sequence for one pass only.
CircularWithHunt: more
properly referred to as
CircularWithMemory.
UCD: Uniform Call
Distribution. Indicates that an
ordered list of idle terminals
is maintained and calls are
presented to those that have
been idle the longest.
Manual: Indicates that calls
are not presented
automatically; rather, agents
must view calls via the
CallManager application and
manually select which calls to
process.
Parallel: All available
members of the Hunt Group
are alerted simultaneously
whenever a new call arrives
at the Hunt Group.
OverFlowDN Specifies the destination of See definition of ServiceId in “”
unanswered incoming calls Section 5.4, “Primitive Data
when the queue is full. This Definitions”, on page 78.
DN can be an E164DN or a
private extension if this MLHG
is part of a BG. If not
specified, received calls that
cannot be queued receive
busy treatment. Optional.
ConfQueue Indicates the number of calls integer 0..MaxQueueSize MaxQueueSize
Size that may be queued waiting
for an available phone
(terminal). If not specified,
the default value is
MaxQueueSize.
A31003-H80A0-T101-1-7618, 11/2021
Hunt Groups

MaxQueue Indicates the maximum integer 0..511 0
Size number of calls that may be
queued waiting for an
available phone (terminal).
This parameter can be
configured by the telco and
sets a hard limit of the queue
size.
CallingParty Indicates which calling enum PilotDN UseLineAnd
Source number should be used on UseLineAndPilotDN PilotDN
outgoing calls from a device Note: PilotDN option is
that is a terminal in the currently not supported. Hunt
MLHG. Group will function according
to UseLineAndPilotDN option,
regardless of the chosen
setting.
NoAnsAdv Indicates the time for which a integer 5..3600 (seconds) 29
Time terminal will ring before the
hunting algorithm moves on
to continue searching for the
next available terminal.
Intercept Indicates the configured 0..15 Character string – must MLHG_Default
Annoncement intercept announcement that represent a valid intercept.1
Id is to be played when an
incoming call is queued
because no terminals are
available. Optional
NoInterceptAnn When set to True, no Boolean True, False False
ouncement announcement is provided
from the OSV platform media
server toward the queued
party. Instead the queued
party will hear local ringback
provided by the network or
NightService The directory number to See definition of ServiceId in “”
DN which calls are diverted when Section 5.4, “Primitive Data
the Night Service feature is Definitions”, on page 78.
active. If provided, the SOAP
Server validates the DN via a
translation routine to ensure
that it is routable at the time
of provisioning. If it is not
routable, the request is
rejected. Optional.
A31003-H80A0-T101-1-7618, 11/2021
Hunt Groups

MaxTimeIn Monitors the time in queue for integer 0..43200 0
Queue calls to the MLHG. When the
actual time exceeds the
provisioned value and other
conditions are met, the
queued call is removed and
routed to the OverflowDN, if
any. If there is no
OverflowDN, the call is routed
to the Night Service DN, if
any. If there is no Night
Service DN, the call receives
busy tone.
If not provided, the default is
0, which is interpreted by call
processing to mean that the
value is not provisioned and a
queued call will remain in the
queue indefinitely.
NightService Enables the operator to Boolean True, False False
ManualStatus manually activate Night
Service.
PostCallTimer Number of seconds to pause integer 0..43200 0
after each call before
presenting next call to same
agent. If not provided, the
default value of 0 is used,
which indicates that there
shall be no post call pause.
Note that this value is ignored
if the HuntType is Manual.
Optional.
TMStatus Enables the operator to Boolean True, False False
enable or disable Traffic
Measurements for this MLHG.
InQueueInterru Specifies the intercept to be 0..15 Character string – must MLHG_Q_Pos
ptIntercept played to callers in the represent a valid intercept.1
MLHG’s queue periodically
after the number of seconds
specified in the
InQueueInterruptTime.
NOTE: This attribute is not
supported for Version 2.2
WSDL versions!
A31003-H80A0-T101-1-7618, 11/2021
Hunt Groups

IsMlhgRerouting This attribute can be Boolean True, False False
Allowed provisioned to allow or deny
subscriber rerouting. If the
MLHG is provisioned to allow
subscriber rerouting, the
Subscriber rerouting will only
take place for MLHG members
that are provisioned for
subscriber rerouting
SendPilotDisplay Controls whether the Boolean True, False False
OpenScape Voice sends the
Pilot’s display information to
the Hunt Group members for
hunted calls
isMlhgEnhanced Controls whether Enhanced Boolean True, False False
RerouteAllowed Subscriber Rerouting is
allowed in case a distributed
call to a Hunt Group member
is rejected due to Call
Admission Control. The
default value for this
parameter shall be disabled.
OverflowDnNoR Defines an Overflow String
erouting destination in case a
distributed call to the Hunt
Group member is rejected
due to Call Admission Control
or WAN Failure AND
Subscriber Rerouting
(Enhanced or Basic) either
fails or is not allowed.
AllowCallsToOve Controls the Conditional / Boolean True, False False
rflow Unconditional routing. If this
option is active then
Unconditional routing
is invoked, else Conditional
routing is invoked.
AllowUnanswere Determines if call continues Boolean True, False False
dCallsToRequeu to ring last member or placed
e in the queue. If there is no
queue the only "No Answer"
option invoked is for ring last
member.
List”).
A31003-H80A0-T101-1-7618, 11/2021
Hunt Groups
15.2.2 Modify Mlhg Info

This method adds, removes, and updates Hunt Group info.

WSDL Version
10.00.01.181 subRC_DB_MLHG_LOOKUP_FAILED
10.00.01.192 subRC_DB_MLHG_PILOT_DN_LOOKUP_FAILED
subRC_APP_MLHG_MANUAL_HUNT_CSTA_CONFLICT
subRC_APP_MLHG_HUNT_TYPE_INVALID
1Added attributes introduced for FRN0124 and FRN0944.
2Added TMStatus, introduced for FRN0617.
Table 771 Modify Mlhg Info Return Codes

on page 78.
associated with MLHG with BOName of
V7.00.01.09 the Pilot DN.
Table 772 Modify Mlhg Info Input Fields (Seite 1 von 5)
A31003-H80A0-T101-1-7618, 11/2021
Hunt Groups

with incoming calls to the LinearUnconditional
Pilot DN. Parallel
Notes:
Linear: The default hunting
method, in which each MLHG
terminal is checked in
sequence for one pass only.
CircularWithHunt: is more
CircularWithMemory.
UCD: Uniform Call
Distribution. This indicates
that an ordered list of idle
terminals is maintained and
calls are presented to those
that have been idle the
longest.
Manual: Indicates that calls
are not presented
automatically; instead,
agents must view calls via the
CallManager application and
manually select which calls to
process.
LinearUnconditional: Calls are
immediately routed to the
overflow destination if the
hunting passes the last group
member.
Parallel: All available
members of the Hunt Group
are alerted simultaneously
whenever a new call arrives
at the Hunt Group
OverFlowDN Specifies the destination of See definition of ServiceId in Section 5.4, N/A
unanswered incoming calls “Primitive Data Definitions”, on page 78.
when the queue is full. This
DN can be an E164DN or a
is part of a BG. If not
specified, received calls that
cannot be queued receive
busy treatment. Optional.
A31003-H80A0-T101-1-7618, 11/2021
Hunt Groups

ConfQueue Indicates the number of calls integer 0..MaxQueueSize N/A
(terminal). If not specified,
the default value is
MaxQueueSize.
MaxQueue Indicates the maximum integer 0..511 N/A
size.
CallingParty Indicates which calling enum PilotDN N/A
Source number should be used on UseLineAndPilotDN
outgoing calls from a device Note: PilotDN option is
that is a terminal in the currently not supported. Hunt
MLHG. Group will function according
to UseLineAndPilotDN option,
regardless of the chosen
setting.
NoAnsAdv Indicates the time for which a integer 5..3600 (seconds) N/A
Intercept Indicates the configured 15 Character string – must N/A
Id is to be played when an
available. Optional.
NightService The directory number to See definition of ServiceId in Section 5.4, N/A
DN which calls are diverted when “Primitive Data Definitions”, on page 78.
the Night Service feature is
active. If provided, the SOAP
Server validates the DN via a
translation routine to ensure
that it is routable at the time
of provisioning. If it is not
routable, the request is
rejected. Optional.
AutoMakeBusy Indicates whether DNs in Boolean True, False N/A
MLHG are marked busy on
auto advance timer expiry.
A31003-H80A0-T101-1-7618, 11/2021
Hunt Groups

MaxTimeIn Used to monitor the time in integer 0..600 N/A
Queue queue for calls to the MLHG.
When the actual time exceeds
the provisioned value and
other conditions are met, the
routed to the OverflowDN, if
any. If there is no
OverflowDN, the call is routed
to the Night Service DN, if
any. If there is no Night
Service DN, the call receives
busy tone.
If not provided, the default is
0, which is interpreted by call
processing to mean that the
value is not provisioned and a
queued call will remain in the
queue indefinitely.
NightService Enables the operator to Boolean True, False N/A
ManualStatus manually activate Night
Service.
PostCallTimer Number of seconds to pause integer 0..120 N/A
agent. If not provided, the
default value of 0 is used,
which indicates that there
shall be no post call pause.
Note that this value is ignored
if the HuntType is Manual.
Optional.
TMStatus Enables the operator to Boolean True, False N/A
enable or disable Traffic
Measurements for this MLHG.
InQueueInterru Specifies the time interval integer 0, 30..180 N/A
ptTime after which the InQueue
InterruptIntercept
announcement (if one is
provisioned) will be played to
callers in the MLHG’s queue.
Note that the default value of
0 indicates that the
announcement shall never be
played.
InQueueInterru Specifies the intercept 0..15 Character string – must N/A
ptIntercept announcement to be played represent a valid intercept.1
to callers in the MLHG’s queue
periodically after the number
of seconds specified in the
A31003-H80A0-T101-1-7618, 11/2021
Hunt Groups

IsRoutingAllowe This attribute can be Boolean True, False False
d provisioned to allow or deny
subscriber rerouting will only
hunted calls
OverflowDnNoR Define san Overflow String
or WAN Failure AND
routing is invoked.
member.
1The list of valid existing intercepts is available using the GetInterceptList SOAP request (refer to Section 7.8, “Get
Intercept List”).
A31003-H80A0-T101-1-7618, 11/2021
Hunt Groups
15.2.3 Delete Mlhg

This method deletes the specified Hunt Group.

WSDL Version
subRC_APP_MLHG_TERMS_EXIST
subRC_APP_MLHG_TERM_DELETION_FAILED
Table 773 Delete Mlhg Return Codes

on page 78.
RemoveMlhg Indicates that all existing Boolean True, False False
Terms terminals in this MLHG shall
be removed from the MLHG.
If any terminals exist and this
attribute is false, the MLHG
deletion is rejected with an
appropriate error message to
the operator.
Table 774 Delete Mlhg Input Fields
15.2.4 Get Mlhg Info

This method retrieves information about a Multi-Line Hunt Group.
A31003-H80A0-T101-1-7618, 11/2021
Hunt Groups

WSDL Version
04.04.07 subRC_APP_MLHG_PILOT_DN_LEN_INVALID
subRC_APP_MLHG_PILOT_DN_INVALID
subRC_APP_MLHG_PILOT_DN_BG_ID_CONFLICT
Table 775 Get Mlhg Info Return Codes

on page 78.
associated with MLHG with BOName
V7.00.01.09 of the Pilot DN.
RepresentativeE V7.00.01.09 char 1-16 Optional

ndpointName The representative endpoint
is the endpoint that is
configured as the associated
endpoint for all subscribers
and endpoints of the branch
office. With this association,
the subscribers and endpoints
of the branch office are
logically tied together. For
branch offices with a
survivable proxy, following
the proxy registration model,
the representative endpoint is
the configured survivable
proxy endpoint. For branch
offices with a survivable
gateway, following the dual
registration model, the
representative is the
configured survivable
gateway endpoint.
AssociatedEndp V7.00.01.09 char 4 octets Optional
ointIP The associated Endpoint IP
Address
Table 776 Get Mlhg Info Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Hunt Groups

GetMlhgInfo Currently, the only option Array of IncludeMlhgTermList Empty array
OptionList supported is enum
IncludeMlhgTermList, which
indicates that the list of MLHG
terminals and their attributes
shall be displayed along with
the MLHG info.
IsRoutingAllowe This attribute can be Boolean True, False False
d provisioned to allow or deny
Table 776 Get Mlhg Info Input Fields (Seite 2 von 2)

BgName Business Group Name.
Mandatory if the DN to be
used as the Pilot DN is a BGL.
For more information, refer to
OperatorId Refer to Section 5.4,
on page 78.
PilotServiceId The DN of the subscriber/BGL See definition of ServiceId in N/A
that represents the Pilot DN Section 5.4, “Primitive Data
of the MLHG – that is, the Definitions”, on page 78.
Table 777 Get Mlhg Info Output Fields (Seite 1 von 5)
A31003-H80A0-T101-1-7618, 11/2021
Hunt Groups

with incoming calls to the LinearUnconditional
Pilot DN. Parallel
Notes:
• CircularWithHunt: is more
CircularWithMemory.
• UCD: Uniform Call
Distribution. This indicates
that an ordered list of idle
terminals is maintained
and calls are presented to
those that have been idle
the longest.
• Manual: Indicates that
calls are not presented
automatically; instead,
agents must view calls via
the CallManager
application and manually
select which calls to
process.LinearUncondition
al: Calls are immediately
routed to the overflow
destination if the hunting
passes the last group
member.
• Parallel: All available
members of the Hunt
Group are alerted
simultaneously whenever a
new call arrives at the Hunt
Group
OverFlowDN Specifies the destination of See definition of ServiceId in “”
unanswered incoming calls Section 5.4, “Primitive Data
when the queue is full. This Definitions”, on page 78.
DN can be an E.164DN or a
is part of a BG.
ConfQueue Indicates the number of calls integer 0..MaxQueueSize N/A
(terminal).
A31003-H80A0-T101-1-7618, 11/2021
Hunt Groups

MaxQueue Indicates the maximum integer 0..511 N/A
size.
CallingParty Indicates which calling enum PilotDN N/A
Source number should be used on UseLineAndPilotDN
outgoing calls from a device
that is a terminal in the
MLHG.
NoAnsAdv Indicates the time for which a integer 5..3600 (seconds) N/A
Intercept Indicates the configured 15 Character string; must N/A
Id will be played when an
available.
NightService The directory number to See definition of ServiceId in N/A
DN which calls are diverted when Section 5.4, “Primitive Data
the Night Service feature is Definitions”, on page 78.
active.
AutoMakeBusy Indicates whether DNs in Boolean True, False N/A
MLHG are marked busy on
auto advance timer expiry.
MaxTimeIn Monitors the time in queue for integer 0..600 N/A
Queue calls to the MLHG. When the
actual time exceeds the
provisioned value and other
conditions are met, the
routed to the Night Service
DN.
NightService Indicates whether Manual Boolean True, False N/A
ManualStatus Night Service is currently
active.
NightService Display only. Indicates Boolean True, False N/A
AutomaticStatus whether Automatic Night
Service is currently active.
PostCallTimer Number of seconds to pause integer 0..120 N/A
agent.
A31003-H80A0-T101-1-7618, 11/2021
Hunt Groups

TMStatus Indicates whether traffic Boolean True, False N/A
measurements are currently
enabled for this MLHG.
InQueueInterru Specifies the time interval integer 0, 30..180 N/A
ptTime after which the InQueue
InterruptIntercept
announcement (if one is
provisioned) will be played to
callers in the MLHG’s queue.
Note that the default value of
0 indicates that the
announcement shall never be
played.
InQueueInterru Specifies the intercept to be 0..15 Character string – must N/A
ptIntercept played to callers in the represent a valid intercept.1
MLHG’s queue periodically
after the number of seconds
specified in the
IsReroutingAllo This attribute can be Boolean True, False False
wed provisioned to allow or deny
hunted calls
OverflowDnNoR Define san Overflow String
or WAN Failure AND
A31003-H80A0-T101-1-7618, 11/2021
Hunt Groups

routing is invoked.
member.
1The list of valid existing intercepts is available using the GetInterceptList SOAP request (refer to Section 7.8, “Get
Intercept List”).
15.2.5 Add Sub To Mlhg

This method adds a subscriber to a Hunt Group.
A31003-H80A0-T101-1-7618, 11/2021
Hunt Groups

WSDL Version
subRC_APP_MLHG_PILOT_DN_LEN_INVALID
subRC_APP_MLHG_TERM_H323_INVALID
subRC_APP_MLHG_TERM_PARENT_TEEN_CONFLICT
subRC_APP_MLHG_PILOT_DN_SUB_BG_CONFLICT
subRC_APP_MLHG_MEMBER_FEATURE_CONFLICT
subRC_APP_MLHG_TERM_IN_USE
subRC_DB_MLHG_PILOT_DN_TERM_LIST_LOOKUP_FAILED
subRC_APP_MLHG_TERMS_NUMBER_OUT_OF_RANGE
subRC_DB_MLHG_PILOT_DN_MISSING
subRC_APP_MLHG_TERM_CSTA_NOT_SUBSCRIBED
subRC_APP_SUB_DISCONNECTED
subRC_APP_MLHG_PILOT_DN_CSTA_NOT_SUBSCRIBED
subRC_APP_MLHG_QUEUE_PRIORITY_INVALID
subRC_APP_MLHG_EP_TYPE_UNSUPPORTED
subRC_DB_MLHG_TERM_INSERTION_FAILED
subRC_DB_MLHG_PRIMARY_PILOT_DN_LOOKUP_FAILED
subRC_APP_JOB_ADD_FAILED
subRC_WAR_MLHG_TERM_INSERTION_DATA_IGNORED
Table 778 Add Sub To Mlhg Return Codes

on page 78.
Table 779 Add Sub To Mlhg Input Fields (Seite 1 von 3)
A31003-H80A0-T101-1-7618, 11/2021
Hunt Groups

ServiceId The DN of the existing See definition of ServiceId in Section 5.4, N/A
subscriber/BGL to be added “Primitive Data Definitions”, on page 78.
as a new MLHG terminal.
Position Indicates the position in the integer Position of
MLHG in which the new current last
terminal should be inserted. terminal + 1
If not provided, the terminal
is added in the last position.
That is, one greater than the
currently existing last
terminal.
MakeBusySubCo Indicates whether the MLHG Boolean True, False False
ntrolled Member can control the Make
Busy functionality for the
terminal.
StopHuntSub Indicates whether the MLHG Boolean True, False False
Controlled Member can control the Stop
Hunt functionality for the
terminal.
MlhgBusy Indicates the initial Make enum NotBusy NotBusy
Status Busy state for the terminal. Busy - This Group
Busy - All Groups
MlhgStopHuntSt Indicates the initial Stop Hunt enum NotStopHunt NotStopHunt
atus state for the terminal. StopHunt
MlhgAttendant Indicates whether member is Boolean True, False False
an attendant (not used in
OpenScape Voice, only in
CallManager).
A31003-H80A0-T101-1-7618, 11/2021
Hunt Groups

QueuePriority Specifies the order in which integer 1..255 255
this MLHG member shall
search queues, assuming the
terminal is a member of
multiple MLHGs. This value is
stored on a per MLHG/per
MLHG member basis so a
terminal has a separate value
for each MLHG of which it is a
member. Queues with lower
number priorities are checked
before higher numbered
priority queues. Queues with
the same priority may be
checked in any order.
Optional. If not provided, the
default value 255 (lowest
priority) is used.
15.2.6 Create Mlhg Term

This method creates a Hunt Group terminal. Not currently supported.

WSDL Version
N/A subRC_UNSUPPORTED_FUNCTION
Table 780 Create Mlhg Term Return Codes
15.2.7 Modify Mlhg TermInfo

This method adds, removes, and modifies Hunt Group terminal
information.
A31003-H80A0-T101-1-7618, 11/2021
Hunt Groups

WSDL Version
subRC_DB_MLHG_LOOKUP_FAILED
subRC_APP_MLHG_TERM_NOT_IN_MLHG
subRC_APP_MLHG_PRIMARY_PILOT_DN_NOT_ALLOWED
subRC_APP_MLHG_PRIMARY_PILOT_DN_DOES_NOT_EXIST
subRC_DB_MLHG_PRIMARY_PILOT_DN_LOOKUP_FAILED
subRC_APP_MLHG_DOES_NOT_EXIST
subRC_APP_MLHG_TERM_NOT_IN_MLHG
subRC_APP_MLHG_MEMBER_MODIFY_FAILED
subRC_APP_JOB_ADD_FAILED
subRC_APP_MLHG_PILOT_DN_CSTA_NOT_SUBSCRIBED
subRC_APP_MLHG_QUEUE_PRIORITY_INVALID
subRC_DB_MLHG_TERM_INSERTION_FAILED
Table 781 Modify Mlhg Term Info Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Hunt Groups

on page 78.
associated with MLHG with BOName
V7.00.01.09 of the Pilot DN.
Member The DN of the MLHG terminal. See definition of ServiceId in Section 5.4, N/A
ServiceId “Primitive Data Definitions”, on page 78.
PrimaryPilot Assuming the terminal is a See definition of ServiceId in Section 5.4, N/A
ServiceId member of multiple MLHGs, “Primitive Data Definitions”, on page 78.
this parameter indicates that
the terminal’s primary MLHG
shall be changed to the MLHG
of the Pilot DN provided.
Position Indicates the position in the integer N/A
MLHG to which the terminal
should be moved.
MakeBusySubCo Indicates whether the MLHG Boolean True, False N/A
ntrolled Member can control the Make
Busy functionality for the
terminal.
StopHuntSub Indicates whether the MLHG Boolean True, False N/A
Controlled Member can control the Stop
Hunt functionality for the
terminal.
MlhgBusy Indicates the Make Busy state enum NotBusy N/A
Status for the terminal. Busy - This Group
Busy - All Groups
MlhgStopHuntSt Indicates the Stop Hunt state enum NotStopHunt N/A
atus for the terminal. StopHunt
MlhgAttendant Indicates whether member is Boolean True, False N/A
an attendant (not used in
OpenScape Voice, only in
CallManager).
Table 782 Modify Mlhg Term Info Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Hunt Groups

QueuePriority Specifies the order in which integer 1..255 N/A
this MLHG member shall
search queues, assuming the
terminal is a member of
multiple MLHGs. This value is
stored on a per MLHG/per
MLHG member basis, so a
terminal has a separate value
for each MLHG of which it is a
member. Queues with lower
number priorities are checked
before higher number priority
queues. Queues with the
same priority may be checked
in any order.
Table 782 Modify Mlhg Term Info Input Fields (Seite 2 von 2)
15.2.8 Delete Mlhg Term

This method removes the specified Hunt Group terminal from the Hunt
Group whose Pilot DN was specified in the request. The DN remains an
ordinary subscriber/BGL after this request is performed, and it may still
be a member of other Hunt Groups.

WSDL Version
04.04.07 subRC_INTERNAL_ERROR
subRC_MLHG_TERM_DEL_ERR
subRC_INVLD_BG_NAME
subRC_INVLD_SUB_DN
subRC_SUB_DOES_NOT_EXIST
subRC_SUCCESS
subRC_INTERNAL_RECOVERY_ERR
Table 783 Delete Mlhg Term Return Codes

on page 78.
Table 784 Delete Mlhg Term Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Hunt Groups

Member The DN of the MLHG terminal. See definition of ServiceId in Section 5.4, N/A
ServiceId “Primitive Data Definitions”, on page 78.
Table 784 Delete Mlhg Term Input Fields (Seite 2 von 2)
15.2.9 Get Mlhg TM Data

This method retrieves Hunt Group terminal data.

WSDL Version
subRC_APP_MLHG_TMDATA_DIRECTORY_INVALID
subRC_APP_MLHG_TMDATA_HL_DIRECTORY_OPEN_FAILED
Table 785 Get Mlhg TM Data Return Codes

on page 78.
StartDirName A directory with which to 1..25 Character string “”
start. The directory name is
compared against each
directory present in the root
traffic measurement directory
(/global/user/oms) and only
directories created after the
timestamp of the provided
input directory are returned.
The expected format for the
input directory:
“SRX3000-
YYYYMMDDTHHMMSS”
Table 786 Get Mlhg TM Data Input Fields
A31003-H80A0-T101-1-7618, 11/2021
soap_ext_interfaces_ep.fm
Endpoint Profiles
Create Ep Profile
16 Endpoint Profiles
Endpoint Profiles are used for SIP Network Servers such as SIP
Gateways (access to the PSTN, HiPath 4000, HiPath 3000), SIP Proxy
Servers (Comdasys), SIP Voice Mail Server (Xpressions), and SIP
Conference Bridge. These profiles allow services and feature settings
to be defined for these endpoints that need specific services.
16.1 Create Ep Profile

This API is used to Create Endpoint Profiles for SIP Network Servers.
A31003-H80A0-T101-1-7618, 11/2021
Endpoint Profiles
Create Ep Profile

WSDL Version
subRC_APP_EP_NAME_LEN_INVALID
subRC_APP_EP_PROFILE_INVALID
subRC_DB_EP_PROFILE_LOOKUP_FAILED
subRC_APP_EP_PRI_SUP_INVALID
subRC_APP_EP_VOIP_MISSING
subRC_APP_EP_56QOS_INVALID
subRC_APP_EP_QOS_QOSPROFILE_CONFLICT
subRC_APP_EP_QOSPROFILE_INVALID
subRC_APP_EP_QOSPRIM_MISSING
subRC_APP_EP_QOSPRIM_PACK_PER_INVALID
subRC_APP_EP_QOSCLASS_QOSVALUE_INVALID
subRC_APP_EP_QOSSEC_PACK_PER_INVALID
subRC_APP_EP_QOSSEC_TOS_INVALID
subRC_APP_EP_QOSTHRD_QOSSEC_CONFLICT
subRC_APP_EP_QOSTHRD_QOS4TH_CONFLICT
subRC_APP_EP_QOSTHRD_PACK_PER_INVALID
subRC_APP_EP_QOSTHRD_TOS_INVALID
subRC_DB_EP_INSERTION_FAILED
Table 787 Create Ep Profile Return Codes

EpType Type of Endpoint Profile. enum Network_server Network_serve
r
EpName Name of Endpoint Profile to 1..30 Character string required
create.
Table 788 Create Ep Profile Input Fields (Seite 1 von 4)
A31003-H80A0-T101-1-7618, 11/2021
Endpoint Profiles
Create Ep Profile

EpMgtInfo
(EpMgtInfo) Name of the Business Group Please refer to Section 5.4, “Primitive ““
BGName associated with the endpoint. Data Definitions”, on page 78.
Note that when a BG is
provided, the BG’s Private
Numbering Plan, if any, is used
for translation of incoming
calls through this Endpoint
Profile.
(EpMgtInfo) The name of the class of Refer to the definition of COS in Section ““
ClassOfService service. 9.1, “Create Subscriber”, on page 342.
(EpMgtInfo) If the Endpoint Profile has no Refer to the definition of RateArea in ““
RateArea Rate Area assigned, it will only Section 9.1, “Create Subscriber”, on page
be possible to access default 342.
routes.The available list of
Rate Areas is retrievable using
the GetRateAreaList interface
method.
(EpMgtInfo) Identifies the LATA to which 0..3 Numeric string ““
LataDigits the Endpoint Profile belongs.
(The switch may serve
subscribers across multiple
during SCP 800 number
translations to an SCP.
Removed in V8.
(EpMgtInfo) Privacy settings for a enum SipBasic, SipBasic
PrivacySupport subscriber. SipFull
(EpMgtInfo) Please refer to Section 5.4, “System
Language “Primitive Data Definitions”, Default”
on page 78.
(EpMgtInfo) Indicates the Endpoint 1..15 Any existing Calling ““
CallingLoc Profile’s location. Used for Location.1
routing emergency calls to the
answering point that serves
the Calling Location.
A31003-H80A0-T101-1-7618, 11/2021
Endpoint Profiles
Create Ep Profile

(EpMgtInfo) Used to indicate the treatment Boolean True, True
FailedCallsInterc for unsuccessful calls. If the False
eptTreatment Intercept Treatment is set to
True (Yes), unsuccessful calls
will be sent to intercept
treatments, either play tones
or announcement, depends on
the switch configuration. If the
Intercept Treatment is set to
False (No), unsuccessful calls
will be released with the
release cause. The default
value of the Intercept
Treatment is True (Yes). It
applies to all markets and
solutions, i.e. it applicable to
ANSI, ETSI, Enterprise.
(EpMgtInfo) The name of the Private 1..31 Character string. ““
NumberPlanNam Numbering Plan to associate
e with this Endpoint Profile. If
none is provided, the BG’s
numbering plan applies.
For EPs not associated with a
BG, only the system default
numbering plan applies.
(EpMgtInfo) Specifies the endpoint profile’s Any valid time zone. “Local“
TimeZone time zone and determines how
the time-dependent services
work. For a list of valid time
zones, refer to Appendix 31,
“Time Zones”.
(EpMgtInfo) The security zone of an Enum • ImpactLevelZero
ImpactLevel endpoint. • ImpactLevelOne
V7.00.15.0 forward. • ImpactLevelTwo
• ImpactLevelThree
• ImpactLevelFour
• ImpactLevelFive
• ImpactLevelSix
• ImpactLevelSeven
• ImpactLevelEight
• ImpactLevelNine
• ImpactLevelUnclassified
Voip - Not for OSV. Removed in R8
(Voip) See Section 5.4, “Primitive True
Bearer_ Data Definitions”, on page 78.
Speech
(Voip) See Section 5.4, “Primitive False
Bearer_3_1K Data Definitions”, on page 78.
Bearer_56K Data Definitions”, on page 78.
A31003-H80A0-T101-1-7618, 11/2021
Endpoint Profiles
Create Ep Profile

Bearer_64K Data Definitions”, on page 78.
(Voip) See Section 5.4, “Primitive G711
FaxMode Data Definitions”, on page 78.
(Voip) See Section 5.4, “Primitive True
Echo Data Definitions”, on page 78.
Cancellation
Silence Data Definitions”, on page 78.
Suppression
Fax Data Definitions”, on page 78.
Statistics
Outband Data Definitions”, on page 78.
DTMF
Signaling
Suppress Data Definitions”, on page 78.
OutbandDTMFWit
hG711
ListOf The list of features that can be 1. CfCISNAME; Called Party N/A
EpFeatures assigned to the End Point Name Delivery
profile. 2. CfCISNUM; Called Party
Number Delivery
3. CfEpCNAM; Incoming
Calling Name Delivery for
Endpoint
4. CfTRS; Toll restrictions
5. CfEpVM; Voice Mail for
Endpoint
6. CfEpCT; Call Transfer for
Endpoint
7. CfCFID; (Call Forward
Invalid Destination
8. CfNWCPS; Network Wide
Call Park to Serv
1The available list of Calling Locations can be retrieved using the GetCallingLocationList interface method (see Section 7.9,
“Get Calling Location List”).
16.1.1 Update Ep Mgt Info

This method changes management attributes of the endpoint profile.
A31003-H80A0-T101-1-7618, 11/2021
Endpoint Profiles
Create Ep Profile

WSDL Version
subRC_APP_EP_PROFILE_DOES_NOT_EXIST
subRC_DB_EP_MGTINFO_COS_LOOKUP_FAILED
subRC_APP_EP_MGTINFO_COS_DOES_NOT_EXIST
subRC_DB_EP_MGTINFO_RATE_AREA_LOOKUP_FAILED
subRC_APP_EP_MGTINFO_RATE_AREA_DOES_NOT_EXIST
subRC_DB_EP_MGTINFO_CALLING_LOC__LOOKUP_FAILED
subRC_APP_EP_MGTINFO_CALLING_LOC_DOES_NOT_EXIST
subRC_APP_EP_MGTINFO_PRIVACY_SUPPORT_INVALID
Table 789 Update Ep Mgt Info Return Codes

Value
EpName The name of an existing 1..30 Character string. required
Endpoint Profile.
NewEpName The New Name of the 1…30 Character String Optional
Endpoint Profile
OperatorId Refer to Section 5.4, required
on page 78.
EpMgtInfo
(EpMgtInfo) Refer to Section 16.1, “Create N/A
BGName Ep Profile”, on page 722.
ClassOfService Ep Profile”, on page 722.
RateArea Ep Profile”, on page 722.
(EpMgtInfo) Removed in V8 N/A
LataDigits
PrivacySupport Ep Profile”, on page 722.
Language Ep Profile”, on page 722.
Table 790 Update Ep Mgt Info Input Fields (Seite 1 von 3)
A31003-H80A0-T101-1-7618, 11/2021
Endpoint Profiles
Create Ep Profile

Value
BGName Ep Profile”, on page 722.
ClassOfService Ep Profile”, on page 722.
(EpMgtInfo) Indicates the Endpoint 1..15 Any existing Calling Location.1 N/A
CallingLoc Profile’s location. Used for
routing emergency calls to
the answering point that
serves the Calling Location.
(EpMgtInfo) Used to indicate the Boolean True, N/A
FailedCallsInterc treatment for unsuccessful False
eptTreatment calls. If the Intercept
Treatment is set to True (Yes),
unsuccessful calls will be sent
to intercept treatments,
either play tones or
announcement, depends on
the switch configuration. If
the Intercept Treatment is set
to False (No), unsuccessful
calls will be released with the
release cause. The default
value of the Intercept
Treatment is True (Yes). It
applies to all markets and
solutions, i.e. it applicable to
ANSI, ETSI, Carrier,
Enterprise, CarrierNoSS7.
(EpMgtInfo) The name of the Private Refer to Section 16.1, “Create Ep Profile”, N/A
NumberPlanNam Numbering Plan to associate on page 722.
e with this Endpoint Profile. In
order to remove an existing
Number Plan Name
assignment, the parameter
can be sent as an empty
string. Thereafter, the BG’s
numbering plan applies. If the
parameter is not sent, no
change is made to the
existing assignment,
(EpMgtInfo) Specifies the endpoint Any valid time zone. N/A
TimeZone profile’s time zone and
determines how the time-
dependent services work. For
a list of valid time zones, refer
to Appendix 31, “Time
Zones”.
A31003-H80A0-T101-1-7618, 11/2021
Endpoint Profiles
Create Ep Profile

Value
(EpMgtInfo) The security zone of an Enum ImpactLevelZero
ImpactLevel endpoint. ImpactLevelOne
V7.00.15.0 forward. ImpactLevelTwo
ImpactLevelThree
ImpactLevelFour
ImpactLevelFive
ImpactLevelSix
ImpactLevelSeven
ImpactLevelEight
ImpactLevelNine
ImpactLevelUnclassified
16.1.2 Update Ep Capabilities

This method changes the capabilities of the endpoint.

WSDL Version
subRC_APP_EP_VOIP_DELETION_FAILED
Table 791 Update Ep Capabilities Return Codes

Value
Endpoint Profile.
on page 78.
Voip Not for OSV. Removed in R8
(Voip) Refer to Section 16.1, “Create N/A
Bearer_Speech Ep Profile”, on page 722.
Bearer_3_1K Ep Profile”, on page 722.
Table 792 Update Ep Capabilities Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Endpoint Profiles
Create Ep Profile

Value
Bearer_56K Ep Profile”, on page 722.
Bearer_64K Ep Profile”, on page 722.
FaxMode Ep Profile”, on page 722.
EchoCancellation Ep Profile”, on page 722.
Silence Ep Profile”, on page 722.
Suppression
FaxStatistics Ep Profile”, on page 722.
Outband Ep Profile”, on page 722.
DTMFSignaling
Suppress Ep Profile”, on page 722.
OutbandDTMF
WithG711
Table 792 Update Ep Capabilities Input Fields (Seite 2 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Endpoint Profiles
Create Ep Profile
16.1.3 Update Ep Features

This method adds, removes and replaces service features.

WSDL Version
Table 793 Update Ep Features Return Codes

Endpoint Profile.
on page 78.
ListofFeatures Refer to Section 16.1, “Create • CfTRS; Toll restrictions N/A
Ep Profile”, on page 722. • CfEpVM; Voice Mail
• CfEpCT; Call Transfer
• CfCFID; Call Forward Invalid
Destination
• CfCNIM; CSTA External
device name provider
(V7.00.01.10)
Table 794 Update Ep Features Input Fields
16.1.4 Get Ep Info

This method retrieves the endpoint profile.
A31003-H80A0-T101-1-7618, 11/2021
Endpoint Profiles
Create Ep Profile

WSDL Version
subRC_DB_UTIL_LANG_LOOKUP_FAILED
subRC_DB_FEAT_DATA_LOOKUP_FAILED
Table 795 Get Ep Info Return Codes

Endpoint Profile.
Table 796 GetEpInfo Input Fields

EpType Refer to Section 16.1, “Create N/A
Ep Profile”, on page 722.
EpMgtInfo
(EpMgtInfo) Name of the Business Group Please refer to Section 5.4, “Primitive Data N/A
BGName associated with the endpoint. Definitions”, on page 78.
(EpMgtInfo) The name of the class of Refer to the definition of COS in Section N/A
ClassOfService service. 9.1, “Create Subscriber”, on page 342.
(EpMgtInfo) If the subscriber has no Rate Refer to the definition of RateArea in N/A
RateArea Area assigned, the subscriber Section 9.1, “Create Subscriber”, on page
will only be able to access 342.
default routes.The available
list of Rate Areas is
retrievable using the
GetRateAreaList interface
method.
(EpMgtInfo) Privacy settings for a enum SipBasic, N/A
PrivacySupport subscriber. SipFull
(EpMgtInfo) Please refer to Section 5.4, N/A
Language “Primitive Data Definitions”,
on page 78.
Table 797 Get Ep Info Output Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Endpoint Profiles
Create Ep Profile

(EpMgtInfo) The security zone of an Enum • ImpactLevelZero
ImpactLevel endpoint. • ImpactLevelOne
V7.00.15.0 forward. • ImpactLevelTwo
• ImpactLevelThree
• ImpactLevelFour
• ImpactLevelFive
• ImpactLevelSix
• ImpactLevelSeven
• ImpactLevelEight
• ImpactLevelNine
• ImpactLevelUnclassified
ListOf The list of features that can • CfTRS; Toll and Call N/A
EpFeatures be assigned to the End Point Restrictions
profile. • CfVM; Call Forwarding Voice
Mail
• EpCT; Call Transfer for
Endpoint
Subscriber The date and time stamp Please refer to the definition of TOY in N/A
AuditInfo. when the end point profile Section 5.4, “Primitive Data Definitions”,
InitialProvTOY was created. on page 78.
Subscriber The date and time stamp Please refer to the definition of TOY in N/A
AuditInfo.Last when the end point profile Section 5.4, “Primitive Data Definitions”,
OpProvTOY was last modified. on page 78.
Subscriber The ID of the last operator to Please refer to the definition of OperatorId N/A
AuditInfo. change the profile. in Section 5.4, “Primitive Data Definitions”,
LastOpId on page 78.
Table 797 Get Ep Info Output Fields (Seite 2 von 2)
16.1.5 Get Ep Info By Release

This method retrieves EP info.

WSDL Version
05.03.01 The return codes for this request are the same as those listed for Get
Ep Info in Section 16.1.4, “Get Ep Info”.
Table 798 Get Ep Info By Release Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Endpoint Profiles
Create Ep Profile

Interface The Interface Release version enum Latest, Latest
Release to use. This provides Release6,
information for older releases Release8,
in their older format. Release9,
Release10
Endpoint Profile.
Table 799 Get Ep Info By Release Input Fields
The output fields for this method are the same as those described Get
Ep Info in Table 797.
16.1.6 Get EP List

This method retrieves a list of the Endpoint Profiles existing on the
switch. For each entry, the EP Name, EP Type and the BG Name are
returned.

WSDL Version
subRC_DB_EP_PROFILE_NUM_LOOKUP_FAILED
subRC_DB_EP_PROFILE_TYPE_INVALID
Table 800 Get EP List Return Codes

on page 78.
InterfaceWSDL The WSDL version of the Refer to Section 5.1.1, “The Interface N/A
request. This allows the SOAP WSDL and Interface Release Control”, on
Server to avoid returning page 73.
after the WSDL version in
question.
requests. For more
A31003-H80A0-T101-1-7618, 11/2021
Endpoint Profiles
Create Ep Profile

BGName The name of the Business Please refer to Section 5.4, “Primitive Data N/A
Group on which to filter. Definitions”, on page 78.
NumberPlanNa The name of the Private 1..31 Character string. N/A
filter. Only BGs that are
associated with this Number
Plan will be returned.

unsp__GetEp A list of the endpoints N/A
ListResult including the following
(list) attributes for each list entry:
EpName – The name of the
end point
EpType – The type associated
with the end point. (Please
see Section , “Endpoint
Profiles”, on page 722.)
Table 802 Get EP List Output Fields
16.1.7 Delete Ep Profile

This method removes the endpoint profile.

WSDL Version
subRC_APP_EP_PROFILE_T,YPE_INVALID
subRC_APP_EP_PROFILE_IN_USE
subRC_DB_EP_PROFILE_REFERENCE_LOOKUP_FAILED
Table 803 Delete Ep Profile Return Codes

Endpoint Profile.
on page 78.
Table 804 Delete Ep Profile Input Fields
A31003-H80A0-T101-1-7618, 11/2021
soap_ext_interfaces_job.fm
Background Job Processing Interfaces
Jobs
17 Background Job Processing Interfaces
17.1 Jobs
The OpenScape Voice system supports background jobs in specific
situations. In future releases, it may be possible to schedule actions,
such as scheduling the disconnection of a subscriber (for example, to
occur at the end of the month), to occur later on the OpenScape Voice
system. At this time, however, jobs are used for SOAP requests that
require more processing time than a client will typically wait for.
There are several types of requests that require more time than
available; the most common involves updates to Feature Profiles,
which may require the updating of several thousand subscribers. Upon
receipt of this type of request, the OpenScape Voice system returns the
JobId tag in the ResultCodeStruct:. When this field is returned, it
means that the request has been successfully received, validated, and
applied to the Feature Profile and updates have been scheduled for the
affected subscribers.
The status of the job may be obtained using the GetJobInfo method
and a list of existing jobs may be obtained using the GetJobList
method. The CancelJob method may be used to terminate a running or
waiting job.
17.1.1 Get Job Info

This method retrieves information for a particular job.

WSDL Version
subRC_APP_JOB_ID_MISSING
subRC_DB_JOB_ID_LOOKUP_FAILED
subRC_APP_JOB_ID_DOES_NOT_EXIST
Table 805 Get Job Info Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Jobs

JobId The ID of a job in the format 49 Character string N/A
<operatorId>_<jobSeqence
Number>.
StartSequence The sequence number of the int 1..1000 1
first JobResult entry that shall
be returned.
MaxSequence The maximum number of int 1..1000 1000
JobResult entries that shall be
returned.
Table 806 Get Job Info Input Fields

Value
<operatorId>_<jobSequence
Number>.
JobComments A text string optionally 2000 Character string N/A
provided by the operator
when a job is cancelled.
OperatorID Please refer to Section 5.4, N/A
on page 78.
JobStatus The current status of the job. enum Waiting N/A
InProgress
Complete
Canceled
Partial
Error
JobAction The action to be performed by enum AddFeature N/A
this job. RemoveFeature
UpdateFeature
UpdateBGDefaultQOSProfile
UpdateQOSProfile
Audit FeatureProfile
RemoveCaleaEntry
UpdateMlhgMemberCaleaEntry
RemoveMlhgMemberCaleaEntr
y
AuditFeatureProfile
CollectLogFiles
GenericAuditHomeDn
AccessEZIPParm
Table 807 Get Job Info Output Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Jobs

Value
ObjectType The type of object for which enum BG N/A
this job has been submitted. DN
FP is used to indicate a job to FP
propagate features from a QP
Feature Profile to its
associated subscribers/BGLs.
ObjectName The ID of the FeatureProfile. 49 Numeric string N/A
CreateDate The timestamp when the job xsd__dateT N/A
was created. ime
ExecutionDate The timestamp when the job xsd__dateT N/A
started execution. ime
CancelDate The timestamp when the job xsd__dateT N/A
was cancelled, if at all. ime
Max The total number of JobResult integer N/A
Sequences entries existing for this job.
Objects The number of objects integer N/A
Processed processed. In the case of
feature propagation from a
Feature Profile to the
associated subscribers/BGLs,
the number of subscribers/
BGLs processed.
JobResultList A list of job result entries, if Array of N/A
any, where each entry structures
consists of:
• ObjectType
• ObjectName
• SequenceNumber
• JobEntryResultCode
Table 807 Get Job Info Output Fields (Seite 2 von 2)
17.1.2 Get Job List

This method retrieves a list of jobs.

WSDL Version
subRC_APP_JOB_FILTER_INVALID
Table 808 Get Job List Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Jobs

Number>.
Table 809 Get Job List Input Fields
17.1.3 Get Job List By Option

This method retrieves a job list by option.

WSDL Version
subRC_APP_JOB_FILTER_INVALID
Table 810 Get Job List By Option Return Codes

GetJobList List of options used for array of FilterByBgName empty array
OptionList filtering of jobs displayed. enum FilterByOperatorId
Table 811 Get Job List By Option Input Fields

JobId The ID of a job in the format 49 Character string. N/A
Number>.
Table 812 Get Job List By Option Output Fields
17.1.4 Cancel Job

This method terminates the processing of the specified currently
running or waiting job.
A31003-H80A0-T101-1-7618, 11/2021
Jobs

WSDL Version
subRC_APP_JOB_ID_LEN_INVALID
subRC_APP_JOB_COMMENTS_LEN_INVALID
subRC_APP_JOB_ID_DOES_NOT_EXIST
Table 813 Cancel Job Return Codes

JobId The ID of a job in the format 49 Character string. N/A
Number>.
OperatorId Please refer to Section 5.4, N/A
on page 78.
JobComments A text string optionally 2000 Character string. N/A
provided by the operator
when a job is cancelled.
Table 814 Cancel Job Input Fields
A31003-H80A0-T101-1-7618, 11/2021
soap_ext_interfaces_dynamic_cac.fm
Notify CAC Primary Link Status
18 Dynamic CAC Router Management

to support Dynamic CAC (Call Admission Control) router operations.
Note: These SOAP requests and responses are separately defined in

the interface definition (WSDL) file: siemens-hiq8000.cac.wsdl.
18.1 Notify CAC Primary Link Status

This method reports the status of the primary link on the router.

WSDL Version
subRC_APP_CACSDK_INVALID_CAC_PRIMARYLINK_IPADDRESS
subRC_APP_CACSDK_MODIFY_STATUS_ERROR
Table 815 Notify CAC Primary Link Status Return Codes

OperatorId’ Please refer to Section 5.4, required
on page 78.
CACPrimaryLinkIp The IP address of the router A valid IP address required
Address for which the link status is to
be reported.
CACPrimaryLinkSt The link status to report. enum LinkUp required
atus LinkDown
Table 816 Notify CAC Primary Link Status Input Fields
18.2 Get CAC Primary Link Status

This method returns the status of the primary link associated to the
router specified by the input CACPrimaryLinkIpAddress or, if
CACPrimaryLinkIpAddress is not specified, returns a list of all Access
Routers along with their status.
A31003-H80A0-T101-1-7618, 11/2021
Get Provisioned CAC Primary Links

WSDL Version
subRC_APP_CACSDK_INVALID_CAC_PRIMARYLINK_IPADDRESS
subRC_SYS_CACSDK_MEMORY_ALLOCATION_ERROR
subRC_APP_CACSDK_QUERY_CAC_GROUP_ERROR
Table 817 Get CAC Primary Link Status Return Codes

on page 78.
InterfaceWSDL The WSDL version of the Refer to Character string
request. Section
5.1,
“Interface
(WSDL)
Versions”,
on page
73.
requests. For more
CACPrimaryLink The IP address of the router A valid IP address
IpAddress for which the link status list is
to be retrieved.
Table 818 Get CAC Primary Link Status Input Fields
18.3 Get Provisioned CAC Primary Links

This method searches all the CAC Groups that have a router address
configured and returns the address along with the interface name back
in a list. The external management application can use this to identify
all the routers to query.

WSDL Version
subRC_SYS_CACSDK_MEMORY_ALLOCATION_ERROR
Table 819 Get Provisioned CAC Primary Links Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Reset All CAC Primary Links

InterfaceWSDL The WSDL version of the Refer to Character string
request. Section
5.1,
“Interface
(WSDL)
Versions”,
on page
73.
requests. For more
Table 820 Get Provisioned CAC Primary Links Input Fields

Value
ProvisionedCACPr A list of CACPrimaryLink elements, each containing the following attributes:
imaryLinksList
LinkIPAddress An IP Address string Please refer to the definition of N/A
representing the router RouterIpAddress in Section 8.10.1, “Create
associated with the CAC CAC Group”.
LinkName This identifies the interface Please refer to the definition of N/A
within the router. The string is InterfaceName in Section 8.10.1, “Create
of the form “eth0”, “eth1” etc. CAC Group”.
Table 821 Get Provisioned CAC Primary Links Output Fields
18.4 Reset All CAC Primary Links

This method resets the status of the primary link for all CAC Access
Routers to reflect a status “LinkUp”.

WSDL Version
subRC_APP_CACSDK_STATUS_PARTIALLY_RESET
Table 822 Reset All CAC Primary Links Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Reset All CAC Primary Links

on page 78.
Table 823 Reset All CAC Primary Links Input Fields
A31003-H80A0-T101-1-7618, 11/2021
soap_ext_interfaces_exec_asst.fm
Executive Assistant Functionality with Cockpit Application
Executive Assistant Groups
19 Executive Assistant Functionality with

Cockpit Application
The new capabilities and functions that support the requirements of
executive assistant groups are outlined in this section. These
provisioning and management functions were previously handled by
the OpenScape Voice Assistant. Beginning with V4.0, the SOAP
interface will be providing the following capabilities:
• Provisioning of E/A Groups
• Provisioning of E/A Group Members
• Provisioning of E/A Member Auxiliary Lines
• Provisioning of E/A Member Relations
• Provisioning of E/A Cockpit Data
19.1 Executive Assistant Groups

for the provisioning of the executive assistant groups.
19.1.1 Create Executive Assistant Group

This method creates an executive assistant group.

subRC_APP_EA_BGNAME_INVALID
subRC_APP_EA_SERVICE_ID_INVALID
subRC_APP_EA_GROUP_FIELD_INVALID
subRC_APP_EA_GROUP_EADM_ERROR
subRC_APP_EA_ALLOCATION_ERROR
subRC_APP_EA_INITIALIZATION_ERROR
subRC_DB_EA_ERROR
Table 824 Create Executive Assistant Group Return Codes (Seite 1 von
2)
A31003-H80A0-T101-1-7618, 11/2021

subRC_APP_EA_GROUP_COULD_NOT_BE_REMOVED
subRC_APP_EA_GROUP_NAME_INVALID_LENTGH
subRC_APP_MAX_NUMBER_OF_EA_GROUPS_REACHED
subRC_APP_EA_GROUP_NAME_MISSING
subRC_APP_EA_GROUP_TYPE_MISSING
Table 824 Create Executive Assistant Group Return Codes (Seite 2 von
2)
Table 825 lists the input fields for this method:

page 78. Required
BGName The name of an existing BG in Str
which the Group will be
included. Required
EAGroupName The name of the new executive Str
assistant group. Required
EAGroupType The type of the E/A group. enum EAG_Basic,
EAG_EnhancedWithCallWaiting,
EAG_EnhancedWithRollover,
EAG_BasicWithCockpit,
EAG_EnhancedWithCallWaitingAndCo
ckpit,
EAG_EnhancedWithRolloverAndCockp
it
ServerAddress Server IP of the EA group Str
ServerPort Server Port of the E/A group Int
NotificPeerAssist Flag indicating if notification of boolean
peer assistant is required
NotificPeerAssistTimeDel Value indicating the delay in Int
ay seconds for the notification of
Assistant
ScreenQueingMode Flag indicating if a Screen boolean
Queuing mode is needed
Table 825 Create Executive Assistant Group Input Fields
19.1.2 Delete Executive Assistant Group

This method deletes an executive assistant group.
A31003-H80A0-T101-1-7618, 11/2021

subRC_DB_EA_ERROR
subRC_APP_EA_GROUP_COULD_NOT_BE_REMOVED
subRC_APP_EA_GROUP_NOT_FOUND
subRC_APP_EA_GROUP_RETRIEVAL_FAILED
Table 826 Delete Executive Assistant Group Return Codes


Operator ID Please refer to Section 5.4, “Primitive Data Str
Definitions”, on page 78. Required
BGName The name of an existing BG in which the Str
EA Group is included. Required
EAGroupName The name of the executive assistant group Str
to be deleted. Required
Table 827 Delete Executive Assistant Group Input Fields
19.1.3 Update Executive Assistant Group

This method updates an existing executive assistant group. If the
group includes members, this method allows the modification of
corresponding member information. The return codes for this function
are:
WSDL Return Codes

Version
Table 828 Update Executive Assistant Group Return Codes (Seite 1

von 2)
A31003-H80A0-T101-1-7618, 11/2021
WSDL Return Codes

Version
subRC_DB_EA_ERROR
Table 828 Update Executive Assistant Group Return Codes (Seite 2

von 2)

page 78. Required
BGName The name of an existing BG in Str
which the EA Group is included.
Required
EAGroupName The name of the executive Str
assistant group to be updated.
Required
NewEAGroupName The new name of the executive Str optional
assistant group to be updated.
Required
EAGroupType The type of the E/A group. Enum EAG_Basic,
EAG_EnhancedWithCallWaiting,
EAG_EnhancedWithRollover,
EAG_EnhancedWithCallWaitingAndCock
pit,
EAG_EnhancedWithRolloverAndCockpit
ServerAddress Server IP of the EA group Str
ServerPort Server Port of the E/A group Int
NotificPeerAssist Flag indicating if notification of boolea
peer assistant is required n
Table 829 Update Executive Assistant Group Input Fields
A31003-H80A0-T101-1-7618, 11/2021

NotificPeerAssistTimeDel Value indicating the delay in Int
ay seconds for the notification of
Assistant
ScreenQueingMode Flag indicating if a Screen boolea
Queuing mode is needed n
Table 829 Update Executive Assistant Group Input Fields
Optionally the craft person could provide a list of members that should
be updated as well. Each one would consist of the following attributes:
• MemberServiceID
• MemberRole
• PrivateNumberVisible
• MemberName
• TypeExecutive
• MemberPreference
• MemberMobileNumber
• MemberForwardNumber
• MemberToNumber
• AdditionalInfo
The optional member attributes are described in Section 19.2.1,

“Create Executive Assistant Group Member”, on page 751.
19.1.4 Get List of Executive Assistant Groups

This method can be used in order to get a list of all EA Groups within a
specific BG or to get the information of a single EA Group.
WSDL Return Codes

Version
Table 830 Get List of Executive Assistant Group Return Codes
A31003-H80A0-T101-1-7618, 11/2021
WSDL Return Codes

Version
subRC_DB_EA_ERROR
V5.00.20.01 subRC_APP_OSMO_DN_CONFLICT
Table 830 Get List of Executive Assistant Group Return Codes


BGName The name of an existing BG to use as a Str
filter. Required
to look for.
Paging Paging structure for Get List requests. For
more information, refer to Section 5.5,
Sort Order Value indicating the sort order of the list Enum SortOrderAscending,
SortOrderDescending
Sort Type Value indicating the sort type of the list Enum SortByGroupID,
SortByGroupName
Table 831 Get List of Executive Assistant Group Input Fields
19.1.5 Get Extended Executive Assistant

Group List
GetEAGroupList() is used to retrieve the list of EA Groups within a
specific BG. Since that list does not include the Number of Executives,
the Number of Assistants and the Cockpit Status that the Assistant
needs for its list, a new API has been provided,
getEAGroupListExtended(), that will return the needed data for the EA
Group List. That includes: EA Group Name, EA Group Type, the Number
of Executives, the Number of Assistants and the Cockpit Status. Paging
is provided and sorting/filtering based on Group Name. EADM provides
sorting/filtering/paging facilities plus the full result-set to SOAP. Input
Fields are the same as Get List of Executive Assistant Groups described
in section 19.1.4
The following table shows the Extended Result parameters
Table 833 lists the output fields for this method:
A31003-H80A0-T101-1-7618, 11/2021
Executive Assistant Group Members

BgName The name of an existing BG in which the
EA Group is included. Required
EAGroupType The type of the E/A group. Enum EAG_Basic,

EAG_EnhancedWithCallWa
iting,
EAG_EnhancedWithRollov
er,
EAG_EnhancedWithCallWa
itingAndCockpit,
EAG_EnhancedWithRollov
erAndCockpit
ExecutiveCount Count of Executives Integer
Assistant Count Count of Assistants integer
Cockpit Status Whether it Cockpit Application or not Boolean
Table 832 Get Extended Executive Assistant Group List Output Fields
19.2 Executive Assistant Group Members

for the provisioning of the executive assistant group Members.

Member
This method creates an executive assistant group member.
WSDL Return Codes

Version
Table 833 Create Executive Assistant Group Member Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Executive Assistant Group Members
WSDL Return Codes

Version
subRC_APP_EA_GROUP_MEMBER_FIELD_INVALID
subRC_APP_EA_GROUP_MEMBER_EADM_ERROR
subRC_DB_EA_ERROR
subRC_APP_EA_COCKPIT_INFO_NOT_SPECIFIED
subRC_APP_EA_GROUP_MEMBERS_EXIST
subRC_APP_EA_MAX_EA_MEMBER_NUMBER_PER_GROUP
subRC_APP_EA_MEMBER_EXISTS
subRC_APP_EA_MEMBER_NOT_FOUND
Table 833 Create Executive Assistant Group Member Return Codes


Group will be included. Required
EAGroupName The name of an existing group to which Str
the member will be included. Required
MemberServiceID The ServiceID / DN of the new member Str
MemberRole A value indicating the role of the Member Enum EAM_Executive,
EAM_Secretary,
EAM_Deputy
PrivateNumberVisible Flag indicating if the Private number of the Boolean
member would be visible
MemberName A name that can be used for the member Str
TypeExecutive Flag indicating if member is an executive Boolean
MemberPreference Attribute that can be used for preferences Str
MemberMobileNumber A value indicating the mobile number of Str
the member
Table 834 Create Executive Assistant Group Member Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Delete Executive Assistant Group Member

MemberForwardNumber A value indicating the forward number of Str
the member
MemberToNumber A value indicating the 'to' number of the Str
member
AdditionalInfo Additional information Str
Table 834 Create Executive Assistant Group Member Input Fields
19.3 Delete Executive Assistant Group Member

This method deletes an executive assistant group member.
WSDL Return Codes

Version
subRC_APP_EA_MEMBER_COULD_NOT_BE_REMOVED
subRC_DB_EA_ERROR
Table 835 Delete Executive Assistant Group Member Return Codes


Table 836 Delete Executive Assistant Group Member Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Delete Executive Assistant Group Member

Group is included. Required
EAGroupName The name of an existing group containing Str
the member to be deleted. Required
MemberServiceID The ServiceID / DN of the member to be Str
deleted. Required
Table 836 Delete Executive Assistant Group Member Input Fields
19.3.1 Get List of Executive Assistant Group

Members
This method can be used in order to get either a list of all members of
a specific EA Group or to get the information of a single member.
WSDL Return Codes

Version
subRC_DB_EA_ERROR
Table 837 Get List of Executive Assistant Group Members Return

Codes
A31003-H80A0-T101-1-7618, 11/2021
Executive Assistant Group Member Relations

the member to be deleted. Required
MemberServiceID The ServiceID / DN of the member to be Str
deleted
SortOrderDescending
Table 838 Get List of Executive Assistant Group Members Input Fields
19.4 Executive Assistant Group Member Relations

for the provisioning of Relations between executive assistant group
members.

Member Relation
This method creates a relation between 2 existing executive assistant
group members.
WSDL Return Codes

Version
Table 839 Create Executive Assistant Group Member Relation Return

Codes
A31003-H80A0-T101-1-7618, 11/2021
WSDL Return Codes

Version
subRC_APP_EA_GROUP_RELATION_FIELD_INVALID
subRC_APP_EA_GROUP_RELATION_EADM_ERROR
subRC_DB_EA_ERROR
subRC_APP_EA_SERVICEID_IS_USED_AS_EA_MEMBER
subRC_APP_EA_RELATION_MISMATCH
Table 839 Create Executive Assistant Group Member Relation Return

Codes

page 78. Required
From Member The Service ID of the 'from 'Str
member’. Required
To Member The Service ID of the 'to Str
member'. Required
Relation Order The type of the relation. enum EAR_ExecutiveToPrimaryAssistant,
EAR_ExecutiveToSecondaryAssista
nt, EAR_AssistantToDeputy
Table 840 Create Executive Assistant Group Member Relation Input Fields

Member Relation
This method removes an existing relation between 2 executive
assistant group members.
WSDL Return Codes

Version
Table 841 Delete Executive Assistant Group Member Relation Return

Codes
A31003-H80A0-T101-1-7618, 11/2021
WSDL Return Codes

Version
subRC_DB_EA_ERROR
subRC_APP_EA_RELATION_REMOVAL_FAILED
Table 841 Delete Executive Assistant Group Member Relation Return

Codes

page 78. Required
From Member The Service ID of the 'from 'Str
member. Required
To Member The Service ID of the 'to member'. Str
Required
Relation Order The type of the relation. enum EAR_ExecutiveToPrimaryAssistant,
EAR_ExecutiveToSecondaryAssista
nt, EAR_AssistantToDeputy
Table 842 Delete Executive Assistant Group Member Relation Input Fields
19.4.3 Get Executive Assistant Group

Member Relation List
This method can be used in order to get either a list of relations all
members of a specific EA Group.
A31003-H80A0-T101-1-7618, 11/2021
Executive Assistant Group Member Auxiliary Lines
WSDL Return Codes

Version
subRC_DB_EA_ERROR
Table 843 Get Executive Assistant Group Member Relation Return

Codes

the member to be filtered. Required
MemberServiceID The ServiceID / DN to be filtered Str
SortOrderDescending
Table 844 Get Executive Assistant Group Member Relation Input Fields
19.5 Executive Assistant Group Member Auxiliary Lines

for the provisioning of Auxiliary Lines for executive assistant group
Members.
A31003-H80A0-T101-1-7618, 11/2021

Member Auxiliary Line
This method creates an auxiliary line for an existing executive assistant
group member.
WSDL Return Codes

Version
subRC_APP_EA_GROUP_MEMBER_AUX_LINE_FIELD_INVALI
D
subRC_APP_EA_GROUP_MEMBER_AUX_LINE_EADM_ERROR
subRC_DB_EA_ERROR
subRC_APP_MAX_AUX_LINES_PER_MEMBER_REACHED
subRC_APP_MAX_AUX_LINES_REACHED
subRC_APP_EA_GROUP_AUX_LINES_ALREADY_CREATED
subRC_APP_EA_GROUP_AUX_LINE_NOT_FOUND
Table 845 Create Executive Assistant Group Member Auxiliary Line

Return Codes

Member Service ID The Service ID of the member to which the Str
aux line will be assigned. Required
Auxiliary line Service ID The Service ID of the auxiliary line. Str
Required
Table 846 Create Executive Assistant Group Member Auxiliary Line Input Fields
A31003-H80A0-T101-1-7618, 11/2021

Auxiliary line type The type of the auxiliary line. enum EAX_Overflow,
EAX_Intercom,
EAX_Private
Table 846 Create Executive Assistant Group Member Auxiliary Line Input Fields

Member Auxiliary Line
This method deletes an existing auxiliary line for an executive assistant
group member.
WSDL Return Codes

Version
D
subRC_DB_EA_ERROR
subRC_APP_EA_GROUP_AUX_LINE_NOT_FOUND
Table 847 Delete Executive Assistant Group Member Auxiliary Line

Return Codes

Table 848 Delete Executive Assistant Group Member Auxiliary Line Input Fields
A31003-H80A0-T101-1-7618, 11/2021

Member Service ID The Service ID of the member of which the Str
aux line will be assigned. Required
Auxiliary line Service ID The Service ID of the auxiliary line. Str
Required
Table 848 Delete Executive Assistant Group Member Auxiliary Line Input Fields
19.5.3 Get Executive Assistant Group

Member Relations
This method can be used in order to get a list of all Auxiliary Lines of a
specified Member of a certain EA Group, or a list of Auxiliary Lines of
all Members within a specified EA Group.
WSDL Return Codes

Version
D
subRC_DB_EA_ERROR
Table 849 Get Executive Assistant Group Member Auxiliary Line

Return Codes

Table 850 Get Executive Assistant Group Member Auxiliary Line Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Executive Assistant Cockpit

MemberServiceID The ServiceID / DN to be filtered Str
SortOrderDescending
Table 850 Get Executive Assistant Group Member Auxiliary Line Input Fields
19.6 Executive Assistant Cockpit

for the provisioning of cockpit information regarding for executive
assistant group members.
19.6.1 Get Executive Assistant Cockpit List

This method can be used in order to get a list of all EA Groups within a
specific Business Group that are of type 'Cockpit'.
WSDL Return Codes

Version
subRC_DB_EA_ERROR
Table 851 Get Executive Assistant Cockpit List Return Codes

A31003-H80A0-T101-1-7618, 11/2021

SortOrderDescending
Table 852 Get Executive Assistant Cockpit List Input Fields
19.6.2 Get Executive Assistant Cockpit

Configuration Data
This method can be used in order to get the configuration data of all
Members of a certain E/A Group/Cockpit.
WSDL Return Codes

Version
D
subRC_APP_EA_GROUP_COCKPIT_FIELD_INVALID
Table 853 Get Executive Assistant Cockpit Configuration Data Return

Codes
A31003-H80A0-T101-1-7618, 11/2021
WSDL Return Codes

Version
subRC_APP_EA_GROUP_COCKPIT_EADM_ERROR
subRC_DB_EA_ERROR
Table 853 Get Executive Assistant Cockpit Configuration Data Return

Codes

Executive Assistant The E/A group name that will be used as a Str
Group Name filter. Required
Table 854 Get Executive Assistant Cockpit Configuration Data Input Fields
19.6.3 Get Executive Assistant Cockpit

Dynamic Data
This method can be used in order to get the dynamic data of all
members of a certain E/A Group/Cockpit.
WSDL Return Codes

Version
Table 855 Get Executive Assistant Cockpit Dynamic Data Return Codes
A31003-H80A0-T101-1-7618, 11/2021
WSDL Return Codes

Version
subRC_APP_EA_GROUP_MEMBER_AUX_LINE_FIELD_INVALID
subRC_DB_EA_ERROR
Table 855 Get Executive Assistant Cockpit Dynamic Data Return Codes

EAGroupName The E/A group name that will be used as a Str
filter. Required
Table 856 Get Executive Assistant Cockpit Dynamic Data Input Fields
19.6.4 Update Executive Assistant Cockpit

Dynamic Data
This method can be used in update the dynamic data of a specific
members of a certain E/A Group/Cockpit.
A31003-H80A0-T101-1-7618, 11/2021
WSDL Return Codes

Version
D
subRC_DB_EA_ERROR
Table 857 Update Executive Assistant Cockpit Dynamic Data Return

Codes

EAGroupName The E/A group name that will be used as a Str
filter. Required
Table 858 Update Executive Assistant Cockpit Dynamic Data Input Fields
A31003-H80A0-T101-1-7618, 11/2021

Server Port A value representing the port of the Server Str
used with the group
MemberIdentifier The ServiceID / DN of the member to be Str
updated
PhoneIP A value indicating the Phone IP of the Enum EAM_Executive,
member EAM_Secretary,
EAM_Deputy
TypeExecutive Flag indicating if member is an executive Boolean
MemberName A name that can be used for the member Str
MemberStatus The current status of the EA member Enum EAC_EXEC_TO_ASNT_SOFT,
EAC_EXEC_TO_ASNT_REG,
EAC_EXEC_TO_ASNT_STRIC
T EAC_EXEC_IMM_RING,
EAC_EXEC_TO_EXEC_MOB,
EAC_EXEC_TO_EXEC_VMAIL,
EAC_EXEC_TO_NUMBER,
EAC_ASNT_AT_DESK,
EAC_ASNT_OFF_DESK,
EAC_ASNT_TO_ASNT_VMAIL
, EAC_ASNT_TO_ASNT_MOB,
EAC_ASNT_TO_NUMBER
MemberPreferenc Attribute that can be used for preferences Str
e
MemberForwardN A value indicating the forward number of the Str
umber member
MemberToNumber A value indicating the 'to' number of the Str
member
AdditionalInfo Additional information Str
Table 858 Update Executive Assistant Cockpit Dynamic Data Input Fields
A31003-H80A0-T101-1-7618, 11/2021
soap_ext_interfaces_upgrade.fm
Upgrade and Remote Patching
Get Node Info
20 Upgrade and Remote Patching

to support Upgrade and related Remote Patching operations.
Remote Patching capability allows semi-automating of the upgrade

process and allows a GUI interface to initiate this action. The role of the
SOAP Server for these requests is merely as a transport layer. The
requests are forwarded to the Upgrade Library for processing. SOAP
will not validate the requests or the sequence of operations attempted,
but instead will simply do a “flow through” to the Upgrade Library. Any
error message returned will be mapped back and returned to the client.
Note: These SOAP requests and responses are separately defined in the
interface definition (WSDL) file: siemens-hiq8000.upgrade.wsdl
20.1 Get Node Info

This method retrieves node software version, patch level information,
and other data about the system.

WSDL Version
subRC_SYS_SPT_ALLOC_ERROR
subRC_APP_SPT_NO_INIT_ERROR
subRC_APP_SPT_GEN_ERROR
subRC_APP_SPT_SERVER_ERROR
Table 859 Get Node Info Return Codes

OperatorId Please refer to the definition of OperatorId in Section 5.4, “Primitive Data required
Table 860 Get Node Info Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Get Node Patch Set List

CEName The CE (Cluster Element) 1..1024 Character String N/A
node name.
CEIP The CE node IP address. 1..1024 Character String N/A
NodeDBRole Indicates whether the enum RolePrimary N/A
database on the node is RoleSecondary
currently Primary or
Secondary.
NodeId Indicates whether the node is enum NodeId1 N/A
designated “Node 1” or “Node NodeId2
2”.
rtpVersion The RTP (Resilient Telco 1..1024 Character String N/A
Platform) software version
currently running on the
node.
patchVersion The patch set version 1..1024 Character String N/A
node.
osType The operating system type. 1..1024 Character String N/A
osVersion The operating system 1..1024 Character String N/A
version.
VIP Virtual IP address of the 1..1024 Character String N/A
cluster.
dbVersion The version of the Solid 1..1024 Character String N/A
database.
thirdPartyVersion The version of third party 1..1024 Character String N/A
software on the node.
Table 861 Get Node Info Output Fields
20.2 Get Node Patch Set List

This method retrieves the list of all patch sets available on a node or
on a DVD attached to a node. In response to this operation, a list of
patch sets is returned; for example:
11.00.01.ALL.12_PS0001 (UNSPps0001)
11.00.01.ALL.12_PS0002 (UNSPps0002)
11.00.01.ALL.12_PS0003 (UNSPps0003)
A31003-H80A0-T101-1-7618, 11/2021
Get SIS Patch Set List

WSDL Version
subRC_APP_SPT_PATCH_LOCATION_MISSING
subRC_APP_SPT_NODE_ID_MISSING
subRC_APP_SPT_TIMEOUT_ERROR
Table 862 Get Node Patch Set List Return Codes

NodeId Indicates whether the enum NodeId1 required
request is for “Node 1” or NodeId2
“Node 2”.
PatchLocation The location of the patch sets enum PatchLocationHIQ required
to report. Note that the PatchLocationDVD
options are OpenScape Voice
or DVD; for SIS, the request
GetSisPatchSetList must be
used.
Table 863 Get Node Patch Set List Input Fields

Value
PatchSetList A list of PatchSet elements, each containing the following attribute:
PatchSet. The name of a patch set. 1..1024 Character String N/A
PatchSetName
Table 864 Get Node Patch Set List Output Fields
20.3 Get SIS Patch Set List

This method retrieves the list of all patch sets available on a SIS
(Software Installation Server).
A31003-H80A0-T101-1-7618, 11/2021
Get SIS Patch Set List

WSDL Version
subRC_APP_SPT_SIS_IP_MISSING
subRC_APP_SPT_SIS_USER_MISSING
subRC_APP_SPT_SIS_PASSWORD_MISSING
Table 865 Get Sis Patch Set List Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Upgrade

sisIP The IP address of the SIS 1..1024 Character String required
(Software Installation
Server).
sisUser The user name with which to 1..1024 Character String required
log on to the SIS (Software
Installation Server).
sisIP The password with which to 1..1024 Character String required
Table 866 Get Sis Patch Set List Input Fields

PatchSetList A list of PatchSet elements, each containing the following attribute:
PatchSetName
Table 867 Get Sis Patch Set List Output Fields
20.4 Upgrade
This method initiates a new upgrade on a system. The upgrade will be
performed on the specified node of the system only.

WSDL Version
subRC_APP_SPT_CLIENT_ERROR
Table 868 Upgrade Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Upgrade

Value
NodeId Indicates whether the enum NodeId1 required
“Node 2”.
Note: This operation is

expected to be executed on
Node 1 only; it is not
supported for Node 2. To
upgrade the second node, the
UpgradeSecondNode
operation must be used.
upgradeMethod This specifies whether to use enum UpgradeMethodOnline UpgradeMetho
“Online”, ”Rolling” or “Split UpgradeMethodRolling dRolling
Mode Upgrade”. (The UpgradeMethodSMU
difference is if RTP uses
Online is stores copies of the
patches for rollback, while
Rolling does not).
Note: Only
UpgradeMethodRolling is
supported at this time.
patchSetToInsta The list of patchsets to be installed. Each element of the list consists of the following
ll attribute:
PatchSetName
patchSetToRem The list of patchsets to be removed. In the same operation request to remove patchsets
ove and add patchsets can be specified. Each element of the list consists of the following
attribute:
PatchSetName
PatchLocation - Indicates whether to enum PatchLocationHIQ PatchLocation
download the patches from PatchLocationDVD HIQ
the sis server or to pick them PatchLocationSIS
up from the OpenScape Voice
system at location or to use
them from the DVD. This is
enum with the options, SIS,
OpenScape Voice, or DVD
PatchSetNodeLo Indicates which node has the enum NodeId1 required
cation patchset, in case NodeId2
patchLocation = OpenScape
Voice or DVD.
Table 869 Upgrade Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Upgrade Second Node

Value
sisIP The IP address of the SIS 1..1024 Character String ““
(Software Installation
Server).
Required for
PatchLocationSIS.
sisUser The user name with which to 1..1024 Character String ““
Required for
PatchLocationSIS.
sisIP The password with which to 1..1024 Character String ““
Required for
PatchLocationSIS.
Table 869 Upgrade Input Fields (Seite 2 von 2)
20.5 Upgrade Second Node

This method initiates an upgrade on the second node of a system.
Normally this operation would be executed after the first node has been
upgraded successfully. No data parameters are included in the request,
since all necessary information has already been sent via the
“Upgrade” method.

WSDL Version
Table 870 Upgrade Second Node Return Codes

Value
Table 871 Upgrade Second Node Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Get Upgrade Status
20.6 Get Upgrade Status

This method returns the current status of an upgrade operation.

WSDL Version
Table 872 Get Upgrade Status Return Codes

Table 873 Get Upgrade Status Input Fields

Value
NodeId Indicates whether the enum NodeId1 N/A
“Node 2”.
CEName The CE node name. 1..1024 Character String N/A
message A message string with status 1..1024 Character String N/A
or error information.
percentageCompl The percentage of the integer 0..100 N/A
eted upgrade process that has
been completed (from 0 to
100%).
Table 874 Get Upgrade Status Output Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Upgrade Commit

Value
upgradeState The current state of the enum UpgradeStateUnknown N/A
upgrade. UpgradeStateNotRunning
UpgradeStateInProgress
UpgradeStateFailed
UpgradeStateFinishedFailed
UpgradeStateFinishedSuccessf
ul
UpgradeStatePreCommited
UpgradeStatePreSecondNodeU
pgrade
UpgradeStateFallbackFailed
UpgradeStateFallbackInProgres
s
UpgradeStateFallbackFinished
startTime The date and time when the 1..1024 Character String in the format: N/A
operation was started. YYYY-MM-DDTHH:MM:SS
operatorId The ID of the operator who Please refer to the definition of OperatorId N/A
initiated the operation. in Section 5.4, “Primitive Data Definitions”,
on page 78.
originatorIP The IP address of the client 1..20 Character String in valid IP N/A
that initiated the request. address format.
fromPatchSet The latest patchset 1..1024 Character String N/A
information from before the
upgrade was started.
toPatchSet The target patchset. 1..1024 Character String N/A
upgradeMethod Indicates the specified enum UpgradeMethodOnline N/A
upgrade method. UpgradeMethodRolling
UpgradeMethodSMU
Table 874 Get Upgrade Status Output Fields (Seite 2 von 2)
20.7 Upgrade Commit

This method finalizes the upgrade by allowing it to be committed.
Normally performed after verification of system health, call processing,
and other checks are completed on the upgraded system.

WSDL Version
Table 875 Upgrade Commit Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Upgrade Fallback

Value
Table 876 Upgrade Commit Input Fields
20.8 Upgrade Fallback

This method performs a fallback of the most recent (i.e. the current)
upgrade attempt. It is used if errors are reported or manual verification
checks fail on the upgraded system. Fallback will (attempt to) uninstall
the upgrade on both nodes, if applicable.

WSDL Version
Table 877 Upgrade Fallback Return Codes

Value
Table 878 Upgrade Fallback Input Fields
20.9 Get Node Health

This method is identical to the Get Node Info request, except that in
addition to the information provided, it also includes the results of the
RapidStat utility that can be used to report errors or warnings
regarding the status of the switch.
Attention: This request may take longer to complete due to the time
required to perform the RapidStat inquiry. If a faster response is
needed, the GetNodeInfo request should be used.
A31003-H80A0-T101-1-7618, 11/2021
Get Node Health

WSDL Version
Table 879 Get Node Health Return Codes

Table 880 Get Node Health Input Fields

Value
CEName The CE (Cluster Element) 1..1024 Character String N/A
node name.
NodeDBRole Indicates whether the enum RolePrimary N/A
database on the node is RoleSecondary
currently Primary or
Secondary.
NodeId Indicates whether the node is enum NodeId1 N/A
designated “Node 1” or “Node NodeId2
2”.
rtpVersion The RTP (Resilient Telco 1..1024 Character String N/A
Platform) software version
node.
patchVersion The patch set version 1..1024 Character String N/A
node.
osType The operating system type. 1..1024 Character String N/A
osVersion The operating system 1..1024 Character String N/A
version.
VIP Virtual IP address of the 1..1024 Character String N/A
cluster.
Table 881 Get Node Health Output Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Query Operation Mode

Value
dbVersion The version of the Solid 1..1024 Character String N/A
database.
thirdPartyVersion The version of third party 1..1024 Character String N/A
software on the node.
RapidStatDataList A structured list of all warnings and errors reported by the RapidStat tool. Each list
element (RapidStatDataEntry) contains the following fields:
RapidStatDataEntr The type of message reported enum RSWarning N/A
y. by RapidStat. RSError
RapidStatMessageT
ype
RapidStatDataEntr The text of the message 1..1024 Character String N/A
y. reported by RapidStat.
RapidStatMessage
Table 881 Get Node Health Output Fields (Seite 2 von 2)
20.10 Query Operation Mode

This function will return the own node and partner node Operation
Mode state of a cluster system. The following are possible operation
mode states:
• Normal
• NormalC
• StandAonePrimary
• StandAloneSync
• StandAloneSecondary
• StandAlone
• ShuttingDown
• Unknown

OperatorId The operator issuing the command. Please refer to the definition of Operator ID in Section
5.4.2, “Field Definitions”, on page 79.
Table 882 Query Operation Mode Output Fields
A31003-H80A0-T101-1-7618, 11/2021
Modify Operation Mode
20.11 Modify Operation Mode


OperatorId The operator issuing the Please refer to the definition of Operator ID in Section
command. 5.4.2, “Field Definitions”, on page 79.
NewOpMode Mandatory field. Specifies the enum OpModeNormal
operation mode status of the node OpModeStandAlonePrimary
of the cluster to be modified. OpModeStandAloneSecond
The craftsperson can manually ary
change the operation mode of a
node in a cluster only if the two
nodes cannot communicate with
one another over the cross-
channel.
The allowed from states are:
• StandAlonePrimary
• StandAloneSecondary
The manual modification is allows
for only the own node because
there is no communication with
the partner node.
Required field
Table 883 Modify Operation Mode Input Fields
20.12 Get Database Role

This Web Service will retrieve the Database Role of the OSV. The new
API will be used by Assistant to determine which OSV node hosts the
Primary Database connection so as to direct Mass Provisioning
Commands/Operations in that node only.

WSDL Version
subRC_APP_DSA_DBROLE_RETRIEVAL_FAIL
Table 884 Get Database Role Return Codes

OperatorId Yes I/F Char array 40 (1…40)
operator
Table 885 Get Database Role Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Get Database Role

Result A typical structure containing return codes (indicating success/failure/error
cases), invocation timestamp along with various informative messages.
Return code list is displayed below.
GetDBRoleResult The Database Node Result returns an enumerator indicating the possible
values of the Database Connection: The possible values are: RolePrimary,
RoleSecondary
Table 886 Get Database Role Output Fields
A31003-H80A0-T101-1-7618, 11/2021
Get Database Role
A31003-H80A0-T101-1-7618, 11/2021
soap_ext_interfaces_traffic_types.fm
Traffic Types and Classes of Restrictions
Create Traffic Type
21 Traffic Types and Classes of Restrictions

FRN3454 introduced a new concept for the existing functionality of
Traffic Types, where additional Traffic Types shall be able to be
provisioned on System Level (Global Numbering Plan) and be used by
Destination Codes and Code Indices for translation.
A collection of Traffic Types shall be able to be grouped together under

a new Provisioning Entity called Class of Restriction. Classes of
restrictions shall be used by the features TRS (Subscribers,
FeatureProfile, Endpoint Profile), CFR (Subscribers, Features Profile),
AuthCode (Subscribers, Features Profile), in order to determine
whether to disallow the call or request an authorization code before
allowing the call to go through.
21.1 Create Traffic Type

Soap Server shall be enhanced in order to support the provisioning of
new Traffic Types in the Default Number Plan (Global Translation and
Routing Tab of Assistant). There will exist two Variants of Traffic Types:
Emergency and Generic. The administrator shall be able to provision
127 additional Generic Traffic Types but shall not be able to provision
additional Emergency Traffic Types. The Variant will not be exposed in
this interface.
Validations to be performed by Soap Server are: Presence of

Mandatory Traffic Type Name, Usage of Invalid characters, Length of
Traffic Type Name, Already Existing Traffic Type Name.
Effective starting with V6, the administrator can enter a TrafficType

value/id, which shall be associated with the TrafficType Name. The new
field is optional. Validations shall be performed by SDAL/SOAP and
appropriate error messages shall be returned whenever:
• Invalid Trafifc Type ID/Value has been selected
• The Traffic Type ID/Value is already being used

subRC_APP_TRAFFIC_TYPE_NAME_LEN_INVALID
subRC_APP_TTNAME_SDAL_INITIALIZATION_ERROR
subRC_APP_TTNAME_ALREADY_EXISTS
subRC_APP_TT_TYPE_LIMIT_EXCEED
subRC_APP_GENERAL_SDAL_ERROR
Table 887 Create Traffic Type Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Create Traffic Type
Field Name Require Description Type Max Length Default Value

d (Range)
OperatorId Yes I/F operator Char array 40 (1…40) N/A
TrafficTypeName Yes I/F Traffic Type Name Char array 32 (1…32) N/A
Traffic Type Id No I/F Traffic Type ID int N/A
Table 888 Create Traffic Type Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Modify Traffic Type

Return code list is displayed above.
Table 889 Create Traffic Type Output Fields
21.2 Modify Traffic Type

Soap Server shall be enhanced in order to support the modification of
the Name of an already provisioned Traffic Type.
Validations to be performed by Soap Server are in addition to the ones

in the Create Interface: Already existing New Traffic Type Name, Non
existing Traffic Type for the Old Traffic Type Name.

subRC_APP_NEW_TRAFFIC_TYPE_NAME_NOT_PROVIDED
subRC_APP_TTNAME_NON_EXISTING
subRC_APP_TTNAME_ALREADY_EXISTS
Table 890 Modify Traffic Type Return Codes
Field Name Require Description Type Max Length Default

d (Range) Value
NewTrafficTypeNa Yes I/F New Traffic Type Name Char array 32 (1…32) N/A
me
Table 891 Modify Traffic Type Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Delete Traffic Type

Table 892 Modify Traffic Type Output Fields
21.3 Delete Traffic Type

Soap Server shall be enhanced to support the deletion of a Generic
Traffic Type. Validations to be performed are: Non Existing Traffic Type,
Specific Traffic Type is being used in translation by Destination Codes/
Code Indices; Specific Traffic Type is being used by a Class of
Restriction or Destination Codes.

subRC_APP_TTNAME_REFERENCED_BY_XDM
subRC_APP_TTNAME_REFERENCED_BY_COR
subRC_APP_TTNAME_EMERGENCY
subRC_APP_TTNAME_NON_EXISTING
Table 893 Delete Traffic Type Return Codes

d (Range) Value
Table 894 Delete Traffic Type Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Query Traffic Type

Table 895 Delete Traffic Type Output Fields
21.4 Query Traffic Type

Soap Server supports the List retrieval of Traffic Type Names together
with an indication of whether it is a generic or an emergency Traffic
type. Filtering on TrafficType Name, Ascending or Descending Order as
well as Paging Information shall be supported.
Effective with V6 the new TrafficType ID/value field is returned for each
TrafficType Name. Sorting of the retrieved list based on TrafficType ID/
Value shall also be supported along with the TrafficType Name.

subRC_APP_TT_QUERY_LIST_FAIL
Table 896 Query Traffic Type Return Codes

d (Range) Value
TrafficTypeName No I/F Traffic Type Name Char array 32 (1…32) N/A
TrafficTypevariant No I/F Traffic Type Enumerator - -
Page Number No number of the retrieved result Integer - -
set
Page Size No Page size of the retrieved Integer [1-128] -
result set
Sorting No The sort order of the retrieved Enumerator Ascending Ascending
result set Descending
TTSortType No Sort filter criteria for the Enumerator TTSortByNam TTSortByNa
Traffic types e, me
TTSortByValu
e
Table 897 Query Traffic Type Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Create Class Of Restrictions

PaginatedInfo A common paging structure containing Current Page/ Num of Pages / Page
Size etc.
QueryTrafficType List A list containing Traffic Type Names with an indication of Generic or
Emergency
Table 898 Query Traffic Type Output Fields
21.5 Create Class Of Restrictions

Soap Server shall be enhanced in order to support the provisioning of
a Class of Restriction in the Default Number Plan (Global Translation
and Routing Tab of Assistant). The Class of Restriction shall consist of
a List with a combination of Generic Traffic Types.
Soap Server shall provide the name of the Class of restriction along
with the names of Traffic Types found in the list in SDAL, which shall
set the values in the bitmaps.
Validations to be performed: Presence of mandatory COR Name, COR

Name Length validation, Already existing COR Name, Traffic Type
Name does not exist; List contains Traffic Type of Variant Emergency.

Table 899 Create COR Return Codes

d (Range) Value
CORName Yes I/F COR Name Char array 32 (1…32) N/A
TrafficTypeNamesLi No The list of Traffic Types to be associated with COR
st
Table 900 Create COR Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Modify Class Of Restrictions

Table 901 Create COR Output Fields
21.6 Modify Class Of Restrictions

Soap Server shall be enhanced in order to support the modification of
the name of a Class of Restriction if a new name is provided. Moreover,
modification of the Traffic Type List associated with the COR shall be
supported.
It is important to note that Assistant shall have to always send the List
of Traffic Types when using the ModifyClassofRestriction API. Based on
the List of Traffic Types in the request, the old bitmap shall be reset and
set again.
Validations to be performed are in addition to the ones in the Create

Interface: Already existing New COR Name, Not existing Traffic Types
for COR Name, Non Existing Traffic Types, List of Traffic Types contains
an Emergency one.

Table 902 Modify COR Return Codes

d (Range) Value
NewCORName Yes I/F New COR Type Name Char array 32 (1…32) N/A
TrafficTypeNamesLi No The list of Traffic Types to be associated with COR
st
Table 903 Modify COR Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Delete Class Of Restrictions

Return code list is displayed above.Return code list is displayed above.
Table 904 Modify COR Output Fields
21.7 Delete Class Of Restrictions

Soap Server shall be enhanced in order to support the deletion of a
Class of restriction. Validations to be performed are: Non Existing Class
of Restriction, Class of Restriction is in use by services.

subRC_APP_COR_NAME_LEN_INVALID
subRC_APP_CORNAME_SDAL_INITIALIZATION_ERROR
subRC_APP_CORNAME_NON_EXISTING
subRC_APP_CORNAME_REFERENCED_BY_SERVICES
Table 905 COR Input Fields

d (Range) Value
Table 906 Delete COR Input Fields

Table 907 Delete COR Output Fields
21.8 Query Class Of Restrictions

Soap Server shall be enhanced in order to support the retrieval of the
list of Class of Restriction Names. The interface shall support paging as
well as paging/sorting based on the COR Name
A31003-H80A0-T101-1-7618, 11/2021
Query Class Of Restrictions Info List

subRC_APP_COR_NAME_QUERY_LIST_FAIL
Table 908 Query COR Names List Input Fields

d (Range) Value
CORName No I/F COR Name Char array 32 (1…32) N/A
set
Page Size No Page size of the retrieved Integer - -
result set
Table 909 Query COR Names List Input Fields

Size etc.
QueryCORNames List A list containing COR Names
Table 910 Query COR Names List Output Fields
21.9 Query Class Of Restrictions Info List

Soap Server shall be enhanced in order to support the query for the
values of the Traffic Types in a specific Class of Restriction. Paging shall
not be supported since a list of up to 128 Traffic Types should be fine.
Sorting based on Traffic Types shall be supported but filtering shall not
be applicable.
A31003-H80A0-T101-1-7618, 11/2021
Query COR Usage List

subRC_APP_COR_NAME_QUERY_LIST_FAIL
Table 911 Query COR Info List Input Fields

d (Range) Value
Table 912 Query COR Info List Input Fields

CORName The name of the COR for which TrafficType List shall be retrieved
TrafficTypeNamesList The list of Traffic Types to be associated with COR
Table 913 Query COR Info List Output Fields
21.10 Query COR Usage List

Soap Server shall be enhanced in order to support the retrieval of the
list of Subscribers and/or Endpoint Profiles that are using the Class of
Restriction through the Call Forward Restrictions (CFR), the AuthCode
and TRS services. In the case of TRS, a standard as well an alternate
Class of Restriction can be provisioned. The Query Interface shall
display the usage of both Standard and Alternate Class of Restrictions.

subRC_APP_CORNAME_NON_EXISTING
Table 914 Query COR Usage List Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Query COR Group Key List

d (Range) Value
set
result set
Table 915 Query COR Usage List Input Fields

Size etc.
CORUsageList The list of Usage Information for the requested COR. The UsageListEntry shall
return: UsageName, UsageType (UndefinedUsageType, Subscriber,
EndpointProfile),and Boolean indication for: StandardTollRestrictions,
AlternateTollRestrictions, CallForwardRestrictions, AuthorizationCodes
Table 916 Query COR Usage List Output Fields
21.11 Query COR Group Key List

The Authorization Code Toll Restriction Override service is a system
wide service that allows administrators to create groups of
authorization codes. For each group a class of restriction can be
defined that contains the toll restricted traffic types that are
overridden. Authorization Code Groups are formed by simply using the
leading digits of the authorization codes as the key that identifies a
group.
This feature is activated system-wide by setting the Srx/Main/

AuthTRSOverride RTP parameter to true. The group keys and Class of
restriction associations are stored in the Srx/Main/
AuthTRSOverrideValues RTP parameter in the following format:
<GroupKey1>:<COR1>;<GroupKey2>:<COR2>; ….
A31003-H80A0-T101-1-7618, 11/2021
Query COR Group Key List
Once activated, all off-net destinations marked with a generic traffic

type (i.e. non-emergency traffic type) will be restricted unless the
traffic type is listed in a class of restriction assigned to the authorization
code group to which the authorization code entered on the call belongs.
After the validation of an entered authorization code, the Authorization

Code Toll Restriction Override service when activated, matches the
entered authorization code against the Authorization Code Group keys.
• If no key matches, then no toll restrictions will be overridden,

i.e. the currently restricted traffic types will remain in effect and
the call will be released as if the call were restricted by the toll
restriction service.
• If 1 key matches, then the traffic type of the call will be looked
up in the class of restriction that is associated to the key. If it is
listed, then the call may proceed. If it is not listed, the call will
be released as if the call were restricted by the toll restriction
service.
• If more than 1 key matches, the best matching key (on key
length) is used. The traffic type of the call will be looked up in
the class of restriction that is associated to the matching key. If
it is listed, then the call may proceed. If it is not listed, the call
will be released as if the call were restricted by the toll restriction
service.
The QueryCORGroupKeyList API returns a list of the Authorization Code

Group Keys that are associated with the requested Class of Restriction.

d (Range) Value
set
result set
Table 917 Query COR Group Key List Input Fields
A31003-H80A0-T101-1-7618, 11/2021
CSTA Applications

Size etc.
CORGroupKeyList The list of COR Group Key information for the requested COR Group.
Table 918 Query COR Group Key List Output Fields
21.12 CSTA Applications

SOAP supports the creation, modification, query and deletion of CSTA
applications, the retrieval of the list of provisioned applications as well
as the list of active devices for each application. When a CSTA
application is created, modified or removed from the system, SOAP the
associated packet filter rules are updated. Up to 256 applications are
allowed to be provisioned. CSTA application can be provisioned using
IPv4 addresses only.
The following APIs are used for the provisioning of CSTA applications:
• GetCSTAApplicationList
• CreateCSTAApplication
• ModifyCSTAApplication
• QueryCSTAApplication
• GetCSTAActiveDeviceList
• DeleteCSTAApplication
• GetCSTASMInfo
21.12.1 GetCSTAApplicationList
The GetCSTAApplicationList API (starting in V7.00.06.01) allows the
retrieval of the list of CSTA applications provisioned in the system.
Table 919 lists the input fields of GetCSTAApplicationListRequest:
A31003-H80A0-T101-1-7618, 11/2021
CSTA Applications
Require
Field Description Type Default Value [Range]
d
ApplicationType Allows filtering of the result no Enumerati CSTAAppTypeAll
per application type or on CSTAAppTypeOpenscape
quering for all application CSTAAppTypeThirdParty
CSTAAppTypeTelefonica
CSTAAppTypeUnknown
CSTAAppTypeNA
SortType The sort criterion applied to no Enumerati CSTAAppSortTypeApplicationT
the request. on ype
CSTAAppSortTypeIP
CSTAAppSortTypeNameCSTA
AppSortTypeConnected
Table 919 GetCSTAApplicationListRequest fields
Table 920 lists the input fields of GetCSTAApplicationListResult:
Field Description Type Range - Length

displayed below.
ApplicationList A list of ApplicationData elements
(ApplicationList) A structure containing the following data
ApplicationData
(ApplicationData) Provides a description of the Char array 1..64
ApplicationName CSTA application.
ApplicationName is a unique
identifier. If a CSTA application
is connected before it is
provisioned it has a default
name which is the
application’s IP address.
(ApplicationData) The (unique) IP of the Char array 1..45
IPAddress application in IPv4 format.
Table 920 GetCSTAApplicationListResult fields
A31003-H80A0-T101-1-7618, 11/2021
CSTA Applications
(ApplicationData) The type of the application. Enumeration CSTAAppTypeOpenscape

ApplicationType Value Unkown is set to an CSTAAppTypeThidParty
application if the application CSTAAppTypeTelefonica
connects before provisioned. CSTAAppTypeUnknown
CSTAAppTypeNA
(ApplicationData) Indicates if the application is Boolean False, true
Connected currently connected. This
means that the application
has established a CSTA over
TCP or CSTA over HTTP/SOAP
connection
(ApplicationData) The number of active CSTA Unsigned Integer -
Monitors monitored devices
(ApplicationData) The number of active CSTA Unsigned Integer -
RouteRegistrations route registration devices
Totals A structure containing the following data
(Totals) The total number of active Unsigned Integer -
RouteRegistrations CSTA monitored devices
(Totals) The total number of active Unsigned Integer -
Monitors CSTA monitored devices
Table 920 GetCSTAApplicationListResult fields
The following table shows the possible error codes of

GetCSTAApplicationList API:

Version
V7.00.06.01
subRC_DB_GENERAL_SDAL_DB_ERROR SDAL DB General Error
subRC_APP_GENERAL_SDAL_ERROR General SDAL Error
Table 921 GetCSTAApplicationList Return Codes
21.12.2 CreateCSTAApplication
The CreateCSTAApplication API (starting with V7.00.06.01) allows the

provisioning of new CSTA applications. The creation of an application
with existing IP address or name is blocked. Up to 256 applications
are allowed to be created.
Table 922 lists the input fields of CreateCSTAApplicationRequest:
A31003-H80A0-T101-1-7618, 11/2021
CSTA Applications
Require Default Value

Field Description Type
d [Range]
Identification A required structure containing the following data
(Identification ) The (unique) IP of the yes Char array 1..45
ApplicationIPAddress application in IPv4 format.
Maximum length is 45 characters
to allow future use of IPv6
addressing.
(Identification ) Provides a description of the yes Char array 1..64
ApplicationName CSTA application. The
identifier of an application. If a
CSTA application is connected
before they are provisioned it
has a default name which is the
application’s IP address. If the
application type is Telefonica
then this name is copied to the
Application ID located in the
Operational Data section.
(Identification ) CSTAAppTypeOpenscape no Enumerati CSTAAppTypeOpensca
ApplicationType CSTAAppTypeThidParty on pe (default)
CSTAAppTypeTelefonica CSTAAppTypeThidPart
y
CSTAAppTypeTelefonic
a
(ApplicationInterface no Boolean
Options)
EnableSIPUr
SOAPHeartbeat A structure containing the following data.
(SOAPHeartbeat) Port that applications use when no Unsigned Default: 7780
SOAPListenerPort connecting to OpenScape Voice Integer 80, 1024 - 65535
via CSTA over HTTP/SOAP.
CSTA over HTTP/SOAP uses
same IP address as CSTA over
TCP.
(SOAPHeartbeat) System Status Heartbeat timer no Unsigned Default: 0
HeartbeatTimer interval value. A value of 0 Integer 0-3600
disables the heartbeat function.
(SOAPHeartbeat) System Status Heartbeat no Unsigned Default: 0
HeartbeatWatchdog watchdog timer value. Integer 70..360
(SOAPHeartbeat) System Status Heartbeat retry no Unsigned Default: 0
HeartbeatRetryCount value. Integer 0..5
Table 922 CreateCSTAApplicationRequest fields
A31003-H80A0-T101-1-7618, 11/2021
CSTA Applications
OperationalData A structure containing the following data. Applicable only to application of type
ApplicationTypeTelefonica.
(OperationalData) The Application ID. If this field is no Char array 1..64
ApplicationID not provided then it corresponds
to the ApplicationName of the
Identity section.
(OperationalData) Telefonica Enterprise no Char array Default: 000000
EnterpriseID Identification prefixed to 6..8
subscriber deviceIDs presented
to Telefonica application.
(OperationalData) Telefonica prefixes this code to no Char array Default: 000000
PASCODE the routedSelected parameter 1..8
when routing to the mobile
network VPN. CRS uses this
parameter to determine when to
invoke Route End with
RouteEndReason =
endCstaDistribution.
(OperationalData) Telefonica outside access code no Char array 1..30
OutsideAccess for external number conversion.
(OperationalData) Used to convert subscriber no Char array 1..30
BGName extension to fully qualified
number via new mapping
function.
NPName extension to fully qualified
function.
(BgACL) BG Name used as an ACL value. string
BGName
Table 922 CreateCSTAApplicationRequest fields
Table 923 lists the fields of CreateCSTAApplicationResult:

cases), invocation timestamp along with various informative messages. Return
code list is displayed below.
Table 923 CreateCSTAApplicationResult fields

CreateCSTAApplication API:
A31003-H80A0-T101-1-7618, 11/2021
CSTA Applications

Version
subRC_APP_COMM_OPERATOR_INVALID Invalid Operator name. Length invalid or
characters not allowed.
subRC_APP_CSTA_INVALID_VALUE Invalid Value provided
subRC_APP_CSTA_INVALID_APP_IP Invalid Value provided
subRC_APP_CSTA_INVALID_APP_TYPE Invalid value provided: Application Type.
Allowed values: Openscape, ThirdParty,
Telefonica
subRC_APP_CSTA_INVALID_APP_NAME Invalid Value provided
subRC_APP_CSTA_INVALID_OPERATION_DATA Operational data may only be provided for
Applications of type Telefonica
Operational data are required for

V7.00.06.0 Applications of type Telefonica
1
subRC_APP_CSTA_BG_NP_REQUIRED At least one of BGName,NPName must be
provided for Applications of type
Telefonica
subRC_APP_CSTA_APP_IP_EXISTS A CSTA Application with the specified IP
Address already exists
subRC_APP_CSTA_APP_NAME_EXISTS A CSTA Application with the specified
Name already exists
subRC_APP_CSTA_APP_MAX_APPS_REACHED A CSTA Application with the specified
Name already exists
subRC_DB_GENERAL_SDAL_DB_ERROR A CSTA Application with the specified
Name already exists
subRC_APP_GENERAL_SDAL_ERROR A CSTA Application with the specified
Name already exists
subRC_APP_CSTA_BG_NP_MUTUALLY_EXCLUSIVE BGName and NPName are mutually
exclusive for Applications of type
Telefonica
subRC_APP_CSTA_PFR_UPDATE_ERROR secPacketFilter.AddCstaAppRule Failed
subRC_APP_CSTA_APP_SOASF_RTP_SEND_ERROR Failed to send message to SOASF
Table 924 CreateCSTAApplication Return Codes
21.12.3 ModifyCSTAApplication
The ModifyCSTAApplication API (starting with V7.00.06.01) allows the

modification of a CSTA application. If the IP address of an application
is changed SOAP will update the packets filtering rules. SOAP does not
allow the modification of the ApplicationType of an existing
application, except the transition from type Unknown to other types.
A31003-H80A0-T101-1-7618, 11/2021
CSTA Applications
Table 925 lists the fields of ModifyCSTAApplicationRequest:
Field Description Require Type Default Value

d [Range]
ApplicationIPAddress The (unique) IP of the application to yes Char array 1..45
be updated in IPv4 format.
Maximum length is 45 characters to
allow future use of IPv6 addressing.
(Identification) The new IP of the application in IPv4 yes Char array 1..45
ApplicationIPAddress format. This IP must unique among
applications.
(Identification) Provides a description of the CSTA yes Char array 1..64
ApplicationName application. ApplicationName is a
unique identifier. If a CSTA
application is connected before they
are provisioned it has a default
name which is the application’s IP
address. If the application type is
Telefonica then this name is copied
to the Application ID located in the
(Identification) The type of the application. no Enumerati CSTAAppTypeOpensca
ApplicationType Application type may be: on pe (default)
CSTAAppTypeOpenscape (default) CSTAAppTypeThidPart
CSTAAppTypeThidParty y
CSTAAppTypeTelefonica CSTAAppTypeTelefonic
CSTAAppTypeNA a
CSTAAppTypeNA
Options)
EnableSIPUr
(SOAPHeartbeat) Port that applications use when no Unsigned Default: 7780
SOAPListenerPort connecting to OpenScape Voice via Integer 80, 1024 - 65535
CSTA over HTTP/SOAP. CSTA over
HTTP/SOAP uses same IP address as
CSTA over TCP.
(SOAPHeartbeat) System Status Heartbeat timer no Unsigned Default: 0
HeartbeatTimer interval value. A value of 0 disables Integer 0-3600
the heartbeat function.
(SOAPHeartbeat) System Status Heartbeat watchdog no Unsigned Default: 0
HeartbeatWatchdog timer value. Integer 70..360
(SOAPHeartbeat) System Status Heartbeat retry no Unsigned Default: 0
HeartbeatRetryCount value. Integer 0..5
Table 925 ModifyCSTAApplicationRequest fields
A31003-H80A0-T101-1-7618, 11/2021
CSTA Applications
(OperationalData) The Application ID. If this field is not no Char array 1..64
ApplicationID provided then it corresponds to the
ApplicationName of the Identity
section.
(OperationalData) Telefonica Enterprise Identification no Char array Default: 000000
EnterpriseID prefixed to subscriber deviceIDs 6..8
presented to Telefonica application.
(OperationalData) Telefonica prefixes this code to the no Char array Default: 000000
PASCODE routedSelected parameter when 1..8
routing to the mobile network VPN.
CRS uses this parameter to
determine when to invoke Route
End with RouteEndReason =
(OperationalData) Telefonica outside access code for no Char array 1..30
OutsideAccess external number conversion.
BGName extension to fully qualified number
via new mapping function.
NPName extension to fully qualified number
BGName
Table 925 ModifyCSTAApplicationRequest fields
Table 926 lists the fields of ModifyCSTAApplicationResult:

A typical structure containing return codes (indicating success/failure/error
Result cases), invocation timestamp along with various informative messages. Return
Table 926 ModifyCSTAApplicationResult fields

ModifyCSTAApplication API:
A31003-H80A0-T101-1-7618, 11/2021
CSTA Applications

Version
subRC_APP_COMM_OPERATOR_INVAL Invalid Operator name. Length invalid or characters not
ID allowed.
subRC_APP_CSTA_INVALID_APP_TYPE Invalid value provided: Application Type. Allowed
values: Openscape, ThirdParty, Telefonica
subRC_APP_CSTA_INVALID_APP_NAM Invalid Value provided
E
subRC_APP_CSTA_INVALID_OPERATI Operational data may only be provided for Applications
ON_DATA of type Telefonica
Operational data are required for Applications of type

Telefonica
subRC_APP_CSTA_BG_NP_REQUIRED At least one of BGName,NPName must be provided for
V7.00.06.0 Applications of type Telefonica
1 subRC_APP_CSTA_APP_IP_EXISTS A CSTA Application with the specified IP Address
already exists
subRC_APP_CSTA_APP_NAME_EXISTS A CSTA Application with the specified Name already
exists
subRC_DB_GENERAL_SDAL_DB_ERRO A CSTA Application with the specified Name already
R exists
subRC_APP_GENERAL_SDAL_ERROR A CSTA Application with the specified Name already
exists
subRC_APP_CSTA_BG_NP_MUTUALLY_ BGName and NPName are mutually exclusive for
EXCLUSIVE Applications of type Telefonica
subRC_APP_CSTA_PFR_UPDATE_ERRO secPacketFilter.ModifyCstaAppRule Failed
R
subRC_APP_CSTA_APP_SOASF_RTP_S Failed to send message to SOASF
END_ERROR
subRC_APP_CSTA_APP_NOT_PRESENT No CSTA Application with the specified IP Address exists
subRC_APP_CSTA_APP_MOD_FAILED_ Failed to Modify CSTA Application. Active Monitored
MONITORED_DEVICES_EXIST devices exist
subRC_APP_CSTA_APP_MOD_FAILED_ Failed to Modify CSTA Application. Route Registered
ROUTE_REG_DEVICES_EXIST devices exist
subRC_APP_CSTA_APP_MOD_FAILED_ Failed to Modify CSTA Application. CSTA Application is
CONNECTED connected
Table 927 ModifyCSTAApplication Return Codes
A31003-H80A0-T101-1-7618, 11/2021
CSTA Applications
21.12.4 QueryCSTAApplication
The QueryCSTAApplication API (starting with V7.00.06.01) allows the

retrieval of the data of a CSTA application provisioned in the system.
Table 928 lists the fields of QueryCSTAApplicationRequest:

d [Range]
IPAddress The (unique) IP of the application to yes Char array 1..45
be queried in IPv4 format.
Table 928 QueryCSTAApplicationRequest Fields
Table 929 lists the fields of QueryCSTAApplicationResult:

A typical structure containing return codes (indicating success/failure/error cases),
Result invocation timestamp along with various informative messages. Return code list is
displayed below.
Identification A structure containing the following data
(Identification) The IP of the application IPv4
Char array 1..45
ApplicationIP format.
(Identification)
The name of the CSTA application. Char array 1..64
ApplicationName
The type of the application.
Application type may be: ApplicationTypeOpenscape
(Identification) ApplicationTypeOpenscape ApplicationTypeThidParty
Enumeration
ApplicationType ApplicationTypeThidParty ApplicationTypeTelefonica
ApplicationTypeTelefonica ApplicationTypeUnkown
ApplicationTypeUnkown
Options)
EnableSIPUri

Table 929 QueryCSTAApplicationResult Fields
A31003-H80A0-T101-1-7618, 11/2021
CSTA Applications
Port that applications use when

connecting to OpenScape Voice via
(SOAPHeartbeat ) Unsigned
CSTA over HTTP/SOAP. CSTA 80, 1024 - 65535
SOAPListenerPort Integer
over HTTP/SOAP uses same IP
address as CSTA over TCP.
System Status Heartbeat timer
(SOAPHeartbeat ) Unsigned
interval value. A value of 0 0-3600
HeartbeatTimer Integer
disables the heartbeat function.
(SOAPHeartbeat ) System Status Heartbeat Unsigned
70..360
HeartbeatWatchdog watchdog timer value. Integer
(SOAPHeartbeat )
System Status Heartbeat retry Unsigned
HeartbeatRetryCoun 0..5
value. Integer
t
A structure containing the following data. Applicable only to application of type
OperationalData
(OperationalData) The Application ID. If this field
ApplicationID is not provided then it
corresponds to the Char array 1..64
ApplicationName of the
Identity section.
(OperationalData) Telefonica Enterprise
EnterpriseID Identification prefixed to
Char array 6..8
subscriber deviceIDs presented
to Telefonica application.
(OperationalData) Telefonica prefixes this code to the
PASCODE routedSelected parameter when
routing to the mobile network
VPN. CRS uses this parameter to Char array 1..8
determine when to invoke Route
End with RouteEndReason =
(OperationalData) Telefonica outside access code for
Char array 1..30
OutsideAccess external number conversion.
(OperationalData) Used to convert subscriber
BGName extension to fully qualified number Char array 1..30
(OperationalData) Used to convert subscriber
NPName extension to fully qualified number Char array 1..30
A31003-H80A0-T101-1-7618, 11/2021
CSTA Applications
ApplicationStatus A structure containing the following data

(ApplicationStatus) Enumeration Active
The SOAP heartbeat status.
Status Inactive
(ApplicationStatus) Date and time of last update of Char array 0..256
StatusLastUpdate SOAP heartbeat status.
(ApplicationStatus) The application connection status. Enumeration CSTAAppConnectionStatusD
ConnectionStatus own
CSTAAppConnectionStatusU
p
CSTAAppConnectionStatusFa
iled
CSTAAppConnectionStatusR
etrieved
(ApplicationStatus) Char array 0..256
Date and time of last update of
ConnectionStatus
application connection status.
LastUpdate
(ApplicationStatus) Boolean
SecureConnected
(ApplicationStatus) The status of the application Enumeration Active
SessionStatus session service heartbeat. Inactive
(ApplicationStatus) Date and time of last update of the Char array 0..256
SessionStatus status of the application session
LastUpdate service heartbeat.
SupportedWebServi A list of WebServiceName elements
ceNames
(SupportedWebServi Supported web service name Char array 1..64
ceNames)
WebServiceName
BGName

QueryCSTAApplication API:
WSDL
Return Codes Message
Version
Table 930 QueryCSTAApplication Return Codes
A31003-H80A0-T101-1-7618, 11/2021
CSTA Applications

V7.00.06.0
subRC_APP_CSTA_APP_NOT_PRESENT No CSTA Application with the
1
specified IP Address exists
Table 930 QueryCSTAApplication Return Codes
21.12.5 GetCSTAActiveDeviceList
The GetCSTAActiveDeviceList API (starting with V7.00.06.01) allows

the retrieval of the list of subscriber DNs with active CSTA monitors or
route registrations for a CSTA application.
Table 931 lists the fields of GetCSTAActiveDeviceListRequest:

d [Range]
ApplicationIP The (unique) IP of the yes Char array 1..45
application to be queried for
active devices in IPv4 format.
DeviceID Allows filtering for a Service ID. no Char array 0..30
Supports ‘*’ and ‘?’ wildcards.
DeviceFilter Allowes filtering for devices with no Enumerati CSTADeviceFilterAll
active CSTA monitors, active on CSTADeviceFilterMonitor
CSTA route registrations, CSTADeviceFilterRouteReg
subscriber devices only, NID istrations,
devices only or all devices. CSTADeviceFilterSubscribe
r,
CSTADeviceFilterNID
DeviceSortType Allows sorting by ServiceID-NID, no Enumerati
EBGID, Monitored and Route on CSTADeviceSortTypeServic
Registration. eId,
CSTADeviceSortTypeEBGI
d
CSTADeviceSortTypeMonit
or
CSTADeviceSortTypeRoute
Registration
Table 931 GetCSTAActiveDeviceListRequest Fields
Table 932 lists the fields of GetCSTAActiveDeviceListResult:
A31003-H80A0-T101-1-7618, 11/2021
CSTA Applications

A typical structure containing return codes (indicating success/failure/error cases),
Result invocation timestamp along with various informative messages. Return code list is
displayed below.
A common paging structure containing Current Page/ Num of Pages / Page Size
PaginatedInfo
etc.
ActiveDeviceList A list of active device elements
(ActiveDeviceList)
A structure containing the following data
ActiveDeviceData
For Subscriber Devices:
If the application type is
Telefonica then the Service ID is
returned in
(ActiveDeviceData) EID+ExtensionFormat. For other
application types the device Char array 0..15
DeviceId
number is presented in FQN
format.
For NID Devices:
The NID of the device.
The EBGID. Applicable for
(ActiveDeviceData)
Telefonica application type only Char array 1..32
EBGID
and Subscriber device type.
Indicates whether this device has
(ActiveDeviceData)
active monitors for the CSTA Boolean False, true
Monitored
application.
Indicates whether this device has
(ActiveDeviceData)
active Route Registrations for the Boolean False, true
RouteRegistration
CSTA application.
(ActiveDeviceData) Indicates whether this device is a CSTADeviceTypeSubscriber
Enumeration
Type Subscriber or NID CSTADeviceTypeNID
Table 932 GetCSTAActiveDeviceListResult Fields

GetCSTAActiveDeviceListAPI:
WSDL
Version
Table 933 GetCSTAActiveDeviceList Return Codes
A31003-H80A0-T101-1-7618, 11/2021
CSTA Applications

V7.00.06.0
1
Table 933 GetCSTAActiveDeviceList Return Codes
21.12.6 DeleteCSTAApplication
The DeleteCSTAApplication API (starting with V7.00.06.01) will allow

the deletion of a CSTA application.
Table 934 lists the fields of DeleteCSTAApplicationRequest:

d [Range]
ApplicationIPAddress The (unique) IP of the yes Char array 1..45
application to be deleted in IPv4
format.
Table 934 DeleteCSTAApplicationRequest Fields
Table 935 lists the fields of DeleteCSTAApplicationResult:

Table 935 DeleteCSTAApplicationResult fields
The following table shows the possible error codes of DeleteCSTAApplication

API:
WSDL
Version
Table 936 DeleteCSTAApplication Return Codes
A31003-H80A0-T101-1-7618, 11/2021
CSTA Applications
subRC_APP_COMM_OPERATOR_INVALID Invalid Operator name.

Length invalid or
subRC_APP_CSTA_APP_NOT_PRESENT No CSTA Application with
the specified IP Address
exists
subRC_APP_CSTA_APP_DEL_FAILED_MONITORED_DEVICES_EXIS Failed to Delete CSTA
V7.00.06.0 T Application. Active
1 Monitored devices exist
subRC_APP_CSTA_APP_DEL_FAILED_ROUTE_REG_DEVICES_EXIS Failed to Delete CSTA
T Application. Route
Registered devices exist
subRC_APP_CSTA_APP_DEL_FAILED_CONNECTED Failed to Delete CSTA
Application. CSTA
Application is connected
subRC_APP_DB_GENERAL_SDAL_DB_ERROR SDAL DB General Error
Table 936 DeleteCSTAApplication Return Codes
21.12.7 GetCSTASMInfo
The GetCSTASMInfo API (starting with V7.00.06.01) allows the

retrieval of the status of CSTA SM.
Table 937 lists the fields of GetCSTASMInfoRequest:

d [Range]
Char
OperatorId I/F operator yes NA [1…40]
array
Table 937 GetCSTASMInfoRequest Fields
Table 938 lists the fields of GetCSTASMInfoResult:
A31003-H80A0-T101-1-7618, 11/2021
CSTA Applications

displayed below.
CSTAStatus A structure containing the following data
(CSTAStatus) The current status of CSTA SM. Enumeration CSTASMStatusNormal
Status CSTASMStatusEnabled
CSTASMStatusDisabled
CSTASMStatusPartiallyDisabled
CSTASMStatusOverloadReache
d
CSTASMStatusOverloadRelieve
d
(CSTAStatus) The date and time in text format Char array 0..256
LastUpdate of the last update of CSTA SM
status.
Table 938 GetCSTASMInfo fields
A31003-H80A0-T101-1-7618, 11/2021
CSTA Applications
A31003-H80A0-T101-1-7618, 11/2021
soap_ext_interfaces_csta.fm
CSTA Applications
Get CSTA Application List
22 CSTA Applications
SOAP supports the creation, modification, query and deletion of CSTA
applications, the retrieval of the list of provisioned applications as well
as the list of active devices for each application. When a CSTA
application is created, modified or removed from the system, SOAP the
associated packet filter rules are updated. Up to 256 applications are
allowed to be provisioned. CSTA application can be provisioned using
IPv4 addresses only.
The following APIs are used for the provisioning of CSTA applications:
• GetCSTAApplicationList
• CreateCSTAApplication
• ModifyCSTAApplication
• QueryCSTAApplication
• GetCSTAActiveDeviceList
• DeleteCSTAApplication
• GetCSTASMInfo
22.1 Get CSTA Application List

The GetCSTAApplicationList API (starting in V7.00.06.01) allows the
retrieval of the list of CSTA applications provisioned in the system.

ApplicationType Allows filtering of the result no Enumerat CSTAAppTypeAll?
per application type or io n CSTAAppTypeOpen
quering for all application scape?
CSTAAppTypeThird

Table 939 Get CSTA Application List Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
CSTA Applications
Get CSTA Application List

SortType The sort criterion applied to no Enumerat CSTAAppSortTypeApplica
the request. io n tionTyp e?
CSTAAppSortTypeIP?
CSTAAppSortTypeNameC

Table 939 Get CSTA Application List Input Fields (Seite 2 von 2)

PaginatedInfo A common paging structure containing Current Page/ Num of Pages / Page Size
etc.
ApplicationList A list of ApplicationData elements
(ApplicationList)? A structure containing the following data
ApplicationData
(ApplicationData)? Provides a description of the Char array 1..64
identifier. If a CSTA
application is connected
before it is provisioned it has
a default name which is the
application’s IP address.
(ApplicationData)? The (unique) IP of the Char array 1..45
IPAddress application in IPv4 format.
(ApplicationData)? The type of the Enumeration CSTAAppTypeOpensc

ApplicationType application. Value ape?
Unkown is set to an CSTAAppTypeThidPar
application if the ty?
application connects CSTAAppTypeTelefoni
before provisioned. ca?
CSTAAppTypeUnkno
wn
Table 940 Get CSTA Application List Output Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
CSTA Applications
Create CSTA Application

(ApplicationData)? Indicates if the application Boolean False, true
Connected is currently connected. This
means that the application
has established a CSTA
over TCP or CSTA over
HTTP/SOAP connection
(ApplicationData)? The number of active CSTA Unsigned Integer -
Monitors monitored devices
(ApplicationData)? The number of active CSTA Unsigned Integer -
RouteRegistrations route registration devices
Totals A structure containing the following data

(Totals)? The total number of active Unsigned Integer -
RouteRegistrations CSTA
monitored devices
(Totals)? The total number of active Unsigned Integer -
Monitors CSTA
monitored devices
Table 940 Get CSTA Application List Output Fields (Seite 2 von 2)

GetCSTAApplicationList
V7.00.06.01 subRC_APP_COMM_OPERATOR_INVALID Invalid Operator name. Length

invalid or characters not
allowed.
Table 941 Get CSTA Application List Return Codes
22.2 Create CSTA Application

The CreateCSTAApplication API (starting with V7.00.06.01) allows the
provisioning of new CSTA applications. The creation of an application
with existing IP address or name is blocked. Up to 256 applications are
allowed to be created.
A31003-H80A0-T101-1-7618, 11/2021
CSTA Applications

(Identification )? The (unique) IP of the yes Char array 1..45
ApplicationIPAddress application in IPv4 format.
Maximum length is 45
(Identification )? Provides a description of the yes Char array 1..64

ApplicationName CSTA application. The
identifier of an application. If
a CSTA application is
connected before they are
provisioned it has a default
name which is the
application’s IP address. If
the application type is
Telefonica then this name is
copied to the Application ID
located in the Operational
Data section.
(Identification )? CSTAAppTypeOpens no Enumerat CSTAAppTypeOpenscap e
ApplicationType cape? io n (default)?
CSTAAppTypeThidPa CSTAAppTypeThidParty?
rty? CSTAAppTypeTelefonica
CSTAAppTypeTelefo
nica
(SOAPHeartbeat)? Port that applications use no Unsigned Default: 7780?
SOAPListenerPort when connecting to Integer 80, 1024 - 65535
OpenScape Voice via CSTA
over HTTP/SOAP. CSTA over
HTTP/SOAP uses same IP
address as CSTA over TCP.
(SOAPHeartbeat)? System Status Heartbeat no Unsigned Default: 0?
HeartbeatTimer timer interval value. A Integer 0-3600
value of 0 disables the
heartbeat function.
HeartbeatRetryCount retry value. Integer 0..5
Table 942 Create CSTA Application Input Fields (Seite 1 von 3)
A31003-H80A0-T101-1-7618, 11/2021
CSTA Applications

(OperationalDa The Application ID. If this no Char array 1..64
ta) field is not provided then it
ApplicationID corresponds to the
Identity section.
(OperationalData)? Telefonica Enterprise no Char array Default: 000000?
subscriber deviceIDs
presented to Telefonica
application.
(OperationalData)? Telefonica prefixes this code no Char array Default: 000000?
PASCODE to the routedSelected 1..8
parameter when routing to
the mobile network VPN.
determine when to invoke
Route End with
RouteEndReason =
(OperationalData)? Telefonica outside access no Char array 1..30
OutsideAccess code for external number
conversion.
(OperationalData)? Used to convert subscriber no Char array 1..30
function.
function.
(Interface Options) Indicates whether no Boolean false
EnableConsultCallFor Consultation Call for [false, true]
ConnectOnHold Connections on Hold is
enabled
(Interface Options) Indicates whether CID no Boolean false
EnableCIDSuppressio Suppression Status is [false, true]
nStatus enabled.
A31003-H80A0-T101-1-7618, 11/2021
CSTA Applications

(Interface Options) Indicate whether Alternative no Boolean false
EnableAlternativeCID CID List is enabled. [false, true]
List
DisableApplicationPop Application Populated CID is [false, true]
ulatedCID disabled.
(Interface Options) Indicates whether CSTA will no Boolean (Interface Options)

EnableCFPrivilegeCha get privilege update EnableCFPrivilegeChange
ngeNotification notifications Notification
(Interface Options) Indicates whether we get no Boolean (Interface Options)
EnableAllMembersBus notification when all EnableAllMembersBusyNo
yNotification members of a Hunt Group tification
are busy
(Interface Options) Reserved field no Boolean false
Reserved_1 [false, true]


EnableCFPrivilegeCha Can only be changed when the no Boolean false

ngeNotification selected application is [false, true]
currently not connected to
OSV

Table 943 Create CSTA Application Output Fields
A31003-H80A0-T101-1-7618, 11/2021
CSTA Applications
A31003-H80A0-T101-1-7618, 11/2021
CSTA Applications
WSDL Version Return Codes Message

allowed.
Length invalid or
subRC_APP_CSTA_INVALID_APP_TYPE Invalid value provided:
Application Type. Allowed
values: Openscape,
ThirdParty, Telefonica
subRC_APP_CSTA_INVALID_OPERATION_DATA Operational data may only be
provided for
V7.00.06.01 Applications of type Telefonica?
?
Operational data are required
for Applications of type
Telefonica
subRC_APP_CSTA_BG_NP_REQUIRED At least one of
BGName,NPName must be
provided for Applications of
type Telefonica
subRC_APP_CSTA_APP_IP_EXISTS A CSTA Application with
the specified IP Address
already exists
subRC_APP_CSTA_APP_NAME_EXISTS A CSTA Application with the
specified Name already
exists
subRC_APP_CSTA_APP_MAX_APPS_REACHED A CSTA Application with the
exists
subRC_DB_GENERAL_SDAL_DB_ERROR A CSTA Application with the
exists
subRC_APP_GENERAL_SDAL_ERROR A CSTA Application with the
exists
subRC_APP_CSTA_BG_NP_MUTUALLY_EXCLUSIVE BGName and NPName are
mutually exclusive for
A31003-H80A0-T101-1-7618, 11/2021
Applications of type Telefonica
CSTA Applications
Modify CSTA Application
22.3 Modify CSTA Application

The ModifyCSTAApplication API (starting with V7.00.06.01) allows the
modification of a CSTA application. If the IP address of an application
is changed SOAP will update the packets filtering rules. SOAP does not
allow the modification of the ApplicationType of an existing application,
except the transition from type Unknown to other types.

application to be updated in
IPv4 format. Maximum
length is 45 characters to
allow future use of IPv6
addressing.
(Identification)? The new IP of the yes Char array 1..45
ApplicationIPAddress application in IPv4
format. This IP must
unique among
applications.
(Identification)? Provides a description of the yes Char array 1..64
identifier. If a CSTA
application is connected
before they are provisioned
it has a default name which
is the application’s IP
address. If the application
type is Telefonica then this
name is copied to the
Application ID located in the
(Identification)? The type of the application. no Enumerat CSTAAppTypeOpenscap e
ApplicationType Application type may be: ion (default)?
CSTAAppTypeOpenscape CSTAAppTypeThidParty?
(default)? CSTAAppTypeTelefonica
CSTAAppTypeThidParty?
CSTAAppTypeTelefonica
Table 945 Modify CSTA Application Input Fields (Seite 1 von 3)
A31003-H80A0-T101-1-7618, 11/2021
CSTA Applications

(SOAPHeartbeat)? Port that applications use no Unsigned Default: 7780?
SOAPListenerPort when connecting to Integer 80, 1024 - 65535
OpenScape Voice via CSTA
over HTTP/SOAP. CSTA
over HTTP/SOAP uses
same IP address as CSTA
over TCP.
HeartbeatTimer timer interval value. A value Integer 0-3600
of 0 disables the heartbeat
function.
HeartbeatRetryCount retry value. Integer 0..5
(OperationalDa The Application ID. If this no Char array 1..64
ta) field is not provided then it
ApplicationID corresponds to the
Identity section.
(OperationalData)? Telefonica Enterprise no Char array Default: 000000?
application.
(OperationalData)? Telefonica prefixes this code no Char array Default: 000000?
PASCODE to the routedSelected 1..8
Route End with
RouteEndReason
= endCstaDistribution.
(OperationalData)? Telefonica outside no Char array 1..30
OutsideAccess access code for
external number
conversion.
A31003-H80A0-T101-1-7618, 11/2021
CSTA Applications

function.
function.
enabled
(Interface Options) Indicates whether CID no Boolean false
nStatus enabled.
(Interface Options) Indicate whether Alternative no Boolean false

List
ulatedCID disabled.
(Interface Options) Indicates whether CSTA will no Boolean (Interface Options)

EnableCFPrivilegeCha get privilege update EnableCFPrivilegeChange
ngeNotification notifications Notification
(Interface Options) Indicates whether we get no Boolean (Interface Options)
EnableAllMembersBus notification when all EnableAllMembersBusyNo
yNotification members of a Hunt Group tification
are busy


EnableCFPrivilegeCha Can only be changed when the no Boolean false

ngeNotification selected application is [false, true]
currently not connected to
OSV
A31003-H80A0-T101-1-7618, 11/2021
CSTA Applications

Table 946 Modify CSTA Application List Output Fields
A31003-H80A0-T101-1-7618, 11/2021
CSTA Applications
Query CSTA Application
subRC_APP_COMM_OPERATOR_INVALI D Invalid Operator name.

Length invalid or
subRC_APP_CSTA_INVALID_APP_TYPE Invalid value provided:
Application Type. Allowed
subRC_APP_CSTA_INVALID_OPERATION Operational data may only be
_DATA provided for Applications of type
Telefonica?
subRC_APP_CSTA_BG_NP_REQUIRED At least one of

BGName,NPName must be
subRC_APP_CSTA_APP_IP_EXISTS A CSTA Application with the
subRC_APP_CSTA_APP_NAME_EXISTS A CSTA Application with the
subRC_DB_GENERAL_SDAL_DB_ERRO R A CSTA Application with the
V7.00.06.01 specified Name already exists
subRC_APP_GENERAL_SDAL_ERROR A CSTA Application with the
subRC_APP_CSTA_BG_NP_MUTUALLY_ EXCLUSIVE BGName and NPName are
mutually exclusive for
subRC_APP_CSTA_PFR_UPDATE_ERRO R secPacketFilter.ModifyCstaAppR
ule Failed
subRC_APP_CSTA_APP_SOASF_RTP_S END_ERROR Failed to send message to
SOASF
subRC_APP_CSTA_APP_MOD_FAILED_ Failed to Modify CSTA
MONITORED_DEVICES_EXIST Application. Active Monitored
subRC_APP_CSTA_APP_MOD_FAILED_R Failed to Modify CSTA
OUTE_REG_DEVICES_EXIST Application. Route Registered
subRC_APP_CSTA_APP_MOD_FAILED_CONNECTED Failed to Modify CSTA
Application. CSTA
Table 947 Modify CSTA Application List Return Codes
22.4 Query CSTA Application

The QueryCSTAApplication API (starting with V7.00.06.01) allows the
retrieval of the data of a CSTA application provisioned in the system.
A31003-H80A0-T101-1-7618, 11/2021
CSTA Applications

IPAddress The (unique) IP of the yes Char array 1..45
application to be queried in
IPv4 format.
Table 948 Query CSTA Application Fields

Identification A structure containing the following data
(Identification)? The IP of the application Char array 1..45
ApplicationIP IPv4 format.
(Identification)? The name of the CSTA Char array 1..64

application.
ApplicationName
The type of the application. ApplicationTypeOpensc

Enumeration
Application type may be: ape?
ApplicationTypeO ApplicationTypeThidPar
(Identification)? ty?
penscape?
ApplicationType ApplicationTypeTelefoni
ApplicationTypeTh
idParty? ca?
ApplicationTypeTe ApplicationTypeUnkown
lefonica?
ApplicationTypeU
nkown
Port that applications use Unsigned 80, 1024 - 65535
when connecting to Integer
(SOAPHeartbeat )? OpenScape Voice via CSTA
SOAPListenerPort over HTTP/SOAP. CSTA
over HTTP/SOAP uses same
IP address as CSTA over
TCP.
Table 949 Query CSTA Application Output Fields (Seite 1 von 4)
A31003-H80A0-T101-1-7618, 11/2021
CSTA Applications

System Status Heartbeat Unsigned
(SOAPHeartbeat )? 0-3600
timer interval value. A Integer
HeartbeatTimer value of 0 disables the
heartbeat function.
(SOAPHeartbeat )? System Status Unsigned 70..360
HeartbeatWatchdog Heartbeat watchdog Integer
timer value.
(SOAPHeartbeat )? Unsigned
HeartbeatRetryCount System Status Heartbeat Integer 0..5
retry value.
A structure containing the following data. Applicable only to application of type
OperationalData ApplicationTypeTelefonica.
(OperationalData)? The Application ID. If this Char array 1..64
ApplicationID field is not provided then
it corresponds to the
Identity section.
(OperationalData)? Telefonica Enterprise Char array 6..8
EnterpriseID Identification prefixed to
application.
(OperationalData)? Telefonica prefixes this Char array 1..8
PASCODE code to the routedSelected
Route End with
RouteEndReason =
(OperationalData)? Telefonica outside Char array 1..30
OutsideAccess access code for external
number conversion.
(OperationalData)? Used to convert subscriber
Char array 1..30
function.
A31003-H80A0-T101-1-7618, 11/2021
CSTA Applications

(OperationalData)? Used to convert subscriber
Char array 1..30
function.
ApplicationStatus A structure containing the following data
(ApplicationStatus)? Enumeration Active?
Status The SOAP heartbeat status. Inactive
(ApplicationStatus)? Date and time of last update Char array 0..256
StatusLastUpdate of SOAP
heartbeat status.
(ApplicationStatus)? The application connection Enumeration CSTAAppConnectionStatus
ConnectionStatus status. Dow n ?
CSTAAppConnectionStatus
Up?
CSTAAppConnectionStatusF
aile d?
CSTAAppConnectionStatus
Retri eved
(ApplicationStat Char array 0..256
us)? Date and time of
ConnectionStatu last update of
s LastUpdate application
connection status.
(ApplicationStatus)? The status of the Enumeration Active?
SessionStatus application session Inactive
service heartbeat.
(ApplicationStat Date and time of last Char array 0..256
us)? update of the status of the
SessionStatus application session service
LastUpdate heartbeat.
SupportedWebServic A list of WebServiceName elements
e
Names
(SupportedWebServ Supported web service name Char array 1..64
ice Names)?
WebServiceName
A31003-H80A0-T101-1-7618, 11/2021
CSTA Applications
Get CSTA Active Device List

(Interface Options) Indicates whether Boolean false
enabled
(Interface Options) Indicates whether CID Boolean false
nStatus enabled.
(Interface Options) Indicate whether Alternative Boolean false

List
(Interface Options) Indicates whether Boolean false
ulatedCID disabled.
(Interface Options) Reserved field Boolean false




V7.00.06.01
specified
Table 950 Query CSTA Application Return Codes
22.5 Get CSTA Active Device List
A31003-H80A0-T101-1-7618, 11/2021
CSTA Applications
The GetCSTAActiveDeviceList API (starting with V7.00.06.01) allows

the retrieval of the list of subscriber DNs with active CSTA monitors or
route registrations for a CSTA application.

ApplicationIP The (unique) IP of the yes Char array 1..45
application to be queried for
DeviceID Allows filtering for a no Char array 0..30

Service ID. Supports ‘*’
DeviceFilter Allowes filtering for devices no Enumerat CSTADeviceFilterAll?
with active CSTA monitors, ion CSTADeviceFilterMonitor?
active CSTA route CSTADeviceFilterRouteRe
registrations, subscriber gist rations,?
devices only, NID devices CSTADeviceFilterSubscrib
DeviceSortType Allows sorting by no Enumerat

ServiceID-NID, EBGID, ion CSTADeviceSortTypeServ
Monitored and Route iceI d,?
Registration. CSTADeviceSortTypeEBG
Id?

Table 951 Get CSTA Active Device List Input Fields

PaginatedInfo A common paging structure containing Current Page/ Num of Pages / Page Size
etc.
ActiveDeviceList A list of active device elements
(ActiveDeviceList)?
ActiveDeviceData A structure containing the following data
Table 952 Get CSTA Active Device List Output Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
CSTA Applications

For Subscriber Devices: Char array 0..15
If the application type is

Telefonica then the Service
ID is returned in
(ActiveDeviceData)? EID+ExtensionFormat. For
DeviceId other application types the
device number is presented
in FQN format.
For NID Devices:
The NID of the device.

The EBGID. Applicable for
(ActiveDeviceData)? Char array 1..32
Telefonica application type
EBGID only and Subscriber device
type.
Indicates whether this
(ActiveDeviceData)? Boolean False, true
device has active
Monitored monitors for the CSTA
application.
Indicates whether this
(ActiveDeviceData)? Boolean False, true
device has active Route
RouteRegistration Registrations for the
CSTA application.
(ActiveDeviceData)? Indicates whether this Enumeration CSTADeviceTypeSubscriber?
Type device is a CSTADeviceTypeNID
Subscriber or NID
Table 952 Get CSTA Active Device List Output Fields (Seite 2 von 2)

V7.00.06.01
specified
Table 953 Get CSTA Active Device List Return Codes
A31003-H80A0-T101-1-7618, 11/2021
CSTA Applications
Delete CSTA Application
22.6 Delete CSTA Application

The DeleteCSTAApplication API (starting with V7.00.06.01) will
allow the deletion of a CSTA application.

application to be deleted in
Table 954 Delete CSTA Application Input Fields

Table 955 Delete CSTA Application Output Fields

Length invalid or characters

subRC_APP_CSTA_APP_DEL_FAILED_MONITORED_DE Failed to Delete CSTA
VICES_EXIST Application. Active Monitored
subRC_APP_CSTA_APP_DEL_FAILED_ROUTE_REG_DE Failed to Delete CSTA

V7.00.06.01 VICES_EXIST Application. Route Registered
subRC_APP_CSTA_APP_DEL_FAILED_CONNECTED Failed to Delete CSTA

Application. CSTA Application is
subRC_APP_DB_GENERAL_SDAL_DB_ERROR SDAL DB General Error

Table 956 Delete CSTA Application Return Codes
A31003-H80A0-T101-1-7618, 11/2021
CSTA Applications
Get CSTASM Info
22.7 Get CSTASM Info

The GetCSTASMInfo API (starting with V7.00.06.01) allows the
retrieval of the status of CSTA SM

Table 957 Get CSTASM Info Input Fields

cases), invocation timestamp along with various informative messages. Return
CSTAStatus A structure containing the following data
(CSTAStatus)? The current status of CSTA Enumeration CSTASMStatusNormal?
Status SM. CSTASMStatusEnabled?
CSTASMStatusDisabled?
CSTASMStatusPartiallyDisab
led?
CSTASMStatusOverloadReac
hed?
CSTASMStatusOverloadReli
eved
(CSTAStatus)? The date and time in text Char array 0..256
LastUpdate format of the last update of
CSTA SM status.
Table 958 Get CSTASM Info Output Fields
A31003-H80A0-T101-1-7618, 11/2021
CSTA Applications
Get CSTASM Info
A31003-H80A0-T101-1-7618, 11/2021
soap_ext_interfaces_cont_trace.fm
Continuous Trace
Get Continuous Trace Info
23 Continuous Trace
23.1 Get Continuous Trace Info

WSDL Version
subRC_SUCCESS
Table 959 Get Continuous Trace Return Codes

on page 78.
InterfaceWSDL Please refer to Section 5.4, For more information, refer to Section
“Primitive Data Definitions”, 5.1.1, “The Interface WSDL and Interface
on page 78. Release Control”, on page 73.
ClientId Of the SOAP Client string
Table 960 Get Continuous Trace Input Fields

Result A typical structure containing
return codes (indicating
success/failure/error cases),
invocation timestamp along
with various informative
messages. Return code list is
displayed above.
TracingInfo A structure containing the following
TracingWrite A structure containing the following
Filter enum • extern247
• normal247
• min247
TracingReadOnl structure containing the following
y
TrcState boolean True, False
TrcStatus string
Table 961 Get Continuous Trace Output Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
Continuous Trace
Activate Continuous Trace

HostExportInfo A Structure containing the following.
HostExportWrt Structure containing the following.
NameOrIp string
isHost boolean True, False
Directory string
LoginName string
Passwd string
HostExportRd Structure containing the following.
ExpState boolean
ExpStatus string
ExpTextDetails string
Table 961 Get Continuous Trace Output Fields (Seite 2 von 2)
23.2 Activate Continuous Trace

WSDL Version
subRC_SUCCESS
subRC_xxxx
Table 962 Activate Continuous Trace Return Codes

on page 78.
activateContTrc Structure containing the following
Rq
OperatorId string
Filter enum • extern247
• normal247
• min247
Table 963 Activate Continuous Trace Input Fields
A31003-H80A0-T101-1-7618, 11/2021
Continuous Trace
DeActivate Continuous Trace

above.
Table 964 Activate Continuous Trace Output Fields
23.3 DeActivate Continuous Trace

WSDL Version
subRC_SUCCESS
subRC_xxxx
Table 965 DeActivate Continuous Trace Return Codes

on page 78.
deactivateContT Structure containing the following
rcRq
OperatorId string
Table 966 DeActivate Continuous Trace Input Fields

above.
Table 967 DeActivate Continuous Trace Output Fields
23.4 Start File Export
A31003-H80A0-T101-1-7618, 11/2021
Continuous Trace
Stop File Export

WSDL Version
subRC_SUCCESS
subRC_xxxx
Table 968 Start File Export Return Codes

on page 78.
startFileExpRq Structure containing the following
OperatorId string
NameOrIp string
isHost boolean True, False
Directory string
LoginName string
Passwd string
Table 969 Start File Export Input Fields

above.
Table 970 Start File Export Output Fields
23.5 Stop File Export

WSDL Version
subRC_SUCCESS
subRC_xxxx
Table 971 Stop File Export Return Codes
A31003-H80A0-T101-1-7618, 11/2021
Continuous Trace
Stop File Export

on page 78.
stopFileExpRq Structure containing the following
OperatorId string
Table 972 Start File Export Input Fields

above.
Table 973 Start File Export Output Fields
A31003-H80A0-T101-1-7618, 11/2021
soap_alarms.fm
Alarms and Log Events
Alarms
24 Alarms and Log Events
24.1 Alarms
The subscriber provisioning component issues alarms under some
conditions, and in order to accomplish this, the following macro is
called:
SRX_ALARM_EVENT ( eventSet,
eventId,
swnode,
faultyObject1,
faultyObject2,
faultyObject3,
errorText)
The following subsections describe each of the alarms that may be

reported.
24.1.1 SOAP Server Process Exit

This alarm is issued when a SOAP Server child process ends for any
reason.
This may be part of a normal shutdown of the OpenScape Voice

system. If it is not, then subscriber management has experienced
some problem during the processing of a subscriber provisioning
request and either produced a core dump or exited in an attempt to
restart its connections and recover.
This alarm will be reported each time soapServer child process

terminates abnormally. The process will restart automatically. Since
each SOAP Server child process uses a unique port number to accept
SOAP requests, the port number is used in this alarm to identify which
child process terminated. If the parent SOAP Server terminates
abnormally, a number of alarms equal to the number of currently
configured child processes (default: 4) will be reported.
The process is automatically restarted, and there is no manual action

required by the operator other than to report the occurrence to
OpenScape Voice support personnel. If the process ended due to a core
dump, there may be symptoms such as a stack trace or a core dump
file in the /unisphere/srx3000/srx/40/core directory.
Table 974 shows the values of the alarm event fields for this alarm.
A31003-H80A0-T101-1-7618, 11/2021
soap_alarms.fm
Alarms
Field Description
Event Set ID GLOBAL_EVENT_SET_ID (value: 217)
Event ID GLOBAL_ERROR_EXIT_EVT_ID (value: 8)
Faulty Object 1 The node on which the alarm condition occurred.
Faulty Object 2 “SrxSoapGroup”
Faulty Object 3 The listening port number of the SOAP Server child process that has
terminated; for example “8767”.
Error Text “Process terminating abnormally”
Table 974 SOAP Server Process Exit Alarm Data
24.1.2 SOAP Server Process Startup

This alarm is issued when a SOAP Server child process starts (or
restarts after an exit).
Since each SOAP Server child process uses a unique port number to
accept SOAP requests, the port number is used in this alarm to identify
which child process started. On a normal startup of the SOAP Server, a
number of alarms equal to the number of currently configured child
processes (default: 4) will be reported.
This is a normal occurrence and there is no manual action required by

the operator.
Note: This alarm clears the “SOAP Server Process Exit” alarm.
Field Description
Event ID GLOBAL_PROCESS_ACTIVE_EVT_ID (value: 5)
Faulty Object 2 “SrxSoapGroup”
Faulty Object 3 The listening port number of the SOAP Server child process that has started
up.
Error Text “Process completely initialized and active”
Table 975 SOAP Server Process Startup Alarm Data
A31003-H80A0-T101-1-7618, 11/2021
soap_alarms.fm
Alarms
24.1.3 Submgt Schedule Process Exit

This alarm is issued when the submgtSchedule process ends for any
reason.
This may be part of a normal shutdown of the OpenScape Voice

system. If it is not, then subscriber management has experienced
some problem during the processing of a background job and either
produced a core dump or exited in an attempt to restart its connections
and recover.
The process is automatically restarted, and there is no manual action

required by the operator other than to report the occurrence to
OpenScape Voice support personnel. If the process ended due to a core
dump, there may be symptoms such as a stack trace or a core dump
file in the /unisphere/srx3000/srx/40/core directory.
Field Description
Faulty Object 2 “SrxSubmgtSchedGroup”
Faulty Object 3 “submgtSchedule<NN>”
Error Text “Process terminating abnormally”
Table 976 Submgt Schedule Process Exit Alarm Data
Note: The “Faulty Object 3” field contains the exact name of the
subscriber management scheduler process, which ends in “01” on one
node of a cluster and “02” on the other. This information is redundant
since the node is already specified in “Faulty Object 1” but is included
for completeness.
24.1.4 Submgt Schedule Process Startup

This alarm is issued when the submgtSchedule process starts up (or
restarts after an exit). This is a normal occurrence and there is no
manual action required by the operator.
Note: This alarm clears the “SubmgtSchedule Process Exit” alarm.
A31003-H80A0-T101-1-7618, 11/2021
soap_alarms.fm
Alarms
Field Description
Faulty Object 2 “SrxSubmgtSchedGroup”
Faulty Object 3 “submgtSchedule<NN>”
Error Text “Process completely initialized and active”
Table 977 SubmgtSchedule Process Startup Alarm Data
Note: The “Faulty Object 3” field contains the exact name of the
subscriber management scheduler process, which ends in “01” on one
node of a cluster and “02” on the other. This information is redundant
since the node is already specified in “Faulty Object 1” but is included
for completeness.
24.1.5 Error Removing Old Jobs

This alarm is issued when the submgtSchedule process has failed to
remove old jobs. These are background jobs that have been executed
and remain stored in the database for a certain number of days after
their completion (the exact number of days are configurable by RTP
parameters, but by default the retention time is 3 days for successful
jobs and 5 days for jobs that ended in error or were partially executed.
If the automatic removal of these jobs could not be performed for some
reason, this alarm is reported.
There is no action necessary on the part of the operator other than to

notify support personnel.
Field Description
Event Set ID SUBMGMT_EVENT_SET_ID (value: 207)
Event ID SUBMGMT_REMOVE_RES_ERROR (value: 5)
Faulty Object 2 “SOAP”
Faulty Object 3 “JOBS”
Error Text “The Job to remove old jobs failed: RC[<NN>]”
Table 978 Error Removing Old Jobs Alarm Data
A31003-H80A0-T101-1-7618, 11/2021
soap_alarms.fm
Log Events
Attention: <NN> in the “Error Text” field contains the error return
code that was received from the lower level function call used by the
submgtSchedule process to remove the old jobs.
24.1.6 Old Jobs Removed Successfully

This alarm is issued when the submgtSchedule process has
successfully removed old jobs. These are background jobs that have
been executed and remain stored in the database for a certain number
of days after their completion (the exact number of days are
configurable by RTP parameters, but by default the retention time is 3
days for successful jobs and 5 days for jobs that ended in error or were
partially executed.
Whenever the automatic removal of these jobs was performed

successfully, this alarm is reported.
This is a normal occurrence and there is no action necessary on the part

of the operator.
Note: This alarm clears the “Error Removing Old Jobs” alarm.
Field Description
Event Set ID SUBMGMT_EVENT_SET_ID (value: 207)
Event ID SUBMGMT_REMOVE_RES_SUCCESS (value: 6)
Faulty Object 2 “SOAP”
Faulty Object 3 “JOBS”
Error Text “Old resources removed”
Table 979 Old Jobs Removed Successfully Alarm Data
24.2 Log Events

The subscriber provisioning component issues log events under some
conditions, and in order to accomplish this, the following macro is
called:
A31003-H80A0-T101-1-7618, 11/2021
soap_alarms.fm
Log Events
OpLogReport (fileName,
lineNumber,
logCategory,
logPriority,
logAppReason,
format,
args )
The following subsections describe each of the log events that may be
reported. The fileName and lineNumber always indicate the location in
the source code that originated the log event, and thus are not
mentioned below. The “format” parameter allows for the possibility to
report additional data by using a formatted string, and the contents of
the “args” parameter correspond to the data items to be inserted into
the formatted string.
24.2.1 Error Accessing the Database

This log event is issued whenever the processing of a SOAP request
encounters a failure that corresponds to a database access error. Table
980 shows the values of the log event fields for this event.
Field Description
logCategory OP_LOG_CAT_DATABASE_CON_ERR
logPriority OP_LOG_PRI_HIGH
logAppReason 0
format “SOAP Database Access error, RC[%u]”
args return code
Table 980 Example of Database Error
24.2.2 Provisioning Error

This log event is issued whenever the processing of a SOAP request
encounters a failure that corresponds to an internal error. Table 981
shows the values of the log event fields for this event.
Field Description
logCategory OP_LOG_CAT_PROVISIONING_ERR
logPriority OP_LOG_PRI_HIGH
logAppReason 0
format “SOAP Provisioning error, RC[%u]”
args return code
Table 981 Example of an Internal Error
A31003-H80A0-T101-1-7618, 11/2021
soap_alarms.fm
Display of OSV Error Provisoning Logs
24.3 Display of OSV Error Provisoning Logs

Effective starting with V6, ther is support of execution of log file
exportation in an asynchronous way.
The Interfaces unsp__CollectLogFiles has been implemented that

parses all log files: HiQLogProvisioning.log.* located under /log
directory. The API is able identify log entries that their form is as the
following example:
{
serial_number => 44070,
time => <Tue Sep 14 16:44:19 2010<,
time_secs => 1284471859,
time_usecs => 504918,
process_name => <sipsm11<,
file_name => <sipResolver.cc<,
line_num => 319,
pid => 10495,
log_priority => <HIGH<,
log_category => <SUB_PROVISIONING_ERR<,
log_appl_reason => 72,
component_id => <UNKNOWN<,
appl_event_id => 72,
num_prior_occurences => 0,
managed_suppression_count => 10,
managed_suppression_time => 1,
data_length => 116,
data => <SUBSCRIBE mesg received with invalid Group
pickup URI access code=*78 from DN=302108189611
device=172.25.12.180:5060<,
}

Operator Id
Log Category Selection of errors from Enum SUB_PROVISIONING_ERR = N/A
specific categories 0,
PROVISIONING_ERR
Table 982 Collect Log Files Input Fields (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
soap_alarms.fm

DateTime User will be able to provide Char
Date and Time so that log
entries that have older
timestamp are ignored.
.
Table 982 Collect Log Files Input Fields (Seite 2 von 2)
From each log entry the following rows will be exported

time => <Tue Sep 14 16:44:19 2010<,
log_category => <SUB_PROVISIONING_ERR<,
num_prior_occurences => 0,
data => <SUBSCRIBE mesg received with invalid Group pickup
URI access code=*78 from DN=302108189611
device=172.25.12.180:5060<,
The first check is if exported value of ‘time’ (Tue Sep 14 16:44:19

2010) is equal or greater than the time and date that user provided in
the request. If this is the case, SOAP checks if the ‘log_category’ field
coincides with the one that user provided. If positive, ‘data’ field is
checked against a pool (vector) of previously stored log descriptions
from previous log entry processing:
If contents of ‘data’ describe a new error, then SOAP saves the

description of the error located inside ‘data’ field to the pool of error
descriptions and creates a new record with the following elements:
Output: The output of the API is a file with tab separated fields showed
below:
Field descriptions are located at the first line, tab separated. Field
values are added to the following lines of the log file.
Output filename is the log category defined in the request.
• OSV Node: The IP address of the switch
• Log Category: Provided as input by the user, can be either

SUB_PROVISIONING_ERR or PROVISIONING_ERR
• Number of occurrences:This field indicates the number of

distinct records of this error found inside the log file. Note: It has
to do nothing with num_prior_occurences. The latter may
include prior occurrences of other error types.
A31003-H80A0-T101-1-7618, 11/2021
soap_alarms.fm
• Time&Date of first occurrence: UPDATE with ‘dateandtime’

from the log entry
• Time&Date of last occurrence: UPDATE with ‘dateandtime’

from the log entry
• Data (error description): Copy the error description located at

‘data’ from the log entry. If contents of ‘data’ field match an
existing description from the pool of descriptions of previous log
entries, then SOAP locates this record and updates the following
fields:
Job Id created by the Collect Log

Job Id Int N/A
Files Request
Log File Name Log File Name that shall be cre- Char
ated.
Table 983 Collect Log Files Input Fields
A31003-H80A0-T101-1-7618, 11/2021
soap_ap_sm_mass_prov.fm
Import and Export of SOAP Provisioned Data
Export and Mass Provisioning
25 Import and Export of SOAP Provisioned Data
25.1 Export and Mass Provisioning

Subscriber Management Mass Provisioning allows the mass processing
of provisioning commands by way of the CLI platform. To facilitate the
provisioning of subscribers and their services, script files (containing
shorthand versions of provisioning commands) are used. This section
describes the format of the scripts and how to use them.
The Subscriber Management Mass Provisioning utility loops through the

processing all of the commands in the script file. Output results are
printed to the computer screen; or, the user may redirect the output to
a file.
Warning: soapMassProv is intended to be used for performing

changes en masse. Naturally such activities should only be scheduled
during service windows or staging time. During normal call processing
hours, provisioning should be limited to casual day to day activities
through the SOAP admin interface on the OSV as the advised choice,
for optimum load balancing reasons e.g. using CMP/OSV-Assistant or
customer sponsored applications.
25.1.1 Importing Subscriber Data

Subscriber data can be imported to the OpenScape Voice system using
the soapMassProv executable, which accepts a file in the same format
as is generated by soapExport.
The executable is invoked from within the RTP CLI (startCLI) expert
mode by using the command soapMassProv, followed by a string of
parameters enclosed within double quotes. The syntax to perform this
is as follows:
From the expert mode prompt:
CLI>soapMassProv “-f=ProvisioningCommandFile”
where
ProvisioningCommandFile is a file containing the commands to
execute. Refer to Section 32.3, “Command Line Syntax”, on page
996 for a detailed description of the syntax of this file.
A31003-H80A0-T101-1-7618, 11/2021
It is also possible to execute soapMassProv from the command line, as

was supported in the past, but now this method is reserved for internal
development and test purposes only, and therefore the operator ID and
password parameters are required in addition to the parameters listed
above. The command line syntax is as follows:
1. Telnet to the OpenScape Voice system as user “srx”.
2. cd ../UNSPsubp
3. ./soapMassProv -o=Operator -pass=Password -

f=ProvisioningCommandFile
Table 984 lists and describes the soapMassProv parameters.
Parameter Type Description

-f=filename Command line parameter Specifies the input file that contains mass
provisioning commands to be processed. The
valid syntax for this file is defined in the
mp2.dat file and also later in this document.
-h=homeDirectory Command line parameter Specifies a directory that is different from the
one from which the program is started. Used by
the program to find configuration information.
UNSPsubp is installed in /Unisphere/srx3000/
UNSPsubp and it should be executed from there
If specified from another directory, specify -h=/
Unisphere/srx3000/UNSPsubp.
-out=outputFile Command line parameter Specifies an output file to which the following
data is written:
For successfully processed commands, the

command from the import file is copied here,
but commented out.
For commands that failed for any reason, the

command from the input file is copied here
without comments.
This means that, for example, in case of

sequence problems, where some commands
must be executed as a prerequisite for other
commands, the output file can be reused as an
input file for a second pass to complete the
processing of those commands that failed the
first time.
-p=priority Command line parameter Specifies the priority at which this process it to
be run, ranging from 0 to
-60, where -60 is the default if the parameter is
not provided.
Table 984 soapMassProv Parameters (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021

-o=operatorId Command line parameter A string identifying the operator who is
performing this action; only required when
performing this action from the command line
as opposed to via expert mode CLI.
-pass=password Command line parameter The password that is required in order to
perform this action from the command line as
opposed to via expert mode CLI.
-lins Command line parameter -lins=<lin list size> : exports defined lin list size
-lins : exports all lins from Bg Subnet
-Mlhg Command line parameter -Mlhg=<DN> : exports Multiline Hunt Group
<DN>
-Mlhg : Exports ALL Multiline Hunt Groups
-LOT=<lotname> Command line parameter Exports <lotname> from the defined BG.
-lins : exports all parking lots from the specified
BG.
-EAC:BG=BGName Command line parameter BGname specifies a business group name. The
result is a list of E/A Groups, members, relations
and AuxLines.
- Command line parameter BGname specifies a business group name,
MSA=BGname:BOname BOname specifies the branch office name. The
result is a list of media server assignments to
the specified branch office.
-passupdate Command line parameter Will prompt for the current password and give
the option to update the mass provisioning
password.
Table 984 soapMassProv Parameters (Seite 2 von 2)
If -StartDn, -c and -Mlhg are specified, all defined subscribers and

multiline hunt groups inside this range are exported.
If -BG and -lins are specified, all lins from a BG subnet are exported.
If both -BG and -LOT are specified, all parking lots are exported. -LOT
exports all parking lots, and -LOT=<lotname> exports a specific
parking lot.
Usage Example for -passupdate

./soapExport -o=user -f=output-file -BG -passupdate
Enter current password to proceed:
Authentication OK
---Update password---
Type new password:
*****
Type new password:
*****
Password updated successfully!
A31003-H80A0-T101-1-7618, 11/2021
25.1.2 Exporting Subscriber Data

Subscriber data can be exported from the OpenScape Voice system to
a comma delimited file.
The executable is invoked from within the RTP CLI (startCLI) expert
mode by using the command soapExport, followed by a string of
parameters enclosed within double quotes. The syntax to perform this
is as follows:
CLI>soapExport “-f=outputfilename [-BG]-StartDN=StartDn [-

c=count]]”
It is also possible to execute soapMassProv from the command line, as

above. The command line syntax is as follows:
1. Telnet to the OpenScape Voice system as user “srx”.
2. cd ../UNSPsubp
3. ./soapExport -o=Operator -pass=Password -f=outputfilename [-

BG]-StartDN=StartDn [-c=count]]
where outputfilename is the location to which the exported data is to

be written.
BG indicates a specific BGName or all business group definitions
PNP specifies a NumberPlanName or the entire Private Numbering
Plan
EP specifies an EndPointProfile or all End Point Profiles
QP specifies a QOS Profile or all QOS Profiles
FP specifies a Feature Profile or all Feature Profiles
StartDn is the subscriber to start with
NM specifies all the features of the Network Management interfaces
TS specifies the Tombstone table
count is the max number of subscribers to export
• If -BG and -PNP are specified, the Business Group will be exported
with its own Private Numbering Plan.
• If -BG and -StartDn are specified, the Business Group will be

exported with all its subscribers starting from the specified DN.
A31003-H80A0-T101-1-7618, 11/2021
• If neither -BG, -PNP, or -StartDn are specified, the subscribers will

be exported starting with the lowest numerical alphabetic.
• If -NM=All is specified, -NM=<ObjectName> will export only that

object. For example,
• soapExport "-NM=All -f=/tmp/nm":// All objects
• soapExport "-NM=OfficeCode -f=/tmp/nm :// Exports

OfficeCodes
The output from soapExport can be used as input to soapMassProv.
Table 985 lists and describes the soapExport parameters.

-f=filename Command line parameter Specifies the output file that will be generated
with the comma-delimited data.
-o=operatorId Command line parameter A string identifying the operator who is
performing this action; only required when
performing this action from the command line
as opposed to via expert mode CLI.
-pass=password Command line parameter The password that is required in order to
perform this action from the command line as
opposed to via expert mode CLI.
-BG=BGName Command line parameter Specifies a Business Group Name. If the
parameter is provided with no value, all
Business Group definitions are exported.
-EP = EPName Command line parameter Specifies an Endpoint Profile. If the parameter
is specified with no value, all Endpoint Profiles
are exported.
-FP = Feature Profile Command line parameter Specifies a Feature Profile. If the parameter is
Name provided with no value, all Feature Profiles are
exported.
Since Feature Profiles may or may not be
associated with Business Groups, the following
other possibilities apply:
• FP --- export all Feature Profiles

• FP=: --- export all Switch Wide Feature
Profiles
• FP=<fp> --- export Feature Profile with
Feature Profile Name = <fp>
• FP=:<bg> --- export all Feature Profiles
• belonging to Business Group <bg>
• FP=<fp>:<bg> --- export Feature Profile
with Feature Profile Name <fp> belonging to
Business Group <bg>
Note this means that if a Feature Profile is

associated with a BG, the BG Name must be
provided.
Table 985 soapExport Parameters (Seite 1 von 3)
A31003-H80A0-T101-1-7618, 11/2021

-PNP=NumberPlan Command line parameter Specifies a NumberPlanName. If not specified,
Name the BG must be specified, and the Private
Numbering Plan associated with that BG is
exported.
-DEST Command line parameter When included along with the -BG and -PNP
options, indicates that all destinations for the
given Numbering Plan are to be exported.
-NumMod=Number Command line parameter Specifies a NumberPlanName for which the
PlanName Number Modification data is to be exported.
-TS Command line parameter Indicates that the contents of the Tombstone
table are to be exported.
-StartDn=DN Command line parameter Indicates the starting Directory Number at
which to start the export. If not specified,
export starts with the numerically lowest DN
provisioned on the system.
-c=Number Command line parameter Indicates the number of Directory Numbers to
export. If not specified, or greater than 10,000
is specified, 10,000 will be exported.
-c2=Number Command line parameter Same as for the -c option, this parameter
indicates the number of Directory Numbers to
export; however, in this case, there is no limit
to the number of exported DNs. Note that if the
-c2 option is used on a heavily populated
system, the result may be a long running
command.
A31003-H80A0-T101-1-7618, 11/2021

-NM=All Command line parameter Indicates that Network Management objects
-NM=<object> are to be exported. If gAllh is specified, all
supported objects are exported. Alternatively,
an object name can be provided to export only
that object. The currently supported Network
Management objects are:
• OfficeCode
• HomeDn
• ClassService
• RateArea
• CallingLocation
• Destination
• Endpoint
• Route
• Alias
• MediaGateway
• MediaGatewayCircuits
• TimeDestination
• DaySchedule
• PeriodSchedule
• WeeklySchedule
• Intercept
• Treatment
• CarrierDestination
• CarrierRoute
• TrunkGroup
• Trunk
• OriginDestination
• OriginRoute
• SipReason
• CodeProcess
• OperatorEnum
• EnumServer
• EndpointProvider
• EndpointLocation
-lins Command line parameter -lins=<lin list size> : exports defined lin list
size
-lins : exports all lins from Bg Subnet
-Mlhg Command line parameter -Mlhg=<DN> : exports Multiline Hunt Group
<DN>
-Mlhg : Exports ALL Multiline Hunt Groups
If -StartDn, -c and -Mlhg are specified, all defined subscribers and

multiline hunt groups inside this range are exported.
If -BG and -lins are specified all lins from a BG subnet are exported.
The soapExport exports the provisioning commands in the current

version and outputs them to the file. This file can then be imported
(using soapMassProv) with a version greater than or equal to the
version output in the file.
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
Beginning in Version 3.0, the SOAP Export and SOAP Mass Provisioning
syntax is enhanced to improve its readability. Using the old style format
was cumbersome due to the fact that the parameters were position-
dependent and thus the mapping of data items to parameters was
difficult to determine by examining the script file. Therefore, a new
style of command is introduced consisting of a parameter = value
format, making the parameters clearly identifiable and position
independent.
Every command has the general format:

<command-name>
,<attribute1>=<value1>
..
;;
Warning: Note one important restriction of this new format: The

command and attribute names are reserved words. This means that if
they are to be used as an input value for some attribute, they must be
placed within double quotes. For example, to create a Business Group
with the name “AF”, which is a reserved command name, the following
command could be used:
CBG
,BGNAME=”AF”
,DISPLAYNUMBER=5619556559
Also note the following about SOAP Mass Provisioning:
• Files that have a file version with an “MP2” are parsed with the lex-
yacc parser.
• C style comment syntax has been introduced. This allows large

blocks of input file to be commented out if necessary with /* and */.
25.2 Supported Commands

The following subsections present the syntax for each of the supported
commands. This information is also included in the deliverable file
mp2.dat. For specific details about attributes, please refer to this
file. Additionally, the files generated by SOAP Export now have the
WSDL version included at the top of the file in order to clearly
document the version of the switch from which the data was exported.
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
25.2.1 Add Features

<AF>
AF - Add Features to subscribers (Please see WSDL
API:unsp__UpdateSubscriberFeatures)
,SUBSCRIBERDN=<string>
feat1
,feat1_attribute1=<value>
feat2
.
.
featn
,featn_attribute1=<value>
</AF>
25.2.1.1 Supported Features
Following is a list of features supported by the Add Subscriber Feature

(AF) command above along with their attributes. Note that in general,
these features are also supported by the other subscriber feature listed
below:
• MF - Modify Subscriber Feature
• IF - Reset Inherited Subscriber feature fields
• FPAF - Add Feature Profile Feature
• FPRF - Remove Feature Profile Feature
• FPMF - Modify Feature Profile Feature
• FPMFR - Modify Feature Profile Feature with Reset of Subs
<CFACCB>
CFACCB,
ENABLED=<bool>
</CFACCB>
<CFACR>
ACR - (Please see WSDL API:unsp__UpdateSubscriberFeatures)
,ENABLED=<bool>
,SUBCONTROLLED=<bool>
,BILLING=<enum>
</CFACR>
<CFAcctCode>
AcctCode - (Please see WSDL
,ENABLED=<bool>
</CFAcctCode>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
<CfAuthCode>
AuthCode - (Please see WSDL
,ENABLED=<bool>
,AUTHCODECDR=<enum>
,INTERNATIONAL=<bool>
,INTERNATIONALZONE1=<bool>
,INTERLATA=<bool>
,INTRALATA=<bool>
,TOLLFREE=<bool>
,LOCALDIRASSIST=<bool>
,HOMEDIRASSIST=<bool>
,LONGDIRASSIST=<bool>
,EMERGENCY=<bool>
,NATIONAL=<bool>
,LOCALTT=<bool>
</CfAuthCode>
<CFBgCNAM>
BgCNAM - (Please see WSDL
,ENABLED=<bool>
</CFBgCNAM>
<CFBgCPU>
BgCPU - (Please see WSDL
,ENABLED=<bool>
</CFBgCPU>
<CFCPUD>
CPUD - Call Pick Up Direct (Please see WSDL
,ENABLED=<bool>
</CFCPUD>
<CFBgCT>
BgCT - (Please see WSDL
,BGCTVARIANT=<enum>
,BGCTRECALLAPPLYTYPE=<enum>
,BGCTRECALLTIMER=<int>
,BGCTINTERCEPTAPPLYTYPE=<enum>
,BGCTINTERCEPTTIMER=<int>
,BGCTINTERCEPTDEST=<string>
,BGCTBLOCKTRANSFERTORESTRICTEDPARTY=<bool>
</CFBgCT>
<CFBgDAPPS>
BgDAPPS - (Please see WSDL
,INTRABGCALLSPPS=<enum>
,CALLINGINTRABGDISPLAYFIRSTOPTION=<enum>
,CALLINGINTRABGDISPLAYSECONDOPTION=<enum>
,CALLINGINTRABGDISPLAYTHIRDOPTION=<enum>
,CALLINGNONINTRABGDISPLAYFIRSTOPTION=<enum>
,CALLINGNONINTRABGDISPLAYSECONDOPTION=<enum>
,CONNECTEDINTRABGDISPLAYFIRSTOPTION=<enum>
,CONNECTEDINTRABGDISPLAYSECONDOPTION=<enum>
,CONNECTEDINTRABGDISPLAYTHIRDOPTION=<enum>
</CFBgDAPPS>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
<CFBgDNPPS>
BgDNPPS - (Please see WSDL
,DEFAULTPPS=<enum>
,INTRABGCALLSPPS=<enum>
,EXTERNALCALLERID=<string>
</CFBgDNPPS>
<CFCACC>
CACC - "Cancel Automatic Collect Call" (Please see WSDL
,ENABLED=<bool>
</CFCACC>
<CFCCBS>
CCBS - Completion of Calls on Busy Subscriber service
(Please see WSDL API:unsp__UpdateSubscriberFeatures)
</CFCCBS>
<CFCCNR>
CCNR - Completion of Calls on No Reply service (Please see
WSDL API:unsp__UpdateSubscriberFeatures)
</CFCCNR>
<CFCFB>
CFB - Call Forward Busy (Please see WSDL
,ENABLED=<bool>
,SERVICEID=<string>
,SUBACTIVATABLE=<enum>
,DESTSERVICEIDSUBCONTROLLABLE=<enum>
,CFNOTIFYCALLINGPARTY=<enum>
,NOTIFYSUBCALLFWDACTIVE=<bool>
</CFCFB>
<CFCFD>
CFCFD - Call Forward Dependable (Please see WSDL
API:unsp__UpdateSubscriberFeatures in Provisioning Doc for
Attribute details)
,ENABLED=<bool>
,SERVICEID=<string>
,EXTSERVICEID=<string>
</CFCFD>
<CFCFDA>
CFDA - Call Forward No Answer (Please see WSDL
,ENABLED=<bool>
,SERVICEID=<string>
,NUMBEROFRINGS=<int>
,RINGDURATION=<int>
</CFCFDA>
<CFCFV>
CFV - Call Forward Variable (Please see WSDL
,ENABLED=<bool>
,SERVICEID=<string>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
,NOTIFYSUBCALLFWDOCCURRED=<bool>
</CFCFV>
<CFCIDS>
CIDS - Outgoing Caller ID Suppression (Please see WSDL
</CFCIDS>
<CFCPS>
CFCPS - Call Park to Server (Please see WSDL
API:unsp__UpdateSubscriberFeatures for attribute details)
, SUBSCRIBERDN=<string>
, ENABLED=<bool>
, PARKALLOW=<bool>
, RETRIEVEALLOW=<bool>
, LOTNAME=<string>
, BGNAME=<string>
</CFCPS>
<CFCPUD>
CPUD - Call Pick Up Direct (Please see WSDL
,ENABLED=<bool>
</CFCPUD>
<CFCRBT>
CFCRBT - Colorful Ringback Tone (Please see WSDL
Attribute details)
,ENABLED=<bool>
,ACTIVERINGBACKTONE=<string>
,RBTONELIST_LEN=<int>
,INTERCEPTNAME_0=<string>
</CFCRBT>
<CFCT>
CT - Call Transfer (Please see WSDL
</CFCT>
<CFCSTA>
CSTA - "CSTA for SimplyPhone" (Please see WSDL
,CSTATYPE=<enum>
</CFCSTA>
<CFCW>
CW - (Please see WSDL API:unsp__UpdateSubscriberFeatures)
,ENABLED=<bool>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
,NOTIFYCALLINGPARTY=<bool>
</CFCW>
<CFCFDISP>
CFDISP - Call Forward Display (Please see WSDL
,ENABLED=<bool>
</CFCFDISP>
<CFDND>
DND - (Please see WSDL API:unsp__UpdateSubscriberFeatures)
,ENABLED=<bool>
</CFDND>
<CFDTF>
DTF - Deny Terminating Feature (Please see WSDL
Attribute details)
,ENABLED=<bool>
,CALLBACKMONITORING=<bool>
</CFDTF>
<CFECF>
ECF - "Enhanced Call forward" (Please see WSDL
,ENABLED=<bool>
,SCREENLIST_LEN=<int>
,SCREENLIST_SERVICEID_0=<string>
,SCREENLIST_ENTRY_0=<enum>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
,ECFLIST_LEN=<int>
,ECFLIST_DOW_0=<enum>
,ECFLIST_STARTTIME_0=<string>
,ECFLIST_STOPTIME_0=<string>
,ECFLIST_CALLFWDTYPE_0=<enum>
,ECFLIST_SCREENOPTION_0=<enum>
,ECFLIST_SERVICEID_0=<string>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
,NO_OF_RINGS=<int>
,RING_DURATION=<int>
</CFECF>
<CFEACR>
EACR - (Please see WSDL
,ENABLED=<bool>
,BILLING=<enum>
,EACRDEST=<enum>
,VOICEMAILDN=<string>
</CFEACR>
<CFEXO>
EXO - "Executive Busy Override" (Please see WSDL
,ENABLED=<bool>
,EXOOPTION=<enum>
</CFEXO>
<CFHotDesk>
HotDesk - (Please see WSDL
,ENABLED=<bool>
,HOTDESKSIDE=<enum>
</CFHotDesk>
<CFLINR>
LINR - Last Incoming Number Redial (Please see WSDL
</CFLINR>
<CFLONR>
LONR - Last Outgoing Number Redial (Please see WSDL
</CFLONR>
<CFMCT>
MCT - "Customer Originated Trace" (Please see WSDL
,BILLING=<enum>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
</CFMCT>
<CFMOH>
MOH - "Music On Hold" (Please see WSDL
,ENABLED=<bool>
,INTERCEPTNAME=<string>
</CFMOH>
<CFO>
CFO - "Call Forward Override" (Please see WSDL
,ENABLED=<bool>
</CFO>
<CFONS>
ONS - "One Number Service" (Please see WSDL
,ENABLED=<bool>
,ONSTYPE=<enum>
,STATICONDACTIVATE=<bool>
,STATICONDSERVICEID=<string>
</CFONS>
<CFRACF>
RACF - "Remote Activation Call Forward" (Please see WSDL
,PIN=<string>
</CFRACF>
<CFRCF>
RCF - "Remote Call forward" (Please see WSDL
,SERVICEID=<string>
,MAXSIMULTANEOUSCALLS=<int>
</CFRCF>
<CFRFA>
RFA - Remote Feature Access (Please see WSDL
,PIN=<string>
</CFRFA>
<CFSCA>
SCA - Selective Caller Accept (Please see WSDL
,ENABLED=<bool>
,BILLING=<enum>
,SERVICEID_0=<string>
,SUBSCRIBERPPS_0=<enum>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
,PIN=<string>
,SCATERMINATIONTREATMENT=<enum>
,SERVICEID=<string>
</CFSCA>
<CFSCC>
SCC - "Station Controlled Conference service definition"
(Please see WSDL API:unsp__UpdateSubscriberFeatures)
,ENABLED=<bool>
</CFSCC>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
<CFSCF>
SCF - Selective Call Forward (Please see WSDL
,ENABLED=<bool>
,SERVICEID=<string>
,SPLASHRING=<bool>
,BLACKLIST=<bool>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
</CFSCF>
<CFSCR>
SCR - Selective Caller Reject (Please see WSDL
,ENABLED=<bool>
,BILLING=<enum>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
</CFSCR>
<CFSERRNG>
SERRNG - Serial Ringing (Please see WSDL
,ENABLED=<bool>
,SERIALDNLIST_LEN=<int>
,DURATION=<int>
,DURATION_0=<int>
,DNACTIVE_0=<bool>
,EXTENSION_0=<bool>
,DURATION_1=<int>
,DNACTIVE_1=<bool>
,EXTENSION_1=<bool>
,DURATION_2=<int>
,DNACTIVE_2=<bool>
,EXTENSION_2=<bool>
,DURATION_3=<int>
,DNACTIVE_3=<bool>
,EXTENSION_3=<bool>
,DURATION_4=<int>
,DNACTIVE_4=<bool>
,EXTENSION_4=<bool>
,DURATION_5=<int>
,DNACTIVE_5=<bool>
,EXTENSION_5=<bool>
</CFSERRNG>
<CFSILM>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
CFSILM
,ENABLED=<bool>
</CFSILM>
<CFSILMProtection>
CFSILMProtection
,ENABLED=<bool>
</CFSILMProtection>
<CFSILMTag>
CFSILMTag
,ENABLED=<bool>
</CFSILMTag>
<CFSPCALL>
SPCALL - "Speed call Feature" (Please see WSDL
,ONEDIGIT=<string>
,TWODIGIT=<string>
,ONEDIGIT_LIST_LEN=<int>
,ONEDIGIT_SERVICEID_0=<string>
,ONEDIGIT_SPCALLNUM_0=<int>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
,TWODIGIT_LIST_LEN=<int>
,TWODIGIT_SERVICEID_0=<string>
,TWODIGIT_SPCALLNUM_0=<int>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
</CFSPCALL>
<CFSR>
SR - Station Restriction (Please see WSDL
,ORIGINATINGSR=<enum>
,TERMINATINGSR=<enum>
</CFSR>
<CFSRS>
SRS - (Please see WSDL API:unsp__UpdateSubscriberFeatures)
,DNRINGLIST_LEN=<int>
,ENABLED=<bool>
,EXTENSION_0=<bool>
,EXTENSION_1=<bool>
,EXTENSION_2=<bool>
,EXTENSION_3=<bool>
,EXTENSION_4=<bool>
,EXTENSION_5=<bool>
</CFSRS>
<CFTRS>
TRS - "Toll Restrictions" (Please see WSDL
Attribute details)
,CORNAME=<string>
,ALTERNATECORNAME=<string>
,SWITCHOVERDURATION=<int>
,ALTCORDAYSCHEDULELIST_LEN=<int>
,ALTCORDAYSCHEDULELIST_DOW_0=<enum>
,ALTCORDAYSCHEDULELIST_STARTTIME_0=<string>
,ALTCORDAYSCHEDULELIST_STOPTIME_0=<string>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
,ALTCORDATESCHEDULELIST_LEN=<int>
,ALTCORDATESCHEDULELIST_STARTDATENTIME_0=<string>
,ALTCORDATESCHEDULELIST_ENDTIME_0=<string>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
,RESTRICTEDLINELIST_LEN=<int>
</CFTRS>
<CFVM>
VM - Voice Mail (Please see WSDL
,ENABLED=<bool>
,SERVICEID=<string>
,NUMBEROFRINGS=<int>
,VMWI_=<bool>
,AMWI_=<bool>
,RINGDURATION=<int>
</CFVM>
<CFWL>
WL - (Please see WSDL API:unsp__UpdateSubscriberFeatures)
,ENABLED=<bool>
,WARMLINEDN=<string>
</CFWL>
25.2.2 Remove Features

<RF>
RF - Remove Features from subscribers (Please see WSDL
feat1
feat2
.
.
<featn>
</RF>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
25.2.3 Modify Features

<MF>
MF - Modify Features for subscribers (Please see WSDL
feat1
feat2
.
.
featn
</MF>
25.2.4 Deny Features

<DF>
DF - Deny Features for subscribers (Please see WSDL
feat1
feat2
.
.
<featn>
</DF>
25.2.5 Add Feature Profile Features

<FPAF>
FPAF - Add Features to Feature Profile
,FPNAME=<string>
,BGNAME=<string>
feat1
feat2
.
.
featn
</FPAF>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
25.2.6 Remove Feature Profile Features

<FPRF>
FPRF - Remove Features from Feature Profile
,FPNAME=<string>
,BGNAME=<string>
feat1
feat2
.
.
featn
</FPRF>
25.2.7 Modify Feature Profile Features

<FPMF>
FPMF - Modify Features in a Feature Profile
,FPNAME=<string>
,BGNAME=<string>
feat1
feat2
.
.
featn
</FPMF>
25.2.8 Add Business Group Features

<ABF>
ABF - Add Business Group Features
,BGNAME=<string>
feat1
feat2
.
.
featn
</ABF>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
Following is a list of features supported by the ABF command above

along with their attributes. Note that these features are also supported
by the RBF (Remove Business Group Features) command.
<CFBgDR>
BgDR - "Intra BG Distinctive Ringing" (Please see WSDL
API:unsp__UpdateBGFeatures)
,ENABLED=<bool>
</CFBgDR>
<CFBgE911LIN>
BgE911LIN - "BG E911 LIN Administration" (Please see WSDL
,DEFAULTEMERGENCYNUMBER=<string>
,DEFAULTINTERCEPTNAME=<string>
</CFBgE911LIN>
<CFBgHotDesk>
BgHotDesk - "The Hot Desking Configuration Service" (Please
see WSDL API:unsp__UpdateBGFeatures)
,AUTOLOGOFFTIME=<string>
</CFBgHotDesk>
<CFBgKS>
BgKS - "Keyset Operation BG only" (Please see WSDL
,MANUALHOLDRECALLTIMER=<int>
,LINERESERVATIONTIMER=<int>
</CFBgKS>
<CFBgLC>
BgLC - "Business Group Large Conference service definition"
(Please see WSDL API:unsp__UpdateBGFeatures)
,MINNUMBERPORTS=<int>
,MAXNUMBERPORTS=<int>
,MAXCONFERENCES=<int>
,MAXCONFERENCEMEMBERS=<int>
,CONFERENCERECALLDISCTIMER=<int>
,PLAYENTRYEXITTONE=<bool>
,BLOCKLCONFRESTRICTEDPARTY=<bool>
</CFBgLC>
<CFBgNBCPU>
BgNBCPU - "Business Group Night Bell CPU service definition"
(Please see WSDL API:unsp__UpdateBGFeatures)
,ENABLED=<bool>
,NIGHTBELLCPUID=<int>
</CFBgNBCPU>
<CFBgSILM >
BgSILM - "The Hot Desking Configuration Service" (Please
see WSDL API:unsp__UpdateBGFeatures)
, MONITORTAGLIMIT <int>
, MAXNUMBEROFSUPERVISORS <int>
</CFBgSILM >
<CFBgSpDial>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
CFBgSpDial - "Bg System Speed Calling Lists" (Please see

WSDL API:unsp__UpdateSubscriberFeatures)
,ENABLED=<bool>
,LISTIDONE=<int>
,LISTIDTWO=<int>
</CFBgSpDial>
<CFBGTM>
CFBGTM
</CFBGTM>
25.2.9 Remove Business Group Features

<RBF>
RBF - Remove Business Group Features
,BGNAME=<string>
feat1
feat2
.
.
featn
</RBF>
25.2.10 Add End Point Profile Features

<EPADDFEAT>
EPADDFEAT - Add End Point Profile Features
,EPNAME=<string>
feat1
feat2
.
.
featn
</EPADDFEAT>
Following is a list of features supported by the EPADDFEAT command

above along with their attributes. Note that these features are also
supported by the DPDELFEAT (Remove Endpoint Profile Features)
command.
<CFCFID>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
CFID - "Call Forward Invalid Destination" (Please see WSDL

API:unsp__UpdateEpFeatures in Provisioning Doc for
Attribute details)
,ENABLED=<bool>
,ALTERNATETARGET=<string>
</CFCFID>
<CFEpCNAM>
EpCNAM - "Incoming Calling Name Delivery" (Please see WSDL
API:unsp__UpdateEpFeatures)
</CFEpCNAM>
<CFEPCISNAME>
EPCISNAME - Called Party Name Delivery (Please see WSDL
,NAMEDB=<enum>
</CFEPCISNAME>
<CFEpCT>
EpCT - "Endpoint Call Transfer" (Please see WSDL
Attribute details)
,ENABLED=<bool>
</CFEpCT>
<CFEPTRS>
EPTRS - "Toll Restrictions" (Please see WSDL
Attribute details)
,CORNAME=<string>
,ALTERNATECORNAME=<string>
,SWITCHOVERDURATION=<int>
,ALTCORDAYSCHEDULELIST_LEN=<int>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
,ALTCORDATESCHEDULELIST_LEN=<int>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
,RESTRICTEDLINELIST_LEN=<int>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
</CFEPTRS
<CFSBRK>
SBRK - "Service Broker" (Please see WSDL
,ENABLED=<bool>
</CFSBRK>
<CFEPVM>
CFEPVM
</CFEPVM>
<CFCNIM>
CNIM - "CSTA Network Interface Device" (Please see WSDL
API:unsp UpdateEpFeatures in Provisioning Doc for
Attribute details)
,NAMEPROVIDER=<string>
</CFCNIM>
25.2.11 Create CSTA Application

<CCSTAAPP>
CCSTAAPP – “Creates a CSTA Application” (Please see WSDL
API:unsp__CreateCSTAApplication in Provisioning Doc for
Attribute details)
,APPNAME=<string>
,APPIP=<string>
,APPTYPE=<enum>,
,SOAPLISTENERPORT=<int>
,HEARTBEATTIMER=<int>
,HEARTBEATWATCHDOG=<int>
,HEARTBEATRETRYCOUNT=<int>
,APPID=<string>
,ENTERPRISEID=<string>
,PAS_CODE=<string>
,OUTSIDEACCESS=<int>
,BGNAME=<string>
,NPNAME=<string>
</CCSTAAPP>
25.2.12 Modify CSTA Application

<MCSTAAPP>
MCSTAAPP – “Modifies a CSTA Application” (Please see WSDL
API:unsp__ModifyCSTAApplication in Provisioning Doc for
Attribute details)
,APPIP=<string>
,APPNAME=<string>
,APPNEWIP=<string>
,APPTYPE=<enum>,
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
,APPID=<string>
,PAS_CODE=<string>
,OUTSIDEACCESS=<int>
,BGNAME=<string>
,NPNAME=<string>
</MCSTAAPP>
25.2.13 Delete CSTA Application

<DCSTAAPP>
DCSTAAPP – “Deletes a CSTA Application” (Please see WSDL
API:unsp__DeleteCSTAApplication in Provisioning Doc for
Attribute details)
,APPIP=<string>
</DCSTAAPP>
25.2.14 Delete End Point Profile Features

<EPDELFEAT>
EPDELFEAT - Delete End Point Profile Features
,EPNAME=<string>
feat1
feat2
.
.
featn
</EPDELFEAT>
25.2.15 Create Subscriber

There a number of different kinds of subscribers that can be created.
The commands for all of them are listed below.
<CS>
CS - Base Subscriber Profile.All parameters available for
all types of subscribers. (Please see WSDL
API:unsp__CreateSubscriber2)
,RETAILER=<string>
,ACCOUNTID=<string>
,BILLINGID=<string>
,CLASSOFSERVICE=<string>
,RATEAREA=<string>
,CALLINGLOC=<string>
,NUMBERPLANNAME=<string>
,BGNAME=<string>
,DISPLAYNAME=<string>
,UNICODEDISPLAYNAME=<string>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
,TIMEZONE=<string>
,PIN=<string>
,PUBLICPIN=<string>
,SUBSCRIBERSTATUS=<enum>
,INTERCEPTANNOUNCEMENT=<enum>
,NEWSERVICEID=<string>
,LANGUAGE=<string>
,BGDEPTNAME=<string>
,PIC_1=<string>
,PIC_2=<string>
,PIC_3=<string>
,PIC_4=<string>
,FAXSTATISTICS=<bool>
,OUTBANDDTMFSIGNALING=<bool>
,SUPPRESSOUTBANDDTMFWITHG711=<bool>
,QOSCLASSMODE=<enum>
,QOSVALUE=<int>
,QOSPROFILENAME=<string>
,QOSPROFILEBGNAME=<string>
,CODECPRIM=<enum>
,PPPRIM=<int>
,TOSPRIM=<int>
,CODECSEC=<enum>
,PPSEC=<int>
,TOSSEC=<int>
,CODECTHIRD=<enum>
,PPTHIRD=<int>
,TOSTHIRD=<int>
,CODECFOURTH=<enum>
,PPFOURTH=<int>
,TOSFOURTH=<int>
,EXTERNALDNFLAG=<bool>
,COUNTRYCODELEN=<int>
,FEATUREPROFILENAME=<string>
,FEATUREPROFILEBGNAME=<string>
,KEYSETUSE=<enum>
,ALPHANUMERICSIPURI=<string>
,DONOTSENDSIPURI=<bool>
</CS>
<CS_SIP>
CS_SIP - Creates a SIP subscriber (Please see WSDL
API:unsp__CreateSubscriber2)
,RETAILER=<string>
,ACCOUNTID=<string>
,BILLINGID=<string>
,RATEAREA=<string>
,BGNAME=<string>
,TIMEZONE=<string>
,PIN=<string>
,PIN2=<string>
,PIN3=<string>
,PIN4=<string>
,PIN5=<string>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
,PUBLICPIN=<string>
,LANGUAGE=<string>
,PIC_1=<string>
,PIC_2=<string>
,PIC_3=<string>
,PIC_4=<string>
,QOSPROFILENAME=<string>^M
,QOSPROFILEBGNAME=<string>^M
,PHONENAME=<string>
,REGTYPE=<enum>
,SIGIPADDR=<string>
,SIGPORT=<int>
,PREREGISTER=<bool>
,IPSEC_REALM=<string>
,IPSEC_UNAME=<string>
,IPSEC_PW=<string>
,IPSEC_SCHEME=<enum>
,IPSEC_SRTP=<enum>
,MAXSIPSESSIONS=<int>
,TRANSPORTTYPE=<enum>
,,KEYSETUSE=<enum>
,ASSOCIATEDSIPENDPOINTNAME=<string>
,OVERRIDEIRMCODECRESTRICTIONS=<bool>
,LOOSEROUTINGURI=<string>
,MEDIAREDIRECTALLOWED=<bool>
,AORPERCONTACT=<bool>
,ALIASNAME0=<string>
,VIPTYPE=<enum>,
,SENDURITELEPHONESUBFORMAT=<bool>,
,SENDINTERNATIONALNUMBERGNF=<bool>
,RegistViaCentralSBC
,SENDSIPURIWHENAVAILABLE=<bool>
,RESERVED_2=<bool>
,RESERVED_3=<bool>
,RESERVED_4=<bool>
,Reserved_5=<bool>
,DISLONGCALLAUDIT=<bool>
,ANATSUPPORT=<enum>,
,OutgoingCallSupervisionTimer
,MOBILEFLAG=<bool>
,MAINDEVICEDN=<string>
,MOBRINGDUR=<int>
,MAINRINGDUR=<int>
,CELLRINGDUR=<int>
</CS_SIP>
<CS_MGCP>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
CS_MGCP - Create MGCP subscriber

(Please see WSDL API:unsp__CreateSubscriber2)
,RETAILER=<string>
,ACCOUNTID=<string>
,BILLINGID=<string>
,RATEAREA=<string>
,BGNAME=<string>
,TIMEZONE=<string>
,PIN=<string>
,PUBLICPIN=<string>
,LANGUAGE=<string>
,PIC_1=<string>
,PIC_2=<string>
,PIC_3=<string>
,PIC_4=<string>
,QOSVALUE=<int>
,CODECPRIM=<enum>
,PPPRIM=<int>
,TOSPRIM=<int>
,CODECSEC=<enum>
,PPSEC=<int>
,TOSSEC=<int>
,CODECTHIRD=<enum>
,PPTHIRD=<int>
,TOSTHIRD=<int>
,CODECFOURTH=<enum>
,PPFOURTH=<int>
,TOSFOURTH=<int>
,DQTBRP=<int>
,DQTBSP=<int>
,DQPDRP=<int>
,DQMPUP=<int>
,DQMPSP=<int>
,DQRateP=<int>
,DQSTP=<int>
,DQTBRS=<int>
,DQTBSS=<int>
,DQPDRS=<int>
,DQMPUS=<int>
,DQMPSS=<int>
,DQRateS=<int>
,DQSTS=<int>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
,DQTBRT=<int>
,DQTBST=<int>
,DQPDRT=<int>
,DQMPUT=<int>
,DQMPST=<int>
,DQRateT=<int>
,DQSTT=<int>
,DQTBRF=<int>
,DQTBSF=<int>
,DQPDRF=<int>
,DQMPUF=<int>
,DQMPSF=<int>
,DQRateF=<int>
,DQSTF=<int>
,MEDIAGATEWAYNAME=<string>
,MEDIAGATEWAYCIRCUIT=<string>
,RTPSECURITY=<enum>
,KEYSETUSE=<enum>
</CS_MGCP>
<CS_H323>
CS_H323 - Create a H233 subscriber
(Please see WSDL API:unsp__CreateSubscriber2)
,RETAILER=<string>
,ACCOUNTID=<string>
,BILLINGID=<string>
,RATEAREA=<string>
,BGNAME=<string>
,TIMEZONE=<string>
,PIN=<string>
,PUBLICPIN=<string>
,LANGUAGE=<string>
,PIC_1=<string>
,PIC_2=<string>
,PIC_3=<string>
,PIC_4=<string>
,QOSVALUE=<int>
,CODECPRIM=<enum>
,PPPRIM=<int>
,RRPRIM=<enum>
,CODECSEC=<enum>
,PPSEC=<int>
,RRSEC=<enum>
,CODECTHIRD=<enum>
,PPTHIRD=<int>
,RRTHIRD=<enum>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
,CODECFOURTH=<enum>
,PPFOURTH=<int>
,RRFOURTH=<enum>
,PHONENAME=<string>
,REGTYPE=<enum>
,RASIPADDR=<string>
,RASPORT=<int>
,TIMETOLIVE=<int>
,ALIASTYPE0=<enum>
,ALIASTYPE1=<enum>
,ALIASTYPE2=<enum>
</CS_H323>
25.2.16 Delete Subscriber

<RS>
RS - "Delete a subscriber." (Please see WSDL
API:unsp__DeleteSubscriber2)
,DELETEGATEWAYOBJECTS=<enum>
</RS>
25.2.17 Update Subscriber Directory Number

<UD>
UD - "Update Subscriber Directory Number. Change the sub's
DN" (Please see WSDL API:unsp__UpdateSubscriberDn2)
</UD>
25.2.18 Create Hunt Group

<MLHGCREATE>
MLHGCREATE - Create a Mlhg from an existing subscriber.
(Please see WSDL API:unsp__CreateMlhg2)
,BGNAME=<string>
,BOName=<string>
,MLHGHUNTTYPE=<enum>
,MLHGEXTERNALDN=<string>
,MLHGOVERFLOWDN=<string>
,MLHGCONFQUEUESIZE=<int>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
,MLHGMAXQUEUESIZE=<int>
,MLHGCALLINGPARTYSOURCE=<enum>
,MLHGNOANSADVTIME=<int>
,NOANSADVTIME=<int>
,NOINTERCEPTANNOUNCEMENT=<bool>
,INTERCEPTANNONCEMENTID=<string>
,NIGTHSERVICEDN=<string>
,AUTOMAKEBUSY=<bool>
,MAXTIMEINQUEUE=<int>
,NIGHTSERVICEMANUALSTATUS=<bool>
,POSTCALLTIMER=<int>
,INQUEUEINTERRUPTTIME=<int>
,INQUEUEINTERRUPTINTERCEPT=<string>
,TMSTATUS=<bool>
,MLHGMAKEBUSYSUBCONTROLLED=<bool>
,MLHGHUNTSUBCONTROLLED=<bool>
,MLHGBUSYSTATUS=<enum>
,MLHGSTOPHUNTSTATUS=<enum>
InQueueInterruptTime=<int>
InQueueInterruptIntercept=<string>
isMlhgRerouteAllowed=<bool>
>SendPilotDisplay=<bool>
isMlhgEnhancedRerouteAllowed=<bool>
OverflowDnNoRerouting=<string>
</MLHGCREATE>
25.2.19 Modify Mlhg

<MLHGMODIFY>
MLHGMODIFY - Modify Mlhg Information (Please see WSDL
API:unsp__ModifyMlhgInfo2)
,BGNAME=<string>
,BOName=<string>
,MLHGPILOTDN=<string>
,MLHGHUNTTYPE=<enum>
,MLHGEXTERNALDN=<string>
,MLHGOVERFLOWDN=<string>
,MLHGCONFQUEUESIZE=<int>
,MLHGMAXQUEUESIZE=<int>
,MLHGCALLINGPARTYSOURCE=<enum>
,MLHGNOANSADVTIME=<int>
,NOANSADVTIME=<int>
,NOINTERCEPTANNOUNCEMENT=<bool>
,INTERCEPTANNONCEMENTID=<string>
,NIGTHSERVICEDN=<string>
,AUTOMAKEBUSY=<bool>
,MAXTIMEINQUEUE=<int>
,NIGHTSERVICEMANUALSTATUS=<bool>
,POSTCALLTIMER=<int>
,TMSTATUS=<bool>
,INQUEUEINTERRUPTTIME=<int>
,INQUEUEINTERRUPTINTERCEPT=<string>
</MLHGMODIFY>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
25.2.20 Remove Hunt Group

<MLHGREMOVE>
MLHGREMOVE - Remove a Mlhg (Please see WSDL
API:unsp__DeleteMlhg2)
,BGNAME=<string>
,MLHGREMOVETERMS=<bool>
</MLHGREMOVE>
25.2.21 Add Subscriber To Hunt Group

<MLHGADDSUB>
MLHGADDSUB - Add Sub To a Multi line Hunting Group (Please
see WSDL API:unsp__AddSubToMlhg2)
,BGNAME=<string>
,POSITION=<int>
,MLHGATTENDANT=<bool>
,QUEUEPRIORITY=<int>
</MLHGADDSUB>
25.2.22 Modify Hunt Group Terminal

<MLHGMODTERM>
MLHGMODTERM - (Please see WSDL
API:unsp__ModifyMlhgTermInfo2)
,BGNAME=<string>
,BOName=<string>
,MLHGPRIMARYPILOTDN=<string>
,POSITION=<int>
,MLHGATTENDANT=<bool>
,QUEUEPRIORITY=<int>
</MLHGMODTERM>
25.2.23 Remove Hunt Group Terminal

<MLHGREMTERM>
MLHGREMTERM - (Please see WSDL API:unsp__DeleteMlhgTerm2)
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
,BGNAME=<string>
</MLHGREMTERM>
25.2.24 Create Feature Profile

<FPCREATE>
FPCREATE - "Create a Feature Profile" (Please see WSDL
API:unsp__CreateFeatureProfile2)
,FPNAME=<string>
,BGNAME=<string>
,FEATUREPROFILETYPE=<enum>
,FEATUREPROFILECONNECTIONTYPE=<enum>
</FPCREATE>
25.2.25 Delete Feature Profile

<FPREMOVE>
FPREMOVE - "Delete a Feature Profile" (Please see WSDL
API:unsp__DeleteFeatureProfile2)
,FPNAME=<string>
,BGNAME=<string>
</FPREMOVE>
25.2.26 Update Subscriber Feature Profile

<UFP>
UFP - "Update subscribers Feature Profile" (Please see WSDL
API:unsp__UpdateSubscriberFeatureProfile2)
,PRESERVELOCPRES=<bool>
,FPNAME=<string>
,BGNAME=<string>
</UFP>
25.2.27 Update Subscriber Account

Management Info
<UM>
UM - Update Subscriber Account Management Info (Please see
WSDL API:unsp__UpdateSubscriberAccountMgtInfo2)
,RETAILER=<string>
,ACCOUNTID=<string>
,BILLINGID=<string>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
,RATEAREA=<string>
,,PRIVACYSUPPORT=<enum>
</UM>
25.2.28 Update Account Business Group

Information
<UMB>
UMB - "Update Account Business Group Information" (Please
see WSDL API:unsp__UpdateSubscriberBGInfo2)
,CPUID=<int>
,BGLINENAME=<string>
,UNICODEBGLINENAME=<string>
,BGATTENDANTNUMBERFLAG=<bool>
,BGEXTENSION=<string>
</UMB>
25.2.29 Update Subscriber PIC Information

<UP>
UP - "Update Subscriber PIC Information" (Please see WSDL
API:unsp__UpdateSubscriberPICs2)
,PIC_1=<string>
,PIC_2=<string>
,PIC_3=<string>
,PIC_4=<string>
</UP>
25.2.30 Update Subscriber QoS Profile

Information
<UQ>
UQ - "Update subscriber QOS Profile Information" (Please see
WSDL API:unsp__UpdateSubscriberQOS2)
,QOSVALUE=<int>
,CODECPRIM=<enum>
,PPPRIM=<int>
,RRPRIM=<enum>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
,CODECSEC=<enum>
,PPSEC=<int>
,RRSEC=<enum>
,CODECTHIRD=<enum>
,PPTHIRD=<int>
,RRTHIRD=<enum>
,CODECFOURTH=<enum>
,PPFOURTH=<int>
,RRFOURTH=<enum>
,DQTBRP=<int>
,DQTBSP=<int>
,DQPDRP=<int>
,DQMPUP=<int>
,DQMPSP=<int>
,DQRateP=<int>
,DQSTP=<int>
,DQTBRS=<int>
,DQTBSS=<int>
,DQPDRS=<int>
,DQMPUS=<int>
,DQMPSS=<int>
,DQRateS=<int>
,DQSTS=<int>
,DQTBRT=<int>
,DQTBST=<int>
,DQPDRT=<int>
,DQMPUT=<int>
,DQMPST=<int>
,DQRateT=<int>
,DQSTT=<int>
,DQTBRF=<int>
,DQTBSF=<int>
,DQPDRF=<int>
,DQMPUF=<int>
,DQMPSF=<int>
,DQRateF=<int>
,DQSTF=<int>
</UQ>
25.2.31 Update Subscriber Status

<US>
US - "Update subscribers Status" (Please see WSDL
API:unsp__UpdateSubscriberStatus2)
</US>
25.2.32 Update Subscriber User information

<UU>
UU - "Update Subscriber User information" (Please see WSDL
API:unsp__UpdateSubscriberAccountUserInfo2)
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
,TIMEZONE=<string>
,PIN=<string>
,PUBLICPIN=<string>
,LANGUAGE=<string>
</UU>
25.2.33 Update Connection Information for a

SIP Subscriber
<UCS>
UCS - "Update Connection Information for a SIP subscriber"
(Please see WSDL API:unsp__UpdateConnectionInfo2)
,REGTYPE=<enum>
,SIGIPADDR=<string>
,SIGPORT=<int>
,PREREGISTER=<bool>
,IPSEC_REALM=<string>
,IPSEC_UNAME=<string>
,IPSEC_PW=<string>
,IPSEC_SCHEME=<enum>
,IPSEC_SRTP=<enum>
,MAXSIPSESSIONS=<int>
,TRANSPORTTYPE=<enum>
,ASSOCIATEDSIPENDPOINTNAME=<string>
,MEDIAREDIRECTALLOWED=<bool>
,OVERRIDEIRMCODECRESTRICTIONS=<bool>
,LOOSEROUTINGURI=<string>
,MAXORIGSESSIONLIMIT=<int>
,MAXTERMSESSIONLIMIT=<int>
,AORPERCONTACT=<bool>
,VIPTYPE=<enum>,
,SENDURITELEPHONESUBFORMAT=<bool>
,SENDINTERNATIONALNUMBERGNF=<bool>
,SENDSIPURIWHENAVAILABLE=<bool>
,ANATSUPPORT=<enum>,,RESERVED_2=<bool>
,RESERVED_3=<bool>
,RESERVED_4=<bool>
,DISLONGCALLAUDIT=<bool>
</UCS>
25.2.34 Add Contact Information

<CTINFOADD>
CTINFOADD - "Add Contact Information" (Please see WSDL
API:unsp__AddContactList2)
,CONTACTINFO_LIST_LEN=<int>
,CONTACTHOSTADDR_0=<string>
,CONTACTPORT_0=<int>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
,CONTACTCONNECTTYPE_0=<enum>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
</CTINFOADD>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
25.2.35 Remove Contact Information

<CTINFOREMOVE>
CTINFOREMOVE - "Remove Contact Information" (Please see WSDL
API:unsp__DeleteContactList2)
,CONTACTINFO_LIST_LEN=<int>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
</CTINFOREMOVE>
25.2.36 Create Business Group

<CBG>
CBG - "Create a Business Group" (Please see WSDL
API:unsp__CreateBG2)
,BGNAME=<string>
,DISPLAYNUMBER=<string>
,DNRESERVEENABLED=<bool>
</CBG>
25.2.37 Delete Business Group

<RBG>
RBG - "Delete a Business Group" (Please see WSDL
API:unsp__DeleteBG2)
,BGNAME=<string>
</RBG>
25.2.38 Update Business Group Status

<UBS>
UBS - "Update Business Group Status" (Please see WSDL
API:unsp__UpdateBGStatus2)
,BGNAME=<string>
,BGSTATUS=<enum>
</UBS>
25.2.39 Add Business Group Main Number

<ABM>
ABM - "Add Main number to a Business Group" (Please see WSDL
API:unsp__AddBGMainNumber2)
,BGNAME=<string>
,BGMAINNUMBER=<string>
,BGMAINNUMBERATTENDANT=<string>
,AUTOATTENDANTNUMBER=<string>
,AUTOATTENDANTSTATUS=<enum>
</ABM>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
25.2.40 Delete Business Group Main Number

<RBM>
RBM - "Delete BG Main number" (Please see WSDL
API:unsp__DeleteBGMainNumber2)
,BGNAME=<string>
</RBM>
Update Business Group Main Number

<UBM>
UBM - "Update Main Number of a Business Group" (Please see
WSDL API:unsp__UpdateBGMainNumber2)
,BGNAME=<string>
,BGMAINNUMBERATTENDANT=<string>
,AUTOATTENDANTNUMBER=<string>
,AUTOATTENDANTSTATUS=<enum>
</UBM>
25.2.41 Update Business Group MDR

Information
<UBMDR>
UBMDR - "Update MDR Information" (Please see WSDL
API:unsp__UpdateBGParms2)
,BGNAME=<string>
,MDRINDICATOR=<enum>
,MDRCUSTID=<string>
</UBMDR>
25.2.42 Update Business Group Media Server

Information
<UBCNT>
UBCNT - "Update Media server related Information" (Please
see WSDL API:unsp__UpdateBGParms2)
,BGNAME=<string>
,MEDIASVRRETRYCOUNT=<int>
,MEDIASVRTIMEOUTINTERVAL=<int>
,INPUTRETRYCOUNT=<int>
</UBCNT>
25.2.43 Update Subscriber Keyset Info

<UK>
UK - Update Subscriber Keyset Info (Please see WSDL
API:unsp__UpdateKeysetInfo2)
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
,KEYSETUSE=<enum>
,KEYSETMANUALHOLDTIMER=<int>
,CALLFORWARDLEDINDICATION=<bool>
,KEYSETLINEAPPEARANCEENTRIES_LIST_LEN=<int>
,KEYSETLINEAPPEARANCE_0=<string>
,ORIGKEYSETOPERATIONMODE_0=<enum>
,TERMKEYSETOPERATIONMODE_0=<enum>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
</UK>
25.2.44 Create Business Group Department

<BGCREATEDEPT>
BGCREATEDEPT - "Create a Business Group department" (Please
see WSDL API:unsp__CreateBGDept2)
,BGNAME=<string>
</BGCREATEDEPT>
25.2.45 Delete Business Group Department

<BGDELETEDEPT>
BGDELETEDEPT - "Delete a Business Group department" (Please
see WSDL API:unsp__DeleteBGDept2)
,BGNAME=<string>
</BGDELETEDEPT>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
25.2.46 Create Business Group E9-1-1

Subnet
<E911BGSUBNETCREATE>
E911BGSUBNETCREATE - "Create a Business Group E911 subnet"
(Please see WSDL API:unsp__CreateBgSubnet2)
,BGNAME=<string>
,BOName=<string>
,SUBNETIP=<string>
,SUBNETMASK=<string>
,LOCATIONDOMAIN=<string>
,SCANRESPONSETIMEOUT=<int>
,DESCRIPTION=<string>
,LINLIST_E911LIN=<string>
,LINLIST_CBN=<string>
,LINLIST_DCBN=<string>
,LINLIST_USEDCBN=<int>
,ROUTENUMBER=<string>
</E911BGSUBNETCREATE>
25.2.47 Delete Business Group E9-1-1

Subnet
<E911BGSUBNETDELETE>
E911BGSUBNETDELETE - "Delete a Business Group E911 subnet"
(Please see WSDL API:unsp__DeleteBgSubnet2)
,BGNAME=<string>
,SUBNETIP=<string>
</E911BGSUBNETDELETE>
When specifying no LINs, then BG subnet and all LINs of the specified
BG Subnet are removed.
<E911BGSUBNETDELETE>
E911BGSUBNETDELETE - "Delete a Business Group E911 subnet"
(Please see WSDL API:unsp__DeleteBgSubnet2)
,BGNAME=<string>
,SUBNETIP=<string>
</E911BGSUBNETDELETE>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
25.2.48 Update Business Group E9-1-1

Subnet
<E911BGSUBNETUPDATE>
E911BGSUBNETUPDATE - "Update a Business Group E911 subnet"
(Please see WSDL API:unsp__UpdateBgSubnet2)
,BGNAME=<string>
,BOName=<string>
,SUBNETIP=<string>
,SCANRESPONSETIMEOUT=<int>
,DESCRIPTION=<string>
,ROUTENUMBER=<string>
,SENDLININSTEADCPN=<int>
</E911BGSUBNETUPDATE>
25.2.49 Create Endpoint Profile

<EPCREATE>
EPCREATE - "Create an endpoint profile" (Please see WSDL
API:unsp__CreateEpProfile2)
,EPNAME=<string>
,EPTYPE=<enum>
,BGNAME=<string>
,RATEAREA=<string>
,PRIVACYSUPPORT=<enum>
,LANGUAGE=<string>
,FAILEDCALLSINTERCEPTTREATMENT=<bool>
,PIC_1=<string>
,PIC_2=<string>
,PIC_3=<string>
,PIC_4=<string>
,,QOSCLASSMODE=<enum>
,QOSVALUE=<int>
,CODECPRIM=<enum>
,PPPRIM=<int>
,TOSPRIM=<int>
,CODECSEC=<enum>
,PPSEC=<int>
,TOSSEC=<int>
,CODECTHIRD=<enum>
,PPTHIRD=<int>
,TOSTHIRD=<int>
,CODECFOURTH=<enum>
,PPFOURTH=<int>
,TOSFOURTH=<int>
</EPCREATE>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
25.2.50 Delete Endpoint Profile

<EPDEL>
EPDEL - "Delete an endpoint profile" (Please see WSDL
API:unsp__DeleteEpProfile2)
,EPNAME=<string>
</EPDEL>
25.2.51 Update Endpoint Profile

Management Information
<EPUPDATEMGT>
EPUPDATEMGT - "Update endpoint profile management
information" (Please see WSDL API:unsp__UpdateEpMgtInfo2)
,EPNAME=<string>
,BGNAME=<string>
,RATEAREA=<string>
,PRIVACYSUPPORT=<enum>
,LANGUAGE=<string>
,FAILEDCALLSINTERCEPTTREATMENT=<bool>
,IMPACTLEVEL=<enum>
</EPUPDATEMGT>
25.2.52 Update Endpoint Profile PICs

<EPUPDATEPICS>
EPUPDATEPICS - "Update Endpoint profiles PICS" (Please see
WSDL API:unsp__UpdateEpPics2)
,EPNAME=<string>
,PIC_1=<string>
,PIC_2=<string>
,PIC_3=<string>
,PIC_4=<string>
</EPUPDATEPICS>
25.2.53 Update Endpoint Profile QoS

Information
<EPUPDATEQOS>
EPUPDATEQOS - "Update endpoint profile QOS" (Please see WSDL
API:unsp__UpdateEpQos2)
,EPNAME=<string>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
,QOSVALUE=<int>
,CODECPRIM=<enum>
,PPPRIM=<int>
,TOSPRIM=<int>
,CODECSEC=<enum>
,PPSEC=<int>
,TOSSEC=<int>
,CODECTHIRD=<enum>
,PPTHIRD=<int>
,TOSTHIRD=<int>
,CODECFOURTH=<enum>
,PPFOURTH=<int>
,TOSFOURTH=<int>
</EPUPDATEQOS>
25.2.54 Create QoS Profile

<QOSPROFILECREATE>
QOSPROFILECREATE - (Please see WSDL
API:unsp__CreateQOSProfile2)
,QOSVALUE=<int>
,CODECPRIM=<enum>
,PPPRIM=<int>
,TOSPRIM=<int>
,DQTBRP=<int>
,DQTBSP=<int>
,DQPDRP=<int>
,DQMPUP=<int>
,DQMPSP=<int>
,DQRateP=<int>
,DQSTP=<int>
,CODECSEC=<enum>
,PPSEC=<int>
,TOSSEC=<int>
,DQTBRS=<int>
,DQTBSS=<int>
,DQPDRS=<int>
,DQMPUS=<int>
,DQMPSS=<int>
,DQRateS=<int>
,DQSTS=<int>
,CODECTHIRD=<enum>
,PPTHIRD=<int>
,TOSTHIRD=<int>
,DQTBRT=<int>
,DQTBST=<int>
,DQPDRT=<int>
,DQMPUT=<int>
,DQMPST=<int>
,DQRateT=<int>
,DQSTT=<int>
,CODECFOURTH=<enum>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
,PPFOURTH=<int>
,TOSFOURTH=<int>
,DQTBRF=<int>
,DQTBSF=<int>
,DQPDRF=<int>
,DQMPUF=<int>
,DQMPSF=<int>
,DQRateF=<int>
,DQSTF=<int>
,PCMMPS=<string>
,PCMMVOL=<int>
,PCMMVOLEXPMTHD=<enum>
,PCMMTIMR=<int>
,PCMMTIMREXPMTHD=<enum>
</QOSPROFILECREATE>
25.2.55 Modify QoS Profile

<QOSPROFILEMODIFY>
QOSPROFILEMODIFY - (Please see WSDL
API:unsp__ModifyQOSProfile2)
,QOSVALUE=<int>
,CODECPRIM=<enum>
,PPPRIM=<int>
,TOSPRIM=<int>
,RRPRIM=<enum>
,CODECSEC=<enum>
,PPSEC=<int>
,TOSSEC=<int>
,RRSEC=<enum>
,CODECTHRD=<enum>
,PPTHRD=<int>
,TOSTHRD=<int>
,RRTHRD=<enum>
,CODECFOURTH=<enum>
,PPFOURTH=<int>
,TOSFOURTH=<int>
,RRFOURTH=<enum>
,DQTBRP=<int>
,DQTBSP=<int>
,DQPDRP=<int>
,DQMPUP=<int>
,DQMPSP=<int>
,DQRateP=<int>
,DQSTP=<int>
,DQTBRS=<int>
,DQTBSS=<int>
,DQPDRS=<int>
,DQMPUS=<int>
,DQMPSS=<int>
,DQRateS=<int>
,DQSTS=<int>
,DQTBRT=<int>
,DQTBST=<int>
,DQPDRT=<int>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
,DQMPUT=<int>
,DQMPST=<int>
,DQRateT=<int>
,DQSTT=<int>
,DQTBRF=<int>
,DQTBSF=<int>
,DQPDRF=<int>
,DQMPUF=<int>
,DQMPSF=<int>
,DQRateF=<int>
,DQSTF=<int>
,PCMMPS=<string>
,PCMMVOL=<int>
,PCMMVOLEXPMTHD=<enum>
,PCMMTIMR=<int>
,PCMMTIMREXPMTHD=<enum>
</QOSPROFILEMODIFY>
25.2.56 Delete QoS Profile

<QOSPROFILEDEL>
QOSPROFILEDEL - Delete a QOS Profile (Please see WSDL
API:unsp__DeleteQOSProfile2)
</QOSPROFILEDEL>
25.2.57 Create Destination Code

<DESTCODECREATE>
DESTCODECREATE - "Creates a Destination Code" (Please see
WSDL API:unsp__CreateDestCode2 in Provisioning Doc for
Attribute details)
,DESTINATIONCODE=<string>
,CODEINDEXNAME=<string>
,NUMPA=<string>
,HOMEDNOFFICECODE=<string>
,DESTINATIONNAME=<string>
,RATEAREA=<string>
,DESTINATIONTYPE=<enum>
,TRAFFICTYPENAME=<string>
,NATUREOFADDRESS=<enum>
,OPERPREFIXNOTALLOWED=<bool>
,NATIONALPREFIXNOTALLOWED=<bool>
,NATIONPREFIXREQUIRED=<bool>
,CACNOTALLOWED=<bool>
,INTRIGPROCREQUIRED=<bool>
,DESTNEWCODE=<string>
,DESTCOUNTRYCODE=<string>
</DESTCODECREATE>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
25.2.58 Modify Destination Code

<DESTCODEMODIFY>
DESTCODEMODIFY - "Modifies a Destination Code" (Please see
WSDL API:unsp__ModifyDestCode2 in Provisioning Doc for
Attribute details)
,NUMPA=<string>
,HOMEDNOFFICECODE=<string>
,RATEAREA=<string>
,OPERPREFIXNOTALLOWED=<bool>
,NATIONALPREFIXNOTALLOWED=<bool>
,NATIONPREFIXREQUIRED=<bool>
,CACNOTALLOWED=<bool>
,INTRIGPROCREQUIRED=<bool>
,DESTNEWCODE=<string>
,DESTCOUNTRYCODE=<string>
</DESTCODEMODIFY>
25.2.59 Remove Destination Code

<DESTCODEREMOVE>
DESTCODEREMOVE - Remove a Destination Code (Please see WSDL
API:unsp__DeleteDestCode2)
,RATEAREA=<string>
</DESTCODEREMOVE>
25.2.60 Create Number Plan

<NPCREATE>
NPCREATE - Creates a Number Plan (Please see WSDL
API:unsp__CreateNumberPlan2)
,NUMBERPLANID=<int>
,BGNAME=<string>
</NPCREATE>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
25.2.61 Remove Number Plan

<NPREMOVE>
NPREMOVE - Removes a Number Plan (Please see WSDL
API:unsp__DeleteNumberPlan2)
</NPREMOVE>
25.2.62 Create Authorization Code

<AUTHCODECREATE>
AUTHCODECREATE - The authorization code to be used must be
between 2 and 14 characters. (Please see WSDL
API:unsp__CreateAuthCode)
,BGNAME=<string>
,COUNTAUTHCODELIST=<int>
,AUTHCODE_0=<string>
</AUTHCODECREATE>
25.2.63 Delete Authorization Code

<AUTHCODEDEL>
AUTHCODEDEL - Delete Authorization Code (Please see WSDL
API:unsp__DeleteAuthCode)
,BGNAME=<string>
,COUNTAUTHCODELIST=<int>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
</AUTHCODEDEL>
25.2.64 Create Prefix Access Code

<APAC>
APAC - Create Prefix Access Code (Please see WSDL
API:unsp__CreatePrefixAccessCode2)
,DIGITS=<string>
,DNMINLEN=<int>
,DNMAXLEN=<int>
,PREFIXTYPE=<enum>
,DIGITPOS=<int>
,DIGITSINSERT=<string>
,TRAILINGDIGITPOS=<int>
,NOA=<enum>
,DESTTYPE=<enum>
,DESTNAME=<string>
,CACLENGTH=<int>
</APAC>
25.2.65 Create PNP Location Code

<APNPLOC>
APNPLOC - Create PNP Location Code (Please see WSDL
API:unsp__CreatePnpLocationCode2)
,LOCCODE=<string>
,LOCL0LEN=<int>
,LOCL1LEN=<int>
,LOCL2LEN=<int>
,LOCSKIPDIGITS=<int>
</APNPLOC>
25.2.66 Update PNP Location Code

<UPNPLOC>
UPNPLOC - Modify Update PNP Location Code (Please see WSDL
API:unsp__ModifyPnpLocationCode2)
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
,LOCCODE=<string>
,LOCL0LEN=<int>
,LOCL1LEN=<int>
,LOCL2LEN=<int>
,LOCSKIPDIGITS=<int>
</UPNPLOC>
25.2.67 Remove PNP Location Code

<RPNPLOC>
RPNPLOC - Remove PNP Location Code (Please see WSDL
API:unsp__DeletePnpLocationCode2)
,LOCCODE=<string>
</RPNPLOC>
25.2.68 Update Prefix Access Code

<UPAC>
UPAC - Update Modify Prefix Access Code (Please see WSDL
API:unsp__ModifyPrefixAccessCode2)
,DIGITS=<string>
,DNMINLEN=<int>
,DNMAXLEN=<int>
,PREFIXTYPE=<enum>
,DIGITPOS=<int>
,DIGITSINSERT=<string>
,TRAILINGDIGITPOS=<int>
,NOA=<enum>
,DESTTYPE=<enum>
,DESTNAME=<string>
</UPAC>
25.2.69 Remove Prefix Access Code

<RPAC>
RPAC - Remove Prefix Access Code (Please see WSDL
API:unsp__DeletePrefixAccessCode2)
,DIGITS=<string>
,DNMINLEN=<int>
,DNMAXLEN=<int>
</RPAC>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
25.2.70 Create PNP Extension

<APNPEXT>
APNPEXT - Create PNP Extension (Please see WSDL
API:unsp__CreatePnpExtension2)
,EXTPREFIX=<string>
,EXTLEN=<int>
,LOCCODE=<string>
,E164PREFIX=<string>
,DESTTYPE=<enum>
,DESTNAME=<string>
</APNPEXT>
25.2.71 Update PNP Extension

<UPNPEXT>
UPNPEXT - Update Modify PNP Extension (Please see WSDL
API:unsp__ModifyPnpExtension2)
,EXTPREFIX=<string>
,EXTLEN=<int>
,LOCCODE=<string>
,E164PREFIX=<string>
,DESTTYPE=<enum>
,DESTNAME=<string>
</UPNPEXT>
25.2.72 Remove PNP Extension

<RPNPEXT>
RPNPEXT - Remove PNP Extension (Please see WSDL
API:unsp__DeletePnpExtension2)
,EXTPREFIX=<string>
</RPNPEXT>
25.2.73 Create Display Number Definition

<DNDCREATE>
DNDCREATE - "Create Display Number Definition" (Please see
WSDL API:unsp__CreateDNDefinition)
,COUNTRYCODE=<string>
,AREACODE=<string>
,EXCHANGECODE=<string>
,E164SKIPDIGIT=<int>
,LOCATIONCODE=<string>
,LOCL2LEN=<int>
,LOCL1LEN=<int>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
,LOCL0LEN=<int>
,PNPSKIPDIGIT=<int>
</DNDCREATE>
25.2.74 Delete Display Number Definition

<DNDDELETE>
DNDDELETE - "Delete Display Number Definition" (Please see
WSDL API:unsp__CreateDNDefinition)
,COUNTRYCODE=<string>
,AREACODE=<string>
,EXCHANGECODE=<string>
,E164SKIPDIGIT=<int>
,LOCATIONCODE=<string>
,LOCL2LEN=<int>
,LOCL1LEN=<int>
,LOCL0LEN=<int>
,PNPSKIPDIGIT=<int>
</DNDDELETE>
25.2.75 Create Display Number Prefix

<DNPCREATE>
DNPCREATE - "Create Display Number Prefix" (Please see WSDL
API:unsp__CreateDNPrefix)
,DNPCALLNUMBERPLANINDICATOR=<enum>
,DNPCALLTYPEOFNUMBER=<enum>
,NETWORKACCESSCODE=<string>
,NUMBERPREFIXCODE=<string>
</DNPCREATE>
25.2.76 Modify Display Number Prefix

<DNPMODIFY>
DNPMODIFY - "Modify Display Number Prefix" (Please see WSDL
API:unsp__ModifyDNPrefix)
,NETWORKACCESSCODE=<string>
,NUMBERPREFIXCODE=<string>
</DNPMODIFY>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
25.2.77 Delete Display Number Prefix

<DNPDELETE>
DNPDELETE - "Delete Display Number Prefix" (Please see WSDL
API:unsp__DeleteDNPrefix)
</DNPDELETE>
25.2.78 Create Display Number Modification

<DNMCREATE>
DNMCREATE - "Create Display Number Modification" (Please see
WSDL API:unsp__CreateDNModification)
,FROMNUMBERPLANNAME=<string>
,TONUMBERPLANNAME=<string>
,DNMTYPEOFNUMBERIN=<enum>
,DNMTYPEOFNUMBER=<enum>
,PRIVACYTYPE=<enum>
,OPTIMIZED=<bool>
</DNMCREATE>
25.2.79 Modify Display Number Modification

<DNMMODIFY>
DNMMODIFY - "Modify Display Number Modification" (Please see
WSDL API:unsp__ModifyDNModification)
,DNMTYPEOFNUMBER=<enum>
,PRIVACYTYPE=<enum>
,OPTIMIZED=<bool>
</DNMMODIFY>
25.2.80 Delete Display Number Modification

<DNMDELETE>
DNMDELETE - "Delete Display Number Modification" (Please see
WSDL API:unsp__DeleteDNModification)
</DNMDELETE>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
25.2.81 Update Business Group Common

Numbering Plan
<BGPARAMSMODIFY>
BGPARAMSMODIFY - "Update BG Parameters,
BGCommonNumberingPlan"
(Please see WSDL API:unsp__UpdateBGParms2)
,BGNAME=<string>
,BGCOMMONNUMBERPLANNAME=<string>
</BGPARAMSMODIFY>
25.2.82 Update Business Group Default QoS

profile
<UBQOSP>
UBQOSP - "Update default QOS profile" (Please see WSDL
API:unsp__UpdateBGParms2)
,BGNAME=<string>
</UBQOSP>
25.2.83 Create CAC Group

<CCG>
CCG - "Create a CAC Group" (Please see WSDL
API:unsp__CreateCACGroup)
,BUSINESSGROUPNAME=<string>
,BRANCHOFFICENAME=<string>
,CACGROUPNAME=<string>
,CACGROUPTYPE=<enum>
,ROUTERIPADDRESS=<string>
,INTERFACENAME=<string>
,ACCESSLINKTYPE=<enum>
,ROUTERIPADDRESS2=<string>
,INTERFACENAME2=<string>
,ACCESSLINKTYPE2=<enum>
,NUMCACGROUPADDRESS=<int>
,CACGROUPADDRESS0=<string>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
</CCG>
25.2.84 Delete CAC Group

<DCG>
DCG - "Delete a CAC Group" (Please see WSDL
API:unsp__DeleteCACGroup)
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
</DCG>
25.2.85 Remove CAC Group Address

<DCGA>
DCGA - "Removes one or more address from an existing CAC
Group" (Please see WSDL API:unsp__RemoveCACGroupAddr)
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
</DCGA>
25.2.86 Add CAC Group Address

<CCGA>
CCGA - "Adds one or more addresses to an existing CAC Group"
(Please see WSDL API:unsp__AddCACGroupAddr)
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
</CCGA>
25.2.87 Create CAC Policy

<CCP>
CCP - "Create a CAC Policy" (Please see WSDL
API:unsp__CreateCACPolicy)
,CACPOLICYTYPE=<int>
,CACPOLICYLIMITTYPE=<enum>
,CACPOLICYOPTIONFLAG=<enum>
,CALLLIMIT=<int>
,BANDWIDTHLIMIT=<int>
,SECONDARYCALLLIMIT=<int>
,SECONDARYBANDWIDTHLIMIT=<int>
,CACPOLICYALLOWALLCODEC=<bool>
,CACPOLICYALLOWG711ALAWCODEC=<bool>
,CACPOLICYALLOWG711ULAWCODEC=<bool>
,CACPOLICYALLOWG722CODEC=<bool>
,CACPOLICYALLOWILBCCODEC=<bool>
,CACPOLICYALLOWAMRCODEC=<bool>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
,CACPOLICYALLOWAMRWBCODEC=<bool>
CACPOLICYALLOWAACLCCODEC=<bool>
CACPOLICYALLOWG722124CODEC=<bool>
CACPOLICYALLOWALLVIDEOCODEC=<bool>
CACPOLICYALLOWH263CODEC=<bool>
CACPOLICYALLOWVP8CODEC=<bool>
MAXPROFILELEVEL=<enum>
</CCP>
25.2.88 Delete CAC Policy

<DCP>
DCP - "Delete a CAC Policy" (Please see WSDL
API:unsp__DeleteCACPolicy)
</DCP>
25.2.89 Create Group To Group CAC Policy

<CGTGCP>
CGTGCP - "Creates a Group-To-Group CAC Policy" (Please see
WSDL API:unsp__CreateGToGCACPolicy in Provisioning Doc for
Attribute details)
,CACGROUP1NAME=<string>
,CACPOLICYLIMITTYPE=<enum>
,CACPOLICYOPTIONFLAG=<enum>
,CALLLIMIT=<int>
,BANDWIDTHLIMIT=<int>
,CACPOLICYALLOWALLCODEC=<bool>
,CACPOLICYALLOWG711ALAWCODEC=<bool>
,CACPOLICYALLOWG711ULAWCODEC=<bool>
,CACPOLICYALLOWILBCCODEC=<bool>
,CACPOLICYALLOWAMRCODEC=<bool>
,CACPOLICYALLOWAMRWBCODEC=<bool>
CACPOLICYALLOWAACLCCODEC=<bool>
CACPOLICYALLOWVP8CODEC=<bool>
MAXPROFILELEVEL=<enum>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
</CGTGCP>
25.2.90 Delete Group To Group CAC Policy

<DGTGCP>
DGTGCP - "Deletes a Group-To-Group CAC Policy" (Please see
WSDL API:unsp__DeleteGToGCACPolicy in Provisioning Doc for
Attribute details)
,=<>
</DGTGCP>
25.2.91 Create Business Group Speed Calling

List
<BGSPEEDDIALLISTCREATE>
BGSPEEDDIALLISTCREATE - "Creation of BG Speed Calling Lists"
(Please see WSDL API:unsp__CreateBgSpeedDialList)
,BGNAME=<string>
,LISTID=<int>
,LISTNAME=<string>
,BGSD_ENTRYID=<int>
,BGSD_ENTRYDATA=<string>
</BGSPEEDDIALLISTCREATE>
25.2.92 Update Business Group Speed

Calling List
<BGSPEEDDIALLISTUPDATE>
BGSPEEDDIALLISTUPDATE - "Update the ListName of a List"
(Please see WSDL API:unsp__UpdateBgSpeedDialList)
,BGNAME=<string>
,LISTID=<int>
,LISTNAME=<string>
</BGSPEEDDIALLISTUPDATE>
25.2.93 Delete Business Group Speed Calling

List
<BGSPEEDDIALLISTDELETE>
BGSPEEDDIALLISTDELETE - "Delete an entire Speed Dial List"
(Please see WSDL API:unsp__DeleteBgSpeedDialList)
,BGNAME=<string>
,LISTID=<int>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
</BGSPEEDDIALLISTDELETE>
25.2.94 Delete Business Group Speed Calling

List Entries
<BGSPEEDDIALLISTENTRIESDELETE>
BGSPEEDDIALLISTENTRIESDELETE - "Delete the Entries of a
SPDial List (Please see WSDL
API:unsp__DeleteBgSpeedDialListEntries)
,BGNAME=<string>
,LISTID=<int>
,BGSD_ENTRYID=<int>
</BGSPEEDDIALLISTENTRIESDELETE>
25.2.95 Update Business Group Speed

Calling List Entries
<BGSPEEDDIALLISTENTRIESUPDATE>
BGSPEEDDIALLISTENTRIESUPDATE - "Udpate the Entries of a
List" (Please see WSDL
API:unsp__UpdateBgSpeedDialListEntries)
,BGNAME=<string>
,LISTID=<int>
,BGSD_ENTRYID=<int>
,BGSD_ENTRYDATA=<string>
</BGSPEEDDIALLISTENTRIESUPDATE>
25.2.96 Assign Day Schedule

<AssignDaySchedule>
AssignDayScheduleRequest(Please see WSDL
API:unsp__assignDaySchedule for more details)
AssignDaySchedule
,TimeDestinationName=<string>
,DayScheduleNameSun=<string>
,DayScheduleNameMon=<string>
,DayScheduleNameTue=<string>
,DayScheduleNameWed=<string>
,DayScheduleNameThu=<string>
,DayScheduleNameFri=<string>
,DayScheduleNameSat=<string>
<\AssignDaySchedule>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
25.2.97 Assign Treatment

<AssignTreatment>
TreatmentDataInfo(Please see WSDL API:unsp__assignTreatment
for more details)
AssignTreatment
,Cycle=<long>
,Interval=<long>
,Type=<enum unsp__TreatmentType>
,SipReasonId=<long>
,TreatmentInfoName=<string>
,TreatmentInfoOrder=<enum unsp__TreatmentOrder>
,InterceptInfoName=<string>
,ToneName=<string>
,ToneDuration=<long>
,ToneDestinationName=<string>
,ToneDestinationCircuit=<string>
,ToneDestinationType=<enum
unsp__InterceptDestinationType>
,AnnounceName=<string>
,AnnounceAnswer=<enum unsp__YesNo>
,AnnounceBargeIn=<enum unsp__YesNo>
,AnnounceDestinationName=<string>
,AnnounceDestinationCircuit=<string>
,AnnounceDestinationType=<enum
<\AssignTreatment>
25.2.98 Block Media Gateway

<BlockMediaGateway>
BlockMediaGatewayRequest(Please see WSDL
API:unsp__blockMediaGateway for more details)
BlockMediaGateway
,GatewayName=<string>
,AdminStatus=<enum unsp__ResourceStatus>
<\BlockMediaGateway>
25.2.99 Block Trunk

<BlockTrunk>
BlockTrunkRequest(Please see WSDL API:unsp__blockTrunk for
more details)
BlockTrunk
,TrunkGroupName=<RtmTrunkGroupName>
,TrunkGroupNumber=<unsignedShort>
,TrunkNumberMin=<int>
,TrunkNumberMax=<int>
<\BlockTrunk>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
25.2.100 Block Trunk Group

<BlockTrunkGroup>
BlockTrunkGroupRequest(Please see WSDL
API:unsp__blockTrunkGroup for more details)
BlockTrunkGroup
,TrunkGroupNumber=<unsignedInt>
<\BlockTrunkGroup>
25.2.101 Create Alias

<Alias>
CreateAliasRequest(Please see WSDL API:unsp__createAlias
for more details)
Alias
,NodeName=<string>
,NumberAliases=<short>
,AliasesNodeName=<string>
,AliasesAliasName=<string>
,AliasesAliasType=<enum unsp__AliasType>
,AliasesRegistration=<short>
<\Alias>
25.2.102 Create Calling Location

<CallingLocation>
CreateCallingLocationRequest(Please see WSDL
API:unsp__createCallingLocation for more details)
CallingLocation
,Code=<string>
,Name=<string>
<\CallingLocation>
25.2.103 Create Class Of Service

<ClassService>
CreateClassServiceRequest(Please see WSDL
API:unsp__createClassService for more details)
ClassService
,Name=<string>
,Number=<long>
,DefaultCpcCos=<long>
,DefaultCpcCosName=<string>
<\ClassService>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
25.2.104 Create Code Process

<CodeProcess>
CreateCodeProcessRequest(Please see WSDL
API:unsp__createCodeProcess for more details)
CodeProcess
,NumberOfOperations=<short>
,CodeProcessCodeProcessName=<string>
,CodeProcessNatureOfAddress=<enum
unsp__E164NatureOfAddr>
,CodeProcessRetranslate=<bool>
,CodeProcessDestinationName=<string>
,CodeProcessDestinationType=<enum unsp__DestCodeDt>
,OperationListDigitPosition=<long>
,OperationListDigitsToInsert=<string>
,OperationListDigitsToDelete=<long>
<\CodeProcess>
25.2.105 Create Day Schedule

<DaySchedule>
CreateDayScheduleRequest(Please see WSDL
API:unsp__createDaySchedule for more details)
DaySchedule
,Name=<string>
<\DaySchedule>
25.2.106 Create Destination

<Destination>
CreateDestinationRequest(Please see WSDL
API:unsp__createDestination for more details)
Destination
,NumberRoutes=<long>
,DestinationName=<string>
,DestinationSignaling=<enum unsp__SignalingType>
,DestinationBearer=<enum unsp__BearerCaps>
,DestinationDestinationAttributes=<enum
unsp__DestinationAttributes>
,DestinationAttributes=<enum unsp__Attributes>
,DestinationNumberPlanName=<string>
,DestinationPrefixAreaCode=<enum unsp__Attributes>
,DestinationPrefixCountryCode=<enum unsp__Attributes>
,DestinationReRoute=<enum unsp__Attributes>
,RouteListId=<long>
,RouteListName=<string>
,RouteListReferenceName=<string>
,RouteListReferenceType=<enum unsp__ReferenceType>
,RouteListDigitsToDelete=<short>
,RouteListDigitsToInsert=<string>
,RouteListNatureOfAddress=<enum unsp__E164NatureOfAddr>
,RouteListCacSignaling=<enum unsp__CacSignaling>
<\Destination>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
25.2.107 Create Endpoint

<Endpoint>
CreateEndpointRequest(Please see WSDL
API:unsp__createEndpoint for more details)
Endpoint
,EndpointName=<string>
,EndpointIpAddress=<string>
,EndpointAltIpAddress=<string>
,EndpointRasIpAddress=<string>
,EndpointManagementIpAddress=<string>
,EndpointPort=<int>
,EndpointAltPort=<int>
,EndpointRasPort=<int>
,EndpointEndpointType=<enum unsp__EndpointType>
,EndpointRegistration=<short>
,EndpointTimeToLive=<double>
,EndpointAccountAuth=<enum unsp__AccountAuth>
,EndpointProfileName=<string>
,EndpointSessions=<long>
,EndpointMaxOriginatingSessionLimit=<long>
,EndpointMaxTerminatingSessionLimit=<long>
,EndpointTransport=<enum unsp__TransportType>
,EndpointAttributes=<long>
,EndpointAddressOfRecord=<string>
,EndpointServerFailover=<enum unsp__EpFailover>
,EndpointKeysetUse=<enum unsp__KeysetUse>
,EndpointCountryCode=<string>
,EndpointAssociatedEndpointName=<string>
,EndpointIvtgNameDomain=<string>
,EndpointAttributes=<long>
,EndpointLooseRoutingURI=<string>
,EnablePrack=<bool>
,EndpointSrtpSupport=<enum unsp__SrtpSupport>
,EndpointAnatSupport=<enum unsp__Anat>
,OutgoingCallSupervisionTimer
,ProxyBypassSupervisionTime
,EndpointLocationDomain=<string>
,SetNPIandTONtoUnknown=<bool>
,SendXferingNrIsoCgNrForXferedCalls=<bool>
,IncludeRestrNrsInFromHeader=<bool>
,EnableSessionTimer=<bool>
,EndpointUseEndpointDefaultHomeDnAsAuthNumber=<bool>
,EndpointUseSubscriberHomeDnAsAuthNumber=<bool>
,EndpointDisableLongCallAudit=<bool>
,EndpointReserved3=<bool>
,EndpointReserved4=<bool>
,SendReceiveImpactLevel=<bool>
,AddressOfRecord=<string>
,SupportCallbackPathReservation=<bool>
,SendProgStopCallProcTimer=<bool>
,VoiceMail=<bool>
,EnablePrack=<bool>
,SrtpSupport=<unsp__SrtpSupport
,LocationDomain=<string>
,AliasesCustomerName=<string>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
,EndpointDoNotSendSIPUri=<bool>
,EndpointSendSIPUriWhenAvailable=<bool>
,EndpointSupportPeerDomains=<bool>
<\Endpoint>
25.2.108 Create HomeDN

<HomeDn>
CreateHomeDnRequest(Please see WSDL API:unsp__createHomeDn
for more details)
HomeDn
,StartCode=<string>
,EndCode=<string>
,OfficeCode=<string>
,<\HomeDn>
25.2.109 Create Intercept

<Intercept>
InterceptRequest(Please see WSDL API:unsp__createIntercept
for more details)
Intercept
,CreateName=<boolean>
,NumberTreatments=<short>
,InterceptCycle=<long>
,InterceptInterval=<long>
,InterceptIsDefault=<enum unsp__IsDefault>
,InterceptDefaultName=<string>
,TreatmentCycle=<long>
,TreatmentInterval=<long>
,TreatmentType=<enum unsp__TreatmentType>
,TreatmentSipReasonId=<long>
,TreatmentInfoOrder=<enum unsp__TreatmentOrder>
,ToneName=<string>
<\Intercept>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
25.2.110 Create Media Gateway Circuits

<MediaGatewayCircuits>
CreateMediaGatewayCircuitsRequest(Please see WSDL
API:unsp__createMediaGatewayCircuits for more details)
MediaGatewayCircuits
,CircuitType=<enum unsp__CircuitAssignment>
,StartCircuitId=<string>
,EndCircuitId=<string>
<\MediaGatewayCircuits>
25.2.111 Create Media Gateway

<MediaGateway>
CreateMediaGatewayRequest(Please see WSDL
API:unsp__createMediaGateway for more details)
MediaGateway
,GatewayProtocolType=<enum unsp__GatewayProtocolType>
,GatewayProtocolVersion=<enum
unsp__GatewayProtocolVersion>
,MgCircuitFormat=<string>
,NetworkTypes=<int>
,CodecTypes=<int>
,MgAddrCallp=<string>
,MgAddrProvision=<string>
,Timeout=<unsignedInt>
,RetryCount=<unsignedInt>
,IpAddrAllocMethod=<enum unsp__IPAddressAllocMethod>
,Fqdn=<string>
,LocalClli=<string>
,GwAssignMethod=<enum unsp__GatewayAssignmentMethod>
,MediaServerVersion=<enum unsp__MSVersion>
,TimerHist=<int>
,TimerMax=<int>
,TransmissionTimerLen=<int>
,FaxT38Relay=<enum unsp__T38FaxRelay>
,DtmfRelay=<enum unsp__DtmfRelay>
,MultiHomingFlag=<enum unsp__MultiHoming>
,OverloadSupport=<enum unsp__YesNo>
,OverloadAllowTwCalls=<enum unsp__YesNo>
,OverloadReturnCodeOne=<int>
,OverloadReturnCodeTwo=<int>
,OverloadReturnCodeThree=<int>
,OverloadGapIntervalOne=<int>
,OverloadGapIntervalTwo=<int>
,OverloadGapIntervalThree=<int>
<\MediaGateway>
25.2.112 Create Office Code

<OfficeCode>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
CreateOfficeCodeRequest(Please see WSDL

API:unsp__createOfficeCode for more details)
OfficeCode
,CountryCodeLength=<short>
,AreaCodeLength=<short>
,Attributes=<enum unsp__Attributes>
,ChargeArea=<string>
<\OfficeCode>
25.2.113 Create Origin Destination

<OriginDestination>
OriginDestinationRequest(Please see WSDL
API:unsp__createOriginDestination for more details)
OriginDestination
,Name=<string>
,Type=<enum unsp__OrigDestType>
<\OriginDestination>
25.2.114 Create Origin Route

<OriginRoute>
CreateOriginRoute(Please see WSDL
API:unsp__createOriginRoute for more details)
OriginRoute
,OriginDestinationName=<string>
,RateAreaName=<string>
,DestinationType=<enum unsp__OriginRouteDestinationType>
,IsupCircuitCode=<long>
<\OriginRoute>
25.2.115 Create Period Schedule

<PeriodSchedule>
CreatePeriodScheduleRequest(Please see WSDL
API:unsp__createPeriodSchedule for more details)
PeriodSchedule
,Name=<string>
,DayScheduleName=<string>
,StartTime=<string>
,StopTime=<string>
<\PeriodSchedule>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
25.2.116 Create Rate Area

<RateArea>
CreateRateAreaRequest(Please see WSDL
API:unsp__createRateArea for more details)
RateArea
,Group=<long>
,Name=<string>
,NpaNxx=<string>
,SlhrName=<string>
,PointCode=<long>
,NodeVariant=<enum unsp__NodeVariant>
,Lata=<string>
<\RateArea>
25.2.117 Create Route

<Route>
CreateRouteRequest(Please see WSDL API:unsp__createRoute
for more details)
Route
,NumRoutes=<long>
,GenericRouteDestinationName=<string>
,GenericRouteDestinationSignaling=<enum
unsp__SignalingType>
,GenericRouteDestinationBearer=<enum unsp__BearerCaps>
,GenericRouteDestinationDestinationAttributes=<enum
,GenericRouteDestinationAttributes=<enum
unsp__Attributes>
,GenericRouteDestinationNumberPlanName=<string>
,GenericRouteDestinationPrefixAreaCode=<enum
unsp__Attributes>
,GenericRouteDestinationPrefixCountryCode=<enum
unsp__Attributes>
,GenericRouteDestinationReRoute=<enum unsp__Attributes>
,RouteListId=<long>
,RouteListReferenceName=<string>
,RouteListReferenceType=<enum unsp__ReferenceType>
,RouteListDigitsToDelete=<short>
,RouteListDigitsToInsert=<string>
,RouteListNatureOfAddress=<enum unsp__E164NatureOfAddr>
,RouteListCacSignaling=<enum unsp__CacSignaling>
<\Route>
25.2.118 Create Time Destination

<TimeDestination>
TimeDestinationRequest(Please see WSDL
API:unsp__createTimeDestination for more details)
TimeDestination
,Name=<string>
<\TimeDestination>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
25.2.119 Create Trunk

<Trunk>
CreateTrunkRequest(Please see WSDL API:unsp__createTrunk
for more details)
Trunk
,CicNumberMin=<int>
,MediaGatewayName=<string>
,MediaCicMinId=<string>
,MediaCicMaxId=<string>
,HandlingGroupNumber=<short>
<\Trunk>
25.2.120 Create Trunk Group

<TrunkGroup>
CreateTrunkGroupRequest(Please see WSDL
API:unsp__createTrunkGroup for more details)
TrunkGroup
,TrunkType=<enum unsp__TrunkType>
,TrunkGroupComment=<RtmLongString>
,SignalProfileName=<string>
,FarEndDpc=<RtmPointCode>
,OwnPointCodeType=<enum unsp__OPCType>
,OwnPointCode=<RtmPointCode>
,Usage=<enum unsp__TrunkGroupUsage>
,Owner=<RtmLongString>
,RemoteClli=<string>
,CDRRecordingIns=<enum unsp__CDRRecordingIns>
,SearchMethod=<enum unsp__SearchMethod>
,GainControl=<int>
,CotProcedure=<enum unsp__COTProcedure>
,CotFrequency=<int>
,CirCarrierIndicator=<enum
unsp__CircuitCarrierIndicator>
,AlarmCarrierIndicator=<enum
unsp__AlarmCarrierIndicator>
,HopCountInitValue=<int>
,AccessTandem=<enum unsp__YesNo>
,DefaultDn=<RtmDefaultDn>
,RateAreaName=<RtmRateAreaName>
,ClassOfServiceName=<RtmClassOfServceName>
,NetworkIndicator=<enum unsp__NetworkIndicator>
,SigTranIndicator=<enum unsp__YesNo>
,PreferredTrunkUsage=<int>
,BothwayTrunksReserve=<int>
,PriorityTrunksReserve=<int>
,FarEndCarrierIdCode=<RtmFarEndCarrierIdCode>
,FarEndCarrierSwitchName=<RtmFarEndCarrierSwName>
,POIflag=<enum unsp__POIFlag>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
,POIstage=<enum unsp__POIStage>
,POIChargeArea=<RtmPOIChargeArea>
,Language=<string>
<\TrunkGroup>
25.2.121 Modify Class Of Service

<ModifyClassService>
ModifyClassServiceRequest(Please see WSDL
API:unsp__modifyClassService for more details)
ModifyClassService
,Name=<string>
<\ModifyClassService>
25.2.122 Modify Code Process
<ModifyCodeProcess>
ModifyCodeProcessRequest(Please see WSDL
API:unsp__modifyCodeProcess for more details)
ModifyCodeProcess
,NumberOfOperations=<short>
,CodeProcessCodeProcessName=<string>
,CodeProcessNatureOfAddress=<enum
unsp__E164NatureOfAddr>
,CodeProcessRetranslate=<bool>
,CodeProcessDestinationName=<string>
,CodeProcessDestinationType=<enum unsp__DestCodeDt>
,OperationListDigitPosition=<long>
,OperationListDigitsToInsert=<string>
,OperationListDigitsToDelete=<long>
<\ModifyCodeProcess>
25.2.123 Modify Day Schedule

<ModifyDaySchedule>
ModifyDayScheduleRequest(Please see WSDL
API:unsp__modifyDaySchedule for more details)
ModifyDaySchedule
,ModifyType=<enum unsp__DnModifyType>
,DayScheduleNameSun=<string>
,DayScheduleNameMon=<string>
,DayScheduleNameTue=<string>
,DayScheduleNameWed=<string>
,DayScheduleNameThu=<string>
,DayScheduleNameFri=<string>
,DayScheduleNameSat=<string>
<\ModifyDaySchedule>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
25.2.124 Modify Destination

<ModifyDestination>
ModifyDestinationRequest(Please see WSDL
API:unsp__modifyDestination for more details)
ModifyDestination
,Name=<string>
,Signaling=<enum unsp__SignalingType>
,Bearer=<enum unsp__BearerCaps>
,DestinationAttributes=<enum
,NumberPlanName=<string>
,PrefixAreaCode=<enum unsp__Attributes>
,PrefixCountryCode=<enum unsp__Attributes>
,ReRoute=<enum unsp__Attributes>
<\ModifyDestination>
25.2.125 Modify Endpoint

<ModifyEndpoint>
ModifyEndpointRequest(Please see WSDL
API:unsp__modifyEndpoint for more details)
ModifyEndpoint
,Name=<string>
,IpAddress=<string>
,AltIpAddress=<string>
,RasIpAddress=<string>
,ManagementIpAddress=<string>
,Port=<int>
,AltPort=<int>
,RasPort=<int>
,Registration=<short>
,TimeToLive=<double>
,AccountAuth=<enum unsp__AccountAuth>
,ProfileName=<string>
,Sessions=<long>
,MaxOriginatingSessionLimit=<long>
,MaxTerminatingSessionLimit=<long>
,Transport=<enum unsp__TransportType>
,Attributes=<long>
,ServerFailover=<enum unsp__EpFailover>
,KeysetUse=<enum unsp__KeysetUse>
,CountryCode=<string>
,AssociatedEndpointName=<string>
,IvtgNameDomain=<string>
,Attributes=<long>
,LooseRoutingURI=<string>
,EnablePrack=<bool>
,EndpointSrtpSupport=<enum unsp__SrtpSupport>
,EndpointLocationDomain=<string>
,SetNPIandTONtoUnknown=<bool>
,SendXferingNrIsoCgNrForXferedCalls=<bool>
,IncludeRestrNrsInFromHeader=<bool>
,Reserved3=<bool>
,Reserved4=<bool>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
,EnableSessionTimer=<bool>
,UseEndpointDefaultHomeDnAsAuthNumber=<bool>
,UseSubscriberHomeDnAsAuthNumber=<bool>
,DisableLongCallAudit=<bool>
,SendReceiveImpactLevel=<bool>
,SupportCallbackPathReservation=<bool>
,SendProgStopCallProcTimer=<bool>
,VoiceMail=<bool>
,EnablePrack=<bool>
,SrtpSupport=<unsp__SrtpSupport
,AnatSupport=<enum unsp__Anat>
,EndpointDoNotSendSIPUri=<bool>
,EndpointSendSIPUriWhenAvailable=<bool>
,EndpointSupportPeerDomains=<bool>
<\ModifyEndpoint>
25.2.126 Modify HomeDN

<ModifyHomeDn>
ModifyHomeDnRequest(Please see WSDL API:unsp__modifyHomeDn
for more details)
ModifyHomeDn
,ModifyType=<enum unsp__DnModifyType>
,StartCode=<string>
,EndCode=<string>
,DestinationType=<enum unsp__DestinationType>
,SubscriberName=<string>
,NewDn=<string>
,EnableAssign=<enum unsp__CommandActivate>
,EnableMatch=<enum unsp__EnableMatch>
<\ModifyHomeDn>
25.2.127 Modify Intercept

<ModifyIntercept>
ModifyIntercept(Please see WSDL API:unsp__modifyIntercept
for more details)
ModifyIntercept
,Cycle=<long>
,Interval=<long>
,IsDefault=<enum unsp__IsDefault>
,DefaultName=<string>
<\ModifyIntercept>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
25.2.128 Modify Media Gateway

<ModifyMediaGateway>
ModifyMediaGatewayRequest(Please see WSDL
API:unsp__modifyMediaGateway for more details)
ModifyMediaGateway
,GatewayProtocolType=<enum unsp__GatewayProtocolType>
,GatewayProtocolVersion=<enum
unsp__GatewayProtocolVersion>
,MgCircuitFormat=<string>
,NetworkTypes=<int>
,CodecTypes=<int>
,MgAaddrProvision=<string>
,Timeout=<unsignedInt>
,RetryCount=<unsignedInt>
,IpAddrAllocMethod=<enum unsp__IPAddressAllocMethod>
,Fqdn=<string>
,MediaServerVersion=<enum unsp__MSVersion>
,TimerHist=<int>
,TimerMax=<int>
,TransmissionTimerLen=<int>
,FaxT38Relay=<enum unsp__T38FaxRelay>
,DtmfRelay=<enum unsp__DtmfRelay>
,MultiHomingFlag=<enum unsp__MultiHoming>
,OverloadSupport=<enum unsp__YesNo>
,OverloadAllowTwCalls=<enum unsp__YesNo>
,OverloadReturnCodeOne=<int>
,OverloadReturnCodeTwo=<int>
,OverloadReturnCodeThree=<int>
,OverloadGapIntervalOne=<int>
,OverloadGapIntervalTwo=<int>
,OverloadGapIntervalThree=<int>
<\ModifyMediaGateway>
25.2.129 Modify Office Code

<ModifyOfficeCode>
ModifyOfficeCodeRequest(Please see WSDL
API:unsp__modifyOfficeCode for more details)
ModifyOfficeCode
,CountryCodeLength=<short>
,AreaCodeLength=<short>
,ChargeArea=<string>
<\ModifyOfficeCode>
25.2.130 Modify Origin Destination

<ModifyOriginDestination>
API:unsp__modifyOriginDestination for more details)
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
ModifyOriginDestination
,Name=<string>
,Type=<enum unsp__OrigDestType>
<\ModifyOriginDestination>
25.2.131 Modify Origin Route

<ModifyOriginRoute>
ModifyOriginRouteRequest(Please see WSDL
API:unsp__modifyOriginRoute for more details)
ModifyOriginRoute
,DestinationType=<enum unsp__OriginRouteDestinationType>
,IsupCircuitCode=<long>
<\ModifyOriginRoute>
25.2.132 Modify Period Schedule

<ModifyPeriodSchedule>
ModifyPeriodScheduleRequest(Please see WSDL
API:unsp__modifyPeriodSchedule for more details)
ModifyPeriodSchedule
,Name=<string>
,StartTime=<string>
,StopTime=<string>
<\ModifyPeriodSchedule>
25.2.133 Modify Route

<ModifyRoute>
ModifyRouteRequest(Please see WSDL API:unsp__modifyRoute
for more details)
ModifyRoute
unsp__Attributes>
unsp__Attributes>
unsp__Attributes>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
,RouteId=<long>
,RouteName=<string>
,RouteReferenceName=<string>
,RouteReferenceType=<enum unsp__ReferenceType>
,RouteDigitsToDelete=<short>
,RouteDigitsToInsert=<string>
,RouteNatureOfAddress=<enum unsp__E164NatureOfAddr>
,RouteCacSignaling=<enum unsp__CacSignaling>
<\ModifyRoute>
25.2.134 Modify Treatment

<ModifyTreatment>
ModifyTreatmentData(Please see WSDL
API:unsp__modifyTreatment for more details)
ModifyTreatment
,Cycle=<long>
,Interval=<long>
,SipReasonId=<long>
,ToneName=<string>
<\ModifyTreatment>
25.2.135 Modify Trunk

<ModifyTrunk>
ModifyTrunkRequest(Please see WSDL API:unsp__modifyTrunk
for more details)
ModifyTrunk
,HandlingGroupNumber=<short>
<\ModifyTrunk>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
25.2.136 Modify Trunk Group

<ModifyTrunkGroup>
ModifyTrunkGroupRequest(Please see WSDL
API:unsp__modifyTrunkGroup for more details)
ModifyTrunkGroup
,TrunkType=<enum unsp__TrunkType>
,TrunkGroupComment=<RtmLongString>
,SignalProfileName=<string>
,Usage=<enum unsp__TrunkGroupUsage>
,Owner=<RtmLongString>
,RemoteClli=<string>
,CDRRecordingIns=<enum unsp__CDRRecordingIns>
,SearchMethod=<enum unsp__SearchMethod>
,GainControl=<int>
,CotProcedure=<enum unsp__COTProcedure>
,CotFrequency=<int>
,CirCarrierIndicator=<enum
unsp__CircuitCarrierIndicator>
,AlarmCarrierIndicator=<enum
unsp__AlarmCarrierIndicator>
,HopCountInitValue=<int>
,CongestionControlAction=<enum
unsp__CongestionControlAction>
,CongestionControlLevel=<enum unsp__CongestionLevel>
,AccessTandem=<enum unsp__YesNo>
,DefaultDn=<RtmDefaultDn>
,RateAreaName=<RtmRateAreaName>
,ClassOfServiceName=<RtmClassOfServceName>
,NetworkIndicator=<enum unsp__NetworkIndicator>
,SigTranIndicator=<enum unsp__YesNo>
,PreferredTrunkUsage=<int>
,BothwayTrunksReserve=<int>
,PriorityTrunksReserve=<int>
,FarEndCarrierIdCode=<RtmFarEndCarrierIdCode>
,FarEndCarrierSwitchName=<RtmFarEndCarrierSwName>
,POIflag=<enum unsp__POIFlag>
,POIstage=<enum unsp__POIStage>
,POIChargeArea=<RtmPOIChargeArea>
,Language=<string>
<\ModifyTrunkGroup>
25.2.137 Prioritize Route

<PrioritizeRoute>
PrioritizeRouteRequest(Please see WSDL
API:unsp__prioritizeRoute for more details)
PrioritizeRoute
,Name=<string>
,RouteIndex=<long>
,ReferenceName=<string>
,ReferenceType=<enum unsp__ReferenceType>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
,NewRouteIndex=<long>
<\PrioritizeRoute>
25.2.138 Prioritize Treatment

<PrioritizeTreatment>
PrioritizeTreatmentRequest(Please see WSDL
API:unsp__prioritizeTreatment for more details)
PrioritizeTreatment
,NewOrder=<enum unsp__TreatmentOrder>
<\PrioritizeTreatment>
25.2.139 Remove Alias

<RemoveAlias>
RemoveAliasRequest(Please see WSDL API:unsp__removeAlias
for more details)
RemoveAlias
,NodeName=<string>
<\RemoveAlias>
25.2.140 Remove Calling Location

<RemoveCallingLocation>
RemoveCallingLocationRequest(Please see WSDL
API:unsp__removeCallingLocation for more details)
RemoveCallingLocation
,Code=<string>
<\RemoveCallingLocation>
25.2.141 Remove Class Of Service

<RemoveClassService>
RemoveClassServiceRequest(Please see WSDL
API:unsp__removeClassService for more details)
RemoveClassService
,Name=<string>
,Number=<long>
,DefaultCpcCos=<long>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
<\RemoveClassService>
25.2.142 Remove Code Process
<RemoveCodeProcess>
RemoveCodeProcessRequest(Please see WSDL
API:unsp__removeCodeProcess for more details)
RemoveCodeProcess
,CodeProcessName=<string>
<\RemoveCodeProcess>
25.2.143 Remove Day Schedule

<RemoveDaySchedule>
RemoveDayScheduleRequest(Please see WSDL
API:unsp__removeDaySchedule for more details)
RemoveDaySchedule
,Name=<string>
<\RemoveDaySchedule>
25.2.144 Remove Destination

<RemoveDestination>
RemoveDestinationRequest(Please see WSDL
API:unsp__removeDestination for more details)
RemoveDestination
,Name=<string>
,DestinationAttributes=<enum
,NumberPlanName=<string>
<\RemoveDestination>
25.2.145 Remove Endpoint

<RemoveEndpoint>
RemoveEndpointRequest(Please see WSDL
API:unsp__removeEndpoint for more details)
RemoveEndpoint
,EndpointType=<enum unsp__EndpointType>
,NumberEndpoints=<short>
,EndpointsName=<string>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
<\RemoveEndpoint>
25.2.146 Remove HomeDN

<RemoveHomeDn>
RemoveHomeDnRequest(Please see WSDL API:unsp__removeHomeDn
for more details)
RemoveHomeDn
,StartCode=<string>
,EndCode=<string>
<\RemoveHomeDn>
25.2.147 Remove Intercept

<RemoveIntercept>
RemoveInterceptRequest(Please see WSDL
API:unsp__removeIntercept for more details)
RemoveIntercept
,RemoveName=<boolean>
<\RemoveIntercept>
25.2.148 Remove Media Gateway Circuits

<RemoveMediaGatewayCircuits>
RemoveMediaGatewayCircuitsRequest(Please see WSDL
API:unsp__removeMediaGatewayCircuits for more details)
RemoveMediaGatewayCircuits
,TrunkGroupInfo=<enum unsp__TrunkGroupNo>
,StartCircuitId=<string>
,EndCircuitId=<string>
<\RemoveMediaGatewayCircuits>
25.2.149 Remove Media Gateway

<RemoveMediaGateway>
RemoveMediaGatewayRequest(Please see WSDL
API:unsp__removeMediaGateway for more details)
RemoveMediaGateway
<\RemoveMediaGateway>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
25.2.150 Remove Office Code

<RemoveOfficeCode>
RemoveOfficeCodeRequest(Please see WSDL
API:unsp__removeOfficeCode for more details)
RemoveOfficeCode
<\RemoveOfficeCode>
25.2.151 Remove Origin Destination

<RemoveOriginDestination>
API:unsp__removeOriginDestination for more details)
RemoveOriginDestination
,Name=<string>
<\RemoveOriginDestination>
25.2.152 Remove Origin Route

<RemoveOriginRoute>
RemoveOriginRouteRequest(Please see WSDL
API:unsp__removeOriginRoute for more details)
RemoveOriginRoute
<\RemoveOriginRoute>
25.2.153 Remove Period Schedule

<RemovePeriodSchedule>
RemovePeriodScheduleRequest(Please see WSDL
API:unsp__removePeriodSchedule for more details)
RemovePeriodSchedule
,Name=<string>
,StartTime=<string>
<\RemovePeriodSchedule>
25.2.154 Remove Rate Area

<RemoveRateArea>
RemoveRateAreaRequest(Please see WSDL
API:unsp__removeRateArea for more details)
RemoveRateArea
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
,Group=<long>
,Name=<string>
,NpaNxx=<string>
,SlhrName=<string>
,PointCode=<long>
,NodeVariant=<enum unsp__NodeVariant>
,Lata=<string>
<\RemoveRateArea>
25.2.155 Remove Time Destination

<RemoveTimeDestination>
RemoveTimeDestination(Please see WSDL
API:unsp__removeTimeDestination for more details)
RemoveTimeDestination
,Name=<string>
<\RemoveTimeDestination>
25.2.156 Remove Trunk

<RemoveTrunk>
RemoveTrunkRequest(Please see WSDL API:unsp__removeTrunk
for more details)
RemoveTrunk
<\RemoveTrunk>
25.2.157 Remove Trunk Group

<RemoveTrunkGroup>
RemoveTrunkGroupRequest(Please see WSDL
API:unsp__removeTrunkGroup for more details)
RemoveTrunkGroup
<\RemoveTrunkGroup>
25.2.158 Unassign Day Schedule

<UnassignDaySchedule>
UnassignDayScheduleRequest(Please see WSDL
API:unsp__unassignDaySchedule for more details)
UnassignDaySchedule
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
,UnassignSun=<boolean>
,UnassignMon=<boolean>
,UnassignTue=<boolean>
,UnassignWed=<boolean>
,UnassignThu=<boolean>
,UnassignFri=<boolean>
,UnassignSat=<boolean>
<\UnassignDaySchedule>
25.2.159 Unassign Route

<UnassignRoute>
UnassignRouteRequest(Please see WSDL
API:unsp__unassignRoute for more details)
UnassignRoute
,RouteId=<long>
,NumRoutes=<long>
unsp__Attributes>
unsp__Attributes>
unsp__Attributes>
,RouteListId=<long>
<\UnassignRoute>
25.2.160 Unassign Treatment

<UnassignTreatment>
UnassignTreatmentId(Please see WSDL
API:unsp__unassignTreatment for more details)
UnassignTreatment
,Name=<string>
,Order=<enum unsp__TreatmentOrder>
<\UnassignTreatment>
25.2.161 Create Enum Server

<EnumServer>
CreateEnumServerRequest(Please see WSDL
API:unsp__createEnumServer for more details)
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
EnumServer
,EnumServerName=<string>
,PrimaryIpAddress=<string>
,SecondaryIpAddress=<string>
,CacheSize=<short>
<\EnumServer>
25.2.162 Modify Enum Server
<ModifyEnumServer>
ModifyEnumServerRequest(Please see WSDL
API:unsp__modifyEnumServer for more details)
ModifyEnumServer
,PrimaryIpAddress=<string>
,SecondaryIpAddress=<string>
,CacheSize=<short>
<\ModifyEnumServer>
25.2.163 Remove Enum Server
<RemoveEnumServer>
RemoveEnumServerRequest(Please see WSDL
API:unsp__removeEnumServer for more details)
RemoveEnumServer
<\RemoveEnumServer>
25.2.164 Create Operator Enum

<OperatorEnum>
CreateOperatorEnumRequest(Please see WSDL
API:unsp__createOperatorEnum for more details)
OperatorEnum
,OperatorEnumName=<string>
,OperatorEnumTier0ZoneName=<string>
<\OperatorEnum>
25.2.165 Modify Operator Enum
<ModifyOperatorEnum>
ModifyOperatorEnumRequest(Please see WSDL
API:unsp__modifyOperatorEnum for more details)
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
ModifyOperatorEnum
,OperatorEnumTier0ZoneName=<string>
,OperatorEnumUpdateFlags=<int>
<\ModifyOperatorEnum>
25.2.166 Remove Operator Enum
<RemoveOperatorEnum>
RemoveOperatorEnumRequest(Please see WSDL
API:unsp__removeOperatorEnum for more details)
RemoveOperatorEnum
<\RemoveOperatorEnum>
25.2.167 Set RTP Parameters

<RTPSET>
RTPSET - " Set the RTP parameters" (Please see WSDL
API:unsp__SetConfigParmData in Provisioning Doc for
Attribute details)
,RTPNAME=<string>
,RTPVALUE=<string>
</RTPSET>
25.2.168 Create Disconnect DN

This operation is specifically to allow the export of subscribers that
have been previously disconnected so that they can be imported in the
disconnected state into a new switch if necessary.
<CREATE_DISCONNECT_DN>
SERVICEID:
Type:string
Length:(1-15) Default:-
Mandatory:yes
Comment:"The service Id of the subscriber"
INTERCEPTANNOUNCEMENT:
Type:enum
Values:"[None Disconnect NumberChange]" Default:-
Mandatory:yes
Comment:"Default Intercept for the subscriber"
Type:enum
NEWSERVICEID:
Type:string
Length:(1-15) Default:""
Mandatory:no
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
Comment:"Used when a subscriber's ServiceId has changed"

</CREATE_DISCONNECT_DN>
25.2.169 Update Dn Reservation

<BGRESERVATION>
BGRESERVATION - "Get reserved dn's for a bg" (Please see
WSDL API:unsp__UpdateDnReservation in Provisioning Doc for
Attribute details)
,BGNAME=<string>
,BGDNOFFICECODE=<string>
,BGDNSTARTCODE=<string>
,BGDNENDCODE=<string>
</BGRESERVATION>
25.2.170 Create a Parking Lot

<PARKINGLOTCREATE>
PARKINGLOTCREATE - Creates a Parking Lot (Please see WSDL
API: unsp__CreateParkingLotRequest )
, BGNAME,=<string>
, PARKINGLOTNAME=<string>
, RECALLTIMER=<unsigned int>
, PARKINGSTART=<unsigned long int>
, PARKINGEND=<unsigned long int>
</PARKINLOTCREATE>
25.2.171 Update a Parking Lot

<PARKINGLOTUPDATE>
PARKINGLOTUPDATE - Update a Parking Lot (Please see WSDL
API: unsp__UpdateParkingLotRequest )
, BGNAME,=<string>
, NEWPARKINGLOTNAME=<string>
, RECALLTIMER=<unsigned int>
, PARKINGSTART=<unsigned long int>
, PARKINGEND=<unsigned long int>
</PARKINLOTUPDATE>
25.2.172 Delete a Parking Lot

<PARKINGLOTDELETE>
PARKINGLOTDELETE - Delete a Parking Lot (Please see WSDL
API: unsp__DeleteParkingLotRequest )
, BGNAME,=<string>
</PARKINLOTDELETE>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
25.2.173 Add Community Group

<ACG>
ACG - Adds a Community Group" (Please see WSDL
API:unsp__AddCommunityGroup in Provisioning Doc for
Attribute details)
, SUBSCRIBERDN,=<string>
, PERIODICTONE=<string>
</ACG>
25.2.174 Add Community Group Member

<ACGM>
ACGM - Adds a Community Group Member" (Please see WSDL
API:unsp__AddCommunityGroupMember in Provisioning Doc for
Attribute details)
,SUBSCRIBERDN,=<string>
,COMNUMBER=<int>
,DESTNUMBER=<string>
,DESTNAME=<string>
,INCBLOCK=<bool>
</ACGM>
25.2.175 Modify Community Group

<MCG>
MCG - Modifies a Community Group" (Please see WSDL
API:unsp__AddCommunityGroup in Provisioning Doc for
Attribute details)
, SUBSCRIBERDN,=<string>
, PERIODICTONE=<string>
</MCG>
25.2.176 Modify Community Group Member

<MCGM>
MCGM - Updates a Community Group Member" (Please see WSDL
API:unsp__ModifyCommunityGroupMember in Provisioning Doc
for Attribute details)
,COMNUMBER=<int>
,NEWCOMNUMBER=<int>
,DESTNUMBER=<string>
,DESTNAME=<string>
,INCBLOCK=<bool>
</MCGM>
25.2.177 Remove Community Group Member

<RCGM>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
RCGM - "Removes a Community Group Member" (Please see WSDL

API:unsp__RemoveCommunityGroupMember in Provisioning Doc
for Attribute details)
,COMNUMBER=<int>
</RCGM>
25.2.178 Remove Community Group

<RCG>
RCG - "Removes a Community Group" (Please see WSDL
API:unsp__RemoveCommunityGroup in Provisioning Doc for
Attribute details)
</RCG>
25.2.179 Update Subscriber Mobile Info

<UMI>
UMI - Updates Subscriber Mobile Info(Please see WSDL
API:unsp__UpdateMobileInfo
,MOBILEFLAG=<bool>
,MAINDEVICEDN=<string>
,CELLDEVICENR=<string>
,MOBRINGDUR=<int>
,MAINRINGDUR=<int>
,CELLRINGDUR=<int>
</UMI>
25.2.180 Create Traffic Type

<TRAFFICTYPECREATE>
TRAFFICTYPECREATE - Create TrafficType (Please see wsdl API:
unsp__CreateTrafficType)
,TTNAME=<string>
</TRAFFICTYPECREATE>
25.2.181 Modify Traffic Type

<TRAFFICTYPEMODIFY>
TRAFFICTYPEMODIFY - Modify TrafficType (Please see wsdl API:
unsp__ModifyTrafficType
,TTNAME=<string>
,TTNEWNAME=<string>
</TRAFFICTYPEMODIFY>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
25.2.182 Delete Traffic Type

<TRAFFICTYPEDELETE>
TRAFFICTYPEDELETE - Delete TrafficType (Please see wsdl API:
unsp__DeleteTrafficType
,TTNAME=<string>
,TTNEWNAME=<string>
</TRAFFICTYPEDELETE>
25.2.183 Create Class Of Restrictions

<CORCREATE>
CORCREATE - Create Class of restrictions (Please see wsdl
API: unsp__CreateCOR
CORNAME=<string>
TTNAME_0=<string>
TTNAME_1=<string>
TTNAME_2=<string>
TTNAME_3=<string>
TTNAME_4=<string>
TTNAME_5=<string>
TTNAME_6=<string>
TTNAME_7=<string>
TTNAME_8=<string>
TTNAME_9=<string>
TTNAME_10=<string>
TTNAME_11=<string>
TTNAME_12=<string>
TTNAME_13=<string>
TTNAME_14=<string>
TTNAME_15=<string>
TTNAME_16=<string>
TTNAME_17=<string>
TTNAME_18=<string>
TTNAME_19=<string>
TTNAME_20=<string>
TTNAME_21=<string>
TTNAME_22=<string>
TTNAME_23=<string>
TTNAME_24=<string>
TTNAME_25=<string>
TTNAME_26=<string>
TTNAME_27=<string>
TTNAME_28=<string>
TTNAME_29=<string>
TTNAME_30=<string>
TTNAME_31=<string>
TTNAME_32=<string>
TTNAME_33=<string>
TTNAME_34=<string>
TTNAME_35=<string>
TTNAME_36=<string>
TTNAME_37=<string>
TTNAME_38=<string>
TTNAME_39=<string>
TTNAME_40=<string>
TTNAME_41=<string>
TTNAME_42=<string>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
TTNAME_43=<string>
TTNAME_44=<string>
TTNAME_45=<string>
TTNAME_46=<string>
TTNAME_47=<string>
TTNAME_48=<string>
TTNAME_49=<string>
TTNAME_50=<string>
TTNAME_51=<string>
TTNAME_52=<string>
TTNAME_53=<string>
TTNAME_54=<string>
TTNAME_55=<string>
TTNAME_56=<string>
TTNAME_57=<string>
TTNAME_58=<string>
TTNAME_59=<string>
TTNAME_60=<string>
TTNAME_61=<string>
TTNAME_62=<string>
TTNAME_63=<string>
TTNAME_64=<string>
TTNAME_65=<string>
TTNAME_66=<string>
TTNAME_67=<string>
TTNAME_68=<string>
TTNAME_69=<string>
TTNAME_70=<string>
TTNAME_71=<string>
TTNAME_72=<string>
TTNAME_73=<string>
TTNAME_74=<string>
TTNAME_75=<string>
TTNAME_76=<string>
TTNAME_77=<string>
TTNAME_78=<string>
TTNAME_79=<string>
TTNAME_80=<string>
TTNAME_81=<string>
TTNAME_82=<string>
TTNAME_83=<string>
TTNAME_84=<string>
TTNAME_85=<string>
TTNAME_86=<string>
TTNAME_87=<string>
TTNAME_88=<string>
TTNAME_89=<string>
TTNAME_90=<string>
TTNAME_91=<string>
TTNAME_92=<string>
TTNAME_93=<string>
TTNAME_94=<string>
TTNAME_95=<string>
TTNAME_96=<string>
TTNAME_97=<string>
TTNAME_98=<string>
TTNAME_99=<string>
TTNAME_100=<string>
TTNAME_101=<string>
TTNAME_102=<string>
TTNAME_103=<string>
TTNAME_104=<string>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
TTNAME_105=<string>
TTNAME_106=<string>
TTNAME_107=<string>
TTNAME_108=<string>
TTNAME_109=<string>
TTNAME_110=<string>
TTNAME_111=<string>
TTNAME_112=<string>
TTNAME_113=<string>
TTNAME_114=<string>
TTNAME_115=<string>
TTNAME_116=<string>
TTNAME_117=<string>
TTNAME_118=<string>
TTNAME_119=<string>
TTNAME_120=<string>
TTNAME_121=<string>
TTNAME_122=<string>
TTNAME_123=<string>
TTNAME_124=<string>
TTNAME_125=<string>
TTNAME_126=<string>
</CORCREATE>
25.2.184 Modify Class Of Restrictions

<<CORMODIFY>
CORMODIFY - Modify Class of restrictions (Please see wsdl
API: unsp__ModifyCOR
CORNAME=<string>
TTNAME_0=<string>
TTNAME_1=<string>
TTNAME_2=<string>
TTNAME_3=<string>
TTNAME_4=<string>
TTNAME_5=<string>
TTNAME_6=<string>
TTNAME_7=<string>
TTNAME_8=<string>
TTNAME_9=<string>
TTNAME_10=<string>
TTNAME_11=<string>
TTNAME_12=<string>
TTNAME_13=<string>
TTNAME_14=<string>
TTNAME_15=<string>
TTNAME_16=<string>
TTNAME_17=<string>
TTNAME_18=<string>
TTNAME_19=<string>
TTNAME_20=<string>
TTNAME_21=<string>
TTNAME_22=<string>
TTNAME_23=<string>
TTNAME_24=<string>
TTNAME_25=<string>
TTNAME_26=<string>
TTNAME_27=<string>
TTNAME_28=<string>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
TTNAME_29=<string>
TTNAME_30=<string>
TTNAME_31=<string>
TTNAME_32=<string>
TTNAME_33=<string>
TTNAME_34=<string>
TTNAME_35=<string>
TTNAME_36=<string>
TTNAME_37=<string>
TTNAME_38=<string>
TTNAME_39=<string>
TTNAME_40=<string>
TTNAME_41=<string>
TTNAME_42=<string>
TTNAME_43=<string>
TTNAME_44=<string>
TTNAME_45=<string>
TTNAME_46=<string>
TTNAME_47=<string>
TTNAME_48=<string>
TTNAME_49=<string>
TTNAME_50=<string>
TTNAME_51=<string>
TTNAME_52=<string>
TTNAME_53=<string>
TTNAME_54=<string>
TTNAME_55=<string>
TTNAME_56=<string>
TTNAME_57=<string>
TTNAME_58=<string>
TTNAME_59=<string>
TTNAME_60=<string>
TTNAME_61=<string>
TTNAME_62=<string>
TTNAME_63=<string>
TTNAME_64=<string>
TTNAME_65=<string>
TTNAME_66=<string>
TTNAME_67=<string>
TTNAME_68=<string>
TTNAME_69=<string>
TTNAME_70=<string>
TTNAME_71=<string>
TTNAME_72=<string>
TTNAME_73=<string>
TTNAME_74=<string>
TTNAME_75=<string>
TTNAME_76=<string>
TTNAME_77=<string>
TTNAME_78=<string>
TTNAME_79=<string>
TTNAME_80=<string>
TTNAME_81=<string>
TTNAME_82=<string>
TTNAME_83=<string>
TTNAME_84=<string>
TTNAME_85=<string>
TTNAME_86=<string>
TTNAME_87=<string>
TTNAME_88=<string>
TTNAME_89=<string>
TTNAME_90=<string>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
TTNAME_91=<string>
TTNAME_92=<string>
TTNAME_93=<string>
TTNAME_94=<string>
TTNAME_95=<string>
TTNAME_96=<string>
TTNAME_97=<string>
TTNAME_98=<string>
TTNAME_99=<string>
TTNAME_100=<string>
TTNAME_101=<string>
TTNAME_102=<string>
TTNAME_103=<string>
TTNAME_104=<string>
TTNAME_105=<string>
TTNAME_106=<string>
TTNAME_107=<string>
TTNAME_108=<string>
TTNAME_109=<string>
TTNAME_110=<string>
TTNAME_111=<string>
TTNAME_112=<string>
TTNAME_113=<string>
TTNAME_114=<string>
TTNAME_115=<string>
TTNAME_116=<string>
TTNAME_117=<string>
TTNAME_118=<string>
TTNAME_119=<string>
TTNAME_120=<string>
TTNAME_121=<string>
TTNAME_122=<string>
TTNAME_123=<string>
TTNAME_124=<string>
TTNAME_125=<string>
TTNAME_126=<string>
</CORMODIFY>
25.2.185 Create Call Pickup Group

<ACPU>
ACPU - "Adds Call Pickup Group" (Please see WSDL
API:unsp__AddCpuGroup in Provisioning Doc for Attribute
details)
,BGNAME=<string>
,CPUID=<int>
,CPUNAME=<wstring>
,NOTIFICATIONDELAYTIMER=<int>
,CIDPRESENTATION=<enum>
</ACPU>
25.2.186 Modify Call Pickup Group

<MCPU>
MCPU - "Modifies a Call Pickup Group" (Please see WSDL
API:unsp__ModifyCpuGroup in Provisioning Doc for Attribute
details)
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
,BGNAME=<string>
,CPUID=<int>
,CPUNAME=<wstring>
,NOTIFICATIONDELAYTIMER=<int>
,CIDPRESENTATION=<enum>
</MCPU>
25.2.187 Delete Call Pickup Group

<RCPU>
RCPU - "Deletes a Call Pickup Group" (Please see WSDL
API:unsp__DeleteBGCpu2 in Provisioning Doc for Attribute
details)
,BGNAME=<string>
,CPUID=<int>
</RCPU>
25.2.188 Add Local Call Pickup Group

member
<ALOCALCPU>
ALOCALCPU - "Adds Member to a Call Pickup Group" (Please see
WSDL API:unsp__AddLocalCpuMembers in Provisioning Doc for
Attribute details)
,BGNAME=<string>
,CPUID=<int>
,LOCALCPU_SERVICEID=<string>
,LOCALCPU_CIDCALLSTOMEMBER=<enum>
,LOCALCPU_CIDNOTIFICATIONTOMEMBER=<enum>
</ALOCALCPU>
25.2.189 Modify Local Call Pickup Group

member
<MLOCALCPU>
MLOCALCPU - "Modifies a Member of a Call Pickup Group"
(Please see WSDL API:unsp__ModifyLocalCpuMembers in
Provisioning Doc for Attribute details)
,BGNAME=<string>
,CPUID=<int>
,LOCALCPU_CIDCALLSTOMEMBER=<enum>
,LOCALCPU_CIDNOTIFICATIONTOMEMBER=<enum>
</MLOCALCPU>
25.2.190 Remove local Call Pickup Group

member
<RLOCALCPU>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
RLOCALCPU - "Removes a Member of a Call Pickup Group"

(Please see WSDL API:unsp__RemoveLocalCpuMembers in
,BGNAME=<string>
,CPUID=<int>
</RLOCALCPU>
25.2.191 Add Remote Call Pickup Group

<AREMOTECPU>
AREMOTECPU - "Adds a remote member Member to a Call Pickup
Group" (Please see WSDL API:unsp__AddRemoteCpuGroups in
,BGNAME=<string>
,CPUID=<int>
,REMOTECPUGROUPNUMBER=<int>
,REMOTECPUGROUPACCESSCODE=<string>
,REMOTECPUGROUPDESCRIPTOR=<string>
,REMOTECPUGROUPHIPATHDX=<bool>
</AREMOTECPU>
25.2.192 Modify Remote Call Pickup Group

<MREMOTECPU>
MREMOTECPU - "Modify a remote member Member of a Call Pickup
Group" (Please see WSDL API:unsp__ModifyRemoteCpuGroups in
,BGNAME=<string>
,CPUID=<int>
,REMOTECPUGROUPDESCRIPTOR=<string>
,REMOTECPUGROUPHIPATHDX=<bool>
</MREMOTECPU>
25.2.193 Remove Remote Call Pickup Group

<RREMOTECPU>
RREMOTECPU - "Remove a remote member Member of a Call Pickup
Group" (Please see WSDL API:unsp__RemoveRemoteCpuGroups in
,BGNAME=<string>
,CPUID=<int>
</RREMOTECPU>
25.2.194 Create Domain Code

<CDomainCode>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
CDomainCode - "Creates a Domain Code" (Please see WSDL

API:unsp__CreateDomainCode in Provisioning Doc for
Attribute details)
,DOMAINCODE=<string>
,ROUTINGAREA=<string>
,PREFIXTYPE=<enum>,
,REDIRECTTO=<enum>,
,RETRANSLATE=<bool>,
,NUMBER=<string>
,TRAFFICTYPESELECTION=<enum>
</CDomainCode>
25.2.195 Modify Domain Code

<MDomainCode>
MDomainCode - "Modifies a Domain Code" (Please see WSDL
API:unsp__ModifyDomainCode in Provisioning Doc for
Attribute details)
,PREFIXTYPE=<enum>,
,REDIRECTTO=<enum>,
,RETRANSLATE=<bool>,
,NUMBER=<string>
,TRAFFICTYPESELECTION=<enum>
</MDomainCode>
25.2.196 Delete Domain Code

<DDomainCode>
DDomainCode - "Deletes a Domain Code" (Please see WSDL
API:unsp__DeleteDomainCode in Provisioning Doc for
Attribute details)
</DDomainCode>
25.2.197 Create CSTA Application

<CCSTAAPP>
,APPIP=<string>
,APPNAME=<string>
,APPTYPE=<enum>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
,APPID=<string>
,PASSCODE=<string>
,OUTSIDEACCESS=<string>
,BGNAME=<string>
,NPNAME=<string>
,ENABLESIPURI=<bool>
</CCSTAAPP>
25.2.198 Modify CSTA Application

<MCSTAAPP>
,APPIP=<string>
,APPNEWIP=<string>
,APPNAME=<string>
,APPTYPE=<enum>
,APPID=<string>
,PASSCODE=<string>
,OUTSIDEACCESS=<string>
,BGNAME=<string>
,NPNAME=<string>
,ENABLESIPURI=<bool>
</MCSTAAPP>
25.2.199 Create Branch Office

<CBO>
CBO - "Creates a Branch Office" (Please
see WSDL API:unsp__createBranchOffice in
,BGNAME=<string>
,REPRESENTATIVEENDPOINTNAME=<string>
,DIDPOOLUPDATE=<enum>
,BOOFFICECODE=<string>
,RATEAREA=<string>
,BOATTRIBUTES=<bool>
,USERNAME=<string>
,PASSWORD=<string>
,NUMDIDDNCODES=<int>
,DIDDNCODE0=<string>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
</CBO>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
25.2.200 Modify Branch Office

<MBO>
MBO - "Modifies a Branch Office" (Please see WSDL
API:unsp__modifyBranchOffice in Provisioning Doc for
Attribute details)
,NEWBRANCHOFFICENAME=<string>
,BGNAME=<string>
,REPRESENTATIVEENDPOINTNAME=<string>
,DIDPOOLUPDATE=<enum>
,BOOFFICECODE=<string>
,RATEAREA=<string>
,BOATTRIBUTES=<bool>
,USERNAME=<string>
,PASSWORD=<string>
,NUMDIDDNCODES=<int>
A31003-H80A0-T101-1-7618, 11/2021
Supported Commands
</MBO
25.2.201 Remove Branch Office
<RBO>
RBO - "Removes a Branch Office" (Please
see WSDL API:unsp__removeBranchOffice in
,BGNAME=<string>
</RBO>
A31003-H80A0-T101-1-7618, 11/2021
soap_results.fm
Subscriber Provisioning Result Information
Result Code Information
26 Subscriber Provisioning Result Information

This section describes the information that is returned as a result of an
operation being performed.
26.1 Result Code Information

All error codes are eight digits long. The error codes will have the
following format:
subRC_<category>_<object>_<attribute>_<error>.
The most significant digit (the first digit) is the category. The next two
digits identify the object. The fourth and fifth digits are the sub-object.
Digits six to eight represent the specific error. Sub-objects are defined
only for objects EP, BG, and FEAT. With this numbering scheme, we
support 10 categories, 99 objects, 99 sub-objects for each object, and
999 unique return codes for each object/subobject.
The category is at a higher level and can be one of those given in Table
986.
Code Name Description

1 DB Database errors (get, insert, delete). In some cases, the
request may be successful if retried after 30 seconds.
2 SYS System errors (memory errors, file access)
3 APP An error detected in the client request or the request is
invalid for the current state of the system objects.
4 WAR Warnings indicating the operation may be completed with errors
9 INT Internal errors. In some cases, the objects being accessed may have
been left in a corrupted state.
Table 986 Error Code Categories
Note that for errors in category 1 (DB) or 9 (INT), the SOAP Server
process may restart in an attempt to clear up any potential data
corruption. In this case, the SOAP Server will not be available to handle
new requests for approximately three seconds following the error.
The object represents the resource being manipulated. Can be one of

those given in Table 987.

1 SUB Subscriber errors
2 EP Endpoint errors
Table 987 Error Code Objects (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
soap_results.fm
Result Code Information

3 BG Business group
4 PNP Private Number Plan
5 FP Feature Profile
6 MLHG Hunt Group
7 QOS Quality of Service
9 JOB Job errors
10 UTIL Utilities (language, PIC, …)
11 FEAT Feature
12 COMM Error in common objects
Table 987 Error Code Objects (Seite 2 von 2)
The subobjects within a Business Group can those given in Table 988.

1 Common BG errors
2 AUTH Authorization code errors
3 DEPT Department errors
4 DP Dialing Plan errors
5 FEAT Feature errors
6 MAIN_NUM Main Number errors
7 NUMBER_PLAN Number Plan errors
8 SUBNET Subnet errors
Table 988 Error Code Sub-objects Within a Business Group
The subobjects related to an EP (endpoint) can be those given in Table

989.

0 Common EP errors
3 SIP Dialing Plan errors
Table 989 Error Code Sub-objects Related to an EP
For Feature object, one sub-object is defined for each feature. Not all
the sub-objects are defined now; more sub-objects will be defined as
they are required.
Examples:
31111004 = subRC_APP_FEAT_ECF_START_TIME_INVALIDCategory: 3 = Application

Object: 11 = Feature
Sub-object: ECF
Attribute: Start time
Error: Invalid (last 3 digits can be anything)
A31003-H80A0-T101-1-7618, 11/2021
soap_results.fm
ResultMsgNumber
30303009 = subRC_APP_BG_DEPT_BG_NAME_MISSING
Category: 3 = Application
Object: 05 = Business Group
Sub-object: 03 = Department
Attribute: BG name
Error: missing (last 3 digits can be anything)
10100001 = subRC_DB_SUB_DN_LOOKUP_FAILED
Category: 1 = Database
Object: 01 = Subscriber
Sub-object: N/A
Attribute: DN
Error: lookup failed (last 3 digits can be anything)
00000000 = SUCCESS
The old errors subRC_INTERNAL_ERROR and

subRC_INTERNAL_RECOVERY_ERROR are now replaced by specific
errors. The subRC_INTERNAL_RECOVERY_ERROR is replaced by
subRC_DB_COMM_INTERNAL_RECOVERY_ERROR. All other errors
beginning with 1 (database error), 2 (system error), and 9 (internal
error) replace the old error subRC_INTERNAL_ERROR.
26.2 ResultMsgNumber
This field is not used.
26.3 Result Text Strings.

The Result Text fields contain additional error information. It is always
returned.
ResultText2 through ResultText5 are defined in the table with the

return codes. Only the fields applicable are returned.
ResultText1 contains the specific error. If no error (ReturnCode=0),
then “Success” is returned.
ResultText2 contains the label of the field that was in error.
ResultText3 contains the value that was in error or the label of the
field that was in conflict.
ResultText4 contains additional label that may be in error.
ResultText5 contains any internal error information
A31003-H80A0-T101-1-7618, 11/2021
soap_results.fm
ResultTOY
26.4 ResultTOY
The date and time that the functions are processed in the following
format:
CYY-MM-DDThh: mm:ss
Example: 2002-09-12T12:35:30.
26.5 Result Codes/Result Text Settings

The list of possible return codes along with text describing the meaning
of each code is provided in a deliverable file: /unisphere/srx3000/
UNSPsubp/ReturnCodes.txt.
Note that an HTTP or SOAP error code will be issued if the XML request
is syntactically invalid.
A31003-H80A0-T101-1-7618, 11/2021
soap_assistant_provision.fm
Using SOAP to Provision the OpenScape Voice Assistant
RTP Configuration Management
27 Using SOAP to Provision the OpenScape Voice

Assistant
The following section outlines SOAP capabilities and functions that
support the requirements of the OpenScape Voice Assistant V5
interface.
• Controlled Access to RTP Configuration Parameters
• Access to Call Statistics
• Backup and Restore via SOAP
• Provisioning of Time Destination Tables
• Provisioning of SIP Signaling Manager
• Provisioning of Billing (CDR)
• Tones and Announcements Management
For more information on the OpenScape Voice Assistant, refer to the

OpenScape Voice Assistant, Framework, Service Documentation;
OpenScape Voice Assistant V2.0 Administrator Documentation;
OpenScape Voice Assistant Feature Configuration Administration
Guide; and, the OpenScape Voice Assistant API Description.
27.1 RTP Configuration Management

The SOAP server is enhanced to have read/write access only to
customer specific RTP parameters defined in the system. The RTP
parameters that will be accessible by SOAP clients (access control list)
are easy to configure and maintain. Soap Server’s Configuration file
(RtpParameters.conf) will assure that only particular RTP parameters
are exported to the SOAP clients. If an RTP parameter is not included
in this list then access is denied, even if this RTP defined as ‘customer
type’ and is accessible via CLI or SNMP. This approach allows different
configuration files to be provided for different solutions, i.e.,
OpenScape Voice. For a list of variables accessible via SOAP, refer to
Table 991.
The structure of RtpParameters.conf file has been redefined in xml

format, making parsing by Soap Server much more easier and
efficient.
<RtpParameterList>
A31003-H80A0-T101-1-7618, 11/2021
<RtpParameter>
<Name>Srx/Service/CCS/CcsRecallTimerT4</Name>
<Type>integer</Type>
<Description>Timer T4 (Recall Supervision originating timer)
is started on sending a CCS recall indication to the CCBS/CCNR
subscriber and is stopped on receipt of an answer to this indication.
Running on the Originating side.</Description>
<Default>30</Default>
<Range>[15-60]</Range>
<Length></Length>
<Unit>seconds</Unit>
<Restart>no</Restart>
<Access>read/write</Access>
<CustomGUI></CustomGUI>
</RtpParameter>
<RtpParameter>
<Name>Srx/Sip/InternationalReroutingPAC</Name>
<Type>string</Type>
<Description>Number combination used for rerouting an
international call</Description>
<Default>""</Default>
<Range>[0-9],('',*,#)</Range>
<Length>0-30</Length>
<Unit>String</Unit>
</RtpParameter>
<RtpParameter>
<Name>Srx/Sip/AuthEnabled</Name>
<Type>boolean</Type>
<Description>Flag to enable or disable Digest Authentication
</Description>
<Default>RtpFalse</Default>
<Range>(true,false)</Range>
<Length></Length>
<Unit>N/A</Unit>
</RtpParameter>
…
</RtpParameterList>
A31003-H80A0-T101-1-7618, 11/2021
The XML formatted RTP Parameters shall have to follow certain

guidelines with regards to their syntax in order for SOAP Server to
parse and validate key element tags.
For integer parameters:
• If it is a range of values it should be included in brackets [ ] e.g.

[ 0-180 ]
• If it accepts specific values then those should be defined in

parenthesis () separated by commas e.g. ( 1,2,3,6 )
For string parameters:
• If it accepts a range of integer values it should be included in

brackets [ ] e.g. [ 0-9 ]
• If it accepts a range of string values it should be included in curly

brackets {} e.g. { A-E }
• If it accepts specific values then those should be defined in

parenthesis () separated by commas e.g ( *,# )
• Ranges and specific values can be combined, e.g. [0-9],(*,#)

defines a field that accepts the numbers from 0 to 9 and the
characters * and #.
For boolean parameters:
• The only expected value is ( true,false ).
It is imperative to note that if the syntax for the ValidRange and Length
fields do not comply with the above rules, then the corresponding RTP
Parameters shall not be subject to any validations.
With the new format in place, Soap Server Development are not
responsible for the maintenance of the file, since the whole process has
been automated. Production has delivered a script that parses the
.parm files and generate the xml formatted RtpParameters.conf file. It
is now the responsibility of the parm file owners to have an accurate
and well defined description and header information.
Both of the GET and SET functions take a list of RTP parameters, which
can be retrieved or assigned, and flags an error when the value to be
"set" is outside the range of valid values.
SOAP Export supports the exporting command for the RTP parameters
that are accessible via SOAP. The executable is invoked from within the
RTP CLI (startCli) expert mode by using the command soapExport,
followed by a string of parameters enclosed within double quotes. The
syntax to perform this should be as follows:
A31003-H80A0-T101-1-7618, 11/2021
CLI>soapExport "-f=outputfilename -RTP"

It is also possible to execute soapExport from the command line, as
above. The command line syntax should be as follows:
./soapExport -o=Operator -pass=Password -f=outputfilename

-RTP
where outputfilename is the location to which the exported RTP
parameters is to be written.
The new massprov commands are designed to work in "MP2" mode and
it should be identified by prefixing a ":MP2" at the end of the "FILE
VERSION command" in the beginning of the command file. For
example:
FILE VERSION:11.00.01:MP2
27.1.1 Set an RTP Parameter

SOAP Mass Provisioning is impacted to support the RTPSet command
for the RTP parameters that are accessible via SOAP. To Set/Update an
RTP parameter on the system, use the #RTPSET command to retreive
a list of the RTP parameters that are available via SOAP. Next, the input
must contain the name of the RTP parameter (e.g. hiQ/CSTA/
ListenerPortNumber) and the value. For example:
RTPSET
• ,RTPNAME="Name of the RTP parameter"
• ,RTPVALUE="Value of the RTP parameter"
SoapServer will not be responsible for the validation of the passed

parameter values. The only validation that is done is whether the RTP
Parameter name that has been passed in the request exists in the
configuration file.
27.1.2 Display the List of Accessible RTP

Parameters
To retrieve an existing RTP parameter on the system, a list of
parameters must be input containing the name of the RTP parameter
(e.g. hiQ/CSTA/ListenerPortNumber).
A31003-H80A0-T101-1-7618, 11/2021
SoapServer will validate that the requested parameter exists in the

configuration file and will return to the user the parameter name and
the value currently assigned to this parameter.
The existing subGetRtpParm common function will be used in order to

obtain a coPaging, Sorting (Sorting Direction: Ascending, Descending)
and Filtering based on RTP Parameter Name with/without wildcard
support shall also be supported. It is important to note that the only
wildcard character to be supported is "*", and it should only be at the
end of RTP Parameter Name to be retrieved. For example: If the
administrator wishes to retrieve all the SIP RTP Parameters, the filter
on the Assistant screen could be something like: Srx/Sip/*
With regards to RTP Parameters having dedicated GUI, the

GetConfigParmDataResult interface shall only return those, only if the
Name field on the GetConfigParmDataRequest includes the full name of
the Parameter. The latter implies that the administrator is aware of the
specific RTP parameter he/she wants to retrieve.
Configuration parameter from the RTP configuration table.
Table 990 outlines the available interfaces to support accessing the RTP
database.
Field Name Required Description Type Max Length Default Value

(Range)
ConfigDataName No I/F Parameter Name Char array N/A N/A
List
GetDedicated No Flag indicating whether Boolean True/False False
GUIParameters Dedicated GUI Parameters
should be returned
ParmMismatchFil No Option for retrieving Enumerator Range of Values: FetchAll
ter Parameters whose value is Fetchall,
the same or different from Fetchmismatche
the default/suggested one d
FetchNonMismat
ched
Sorting No The sort order of the Enumerator Ascending Ascending
retrieved result set Descending
Page Number No number of the retrieved Integer - -
result set
result set
Table 990 "GetConfigParmDataRequest Input Field definitions
A31003-H80A0-T101-1-7618, 11/2021
Table 991 lists the variables accessible via SOAP.
hiQ/CSTA/CSTAManger1VirtualIp Srx/Service/IN/MaxSerialTriggerCount
hiQ/CSTA/CSTAManger2VirtualIp Srx/Service/IN/N11TriggerOfficeOption
hiQ/CSTA/IntervalTimeForReplication Srx/Service/IN/ONoAnswerTimer
hiQ/CSTA/ListenerPortNumber Srx/Service/IN/SDSTriggerOfficeOption
hiQ/CSTA/MaxCSTAConnections Srx/Service/IN/SendToResourceTimer
hiQ/CSTA/MaxMonitoredEndpoints Srx/Service/IN/T1Timer
hiQ/TraffMeas/Settings15MinRetPeriod Srx/Service/IN/T1Timer
hiQ/TraffMeas/Settings30MinRetPeriod Srx/Service/IN/TNoAnswerTimer
hiQ/TraffMeas/Settings5MinRetPeriod Srx/Service/INAP/DP4CauseValues
hiQ/TraffMeas/SettingsDailyRetPeriod Srx/Service/INAP/DP5CauseValues
hiQ/TraffMeas/SettingsHourlyRetPeriod Srx/Service/INAP/ObjectIdentfierSCFSSF
Srs/Auth/AuthenticationStrategy Srx/Service/INAP/ObjectIdentfierSSFSCF
Srs/Auth/DatabaseProcess Srx/Service/INAP/
SII2AllowCdlNNoPresentationIndicator
Srx/IpPacketPriority/DSCPTOS/SIP/Type Srx/Service/INAP/
SII2BothwayThroughConnectionIndicator
Srx/IpPacketPriority/DSCPTOS/SIP/Value Srx/Service/INAP/
SII2BwdCallCompletionTreatmentIndicator
Srx/Main/ACMChargeIndication Srx/Service/INAP/
SII2BwdConferenceTreatmentIndicator
Srx/Main/ACRCfmTreat Srx/Service/INAP/
SII2ConnectedNumberTreatmentIndicator
Srx/Main/ApplicationType Srx/Service/INAP/
SII2FwdCallDiversionTreatmentIndicator
Srx/Main/BillingMethod Srx/Service/INAP/
SII2FwdCallingPartyRestrictionIndicator
Srx/Main/CallingPartyDisplayPrependPrefix Srx/Service/INAP/
SII2FwdCallOfferingTreatmentIndicator
Srx/Main/CallingPartyPrefixDigitString Srx/Service/INAP/
SII2FwdConferenceTreatmentIndicator
Srx/Main/CCCDF/IpAddress Srx/Service/INAP/
SII2SupressCallDiversionNotification
Srx/Main/CCCDF/PortNumber Srx/Service/INAP/SII2SupressCallTransferNotification
Srx/Main/CFMaxDiversions Srx/Service/INAP/SII2SuspendTimer
Srx/Main/ClgPtyDisplayPrependPNAC Srx/Service/INAP/SII2UserDialogueDurationIndicator
Srx/Main/CorrelationInfoUsage Srx/Service/INAP/T_Long
Srx/Main/Country Srx/Service/INAP/T_Medium
Srx/Main/CpuRingListMaxEntries Srx/Service/INAP/T_Short
Srx/Main/CustomerType Srx/Service/INAP/T_SrfTimeout
Table 991 RTP Parameter Path / Name (Seite 1 von 4)
A31003-H80A0-T101-1-7618, 11/2021
Srx/Main/cwtOperMethod Srx/Service/INAP/T_SsfErr
Srx/Main/hiQVariant Srx/Service/INAP/T_SsfOpSeq
Srx/Main/OutGoingCallingPartyNumberType Srx/Service/INAP/T_SsfWfInstructions
Srx/Main/OwnCountryCode Srx/Service/INAP/T_SsfWfUserInteraction
Srx/Main/PrefixDigitStringToCallingParty Srx/Service/INAP/TCAPManagerName
Srx/Main/RACFCfmTreat Srx/Service/INAP/TDP3TriggerOfficeOption
Srx/Main/SrxCallingNameDeliveryMethod Srx/Service/INAP/TDP4TriggerOfficeOption
Srx/Main/SrxCallWaitingTimer Srx/Sip/AlertTimer
Srx/Main/SrxDefaultLang Srx/Sip/AuthClientQopPreference
Srx/Main/SrxLocalCallingNameDelivery Srx/Sip/AuthEnabled
Srx/Main/SrxSupportedLangList Srx/Sip/AuthGenerateNextNonce
Srx/Main/SrxSwitchLangMode Srx/Sip/AuthMaxAttempts
Srx/Main/SS7Variant Srx/Sip/AuthNonceLifetime
Srx/Main/SvcAssignedPerOfficeACR Srx/Sip/default_number_of_sessions
Srx/Main/SvcAssignedPerOfficeCCW Srx/Sip/HungupTimer
Srx/Main/SvcAssignedPerOfficeCIDS Srx/Sip/InternationalReroutingPAC
Srx/Main/SvcAssignedPerOfficeCNAB Srx/Sip/IntlE164Numbers
Srx/Main/SvcAssignedPerOfficeCNDB Srx/Sip/IpPort
Srx/Main/SvcAssignedPerOfficeLINR Srx/Sip/IpPortTLS
Srx/Main/SvcAssignedPerOfficeLONR Srx/Sip/LocalReroutingPAC
Srx/Main/SvcAssignedPerOfficeMCT Srx/Sip/LongCall_disconnect_enabled
Srx/Main/SvcAssignedPerOfficeUSCOLR Srx/Sip/LongCallTimer
Srx/Main/SvcAssignedPerOfficeUSTWC Srx/Sip/max_number_of_sessions
Srx/Main/SvcInternationalPrefix Srx/Sip/Min_Expires_Dialog
Srx/Main/SvcNationalPrefix Srx/Sip/Min_Expires_Keyset
Srx/Main/twcOperMethod Srx/Sip/Min_Expires_Presence
Srx/Service/ACAR/ACFeatureAssignedPerOffice Srx/Sip/Min_Expires_Publish
Srx/Service/ACAR/ Srx/Sip/Min_Expires_Toggle
AnnouncementResponseTimeoutCounter
Srx/Service/ACAR/AnnouncementResponseTimer Srx/Sip/Min_Session_Timer_Value
Srx/Service/ACAR/AnnouncementResponseTimer Srx/Sip/NationalReroutingPAC
Srx/Service/ACAR/ARActivationProcedure Srx/Sip/ReleaseAckTimer
Srx/Service/ACAR/ARActivationProcedure Srx/Sip/ReroutingEndpointEnabled
Srx/Service/ACAR/ARFeatureAssignedPerOffice Srx/Sip/ReroutingSubscriberEnabled
Srx/Service/ACAR/ARFeatureAssignedPerOffice Srx/Sip/ReroutingTimerInvite
Srx/Service/ACAR/ Srx/Sip/ReroutingTimerTrying
DenyARActivationsToAnonymousDN
Srx/Service/ACAR/DenyARtoNonUniqueDN Srx/Sip/SDPProtocol
A31003-H80A0-T101-1-7618, 11/2021
Srx/Service/ACAR/DNVoiceBackOption Srx/Sip/Session_Timer
Srx/Service/ACAR/InitialQueryResponseTimer Srx/Sip/SipUpdateSupported
Srx/Service/ACAR/ Srx/Sip/Timer_T1
InterBusyIdleQueryDurationTimer
Srx/Service/ACAR/InvalidDialedDigitCounter Srx/Sip/Timer_T2
Srx/Service/ACAR/ Srx/Sip/Timer_T4
MaxNum6SecondSpecialRingingCycles
Srx/Service/ACAR/ Srx/Sip/UceGenericTimer
MaxNumConcurrentACActivationsAllowedPerCustom
er
Srx/Service/ACAR/ Srx/Sip/UdpPort
MaxNumConcurrentARActivationsAllowedPerCustom
er
Srx/Service/ACAR/ Srx/Sip/VMServerIPAddress
MaxNumQueueEntriesAllowedPerCalledParty
Srx/Service/ACAR/ Srx/Sip/VMSubscriptionTime
MaxNumUnansweredSpecialRingingApplications
Srx/Service/ACAR/MonitoringTimer Srx/Subp/Address
Srx/Service/ACAR/ Srx/Subp/Address
OriginatingOverallMonitoringTimer
Srx/Service/ACAR/OriginatingScanRateTimer Srx/Subp/ClearErrorDays
Srx/Service/ACAR/OutstandingNotificationTimer Srx/Subp/ClearJobDays
Srx/Service/ACAR/PeriodicScanRate Srx/Subp/DebugGsoap
Srx/Service/ACAR/PerSPCSBlkARMsgWICNInfo Srx/Subp/JobCheckSleep
Srx/Service/ACAR/ Srx/Subp/JobClearTime
RequestTerminatingScanningAllowed
Srx/Service/ACAR/ResumeScanningThresholdTimer Srx/Subp/JobLoopSleepTime
Srx/Service/ACAR/ResumeScanningTimer Srx/Subp/NumberOfInstances
Srx/Service/ACAR/SubsequentQueryResponseTimer Srx/Subp/NumberOfInstances
Srx/Service/ACAR/ Srx/Subp/NumObjectsToPauseAfter
TerminatingScanningMonitoringTimer
Srx/Service/CCS/CCBSFeatureAssignedPerOffice Srx/Subp/OverLoadCheckPeriod
Srx/Service/CCS/CcbsRequestOperationT2 Srx/Subp/OverLoadLevel1Sleep
Srx/Service/CCS/CcbsScanRateT10 Srx/Subp/OverLoadLevel2Sleep
Srx/Service/CCS/CcbsServiceDurationT3 Srx/Subp/OverLoadLevel3Sleep
Srx/Service/CCS/CcbsServiceSupervisionT7 Srx/Subp/Port
Srx/Service/CCS/CCNRFeatureAssignedPerOffice Srx/Subp/Port
Srx/Service/CCS/CcnrRequestOperationT2 Srx/Subp/Priority
Srx/Service/CCS/CcnrScanRateT10 Srx/Subp/SubSchedPriority
Srx/Service/CCS/CcnrServiceDurationT3 Srx/Subp/TombstoneKeepRecordsInterval
Srx/Service/CCS/CcnrServiceSupervisionT7 Srx/Usc/AutoDelete
A31003-H80A0-T101-1-7618, 11/2021
Srx/Service/CCS/CcsIdleGuardT8 Srx/Usc/EncryptedBackupPassword
Srx/Service/CCS/CcsIdleGuardT8 Srx/Usc/EncryptedPassword
Srx/Service/CCS/CcsRecallT9 Srx/Usc/FtpPort
Srx/Service/CCS/CcsRecallTimerT4 Srx/Usc/Host
Srx/Service/CCS/ Srx/Usc/HostBackup
MaxNumInCCBSActivationsAllowedPerCustomer
Srx/Service/CCS/ Srx/Usc/Method
MaxNumInCCNRActivationsAllowedPerCustomer
Srx/Service/CCS/ Srx/Usc/Password
MaxNumOutCCBSActivationsAllowedPerCustomer
Srx/Service/CCS/ Srx/Usc/PasswordBackup
MaxNumOutCCNRActivationsAllowedPerCustomer
Srx/Service/CCS/RetentionTimer Srx/Usc/Refresh
Srx/Service/CFBlockingActive Srx/Usc/Rename_Extension
Srx/Service/CFBlockingCodes Srx/Usc/Retention_Period
Srx/Service/IN/FinalTreatmentName Srx/Usc/Second_Storage
Srx/Service/IN/FinalTreatmentName Srx/Usc/User
Srx/Service/IN/FinalTreatmentType Srx/Usc/UserBackup
Srx/Service/IN/FinalTreatmentType Srx/Main/node1CIPLogical
Srx/Service/IN/INServiceSSN Srx/Main/node2CIP0
Srx/Main/ClusterName Srx/Main/node2CIP1
Srx/Main/node1Name Srx/Main/node2Logical
Srx/Main/node1PhyIpAddr Srx/Main/node1CIPNetmask
Srx/Main/node2Name Srx/Main/node1CIPNetwork
Srx/Main/ClusterType Srx/Main/node2CIPNetwork
Srx/Main/node1CIP0 Srx/Main/CIPGateway
Srx/Main/node1CIP1 Srx/Main/ciControlTos
Srx/Main/CIPBroadcast Srx/Lic/DynamicWarningThres
Srx/Main/CIP2Gateway Srx/Irm/AudioPacketInterval_AAC_LC
Srx/Main/ciDataTos Srx/Irm/AudioPacketInterval_G7221_24
Srx/Main/UseCTSecurityInterceptDest Srx/Irm/AudioPacketInterval_G7221_32
Srx/Irm/AudioBitRate_AAC_LC Srx/Irm/AudioPacketInterval_G7221_48
Srx/Irm/AudioBitRate_G7221_24
A31003-H80A0-T101-1-7618, 11/2021
Call Statistics
27.2 Call Statistics

This interface allows a SOAP client to have read-only access to all
statistics counters defined in the RTP database.
Attention: The interface is generic; new statistics counters that will be

introduced in the future will not have further SOAP impacts.
To attain access to the call statistics counters in the RTP database, the
user provides:
• GetCounterInfo: enter the name of the counter
• GetCounterList: This function returns an array, containing all

counter names from the database, and facilitates paging through
the result set by SOAP clients that display the data graphically to
the user. Therefore the following parameters are also included:
• Page Size
• Page Number
The response includes the following data, for use by the SOAP client in
paging:
• Number of rows in the result set (total number of Endpoint entries)
• Number of pages in the result set (total number of pages of data,

given the number of rows and the Page Size)
• Page Size (same as Page Size in request)
• Page Number (same as Page Number in request)
The paging parameters are optional, and if not passed, the behavior
will default to returning all existing Endpoints with the maximum of
1000 entries. For each entry, the Statistics Counter Name is returned.
For more information on Paging, refer to Section 5.5, “Paging”, on page
86.
SoapServer will use the existing C Interface provided by RTP to support

the above functionality as described in the sections below.
27.2.1 Display the Counter Value

To get the value of a counter from the database, the user inputs the
following commands:
RtpReturn_t
RtpStaGetCounterValue
A31003-H80A0-T101-1-7618, 11/2021
Call Statistics
The output shows:

const RtpChar *counterName,RtpInt32 *value, const
RtpBool_t flush
Parameter definitions:
• counterName: Counter ID unique throughout the cluster. May only

contain letters, digits or underscores.
• value: Pointer to a variable of type RtpInt32 to be used to return

the counter value.
• flush: If set to a value other than null, this parameter causes local
increments/decrements to be flushed before returning the counter
value.
27.2.2 Display the Counter Status

To get the status of a counter from the database, the user inputs the
following commands:
RtpReturn_t
RtpStaGetCounterStatus
The output shows:
const RtpChar *counterId,RtpStaCounterStatus_p stat
• countered: Counter ID unique throughout the cluster.
• Stat: Pointer to a structure of type RtpStaCounterStatus_t:
• typedef struct {
• RtpBool_t stat_status;
• RtpInt32 stat_flushint;
• RtpStaCounterStatus_t, *RtpStaCounterStatus_p;
If successful, the element stat_status will contain the value RtpTrue if

the counter is activated, else RtpFalse. The element stat_flushint will
contain the value of the flush interval specified when the counter was
activated (cf. RtpStaActivateCounter).
27.2.3 Display the Counter Names

To retrieve the list of names of all counters from the database, the user
inputs the following commands:
RtpReturn_t
A31003-H80A0-T101-1-7618, 11/2021
Database Backup and Restore
RtpStaGetCounters
The output shows:
RtpStaCounterList_t **counterList
• counterList: Address of a pointer used to store the location of the

counter names array.
Table 992 outlines the statistics counters defined in the RTP database.
Return Value Function Description

struct int unsp__GetRTPCounterInfo This function returns the value of
unsp__GetCounterValueRes (struct unsp__GetCounterRequest a counter from the database.
ult GetCounterValueRequest, struct
unsp__GetCounterValueResult
*GetCounterValueResult)
struct int unsp__GetRTPCounterStatus (struct This function returns the status of
unsp__GetCounterStatusRe unsp__GetCounterRequest a counter from the database.
sult GetCounterStatusRequest, struct
unsp__GetCounterStatusResult
*GetCounterStatusResult)
struct int unsp__GetRTPCounterList (struct This function returns an array
unsp__GetCounterListResul unsp__GetCounterListRequest containing all counter names
t GetCounterListRequest, struct from the database.
unsp__GetCounterListResult
*GetCounterListResult)
Table 992 Call Statistic Counters
27.3 Database Backup and Restore

SoapServer is enhanced to provide interfaces to support the following
database operations:
• Start a backup process in one or both nodes;
• Cancel a backup;
• Query for the status of the backup process;
• Start a restore process;
• Cancel a restore;
• Query for the status of the restore process.
The existing functionality provided by the Maintenance Manager is used

in order to initiate, cancel or query for the status of maintenance tasks
such as the backup and restore. The Maintenance manager provides
the following APIs to support this:
A31003-H80A0-T101-1-7618, 11/2021
Database Backup and Restore
• RequestHandler.createJob
• RequestHandler.cancelJob
• RequestHandler.getJobs
27.3.1 Create Database Job Request

To create a job in order to start the Backup or Restore process, the user
is prompted to enter the following information:
• Job Type: which indicates the required action. Possible values will
be backup and restore
• Arguments [up to 256 char]: which indicated the type of the

backup or restore and can be any of the following values {all,
oracle_rtp, oracle_srx, oracle_all, omni, solid}.
The response will include the JobID that has been assigned to the
request and can be used later in order to cancel or query this specific
Job.
27.3.2 Cancel Database Job Request

The Backup and Restore processes may be cancelled while they are
running. The user may cancel a job request by entering the required
JobId. Not all jobs can be cancelled. To determine if a job can be
aborted, the “cancellable” attribute will appear in the Job Definition's
Type field.
27.3.3 Get Database Job List

The user may retrieve a list of all created jobs, completed and
running.This new interface facilitates paging through the result set by
SOAP clients that display the data graphically to the user. For more
information on Paging, refer to Section 5.5, “Paging”, on page 86.
Additionally, the paging request will also accept, as optional input, the
JobID in order to filter the expected results on the specific job.
27.3.4 Values for Job Request

For each entry, the values in Table 993 are returned.
A31003-H80A0-T101-1-7618, 11/2021
Managing Time Destinations Tables
Parameter Description
Job ID A cluster-unique index number assigned when a job is created.
Job Name A unique alphanumeric string identifying the job.
Executable Path Indicates the path to the job’s executable, relative to the job definition file.
Arguments (args) Indicates the format of the argument required for a particular job. The
maximum length is 256 characters.
State Indicates whether the job is:
• 1: running - running
• 2: overdue - running, but past max time
• 3: cancelling - running, attempting to cancel
• 4: cancelled - terminated, cancelled
• 5: done - terminated, success
• 6: error - terminated, error
Type A Bitmask that describes the job attributes. The type may contain one or
more type attributes such as:
• BASIC - job contains no attributes

• CANCELABLE - job may be cancelled
• SCHEDUALABLE - job may be scheduled
• BLOCK_ON_DONE - job is blocked when completed
• BLOCK_ON_ERR - job is blocked when an error occurs
• TRAP_ON_ERR - trap is sent when job ends in error
• WRITES_LOG - log file is written upon completion of job
Example: WRITES_LOG | CANCELABLE |BLOCK_ON_ERR | TRAP_ON_ERR

Average Run Time Indicates the estimated average run time (in seconds) required for a job to
complete.
Maximum Run Time Indicates the estimated maximum run time (in seconds) required for a job
to complete.
Report Name Indicates the path and name of the report generated for this job. The
information contained in a Report is brief.
Log Name Indicates the path and name of the log generated for this job. The
information contained in a Log is detailed.
NOTE: This is a future feature.

Start Time Indicates the start time of the job.
Stop Time Indicates the stop time of the job.
Table 993 Job Request Values
27.4 Managing Time Destinations Tables

SoapServer now supports the managing of time destination, day,
period, and weekly schedules on the system.
A31003-H80A0-T101-1-7618, 11/2021
27.4.1 Time Destination

To create or remove a time destination, the user is prompted to
provide:
OperatorID: The name of the user operator used for logging

purposes.
Time Destination Name:The name of the Time Destination, a string

of maximum 15 characters.
To display a Time Destination, the user can optionally input the “Time
Destination Name” in which case only that destination is retrieved
otherwise the command retrieves all time destinations from the
database, and facilitates paging through the result set by SOAP clients
that display the data graphically. For more information on Paging, refer
to Section 5.5, “Paging”, on page 86.
Table 994 outlines the interfaces to support the provisioning of the

Time Destinations functionality.
Return Value Function

struct unsp_CreateTimeDestinationResult int unsp__createTimeDestination
(unsp__CreateTimeDestination
CreateTimeDestinationRequest, struct
unsp__CreateTimeDestinationResult
*CreateTimeDestinationResult);
struct unsp__RemoveTimeDestinationResult int unsp__removeTimeDestination
(unsp__RemoveTimeDestination
RemoveDestinationRequest, struct
unsp__RemoveTimeDestinationResult *
RemoveTimeDestinationResult);
struct unsp__TimeDestinationResult int unsp__queryTimeDestination
(unsp__QueryTimeDestinationRequest
QueryTimeDestinationRequest, struct
unsp__TimeDestinationResult *
QueryTimeDestinationResult);
Table 994 Time Destination Interfaces
27.4.2 Day Schedule

The Day Schedule is used to provision a specific day schedule within
the time destination. The schedule that is assigned within the time
destination should cover one whole week.
SoapServer provides interfaces for create, assign, unassign, delete,

and display operations
• To create a Day Schedule, the user is prompted to provide:
A31003-H80A0-T101-1-7618, 11/2021
• Time Destination Name: Identifying the name of an existing

Time Destination on the system
• Day Schedule Name: Identifying the name of the Day

Schedule object. This object uniquely identifies a day schedule
within the time destination.
• To assign a Day Schedule to a Time Destination, the user is

prompted to provide:

• A list of Day Schedules, each one specified for a day of the

week, may be specified by the Day Schedule Name.
• Any day schedule that is assigned must be fully allocated,

meaning that it must contain period schedules that cover exactly
24 hours (1440 minutes).
• To unassign a Day Schedule from a Time Destination on the

specified days, the user is prompted to provide:

• A Boolean value for every day of week. If it is marked true,

the day schedule on that day is unassigned
• To modify Day Schedules of Time Destination the user is prompted

to provide:

• A list of Day Schedules may be specified with Day Schedule

Name values, and the days of the week.
• To remove Day Schedules from Time Destination, the user is

• Day Schedule Name: Identifying the name of the Day

Schedule object to be removed.

• The command removes the day schedule and all of its period
schedules, provided it is not assigned to a time destination.
Table 995 outlines the interfaces to support the provisioning of the Day
Schedule functionality.
A31003-H80A0-T101-1-7618, 11/2021

struct unsp__CreateDayScheduleResult int unsp__createDaySchedule
(unsp__CreateDayScheduleRequest
CreateDayScheduleRequest, struct
unsp__CreateDayScheduleResult *
CreateDayScheduleResult)
struct unsp__ModifyDayScheduleResult int unsp__modifyDaySchedule
(unsp__ModifyDayScheduleRequest
ModifyDayScheduleRequest, struct
unsp__ModifyDayScheduleResult *
ModifyDayScheduleResult)
struct unsp__RemoveDayScheduleResult int unsp__removeDaySchedule
(unsp__RemoveDayScheduleRequest
RemoveDayScheduleRequest, struct
unsp__RemoveDayScheduleResult *
RemoveDayScheduleResult)
struct unsp__DayScheduleResult int unsp__queryDaySchedule
(unsp__QueryDayScheduleRequest
QueryDayScheduleRequest, struct
unsp__DayScheduleResult *
QueryDayScheduleResult)
Table 995 Day Schedule Interfaces
27.4.3 Period Schedule

The Period Schedule table is used to provision the time period within a
day schedule. The time period is in the hours:minutes (HH:MM) format
and must cover a 24 hour period.
• To create/modify a Period Schedule, the user is prompted to

provide:
• Day Schedule Name to which it belongs and is identified by

dayName
• Time Destination Name identified by timeDestName
• starting time of the period is designated by a character string

startTime (such as 06:00)
• the stop time of the period is designated by a character string

stopTime (such as 11:59)
• Generic destination with which this period is associated is

identified by destName
• To remove a Period Schedule, the user is prompted to provide:
• Day Schedule Name to which it belongs and is identified by

dayName
A31003-H80A0-T101-1-7618, 11/2021
• Time Destination Name identified by timeDestName
• startTime of the period
• The remove command deletes the period schedule provided its

parent day schedule is not explicitly assigned to a time
destination with the Assign Day Schedule command.
• To display a Period Schedule, the user is prompted to provide the

following optional parameters:
• Day Schedule Name to which it belongs
• Time Destination Name
• startTime of the period
• Page Size
• Page Number
In all cases, if the time destination is given and/or the day schedule is
given, they act as a simple filter on the set of period schedules that
may be retrieved. If a specific period schedule object is identified by
the combination of the day schedule and the starting time, the day
schedule is not used as a filter. For each entry, the Day Schedule
Name, Time Destination Name , stopTime, stopTime and Destination
Name will be returned.
For more information on Paging (data responses), refer to Section 5.5,

• To display a Weekly Schedule, the user is prompted to provide the

following parameters:
• Time Destination Name
• A Day for which a schedule may be assigned (optional)
Weekly schedules include the:
• Time Destination;
• day for which the period is assigned
• day schedule that is assigned to (Time Destination, day).
Attention: Day schedules may appear more than once, particularly if

the day schedule is assigned to more than one day for a destination.
Table 996 outlines the interfaces to support the provisioning of the

Period and Weekly Schedule functionality.
A31003-H80A0-T101-1-7618, 11/2021
SIP Signaling Manager

struct unsp__CreatePeriodScheduleResult int unsp__createPeriodSchedule
(unsp__CreatePeriodScheduleRequest
CreatePeriodScheduleRequest, struct
unsp__CreatePeriodScheduleResult *
CreatePeriodScheduleResult)
struct unsp__ModifyPeriodScheduleResult int unsp__modifyPeriodSchedule
(unsp__ModifyPeriodScheduleRequest
ModifyPeriodScheduleRequest, struct
unsp__ModifyPeriodScheduleResult *
ModifyPeriodScheduleResult)
struct unsp__RemovePeriodScheduleResult int unsp__removePeriodSchedule
(unsp__RemovePeriodScheduleRequest
RemovePeriodScheduleRequest, struct
unsp__RemovePeriodScheduleResult *
RemovePeriodScheduleResult)
struct unsp__PeriodScheduleResult int unsp__queryPeriodSchedule
(unsp__QueryPeriodScheduleRequest
QueryPeriodScheduleRequest, struct
unsp__PeriodScheduleResult *
QueryPeriodScheduleResult)
struct unsp__WeeklyScheduleResult int unsp__queryWeeklySchedule
(unsp__QueryWeeklyScheduleRequest
QueryWeeklyScheduleRequest, struct
unsp__WeeklyScheduleResult *
QueryWeeklyScheduleResult)
Table 996 Period and Weekly Schedule Interfaces
27.5 SIP Signaling Manager

SoapServer is enhanced to support the provisioning of the
SIP_Trusted_Entities table that extends the existing
System_SIP_Profile table. New interfaces allow the assigning and
unassigning of Port Ranges to/from SIP Entities and also to display a
list of the port ranges which are assigned to a SIP entity.
27.5.1 Assign Port Range

To assign a port range, the user is prompted to provide:
• The IP address of the SIP entity, and
• A list of port ranges in which each entry will be defined of a

Minimum Port and a Maximum Port.
If the minimum port value [0...65535] has a value equal to "0", then
all the range of ports for this IP is defined as trusted.
A31003-H80A0-T101-1-7618, 11/2021
SIP Signaling Manager
If the minimum port value is > 0 and maximum port value > 0 then all
the ports, from MIN_PORT to MAX_PORT, are defined as trusted
entities.
If the maximum port value [0...65535] has a value equal to "0", this
means that the minimum port value is defined as a single trusted port
for this IP.
Since the user provides a list of Port Ranges there might be cases that
a number of ports are not successfully assigned to SIP Entity.
SoapServer will skip those Ports that cannot be assigned and, in terms
of error checking, the response to the user will include the list of Port
Ranges (MinPort/MaxPort) that were not successfully assigned to SIP
Entity.
27.5.2 Unassign Port Range

To unassign a port range, the user is prompted to provide:
• The IP address of the SIP entity, and
• A list of port ranges that the user wants removed from the SIP
Entity defined in a set of a Minimum Port and a Maximum Port.
27.5.3 Display Port Ranges

The user is prompted to provide the following optional parameters:
• IP Address,
• Page Size,
• Page Number.
If the user provides the IP Address of a SIP Entity, then the entire list
of the port ranges, which are assigned to this entity, is displayed.
Otherwise, the entire list of IP’s is displayed with the corresponding
Port Ranges. For each entry, the list of Port Ranges (MinPort and
MaxPort) is returned.
For more information on Paging, refer to Section 5.5, “Paging”, on page

86.
Table 997 outlines the interfaces to support the provisioning of the SIP
Trusted Entity functionality.
A31003-H80A0-T101-1-7618, 11/2021
Billing and CDR Generation

struct unsp__AddSipTrustedEntityPortsResult int unsp__AddSipTrustedEntityPorts
(struct unsp__SipTrustedEntityPortsRequest
AddSipTrustedEntityPortsRequest, struct
unsp__AddSipTrustedEntityPortsResult
*AddSipTrustedEntityPortsResult)
struct unsp__RemoveSipTrustedEntityPortsResult int unsp__RemoveSipTrustedEntityPorts
(struct unsp__SipTrustedEntityPortsRequest
RemoveSipTrustedEntityPortsRequest, struct
unsp__RemoveSipTrustedEntityPortsResult *
RemoveSipTrustedEntityPortsResult)
struct unsp__GetSipTrustedEntityPortsListResult int unsp__GetSipTrustedEntityPortsList (struct
unsp__GetSipTrustedEntityPortsListRequest
GetSipTrustedEntityPortsListRequest, struct
unsp__GetSipTrustedEntityPortsListResult*
GetSipTrustedEntityPortsListResult)
Table 997 SIP Trusted Entities Interfaces
27.6 Billing and CDR Generation

The generic RTP interface maintains a list of RTP parameters together
with their range of valid values in a file called RtpParameters.conf. The
3 new RTP parameters and their valid ranges will be added to this .conf
file.
These three new parameters permit the modification and display of

CDR usage. This new CDR configuration management capability
enables OpenScape Voice Accounting Management to perform basic
call accounting (incoming, outgoing and internal calls) as well as
ensure correct CDR generation and call duration for Enterprise call
transfer scenarios for all possible customer configurations.
Srx/Usc/nodeID_area0 The areaID value that comprises the nodeID variable.

Integer 0...999.
Integer 0...255.
Integer 0...31.
27.7 Tones and Announcements

SoapServer supports the provisioning of Tones and Announcements on
the system.
A31003-H80A0-T101-1-7618, 11/2021
Tones and Announcements
27.7.1 Intercepts
An intercept is a sequence of treatments that can be repeated for a
certain number of cycles. Ordered treatments for calls cannot be
completed as dialed. These calls are redirected to a recorded
announcement, a tone, an operator, or combinations thereof.
27.7.1.1 Create an Intercept
To create an intercept, the user is prompted to provide the following

parameters:
• Intercept Name: The Intercept Name is an alphanumeric string

[1..15] identifying an Intercept entry.
• Default Intercept Name: The Default Intercept Name is an

alphanumeric string [1..15] identifying a Default Intercept entry. If
a Default Intercept Name is assigned, then all of its corresponding
assigned treatments also become the treatments used, unless they
are modified to be different.
27.7.1.2 Modify an Intercept
To modify an intercept, the user is prompted to provide the following

parameters:

• Cycle: The Cycle represents the number of times that the Intercept
Treatment sequence is applied. This Cycle object is the same for all
treatments assigned to the same Intercept. A treatment reference
must exist in order to modify this object
• Interval: The Interval represents silence between cycles. The

Interval must be the same for all treatments assigned to the same
intercept. A default of '0' interval is interpreted as '0000'
milliseconds. A treatment reference must exist in order to modify
this object
• Default Intercept Name: The Default Intercept Name is an

alphanumeric string [1..15] identifying a Default Intercept entry. If
a Default Intercept Name is assigned, then all of its corresponding
assigned treatments also become the treatments used, unless they
are modified to be different.
A31003-H80A0-T101-1-7618, 11/2021
27.7.1.3 Remove an Intercept
To remove an intercept, the user is prompted to provide the following

parameter:

27.7.1.4 Display an Intercept
To display an intercept, the user is prompted to provide the following

optional parameters:
• Intercept Name,
• Page Size,
• Page Number.
If the Intercept Name is given, it acts as a simple filter on the set of

Intercepts that may be retrieved. For each entry, the Intercept Name,
Cycle, Interval, Default Intercept Name, and Number of Intercepts is
returned. For more information on Paging, refer to Section 5.5,
A31003-H80A0-T101-1-7618, 11/2021
Table 998 outlines the interfaces to support the provisioning of

intercepts.

struct unsp__CreateInterceptResult int unsp__createIntercept
(unsp__CreateInterceptRequest
CreateInterceptRequest, struct
unsp__CreateInterceptResult *
CreateInterceptResult)
struct unsp__RemoveInterceptResult int unsp__removeIntercept
(unsp__RemoveInterceptRequest
RemoveInterceptRequest, struct
unsp__RemoveInterceptResult *
RemoveInterceptResult)
struct unsp__ModifyInterceptResult int unsp__modifyIntercept
(unsp__ModifyInterceptRequest
ModifyInterceptRequest, struct
unsp__ModifyInterceptResult *
ModifyInterceptResult)
struct unsp__QueryInterceptDataResult int unsp__queryIntercept
(unsp__QueryInterceptRequest
QueryInterceptRequest, struct
unsp__QueryInterceptDataResult *
QueryInterceptResult)
Table 998 Intercept Interfaces
27.7.2 Treatments
A treatment of an intercept can be defined as a tone, or an
announcement. Each tone is identified by a system defined ID as well
as a duration period.
27.7.2.1 Assign a Treatment
To assign a treatment to an existing intercept the user is prompted to

provide the following parameters:
• Treatment Order: Describes the desired ordering of the new

treatment to be created in relation to existent treatments. Only
three (3) treatments are allowed per intercept. This is a mandatory
object for creation. It can be any value of {First, Second, Third}.
• Treatment type: This mandatory field can be any value from

{'Tone, Announcement,RelCall}.
• If Tone is chosen, then the user should provide:
A31003-H80A0-T101-1-7618, 11/2021
• Tone Name field is mandatory. Tone Name is an

alphanumeric string [0..15] identifying a Tone.
• Duration, used in setting a length for the Tone Intercept

Treatment, measured in milliseconds. A default of '0'
duration is interpreted as the use of a pre-determined
duration of tone.
• Destination Name, Destination Type and Destination Circuit

are optional.
• If Announcement is chosen then the user should provide
• Announcement Identifier: is typically a URL of size (0..511).
• Answer : It can be either YES/NO
• Barge-In: It can be either YES/NO
• Destination Name, Destination Type and Destination Circuit

are optional
• If Relcall is chosen, the treatment is to release call with a cause

and if the call is SIP incoming, an optional SIP reason header
may also be provisioned. (not applicable to the OpenScape Voice
system)
27.7.2.2 Modify an Existing Treatment
To modify an existing treatment, the user is prompted to provide the

name of the Intercept and the corresponding parameters.
Caution: The type of the treatment cannot be modified.
• If the treatment type is TONE, the Tone Name, and the duration of
the tone may be modified.
• If the treatment type is ANNOUNCE, the announcement message,

announcement identifier, the answer parameter of the
announcement, the bargeIn parameter of the announcement, and
the destination of the announcement can be modified
• If the treatment type is RELCALL, only the Sip Reason Id field may
be modified.
A31003-H80A0-T101-1-7618, 11/2021
27.7.2.3 Unassign a Treatment
To unassign an existing treatment from an intercept, the user is

• Name of the Intercept,
• Treatment Order.
If there are no remaining treatments assigned to the intercept, by

unassigning the treatment, the intercept cycle and interval of the
Intercept are reset to default values.
27.7.2.4 Display a Treatment
To display existing treatments for an intercept, the user is prompted to

provide:
• Intercept Name
• Treatment Order
• Page Size
• Page Number
If the Intercept Name is given, it acts as a simple filter on the set of

Treatments that may be retrieved. The paging parameters are optional,
and if not passed, the behavior defaults to returning all existing
Treatments with the maximum of 1000 entries. For more information
on Paging, refer to Section 5.5, “Paging”, on page 86.
For each entry, the Intercept Name, Cycle, Interval, Type and the
corresponding parameters according to the Treatment Type (Tone/
Announce) is returned.
Table 999 outlines the interfaces to support the provisioning of

treatments.

struct unsp__AssignTreatmentResult int unsp__assignTreatment (unsp__TreatmentData
AssignTreatmentRequest, struct
unsp__AssignTreatmentResult *
AssignTreatmentResult)
struct unsp__ModifyTreatmentResult int unsp__modifyTreatment
(unsp__ModifyTreatmentData
ModifyTreatmentRequest, struct
unsp__ModifyTreatmentResult *
ModifyTreatmentResult)
Table 999 Treatment Interfaces (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
PRIMECLUSTER (PCL) Management

struct unsp__UnassignTreatmentResult int unsp__unassignTreatment
(unsp__UnassignTreatmentId
UnassignTreatmentRequest, struct
unsp__UnassignTreatmentResult *
UnassignTreatmentResult)
struct unsp__QueryTreatmentDataResult int unsp__queryTreatment
(unsp__QueryTreatmentRequest
QueryTreatmentRequest, struct
unsp__QueryTreatmentDataResult *
QueryTreatmentResult)
Table 999 Treatment Interfaces (Seite 2 von 2)
27.8 PRIMECLUSTER (PCL) Management

This new V3.1 feature supports the OpenScape Voice system
redundancy with geographic separation of the two cluster nodes, which
ensures high availability in a catastrophic building failure scenario.
Specifically, it will allow the cluster interconnection between the two
nodes to be a Layer 3 IP connection. To do this, seventeen (17) new
RTP parameters will be added to the RtpParameters.conf file, under the
Small Medium Enterprise (SME) framework. The Soap interface is
responsible for displaying these PRIMECLUSTER interconnect
configuration parameters Conveniently, they are listed below, but are
also added to Table 991.
Note: The SME is an integrated subset of the SOAP server. It has its
own framework and generates the library libxdmsubp.so. Most of the
commonly used objects for simple Enterprise environment are
contained in the library. The SME framework is being used for some
objects in the feature even though they are outside of the Enterprise
environment.
Srx/Main/ClusterName Srx/Main/node1CIPLogical
Srx/Main/node1Name Srx/Main/node2CIP0
Srx/Main/node1PhyIpAddr Srx/Main/node2CIP1
Srx/Main/node2Name Srx/Main/node2Logical
Srx/Main/ClusterType Srx/Main/node1CIPNetwork
Srx/Main/node1CIP0 Srx/Main/node2CIPNetmask
Srx/Main/node1CIP1 Srx/Main/node2CIPNetwork
Srx/Main/CIPBroadcast
A31003-H80A0-T101-1-7618, 11/2021
soap_config_params.fm
RTP Parameters Relevant to Subscriber Provisioning
28 RTP Parameters Relevant to Subscriber

Provisioning
Table 1000 lists and describes the RTP Configuration Parameters that
are used by the SOAP Server and the Subscriber Management
Schedule process during subscriber provisioning activities. The
behavior of the SOAP Server depends on the configured values for
these parameters. Please refer to Section 7.3, “Get Config Data”, on
page 110 for a description of the interface used to retrieve the current
values of these parameters.
Srx/Main/SvcAssignedPerOfficeACR Indicates whether the ACR feature is assigned on an
office-wide basis.
Srx/Main/CustomerType Indicates whether the system is configured for use in the
The soap Processes use this parameter to:
• respond to the GetVersion information,
• control the services that are available on the system
via the FeatureList.dat file
Srx/Xdm/DnCode/digits/minLen Indicates the minimum allowable directory number
length.
Srx/Xdm/DnCode/digits/maxLen Indicates the maximum allowable directory number
length.
Srx/Xdm/DnCode/npa/minLen Indicates the minimum allowable area code (NPA)
length.
Srx/Xdm/DnCode/npa/maxLen Indicates the maximum allowable area code (NPA)
length.
Srx/Xdm/HomeDn/digits/minLen Indicates the minimum allowable home DN length.
Srx/Xdm/HomeDn/digits/maxLen Indicates the maximum allowable home DN length.
Srx/Xdm/OfficeCode/digits/minLen Indicates the minimum allowable office code length.
Srx/Xdm/OfficeCode/digits/maxLen Indicates the maximum allowable office code length.
Srx/Xdm/OfficeCode/countryCode/minLen Indicates the minimum allowable country code length.
Srx/Xdm/OfficeCode/countryCode/maxLen Indicates the maximum allowable country code length.
Srx/Sip/AuthEnabled Indicates whether SIP Authorization is enabled.
Srx/Sip/max_number_of_sessions Indicates the maximum allowable number of SIP
sessions.
Srx/Sip/default_number_of_sessions Indicates the default number of SIP sessions.
Srx/Subp/Address Indicates the IP address on which the SOAP Server
should listen to receive SOAP requests. SoapServer will
process requests only on this adapter. To accept
requests on any adapter specify 0.0.0.0. This parameter
defaults to 0.0.0.0.
Table 1000 RTP Configuration Parameters (Seite 1 von 5)
A31003-H80A0-T101-1-7618, 11/2021
Srx/Subp/Port Indicates the port on which the first instance of the
SOAP server should listen to receive SOAP requests.
When NumberOfInstances > 1, this is the first of
NumberOfInstances ports. This parameter defaults to
8767.
Srx/Subp/NumberOfInstances Indicates the number of SOAP server child processes to
run. Each child processes requests on a single port. This
parameter defaults to 4.
Srx/Subp/OverLoadCheckPeriod Indicates the time period after which to check for
overload conditions on the system. Subscriber
provisioning checks the congestion level after this time
period. It rejects requests for this period of time when in
congestion. This parameter defaults to 30 seconds.
Srx/Subp/OverLoadLevel1Sleep The number of seconds to sleep when the system is in
congestion level 1. The default is 30.
Srx/Subp/JobCheckSleep Indicates the number of seconds for the
submgtSchedule process to pause between checks for
new jobs. This parameter defaults to 10.
Srx/Subp/NumObjectsToPauseAfter Indicates the number of objects after which the
submgtSchedule process pauses. SubmgtSchedule
cascades feature changes to multiple subscribers. This
parameter is used to limit the impact of this processing
on the switch. This parameter defaults to 20.
Srx/Subp/JobLoopSleepTime Indicates the number of seconds for the
submgtSchedule process to pause between each object
processed. This parameter is used to limit the impact of
this processing on the switch. This parameter defaults to
0.
Srx/Subp/JobClearTime Indicates the time of day at which the submgtSchedule
process checks for and removes old jobs. The (jobs)
results of the feature cascadings are maintained for a
user-defined number of days. This parameter reflects
the time of day that these files are purged. The format
is 24HH:MM. This parameter defaults to 02:00.
Srx/Subp/ClearJobDays Indicates the number of days after which the
submgtSchedule process removes successfully
completed jobs. This parameter defaults to 3 days.
Srx/Subp/ClearErrorDays Indicates the number of days after which the
submgtSchedule process removes jobs that ended
abnormally. This parameter defaults to 5 days.
A31003-H80A0-T101-1-7618, 11/2021
Srx/Main/VMWIcapabilityDefault Indicates whether the Visual Message Waiting Indication
capability is Provisioned automatically when the Voice
Mail feature is provisioned. This parameter defaults to
True.
Srx/Main/InvalidStringChars Defines a set of characters, which, if included in any
character string parameter in a provisioning request,
causes the request to be rejected.
Srx/Main/DisableDNValidation This parameter, if defined and set to RtpTrue, causes the
SOAP Server to perform no validation on forward-to
numbers. The default is RtpFalse.
Srx/Main/AllowCFDestEmergency A flag that may be set to allow subscribers to set their
Call Forwarding destinations to Emergency Numbers
(like 911). The default is RtpFalse.
Srx/Main/SwitchFPRestrict If set to RtpTrue, indicates that a switch-wide Feature
Profile cannot be assigned to a BGL - only BG-associated
FPs may be assigned to BGLs. If set to RtpFalse, a
switch-wide FP can be assigned to BGLs. The default is
RtpFalse.
Srx/Main/SrxSwitchLangMode Defines language support on the switch with one of the
following possible values:
1 - Single Language
2 - Multi-Language (meaning that subscribers can be
provisioned with their language of choice for
announcements)
The default value is 1.
Srx/Main/SrxDefaultLang Defines the default language for the switch. This is the
language used when a language code is not specified
individually for a subscriber or other entity. The default
value is 1 (English).
Srx/Main/SrxSupportedLangList Defines the list of possible supported languages. The
parameter is a comma separated string of up to 20
language codes (for example “1,2,3”). The default value
is 1 (English), and the numeric values correspond to
other languages defined internally.
A31003-H80A0-T101-1-7618, 11/2021
Srx/Main/SS7Variant This identifies the nature of the SS7 variant, with the
0 - No SS7 support
1 - ANSI
2 - ITU
3 - Japan
6 - China
The default value is 1 (ANSI).
Note that this parameter is used to for ANSI/ITU (ETSI)
checks in the following scenarios:
• Validating certain SignalType and SignalProfileFlags
values for Create and Modify Signal Profile SOAP
requests.
• Obtaining the list of features that are valid for a
particular environment in response to the
GetFeatureList request.
• Determining whether a service feature is allowed to
be assigned, if it is ANSI or ITU specific. Note that this
check is NOT done if the Srx/Main/CustomerType
parameter is set to Enterprise.
Srx/Main/hiQVariant Defines the Application Market Domain, with the
1 - US
2 - ETSI
The default value is 1 (US).
Note that this parameter is used to for ANSI/ITU (ETSI)
checks in the following scenarios:
• Determining whether to allow hex digits in a dialed
DN.
• Adding the correct prefixes when checking whether
numbers are valid call forwarding destinations.
• Adding the correct prefixes when checkiing whether
numbers are valid hotline/warmline destinations.
Srx/Main/ApplicationType Identifies whether the application type for the switch is
Fixed Mobile Convergence (FMC) or not. The possible
values are:
1 - Non-FMC
2 - FMC
The default value is 1 (non-FMC).
Srx/Main/CFVMCompatibility Indicates whether it shall be possible to assign the Voice
Mail feature as well as one or both of the Call Forwarding
Variants Call Forwarding Busy (CFB) and Call Forward No
Reply (CFDA) to the same subscriber or feature profile.
If this parameter is RtpTrue, the assignments are
allowed; if RtpFalse, the CF features are mutually
exclusive with Voice Mail.
Srx/Subp/Tombstone/KeepRecordsInterval The number of days to keep tombstone entries in the
database. The default value is 30.
Srx/Main/LCSMaxNumConfPorts The maximum number of conference participants.
A31003-H80A0-T101-1-7618, 11/2021
Srx/Main/OutGoingCallingPartyNumberType Should be set to value 0 for E.164 numbers and value 1
for PNP numbers.
Subp/SoapHomeDNReturnCodeRelease Indicates the different returncodes for provisioning in
V2.1 and V3.1.
Srx/Irm/VideoBitRate_Unknown type: integer, endtype value: [ 32000-960000 ]
endvalue
Srx/Irm/VideoBitRate_H263 type: integer, endtype value: [ 32000-960000 ]
endvalue
Srx/Irm/VideoBitRate_H264_Profile_1 type: integer, endtype value: [ 32000-64000 ] endvalue
Srx/Irm/VideoBitRate_H264_Profile_1_b type: integer, endtype value: [ 32000-128000 ]
endvalue
Srx/Irm/VideoBitRate_H264_Profile_1_1 type: integer, endtype value: [ 32000-192000 ]
endvalue
endvalue
endvalue
Srx/Irm/VideoBitRate_H264_Profile_2 type: integer, endtype value: [ 32000-2000000 ]
endvalue
endvalue
endvalue
endvalue
endvalue
endvalue
endvalue
endvalue
Srx/Irm/VideoBitRate_H264_Profile_4_2 type: integer, endtype value: [ 32000-50000000]
endvalue
endvalue
endvalue
Many RTP parameters can be displayed and/or configured via the SOAP
Interface. For details, please refer to Section 7.4, “Set Config Parm
Data” and Section 7.5, “Get Config Parm Data”.
A31003-H80A0-T101-1-7618, 11/2021
The deliverable file RtpParameters.conf is used by those Get and Set

requests to determine if a particular RTP parameter is one of the subset
that can be accessed via the SOAP interface. The current version of this
file is available on the system in the /unisphere/srx3000/UNSPsubp
directory.
A31003-H80A0-T101-1-7618, 11/2021
soap_messages.fm
WSDL and Example SOAP Messages
WSDL Schema Definition
29 WSDL and Example SOAP Messages

The interface definitions are provided only as a sample.
29.1 WSDL Schema Definition

The Web Services Description Language (WSDL) describes the
message sets and interfaces provided by the OpenScape Voice system
for subscriber provisioning. This interface is defined by the SOAP, XML
and HTTP standards. WSDL is SOAP’s equivalent of an XML schema or
CORBA IDL.
29.2 Interfacing to the System using the WSDL

The WSDL is the interface definition. SOAP and XML support and
provide for flexibility in the message processing to allow for backwards
compatibility. Changes in the WSDL need not require programming
changes. With this in mind — especially since there may be multiple
Unify SoftSwitches to be provisioned in a common management
network — the customer should process without strict WSDL
conformance.
The SOAP client should process messages and allow for various tags
not to be sent by the OpenScape Voice system. The SOAP client may
raise an alarm, but should not abend or core dump. Additionally new
elements (attributes/structures) may be returned from the softswitch
in new releases. The customer process may raise alarms or log this
event, but it should process the rest of the message and ignore these
new data fields.
The software and WSDL interface version are obtainable from the
softswitch using the GetVersion interface.
29.3 Sample Messages

The following sections present sample messages that the OpenScape
Voice system will receive and return. All messages are request/
response. There are no unsolicited outbound subscriber provisioning
messages from the OpenScape Voice system. Alerts are different and
are addressed in a different section of this document.
In the following examples, please note the following about the syntax.
A31003-H80A0-T101-1-7618, 11/2021
soap_messages.fm
Sample Messages
A parameter sent like this:

<AccountId></AccountId>
...means that the parameter is being provided with no value. For a

string parameter, this would mean that an empty string is being sent,
and the SOAP Server would process this request as if the operator
intends to replace the existing value of the parameter with the empty
string. This is not the same as requesting that an existing value remain
unchanged for this parameter.
Alternatively, a parameter sent such as this:

<BGAttendantNumber xsi:nil=”true”/>
...is equivalent to not sending the parameter at all. In this case the
SOAP Server performs whatever default action is defined when the
parameter is not provided. For a create operation, this typically means
that some predefined default value is assigned. For a modify operation,
this typically means that the existing value is unchanged.
29.3.1 Get Version Sample Messages
29.3.1.1 Get Version Request
The following SOAP request is used to query the current WSDL version
supported by the OpenScape Voice system.
POST / HTTP/1.0
Content-Type: text/xml; charset=utf-8
Accept: application/soap+xml, application/dime, multipart/
related, text/*
User-Agent: Axis/1.2RC2
Host: 10.77.14.10:8767
Cache-Control: no-cache
Pragma: no-cache
SOAPAction: “”
Content-Length: 338
<soapenv:Envelope xmlns:soapenv=”http://
schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://
www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/
2001/XMLSchema-instance">
<soapenv:Body>
<ns1:GetVersion soapenv:encodingStyle="http://
schemas.xmlsoap.org/soap/encoding/"
xmlns:ns1="urn:siemens-hiq8000"/>
</soapenv:Body></soapenv:Envelope>
A31003-H80A0-T101-1-7618, 11/2021
soap_messages.fm
Sample Messages
29.3.1.2 Get Version Response
The response will resemble the following message:
HTTP/1.1 200 OK
Server: gSOAP/2.7
Content-Length: 760
Connection: close
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://
schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENC="http:/
/schemas.xmlsoap.org/soap/encoding/" xmlns:xsi="http://
www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://
www.w3.org/2001/XMLSchema" xmlns:unsp="urn:siemens-
hiq8000">
<SOAP-ENV:Body>
<unsp:GetVersionResult>
<Result>
</Result>
<VersionData>
<Version>10.00.09.01</Version>
<MarketBuild>10.01.01.ALL.22</MarketBuild>
<SoftSwitchEnvironment>Carrier</
SoftSwitchEnvironment>
<buildDateTime>2006-01-23T15:06</buildDateTime>
</VersionData>
</unsp:GetVersionResult>
</SOAP-ENV:Body>
29.3.2 Create Subscriber Sample Messages
29.3.2.1 Create Subscriber Request
The following is an example of a SOAP request used to create a

subscriber:
POST / HTTP/1.0
related, text/*
Host: 10.77.14.10:8767
Pragma: no-cache
SOAPAction: ""
Content-Length: 3891
<soapenv:Envelope xmlns:soapenv="http://
A31003-H80A0-T101-1-7618, 11/2021
soap_messages.fm
Sample Messages
<soapenv:Body>
<ns1:CreateSubscriber soapenv:encodingStyle="http://
xmlns:ns1="urn:siemens-hiq8000">
<ServiceId>5619556559</ServiceId>
<OperatorId>SuperAdmin</OperatorId>
<CreateSubRequest>
<AccountMgtInfo>
<BillingId></BillingId>
<RetailerId></RetailerId>
<ClassOfService></ClassOfService>
<RateArea></RateArea>
<ExternalDNFlag xsi:nil="true"/>
<CountryCodeLen>0</CountryCodeLen>
<CallingLoc></CallingLoc>
<FeatureProfileId>
<FeatureProfileName></FeatureProfileName>
<BGName xsi:nil="true"/>
</FeatureProfileId>
<NumberPlanName></NumberPlanName>
<ExternalCallerID></ExternalCallerID>
<UseMainPilotDN></UseMainPilotDN>
<ImpactLevel></ImpactLevel>
</AccountMgtInfo>
<SubscriberBGInfo>
<BGName></BGName>
<BGLineName></BGLineName>
<BGAttendantNumber xsi:nil="true"/>
<CpuId>0</CpuId>
<Extension></Extension>
<BGDeptName xsi:nil="true"/>
</SubscriberBGInfo>
<AccountUserInfo>
<DisplayName></DisplayName>
<TimeZone></TimeZone>
<Pin></Pin>
<PublicPin></PublicPin>
<Language>System Default</Language>
</AccountUserInfo>
<Status>
<SubscriberStatus>Active</SubscriberStatus>
<InterceptAnnouncement xsi:nil="true"/>
<NewServiceId xsi:nil="true"/>
</Status>
<ConnectionInfo>
<IPPhone>
<Name>5619556559</Name>
<RegType>Dynamic</RegType>
<IPAddr xsi:nil="true"/>
<Port xsi:nil="true"/>
<Register xsi:nil="true"/>
<TimeToLive xsi:nil="true"/>
<MaxSessions xsi:nil="true"/>
<SIPSecurity>
<Realm xsi:nil="true"/>
<UserName xsi:nil="true"/>
<Password xsi:nil="true"/>
<Scheme>digest-authentication</Scheme>
</SIPSecurity>
<IPConnectionType>UDP</IPConnectionType>
<Attributes>
A31003-H80A0-T101-1-7618, 11/2021
soap_messages.fm
Sample Messages
< MediaReDirectionAllowed>false</
MediaReDirectionAllowed>
<AoRPerContact>false</AoRPerContact>
<OverrideIRMCodecRestrictions>false</
OverrideIRMCodecRestrictions>
<TransferHandoff>false</TransferHandoff>
<AcceptBillingNumber>false</
AcceptBillingNumber>
<SendInsecureRefferedByHeader>false</
SendInsecureRefferedByHeader>
</Attributes>
<ContactInfoList xsi:nil="true"/>
<AssociatedSipEndpointName xsi:nil="true"/>
</IPPhone>
<MGCPPhone xsi:nil="true"/>
<H323Term xsi:nil="true"/>
</ConnectionInfo>
<QualityOfService xsi:nil="true"/>
<InterExchange>
<PIC1></PIC1>
<PIC2></PIC2>
<PIC3></PIC3>
<PIC4></PIC4>
</InterExchange>
<KeysetInfo>
<KeysetUse xsi:nil="true"/>
</KeysetInfo>
<ListOfFeatures>
<CfAC xsi:nil="true"/>
<CfACR xsi:nil="true"/>
<CfAR xsi:nil="true"/>
<CfACCB xsi:nil="true"/>
<CfAcctCode xsi:nil="true"/>
<CfAuthCode xsi:nil="true"/>
<CfBgCNAM xsi:nil="true"/>
<CfBgCPU xsi:nil="true"/>
<CfBgCT xsi:nil="true"/>
<CfBgDAPPS xsi:nil="true"/>
<CfBgDNPPS xsi:nil="true"/>
<CfBLV xsi:nil="true"/>
<CfCCW xsi:nil="true"/>
<CfCFB xsi:nil="true"/>
<CfCFDA xsi:nil="true"/>
<CfCFV xsi:nil="true"/>
<CfCHLD xsi:nil="true"/>
<CfCIDCW xsi:nil="true"/>
<CfCIDS xsi:nil="true"/>
<CfCISNAME xsi:nil="true"/>
<CfCISNUM xsi:nil="true"/>
<CfCNAB xsi:nil="true"/>
<CfCNAM xsi:nil="true"/>
<CfCND xsi:nil="true"/>
<CfCNDB xsi:nil="true"/>
<CfCPK xsi:nil="true"/>
<CfCT xsi:nil="true"/>
<CfCSTA xsi:nil="true"/>
<CfLONR xsi:nil="true"/>
<CfLINR xsi:nil="true"/>
<CfCCBS xsi:nil="true"/>
<CfCCNR xsi:nil="true"/>
<CfCOLR xsi:nil="true"/>
<CfCW xsi:nil="true"/>
A31003-H80A0-T101-1-7618, 11/2021
soap_messages.fm
Sample Messages
<CfDAPPS xsi:nil="true"/>
<CfDNPPS xsi:nil="true"/>
<CfEACR xsi:nil="true"/>
<CfECF xsi:nil="true"/>
<CfHotDesk xsi:nil="true"/>
<CfIN xsi:nil="true"/>
<CfMCT xsi:nil="true"/>
<CfMOH xsi:nil="true"/>
<CfONS xsi:nil="true"/>
<CfPRES xsi:nil="true"/>
<CfRACF xsi:nil="true"/>
<CfRCF xsi:nil="true"/>
<CfRFA xsi:nil="true"/>
<CfSCA xsi:nil="true"/>
<CfSCF xsi:nil="true"/>
<CfSCR xsi:nil="true"/>
<CfSERRNG xsi:nil="true"/>
<CfSILMProtection xsi:nil="true"/>
<CfSILM xsi:nil="true"/>
<CfSPCALL xsi:nil="true"/>
<CfSR xsi:nil="true"/>
<CfSRS xsi:nil="true"/>
<CfTRS xsi:nil="true"/>
<CfVM xsi:nil="true"/>
</ListOfFeatures>
</CreateSubRequest>
</ns1:CreateSubscriber>
29.3.2.2 Create Subscriber Response
HTTP/1.1 200 OK
Server: gSOAP/2.7
Content-Length: 624
Connection: close
hiq8000">
<SOAP-ENV:Body>
<unsp:ResultCodeStruct>
</unsp:ResultCodeStruct>
</SOAP-ENV:Body>
A31003-H80A0-T101-1-7618, 11/2021
soap_messages.fm
Sample Messages
29.3.3 Get Subscriber Info Sample Messages
29.3.3.1 Get Subscriber Info Request
The following message will retrieve the data for the specified
subscriber:
POST / HTTP/1.0
related, text/*
Host: 10.77.14.10:8767
Pragma: no-cache
SOAPAction: ""
Content-Length: 570
<soapenv:Body>
<ns1:GetSubInfoByRel soapenv:encodingStyle="http://
<GetSubInfoRequest>
<InterfaceRelease xsi:nil="true"/>
<InterfaceWSDL xsi:nil="true"/>
<GetSubDataOptions>
<GetSubscriberDataOptionList/>
</GetSubDataOptions>
</GetSubInfoRequest>
</ns1:GetSubInfoByRel>
29.3.3.2 Get Subscriber Info Response

HTTP/1.1 200 OK
Server: gSOAP
<ResultCode>0
<ResultText2>
<ResultText3>
<ResultText4>
<?xml>
<SOAP-ENV:Envelope>
<SOAP-ENV:Body>
<unsp:GetSubscriberResult>
<Result>
A31003-H80A0-T101-1-7618, 11/2021
soap_messages.fm
Sample Messages
</Result>
<ServiceIdType>PrimaryDn</ServiceIdType>
<PrimaryDnInfo>
<OfficeCodeInfo>
<OfficeCode>561955</OfficeCode>
<CountryCodeLength>0</CountryCodeLength>
<AreaCodeLength>3</AreaCodeLength>
<Attributes>AtrNo</Attributes>
</OfficeCodeInfo>
<AccountMgtInfo>
<BillingId>5619551110</BillingId>
<ExternalDNFlag>false</ExternalDNFlag>
<CountryCodeLen>0</CountryCodeLen>
<FeatureProfileId>
<FeatureProfileName></FeatureProfileName>
<BGName></BGName>
</FeatureProfileId>
<NumberPlanName>E164NANP</NumberPlanName>
</AccountMgtInfo>
<AccountUserInfo>
<UnicodeDisplayName></UnicodeDisplayName>
<TimeZone>LOCAL</TimeZone>
<Pin></Pin>
</AccountUserInfo>
<Status>
<SubscriberStatus>Active</SubscriberStatus>
<InterceptAnnouncement>None</
InterceptAnnouncement>
<NewServiceId></NewServiceId>
</Status>
<ConnectionInfo>
<IPPhone>
<Name>5619551110</Name>
<Port>5060</Port>
<Register>false</Register>
<TimeToLive>-1</TimeToLive>
<MaxSessions>0</MaxSessions>
<Attributes>
MediaReDirectionAllowed>false</
A31003-H80A0-T101-1-7618, 11/2021
soap_messages.fm
Sample Messages
<MediaReDirectionAllowed>false</
<OverrideIRMCodecRestrictions>false</
OverrideIRMCodecRestrictions>
</Attributes>
<AssociatedSipEndpointName></
AssociatedSipEndpointName>
<LooseRoutingURI></LooseRoutingURI>
<SubscriberLicenseType>UndefinedSubscriberLicense</
SubscriberLicenseType>
<SIPSecurity>
<SrtpSupport>SrtpDisabled</SrtpSupport>
</SIPSecurity>
</IPPhone>
</ConnectionInfo>
<QualityOfService>
<QOSClass>
<QOSClassMode>TOS</QOSClassMode>
<QOSValue>0</QOSValue>
</QOSClass>
<QOSPrimary>
<Codec>None</Codec>
<PacketizationPeriod>0</PacketizationPeriod>
<TypeOfService>0</TypeOfService>
<ResourceReservation>BestEffort</
ResourceReservation>
</QOSPrimary>
<QOSSecondary>
<Codec>None</Codec>
</QOSSecondary>
<QOSTertiary>
<Codec>None</Codec>
</QOSTertiary>
<QOSFourth>
<Codec>None</Codec>
</QOSFourth>
</QualityOfService>
<InterExchange>
<PIC1></PIC1>
<PIC2></PIC2>
<PIC3></PIC3>
A31003-H80A0-T101-1-7618, 11/2021
soap_messages.fm
Sample Messages
<PIC4></PIC4>
</InterExchange>
<KeysetInfo>
<KeysetUse>KeysetNone</KeysetUse>
</KeysetInfo>
<SubscriberAuditInfo>
<InitialProvTOY>2008-07-01T10:30:03</
InitialProvTOY>
<LastOpProvTOY>2008-07-01T10:30:03</
LastOpProvTOY>
<LastOpId>as</LastOpId>
</SubscriberAuditInfo>
<ListOfFeatures>
<CfMCT>
<Subscribed>SwitchWide</Subscribed>
</CfMCT>
</ListOfFeatures>
<SubMlhgInfo>
<MlhgOwner>false</MlhgOwner>
</SubMlhgInfo>
</PrimaryDnInfo>
</unsp:GetSubscriberResult>
</SOAP-ENV:Body>
29.3.4 Update Subscriber Features Sample

Messages
29.3.4.1 Update Subscriber Features Request
The following SOAP request will assign the Call Forwarding Busy (CFB)
service feature to a subscriber:
POST / HTTP/1.0
related, text/*
Host: 10.77.14.10:8767
Pragma: no-cache
SOAPAction: ""
<soapenv:Body>
<ns1:UpdateSubscriberFeatures
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/
encoding/" xmlns:ns1="urn:siemens-hiq8000">
<ListOfFeatures>
<CfAC xsi:nil="true"/>
<CfACR xsi:nil="true"/>
A31003-H80A0-T101-1-7618, 11/2021
soap_messages.fm
Sample Messages
<CfAR xsi:nil="true"/>
<CfACCB xsi:nil="true"/>
<CfAcctCode xsi:nil="true"/>
<CfAuthCode xsi:nil="true"/>
<CfBgCNAM xsi:nil="true"/>
<CfBgCPU xsi:nil="true"/>
<CfBgCT xsi:nil="true"/>
<CfBgDAPPS xsi:nil="true"/>
<CfBgDNPPS xsi:nil="true"/>
<CfBLV xsi:nil="true"/>
<CfCCW xsi:nil="true"/>
<CfCFB>
<Subscribed>AddReplace</Subscribed>
<SubActivatable>None</SubActivatable>
<DestServiceIdSubControllable>None</
DestServiceIdSubControllable>
<CFCourtesyCallBehavior>NoCourtesyCall</
CFCourtesyCallBehavior>
<Enabled>false</Enabled>
<ServiceId></ServiceId>
<CFNotifyCallingParty>CfNotifyCallingPtyNone</
CFNotifyCallingParty>
<NotifySubCallFwdActive>false</
NotifySubCallFwdActive>
<Local xsi:nil="true"/>
</CfCFB>
<CfCFDA xsi:nil="true"/>
<CfCFV xsi:nil="true"/>
<CfCHLD xsi:nil="true"/>
<CfCIDCW xsi:nil="true"/>
<CfCIDS xsi:nil="true"/>
<CfCISNAME xsi:nil="true"/>
<CfCISNUM xsi:nil="true"/>
<CfCNAB xsi:nil="true"/>
<CfCNAM xsi:nil="true"/>
<CfCND xsi:nil="true"/>
<CfCNDB xsi:nil="true"/>
<CfCPK xsi:nil="true"/>
<CfCT xsi:nil="true"/>
<CfCSTA xsi:nil="true"/>
<CfLONR xsi:nil="true"/>
<CfLINR xsi:nil="true"/>
<CfCCBS xsi:nil="true"/>
<CfCCNR xsi:nil="true"/>
<CfCOLR xsi:nil="true"/>
<CfCW xsi:nil="true"/>
<CfDAPPS xsi:nil="true"/>
<CfDNPPS xsi:nil="true"/>
<CfEACR xsi:nil="true"/>
<CfECF xsi:nil="true"/>
<CfHotDesk xsi:nil="true"/>
<CfIN xsi:nil="true"/>
<CfMCT xsi:nil="true"/>
<CfMOH xsi:nil="true"/>
<CfONS xsi:nil="true"/>
<CfPRES xsi:nil="true"/>
<CfRACF xsi:nil="true"/>
<CfRCF xsi:nil="true"/>
<CfRFA xsi:nil="true"/>
<CfSCA xsi:nil="true"/>
<CfSCF xsi:nil="true"/>
<CfSCR xsi:nil="true"/>
A31003-H80A0-T101-1-7618, 11/2021
soap_messages.fm
Sample Messages
<CfSERRNG xsi:nil="true"/>
<CfSILMA xsi:nil="true"/>
<CfSILMS xsi:nil="true"/>
<CfSPCALL xsi:nil="true"/>
<CfSR xsi:nil="true"/>
<CfSRS xsi:nil="true"/>
<CfTRS xsi:nil="true"/>
<CfTWC xsi:nil="true"/>
<CfVM xsi:nil="true"/>
</ListOfFeatures>
</ns1:UpdateSubscriberFeatures>
29.3.4.2 Update Subscriber Features Response

HTTP/1.1 200 OK
Server: gSOAP/2.7
Content-Length: 624
Connection: close
hiq8000">
<SOAP-ENV:Body>
</SOAP-ENV:Body>
29.3.5 Update Subscriber PIC Sample

Messages
29.3.5.1 Update Subscriber PIC Request
The following message will change the subscriber's interlata and

international carrier (PIC1):
POST / HTTP/1.0
A31003-H80A0-T101-1-7618, 11/2021
soap_messages.fm
Sample Messages
related, text/*
Host: 10.77.14.10:8767
Pragma: no-cache
SOAPAction: ""
Content-Length: 529
<soapenv:Body>
<ns1:UpdateSubscriberPICs
<InterExchange>
<PIC1>0110</PIC1>
<PIC2></PIC2>
<PIC3></PIC3>
<PIC4></PIC4>
</InterExchange>
</ns1:UpdateSubscriberPICs>
29.3.5.2 Update Subscriber PIC Response

HTTP/1.1 200 OK
Server: gSOAP/2.7
Content-Length: 624
Connection: close
hiq8000">
<SOAP-ENV:Body>
</SOAP-ENV:Body></SOAP-ENV:Envelope>
A31003-H80A0-T101-1-7618, 11/2021
soap_messages.fm
Sample Messages
29.3.6 Update Subscriber Account

Management Info Sample Messages
29.3.6.1 Update Subscriber Account Management

Info Request
The following message will change the subscriber's Account ID and

Billing ID:
POST / HTTP/1.0
related, text/*
Host: 10.77.14.10:8767
Pragma: no-cache
SOAPAction: ""
Content-Length: 857
<soapenv:Body>
<ns1:UpdateSubscriberAccountMgtInfo
<AccountMgtInfo>
<AccountId>account6559</AccountId>
<BillingId>5619556559</BillingId>
<ExternalDNFlag xsi:nil="true"/>
<CountryCodeLen xsi:nil="true"/>
<FeatureProfileId>
<FeatureProfileName xsi:nil="true"/>
<BGName xsi:nil="true"/>
</FeatureProfileId>
<NumberPlanName></NumberPlanName>
</AccountMgtInfo>
</ns1:UpdateSubscriberAccountMgtInfo>
A31003-H80A0-T101-1-7618, 11/2021
soap_messages.fm
Sample Messages
29.3.6.2 Update Subscriber Account Management

Info Response

HTTP/1.1 200 OK
Server: gSOAP/2.7
Content-Length: 624
Connection: close
hiq8000">
<SOAP-ENV:Body>
</SOAP-ENV:Body>
29.3.7 Update Subscriber Account User Info

Sample Messages
29.3.7.1 Update Subscriber Account User Info

Request
The following message will change the subscriber's PIN:
POST / HTTP/1.0
related, text/*
Host: 10.77.14.10:8767
Pragma: no-cache
SOAPAction: ""
Content-Length: 625
<soapenv:Body>
<ns1:UpdateSubscriberAccountUserInfo
A31003-H80A0-T101-1-7618, 11/2021
soap_messages.fm
Sample Messages
<AccountUserInfo>
<TimeZone>LOCAL</TimeZone>
<Pin>5432</Pin>
</AccountUserInfo>
</ns1:UpdateSubscriberAccountUserInfo>
29.3.7.2 Update Subscriber Account User Info

Response

HTTP/1.1 200 OK
Server: gSOAP/2.7
Content-Length: 624
Connection: close
hiq8000">
<SOAP-ENV:Body>
</SOAP-ENV:Body>
29.3.8 Update Subscriber Status Sample

Messages
29.3.8.1 Update Subscriber Status Request
The following message will change the subscriber's status to Blocked:
POST / HTTP/1.0
A31003-H80A0-T101-1-7618, 11/2021
soap_messages.fm
Sample Messages

related, text/*
Host: 10.77.14.10:8767
Pragma: no-cache
SOAPAction: ""
Content-Length: 490
<soapenv:Body>
<ns1:UpdateSubscriberStatus
<SubscriberStatus>Blocked</SubscriberStatus>
</ns1:UpdateSubscriberStatus>
29.3.8.2 Update Subscriber Status Response

HTTP/1.1 200 OK
Server: gSOAP/2.7
Content-Length: 624
Connection: close
hiq8000">
<SOAP-ENV:Body>
</SOAP-ENV:Body>
A31003-H80A0-T101-1-7618, 11/2021
soap_messages.fm
Sample Messages
29.3.9 Update Subscriber Connection Info

Sample Messages
29.3.9.1 Update Subscriber Connection Info Request
The following message will change the subscriber's Max Sessions to 6:
POST / HTTP/1.0
related, text/*
Host: 10.77.14.10:8767
Pragma: no-cache
SOAPAction: ""
Content-Length: 959
<soapenv:Body>
<ns1:UpdateConnectionInfo
<ConnectionUpdateRequest>
<IPPhoneUpdateInfo>
<IPAddr xsi:nil="true"/>
<Port>5060</Port>
<Register xsi:nil="true"/>
<TimeToLive xsi:nil="true"/>
<MaxSessions>6</MaxSessions>
<SIPSecurity>
<Realm></Realm>
<UserName></UserName>
<Password></Password>
<Scheme>digest-authentication</Scheme>
<SrtpSupport>SrtpEnabled</SrtpSupport>
</SIPSecurity>
<Attributes>
<MediaReDirectionAllowed>false</
<OverrideIRMCodecRestrictions>false<
/OverrideIRMCodecRestrictions>
</Attributes>
<AssociatedSipEndpointName xsi:nil="true"/>
</IPPhoneUpdateInfo>
<MGCPPhoneUpdateInfo xsi:nil="true"/>
A31003-H80A0-T101-1-7618, 11/2021
soap_messages.fm
Sample Messages
<H323TermUpdateInfo xsi:nil="true"/>
</ConnectionUpdateRequest>
</ns1:UpdateConnectionInfo>
29.3.9.2 Update Subscriber Connection Info

Response

HTTP/1.1 200 OK
Server: gSOAP/2.7
Content-Length: 624
Connection: close
hiq8000">
<SOAP-ENV:Body>
</SOAP-ENV:Body>
29.3.10 Update Subscriber DN Sample

Messages
29.3.10.1 Update Subscriber DN Request
The following message will change the subscriber's DN.
POST / HTTP/1.0
related, text/*
Host: 10.77.14.10:8767
Pragma: no-cache
SOAPAction: ""
A31003-H80A0-T101-1-7618, 11/2021
soap_messages.fm
Sample Messages
Content-Length: 571
<soapenv:Body>
<ns1:UpdateSubscriberDn soapenv:encodingStyle="http:/
/schemas.xmlsoap.org/soap/encoding/"
<DnChangeRequest>
<InterceptAnnouncement>NumberChange</
InterceptAnnouncement>
<NewServiceId>5619556568</NewServiceId>
</DnChangeRequest>
</ns1:UpdateSubscriberDn>
29.3.10.2 Update Subscriber DN Response

HTTP/1.1 200 OK
Server: gSOAP/2.7
Content-Length: 624
Connection: close
hiq8000">
<SOAP-ENV:Body>
</SOAP-ENV:Body>
29.3.10.3 Delete Subscriber Request
The following message will delete the specified subscriber:
POST / HTTP/1.0
A31003-H80A0-T101-1-7618, 11/2021
soap_messages.fm
Sample Messages
related, text/*
Host: 10.77.14.10:8767
Pragma: no-cache
SOAPAction: ""
Content-Length: 434
<soapenv:Body>
<ns1:DeleteSubscriber soapenv:encodingStyle="http://
</ns1:DeleteSubscriber>
29.3.10.4 Delete Subscriber Response

HTTP/1.1 200 OK
Server: gSOAP/2.7
Content-Length: 624
Connection: close
hiq8000">
<SOAP-ENV:Body>
</SOAP-ENV:Body>
A31003-H80A0-T101-1-7618, 11/2021
soap_messages.fm
Sample Messages
29.3.11 Get COS List Sample Messages
29.3.11.1 Get COS List Request
The following message will retrieve the list of Class Of Service

(COS) values defined on the system:
POST / HTTP/1.0
related, text/*
Host: 10.77.14.10:8767
Pragma: no-cache
SOAPAction: ""
Content-Length: 529
<SOAP-ENV:Body>
<unsp:GetCOSList>
</unsp:GetCOSList>
</SOAP-ENV:Body>
29.3.11.2 Get COS List Response
HTTP/1.1 200 OK
Server: gSOAP
<ResultCode>0
<ResultText2>
<ResultText3>
<ResultText4>
<?xml>
<SOAP-ENV:Envelope>
<SOAP-ENV:Body>
<unsp:GetCOSListResult>
<Result>
</Result>
<GetCOSListData>
<COS>FGDIN</COS>
<COS>Ordinary</COS>
<COS>Prison</COS>
A31003-H80A0-T101-1-7618, 11/2021
soap_messages.fm
Sample Messages
<COS>Hotel</COS>
<COS>Hospital</COS>
<COS>OptrScreenReq</COS>
<COS>OpenScapeApp</COS>
</GetCOSListData>
</unsp:GetCOSListResult>
</SOAP-ENV:Body>
A31003-H80A0-T101-1-7618, 11/2021
soap_FeatureListDat.fm
FeatureList.dat
30 FeatureList.dat
The Unify platform software is delivered into a number of different
solutions (OpenScape Voice, HiPath 4200, HiPath 4000). The features
supported on these solutions can differ. The processing of these
features by the SOAP Server is controlled using a combination of the
Node.cfg (RTP parms) and a flat file called FeatureList.dat.
The FeatureList.dat file is used to validate supported features (when

assigning features) and in the GetFeatureList (Advertising features
available on the system). The OpenScape Voice Assistant uses the
GetFeatureList to determine what features to display on the screens.
Below outlines and defines the format and processing of this file.
The file is a comma delimited, keyword associated file, with the

following syntax for each line:
FeatureName,FeatureNumericId,”Feature
Description”condition1=boolean, Condition2=bool
where:
• FeatureName is the WSDL supported featurename (CfAR,CfCW...)
• FeatureNumericId is a unique number for use by the OpenScape

Voice Assistant.
• Feature Description is the name of the feature.
• Conditions = <See Table 1001 for appropriate setting for each

keyword.>
Example:
Keyword Setting
sub is true if the feature is assignable to a residential subscriber
bg is true if the feature is assignable to a business group
bgl is true if the feature is assignable to a business group subscriber
ep is true if the feature is assignable to an endpoint profile
fp_centrex is true if the feature is assignable to a centrex feature profile
fp_residential is true if the feature is assignable to a residential feature profile
sip is true if the feature is assignable to a subscriber with a SIP phone
mgcp is true if the feature is assignable to a subscriber that is connected via MGCP. Not for
OpenScape Voice.
ansi is true when the feature is assignable in the US market
etsi is true when the feature is assignable in the world market
Table 1001 FeatureList.dat Keyword and Settings (Seite 1 von 2)
A31003-H80A0-T101-1-7618, 11/2021
soap_FeatureListDat.fm
FeatureList.dat
Keyword Setting
enterprise is true if the feature is assignable in the enterprise environment
mlhg_pilot is true if the feature is assignable to the pilot of a mlhg.
Table 1001 FeatureList.dat Keyword and Settings (Seite 2 von 2)
CfCND,11,"Incoming Number Delivery", sub=1, bg=0, bgl=1, ep=0,

fp_centrex=1, fp_residential=1, sip=1, mgcp=1, ansi=1, etsi=1,
noss7=1, carrier=1, enterprise=1, mlhg_pilot=1, teen=0
When assigning a feature to an entity, all applicable flags for that entity
and the environment are checked. All applicable flags must be set to
true for the feature to be applied.
If the environment is Enterprise, the Ansi / Etsi flags do not apply.
For information about the RTP parameters that are used to determine
the solution and environment (Carrier/Enterprise and ANSI/ETSI in
particular), refer to Chapter 28, “RTP Parameters Relevant to
Subscriber Provisioning”.
A31003-H80A0-T101-1-7618, 11/2021
soap_time_zones_appx.fm
Time Zones
31 Time Zones
The subscriber may belong to a specific time zone. This time zone
defines how the subscriber's time-dependent services work. In general,
most subscribers will be in the system's local time zone, but SIP phones
can be anywhere and the system can border a time zone edge and
serve multiple time zones.
If no time zone is specified, the subscriber is treated as being in the

system’s local time zone.
The possible time zone values are as follows.
Africa/Abidjan America/Vancouver Europe/Copenhagen

Africa/Accra America/Virgin Europe/Dublin
Africa/Addis_Ababa America/Whitehorse Europe/Gibraltar
Africa/Algiers America/Winnipeg Europe/Helsinki
Africa/Asmera America/Yakutat Europe/Istanbul
Africa/Bamako America/Yellowknife Europe/Kaliningrad
Africa/Bangui Antarctica/Casey Europe/Kiev
Africa/Banjul Antarctica/Davis Europe/Lisbon
Africa/Bissau Antarctica/DumontDUrville Europe/Ljubljana
Africa/Blantyre Antarctica/Mawson Europe/London
Africa/Brazzaville Antarctica/McMurdo Europe/Luxembourg
Africa/Bujumbura Antarctica/Palmer Europe/Madrid
Africa/Cairo Antarctica/South_Pole Europe/Malta
Africa/Casablanca Antarctica/Syowa Europe/Minsk
Africa/Ceuta Antarctica/Vostok Europe/Monaco
Africa/Conakry Arctic/Longyearbyen Europe/Moscow
Africa/Dakar Asia/Aden Europe/Nicosia
Africa/Dar_es_Salaam Asia/Almaty Europe/Oslo
Africa/Djibouti Asia/Amman Europe/Paris
Africa/Douala Asia/Anadyr Europe/Prague
Africa/El_Aaiun Asia/Aqtau Europe/Riga
Africa/Freetown Asia/Aqtobe Europe/Rome
Africa/Gaborone Asia/Ashgabat Europe/Samara
Africa/Harare Asia/Ashkhabad Europe/San_Marino
Africa/Johannesburg Asia/Baghdad Europe/Sarajevo
Africa/Kampala Asia/Bahrain Europe/Simferopol
Africa/Khartoum Asia/Baku Europe/Skopje
Africa/Kigali Asia/Bangkok Europe/Sofia
A31003-H80A0-T101-1-7618, 11/2021
Time Zones
Africa/Kinshasa Asia/Beirut Europe/Stockholm

Africa/Lagos Asia/Bishkek Europe/Tallinn
Africa/Libreville Asia/Brunei Europe/Tirane
Africa/Lome Asia/Calcutta Europe/Tiraspol
Africa/Luanda Asia/Choibalsan Europe/Uzhgorod
Africa/Lubumbashi Asia/Chongqing Europe/Vaduz
Africa/Lusaka Asia/Chungking Europe/Vatican
Africa/Malabo Asia/Colombo Europe/Vienna
Africa/Maputo Asia/Dacca Europe/Vilnius
Africa/Maseru Asia/Damascus Europe/Warsaw
Africa/Mbabane Asia/Dhaka Europe/Zagreb
Africa/Mogadishu Asia/Dili Europe/Zaporozhye
Africa/Monrovia Asia/Dubai Europe/Zurich
Africa/Nairobi Asia/Dushanbe GB
Africa/Ndjamena Asia/Gaza GB-Eire
Africa/Niamey Asia/Harbin GMT
Africa/Nouakchott Asia/Hong_Kong GMT+0
Africa/Ouagadougou Asia/Hovd GMT+1
Africa/Porto-Novo Asia/Irkutsk GMT+10
Africa/Sao_Tome Asia/Istanbul GMT+11
Africa/Timbuktu Asia/Jakarta GMT+12
Africa/Tripoli Asia/Jayapura GMT+13
Africa/Tunis Asia/Jerusalem GMT+2
Africa/Windhoek Asia/Kabul GMT+3
America/Adak Asia/Kamchatka GMT+4
America/Anchorage Asia/Karachi GMT+5
America/Anguilla Asia/Kashgar GMT+6
America/Antigua Asia/Katmandu GMT+7
America/Araguaina Asia/Krasnoyarsk GMT+8
America/Aruba Asia/Kuala_Lumpur GMT+9
America/Asuncion Asia/Kuching GMT-0
America/Atka Asia/Kuwait GMT-1
America/Barbados Asia/Macao GMT-10
America/Belem Asia/Macau GMT-11
America/Belize Asia/Magadan GMT-12
America/Boa_Vista Asia/Makassar GMT-2
America/Bogota Asia/Manila GMT-3
America/Boise Asia/Muscat GMT-4
America/Buenos_Aires Asia/Nicosia GMT-5
A31003-H80A0-T101-1-7618, 11/2021
Time Zones
America/Cambridge_Bay Asia/Novosibirsk GMT-6

America/Cancun Asia/Omsk GMT-7
America/Caracas Asia/Oral GMT-8
America/Catamarca Asia/Phnom_Penh GMT-9
America/Cayenne Asia/Pontianak GMT0
America/Cayman Asia/Pyongyang Greenwich
America/Chicago Asia/Qatar Hongkong
America/Chihuahua Asia/Qyzylorda HST
America/Cordoba Asia/Rangoon Iceland
America/Costa_Rica Asia/Riyadh Indian/Antananarivo
America/Cuiaba Asia/Riyadh87 Indian/Chagos
America/Curacao Asia/Riyadh88 Indian/Christmas
America/Danmarkshavn Asia/Riyadh89 Indian/Cocos
America/Dawson Asia/Saigon Indian/Comoro
America/Dawson_Creek Asia/Sakhalin Indian/Kerguelen
America/Denver Asia/Samarkand Indian/Mahe
America/Detroit Asia/Seoul Indian/Maldives
America/Dominica Asia/Shanghai Indian/Mauritius
America/Edmonton Asia/Singapore Indian/Mayotte
America/Eirunepe Asia/Taipei Indian/Reunion
America/El_Salvador Asia/Tashkent Iran
America/Ensenada Asia/Tbilisi Israel
America/Fort_Wayne Asia/Tehran Jamaica
America/Fortaleza Asia/Tel_Aviv Japan
America/Glace_Bay Asia/Thimbu Kwajalein
America/Godthab Asia/Thimphu Libya
America/Goose_Bay Asia/Tokyo MET
America/Grand_Turk Asia/Ujung_Pandang Mexico/BajaNorte
America/Grenada Asia/Ulaanbaatar Mexico/BajaSur
America/Guadeloupe Asia/Ulan_Bator Mexico/General
America/Guatemala Asia/Urumqi Mideast/Riyadh87
America/Guayaquil Asia/Vientiane Mideast/Riyadh88
America/Guyana Asia/Vladivostok Mideast/Riyadh89
America/Halifax Asia/Yakutsk MST
America/Havana Asia/Yekaterinburg MST7MDT
America/Hermosillo Asia/Yerevan Navajo
America/Indiana/Indianapolis Atlantic/Azores NZ
America/Indiana/Knox Atlantic/Bermuda NZ-CHAT
America/Indiana/Marengo Atlantic/Canary Pacific/Apia
A31003-H80A0-T101-1-7618, 11/2021
Time Zones
America/Indiana/Vevay Atlantic/Cape_Verde Pacific/Auckland

America/Indianapolis Atlantic/Faeroe Pacific/Chatham
America/Inuvik Atlantic/Jan_Mayen Pacific/Easter
America/Iqaluit Atlantic/Madeira Pacific/Efate
America/Jamaica Atlantic/Reykjavik Pacific/Enderbury
America/Jujuy Atlantic/South_Georgia Pacific/Fakaofo
America/Juneau Atlantic/St_Helena Pacific/Fiji
America/Kentucky/Louisville Atlantic/Stanley Pacific/Funafuti
America/Kentucky/Monticello Australia/ACT Pacific/Galapagos
America/Knox_IN Australia/Adelaide Pacific/Gambier
America/La_Paz Australia/Brisbane Pacific/Guadalcanal
America/Lima Australia/Broken_Hill Pacific/Guam
America/Los_Angeles Australia/Canberra Pacific/Honolulu
America/Louisville Australia/Darwin Pacific/Johnston
America/Maceio Australia/Broken_Hill Pacific/Kiritimati
America/Managua Australia/Canberra Pacific/Kosrae
America/Manaus Australia/Hobart Pacific/Kwajalein
America/Martinique Australia/LHI Pacific/Majuro
America/Mazatlan Australia/Lindeman Pacific/Marquesas
America/Mendoza Australia/Lord_Howe Pacific/Midway
America/Menominee Australia/Melbourne Pacific/Nauru
America/Merida Australia/North Pacific/Niue
America/Mexico_City Australia/NSW Pacific/Norfolk
America/Miquelon Australia/Perth Pacific/Noumea
America/Monterrey Australia/Queensland Pacific/Pago_Pago
America/Montevideo Australia/South Pacific/Palau
America/Montreal Australia/Sydney Pacific/Pitcairn
America/Montserrat Australia/Tasmania Pacific/Ponape
America/Nassau Australia/Victoria Pacific/Port_Moresby
America/New_York Australia/West Pacific/Rarotonga
America/Nipigon Australia/Yancowinna Pacific/Saipan
America/Nome Brazil/Acre Pacific/Samoa
America/Noronha Brazil/DeNoronha Pacific/Tahiti
America/North_Dakota/Center Brazil/East Pacific/Tarawa
America/Panama Brazil/West Pacific/Tongatapu
America/Pangnirtung Canada/Atlantic Pacific/Truk
America/Paramaribo Canada/Central Pacific/Wake
America/Phoenix Canada/East-Saskatchewan Pacific/Wallis
America/Port-au-Prince Canada/Eastern Pacific/Yap
A31003-H80A0-T101-1-7618, 11/2021
Time Zones
America/Port_of_Spain Canada/Mountain Poland

America/Porto_Acre Canada/Newfoundland Portugal
America/Porto_Velho Canada/Pacific PRC
America/Puerto_Rico Canada/Saskatchewan PST8PDT
America/Rainy_River Canada/Yukon ROK
America/Rankin_Inlet CET Singapore
America/Recife Chile/Continental Turkey
America/Regina Chile/EasterIsland UCT
America/Rio_Branco CST6CDT Universal
America/Rosario Cuba US/Alaska
America/Santiago EET US/Aleutian
America/Santo_Domingo Egypt US/Arizona
America/Sao_Paulo Eire US/Central
America/Scoresbysund EST US/East-Indiana
America/Shiprock EST5EDT US/Eastern
America/St_Johns Europe/Amsterdam US/Hawaii
America/St_Kitts Europe/Andorra US/Indiana-Starke
America/St_Lucia Europe/Athens US/Michigan
America/St_Thomas Europe/Belfast US/Mountain
America/St_Vincent Europe/Belgrade US/Pacific
America/Swift_Current Europe/Berlin US/Pacific-New
America/Tegucigalpa Europe/Bratislava US/Samoa
America/Thule Europe/Brussels UTC
America/Thunder_Bay Europe/Bucharest W-SU
America/Tijuana Europe/Budapest WET
America/Tortola Europe/Chisinau Zulu
A31003-H80A0-T101-1-7618, 11/2021
soap_test tools.fm
Test Tools
TestSendSoapReq
32 Test Tools
The following command line test tools are delivered onto the system.
32.1 TestSendSoapReq
This utility parses an input file, sends the request to a soap server, and
prints out the resultCode structure or dumps out the xml response.
Parameters:
[-h=Host] -p=port -f=xmlfile [-t=testcasename] [-trace]
If host is not specified, localhost (127.0.0.1) is defaulted to.
Port is the port number on which the SOAP server is listening on.
Xml file is a file that contains one or more xml messages. Each xml
message is encapsulated with the <TEST name> and </TEST name>
tags.
Testcasename is the testcase from the file to send. If omitted, all

testcases are sent.
Trace indicates that the response should be printed out.
Sample xmlfile:
// comments can occur anytime before or after testcases (but not in
the middle of).
# The host and length information in the http header portion are
ignored.
<TEST GetVersion>
POST /cgi-bin/CL_Server HTTP/1.0
Host: 10.76.1.80
SOAPAction: ""
<SOAP-ENV:Envelope
envelope/"
encoding/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
A31003-H80A0-T101-1-7618, 11/2021
soap_test tools.fm
Test Tools
TestSoap.ksh (soapCli)
xmlns:unsp="urn:siemens-hiq8000"
SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/
encoding/">
<SOAP-ENV:Body>
<unsp:GetVersion>
</unsp: GetVersion >
</SOAP-ENV:Body>
</TEST GetVersion >
32.2 TestSoap.ksh (soapCli)

This utility prompts the operator (similar to the CLI) to issue different
SOAP provisioning requests on and to the local soap server. It can be
used to exercise all of the different WSDL interfaces.
A31003-H80A0-T101-1-7618, 11/2021
soap_test tools.fm
Test Tools
TestSoap.ksh (soapCli)
A31003-H80A0-T101-1-7618, 11/2021
soap_priority processing.fm
Performance
33 Performance
The soapServer will process requests on multiple ports. The numbers
defined in this section apply to requests on one port only and do not
take into account the overlap improvement of requests being
distributed to multiple ports.
Multiple instances of SoapMassProv may also be executed

simultaneously. The numbers defined in this section apply to only a
single instance running. No performance numbers have been run
against soapMassProv. These times will be the same of better than the
times of soapServer.
The tests were performed on a single node development machine (Sun

1400 Netra) that is equivalently configured (same performance) as in
a customer environment - however there was no call load on the
system.
Jmeter was used to send repetitive requests and obtain timings,

although full tracing of the soapServer was enabled and a sampling of
the times was verified using the log file data. Table 1002 shows the
average amount of time the soapServer takes to completely process a
particular request. For example, creating a SIP subscriber takes an
average of 181 milliseconds.
Subscriber Request Subscriber Type Time

Create Subscriber
• No features
SIP 181 ms
• No BG Info
Get Subscriber Info

• One feature (CNAM)
SIP 103 ms
• No BG Info
Delete Subscriber
• One feature (CNAM)
SIP 287 ms
• No BG Info
Update Subscriber Features Add Single Feature (CNAM) 46 ms

Remove Single Feature (CNAM) 47 ms
Table 1002 Average Amount of Time to Process Requests
A31003-H80A0-T101-1-7618, 11/2021
Performance
Priority Processing and Congestion Controls
33.1 Priority Processing and Congestion Controls

The subscriber provisioning processes operate at a lower priority that
most other processes on the system. This is so that the impact to call
traffic is minimized. The priority is defined in an RTP configuration
parameter as defined in Chapter 28, “RTP Parameters Relevant to
Subscriber Provisioning”.
The subscriber provisioning processes also participate in congestion

control in the event that the system becomes overloaded. The
OpenScape Voice system has three congestion levels dependent on
CPU load; typically the thresholds are:
• Minor (Level 1): 90% CPU load
• Major (Level 2): 95% CPU load
• Critical (Level 3) 98% CPU load
When the resources of the system become highly used, subscriber

provisioning will start rejecting provisioning requests. Table 1003
defines the requests and the congestion level at which they are
rejected by the SOAP Server. Commands not included in this list are not
rejected; for example, GetVersion, which is expected to have negligible
impact on processor usage, does not check for congestion before
handling the request. The requests listed below are rejected if the
congestion level is the indicated level or higher.
The import and export processes soapMassProv and soapExport

internally call the same common functions that are called when SOAP
requests are handled by the SOAP Server. Therefore, they are subject
to the same behavior as listed above, where applicable. For example,
if the congestion level is 1, a CSM command in a soapMassProv
command file would be rejected because it calls the CreateSubscriber
function. The export of subscribers using soapExport would fail if the
congestion level is 2 or higher, since it internally calls
GetSubscriberList.
The Subscriber Management Scheduling process (can be referred to as

the Job Scheduler) also takes steps to avoid interfering with higher-
priority system operations in case of overload conditions. The
submgtSchedule process checks congestion levels periodically during
its operation. By default, the check period is 30 seconds and is
configurable via the Srx/Subp/OverLoadCheckPeriod RTP configuration
parameter. If an overload condition is detected, the submgtSchedule
process suspends processing of the current job and sleeps for 30, 60,
or 120 seconds, depending on whether the congestion level is 1, 2, or
3 respectively.
A31003-H80A0-T101-1-7618, 11/2021
Performance
Provisioning Request Congestion Level

GetSubscriberInfo (and derivatives) 2
GetSubscriberList 2
DeleteSubscriber 1
DisconnectSubscriber 2
UpdateSubscriberAccountInfo 2
UpdateSubscriberAccountMgtInfo 2
UpdateSubscriberCapabilities 2
UpdateSubscriberDn 2
UpdateSubscriberFeatures 2
UpdateSubscriberPIC 2
UpdateSubscriberQOS 2
UpdateSubscriberStatus 2
UpdateConnectionInfo 2
CreateMlhg 1
ModifyMlhgInfo 1
DeleteMlhg 1
GetMlhgInfo 2
AddSubToMlhg 2
ModifyMlhgTermInfo 2
DeleteMlhgTerm 2
GetMlhgTMData 2
CreateEpProfile 1
GetEpProfile 2
GetEpList 2
DeleteEpProfile 1
UpdateEpFeatures 2
UpdateEpMgtInfo 2
UpdateEpPICs 2
UpdateEpQos 2
CreateBG 1
GetGBInfo 2
GetGBList 2
DeleteBG 1
Table 1003 Requests and Congestion Levels(Seite 1 von 4)
A31003-H80A0-T101-1-7618, 11/2021
Performance

UpdateBGFeatures 2
UpdateBGParms 2
AddBGMainNumber 2
DeleteBGMainNumber 2
UpdateBGMainNumber 2
GetBGAttendantNumbers 2
UpdateKeysetInfo 2
GetKeysetPrimaryList 2
CreatePrefixAccessCode 1
GetPrefixAccessCode 2
DeletePrefixAccessCode 1
ModifyPrefixAccessCode 2
GetDestServiceList 2
CreatePNPLocationCode 1
GetPNPLocationCode 2
DeletePNPLocationCode 1
ModifyPNPLocationCode 2
CreatePNPExtension 1
GetPNPExtension 2
DeletePNPExtension 1
ModifyPNPExtension 2
CreateDestCode 1
GetDestCode 2
DeleteDestCode 1
ModifyDestCode 2
GetDestinationList 2
CreateNumberPlan 1
GetNumberPlan 2
DeleteNumberPlan 1
CreateBgSubnet 1
A31003-H80A0-T101-1-7618, 11/2021
Performance

GetBgSubnetInfo 2
DeleteBgSubnet 1
UpdateBgSubnet 2
GetBgSubnetList 2
ModifyBgDept 1
GetBGDeptList 1
CreateAuthCode 1
GetAuthCode 1
DeleteAuthCode 1
GetAuthCodeList 2
AddContactList 1
GetContactList 2
DeleteContactList 2
CreateQOSProfile 1
GetQOSProfile 2
DeleteQOSProfile 1
UpdateQOSProfile 2
GetQOSProfileList 2
CreateFeatureProfile 1
GetFeatureProfile 2
DeleteFeatureProfile 1
UpdateFeatureProfile 2
GetFeatureProfileList 1
CreateGw 1
GetGwInfo 2
DeleteGw 1
UpdateGw 1
GetGwList 2
GetAssociatedSipEndpointList 2
GetInterceptList 2
A31003-H80A0-T101-1-7618, 11/2021
Performance

GetSupportedLanguageList 1
GetTombStoneSubscriberList 2
A31003-H80A0-T101-1-7618, 11/2021
Index
Index
Index
A call forwarding restrictions 470

access, CLI 40 call forwarding voice mail 436
account code 419 call pickup 438
AddBGMainNumber 482 called party name delivery 439
AddContactList 412 called party number delivery 439
AddSubToMlhg 714 calling name delivery (BG) 439
alarms 840 calling name delivery block 440
anonymous caller rejection 420 calling number delivery 440
attendant answering position 421 calling number delivery block 440
attendant numbers 65 CallingLocation
authentication methods 71 get list 116
AUTH_EP 71 CancelJob 739
authorization code 422 CfAcctCode – account code 419
CfACR – anonymous caller rejection 420
B CfAuthCode – authorization code 422
background jobs 736 CfBgCNAM – calling name delivery (BG) 439
BG only features CfBgCPU – call pickup 437
911 LIN administration 442 CfBgDR – BG distinctive ringing 444
attendant answering position 421 CfBgE911LIN – E911 LIN administration 442
BG distinctive ringing 444 CfBgHotDesk – hot desking (BG) 447
keyset operation 447 CfBgKS – keyset operation 447
silent monitoring 467 CfBgNBCPU – night bell CPU 421
traffic measurement 467 CfBgSILM – silent monitoring 467
BG parking lots 533 CfBgSPCALL – speed call (speed dial) (BG) 462
BG subnet E911 LIN administration 65 CfBgSPCALL – station speed call (BG) 460
branch offices 544, 548, 561 CfBgTM – traffic measurement 467
business group services 64 CfCCBS – completion of calls on busy
business groups subscriber 424
adding main number 482 CfCCNR – Completion of Calls on No Reply 424
authorization codes 518 CfCFB – call forward busy 431
concepts 63 CfCFD – call forward dependable 428
creating 480 CfCFDA – call forward no reply 433
departments 65, 495 CfCFID – call forward invalid 425
feature dependencies 46 CfCFR – call forwarding restrictions 470
parking lots 533 CfCFSIE – call forward system internal
subnet E911 LIN administration 65 external 425
subnets 499 CfCFV – call forward unconditional 429
traffic measurements 66 CfCIDS – outgoing caller ID suppression 439
updating 481 CfCISNAME – called party name delivery 439
CfCISNUM – called party number delivery 439
C CfCNAB – calling name delivery block 440
call forward busy 431 CfCNAM – incoming call name delivery 439
call forward LED indication 69 CfCND – calling number delivery 440
call forward no reply 433 CfCNDB – calling number delivery block 440
Call Forward System Internal External 425 CfCPS – call park to server 470
call forward unconditional 429 CfCSTA – CSTA for SimplyPhone 440
call forward unreachable 428 CfDND – do not disturb 445
A31003-H80A0-T101-1-7618, 11/2021
1047
Index
CfDTF – Deny Terminating Feature 442 CreateFeatureProfile 688

CfECF – enhanced call forward 444, 463 CreateMlhg 697
CfHotDesk – hot desking 446 CreateMlhgTerm 717
CfMCT – customer originated trace 441 CreatePnpExtension 620, 625, 627, 628, 630
CfMOH – music on hold 450 CreatePrefixAccessCode 600
CfONS – one number service 451 CreateRateArea 181
CfRACF – remote activation call forward 453 CreateSubscriber 342
CfRCF – remote call forward 453 creating
CfSCA – selective caller accept 454 BG authorization codes 518
CfSCF – selective call forward 455 business groups 480
CfSCR – selective caller reject 456 destination codes 588
CfSERRNG – serial ringing 457 hunt group terminals 717
CfSILM – silent monitoring 468 multiple hunt groups 697
CfSILMProtection – silent monitoring PNP extension 620, 625, 627, 628, 630
protection 468 prefix access codes 600
CfSILMTag – silent monitoring tag 469 CRM
CfSR – station restriction (BG) 459 See customer relationship management.
CfSRS – simultaneous ringing 458 CSTA for SimplyPhone 440
CfTRS – toll restrictions 465 customer originated trace 441
CfVM – call forwarding voice mail 436, 437 customer relationship management
CLI interface version support 42
See command line interface. required features 41
command line interface 40 required interface support 42
Common Community Groups Return Codes 563, standards support 42
570
completion of calls on busy subscriber 424 D
Completion of Calls on No Reply 424 Delete Class Of Restrictions 790
COS Delete DNM Conversion 676
get list 114 Delete DNM Definition 645
Create Class Of Restrictions 788 Delete DNM LocalToll 684
Create DNM Conversion 673 Delete DNM Modification 658
Create DNM Defintion 641 Delete DNM Normalization 668
Create DNM LocalToll 680 Delete DNM Prefix 635
Create DNM Modification 652 delete subscriber sample messages
Create DNM Normalization 664 delete subscriber request 1027
Create DNM Prefix 633 delete subscriber response 1028
Create DNM Prefix Input Fields 633 Delete Traffic Type 786, 832
Create Subscriber DeleteAuthCode 519
Language 368 DeleteBGDept 496
PublicPin 367 DeleteBgSubnet 510
create subscriber DeleteContactList 413
language 351 DeleteDestCode 595
PublicPin 351 DeleteDestination 179, 199
create subscriber sample messages DeleteEndpoint 173
create subscriber request 1010 DeleteFeatureProfile 690
create subscriber response 1013 DeleteMlhg 708
Create Traffic Type 783, 815 DeletePrefixAccessCode 610
CreateAuthCode 518 DeleteSubscriber 392
CreateBG 480 deleting
CreateDestCode 588 BG authorization code 519
CreateDestination 176, 195 BG departments 496
CreateEpProfile 722 BG subnet 510
A31003-H80A0-T101-1-7618, 11/2021
Index
destination codes 595 calling name delivery block 440

multiple hunt groups 708 calling number delivery 440
PNP location codes 618 calling number delivery block 440
prefix access codes 610 completion of calls on busy subscriber 424
departments 65 CRM 41
design considerations customer originated trace 441
CLI 40 enhanced call forward 463
CRM 41 hot desking 446
security 40 hot desking (BG) 447
sizing 40 incoming call name delivery 439
system requirements 40 keyset operation 69
traffic volumes 40 music on hold 450
destination codes 586 outgoing caller ID suppression 439
DisconnectSubscriber 394 remote activation call forward 453
display number definition table 58 remote call forward 453
display number modification table 61 selective call forward 455
display number prefix table 60 selective caller accept 454
DisplayDestination 180, 200, 202 selective caller reject 456
DisplayEndpoint 174 serial ringing 457
Do Not Disturb 445 silent monitoring 468
silent monitoring protection 468
E silent monitoring tag 469
E.164 number plan 66 simultaneous ringing 458
E911 LIN administration 65 station restrictions (BG) 459
end point profile 722 station speed call (BG) 460
enhanced call forward 444, 463 toll restrictions 465
error removing gold jobs alarm data 843 field data type 78
field definitions 79
F
feature profiles 44 G
Features general utility interfaces 109, 835
call forward invalid 425 get COS list sample messages
call forward system internal external 425 get COS list request 1029
completion of calls on no reply 424 get COS list response 1029
CSTA for SimplyPhone 440 Get Local CPU Members List 561, 562
enhanced call forward 444 get version sample messages
One Number Service 451 get version request 1009
Out Callers Prem Presentation 445 get version response 1010
features GetBGAttendantNumbers 491
account code 419 GetBGInfo 487
anonymous caller rejection 420 GetBGInfoByOptions 487
authorization code 422 GetBGList 488
business groups 421 GetConfigData 110
call forward busy 431 GetContactList 414
call forward no reply 433 GetDestCodeList 597
call forward unconditional 429 GetDestServiceList 600
call forwardig voice mail 436 GetEpInfo 731
call forwarding restrictions 470 GetEpInfoByRelease 733
call pickup 438 GetEPList 734
called party name delivery 439 GetFeatureList 109
called party number delivery 439 GetFeatureProfile 692
calling name delivery (BG) 439 GetFeatureProfileList 691
A31003-H80A0-T101-1-7618, 11/2021
1049
Index
GetJobInfo 736 keyset operation mode 69

GetJobList 738
GetJobListByOption 739 L
GetKeysetPrimaryList 391 location code 58
GetMlhgTMData 721
M
GetNumberPlanIDInfo 586
main numbers 64
GetNumberPlanList 584
MDR
GetPICList 115
See message detail recording.
GetPrefixAccessCodeList 612
media gateways 57
GetPrefixAccessCodeOne 615
media servers 544
GetSubInfoByRel 378
message detail recording 65
GetSubscriberInfo 361
Modify Class Of Restrictions 789
GetSubscriberInfoByOption 378
Modify DNM Conversion 674
GetSubscriberList 381
Modify DNM Definition 644, 656
GetTombStoneSubscriberList 389
Modify DNM LocalToll 683
GetVersion 109
Modify DNM Normalization 666
H Modify DNM Prefix 634
home DNs 70 Modify Traffic Type 785, 818
hot desking 446 ModifyDestCodeInfo 592
hot desking (BG) 447 ModifyDestination 178, 198
hunt groups modifying
overview 51 destination code information 592
phone services 696 hunt group terminal information 717
terminals 695 PNP extension 622
PNP location codes 617
I prefix access codes 605
importing subscriber data 849 ModifyMlhgTermInfo 717
incoming call name delivery 439 ModifyPnpExtension 622
InterceptList ModifyPrefixAccessCode 605
get 115, 116 music on hold 450
interface (WSDL) 73
interface release control 73 N
interface release control rules 73 Network Management Interfaces via SOAP 134
interface support 42 No_SVC 71
interface version support 42 number modification
interface WSDL rules 73 concepts 57
SOAP/XML interface 632
J
jobs 56 O
background 736 office codes 69
cancelling 739 One Number Service 451
retrieving a job list 738 OpenScape Voice Assistant
retrieving a job list by option 739 RTP Configuration Parameteres 975
retrieving information 736 optimized parameter 63
order entry screens 41
K originating numbering plan name
keyset information (FromNpld) 61
call forward LED indication 69 outgoing caller ID suppression 439
keyset use (enum) 67
line appearance 68 P
manual hold timer 68 paging 86
keyset operation (BG) 447 parameters
A31003-H80A0-T101-1-7618, 11/2021
Index
call forward LED indication 69 result text strings 973

display number modification table 61 ResultTOY 974
display number prefix table 60 retrieving
skip digit (SK) 59 a list of jobs 738
unique level (UL) 59 BG attendant numbers 491
parking lots 533 BG info by options 487
PNP Extension 620 BG list 488
PNPs BG-related information 487
See private number plans. 66 destination code list 597
prefix access codes 600 destination service list 600
prefix parameter 61 hunt group terminal data 721
primitive data definitions 78 individual prefix access codes 615
privacy type parameter 62 job information 736
private numbering plans jobs by option 739
concepts 66 numbering plan
location codes 616 information 586
SOAP/XML interfaces 522, 523 list 584
profile only subscribers 44 PNP location codes 619
public/private network access code (PNAC) prefix access code list 612
parameter 60 return code information 87
Q S
Query Class Of Restrictions 790 security 40
Query Class Of Restrictions Info List 791 selective call forward 455
Query COR Usage List 792 selective caller accept 454
Query DNM Conversion 677 selective caller reject 456
Query DNM Definition 647, 649, 659 serial ringing 457
Query DNM LocalToll 686 service activation code table 67
Query DNM Normalization 669 silent monitoring 468
Query DNM Prefix 637 silent monitoring protection 468
Query DNM PrefixList 639 silent monitoring tag 469
Query Traffic Type 787 simultaneous ringing 458
SIP endpoints 70
R SIP network servers 71
RateArea SIP phones connection 65
get list 115 sizing 40
recent change logging skip digit parameter 59
in SOAP export 50 SOAP messages 1008
in SOAP mass provisioning 50 SOAP server 23
in the SOAP server 48 process exit 840
remote activation call forward 453 process startup 841
remote call forward 453 SOAP/XML conventions 77
RemoveRateArea 182 Speed Call (Speed Dial) (BG) 462
removing old jobs 844 standards support 42
requirements station restrictions(BG) 459
CRM 41 station speed call (BG) 460
interface support 42 SubmgtSchedule process exit 842
system 40 subnet E911 LIN administration 65
web server 41 subscrber profile data 24
result code information 971 subscriber connection info messages
result codes 974 update subscriber connection info
result text settings 974 request 1025
A31003-H80A0-T101-1-7618, 11/2021
1051
Index
subscriber info sample messages update subscriber PIC request 1019

get subscriber info request 1014 update subscriber PIC response 1020
get subscriber info response 1014 update subscriber status sample messages
subscriber management mass provisioning update subscriber status request 1023
importing subscriber data 849 update subscriber status response 1024
subscriber provisioning 23, 971 UpdateBGStatus 481
Subscriber Provisioning Network Architecture UpdateBgSubnet 511
Layout 24 UpdateConnectionInfo 409
subscriber service interactions 24 UpdateEpCapabilities 729
subscribers UpdateEpFeatures 731
concepts 44 UpdateEpMgtInfo 726
subscribers profile only 44 UpdateEpPics 729
support UpdateFeatureProfile 689
interface version 42 UpdateKeysetInfo 401
standards 42 UpdateSubscriberAccountMgtInfo 394
supported subscribers 40 UpdateSubscriberAccountUserInfo 398
system requirements 40 UpdateSubscriberBGInfo 396
UpdateSubscriberDn 403
T UpdateSubscriberFeatureProfile 411
terminals 695 UpdateSubscriberFeatures 405
terminating numbering plan name (ToNpld) 61 UpdateSubscriberPICs 394
time zones 1033 UpdateSubscriberStatus 393
toll restrictions 465 Utilities
traffic measurements GetCallingLocationList 116
business groups 66 GetInterceptList 116
Traffic Types and Classes of Restrictions 783, GetRateAreaList 115
813 TranslateDialedDigits 124
traffic volumes 40 utilities
TranslateDialedDigits 124 Get COSList 114
type of number (TON) parameter 60, 62 GetCallingLocationList 116
GetConfigData 110
U
GetFeatureList 109
unique level parameter 59
GetInterceptList 115
update subscriber account management info
GetVersion 109
sample messages
TranslateDialedDigits 124, 125
update subscriber account management info
request 1021 W
update subscriber account management info web services description language
response 1022 definition 1008
update subscriber account user info sample interfacing to the system 1008
messages sample messages 1008
update subscriber account user info WSDL
request 1022 See web services description language.
update subscriber account user info
response 1023
update subscriber DN sample messages
update subscriber DN request 1026
update subscriber DN response 1027
update subscriber features sample messages
update subscriber features request 1017
update subscriber features response 1019
update subscriber PIC sample messages
A31003-H80A0-T101-1-7618, 11/2021

OpenScape Voice v10 SOAP-XML Application Developers Manual

Uploaded by

Document Informationclick to expand document informationOpenScape Voice v10 SOAP-XML Application Developers Manual

Document Informationclick to expand document information

Copyright:

Available Formats

OpenScape Voice v10 SOAP-XML Application Developers Manual

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

OpenScape Voice v10 SOAP-XML Application Developers Manual

Uploaded by

Copyright:

Available Formats

Unify OpenScape Voice V10

As reseller please address further presales related questions to the responsible

Our Quality and Environmental Management Systems are

Copyright © Unify Software and Solutions GmbH & Co. KG 11/2021

Reference No.: A31003-H80A0-T101-1-7618

The information provided in this document contains merely general

Availability and technical specifications are subject to change without

Unify, OpenScape, OpenStage and HiPath are registered trademarks of

4.10.3 Message Detail Recording (MDR) Information . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

7.9 Get Calling Location List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116

8.8.3 Remove Media Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199

8.17.2 Modify Treatment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270

8.28.3 Remove Enum Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326

10.3 Attendant Answering Position (CfBgNBCPU) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421

10.54 Silent Monitoring Tag Feature (CfSILMTag) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469

11.19 Business Group Parking Lots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535

11.26.5 Extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 580

13.3.1 Create DNM Modification . . . . . . . . . . . . . . . . . . . . . . . .................. 652

17.1.1 Get Job Info. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 736

21.4 Query Traffic Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 787

25.2.3 Modify Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 881

25.2.53 Update Endpoint Profile QoS Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 913

25.2.105 Create Day Schedule. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 934

25.2.157 Remove Trunk Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 952

27 Using SOAP to Provision the OpenScape Voice Assistant . . . . . . . . . . . . . . . . . . . . 975

29.3.5 Update Subscriber PIC Sample Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1019

The SOAP (Simple Object Access Protocol) Server is an integrated

Subscriber provisioning is the management of subscriber data on the

1.1 Deployment Network Configuration

1.2 Subscriber Interactions

1.2.1 Service Interactions

Although some particular feature interactions may be mentioned in this

1.3 Subscriber Provisioning Network Architecture Layout

For example, consider the subscriber record containing the following

• Subscriber Alias (DN)

• Subscriber Call Forwarding Variable Number

1.3.1 Small Medium Enterprise

1.3.2 OpenScape Voice Assistant

1.3.3 SIP Network Servers

These SIP Network Server profiles are called Endpoint Profiles.

2 Changes Between Version V7 and V8

The following V8 features required noteworthy updates to the

• Restricted Registration via Central SBC

• EZIP Changes without Reboot

• SIP Timer Control and Audit Enhancements

• CSTA Security and Multi-Tenancy Support

• Domain Based Routing

• Cloud and Hosted Basic E911

• Business Group option to send Call Rejected by Subscriber

• Override Call Forwarding

• OpenScape Voice Support for Xpressions in OpenScape Cloud

• Generic Notification Mechanism using SIP Notify

• Support of the Fit4More Version Numbering Format

The information below offers a lower-level summary of changes in

WSDL Additions in V8:

WSDL Removals in V8:

3.1 Provisioning Traffic Volumes

3.3 System Requirements