0% found this document useful (0 votes)
24 views51 pages

IVSP Interface & Provisioning Description v5.5

provisioning flow

Uploaded by

Willy Duric
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOC, PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
24 views51 pages

IVSP Interface & Provisioning Description v5.5

provisioning flow

Uploaded by

Willy Duric
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOC, PDF, TXT or read online on Scribd
You are on page 1/ 51

IVSP Interface & Provisioning Specifications

Version 5.5
IVSP Interface & Provisioning Specifications
Version 5.5

Copyright

This document contains proprietary information of Artilium™ NV. Any reproduction, use, appropriation,
or disclosure of this information, in whole or in part, without the specific prior written authorization of
the owners thereof is strictly prohibited. Failure to observe this notice may result in legal proceedings
or liability for resulting damage or loss.
© Artilium™ N.V., 2005.

Disclaimer

Every effort has been made to ensure the accuracy of this document. However, due to ongoing
product improvements and revisions, Artilium™ cannot guarantee the accuracy of the information
contained in this document after the date of release nor can it accept responsibility for errors or
omissions.

Company info

Artilium N.V. – Autobaan 20, B-8210 LOPPEM - BRUGGE (Belgium)


Tel. +32 (0)50 230 300
Fax +32 (0)50 230 309
[email protected]
http://www.artilium.com

Document Release History

Version Release Date Purpose


1.0 29/06/2005 Initial Version
1.1 09/07/2005 Modifications after review by Versatel/Telindus
1.2 15/07/2005 P7: XML interface for interface 3
P10 2.1.1 : change user to cli,3 ATM
parameters defined as one parameter, delete
also based on telephone number.
P29: review of presence interface and locking
Appendix: link fields between all databases
1.3 25/07/2005 Update comments Versatel (25/07/05)
2.0 28/07/2005 Add version N° in all XML Requests
P23 : Call Barring : <RuleID> for get, <AddRuleID> for
add, <DeleteRuleID>for delete
<RuleID>1,2,3</RuleID> (gives list seperated with
comma), <AddRuleID>1,3</AddRuleID> with add,
<DeleteRuleID>1,3<DeleteRuleID> with delete
Add Emergency Zone 2
2.1 11/08/2005 Xml adjustments at 2.3.1 and 2.4.1
2.2 16/09/2005 Call Barring Adjustment rules + add CODEC parameter
add/update/get CLI / add errorcodes 15,16,17,18,100,101,102
2.3 27/09/2005 CTID_EXT = 2 to resolve GUI issue Telindus
2.4 29/09/2005 Adapt the varchar for PPPuserID
3.0 04/10/2005 VT Request for not providing ‘XXX’ when GETCLI
Call Barring code + Subscriber Profile added in interface 1 & 2
+CLIP Cirpack

2
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

3.1 07/10/2005 -> Add USERNAME_EXT to be datafilled and put


CLINUMBER in this field with an addclirequest
-> Voicemail password : 0000 in addcli when not provided
-> language change name definition NL/FL , FR/BE , EN/UK
(EN/UK= english, NL/FL = dutch, FR/BE = French) on addcli –
getcli and updatecli

3.2 11/10/2005 Note concerning language choice in add/get/updateCLI


Add ReselCustomID in get cli
Add appendix regarding the agreed Subriber Profiles
3.3 21/10/2005 Add explanation of Nomadism Check and Stages
+ adabas field for emergencyzone changed from
H_SPECNUMZONE_EXT to NAME_SP_ZONE
4.0 21/02/2006 Changes on request by VT on the working of the Nomadism
Check to allow flexibility in the suspend proces
Changes regarding Event locking of the Nomadism Check on
request by VT/TLS
Add InterfaceID parameter for ATM settings on request of VT
Time of First presence detection logged
Adjustment call forwarding nat/int settings
5.0 07/03/2006 Changes on request by VT for BRUO environment
Interface 1 – 3 and Nomadisme check adding of fields and
functional requirements +connectinfo and BRUOVLANID field
in SDP and Interface 1 GET CLI INFO
5.1 15/03/2006 Adjustment Interface 4 for Bruo Parameters
Call Barring Change request by TLS
5.2 03/04/2006 Adjustment for Bruo Parameters on request by VT (email )
Bruo_ShelfID , Bruo_SlotID, Bruo_PortID
5.3 04/04/2006 Adjustment for Interface 1 and 2 on request by TLS (email )
add H_OUTPROFILID_EXT when subscriber must be blocked
only for outgoing traffic Values can be or : block_all (ID = 3) or
dummy_res_profile(ID = 1) anything else isn’t accepted

5.4 07/04/2006 Adjustment for check BROBA/Bruo settings


5.5 23/04/2006 Add Connect Type line in XML part of Nomadism Check

3
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

Table of Contents

1 Introduction..............................................................................................6
2 Interfaces...............................................................................................10
2.1 Client XML interface...........................................................................10
2.2 Services settings XML interface...........................................................23
2.3 Radius interface................................................................................32
2.4 User Status Interface..........................................................................33
2.5 Monitoring.........................................................................................43
2.6 Adabas interface................................................................................43
2.7 Voice Mail.........................................................................................44
2.8 ACS interface....................................................................................45
2.9 ACS - CPE interface...........................................................................46

4
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

Abbreviations and definitions

ACS Auto-Configuration server


API Application Protocol Interface
BSS Business Support System
CDR Call Detail Record
CLI Call Line Identification
IVSP IP Virtual Service Provider
INAP IN Application Protocol
ISDN Integrated Services Digital Network
ISUP ISDN User Part
IVR Interactive Voice Response
OSS Operational Support System
SDP Service Delivery Part
SSDP Shared Service Delivery Platform
SS7 Signaling System N°7
SSL Secure Socket Layer
SSP Signaling Switching Point
VM Voice Mail

5
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

1 Introduction

This document specifies in detail the solution offered by Artilium for the provisioning
of the IVSP.

The solution of Artilium is a Shared Service Delivery Platform consisting of two major
parts:

o The Service Delivery Part (SDP): this part is the hardware and software that is
used for the service definition, execution and storage (database).

o The Voice Mail system: this part is the hardware and software that is used for the
voice mail handling.

This document is intended to describe in detail the provisioning interface


for the IVSP via XML HTTP and voice mail offered to the subscribers. The
necessary intelligent software to provision the SoftSwitch as well as the
presence detection will be done by the Shared Service Delivery Platform of
Artilium.

6
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

Overview

Figure 1 gives an overview of the solution together with the interfaces. This
paragraph describes the global content of each component and interface.

Figure 1 Overview Interfaces

The system is build up around the following components:

 DMS: switch to connect to the PSTN


 Cirpack LEN: the Local Exchange Node connecting the VoIP subscribers
and connecting to the PSTN via the DMS and to the Voice Mail system.
The Cirpack LEN is connected with its local database (Adabas) to store
the Class5 services and emergency zone tables.
 SDP: the service delivery platform as provisioning and monitoring interface
between the different components and its environment.
 The Auto-Configuration Server (ACS) that encompasses secure auto-
configuration as well as other CPE management functions within the
framework.
 Voice mail platform (VM)

7
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

The interfaces are:

Interface 1 is an XML provisioning interface where the operator or service provider


has the possibility to create, update and delete clients and telephone numbers (CLI
or extensions).

Interface 2 is the XML provisioning interface for the activation and configurations of
the telephone services settings.

Interface 3 is dealing with the detection of the PPP session via a Radius server. This
information is read (pulled) by the SDP from the operator or service provider via XML
messages.

Interface 4 is a bidirectional interface to indicate the presence and valid configuration


of a CPE (user status) so that the operator can detect the new customer (status
follow up and anomaly detection such as Nomadism) and also activate the CRM and
NP (Number portability) processes. An update of the successful NP is sent back in
case NP is executed.

Interface 5 is a monitoring interface based on SNMP, which informs the operator via
traps (MIB) about warning and errors with the connected systems.

Interface 6 is an ODBC interface between the SDP (SQL server) and the Cirpack
Subscriber Database for the class5 services and SIP registration information
(Adabas).

Interface 7 is the link between the SDP and Voice Mail platform for the activation and
configuration of the VM boxes.

Interface 8 is the interface between the SDP en ACS for the exchange of CPE
parameters.

Interface 9 is a TR-069 protocol interface for communication between the CPE and
Auto-Configuration Server (ACS) that encompasses secure auto-configuration as
well as other CPE management functions within the framework.

8
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

Identity parameters.

The unique customer identity consists of:


 The PPP user id
 Password of the customer for the PPP session

The PPP user id is a concatenation of:


 The customer number (in this case the Versatel number VTxxxxx)
 The realm (in this case either versatel.be or versadsl.be)

This id and password cannot be changed by the customer and is assigned by


Versatel.

The second user id is for the Versatel Portal (Mijn Versatel : MN VT) and is consisting
of :
 A username VTxxxx assigned by Versatel and not changeable.
 A password, alpha numeric, changeable by the customer

The third identity is the Voicemail identity and consisting of:

 The telephone number (assigned by Versatel)


 Password for mailbox access consisting of 4 digits. Password can be initial
empty and must be changed by the user if he wants to enter his mailbox from
‘anywhere’ to be able to enter his mailbox (if not dialing from own telephone
number).

Remark:
 One mailbox per telephone number (even when customer has multiple
numbers)
 Password for voicemail can either initially be create by Versatel or can initially
be empty. Customer will have no remote access (other than own number) to
mailbox if password is empty. Password can be created or changed via
access to the mailbox menu (via phone) or via web portal (My Versatel).

The fourth identity is the SIP identity for the CPE to be able to register (SIP registrar)
and make SIP VoIP calls. For this there is a SIP URL (telephonenr@domain) and SIP
password. Also an alias will be foreseen for each SIP identity. For each telephone
number there will be a SIP ID where the password will be the same of the PPP
password.
[email protected]: first telephone number
[email protected] that can be created as an extra number on the same or
new CPE port (to be checked what can be configured on CPE).

9
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

2 Interfaces

2.1 Client XML interface


2.1.1 Technical

This section describes the web service procedure (API) to interface with the SDP of
Artilium to manage user accounts.

The XML provisioning interface allows service providers and/or partners to manage
their user accounts via XML HTTP. There are 4 types of requests that can be sent to
the SDP: add_cli, get_cli_info, update_cli and delete_cli.The interface enables a
reseller to create and delete telephone numbers but also to manage the features a
user is allowed to use and/or change. It is also possible to temporarily disable
telephone numbers for example when the client’s payment is overdue.

The Interface only allows connections sent over SSL to ensure security when
sending vital user information (with a fixed certificate to exchange secure data
between two fixed systems).

For each request a login name and password must be send in the request (fixed and
to be agreed between the two parties).

All XML message interchange is synchronous.

List of parameters used in interface:

FieldName Description Format Usage


PPPUserID Unique user identity Varchar(50) Mandatory
of the customer
(created by Versatel)
PPPuserPWD Password PPP Varchar(20) Mandatory
AgentID ID of the agent Varchar(20) Optional
(dealer,reseller). This
ID is ceated by
Versatel. If the ID is
empty or NULL then
the customer will be
stored under the
root.
AgentName Name of the agent Varchar(20) Optional
(dealer,reseller).
DistributorID ID of the distributor int Optional
assigned to the
telephone number
via the distributor
10
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

table of the Artilium


database.(predefined
table)
CliNumber Telephone number Varchar(20) Mandatory
assigned for that
customer
TelPortNumberOnCPE Port number used for int Mandatory
that telephone
number (1 …)
CallForwardingBackup Backup number to Varchar(20) Optional
call in case of
network or CPE
failure.
CallForwardingBackupON Use or do not use a True/False Optional
backup number to
call in case of
network or CPE
failure:
CallWait A call waiting signal True/False Optional
is given in case a
second incoming call
is received
CallHold A call can be set on True/False Optional
hold
Email E-mail adres of the Varchar(255) Optional
customer
Name Last Name of the Varchar(20) Optional
customer
Firstname First Name of the Varchar(20) Optional
customer
Mobile Mobile number of the Varchar(20) Optional
customer
Enabled Activate or block True/False Mandatory
telephone number of
this customer (not
emergency
numbers). This
allows commercial
blocking of a CLI
(automatic blocking
and un-blocking by
system is not
allowed when CLI is
blocked by this flag)
VoicemailPWD Password for the Varchar(20) Optional
voicemail access: 4
digits (0000 until
9999)Standard set
11
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

as 0000
Voicemail Notification Allow or block voice True/False Mandatory
mail notification via
outbound calls.
Language Language requested NL/FL Mandatory
by the customer for FR/BE
EN/UK
the voicemail
message or
messages given by
the network (if any)
AccountStatus Status of the Varchar(20) Optional
account: status fields
(classification) as
configured in Artilium
database (to define
according own
wishes via
conversion codes).
PortedTel Indicate if the True/False Mandatory
number is a ported
number or not.
EmergencyZone1 Emergency zones Varchar(20) Mandatory
EmergencyZone2 are required for the
determination of the
prefix. The
emergency zone list
must be created in
the Cirpack
database. 2
emergency zones
are defined in case
of a move of a CPE.
ATM1_VPI,ATM2_VPI The ATM VPI Int Mandatory/Optional
number of the xDSL (1 or 2)
line (2 sets in case of
move)
ATM1_VCI,ATM2_VCI The ATM VPI Int Mandatory/Optional
number of the xDSL (1 or 2)
line (2 sets in case of
move)
ATM1_PortID, The ATM PortID Int Mandatory/Optional
ATM2_PortID number of the xDSL (1 or 2)
line (2 sets in case of
move)
Nomadism Check This check will allow True/False Mandatory
to verify based on
ATM parameters
provisioned and

12
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

detected via Radius


to block a customer
in real-time
SIP block Check This check will allow True/False Mandatory
to verify based on
SIP account
parameters
provisioned and
detected via Cirpack
to block a customer
in real-time
SIP_Domain Domain name of the Varchar(20) Mandatory
SIP user
SIP_Password Password of the SIP Varchar(20) Mandatory
user
SIP_Alias Alias of the SIP Varchar(20) Optional
identity
SIP_Proxy IP address of proxy Varchar(20) Optional
SIP_reregTime Reregister time of int (seconds) Optional
CPE
SIP_dialPlan Dial plan for SIP Int Optional
calls
CPE_brand Brand of CPE Varchar(20) Optional
CPE_version Sofware version on Varchar(20) Optional
CPE
CPE_serialNo Serial Number of Varchar(20) Optional
CPE
CPE_MAC MAC address of Varchar(20) Optional
CPE
CPE_WIFI Activate or True/False Optional
deactivate the WIFI
on the CPE
CPE_Param1 For future use (CPE Varchar(20) Optional
Parameter)
CPE_Param2 For future use (CPE Varchar(20) Optional
Parameter)
CPE_Param3 For future use (CPE Varchar(20) Optional
Parameter)
CPE_Param4 For future use (CPE Varchar(20) Optional
Parameter)
CPE_Param5 For future use (CPE Varchar(20) Optional
Parameter)
Codec Codec related to the Varchar(20) Mandatory
extension
SubProfile Subscriber Profile Varchar(20) Mandatory
that allow/disallow
features
CallBarringCode Code that allows to Varchar(32) Optional
13
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

activate/Change the
Call barring
CLIPCirpack CLI presentation on Int Optional
incoming call
ReselCustomID Identifier of reseller Int Optional
and customer ID
(=last 7 digit)
ATM1_IntFceID, The ATM Interface Int Mandatory (1 or 2)
ATM2_IntFceID ID number of the
xDSL line (2 sets in
case of move)
BRUO_NodeID The BRUO Interface Int Mandatory/
ID on NODE level Optional
BRUO_ShelfID The BRUO Interface Int Mandatory/
ID on SHELF level Optional
BRUO_SlotID The BRUO Interface Int Mandatory/
ID on SLOT level Optional
BRUO_PortID The BRUO Interface Int Mandatory/
ID on PORT level Optional
BRUO_VlanID The BRUO Interface Int Optional
ID on VLAN level
Connect_Type Broba or Bruo Int Mandatory
settings are valid
ConnectINFO Connect Info Varchar (20) Optional
regarding pppoa or
pppoe
Block_OutgoingCalls Block outgoing calls Int Optional

Remarks : for ATM : it is so that (ATM1_VPI - ATM1_VCI - ATM1_PortID – ATM1_IntFceID) of


(ATM2_VPI - ATM2_VCI - ATM2_PortID– ATM1_IntFceID) must been seen as a one point of
information that needs to be provided.
Or everything concerning ATM1 or ATM2 needs to be set.
If in the set with the 3 parameters one field is empty : an error-message will be given
for BRUO : it is so that BRUO_NodeID - BRUO_ShelfID - BRUO_SlotID BRUO_SlotID must been
seen as a one point of information that needs to be provided when BRUO_On is True..
When the BRUO_On is set to True then the fields are Mandatory else they are optional
BRUO_VlanID can be provided as optional information.

For Emergency : the minimum length is 1 character so no blanco is allowed.


If both zones are provided then no change will take place in the adabas server for this field.
Emergencyzone1 will be enabled when BRUO_On is true

2.1.2 Creation of a new user account

2.1.2.1 ADDCLI request:

<?xml version="1.0"?>
<request type="add_cli" login="value" password="value" version="1.0">
14
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

<PPPuserID>value</PPPuserID>
<PPPuserPwd>value</PPPuserPwd>
<value name=”AgentId”>value</value>
<value name=”AgentName”>value</value>
<value name=”DistributorId”>value</value>
<CLINumber >value</CLINumber> <TelPortNumberOnCPE>value</ TelPortNumberOnCPE>
<callForwardingBackup>value</callForwardingBackup> //NULL if none
<callForwardingBackupOn>true/false</callForwardingBackupOn>
<callWait>true/false</callWait>
<callHold>true/false</callHold> <email>value</email>
<name> value </name>
<firstName> value </firstName>
<mobile>value</mobile>
<enabled>true/false</enabled>
<VoicemailPassword>value</VoicemailPassword> // if no value is provided then 0000 will be given
<value name=”VoicemailNotification”>true/false</value>
<lang>NL / FR / EN </lang>// EN (=EN/UK in softswitch),NL( =NL/FL = in softswitch),FR( =FR/BE = in
softswitchj)
<accountStatus>value</accountStatus>
<value name=” portedTel”>true/false</value>
<value name=”EmergencyZone1”>value</value>
<value name=”EmergencyZone2”>value</value>
<value name=”ATM1_VPI”>value</value>
<value name=”ATM1_VCI”>value</value>
<value name=”ATM1_PortID”>value</value>
<value name=”ATM1_IntFceID”>value</value
<value name=”ATM2_VPI”>value</value>
<value name=”ATM2_VCI”>value</value>
<value name=”ATM2_PortID”>value</value>
<value name=”ATM2_IntFceID”>value</value>
<value name=”Connect_Type”>Broba/Bruo</value>
<value name=”BRUO_NodeID”>value</value>
<value name=”BRUO_ShelfID”>value</value
<value name=”BRUO_SlotID”>value</value>
<value name=”BRUO_PortID”>value</value>
<value name=”AllowNomadismCheck”>true/false</value>
<value name=”AllowSIPBlockCheck”>true/false</value>
<value name=”SIP_Domain”>value</value>
<value name=”SIP_Password”>value</value>
<value name=”SIP_Alias”>value</value>
<value name=”SIP_proxy”>value</value>
<value name=”SIP_reregTime”>value</value>
<value name=”SIP_dialPlan”>value</value>
<value name=”CPE_brand”>value</value> // hardware brand of the CPE
<value name=”CPE_version”>value</value> // CPE version
<value name=”CPE_serialNo”>value</value>
<value name=”CPE_MAC”>value</value>
<value name=”CPE_WIFI>true/false</value>
<value name=”CPE_PARAM1”>value</value>
<value name=”CPE_PARAM2”>value</value>
<value name=”CPE_PARAM3”>value</value>
<value name=”CPE_PARAM4”>value</value>
<value name=”CPE_PARAM5”>value</value>
<value name=”Codec”>value</value>
<value name=”SubProfile”>value</value>

<options>
// basic options
<changeSettings>true/false</changeSettings> //allow to change settings by customer
<callBarringcode> value </callBarringcode>
<CLIRestriction>true/false</CLIRestriction>
<callForwardingUnconditional > true/false </callForwardingUnconditional >
<callForwardingNoAnswer> true/false </callForwardingNoAnswer>
<callForwardingBusy> true/false </callForwardingBusy>
<callBarring> true/false </callBarring>
15
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

<voicemail> true/false </voicemail>


<callHistory> true/false </callHistory>
<BlockOutgoingCalls>value</BlockOutgoingCalls>
//advanced options
<voicemailPro> true/false </voicemailPro>
<voicemail2Mail> true/false </voicemail2Mail>
<fax2Mail faxNumber=“value”> true/false </fax2Mail>
<addressBook> true/false </addressBook>
<webmail> true/false </webmail>
<SMSNotificationVoicemail> true/false </SMSNotificationVoicemail>
<SMSNotificationFax> true/false </SMSNotificationFax>
<sendSMS> true/false </sendSMS>
<sendFax> true/false </sendFax>
<faxPrinterDriver> true/false </faxPrinterDriver>
<outlookPlugin> true/false </outlookPlugin>
<XMLAPI> true/false </XMLAPI>
<findMeFollowMe> true/false </findMeFollowMe>
<scheduledCall> true/false </scheduledCall>
</options>
</request>

Note : For the value ‘’SubProfile’’ the values of the options CLIR – Call Barring – Call Forwarding Unconditional
- Call Forwarding No Answer – Call Forwarding on Busy will be adapted from values in the profile to the extension
CLIRestriction : If CLIR_ABO value = 2 -> CLIR_ON_EXT can be 0 of 1 (supported in XML)
If CLIR_ABO value 1 -> CLIR_ON_EXT = 1
if CLIR_ABO value 0 -> CLIR_ON_EXT = 0
CallBarring : If SCRL_OUT_ABO 0 -> SCRL_MODE_OUT_EXT = 0
If SCRL_OUT_ABO 1 -> SCRL_MODE_OUT_EXT can be 0 of 1 ( XML)
If SCRL_OUT_ABO another value-> error in parameters: SubProfile
CallForwardingUnconditional : if FWD_UNC_ABO value 0 -> FWD_UNC_ON_EXT = 0
if FWD_UNC_ABO value 1 -> FWD_UNC_ON_EXT = 0 or1 (XML)

callForwardingNoAnswer : if FWD_NRP_ABO value 0 -> FWD_NRP_ON_EXT = 0


if FWD_NRP_ABO value 1 -> FWD_NRP_ON_EXT = 0 or 1 (XML)
callForwardingBusy : if FWD_BUSY_ABO value 0 -> FWD_BUSY_ON_EXT = 0
if FWD_BUSY_ABO value 1 -> FWD_BUSY_ON_EXT = 0 or1 (XML)

2.1.2.2 ADDCLI response: successful.

When a new user and the cli has been created successfully, the provisioning-interface will reply with the following
response. When you omitted the CLINumber in the request you will receive an error message.

<?xml version="1.0"?>
<response type="add_cli">
<responseStatus code=”0”>successful</responseStatus>

</response>

2.1.2.3 ADDCLI response: failed.

When a request was not processed successfully you will receive a response containing an error-tag. This tag has
a number attribute with the error-code that can be used for error handling in the code. The text value of the error
contains a description of the error to make debugging easier for the developer.

<?xml version="1.0"?>
<response type="add_cli">
<responseStatus code=”value”> response message </responseStatus>
if

16
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

<responseStatus code=”12”> error in parameters :name parameter </responseStatus>

</response>

Note : the name parameter that will be provided is the first wrong parameter provided.

2.1.3 Request user information

2.1.3.1 GET_CLI_INFO request.

The ‘GET_CLI_INFO’-request allows you to query the information stored in the databases for a single user
account.

<?xml version="1.0"?>
<request type="get_user_info" login="value" password="value" version="1.0">
<CliNumber>value</CliNumber>
</request>

2.1.3.2 GET_CLI_INFO response: successful.

When an account with the specified clinumber is found all information about the account status and options is
returned in the response.

<?xml version="1.0"?>
<response type="get_cli_info">
<responseStatus code=”0”> successful </responseStatus>
<PPPuserID>value</PPPuserID>
<PPPuserPwd>value</PPPuserPwd>
<value name=”AgentId”>value</value>
<value name=”AgentName”>value</value>
<value name=”DistributorId”>value</value>
<CLINumber >value</CLINumber>
<TelPortNumberOnCPE>value</ TelPortNumberOnCPE>
<callForwardingBackup>value</callForwardingBackup> //NULL if none
<callForwardingBackupOn>true/false</callForwardingBackupOn>
<callWait>true/false</callWait>
<callHold>true/false</callHold>
<email>value</email>
<name> value </name>
<firstName> value </firstName>
<mobile>value</mobile>
<enabled>true/false</enabled>
<VoiceMailPassword>value(numeric)</VoicemailPassword> // optional when omitted no phonePassword
will be generated
<value name=”VoicemailNotification”>true/false</value>
<lang>NL / FR / EN </lang>// EN (=EN/UK in softswitch),NL( =NL/FL = in softswitch),FR( =FR/BE = in
softswitch)
<accountStatus>value</accountStatus>
<creationDate> YYYY-MM-DDThh:mm:ssTZD </creationDate>
<lastModDate> YYYY-MM-DDThh:mm:ssTZD </lastModDate>
<value name=” portedTel”>true/false</value>
<value name=”emergencyZone1”>value</value>
<value name=”EmergencyZone2”>value</value>
<value name=”ATM1_VPI”>value</value>
<value name=”ATM1_VCI”>value</value>
<value name=”ATM1_PortID”>value</value>
<value name=”ATM1_IntFceID”>value</value
<value name=”ATM2_VPI”>value</value>
<value name=”ATM2_VCI”>value</value>
<value name=”ATM2_PortID”>value</value>
<value name=”ATM2_IntFceID”>value</value
<value name=”BRUO_NodeID”>value</value>
17
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

<value name=”Connect_Type”>Broba/Bruo</value>
<value name=”BRUO_ShelfID”>value</value>
<value name=”BRUO_SlotID”>value</value>
<value name=”BRUO_PortID”>value</value>
<value name=”BRUO_VlanID”>value</value>
<value name=”AllowNomadismCheck”>true/false</value>
<value name=”AllowSIPBlockCheck”>true/false</value>
<value name=”SIP_Domain”>value</value>
<value name=”SIP_Password”>value</value>
<value name=”SIP_Alias”>value</value>
<value name=”SIP_proxy”>value</value>
<value name=”SIP_reregTime”>value</value>
<value name=”SIP_dialPlan”>value</value>
<value name=”CPE_brand”>value</value> // hardware brand of the CPE
<value name=”CPE_version”>value</value> // CPE version
<value name=”CPE_serialNo”>value</value>
<value name=”CPE_MAC”>value</value>
<value name=”CPE_WIFI>true/false</value>
<value name=”CPE_PARAM1”>value</value>
<value name=”CPE_PARAM2”>value</value>
<value name=”CPE_PARAM3”>value</value>
<value name=”CPE_PARAM4”>value</value>
<value name=”CPE_PARAM5”>value</value>
<value name=”Codec”>value</value>
<value name=”SubProfile”>value</value>
<value name=”ReselCustomID”>value</value>
<value name=”ConnectInfo”>value</value>
<options>
// basic options
<changeSettings>true/false</changeSettings>
<CLIRestriction>true/false</CLIRestriction>
<callForwardingUnconditional > true/false </callForwardingUnconditional >
<callForwardingUncNumber >tel number </callForwardingUncNumber >
<callForwardingNoAnswer> true/false </callForwardingNoAnswer>
<callForwardingNoANumber >tel number </callForwardingNoANumber >
<callForwardingNoTimeOut >number in seconds</callForwardingNoATimeOut>
<callForwardingBusy> true/false </callForwardingBusy>
<callForwardingBusyNumber> tel number </callForwardingBusyNumber>
<callBarring> true/false </callBarring>
<callBarringRules>
<Rule>0032%</Rule> or <Rule>id</Rule>
</callBarring Rules>
<callBarringcode> value </callBarringcode>
<VoiceMail> true/false </VoiceMail>
<callHistory> true/false </callHistory>
<CLIPCirpack>value</ CLIPCirpack >
<BlockOutgoingCalls>value</BlockOutgoingCalls>
//advanced options
<voicemailPro> true/false </voicemailPro>
<voicemail2Mail> true/false </voicemail2Mail>
<fax2Mail faxNumber=“value”> true/false </fax2Mail>
<addressBook> true/false </addressBook>
<webmail> true/false </webmail>
<SMSNotificationVoicemail> true/false </SMSNotificationVoicemail>
<SMSNotificationFax> true/false </SMSNotificationFax>
<sendSMS> true/false </sendSMS>
<sendFax> true/false </sendFax>
<faxPrinterDriver> true/false </faxPrinterDriver>
<outlookPlugin> true/false </outlookPlugin>
<XMLAPI> true/false </XMLAPI>
<findMeFollowMe> true/false </findMeFollowMe>
<scheduledCall> true/false </scheduledCall>
</options>
</response>

18
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

Concerning..“CLIRestriction","callForwardingUnconditional","callForwardingUncNumber","callForwardi
ngNoAnswer","callForwardingNoANumber","callForwardingNoTimeOut""callForwardingBusy","callFor
wardingBusyNumber","SIP_Domain", "SIP_Password","EmergencyZone1" and "EmergencyZone2”
If the value in one of these is equal to XXX then this will be replaced by an empty string

2.1.3.3 GET_CLI_INFO response: failed.

<?xml version="1.0"?>
<response type="get_cli_info">
<responseStatus code=”value”> response message </responseStatus>
if
<responseStatus code=”12”> error in parameters :name parameter </responseStatus>

</response>

Note : the name parameter that will be provided is the first wrong parameter provided.

2.1.4 Updating a user account

2.1.4.1 UPDATE_CLI request:

All parameters that are passed in the update request will be updated in the databases. Omitted parameters will be
ignored and will remain unchanged.

<?xml version="1.0"?>
<request type="update_cli" login="value" password="value" version="1.0">
<PPPuserID>value</PPPuserID>
<PPPuserPwd>value</PPPuserPwd>
<value name=”AgentId”>value</value>
<value name=”AgentName”>value</value>
<value name=”DistributorId”>value</value>
<CLINumber >value</CLINumber>
<TelPortNumberOnCPE>value</ TelPortNumberOnCPE>
<callForwardingBackup>value</callForwardingBackup> //NULL if none
<callForwardingBackupOn>true/false</callForwardingBackupOn>
<callWait>true/false</callWait>
<callHold>true/false</callHold>
<email>value</email>
<name> value </name>
<firstName> value </firstName>
<mobile>value</mobile>
<enabled>true/false</enabled>
<VoicemailPassword>value(numeric)</VoicemailPassword> // optional when omitted no
VoicemailPassword will be generated
<value name=”VoicemailNotification”>true/false</value>
<lang>NL / FR / EN </lang>// EN (=EN/UK in softswitch),NL( =NL/FL = in softswitch),FR( =FR/BE = in
softswitch)
<accountStatus>value</accountStatus>
<value name=” portedTel”>true/false</value>
<value name=”emergencyZone1”>value</value>
<value name=”emergencyZone2”>value</value>
<value name=”ATM1_VPI”>value</value>
<value name=”ATM1_VCI”>value</value>
<value name=”ATM1_PortID”>value</value>
<value name=”ATM1_IntFceID”>value</value
<value name=”ATM2_VPI”>value</value>
<value name=”ATM2_VCI”>value</value>
<value name=”ATM2_PortID”>value</value>
19
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

<value name=”ATM2_IntFceID”>value</value>
<value name=”Connect_Type”>Broba/Bruo</value>
<value name=”BRUO_NodeID”>value</value>
<value name=”BRUO_ShelfID”>value</value
<value name=”BRUO_SlotID”>value</value>
<value name=”BRUO_PortID”>value</value>
<value name=”AllowNomadismCheck”>true/false</value>
<value name=”AllowSIPBlockCheck”>true/false</value>
<value name=”SIP_Domain”>value</value>
<value name=”SIP_Password”>value</value>
<value name=”SIP_Alias”>value</value>
<value name=”SIP_proxy”>value</value>
<value name=”SIP_reregTime”>value</value>
<value name=”SIP_dialPlan”>value</value>
<value name=”CPE_brand”>value</value> // hardware brand of the CPE
<value name=”CPE_version”>value</value> // CPE version
<value name=”CPE_serialNo”>value</value>
<value name=”CPE_MAC”>value</value>
<value name=”CPE_WIFI>true/false</value><value name=”CPE_PARAM1”>value</value>
<value name=”CPE_PARAM2”>value</value>
<value name=”CPE_PARAM3”>value</value>
<value name=”CPE_PARAM4”>value</value>
<value name=”CPE_PARAM5”>value</value>
<value name=”Codec”>value</value>
<value name=”SubProfile”>value</value>
<options>
// basic options
<changeSettings>true/false</changeSettings>
<CLIRestriction>true/false</CLIRestriction>
<callForwardingUnconditional > true/false </callForwardingUnconditional >
<callForwardingNoAnswer> true/false </callForwardingNoAnswer>
<callForwardingBusy> true/false </callForwardingBusy>
<callBarring> true/false </callBaring>
<callBarringcode> value </callBarringcode>
<voicemail> true/false </voicemail>
<callHistory> true/false </callHistory>
<BlockOutgoingCalls>value</BlockOutgoingCalls>
//advanced options
<voicemailPro> true/false </voicemailPro>
<voicemail2Mail> true/false </voicemail2Mail>
<fax2Mail faxNumber=“value”> true/false </fax2Mail>
<addressBook> true/false </addressBook>
<webmail> true/false </webmail>
<SMSNotificationVoicemail> true/false </SMSNotificationVoicemail>
<SMSNotificationFax> true/false </SMSNotificationFax>
<sendSMS> true/false </sendSMS>
<sendFax> true/false </sendFax>
<faxPrinterDriver> true/false </faxPrinterDriver>
<outlookPlugin> true/false </outlookPlugin>
<XMLAPI> true/false </XMLAPI>
<findMeFollowMe> true/false </findMeFollowMe>
<scheduledCall> true/false </scheduledCall>
</options>
</request>

Note : For the value ‘’SubProfile’’ the values of the options CLIR – Call Barring – Call Forwarding Unconditional
- Call Forwarding No Answer – Call Forwarding on Busy will be adapted from values in the profile to the extension
CLIRestriction : If CLIR_ABO value = 2 -> CLIR_ON_EXT can be 0 of 1 (supported in XML)
If CLIR_ABO value 1 -> CLIR_ON_EXT = 1
if CLIR_ABO value 0 -> CLIR_ON_EXT = 0
CallBarring : If SCRL_OUT_ABO 0 -> SCRL_MODE_OUT_EXT = 0
If SCRL_OUT_ABO 1 -> SCRL_MODE_OUT_EXT can be 0 of 1 ( XML)

20
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

If SCRL_OUT_ABO another value-> error in parameters: SubProfile


CallForwardingUnconditional : if FWD_UNC_ABO value 0 -> FWD_UNC_ON_EXT = 0
if FWD_UNC_ABO value 1 -> FWD_UNC_ON_EXT = 0 or1 (XML)

callForwardingNoAnswer : if FWD_NRP_ABO value 0 -> FWD_NRP_ON_EXT = 0


if FWD_NRP_ABO value 1 -> FWD_NRP_ON_EXT = 0 or 1 (XML)
callForwardingBusy : if FWD_BUSY_ABO value 0 -> FWD_BUSY_ON_EXT = 0
if FWD_BUSY_ABO value 1 -> FWD_BUSY_ON_EXT = 0 or1 (XML)

2.1.4.2 UPDATE_CLI response: successful.

<?xml version="1.0"?>
<response type="update_cli" >
<responseStatus code=”0”> succesfull </responseStatus>
</response>

2.1.4.3 UPDATE_CLI response: failed.

<?xml version="1.0"?>
<response type="update_cli" >
<responseStatus code ="value">error message</ responseStatus >
if
<responseStatus code =”12”> error in parameters :name parameter </responseStatus>

</response>

Note : the name parameter that will be provided is the first wrong parameter provided.

2.1.5 Delete a user account

2.1.5.1 DELETE_CLI request:

Sending a ‘delete_cli’ request will remove the user account with the corresponding ‘PPPuserID’ and cli number
from the database. Remark : when deleting a user all his associated telephonenumbers will also be deleted when
the clinumber is empty.

<?xml version="1.0"?>
<request type="delete_cli" login="value" password="value" version="1.0">
<PPPuserID>value</PPPuserID>
<CliNumber>value</CliNumber>
</request>

2.1.5.2 DELETE_CLI response: successful.

<?xml version="1.0"?>
<response type="delete_cli">
<responseStatus code=”0”>successful</responseStatus>
</response>

2.1.5.3 DELETE_CLI response: failed.

<?xml version="1.0"?>
21
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

<response type="delete_cli">
<responseStatus code=”value”> response message </responseStatus>
if
<responseStatus code=”12”> error in parameters :name parameter </responseStatus>

</response>

Note : the name parameter that will be provided is the first wrong parameter provided.

2.1.6 ‘No Blocking At All’ Panic button

2.1.6.1 UPDATE_UNBLOCKALLCLI request:

Sending an ‘update_unblockallcli’ request will unblock all telephone numbers

<?xml version="1.0"?>
<request type=" update_unblockallcli " login="value" password="value" version="1.0">
</request>

2.1.6.2 UPDATE_UNBLOCKALLCLI response: successful.

<?xml version="1.0"?>
<response type=" update_unblockallcli ">
<responseStatus code=”0”>successful</responseStatus>
</response>

2.1.6.3 UPDATE_UNBLOCKALLCLI response: failed.

<?xml version="1.0"?>
<response type=" update_unblockallcli ">
<responseStatus code=”value”> response message </responseStatus>
if
<responseStatus code =”12”> error in parameters :name parameter </responseStatus>

</response>

Note : the name parameter that will be provided is the first wrong parameter provided.

2.1.7 Response messages

 Successful: response-code 0
 General Errors: response-codes 1 to 7 are general errors that occur when a request is malformed
or invalid or when user information is incorrect.
 Specific Errors: response-codes 10 to 14 are specific errors that may occur during the processing
of the requested action.
 System errors: response-codes 20 to 22 are system errors that may occur in the database.

Code Value Description Action


0 ‘Successful' No errors encountered, None
processing was successful.
1 'Connection not allowed' Occurs when the information is Check if SSL is used
22
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

not sent over a SSL-connection


2 'Not a Request' Occurs when a non-valid XML- Check request if all
request is received. XML data is valid
3 'Could not login' Occurs when the login Check login
information is invalid. information
4 'No login information' Occurs when the login Check login
information is missing in the information
request.
5 'Invalid XML request' Occurs when the requested Check if XML request
action is not one of the is one of the defined
predefined actions: 'add_user', actions.
'get_user_info', 'update_user' of
'delete_user'.
6 'Not an admin user' Occurs when the requesting Check rights of the
(admin)user has insufficient requesting user
rights to perform this action.
10 'CLI exists' Occurs when you attempt to Check if CLI exists
create an account with a already, if so check if
clinumber that already exists. requested CLI exists
in OSS.
11 'No free numbers available' Occurs when all numbers in the Check if the
requested number range are in telephone number
use already exists in the
database, if so check
if number can be
deleted to add again
with new customer
data
12 'Error in parameters' Occurs when one or more of the Check if all
required parameters is missing parameters are send
or has an invalid value. correct.
13 'No user ID specified' Occurs when no valid Checks if a valid
PPPuserID is specified in the PPPuserid is send in
request the request.
14 'User not found' Occurs when no account is Chack if PPPuserID is
defined in the database with the send correctly and if
passed PPPuserID when user present in the
updating or requesting info database.
15 ‘CLINotFound’ Occurs when CLI isn’t found Check if CLI exist
16 ‘InvalidUserCLICombination’ Occurs when CLI isn’t defined Check the CLI and
under this PPPuserID PPPuserID
17 ‘InvalidAgentUserCLICombination’ Occurs when the relation Check the CLI and
between CLI , PPPuserID and PPPuserID and
AgentID is invalid AgentID
18 ‘InvalidAgentUserCombination’ Occurs when the relation Check the PPPuserID
between PPPuserID and and AgentID
AgentID is invalid
20 ‘Could not add user' Occurs when a user account Check database
could not be inserted in the (available? connected
database. ?)
21 'Update failed' Occurs when the update query Check database
was not executed successfully. (available? connected
?)
22 'Delete failed' Occurs when a specified Check database
account could not be deleted (available? connected
from the database. ?)
100 ‘UnknownError’ Taken action(s) was unsuccesful Verify logfile and
review last performed
23
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

actions
101 ‘UnknownDatabaseError’ Occurs when SDP database fails Verify SDP ,
Softswitch and ODBC
102 ‘UnknownVoicemailError’ Occurs when voicemail action Verify VoiceMail
failed system or link

Remark :

If the error code is equal to 2,3,4 or 5 then the response will be in the generated as next :

<?xml version="1.0"?>
<response>
<responseStatus code=”code”>valuecode</responseStatus>
</response>

2.2 Services settings XML interface


2.2.1 Technical

This section describes the web service procedure (API) to interface with the SDP of
Artilium to manage the settings of the services assigned to the customers.

The XML provisioning interface allows service providers and/or partners to manage
the service setting of the user accounts via XML.

The Interface only allows connections sent over SSL to ensure security when
sending vital user information (with a fixed certificate to exchange secure data
between two fixed systems).

All XML message interchange is synchronous.(request id are not necessary)

The “settings-interface” provides a framework to manage user settings of a single


account through XML. Resellers can integrate functions in their web applications
without giving the end-user full control over his/her own account can use it.

List of settings:

Fieldname Description Format


24
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

CLI restriction With this setting the service can True/False


be set to CLIP (show CLI) or
CLIR (hide CLI) (CLIR=True)
Call Forwarding With this setting the service Call True/False
Unconditional forwarding unconditional can be Tel Number
activated and the telephone
number where the calls need to
be diverted can be set (remark:
if no number is given then the
number is not changed in the
database). With this service the
calls can be diverted to any
other valid number or a
voicemail number (in this case
the voicemail access number
must be entered)
Call Forwarding No With this settings the service True/False
Answer Call forwarding on no answer Tel Number
can be activated and the TimeOut(seconds
telephone number where the )
calls need to be diverted after a
selected timeout (seconds and
must be a value between 5 and
60s) can be set (remark: if no
number or timeout is given then
the number or timeout is not
changed in the database). With
this service the calls can be
diverted in case of no answer to
any other valid number or a
voicemail number (in this case
the voicemail access number
must be entered)
Call Forwarding Busy With this setting the service Call True/False
forwarding on busy can be Tel Number
activated and the telephone
number where the calls need to
be diverted can be set (remark:
if no number is given then the
number is not changed in the
database). With this service the
calls can be diverted in case of
busy to any other valid number
or a voicemail number (in this
case the voicemail
accessnumber must be
entered)
Call Barring With this settings the barring Prefix% or

25
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

rules can be added or deleted. destination or ID


A barring rule is a prefix number
or complete number or ID
(indicating a list of predefined
numbers or prefixes) that not
can be dialed by the customer.
The list will be provided in a
table

Voicemail Settings to retrieve the new or MessageID(int)


saved message (id, from, From (tel nr)
datetime and New or saved), DateTime
also retrieval of the WAV file. New (Y/N)
(format available is either 6 or 8
kHz WAV file)

2.2.2 Basic Features

2.2.2.1 CLI Restriction.

Request:
<?xml version="1.0"?>
<Request type="CLIRestriction" login="value" password="value" version="1.0">
<CLIRestriction>
<ID>003292703000</ID>
<Enabled>True/False</Enabled>
</CLIRestriction>
</Request>

Response:
<?xml version="1.0"?>
<response type="CLIRestriction">
<responseStatus code=”value”> response message </responseStatus>
if
<responseStatus code =”12”> error in parameters :name parameter </responseStatus>

</response>

Note : the name parameter that will be provided is the first wrong parameter provided.

2.2.2.2 Call Forwarding Unconditional

Request:
<?xml version="1.0"?>
<Request type="CallForwardingUnconditional" login="value" password="value">
<CallForwardingUnconditional>
<ID>003292703000</ID>
<Enabled>True/False</Enabled>
<TelNo>092999999 </TelNo>
</CallForwardingUnconditional >
</Request>
26
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

Response:
<?xml version="1.0"?>
<response type=" CallForwardingUnconditional ">
<responseStatus code=”value”> response message </responseStatus>
if
<responseStatus code =”12”> error in parameters :name parameter </responseStatus>

</response>

Note : the name parameter that will be provided is the first wrong parameter provided.

2.2.2.3 Call Forwarding No Answer.

Request:
<?xml version="1.0"?>
<Request type="CallForwardingNoAnswer" login="value" password="value" version="1.0">
<CallForwardingNoAnswer>
<ID>003292703000</ID>
<Enabled>True/False</Enabled>
<TelNo>092999999 </TelNo>
<TimeOut>5</TimeOut>
</CallForwardingNoAnswer>
</Request>

Response:
<?xml version="1.0"?>
<response type="CallForwardingNoAnswer">
<responseStatus code=”value”> response message </responseStatus>
if
<responseStatus code =”12”> error in parameters :name parameter </responseStatus>

</response>

Note : the name parameter that will be provided is the first wrong parameter provided.

2.2.2.4 Call Forwarding on Busy.

Request:
<?xml version="1.0"?>
<Request type="CallForwardingBusy" login="value" password="value" version="1.0">
<CallForwardingBusy>
<ID>003292703000</ID>
<Enabled>True/False</Enabled>
<TelNo>092999999 </TelNo>
</CallForwardingBusy>
</Request>

Response:
<?xml version="1.0"?>
<response type="CallForwardingBusy ">
<responseStatus code=”value”> response message </responseStatus>
if
<responseStatus code =”12”> error in parameters :name parameter </responseStatus>

27
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

</response>

Note : the name parameter that will be provided is the first wrong parameter provided.
The logic concerning the NoA is as next :

- When a number starts with 0 (1 zero ), then NoA = National. Nummer must be stripped of that
leading 0.
- When a number starts with 00 (2 zeros ), then NoA = National. Nummer must be stripped of that
leading 00..
- The rest: error message when not succesful .

No other checks are performed on the input of the numbers

2.2.2.5 Call Barring.

Get Call Barring Rule Request (returns a list of all active call barring rules):
<?xml version="1.0"?>
<Request type="GetCallBarring" login="value" password="value" version="1.0">
<CallBarring>
<ID>003292703000</ID>
<GetRules/>
</CallBarring>
</Request>

Response:

<?xml version="1.0"?>
<response type=" GetCallBarring ">
<responseStatus code=”value”> response message </responseStatus>
if
<responseStatus code =”12”> error in parameters :name parameter </responseStatus>
if
<responseStatus code =”0”> succesful </responseStatus>
<CallBarring>
<Rules>
<Rule>0032%</Rule> or <RuleID>1</RuleID> /* either a prefix or ID*/
</Rules>
</CallBarring>

</response>

Note : the name parameter that will be provided is the first wrong parameter provided.

Add Call Barring Rule Request (add a new call barring rule):
<?xml version="1.0"?>
<Request type="AddCallBarring" login="value" password="value" version="1.0">
<CallBarring>
<ID>003292703000</ID>
<AddRule>0032%<AddRule> or <AddRuleID>1<AddRuleID> /* either a prefix or ID*/
<AddRule>0033%<AddRule> or <AddRuleID>2<AddRuleID> /* either a prefix or ID*/
Or
<AddRule>0032%,0033%<AddRule> or <AddRuleID>1,2<AddRuleID> /* either a prefix or
ID*/
</CallBarring>
</Request>

28
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

Response:
<?xml version="1.0"?>
<response type="AddCallBarring">
<responseStatus code=”value”> response message </responseStatus>
if
<responseStatus code =”12”> error in parameters :name parameter </responseStatus>

</response>

Note : the name parameter that will be provided is the first wrong parameter provided.

Delete Call Barring Rule Request (removes the call barring with the passed ID):
<?xml version="1.0"?>
<Request type="DeleteCallBarring" login="value" password="value" version="1.0">
<CallBarring>
<ID>003292703000</ID>
<DeleteRule>0032%<DeleteRule> or <DeleteRuleID>1<DeleteRuleID>/* either a prefix or
ID*/
<DeleteRule>0033%<DeleteRule> or <DeleteRuleID>2<DeleteRuleID>/* either a prefix or
ID*/
Or
<DeleteRule>0032%,0033%<DeleteRule> or <DeleteRuleID>1,2<DeleteRuleID>/* either a
prefix or ID*/

</CallBarring>
</Request>

Response:
<?xml version="1.0"?>
<response type="DeleteCallBarring">
<responseStatus code=”value”> response message </responseStatus>
if
<responseStatus code =”12”> error in parameters :name parameter </responseStatus>

</response>

Note : the name parameter that will be provided is the first wrong parameter provided.

Note about Call Barring :


1. It must be that Nature of Address and conversion with interfacing towards the Adabas of a call
barring rule the value 3 will be used for National Calls (leading zero) and value 4 for
International Calls
2. It must be that Nature of Address and conversion with interfacing towards the Adabas of a call
barring rule ID the value 3 will be used for National Calls (leading zero) and value 4 for
International Calls
3.

szFieldName lCodeID szDescription Conversion


CallBarringID 1 01,02,03,04,05,06,07,08,09 strip leading 0
CallBarringID 2 001,002,003,004,005,006,007,008,009 strip leading 00
CallBarringID 3 090,077 strip leading 0
4. On the method ‘ Get call barring info’, the stripped leading zero’s need to be added .In case of
a National (value 3 of NOA ) this will be 1 leading zero (0) and for International (value 4 of
NOA) this will be 2 leading zero (00).

29
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

The logic concerning the NoA is as next :

- When a number starts with 0 (1 zero ), then NoA = National. Nummer must be stripped of that
leading 0.
- When a number starts with 00 (2 zeros ), then NoA = National. Nummer must be stripped of that
leading 00..
- The rest: error message when not succesful .
No other checks are performed on the input of the numbers

2.2.2.6 Voice Mail.

Get Voice Mail Messages Request (returns a list of all voicemail messages):
<?xml version="1.0"?>
<Request type="GetVoiceMailMessages" login="value" password="value" version="1.0">
<VoiceMail>
<ID>003292703000</ID>
<GetMessages/>
</VoiceMail>
</Request>

Response:
<?xml version="1.0"?>
<response type=" GetVoiceMailMessages ">
<responseStatus code=”value”> response message </responseStatus>
if
<responseStatus code =”12”> error in parameters :name parameter </responseStatus>
if
<responseStatus code =”0”> succesful </responseStatus>
<VoiceMail>
<GetMessages>
<Messages>
<Message ID=”99”>
<From>003292709999</From>
<DateTime>2005/01/01 20:00</DateTime>
<New>Yes/NO</New>
</Message>
</Messages>
</GetMessages>
</VoiceMail>

</response>

Note : the name parameter that will be provided is the first wrong parameter provided.

Delete Voice Mail Message Request (removes the message with the corresponding ID):
<?xml version="1.0"?>
<Request type="DeleteVoiceMailMessage" login="value" password="value" version="1.0">
<VoiceMail>
<ID>003292703000</ID>
<DeleteMessage>99<DeleteMessage>
</VoiceMail>
</Request>

Response:
<?xml version="1.0"?>
<response type="DeleteVoiceMailMessage ">
30
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

<responseStatus code=”value”> response message </responseStatus>


if
<responseStatus code =”12”> error in parameters :name parameter </responseStatus>

</response>

Note : the name parameter that will be provided is the first wrong parameter provided.

Get ftp address for the Voice Message Request (returns a URL which is only valid for several minutes
from where the message (WAV file) with the passed id can be downloaded by the user):
<?xml version="1.0"?>
<Request type="GetFTPVoiceMailMessage" login="value" password="value" version="1.0">
<VoiceMail>
<ID>003292703000</ID>
<GetURL>99< GetURL >
</VoiceMail>
</Request>

Response:

<?xml version="1.0"?>
<response type="GetFTPVoiceMailMessage ">
<responseStatus code=”value”> response message </responseStatus>
if
<responseStatus code =”12”> error in parameters :name parameter </responseStatus>
if
<responseStatus code =”0”>succesful </responseStatus>
<VoiceMail>
<GetURL>
ftp://IPaddress_server.filename
</GetURL>
</VoiceMail>

</response>

Note : the name parameter that will be provided is the first wrong parameter provided.

2.2.3 Advanced Features

2.2.3.1 Voice Mail Pro.

No settings available.

2.2.3.2 VoiceMail2Mail.

Request:
<?xml version="1.0"?>
<Request type="Voicemail2Mail" login="value" password="value" version="1.0">
<Voicemail2Mail>
<ID>003292703000</ID>
<Enabled>True/False</Enabled>
</Voicemail2Mail>
</Request>

Response:
<?xml version="1.0"?>
31
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

<response type="Voicemail2Mail">
<responseStatus code=”value”> response message </responseStatus>
if
<responseStatus code =”12”> error in parameters :name parameter </responseStatus>

</response>

Note : the name parameter that will be provided is the first wrong parameter provided.

2.2.3.3 Fax2Mail.

No settings available.

2.2.3.4 AddressBook.

To be defined later.

2.2.3.5 WebMail.

No settings available.

2.2.3.6 SMSNotificationVoiceMail

Request:
<?xml version="1.0"?>
<Request type="SMSNotificationVoicemail" login="value" password="value" version="1.0">
<SMSNotificationVoicemail>
<ID>003292703000</ID>
<Enabled>True/False</Enabled>
</SMSNotificationVoicemail>
</Request>

Response:

<?xml version="1.0"?>
<response type=’ SMSNotificationVoicemail’">
<responseStatus code=”value”> response message </responseStatus>
if
<responseStatus code =”12”> error in parameters :name parameter </responseStatus>

</response>

Note : the name parameter that will be provided is the first wrong parameter provided.

2.2.3.7 SMSNotificationFAX.

Request:
<?xml version="1.0"?>
<Request type="SMSNotificationFax" login="value" password="value" version="1.0">

32
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

<SMSNotificationFax>
<ID>003292703000</ID>
<Enabled>True/False</Enabled>
</SMSNotificationFax>
</Request>

Response:
<?xml version="1.0"?>
<response type=’ SMSNotificationFax’">
<responseStatus code=”value”> response message </responseStatus>
if
<responseStatus code =”12”> error in parameters :name parameter </responseStatus>

</response>

Note : the name parameter that will be provided is the first wrong parameter provided.

2.3 Radius interface


2.3.1 Technical

This section describes the interface between the SDP of Artilium and the operator get
the Radius info of the PPP session . This will allow the SDP to cross check the
information available for that customer with the data available in the Cirpack LEN
(SIP registrar), SDP (stored data) and the ACS (CPE information).

The data available in the Radius log server is given in the next example:

Example (trace Radius log)


Fri Jun 17 00:00:02 2005
Acct-Session-Id = "1/0/0/185.699_00AF7822"
Framed-Protocol = PPP
Framed-IP-Address = 82.174.72.245
User-Name = "[email protected]"
X-Ascend-Connect-Progress = 60
Acct-Authentic = RADIUS
Acct-Status-Type = Start
NAS-Port-Type = Virtual
NAS-Port = 280560315
Connect-Info = "pppoa1-atm"
Service-Type = Framed-User
NAS-IP-Address = 62.58.126.101
Acct-Delay-Time = 0
Client-IP-Address = 62.58.126.101
Stripped-User-Name = "vt662257"
Realm = "versadsl.be"
Acct-Unique-Session-Id = "791b9dd06ab1d533"
Timestamp = 1118959202
ATM_VPI=10
ATM_VCI=12
ATM_PortID=9
33
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

The information that needs to be available for the SDP is at least the following:
 Date & Time
 User-Name
 Client-IP-Address
 Stripped-User-Name
 Realm
 ATM_VPI
 ATM_VCI
 ATM_PortID
 ATM_IntFceID

The SDP will retrieve this data from the Radius Log server via XML HTTP with the following request
(per user name or id):

Request:
<Radiusr>
<Request version="1.0">
<UserID>
<ID>[email protected]</ID>
</UserID>
</Request>
</Radius>

Response:
<Radius>
<Response>
<RadiusInfo>
<DateTime>YYYY-MM-DDThh:mm:ssTZD</DateTime>
<UserName>[email protected]</UserName>
<StrippedUserName>VTxxxxx</StrippedUserName>
<Realm>versatel.be</Realm>
<ClientIPAddress >62.58.126.101</ClientIPAddress>
<ATMVPILog>99</ATMVPILog>
<ATMVCILog>99</ATMVCILog>
<ATMPortIDLog>99</ATMPortIDLog>
<ATMIntFceIDLog>99</ATMIntFceIDLog>
………….<BRUONodeID>99</BRUONodeID>
………….<BRUOShelfID>99</BRUOShelfID>
………….<BRUOSlotID>99</BRUOSlotID>
………….<BRUOPortID>99</BRUOPortID>
………….<BRUOVlanID>99</BRUOVlanID>
………….<ConnectInfo>pppoa1-ATM</ConnectInfo>
</RadiusInfo>
</Response>
</Radius>

It is possible that the user is unknown (this could happen due to time lag) and in this
case the fields are empty. Since the requests are sent either every x minutes or
during a new registration the info of the user should become available during the next
request.

34
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

2.4 User Status Interface

This section describes the mechanism to check the presence (first time detected) and
verify if the customer is allowed to make calls or not (Nomadism and SIP locking).

The mechanism describing this process is illustrated in the following paragraphs.

A customer of Versatel will subscribe via the Versatel portal to order new services
(voice and internet). The OSS of Versatel will then add the customer data (and
update the provisioned data during provisioning process such as ATM parameters
which will identify the ‘physical location’ of the user) in the SDP via the described
XML interface. Two sets of ATM parameters have been foreseen to allow a fluently
move of a customer from one site to another.
The SDP will store this data either in the SDP storage (SQL server) or SIP server
storage (Adabas server). When a user or user data is added or updated then this
data will immediately be added or updated in the databases.

To allow the user to make calls after installation of the CPE the flag ‘Enabled’ should
be set to ‘True’ from the beginning.

When the CPE is installed at the customer site then a PPP session will be initiated to
the ERX (BRAS) which will reserve an IP address for that CPE (IP address will be
changed every day). This information must be sent to the Radius Server log server
where the following parameter per user are stored during the lifetime of the PPP
session: VTid (unique identifier of user), ATMlog parameters
(VPI,VCI,PortID,IntFceID) ,BRUO (Node,Shelf,Slot,Port,Vlan) and IPlog (IP address
of CPE).

Once the PPP session is active the CPE will make a SIP registration per CLI in the
SIP server and the IP address (Ipsip)of the CPE will be stored in de SIP server
storage (Adabas).

Based on the events of each SIP registration (future phase: will first be done via
polling in the SIP server database each X minutes with X still to be defined but as low
as possible) the SDP will check for each CLI (or each SIP registration) if the IP
address is changed and if the customer is enabled. If this is the case then the SDP
will read the Radius log for each user and perform the following checks and actions:

 Check ATM/BRUO parameters: provisioned parameters must match those


read from the Radius log server (either ATM1 , ATM2 or BRUO must match)
 Check IP address: IP address in the SIP server must match the IP address in
the Radius log server.
 Check if first time (presence check) :if IP address in SDP was empty.
 Suspend CLI in the SIP server if allowed and no-match ATM
 Suspend CLI in the SIP server after X/Y time there was no IP match where X
must be flexibel.The principle to define the value of X/Y will be described
further in this chapter
35
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

 Un-suspend the CLI in the SIP server if allowed and match ATM / BRUO /IP
 Inform the OSS of the user status.

36
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

37
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

Stages of the Nomadism check


The nomadism check will run over maximimum 13 different stages
The different stages as set in the picture on the previous page are defined as :
Stage 1 : get CLI info Stage 8 : check SIP block
Stage 2 : check IPAddress change Stage 9 : get emergencyzone
Stage 3 : check if CLI enabled Stage 10 : unsuspend extension
Stage 4 : nomadism check Stage 11 : update parameters
Stage 5 : check ATM/BRUO settingsStage 12 : start call for welcome
Stage 6 : get ATM/BRUO/IP Log Stage 13 : inform user status
Stage 7 : nomadism check

Manual Start/Stop Nomadism Check

When the Nomadism Check is manually stopped and/or started an event will be
generated towards the CSM. If required an action trigger to create a TRAP can be
activated.

Action to get to the SUSPEND Status when IPLOG and IPSIP aren’t equal :

The nomadism check allows to be flexible concerning when a extension will be set in
suspend status regarding the amount of mismatch between IPLog en IPSip. Per
extension the amount of mismatches will be kept and each time a mismatch occurs
an event will be generated towards the CSM In the event there will be information
mentioning how many times this mismatch has been noticed by the servicer.
When the value X is reached the extension will be suspended an the actions as
describe belwo will occur.(see Action when SUSPEND Status is reached )
The value X is configurable in the .config file (No GUI ).

Action when SUSPEND Status is reached

An Event towards the CSM will be sended at the moment that a CLI is going into
Suspended status due to the Nomadism Check. This will be in the case at the
moment the ATM values don’t correspond or that the X value is reached for a specific
extension. If required an action trigger to create a TRAP can be activated.

Action when MASS SUSPEND Status is reached

There will be two (2) possible workable way :

1. Y suspends per polling-cycle. Within 1 polling-cycle no more then Y numbers


can be suspended. If within 1 polling cycle Y is reached then the polling-cycle
is stopped,the nomadisme service is stopped and disabled.
An event will be generated towards the CSM.

2. Y suspends in last Z polling-cycles . When the sum of the total amount


suspends of the last Z polling-cycles is bigger then Y, the the polling-cycle is
being stopped as also the nomadism service and disabled
An event will be generated towards the CSM.

38
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

As the service needs to be restarted, the service explicit needs to be restarted in the
proper way.A reboot of the system won’t be doing that .

The values for Y en Z are configurable in the .config file (No GUI ).
The counters kept for the values Y en Z when the service is stopped or disabled.
The counters will be zero when the service in started

NO Nomadism Check willl be performed when there is no information received from


the VT Radius server.An Event towards the CSM will be generated at that moment
and the check will go on with the next extension .

Overview of the stages that are runned when nomadism check is activated can be
seen in de nomadismcheckdebugfile that as hourly being generated :
yyyy-mm-dd hh:mm:ss [ref] DEBUG Artilium.VoIPNomadismCheckSvc.VoIPNomadismCheckService Processing record
extension=XXXXXXXX, contact=<sip:[email protected]:ZZZZ>
yyyy-mm-dd hh:mm:ss [ref]DEBUG Artilium.VoIPNomadismCheckSvc.VoIPNomadismCheckService * Parsed IPAddress:
YY.YYY.YYY.Y
yyyy-mm-dd hh:mm:ss [ref]DEBUG Artilium.VoIPNomadismCheckLib.NomadismCheck STAGE 1
yyyy-mm-dd hh:mm:ss [ref]DEBUG Artilium.VoIPNomadismCheckLib.NomadismCheck Retrieved PinRecord for
ExtensionNum=XXXXXXXX: CliPin=XXXXXXXX,Sn=
XXXXXXXX,Status=Active,Type=Cli,PppUserId=value,AgentId=value,DistributorId=value,LanguageId=value
yyyy-mm-dd hh:mm:ss [ref] DEBUG Artilium.VoIPNomadismCheckLib.NomadismCheck STAGE 2
yyyy-mm-dd hh:mm:ss [ref]INFO Artilium.VoIPNomadismCheckLib.NomadismCheck IPAddress has changed from
LastIPAddress= to IPAddress=YY.YYY.YYY.Y
yyyy-mm-dd hh:mm:ss [ref] DEBUG Artilium.VoIPNomadismCheckLib.NomadismCheck STAGE 3
yyyy-mm-dd hh:mm:ss [ref] DEBUG Artilium.VoIPNomadismCheckLib.NomadismCheck STAGE 4
yyyy-mm-dd hh:mm:ss [ref]DEBUG Artilium.VoIPNomadismCheckLib.NomadismCheck STAGE 5
yyyy-mm-dd hh:mm:ss [ref]DEBUG Artilium.VoIPNomadismCheckLib.NomadismCheck STAGE 6
yyyy-mm-dd hh:mm:ss [ref] DEBUG Artilium.VoIPNomadismCheckLib.XmlAtmIpLog Sending RadiusLog XML POST:
(Len=value)
<Radius>
<Request>
<UserID>
<ID>value</ID>
</UserID>
</Request>
</Radius>
yyyy-mm-dd hh:mm:ss [ref] DEBUG Artilium.VoIPNomadismCheckLib.XmlAtmIpLog Received RadiusLog XML Response:
(Len=value)
<Radius><Response version="1.0"><RadiusInfo><DateTime>yyyy-mm-ddThh:mm:ss</DateTime><UserName>value</
UserName><StrippedUserName>partvalue</StrippedUserName><Realm>partvalue</
Realm><ClientIPAddress>YY.YYY.YYY.Y</ClientIPAddress><ATMIntFceLog>value</
ATMIntFceLog><ATMPortIDLog>value</ATMPortIDLog><ATMVPILog>value</ATMVPILog><ATMVCILog>value</
ATMVCILog></RadiusInfo></Response></Radius>
yyyy-mm-dd hh:mm:ss [ref] DEBUG Artilium.VoIPNomadismCheckLib.NomadismCheck
LogRecord=AtmLog={vpi=value,vci=value,portId=value,intfce=value}, IpLog=YY.YYY.YYY.Y
yyyy-mm-dd hh:mm:ss [ref]DEBUG Artilium.VoIPNomadismCheckLib.NomadismCheck STAGE 7
yyyy-mm-dd hh:mm:ss [ref]INFO Artilium.VoIPNomadismCheckLib.NomadismCheck Nomadism match for ATM set (1or2) of
CLI/Pin=XXXXXXXX
yyyy-mm-dd hh:mm:ss [ref] DEBUG Artilium.VoIPNomadismCheckLib.NomadismCheck STAGE 8
yyyy-mm-dd hh:mm:ss [ref] INFO Artilium.VoIPNomadismCheckLib.NomadismCheck Sip IP match for CLI/Pin=XXXXXXXX
yyyy-mm-dd hh:mm:ss [ref] DEBUG Artilium.VoIPNomadismCheckLib.NomadismCheck STAGE 9
yyyy-mm-dd hh:mm:ss [ref] DEBUG Artilium.VoIPNomadismCheckLib.NomadismCheck Retrieving SpecialZoneID for
SpecialZone='name' from Adabas
yyyy-mm-dd hh:mm:ss [ref] INFO Artilium.VoIPNomadismCheckLib.NomadismCheck Retrieved SpecialZoneID='value' from
Adabas for SpecialZone='name' from Adabas
yyyy-mm-dd hh:mm:ss [ref] DEBUG Artilium.VoIPNomadismCheckLib.NomadismCheck STAGE 10
yyyy-mm-dd hh:mm:ss [ref] INFO Artilium.VoIPNomadismCheckLib.NomadismCheck Unsuspending ExtensionNum
'XXXXXXXX' in Adabas
yyyy-mm-dd hh:mm:ss [ref]DEBUG Artilium.VoIPNomadismCheckLib.NomadismCheck STAGE 11
yyyy-mm-dd hh:mm:ss [ref] DEBUG Artilium.Database.Log Writing log-entries to log file
yyyy-mm-dd hh:mm:ss [ref]DEBUG Artilium.Database.Log Log record:
TableType=CliPin,TableKey=XXXXXXXX;20301;,Command=Update parameter 'Last IP address' (20301) for CLI/PIN
'XXXXXXXX', scenario parameter: no,Values=string 1: 'YY.YYY.YYY.Y',Changed=
39
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

yyyy-mm-dd hh:mm:ss [ref] DEBUG Artilium.Database.Log Log record:


TableType=CliPin,TableKey=XXXXXXXX;20302;,Command=Update parameter 'ATM 1 PVC' (20302) for CLI/PIN 'XXXXXXXX',
scenario parameter: no,Values=string 1: '0',Changed=
yyyy-mm-dd hh:mm:ss [ref] DEBUG Artilium.Database.Log Log record:
TableType=CliPin,TableKey=XXXXXXXX;20303;,Command=Update parameter 'ATM 1 VCI' (20303) for CLI/PIN 'XXXXXXXX',
scenario parameter: no,Values=string 1: '0',Changed=
yyyy-mm-dd hh:mm:ss [ref] DEBUG Artilium.Database.Log Log record:
TableType=CliPin,TableKey=XXXXXXXX;20304;,Command=Update parameter 'ATM 1 PortID' (20304) for CLI/PIN
'XXXXXXXX', scenario parameter: no,Values=string 1: '0',Changed=
yyyy-mm-dd hh:mm:ss [ref]DEBUG Artilium.Database.Log Log record:
TableType=CliPin,TableKey=XXXXXXXX;20304;,Command=Update parameter 'ATM 1 IntFce' (20304) for CLI/PIN
'XXXXXXXX', scenario parameter: no,Values=string 1: '0',Changed=
yyyy-mm-dd hh:mm:ss [ref]DEBUG Artilium.Database.Log Log record:
TableType=CliPin,TableKey=XXXXXXXX;20305;,Command=Update parameter 'ATM 1 Emergency zone' (20305) for CLI/PIN
'XXXXXXXX', scenario parameter: no,Values=string 1: '0',Changed=
yyyy-mm-dd hh:mm:ss [ref] DEBUG Artilium.Database.Log Writing log records succeeded
yyyy-mm-dd hh:mm:ss [ref]DEBUG Artilium.VoIPNomadismCheckLib.NomadismCheck STAGE 12
yyyy-mm-dd hh:mm:ss [ref] INFO Artilium.VoIPNomadismCheckLib.NomadismCheck Adding outbound call for ExtensionNum=
'XXXXXXXX'
yyyy-mm-dd hh:mm:ss [ref] DEBUG Artilium.Util.TableQueueSender VoIPNomadismCheck: Message
Artilium.VoIPNomadismCheckLib.OutboundCall: First executing synchronously
yyyy-mm-dd hh:mm:ss [ref] INFO Artilium.Util.TableQueueSender VoIPNomadismCheck: Message
Artilium.VoIPNomadismCheckLib.OutboundCall: Synchronous execution succeeded
yyyy-mm-dd hh:mm:ss [ref] DEBUG Artilium.VoIPNomadismCheckLib.NomadismCheck STAGE 13
yyyy-mm-dd hh:mm:ss [ref]INFO Artilium.VoIPNomadismCheckLib.NomadismCheck Sending user status for ExtensionNum
'XXXXXXXX', Type=InitialPresence
yyyy-mm-dd hh:mm:ss [ref]DEBUG Artilium.Util.TableQueueSender VoIPNomadismCheck: Message
Artilium.VoIPNomadismCheckLib.XmlUserStatus: First executing synchronously
yyyy-mm-dd hh:mm:ss [ref] INFO Artilium.VoIPNomadismCheckLib.XmlUserStatus Sending User Status XML Request for
XXXXXXXX to URL http://aa.aaa.aaa.aa/
yyyy-mm-dd hh:mm:ss [ref] DEBUG Artilium.VoIPNomadismCheckLib.XmlUserStatus Sending UserStatus XML POST to
http://aa.aaa.aaa.aa/ (Len=831)
<?xml version="1.0"?>
<request type="UserStatus" version="1.0">
<timeStamp>yyyy-mm-ddThh:mm:ss</timeStamp>
<extensionNum> XXXXXXXX</extensionNum>
<sipIpAddress>YY.YYY.YYY.Y</sipIpAddress>
<atmSetMatched>value</atmSetMatched>
<type>InitialPresence</type>
<logAtmPvc>value</logAtmPvc>
<logAtmVci>value</logAtmVci>
<logAtmPortNr>value</logAtmPortNr>
<logAtmIntFce>value</logAtmIntFce>
<logIpAddress>YY.YYY.YYY.Y</logIpAddress>
<pppUserId>value</pppUserId>
<agentId>value</agentId>
<distributerId />
<cliPin>XXXXXXXX</cliPin>
<nomadismCheckEnabled>True</nomadismCheckEnabled>
<sipBlockCheckEnabled>True</sipBlockCheckEnabled>
<provAtm1Pvc />
<provAtm1Vci />
<provAtm1PortNr />
<provAtm1IntFce/>
<provAtm2Pvc>value</provAtm2Pvc>
<provAtm2Vci>value</provAtm2Vci>
<provAtm2PortNr>value</provAtm2PortNr>
<provAtm2IntFce>value</provAtm2IntFce>
<previousIpAddress />
</request>
yyyy-mm-dd hh:mm:ss [ref]DEBUG Artilium.VoIPNomadismCheckLib.XmlUserStatus Received UserStatus XML Response:
(Len=value)
<?xml version="1.0" encoding="utf-8"?><response type="UserStatus" version="1.0"><responseStatus
code="0">ok</responseStatus></response>
yyyy-mm-dd hh:mm:ss [ref] INFO Artilium.VoIPNomadismCheckLib.XmlUserStatus Received succesful response, extension=
XXXXXXXX, code=0, message=ok
yyyy-mm-dd hh:mm:ss [ref]INFO Artilium.Util.TableQueueSender VoIPNomadismCheck: Message
Artilium.VoIPNomadismCheckLib.XmlUserStatus: Synchronous execution succeeded

It is foreseen that these files will be ceased after a period of 7 days

40
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

2.4.1 Initial Check (Presence)

The first time a ‘new’ customer is detected via the SDP (first SIP registration) then the
system will check whether this customer is already provisioned in the SDP with the
same parameters (UserID and ATM parameters). A XML inform message will be sent
to inform the OSS containing the user status.

The data written in this XML inform message is the following:


 User ID (full username - Null if customer not found)
 Agent ID (Null if customer not found)
 Distributor ID (Null if customer not found)
 Telephone number (Null if customer not found)
 Timestamp (datetime: YYYY-MM-DDThh:mm:ssTZD, with T the start to
indicate the beginning of the time element and TZD is the timezone delay e.g.
+01:00)
 Client IP Address (if available)
 New Status Customer (Active or blocked or NULL if customer not found)
 ATM /BRUO set matched: ‘1’ or ‘2’ or ‘none’
 Reason blocked
o if new status = Active or NULL then NULL
o if no match ATM parameters: ‘ATM blocking’
o if no match BRUO parameters : ‘BRUO blocking’
o if no X match SIP account: ‘SIP blocking’

This XML info is used by the Operator’s CRM & Order Processing tool to start e.g.
Number Porting. In case no telephone number is present or null then the customer
was not found in the SDP (missing data).

Once this XML inform message for presence is sent and the customer data exists,
then the SDP will add an ‘outbound’ in the VM system so that this system will call the
customer (via the Cirpack) to play a welcome announcement. This outbound will be
repeated 3 times each 30min in case the call cannot successfully be terminated.

When the checks for ATM and IP does not match then the customer will be de-
activated in the Cirpack Adabas database (H_SUSPEND_EXT set to 1 meaning
suspended).

When there is a match then the field H_SUSPEND_EXT will be updated to 0 (was
normally by default set to 0 to allow calls). From then on the customer can start
making outgoing calls.

No second welcome message is given anymore.

When the Initial presence was succesfull a logging on extension level in the Arta
SWA will be available for verification not for reporting.
The first presence detection mechanism is started and stopped simular with the
nomadism check in general. So if The Nomadism Check is disabled this implements
that the timestamp towards the SWA can’t be delivered.
41
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

XML Request “ATM/Bruo/IP log”


<?xml version="1.0" encoding="utf-8"?>
<Radius>
<Request>
<UserID>userid</UserID>
</Request>
</Radius>

XML Response “ATM/Bruo/IP log”


<?xml version="1.0" encoding="utf-8"?>
<Radius>
<Response>
<RadiusInfo>
<DateTime>2006-01-01T00:00:00TZD</DateTime>
<UserName>[email protected]</UserName>
<StrippedUserName>VTxxxxx</StrippedUserName>
<Realm>versatel.be</Realm>
<ClientIPAddress>10.10.10.10</ClientIPAddress>
<ATMVPILog>11</ATMVPILog>
<ATMVCILog>12</ATMVCILog>
<ATMPortIDLog>13</ATMPortIDLog>
<ATMIntFceIDLog>14</ATMIntFceIDLog>
<BRUONodeID>21</BRUONodeID>
<BRUOShelfID>22</BRUOShelfID>
<BRUOSlotID>23</BRUOSlotID>
<BRUOPortID>24</BRUOPortID>
<BRUOVlanID>25</BRUOVlanID>
<ConnectInfo>26</ConnectInfo>
</RadiusInfo>
</Response>
</Radius>

XML Request “User Status”


<?xml version="1.0" encoding="utf-8" ?>
<request type="UserStatus" version="1.0">
<timeStamp>YYYY-MM-DDThh:mm:ssTZD</timeStamp>
<!-- Info retrieved from Cirpack -->
<extensionNum>extensionNum</extensionNum>
<sipIpAddress>sipIpAddress</sipIpAddress>
<!-- Info generated during nomadism check -->
<!-- atmSetMatched: 1/2=Atm set 1/2 matched, 0=no match, (empty)=no
matching performed -->
<atmSetMatched>1/2/none/(empty)</atmSetMatched>

<type>CliPinNotFound/NoAtmSetProvisioned/NoAtmIpLog/LockingIncidentSip/
LockingIncidentSipWithoutSuspend/LockingIncidentAtm/LockingIncidentBruo/
InitialPresence/AtmSetMove</type>
<!-- Info retrieved from Atm/Ip log -->
<!-- These fields will be (empty) if no Atm/Ip log was returned -->
<logAtmPvc>(empty)/logAtmPvc</logAtmPvc>
<logAtmVci>(empty)/logAtmVci</logAtmVci>
<logAtmPortNr>(empty)/logAtmPortNr</logAtmPortNr>
<logAtmIntFce>(empty)/logAtmIntFce</logAtmIntFce>
<logIpAddress>(empty)/logIpAddress</logIpAddress>
<logBruoNodeId>(empty)/logBruoNodeId</logBruoNodeId>
<logBruoShelfId>(empty)/logBruoShelfId</logBruoShelfId>
<logBruoSlotId>(empty)/logBruoSlotId</logBruoSlotId>
<logBruoPortId>(empty)/logBruoPortId</logBruoPortId>

42
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

<logBruoVlanId>(empty)/logBruoVlanId</logBruoVlanId>
<logConnectInfo>(empty)/logConnectInfo</logConnectInfo>
<!-- Info retrieved from cli/pin -->
<!-- These fields will be (empty) if no cli/pin was found -->
<pppUserId>(empty)/PPPUserID</pppUserId>
<agentId>(empty)/AgentID</agentId>
<distributerId>(empty)/DistributerID</distributerId>
<cliPin>(empty)/TelNo</cliPin>
<nomadismCheckEnabled>(empty)/True/False</nomadismCheckEnabled>
<sipBlockCheckEnabled>(empty)/True/False</sipBlockCheckEnabled>
<connectType>(empty)/Broba/Bruo</connectType>
<provAtm1Pvc>(empty)/provAtm1Pvc</provAtm1Pvc>
<provAtm1Vci>(empty)/provAtm1Vci</provAtm1Vci>
<provAtm1PortNr>(empty)/provAtm1PortNr</provAtm1PortNr>
<provAtm2Pvc>(empty)/provAtm2Pvc</provAtm2Pvc>
<provAtm2Vci>(empty)/provAtm2Vci</provAtm2Vci>
<provAtm2PortNr>(empty)/provAtm2PortNr</provAtm2PortNr>
<provBruoNodeId>(empty)/provBruoNodeId</provBruoNodeId>
<provBruoShelfId>(empty)/provBruoShelfId</provBruoShelfId>
<provBruoSlotId>(empty)/provBruoSlotId</provBruoSlotId>
<provBruoPortId>(empty)/provBruoPortId</provBruoPortId>
<previousIpAddress>(empty)/previousIpAddress</previousIpAddress>

<sipBlockCheckMismatchCount>(empty)/Count</sipBlockCheckMismatchCount>
</request>

XML Response “User Status”


<?xml version="1.0" encoding="utf-8" ?>
<response type="UserStatus" version="1.0">
<responseStatus code="value">response message</responseStatus>
</response>

2.4.2 Cross Check (Operational locking)

Based on the received information from the Radius server the SDP will cross check
this received parameters and compare them with the information available in the
Cirpack Adabas server each time a new SIP registration is done and if the IP address
was changed (detected in SDP).

The following will be checked:


 Username (=UserID as added via XML) must be available and the same in the
SDP
 ATM parameters: ATM parameters received from the Radius must math those
stored in the SDP (ATM 1 or ATM 2).
 BRUO parameters : BRUO parameters received from the Radius must math
those stored in the SDP. The VLANID won’t be checked but just be added if
provided
 SIP IP address must be the same in the Adabas and Radius. In this case
based on the user id received in the radius info the SDP will look up the
telephone number(s) if the number is present (PinInfo) associated to this user
id and will compare it with the IP address stored in the Adabas (registrar).
 EMERGENCY ZONE : parameters received from the Clients interface via XML
must be stored in the Adabas depending on the ATM set detected via Radius.
43
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

Remark: in case both ATM parameter sets stored in the SDP are empty (not
provisioned) and the BRUO parameters are empty the ATM/BRUO check will not be
performed.
in case both ATM parameter sets stored in the SDP are empty (not provisioned) and
the BRUO parameters are present the ATM/BRUO check will be performed

The results of the checks are also sent via XML to the OSS of Versatel (see 2.4.1).

If there is a mismatch in one of these criteria then the SDP will block the customer if
allowed (all outgoing calls except emergency calls). This will be done by updating the
field H_SUSPEND_EXT=1 in the Adabas server of the Cirpack for the telephone
number(s) assigned to this customer but only when the parameters for the customer
are set to allowed blocking for SIP and ATM check.

If there is a match for all criteria then the SDP will activate the customer again if
allowed (Enable=True) (allow outgoing calls). This will be done by updating the field
H_SUSPEND_EXT=0 in the Adabas server of the Cirpack for the telephone
number(s) assigned to this customer.

The emergency zone set in the field H_SPECNUMZONE_EXT will be adapted when
there is a change with the set ATM 1 or ATM 2. As long as the ATM log match the
ATM detected no changes will be performed . When there is a change of set
between ATM 1 or ATM 2 is detected the field H_SPECNUMZONE_EXT will be
changed to the matched set .The mismatched ATM parameters of ATM set and
EmergencyZone will be cleared at that point.When the BRUO parameters are
enabled the field H_SPECNUMZONE_EXT will be used from the field that is set in
emergencyzone1.

Important Note : This change of set won’t happen in case the customer is not
enabled or the IP address hasn’t changed .

If for some reason the XML interface between Artillium and Versatel fails, the
telephone number will not be blocked and the authentication will be retried on next
attempt until authentication is possible.

Blocking mechanisms:

 Commercial blocking: via XML interface from VT as master (immediate update


in SIP server database)
 Nomadism blocking:
o CPE Nomadism from VT cloud to 3rd party cloud OR VT cloud to VT
cloud. Blocking based on ATM parameter check
o User Nomadism: a user could with his CD activate his telephone
number on an other VT CPE. Blocking based on SIP IP address.

44
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

2.5 Monitoring

Will be defined in a later stadium.

This will include the ‘presence’ and ‘availability’ checks e.g. in case a CPE
disappears for a certain reason this will create a monitoring event.

Artilium provides a tool, CSM (Central System Monitoring) that will collect all events
(SNMP, ACS, own events) in a database (on SDP) and that can transmit these
events as SNMP traps to another monitoring tool if required (see documentation
Artilium).

2.6 Adabas interface

This interface is an ODBC interface to allow the SDP to read and update information
from the Adabas server (connected to the Cirpack LEN).

This interface is used to:


 Create the customer and the extension (telephone number) (in CPN,GRP and
EXT tables)
 Modify the settings for the class5 services provided by the Cirpack:
1. CLI restriction: CLIR_ON_EXT
2. Call Forwarding Unconditional: FWD_UNC_ON_EXT and
FWD_UNC_NUM_EXT (FWD_UNC_NAT_EXT will always be set to 3
or 4).
3. Call Forwarding No Reply: FWD_NRP_ON_EXT and
FWD_NRP_NUM_EXT (FWD_NRP_NAT_EXT will always be set to 3
or 4).
4. Call Forwarding Busy: FWD_BUSY_ON_EXT and
FWD_BUSY_NUM_EXT (FWD_BUSY_NAT_EXT will always be set to
3 or 4).
5. Call Barring via PF_SCRL table (outgoing black list only and for each
extension the subscriber profile should have the field SCRLOUT_ABO
set to 1 and the field SCRL_MODE_OUT_EXT set to 1) and SCRL
table containing the numbers or prefixes (nature number set to national
(3)) blocked (barring rules).
 Verification of the username and domain name for the SIP sessions
(USERNAME_EXT and DOMAIN_EXT)
 Indicate the emergency zone for that customer (Special Number Zone in
H_SPECNUMZONE_EXT: list of available zones must be created in the
Cirpack and selected via the ADD_USER request)
 Set the call forwarding number in case of backup number available from
customer (CPE not reachable).
 Activate or block the customer (H_SUSPEND_EXT)

45
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

In an appendix we describe the relation between all the parameters defined where
they are stored (SDP, SIP server, ACS).

2.7 Voice Mail

This section describes the voice mail system more in detail.

2.7.1 Configuration

The voicemail system is connected via one E1 (ISDN) to the Cirpack (could be
expanded to more channels when required).

This system is an IP (Intelligent Peripheral) and is able to perform the following


functions in the network:

 IVR (e.g. outbound calls for welcome message)


 Voice mail and voicemail notification via outbound.

2.7.2 IVR

This system is used to give a welcome message to a new customer after the first
presence detection.

2.7.3 Voice Mail

The voicemail becomes active when a customer configures the call forwarding
features (calls deviated to the voicemail e.g. via a specific voice mail number). Calls
deviated to the voicemail will be answered by the voice mail system allowing the
caller to leave a message for the called person.

Once a message is left then the called person will be notified via an outbound
initiated by the voicemail system x times after a specific timeout (default setting to set
for the system). Also the operator can check the numbers of messages left via XMLor
can pickup the message.(via WAV file).

2.7.3.1 Settings.

Each customer will get a voice mailbox that is assigned when a new user is added
via XML. The following parameters will be set by default for all customers:

 Possibility to create a personalized welcome message


 Use by default of standard welcome message.
 Language set (NL, FR or UK) according to user settings (add_user via XML)

46
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

 The customer can access ‘free’ his or her voice mailbox (via specific access
number).
 Notification via outbound
 Recording of messages up to 1 hour or maximum 30 messages.
 Maximum duration of a message is 5 minutes
 Automatically removal of un-listened messages after 30 days.
 Automatically removal of saved messages after 15 days.
 By default of standard voicemail password : defined as 0000 (4 times zero)

De personalized greetings can be recorded by the customer by using (dial in) the
voice mail menu (mail box administration).

2.7.3.2 Flows.

We refer to our standard description for the voice mail system.

2.7.3.3 Notifications.

Standard notification is done via outbound. When a message is left for a


customer then the IVR platform will make x calls (parameter defined on
system level) to the customer each y minutes (parameter defined on
system level) to indicate that there is a new message.

It is possible to block this outbound mechanism per telephone number


(see parameters users).

Other MWI notification are currently analyzed via the MWI possibility
between Cirpack and CPE (provisioning via Adabas).

2.8 ACS interface


2.8.1 Technical

This section describes the interface between the SDP and the ACS.

Is still not yet defined (choice of ACS to be made).

2.9 ACS - CPE interface


2.9.1 Technical

This is based on TR-069 and will not be detailed in this document.

47
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

Appendix: link fields between different system databases:

FieldName SDP Artilium Fieldname Adabas Fieldname ACS


Fieldname
PPPUserID Address szuserID None
(cTypeAddress=0
PPPuserPWD szPassword None
AgentID Address.szCustomerNr None
(cTypeAddress=1)
AgentName Address.szName None
DistributorID Distributor.szName None
CliNumber PinInfo.szPINorCLIP EXTENSIONNUM_EXT,
NAME_EXT, LOG_EXT
USERNAME_EXT
TelPortNumberOnCPE Parameter (CLI level) None
CallForwardingBackup None H_CFBACKUPON_EXT (0
or 1),
H_CFBACKUPNUM_EXT
(number)
Email Address.szMail None
Name Address.szName None
Firstname Address.szFirstName None
Mobile Address.szMobilePhone, None
PinInfo.szTelephone
Enabled PinInfo.nStatus: active or H_SUSPEND_EXT=0
blocked (enabled) or 1 (blocked)
VoicemailPWD Parameter (CLI level) None
Voicemail Notification Parameter (CLI level) None
Language None H_LANGUAGE_EXT
(check content)
AccountStatus Address.cClassification None
PortedTel Parameter (CLI level) None
EmergencyZone 1 Parameter (CLI level) NAME_SP_ZONE
EmergencyZone 2 Parameter (CLI level) NAME_SP_ZONE
ATM1_VPI Parameter (CLI level) None
ATM1_VCI Parameter (CLI level) None
ATM1_PortID Parameter (CLI level) None
ATM2_VPI Parameter (CLI level) None
ATM2_VCI Parameter (CLI level) None
ATM2_PortID Parameter (CLI level) None
Nomadism Check Parameter (CLI level) None
SIP block Check Parameter (CLI level) None
SIP_Domain None DOMAIN_EXT
SIP_Password None PWD_EXT
SIP_Alias PinInfo.szCustomerName None
SIP_Proxy Parameter (CLI level) None
SIP_reregTime Parameter (CLI level) None
SIP_dialPlan Parameter (CLI level) None
CPE_brand Parameter (Cust level) None
CPE_version Parameter (Cust level) None
CPE_serialNo Parameter (Cust level) None
CPE_MAC Parameter (Cust level) None
CPE_Param1 Parameter (Cust level) None
CPE_Param2 Parameter (Cust level) None
CPE_Param3 Parameter (Cust level) None
48
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

CPE_Param4 Parameter (Cust level) None


Call Wait Parameter (CLI level) None (handeld by ACS)
Call On Hold Parameter (CLI level) None (handeld by ACS)
CPE WIFI Parameter (Cust level) None (handeld by ACS)
CPE_Param5 Parameter (Cust level) None
Change Settings Parameter (Cust level) None
CLI Restriction None CLIRON_EXT= 0 or 1
Call Forwarding None FWD_UNC_ON_EXT= 0 or
Unconditional 1, FWD_UNC_NUM_EXT=
number
Call Forwarding on No None FWD_NRP_ON_EXT= 0 or
Answer 1, FWD_NRP_NUM_EXT=
number
Call Forwarding on Busy None FWD_BUSY_ON_EXT= 0
or 1,
FWD_BUSY_NUM_EXT=
number
Call Barring Parameter (CLI level) PF_SCRL & SCRL tables
SCRL_MODE_OUT_EXT =
0 or 1
Voice Mail Parameter (CLI level) None
CallBarringCode None SCRL_CODE_OUT_EXT
CLIPCirpack None CLIP_ABO = 0 or 1 or 2
SubProfile None _abo table (1)
ReselCustomID ResellerID(224ID)+litemID H_ACCOUNTID_EXT
ATM1_IntFceID Parameter (CLI level) None
ATM2_IntFceID Parameter (CLI level) None
BRUO_NodeID Parameter (CLI level) None
BRUO_ShelfID Parameter (CLI level) None
BRUO_SlotID Parameter (CLI level) None
BRUO_PortID Parameter (CLI level) None
BRUO_VlanID Parameter (CLI level) None
Connect_Type Parameter (CLI level) 0 : Broba
1 : Bruo
ConnectInfo Parameter (CLI level) None
Block_OutgoingCalls None H_OUTPROFILID_EXT

Note : (1) Fields in this table that will be available are


(ABOPROFILID_ABO,NAME_ABO,COLP_ABO,COLR_ABO,CLIP_ABO,CNIP_ABO,CLIR_ABO,LST_ABO,UUS1
_ABO,UUS2_ABO,UUS3_ABO ,PICKUP_COMP_ABO ,PICKUP_GROUP_ABO, FWD_UNC_ABO,
FWD_BUSY_ABO, FWD_NRP_ABO,CALLHOLD_ABO, CALLWAIT_ABO, CALLTRFR_ABO, CALLCONF_ABO,
NRP_CALLING_ABO,
NRP_CALLED_ABO,AOC_ABO,IPAD_ABO,FPAD_ABO ,AAB_ABO ,DND_ABO ,ACCOUNT_CODE_ABO,
LOCK_ABO ,MCID_ABO,GDAC_ABO, SCRL_IN_ABO,
SCRL_OUT_ABO, THREEPTY_ABO, ENQ_ABO ,NBCALLS_ABO, MFWD_ABO ,CLIRONESHOT_ABO,
CAWONESHOT_ABO,HIDDEN_CF_ABO,LATF_ABO,CARRIER_ABO,ACR_ABO,TS_PROFILE_ABO,PRIORIT
Y_ABO, DATACALL_ABO ,DATACALLONESHOT_AB,DIVERSION_ABO, MWI_ABO, RGBT_ABO,
MHOLD_ABO ,SUP_ABO ,FILT_ABO, NBCALLLOGS_ABO ,CALLTRFR_MODE_ABO,MCAW_ABO)

49
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

Appendix: fields with fixed values in system databases:

FieldName SDP Artilium Adabas Fieldname ACS


Fieldname Fieldname
Nature of cli always None EXTENSIONNAT_EXT=3 None
national
ID of the Cirpack Switch None SWITCHID_EXT=1 None
Nature of backup H_CFBACKUPNAT_EXT=3 or 4
number national or
international
Company ID (always 1) None COMPID_EXT=1 None
Group ID (always 1) None GROUPID_EXT=1 None
RangeID None RANGE_ID must be set to first None
digit of telephonenumber
(remove 0 if 0 first digit)
Access type always set None ACCESSTYPE_EXT=3
to trunkgroup
Access name always set None ACCESSNAME_EXT=’SIP’
to SIP
Nature of Call None FWD_NRP_NAT_EXT=3 or 4
Forwarding on no reply
number national or
international
Nature of Call None FWD_BUSY_NAT_EXT=3 or 4
Forwarding on busy
number national or
international
Nature of Call None FWD_UNC_NAT_EXT=3 or 4
Forwarding
Unconditional number
national or international
ID CT (internal Adabas) None CTID_EXT=2
Expiration Date of SIP None EXPIRY_DATE_EXT=20310101 None
registration
Block_OutgoingCalls H_OUTPROFILID_EXT = 1 or 3 None

1 = dummy_res_profile
3 = block_all

Appendix: Subscriber Profile Diagram

CLI Restriction x x x x x x x
Call Forwarding - No Answer x x x x x x x
Call Forwarding - Busy x x x x x x x
Call Forwarding - Unconditional x x x
CLI Presentation x x x
Package Profile to pass over OSSs interface Basic Basic+CFU Basic+WO Basic+CFU+WO P1 P2 P3
Present 2nd Caller (notification)* x x x
Call Barring
Standard Voice mail x x x x x x x

Name Profile in Versatel OSS 00001111 00011111 00101111 00111111 01001111 01011111 011011

50
Prepared by Artilium
Confidential
IVSP Interface & Provisioning Specifications
Version 5.5

CLI Restriction x x x x x x x
Call Forwarding - No Answer x x x x x x x
Call Forwarding - Busy x x x x x x x
Call Forwarding - Unconditional x x x
CLI Presentation x x x
Package Profile to pass over OSSs interface P1 P2 P3 P4 P1 P2 P3
Present 2nd Caller (notification)* x x x
Call Barring x x x x x x x
Standard Voice mail x x x x x x x

Name Profile in Versatel OSS 10001111 10011111 10101111 10111111 11001111 11011111 11101111 111

* In case a second call is incoming, a tone is provided in-band. The call on hold gets
silence ; DTMF string has local CPE command and controls the use of the service,
without changing Adabas setting (see Class 5 TLS testing status 230905)

51
Prepared by Artilium
Confidential

You might also like