Manual Voip-Switch v54 Extract Operation Daml E20

Manual
Aarenet VoIP Switch

Operational Configuration via
DataAccessCenter
Document Version: e2.0

Aarenet VoIP Switch Software Release: V5.4
Aarenet AG, Meriedweg 11

CH 3172 Niederwangen
T +41 31 980 28 11, F +41 31 980 28 12
www.Aarenet.com, info@Aarenet.com
Copyright Aarenet AG., Niederwangen, Switzerland. Copying of this document or parts of it is prohibited.
Operational Configuration via DataAccessCenter
Table of Contents:
1
Information about this Manual ......................................................................... 3
1.1
Purpose of this Documentation .................................................................................................. 3
1.2
Audience ....................................................................................................................................... 3
1.3
Document Conventions ............................................................................................................... 4
1.4
Obtaining of Documentation and SW Application .................................................................... 4
1.5
Feedbacks ..................................................................................................................................... 4
Operational Configuration via DataAccessCenter ......................................... 5
2.1
2.1.1
2.1.2
2.1.3
2.1.4
Functionality of the DataAccessCenter DAC ............................................................................ 5

Overview ........................................................................................................................................ 5
Configurable Operational Parameters ........................................................................................... 5
Query of Special operational Data and State Information ............................................................. 6
Introduction to the DAML Formats and XSLT Conversion ............................................................. 6
2.2
Releasing the DataAccessCenter ............................................................................................... 7
2.3
IP Access to the DAML Interface ................................................................................................ 7
2.4
2.4.1
2.4.2
2.4.3
2.4.4
DAML-Data Exchange via HTTP ................................................................................................. 8

HTTP-DIGEST Authentication ....................................................................................................... 8
HTTP POST Data Exchange for DAML-Formats........................................................................... 8
HTTP-GET Data Exchange for DAML-Queries ............................................................................. 8
HTTP RESPONSE of the DataAccessCenter ................................................................................ 9
2.5
2.5.1
2.5.2
2.5.3
2.5.4
DAML-Format: Account ........................................................................................................... 9

Introduction..................................................................................................................................... 9
XML-Container for the DAML-Format of an Account .................................................................. 9
Create, Modify, Read and Delete of an Account .......................................................................10
Konfiguration der Parameter of an Account ..............................................................................13
2.6
2.6.1
2.6.2
2.6.3
2.6.4
DAML-Format: Address .........................................................................................................19

Introduction...................................................................................................................................19
XML-Container for the DAML-Format of an Address ................................................................19
Create, Modify, Read and Delete of an Address .......................................................................20
Konfiguration der Parameter of an Address ..............................................................................23
2.7
2.7.1
2.7.2
2.7.3
2.7.4
DAML-Format: Call Distribution & Call Forwarding ............................................................35

Introduction...................................................................................................................................35
XML-Container for the DAML-Format of a Call Distribution & Call Forwarding ........................35
Create, Modify, Read and Delete of a Call Distribution & Call Forwarding ...............................36
Konfiguration der Parameter of the Call Distribution & Call Forwarding ...................................39
2.8
2.8.1
2.8.2
2.8.3
2.8.4
DAML-Format: Group .............................................................................................................43

Introduction...................................................................................................................................43
XML-Container for the DAML-Format of a Group......................................................................43
Create, Modify, Read and Delete of a Group .............................................................................44
Configuration of the Parameters of a Group ..............................................................................45
2.9
DAML Query: List of all Emergency Locations ...................................................................46
2.10
DAML Query: List of all Ruleset Names ...............................................................................46
2.11
DAML Query: List of all Account Names .............................................................................47
2.12
DAML Query: List of all Announcement Names of an Address ........................................48
2.13
DAML Query: List of all VoiceMail Messages of an Address .............................................49
2.14
DAML Query: List of the Last Connections of a Number ...................................................51
Copyright Aarenet AG
2/52
Information about this Manual
1.1
Purpose of this Documentation
The document describes the operational configuration of the Aarenet VoIP Switch via the DAML interface of
the DataAccessCenter.
1.2
Audience
This reference manual is aimed for the following users:
Operators who arrange accounts and its associated addresses.
Application developers who program 3rd-party applications that configures the Aarenet VoIP
Switch.
3/52
1.3
Document Conventions
Note:
Warning:
Helpful tips or references to information which aren't included in this reference

manual.
Warnings to situations which may cause danger of injury, device damage or data
loss.
Warnings to situations which may cause interruptions of the telephony service for
the subscriber.
C
V
1.4
Configuration:
Tip to a configuration situation which is not intuitively recognizable.
Version:
Tip to a situation which is dependent of the Aarenet VoIP System software version.
Obtaining of Documentation and SW Application
This documentation and PC applications can be obtained by means of e-mail from the Aarenet support or the
Aarenet download site:
support@aarenet.com
http://www.aarenet.com/downloads
1.5
Feedbacks
Comments, suggestions, error messages can be reported via e-mail to Aarenet support:
support@aarenet.com
4/52
2.1
Functionality of the DataAccessCenter DAC
2.1.1
Overview
The DataAccessCenter DAC is a HTTP/HTTPS based interface which allows 3rd-party applications to access the operational data of the Aarenet VoIP Switch. It is predestined therefore for the binding of a CRM
system of the operator to the Aarenet VoIP Switch.
The DataAccessCenter DAC offers with the DAML interface (Data Access Markup Language DAML) an API
to access and to configure operational data of the Aarenet VoIP Switch.
The following features distinguish the DataAccessCenter:
The DAML interface allows the configuration of all parameters of the VoIP Switch.
The DAML documents are exchanged with the HTTP/HTTPS protocol.
The access is protected by a HTTP-Authentication.
The interface supports XML-based data (version XML 1.0).
The XLS transformation XSLT is supported.
For the immediate use DAML-Formats are prepared for managing of account, phone numbers
and other often used features.
Customized DAML-Formats can be created when required.
If required, customized in- and output formats can be created with XLST. To provide e.g. read
out CDR data in a HTML-formatted file.
2.1.2
Configurable Operational Parameters
For the following operative parameters are prepared DAML-Formats ready. These DAML-Formats are described in this document in detail:
DAML-Format "Account":
For the creation and treatment of customers account
DAML-Format "Address"
For the creation and treatment of public and internal phone numbers in customer accounts and
vPBX
DAML-Format "Group":
For the creation and treatment of vPBX
DAML-Format Call Distribution & Call Forwarding :

For the creation and treatment of call forwarding and call distribution of public and internal
phone numbers
Other DAML-Formats can be enabled in arrangement with the Aarenet project manager or support. These
DAML-Formats aren't described in this document:
Loading Announcement texts:

Loading Announcement texts as a WAV file and associate it with an internal number
Routing Tables:
For the creation and treatment of Routing tables
Price Lists:
For the creation and treatment of price-lists
5/52
2.1.3
Query of Special operational Data and State Information
By means of DAML-Queries special configured operational data can be interrogated. The following DAMLQueries are described in detail in this document:
Account:
Query of all account names
Emergency call places:

Query of all configured emergency call places
Connection list:
Query of the CDR of the last N connections of a phone number
Rule Set:
Query of the available Rule Set
Messages of the answering machine:

Query of messages on the answering machine of a phone number
Announcements:
Query of the announcements which are associated to a phone number.
Further DAML-Queries can be created in arrangement with the Aarenet project manager or support.
2.1.4
Introduction to the DAML Formats and XSLT Conversion
2.1.4.1
XML-Formatting
The DAML documents are XML1 formatted documents. Remarks for the production of a DAML document:
The basic rules of the XML standards are valid, version XML 1.0
The order of the XML elements is free
If XML elements are not provided during the creation of an instance, the default value of the
VoIP Switch is considered.
2.1.4.2
XSLT-Converting
The aim of XLST consists in the fact that the command and response formats from and toward a CRM application remain stable. Therefore, it is a goal that only those parameters are visible which are treated.
With XLST a XML document can be converted into another XML document. With the DAML interface it is
possible to treat incoming XML documents, e.g. from a CRM application, with defined XLST commands, before they are processed as DAML formats. Vice versa outgoing XML documents can be reworked with defined XLST commands and the result sent to the CRM application.
XLST conversions must be developed and checked in corporation with the Aarenet
engineering.
Application for incoming XML documents, e.g.:
Completion of missing XML fields with the default values
Simple introduction to XML: http://www.selfxml.de/begriffe.html
6/52
Application to outgoing XML documents, e.g.:
Queries of CDR lists and delivery as HTML formatted document
2.2
Releasing the DataAccessCenter
To grant an external application access to the operational data via DataAccessCenter an authorization at
component level must be set up:
1.
HTTP / HTTPS- Authorization-Credentials:

Defines the username and password of the user
2.
Group-based Authorization:
Defines to which groups the external application has access.
3.
Authorization for the access to DAML-Formats and DAML-Queries:

Defines to which DAML-Formats and DAML-Queries the external application can use.
4.
Edit permissions:
Defines which editing permissions (create, read, write, delete of data records) the external application has.
5.
XLTS files to be used for interpretation and formatting

Defines, whether the configuration data must be pre and/or reworked by means of XLST conversions.
N
2.3
The configuration of the DataAccessCenter releasing has to be accomplished in

close collaboration between the provider and the Aarenet project manager.
IP Access to the DAML Interface
For the DataAccessCenter the URL must have the following form:
DAML Access:
https://<IP_ADDRESS_FQDN>:8447/dataaccesscenter
Example:
https://192.168.1.1:8447/dataaccesscenter
https://dac.provider.com:8447/dataaccesscenter
Element:
Value Range:
Description:
<IP_ADDRESS_F
QDN>
String:
IP Address
FQDN
Must be an IP-Address or a FQDN.

Mandatory configuration!
IP Address:
IP Address
FQDN:
Full Qualified Domain Name
7/52
2.4
DAML-Data Exchange via HTTP
2.4.1
HTTP-DIGEST Authentication
Prior the transfer of data an application has to use the HTTP-Digest authentication before it can use the assigned DAML-format.
2.4.2
HTTP POST Data Exchange for DAML-Formats
The application must transmit its instructions with a HTTP-POST-Request toward the DataAccessCenter. By
the use of the directive POST big data volumes can be transmitted in the HTTP body. Moreover, they are not
visible in the URL.
2.4.2.1
DAML-Directives write, read, delete
The command what the DAML interface has to do with the transmitted data is transferred in a XML formatted
DAML-directive:
DAML-Document:
<daml command="DAML_DIRECTIVE" >
. . .
</daml>
Example:
<daml command="read">
<account>
<accountName>acc0001</accountName>
</account>
</daml>
Element:
Value Range:
Description:
DAML_DIRECTIV
E
Selection List:
write
read
delete
DAML Directive
write:
The given data should be written. This directive creates or modifies instances.
Read:
The given data should be read and delivered.
delete:
The given data should be deleted.
2.4.3
HTTP-GET Data Exchange for DAML-Queries
DAMl-Queris permit the queries of data which cannot be determined with usual DAML-Directives, e.g. connections list.
DAML-Queries are executed with HTTP GET Requests.
8/52
DAML-Query:
https://<IP_ADDRESS_FQDN>:8447/dataaccesscenter/daml?query=DAML_QUERY_NAME
Example:
https://dac.provider.com:8447/dataaccesscenter/daml?query=emergencyLocations
2.4.4
HTTP RESPONSE of the DataAccessCenter
After the data were successfully transmitted and treated, the response code 200 OK is returned.
In the case of an error a code "4xx <ERROR_DESCRIPTION>" or "5xx <ERROR_DESCRIPTION>" is returned, e.g., "500 Internal Server Error".
If the cause of the problem is not deductive from the error message, the error situation can be examined
from the information in the log file of the component DataAccessCenter.
2.5
DAML-Format: Account
2.5.1
Introduction
This DAML-format allows the treatment of accounts.

It allows to:
create an account
delete an account
modify an account
read an account
The SIP addresses (phone numbers) which are associated with the account are treated with the DAMLformat "Address" (see chapter 2.6).
XML-Container for the DAML-Format of an Account
2.5.2
All XML fields are listed in the account container:
The XML filed <account> defines the account container
Mandatory is the XML field <accountName> which identifies the account unambiguously.
The order of the XML fields is arbitrarily
Account-Container for Account:

<account>
<accountName>ACC_NAME</accountName>
. . .
</account>
Example:
<account>
<accountName>an-acc-0001</accountName>
9/52
<tenant>Aarenet</tenant>
. . .
</account>
2.5.3
Create, Modify, Read and Delete of an Account
2.5.3.1
Create an Account
DAML-Document:
All available Parameter for Account see: Chapter 2.5.4
<daml command="write" >
<account>
<tenant>ACC_TENANT</tenant>
<info>ACC_INFO</info>
<username>ACC_SIP_USERNAME</username>
<password>ACC_SIP_PASSWORD</password>
<maxChannels>ACC_CHANNEL</maxChannels>
<emergencyLocation>ACC_LOCATION</emergencyLocation>
<routingTable>ACC_ROUTINGTABLE</routingTable>
<ruleset>ACC_RULSET</ruleset>
<pricelist>ACC_PRICELIST</pricelist>
<sendAoc>ACC_AOC</sendAoc>
<sysAccountTopStop>
<type>TOPSTOP_USER_TYPE</type>
<valueMax>TOPSTOP_MAX</valueMax>
<alarmLevel>TOPSTOP_ALARM_LEVEL</alarmLevel>
<alarmEmail>TOPSTOP_EMAIL</alarmEmail>
<valueCurrent>TOPSTOP_CURRENT_VALUE</valueCurrent>
</sysAccountTopStop>
<validAfter>ACC_VALID_AFTER</validAfter>
<validUntil>ACC_VALID_UNTIL</validUntil>
<specialArrangement>ACC_SPECIAL_ARRAGEMENT</specialArrangement>
<alarmOnExpiry>ACC_ALARM_ON_EXPIRY</alarmOnExpiry>
<useMediaServer>ACC_USE_MEDIA_SERVER</useMediaServer>
<maliciousCallerId>ACC_MCID</maliciousCallerId>
<accountAdmin>
<username>ACC_SUBSC_USERNAME</username>
<password>ACC_SUBSC_PASSWORD</password>
<language>ACC_SUBSC_LANGUAGE</language>
</accountAdmin>
<callForward>
<name>CF_NAME</name>
<type>CF_TYPE</type>
<priority>CF_PRIORITY</priority>
<delay>CF_DELAY</delay>
<destPattern>CF_DESTINATION_PATTERN</destPattern>
<sourcePattern>CF_SOURCE_PATTERN</sourcePattern>
<sourcePresentationPattern>CF_SOURCE_PRES_PATTERN</sourcePresentationPattern>
<destReplace>CF_DESTINATION_REPLACE</destReplace>
<timePattern>CF_TIME_PATTERN</timePattern>
<propagateBusy>CF_PROPAGATE_BUSY</propagateBusy>
10/52
<parallelCall>CF_PARALLEL_CALL</parallelCall>
<alwaysRing>CF_ALWAYS_RING</alwaysRing>
<lastDiversion>CF_LAST_DIVERSION</lastDiversion>
</callForward>
</account>
</daml>
Example of creating an Account:

<account>
<info>Test Account: Tel 012 345 67 89</info>
<username>asdfe434twdv</username>
<password>sg76wv5v25v342</password>
<maxChannels>60</maxChannels>
<emergencyLocation>GN0355 Köniz</emergencyLocation>

<routingTable>Route to PSTN</routingTable>
<ruleset>Subscriber</ruleset>
<ruleset>Block : 09xx</ruleset>
<pricelist>Standard Pricelist</pricelist>
<sendAoc>true</sendAoc>
<sysAccountTopStop>
<type>SYS</type>
<valueMax>100.00</valueMax>
<alarmLevel>0.7</alarmLevel>
<alarmEmail>support@aarenet.com</alarmEmail>
<validAfter>2013-04-14T10:29:00</validAfter>
<validUntil/>
<specialArrangement>false</specialArrangement>
<alarmOnExpiry>false</alarmOnExpiry>
<useMediaServer>false</useMediaServer>
<maliciousCallerId>false</maliciousCallerId>
<accountAdmin>
<username>acc-21</username>
<password>acc-21-password</password>
<language>en</language>
</accountAdmin>
</account>
</daml>
2.5.3.2
Modify an Account: Modify or Delete a Parameter
DAML-Document:
<account>
. . .
All available Parameter for Account see: Chapter 2.5.3.5
. . .
</account>
</daml>
11/52
Example 1: Modify an already configured Account parameter:

<account>
<validUntil>2014-01-01T00:00:00</validUntil>
</account>
</daml>
Example 2: Delete an already configured Account parameter:

In this example the contents of the <info> filed is deleted in two different manners.
<account>
<info></info>

<info/>
</account>
</daml>
2.5.3.3
Read an Account
DAML-Document:
<account>
</account>
</daml>
Example:
<account>
</account>
</daml>
2.5.3.4
Delete an Account
DAML-Document:
<daml command="delete">
<account>
</account>
</daml>
Example:
<daml command="delete">
<account>
</account>
</daml>
12/52
2.5.3.5
Special Cases
Remarks for deleting of TopStop:
If within an account a TopStop has to be deleted all other configured TopStops of this account
must be deleted too.
Furthermore required TopStops must be written again.
2.5.4
Konfiguration der Parameter of an Account
2.5.4.1
XML Fields of the Basic Account Parameters
XML Field:
Value Range:
Description:
<accountName>
ACC_NAME
</accountName
>
String:
Account
Name
Unambiguous name of the account

Account Name:
Arbitrary string; max. 32 characters
<tenant>
ACC_TENANT
</tenant>
String:
Void
Mandant
Name of the mandant to which the account belongs.

The mandant must be already created in the system of the VoIP
Switch!
Void (Default):
Mandant:
Definierter Mandant; max. 128 characters
<info>
ACC_INFO
</info>
String:
Void
Information
Any information
<username>
ACC_SIP_USERN
AME
</username>
String:
SIP User
SIP user name.
Void (Default):
Information:
The SIP user name must be unique!
SIP User:
<password>
ACC_SIP_PASSW
ORD
</password>
String:
SIP Password
SIP password
SIP Password:
<maxChannels>
ACC_CHANNEL
</maxChannels
>
Number:
Void
Number of
Channel
Determines how many concurrent connections are possible.

If the value is 0 the no incoming and outgoing connections are possible.
Void (Default):
No channel limitation
13/52
XML Field:
Value Range:
Description:
Number of Channel:
Value Range:
0 :no channels
>=1 : Exact number of channels
<emergencyLoc
ation>
ACC_LOCATION
</emergencyLo
cation>
Selection List:
Void
Ort
A configured emergency location of the defined emergency call regions can be selected.
The emergence location must be already configures in the emergency call configuration of the VoIP Switch!
Void (Default):
The system-wide default emergency location is
used.
Ort:
Defined emergency location; max. 64 characters
2.5.4.2
XML Fields of the Routing & Rating Account Parameters
XML Field:
Value Range:
Description:
<routingTable
>
ACC_ROUTINGTA
BLE
</routingTabl
e>
Selection List:
Routing
Table
A configured routing table can be selected.

The routing table must be already created in the routing of the VoIP
Switch!
Without a routing table configured only OnNet connections are possible!
Routing Table:
The name of a configured routing table; max.
45 characters
<ruleset>
. . .
</ruleset>
<ruleset>
ACC_RULSET
</ruleset>
Any number of ruleset can be assigned to an account.

The XML field <ruleset> can be defined n times within account container.
Selection List:
Ruleset
Defines the rulesets to be applied for this account.

The Ruleset must be already created in the routing of the VoIP
Switch!
Ruleset:
Name of a configured ruleset; max. 128 characters
<pricelist>
ACC_PRICELIST
</pricelist>
Selection List:
Void
Price List
A configured price list can be selected.

The price list must be already created in the rating of the VoIP
Switch!
Without a pricelist in the account the computation of the connection
fee, top stop and AOC is not possible!
Void (Default):
Price List:
Name of a configured price list; max. 32
characters
14/52
XML Field:
Value Range:
Description:
<sendAoc>
ACC_AOC
</sendAoc>
Boolean:
false
true
Activate sending advice of charge AOC to all addresses of the account.

false (Default):
Advice of charge is not activated
true:
Advice of charge is activated
2.5.4.3
XML Fields of the Advanced Account Parameters
XML Field:
Value Range:
Description:
<validAfter>
ACC_VALID_AFT
ER
</validAfter>
Date/Time:
Void
Account
Valid From
Date/time of the activation of the account

Void (Default):
The account is active.
Account Valid From:
The account is active beginning at Date/Time.
Text-Format:
The format conforms to the XML standard xmlDateTime Data Type:
yyyy-MM-dd'T'HH:mm:ss
Example: 2013-04-14T10:29:00
<validUntil>
ACC_VALID_UNT
IL
</validUntil>
Date/Time:
Void
Account
Valid Until
Date/time of the deactivation of the account

The addresses associated with the account are also not active any
more.
Void (Default):
The account is active.
Account Valid Until:
The account is deactivated beginning at
Date/Time.
Text-Format:
The format corresponds with the XML Standard
xml-DateTime Data Type:
Example: 2013-05-01T00:00:00
<specialArran
gement>
ACC_SPECIAL_A
RRAGEMENT
</specialArra
ngement>
Boolean:
false
true
When "Spezial Arragement" is enabled then the CLIP delivered by

the CPE is accepted by the VoIP Switch (known also as "CLIP no
Screening").
If it is not activated, the VoIP Switch compares the delivered CLIP
with the addresses of this account and replaces it with the best
match. If there is no best no best then the main number is used as
CLIP. If the account has no main number defined in, then the VoIP
Switch rejects the connection setup.
According to the juridical situation of a country this feature may
not or only used restrictedly!
15/52
XML Field:
Value Range:
Description:
false (Default):
The feature is not activated.
true:
The feature is activated.
<alarmOnExpir
y>
ACC_ALARM_ON_
EXPIRY
</alarmOnExpi
ry>
Boolean:
false
true
If a SIP registration is not renewed, an email is generated by the

Aarenet VoIP Switch.
The email address is a configuration of the component
ServiceCenter
false (Default):
true:
<useMediaServ
er>
ACC_USE_MEDIA
_SERVER
</useMediaSer
ver>
Boolean:
false
true
<maliciousCal
lerId>
ACC_MCID
</maliciousCa
llerId>
Boolean:
false
true
Is the feature Use always Media Server activated then all media
streams will be routed via a MediaServer of the Aarenet VoIP
Switch
false (Default):
true:
Is the feature Force Call ID (MCID) activated then the CLIP of all
incoming anonymous calls to this account is reactivated (CLIR
CLIP), if possible
According to the juridical situation of a country this feature may
not or only used restrictedly! The prescribed legal action has to
be observed!
false (Default):
true:
<accountAdmin
>
. . .
</accountAdmi
n>
<username>
ACC_SUBSC_USE
RNAME
</username>
For the customer account operator the operative access to the account and its addresses is unlocked.
They will be enabled to do limited operative configurations via:
AdminCenter
SubscriberCenter
String:
Void
Account
User
User name for the account login

The username must be unique, on the whole Aarenet VoIP Switch!
Void (Default):
No access
Account User:
<password>
ACC_SUBSC_PAS
SWORD
</password>
String:
Void
Account
Password
Password for the account login

Void (Default):
No access
Account Password:
16/52
XML Field:
Value Range:
Description:
<language>ACC
_SUBSC_LANGUA
GE</language>
2.5.4.4
Selection List:
en
de
Defines the used language in the GUI

en (Default):
Englisch
de:
German
XML Fields of the TopStop Account Parameter
XML Fields of the TopStop Account Parameter:

<sysAccountTopStop>
<type>TOPSTOP_USER</type>
XML Field:
Value Range:
<sysAccountTo
pStop>
. . .
</sysAccountT
opStop>
<type>
TOPSTOP_USER
</type>
Description:
Any number of TopStop can be associated with an account.
The XML field <sysAccountTopStop> can be defined n times
within an account container therefore.
Selection List:
SYS
ACC
ADD
Der Parameter definiert, mit welcher Rolle dieser TopStop erstellt

wurde. Er definiert somit auch, fr welche Rolle dieses TopStop
sichtbar sein soll.
The parameter defines with which role a TopStop was created. This
defines also for which role the TopStop is visible.
SYS (Default):
The TopStop was created by a system administrator. It is visible only for this role.
ACC:
The TopStop was created by an account operator. It is visible for the roles of the system administrator and account operator.
ADD:
The TopStop was created by a subscriber. It
is visible for the system administrator, account operator and subscriber.
<valueMax>
TOPSTOP_MAX
</valueMax>
Decimal Number:
Void
TopStop
Maximum
Value
Defines the charging limit per month for the account. It may not be
exceeded by the charging sum of all connections of this account.
At the beginning of each month the charging limit is reset.
An email is generated if the charging limit is reached and an email
address is defined.
Void (Default):
No charging limit is superviced
TopStop Maximum Value:
Maximal charging limit
Value Range: >= 0.00
17/52
XML Field:
Value Range:
Description:
<alarmLevel>
TOPSTOP_ALARM
_LEVEL
</alarmLevel>
Decimal Number:
Void
TopStop
Alarm Level
An email is generated when the defined charging level is reached,

e.g.
150.00 * 0.7 = 105.00
An email is generated if the charging level is reached and an email
address is defined.
Void (Default):
No level is monitored.
TopStop Alarm Level:
An email alarm is generated if x% of the
charging limit is used:
Value Range: 0.0 1.0
<alarmEmail>
TOPSTOP_EMAIL
</alarmEmail>
<valueCurrent
>
TOPSTOP_CURRE
NT_VALUE
</valueCurren
t>
2.5.4.5
String:
Void
Email
Adresse
If defines an email address which is informed if the level or the

charging limits is reached.
Decimal Number:
TopStop
Current
Value
Current total charges of this account since early beginning of the

month.
Void (Default):
No email will be sent.
Email address:
At overrun of the level and the charging limit an email is sent; max. 64 characters.
The value can be only read out

TopStop Current Value:
Current total charges
XML Fields of the Attribute Account Parameter
XML Fields fr ein Attribut:

<accountAttribute>
<name>ACC_ATTRIBUTE_NAME</name>
<value>ACC_ATTRIBUTE_VALUE</value>
</accountAttribute>
XML Field:
Value Range:
<accountAttri
bute>
. . .
</accountAttr
ibute>
<name>
ACC_ATTRIBUTE
_NAME
</name>
Description:
Any number of attributes can be assigned to an account.
The XML field <accountAttribute> can be defined n times within an account container therefore.
String:
Attribute
Name
An attribute name can be used.

The attribute must be already created in the ConfigCenter component of the VoIP Switch!
Attribute Name:
Name of a configured attribute; max. 256
characters.
18/52
XML Field:
Value Range:
Description:
<value>
ACC_ATTRIBUTE
_VALUE
</value>
String:
Attribute
Value
Beliebige Information.
Attribute Value:
Any information; max. 256 characters.
2.6
DAML-Format: Address
2.6.1
Introduction
This DAML-format allows the treatment of addresses (phone numbers) of an account.

It allows to:
create an address
delete an address
modify an address
read an address
XML-Container for the DAML-Format of an Address
2.6.2
All XML fields are listed in the address container:
The XML filed <address> defines the account container.
Mandatory is the XML field is <account> which identifies the account unambiguously.
Mandatory is the XML field is <number> which identifies the address (phone number) unambiguously.
The order of the XML fields is arbitrarily.
Address-Container for Address :

<address>
<number>ADD_NUMBER</number>
<account>ACC_NAME</account>
. . .
</address>
Example:
<address>
<number>0123456789</number>
<account>an-acc-0001</account>
. . .
</address>
19/52
2.6.3
Create, Modify, Read and Delete of an Address
2.6.3.1
Create an Address
DAML-Document:
All available Parameter for Address see: Chapter 2.6.4
<address>
<domain>ADD_DOMAIN</domain>
<displayName>ADD_DISP_NAME</displayName>
<showClip>ADD_SHOW_CLIP</showClip>
<hideClip>ADD_HIDE_CLIP</hideClip>
<language>ADD_LANGUAGE</language>
<mainNumber>ADD_MAIN_NUMBER</mainNumber>
<registersViaMainNumber>ADD_REG_VIA_MAIN</registersViaMainNumber>
<baseNumber>ADD_BASE_NUMBER</baseNumber>
<preferredNumber>ADD_PREF_NUMBER</preferredNumber>
<validAfter>ADD_VALID_AFTER</validAfter>
<validUntil>ADD_VALID_UNTIL</validUntil>
<portoutNumber>ADD_PORT_OUT_NUMBER<portoutNumber/>
<singleLocation>ADD_SINGLE_REGISTRATION</singleLocation>
<balancedRouting>ADD_BALANCED_ROUTING</balancedRouting>
<disabled>ADD_DISABLED_ADDRESS</disabled>
<blocked>ADD_OUTGOING_BLOCKED</blocked>
<noOfferOnBusy>ADD_NO_OFFER_ON_BUSY</noOfferOnBusy>
<signalingOnly>ADD_SIGNALING_ONLY</signalingOnly>
<cfu>ADD_CFU_SHORT</cfu>
<cfb>ADD_CFB_SHORT</cfb>
<cfnr>ADD_CFNR_SHORT</cfnr>
<cfo>ADD_CFO_SHORT</cfo>
<cff>ADD_CFF_SHORT</cff>
<dnd>ADD_DND</dnd>
<rrn>ADD_RRN</rrn>
<addressAdmin>
<username>ADD_SUBSC_USERNAME</username>
<password>ADD_SUBSC_PASSWORD</password>
<language>ADD_SUBSC_LANGUAGE</language>
</addressAdmin>
<messageBox>
<pin>ADD_VM_PIN</pin>
<email>ADD_VM_EMAIL</email>
<autoAuthentication>ADD_VM_AUTO_AUTH</autoAuthentication>
<blocked>ADD_VM_BLOCK</blocked>
<signalNewMessage>ADD_VM_SIG_NEW_MESSAGE</signalNewMessage>
<subscribedMwiOnly>ADD_VM_MWI_ONLY</subscribedMwiOnly>
<language>ADD_VM_LANGUAGE</language>
<skipMessageMenu>ADD_VM_SKIP_MESSAGE_MENU</skipMessageMenu>
20/52
</messageBox>
<pbx>VPBX_PBX_GROUP</pbx>
<groupMember>VPBX_MEMBER_OF_GROUP</groupMember>
<privateNumber>VPBX_PRIVATE_ADD</privateNumber>
<publicClip>VPBX_PUBLIC_CLIP</publicClip>
<queueLen>VPBX_QUEUE_LENGTH</queueLen>
n-mal
<monitorGroup>VPBX_MONITOR_GROUP</monitorGroup>
<presenceGroup>VPBX_PRESENCE_GROUP</presenceGroup>
<messageGroup>VPBX_MESSAGE_GROUP</messageGroup>
<mgcpProfile>ADD_MGCP_PROFILE</mgcpProfile>
<endpointName>ADD_MGCP_ENDPOINT</endpointName>
<callWaiting>ADD_MGCP_CALL_WAIT</callWaiting>
<callHold>ADD_MGCP_CALL_HOLD</callHold>
<sysAddressTopStop>
<type>TOPSTOP_USER_TYPE</type>
</sysAddressTopStop>
<location>
<userAgent>ADD_REG_USER_AGENT</userAgent>
<receivedAddress>ADD_REG_IP_ADDRESS</receivedAddress>
<q>ADD_REG_Q_VALUE</q>
<behindNat>ADD_REG_BEHIND_NAT</behindNat>
</location>
</address>
</daml>
Example of creating an Address:

<address>
<language>de</language>
<displayName>0265060000</displayName>
<validAfter>2014-05-13T00:00:00</validAfter>
<validUntil/>
</address>
</daml>
2.6.3.2
Modify an Address: Modify or Delete a Parameter
DAML-Document:
<address>
. . .
All available Parameter for Address see: Chapter 2.6.4
. . .
</address>
</daml>
Example 1: Modify an already configured Account parameter:
21/52

<address>
<validUntil>2014-01-01T00:00:00</validUntil>
</address>
</daml>
Example 2: Delete an already configured Account parameter:

In this example the contents of the <validUntil> filed is deleted in two different manners.
<address>
<validUntil></validUntil>

<validUntil/>
</address>
</daml>
2.6.3.3
Read an Address
DAML-Document:
<daml command="read" >
<address>
</address>
</daml>
Example:
<address>
</address>
</daml>
2.6.3.4
Delete an Address
DAML-Document:
<daml command="delete" >
<address>
</address>
</daml>
Example:
<address>
22/52
</address>
</daml>
2.6.3.5
Special Cases
Remarks for deleting of TopStop:
If within an address a TopStop has to be deleted all other configured TopStops of this account
must be deleted too.
Still needed TopStops have to be rewritten.
Remarks for modifying /deleting of Call Forwards:
Werden die XML Fields folgender vereinfachter Anrufweiterleitungen gelscht oder modifiziert,
so werden die Anrufverteilungen des mit der Adresse assozierten Account gelscht:
If the XML field of the following simplified call forwardings is deleted or modified, then all call distributions of the account which is associated with this address are deleted:
<cfu>ADD_CFU_SHORT</cfu>
<cfb>ADD_CFB_SHORT</cfb>
<cfnr>ADD_CFNR_SHORT</cfnr>
<cfo>ADD_CFO_SHORT</cfo>
<cff>ADD_CFF_SHORT</cff>
Weiterhin bentigte Anrufweiterleitungen und Anrufverteilungen mssen wieder geschrieben

werden.
Furthermore required call forwardings and call distributions must be written again.
2.6.4
Konfiguration der Parameter of an Address
2.6.4.1
XML Fields of the Basic Address Parameter
XML Field:
Value Range:
Description:
<account>
ACC_NAME
</account>
String:
Account
Name
Unequivocal name of the account to which the phone number belongs

Account Name:
<number>
ADD_NUMBER
</number>
String:
SIP Number
Unequivocal phone number or SIP address.

Format SIP address:
<SIP-DISPLAY><SIP_NUMBER>@<SIP_DOMAIN>
Void (Default):
Invalid configuration
SIP Number:
23/52
XML Field:
Value Range:
Description:
<domain>
ADD_DOMAIN
</domain>
String:
Void
IP Address
FQDN
IP address or FQDN of the SIP Registrar and SIP Proxy.

Format SIP address:
Void (Default):
IP Address:
FQDN:
<displayName>
ADD_DISP_NAME
</displayName
>
String:
Void
Display
Name
Displayed name information at the called party side.

Format SIP address:
The display information from the SIP terminal will be overwritten!

Void (Default):
Display Name:
<showClip>
ADD_SHOW_CLIP
</showClip>
Boolean:
true
false
<hideClip>
ADD_HIDE_CLIP
</hideClip>
Boolean:
true
false
These two parameters determine whether and how the CLIP of the
calling is modified by the Aarenet VoIP Switch.
ADD_SHOW_CLIP: false (Default)
ADD_HIDE_CLIP: false (Default)
CLIP will not be changed
ADD_SHOW_CLIP: true
ADD_HIDE_CLIP: false
CLIP will be always shown permanent CLIP
ADD_SHOW_CLIP: false
ADD_HIDE_CLIP: true
CLIP will be never shown permanent CLIR
ADD_SHOW_CLIP: true
ADD_HIDE_CLIP: true
Invalid, the result is undefined!
<language>
ADD_LANGUAGE
</language>
<mainNumber>
ADD_MAIN_NUMB
ER
</mainNumber>
Selection List:
de
en
fr
it
Defines the used language for inband information, which are played
by the Aarenet VoIP Switch, e.g. The subscriber is not wanted to
be disturbed at the moment
Boolean:
true
false
Defines if the number is the main number of the account.
de:
en:
fr:
it:
German
English
France
Italian
If a CPE registers the main number with the correct SIP Credentials
at the account, then the main number and all other numbers
24/52
XML Field:
Value Range:
Description:
which are selected with registered via main number are automatically registered.
Per account there can be only one main number!
false (Default):
The number must be registered by a CPE.
true:
The number must be registered by a CPE. Also
all numbers of the account with
ADD_REG_VIA_MAIN are automatically registered.
<registersVia
MainNumber>
ADD_REG_VIA_M
AIN
</registersVi
aMainNumber>
Boolean:
true
false
<baseNumber>
ADD_BASE_NUMB
ER
</baseNumber>
Boolean:
true
false
This number is registered via the main number. It is not necessary

that this number has to be registered by a CPE directly.
false (Default):
The number must be registered by a CPE.
true:
This number is automatically registered if
the main number is registered.
This number is the base number of this account. The base number
serves as a search pattern to identify an open number space.
Per account there can be only one base number!
Example:
Base Number :
012345
Regexp: 012345.*
Matches, e.g. the numbers:

012345 0
012345 100
012345 99999
false (Default):
The number is no base number.
true:
The number is the base number of the account.
<preferredNum
ber>
ADD_PREF_NUMB
ER
</preferredNu
mber>
Boolean:
true
false
This number will always be used as CLIP by the Aarenet VoIP

Switch for all outgoing calls from any number of this account.
The number will be signaled as preferred. Either in the SIP Header
From- or P-Preferred.
false (Default):
The number is not a fix CLIP
true:
The number defines the fix CLIP of the account.
25/52
2.6.4.2
XML Fields of the Advanced Address Parameter
XML Field:
Value Range:
Description:
<validAfter>
ADD_VALID_AFT
ER
</validAfter>
Date/Time:
Date/time of the activation of the telephony number (SIP address)
Void
Address
Valid From
Void (Default):
The number is active.
Address Valid From:
The number is active starting at Date/Time.
Text-Format:
The format conforms to the XML standardxmlDateTime Data Type:
Example: 2013-04-14T10:29:00
<validUntil>
ADD_VALID_UNT
IL
</validUntil>
Date/Time:
Void
Address
Valid Until
Date/time of the deactivation of the telephony number (SIP address)

Void (Default):
The number is not deactivated.
Address Valid Until:
The number is deactivated starting at
Date/Time.
Text-Format:
The format conforms to the XML standardxmlDateTime Data Type:
Example: 2013-05-01T00:00:00
<portoutNumbe
r>
ADD_PORT_OUT_
NUMBER
<portoutNumbe
r/>
String:
Void
Port Out
Number
When ADD_PORT_OUT_NUMBER is defined and the number deactivated with Date/Time ADD_VALID_UNTIL then the Aarenet VoIP
Switch will redirect an incoming call toward this number back into
the PSTN.
According the settings of the ServiceCenter component this
ADD_PORT_OUT_NUMBER is part of a rewriting rule which is applied to the destination number before the call is redirected toward the PSTN.
In Switzerland the NPRN of the new provider is set
Example:
Outported Number : 0123456789
NPRN new provider : 098000
Setting in ADD_PORT_OUT_NUMBER : 98000
The rewriting result will be: 0980000123456789
Void (Default):
Port Out Number:
<singleLocati
on>
ADD_SINGLE_RE
Boolean:
true
false
Defines, whether several CPE can register on this number.

true (Default):
26/52
XML Field:
Value Range:
GISTRATION
</singleLocat
ion>
Description:
Several CPE can register on the number.
false:
Only one CPE is allowed to register on the
number.
<balancedRout
ing>
ADD_BALANCED_
ROUTING
</balancedRou
ting>
Boolean:
true
false
<disabled>
ADD_DISABLED_
ADDRESS
</disabled>
Boolean:
true
false
When the CPE provides with the registration a Q value then incoming connections are routed to that CPE which has delivered the biggest q value.
false (Default):
The Q value delivered by the CPE is not considered.
true:
The Q value delivered by the CPE is considered.
The number is disabled for incoming and outgoing connections.
This number cannot be created a second time on this Aarenet VoIP
Switch.
This feature can be used for a reservation of a number.
false (Default):
The number is not disabled.
true:
The number is disabled.
<blocked>
ADD_OUTGOING_
BLOCKED
</blocked>
Boolean:
true
false
<noOfferOnBus
y>
ADD_NO_OFFER_
ON_BUSY
</noOfferOnBu
sy>
Boolean:
true
false
<signalingOnl
y>
ADD_SIGNALING
_ONLY
</signalingOn
ly>
Boolean:
true
false
<cfu>
ADD_CFU_SHORT
</cfu>
String:
CF Destination
Number
The number cannot start outgoing connections. Incoming connection to this number are routed normally.
false (Default):
The number is not disabled for outgoing connections.
true:
The number is disabled for outgoing connections.
When the number is in an active connection then newly incoming
connections are not offered.
false (Default):
Incoming calls are always offered.
true:
If a connection is active no new incoming
connections are offered.
The number can be used only for outgoing connections.
Incoming connections to this number are rerouted toward the PSTN
false (Default):
The number can handle incoming and outgoing
connections.
true:
The number can handle only outgoing connections.
Configures a general Unconditional Call Forwarding CFU to the
redirection destination.
This call forwarding is valid for all phone numbers of the account.
27/52
XML Field:
Value Range:
Description:
It is automatically configured with the default DAML priority for Call
Forwarding.
For complex call forwarding see chapter 2.7
Follow the special procedure by modifying or deleting of this redirection, see chapter 2.6.3.5
CF Destination Number:
<cfb>
ADD_CFB_SHORT
</cfb>
String:
CF Destination
Number
Configures a general Call Forwarding Busy CFBto the redirection

destination.
Forwarding.
Follow the special procedure by modifying or deleting of this redirection, see chapter 2.6.3.5.
<cfnr>
ADD_CFNR_SHOR
T
</cfnr>
String:
CF Destination
Number
Configures a general Call Forwarding not Reachable CFNRto the

redirection destination.
Forwarding.
<cfo>
ADD_CFO_SHORT
</cfo>
String:
CF Destination
Number
Configures a general Call Forking CFO to the redirection destination.

This call forking is valid for all phone numbers of the account.
Forwarding.
B Arbitrary string; max. 50 characters
<cff>
ADD_CFF_SHORT
</cff>
String:
CF Destination
Number
Configures a general Call Forwarding Fall Back CFFto the redirection destination.
Forwarding Fall Back CFF.
28/52
XML Field:
Value Range:
Description:
<dnd>
ADD_DND
</dnd>
Boolean:
true
false
Do not Disturb, incoming calls are rejected with an inband message.

false (Default):
Incoming calls are accepted.
true:
Incoming calls are rejected.
<rrn>
ADD_RRN
</rrn>
Boolean:
true
false
<addressAdmin
>
. . .
<addressAdmin
>
<username>
ADD_SUBSC_USE
RNAME
</username>
Anonymous incoming calls are rejected with an inband message.

false (Default):
All incoming calls are accepted.
true:
Anonymous incoming calls are rejected.
For the subscriber limited operational configurations and readouts
to his address is enabled by the:
AdminCenter
SubscriberCenter
iPhoneCenter
String:
Void
Subscriber
Username
Username for the subscriber login

The username must be unique in the Aarenet VoIP Switch!
Void (Default):
No Access
Subscriber Username:
<password>
ADD_SUBSC_PAS
SWORD
</password>
String:
Void
Subscriber
Password
Password for the subscriber login
<language>
ADD_SUBSC_LAN
GUAGE
</language>
Selection List:
en
de
Defines the used language in the GUI.
2.6.4.3
Void (Default):
No Access
Subscriber Password:
en (Default):
Englisch.
de:
German.
XML Fields of the VoiceMailBox Address Parameter
XML Field:
Value Range:
<messageBox>
. . .
</messageBox>
<pin>
ADD_VM_PIN
</pin>
Description:
Per address VoiceMailBox can be associated and configured.
Digit:
Void
PIN
Defines the PIN to be used for the VoiceMailBox access.

It is recommended to use only digits, else the subscribers will have
problems with a legacy telephone keypad.
Void (Default):
29/52
XML Field:
Value Range:
Description:
No PIN defined
PIN:
Defined PIN; max. 128 characters
<email>
ADD_VM_EMAIL
</email>
String:
Void
EmailAdresse
Defines the email address to which a new message will be sent.
<autoAuthenti
cation>
ADD_VM_AUTO_A
UTH
</autoAuthent
ication>
Selection List:
false
true
Defines whether the PIN is needed by an access from the telephone with the own number.
<blocked>
ADD_VM_BLOCK
</blocked>
String:
no
Blocked
Minutes
Void (Default):
No email will be sent.
Email address:
The email address to which new message should
be sent; max. 64 characters.
false (Default:
The PIN is needed for the access to the
VoiceMailBox.
true:
The PIN is not needed for the access to the
VoiceMailBox.
States, if the VoiceMailBox is blocked and how long it is blocked.
The value can be only read out!
no:
If no is returned then the VoiceMailBox is
not blocked.
Blocked Minutes:
Remaining duration of the blocking in minutes
<signalNewMes
sage>
ADD_VM_SIG_NE
W_MESSAGE
</signalNewMe
ssage>
Selection List:
true
false
<subscribedMw
iOnly>
ADD_VM_MWI_ON
LY
</subscribedM
wiOnly>
Selection List:
true
false
<language>
ADD_VM_LANGUA
GE
</language>
Selection List:
de
en
fr
it
Definiert, dass ber eine neue Nachricht im VoiceMailBox informiert

werden soll.
true (Default):
Die Endgerte werden informiert.
false:
Die Endgerte werden nicht informiert.
Defines whether and how the telephone is informed about a new
message in the VoiceMailBox. The format is Message Waiting Information MWI.
true (Default):
Explicit MWI Subscription only:
MWI messages are sent to the terminal when it
prior subscribed for the WMI service.
false:
Implicitly, all registered devices:
A MWI message is automatically sent to all
terminals registered with this address. The
terminals must not log in with the WMI service.
Defines the language of the announcement texts of the
VoiceMailBox.
de:
en:
German
English
30/52
XML Field:
Value Range:
Description:
Fr:
it:
<skipMessageM
enu>
ADD_VM_SKIP_M
ESSAGE_MENU
</skipMessage
Menu>
2.6.4.4
Selection List:
true
false
French
Italian
Defines whether the menu of the VoiceMailBox are recited.

false (Default):
The menu are recited.
true:
The menu are not recited.
XML Fields of the vPBX Address Parameter
XML Field:
Value Range:
Description:
<pbx>
Selection List:
Void
vPBX Group
The name of the group which defines the vPBX. The address will
become a member of this vPBX group
VPBX_PBX_GROU
P
</pbx>
The vPBX group must be already created in the System of the

Aarenet VoIP Switch!
Void (Default):
vPBX Group:
The name of a configured vPBX group; max. 64
characters.
<groupMember>
. . .
A vPBX may belong to several groups.
</groupMember
>
The XML field <groupMember> can be defined n times within

an address container therefore
<groupMember>
VPBX_MEMBER_O
F_GROUP
</groupMember
>
Selection List:
Void
Group Member
A configured superior group can be selected.

The group must be already created in the System of the Aarenet
VoIP Switch!
Void (Default):
Group Member:
The name of a configured group; max. 64 characters.
<privateNumber
>
VPBX_PRIVATE_
ADD
Boolean:
true
false
false (Default):
It is a public number.
true:
It is a vPBX private number.
</privateNumber
>
<publicClip>
VPBX_PUBLIC_C
LIP
</publicClip>
Defines the number as a private number. Therefore it is visible and

callable only within the vPBX group.
String:
CLIP Number
Defines the public identity of this private number for outgoing connections toward the PSTN. The assigned public number will be
used as CLIP and must be from the public number range of the
vPBX.
This parameter is valid only with private numbers.
If no public number is configured as a public identity, then no
outgoing connections from this private number toward the PSTN
31/52
XML Field:
Value Range:
Description:
are possible!
Void (Default):
CLIP Number:
An already defined public number of this
vPBX; max. 50 characters
<queueLen>
VPBX_QUEUE_LE
NGTH
</queueLen>
Number:
Void
Call Queue
Defines how many concurrently incoming calls toward the private

number are offered at the same time. The calling sides receive the
alerting tone.
The call queue is used for presenting incoming calls by the monitor
function (see below VPBX_MONITOR_GROUP).
The functionality is depended on the implementation on the SIP device!
Void (Default):
The call queue is switched off
Call cue:
If the value is bigger than 0 the number behaves like a call queue.
<monitorGroup>
VPBX_MONITOR_
GROUP
</monitorGroup
>
Selection List:
Void
Monitor
Group
Name of the group whose members are allowed to subscribe for the
Monitor information of this internal number ("monitoring).
Monitor information are visible in this group and related superior
groups.
The group must be already created in the system of the Aarenet
VoIP Switch!
Void (Default):
Monitor Group:
<presenceGrou
p>
VPBX_PRESENCE
_GROUP
</presenceGrou
p>
Selection List:
Void
Presence
Group
Presence information of this internal number.
Presence information are visible in this group and related superior
groups.
VoIP Switch!
Void (Default):
Presence Group:
<messageGroup
>
VPBX_MESSAGE_
GROUP
</messageGrou
p>
Selection List:
Void
Message
Group
Name der Gruppe, deren Mitgliedern erlaubt ist sich fr den Message Dienst dieser internen Nummer anzumelden.
Message Service of this internal number.
Message information are visible in this group and related superior
groups.
32/52
XML Field:
Value Range:
Description:
VoIP Switch!
Void (Default):
Message Group:
2.6.4.5
XML Fields of the MGCP Address Parameter
Element:
Value Range:
Description:
<mgcpProfile>
ADD_MGCP_PROF
ILE
</mgcpProfile
>
Selection List:
Void
MGCP Profile
A configured profile MGCP can be selected.

The MGCP profiles must be already created in the System of the
Aarenet VoIP Switch!
Void (Default):
MGCP Profile:
The name of a configured MGCP profile; max.
32 characters.
<endpointName
>
ADD_MGCP_ENDP
OINT
</endpointNam
e>
String:
Void
MGCP Endpoint Name
Unequivocal identification of the MGCP MTA and the associated

FXS port.
The MGCP-MTA delivers this information together with it IP address
in the MGCP message RSIP. The Aarenet VoIP Switch compares its identification with the ADD_MGCP_ENDPOINT parameter
and accepts the communication when they match.
If no endpoint is defined then no connections to this address are
possible!
The MGCP Endpoint Name is composed from two parts:
The FXS-port identification of the MGCP MTA for

which the MGCP messages must be processed
The unequivocal identification of the MGCP MTA.

Usually the MTA MAC address of the device is used.
Syntax:
<FXS-PORT>@<MGCP_MTA_ID>
Example:
First FXS-Port of MGCP MTA:
0@0024d1aecd5a
Second FXS-Port of the MGCP MTA:
1@0024d1aecd5a
Void (Default):
No connections possible.
MGCP Endpoint Name:
Unequivocal identification of the MGCP MTA;
max. 64 characters.
<callWaiting>
Boolean:
If during a connection the MGCP MTA is able to signal a next in-
33/52
Element:
Value Range:
Description:
ADD_MGCP_CALL
_WAIT
</callWaiting
>
true
false
coming connection to a connected phone then this feature can be

activated.
<callHold>
ADD_MGCP_CALL
_HOLD
</callHold>
Boolean:
true
false
2.6.4.6
false (Default):
Incoming calls in busy state are not signaled.
true:
Incoming calls in busy state are signaled.
When the MGCP MTA is able to put an active connection to hold
then this feature can be activated.
false (Default):
Connections cannot be set on hold.
true:
Connections can set on hold.
XML Fields of the TopStop Address Parameter
Element:
Value Range:
<sysAddressTo
pStop>
. . .
</sysAddressT
opStop>
Description:
Any Number of TopStop can be associated with an address.
The XML field <sysAddressTopStop> can be defined n times
within an address container therefore
The TopStop parameter are described in chapter 2.5.4.4
2.6.4.7
XML Fields of the Location Address Parameter
Element:
Value Range:
<location>
. . .
</location>
<userAgent>
ADD_REG_USER_
AGENT
</userAgent>
Description:
Per registered CPE one Location container is delivered.
The registration information is delivered by the Aarenet VoIP Switch
while reading out the address parameters.
String:
Void
CPE Type
Contains the name of the CPE.
SIP: SIP Header User Agent
MGCP: MGCP profile name of the Aarenet VoIP

Switch
Void:
No name delivered
CPE Type:
Name of the CPE
<receivedAddr
ess>
ADD_REG_IP_AD
DRESS
</receivedAdd
ress>
String:
IP Address
<q>
ADD_REG_Q_VAL
UE
Number:
Void
Q-Value
Contains the IP address of the registered CPE.

IP Address (Default):
IP Address
Contains the "weighting" (q-value) of the registered CPE.

The q-value is considered by the Aarenet VoIP Switch when
34/52
Element:
Value Range:
</q>
Description:
ADD_BALANCED_ROUTING is active.
The higher a q-value the higher the probability that a CPE receives a call.
If is the q-value 0, the CPE receives only calls if no other CPE is
registered.
Void:
No q value registered
Q-Value:
Registered weighting of the CPE,
Value rank: 0 - 1000.
<behindNat>
true
</behindNat>
Boolean:
true
false
Indicates whether the CPE is located behind a NAT.

If the CPE is behind a NAT then it is contacted by the Aarenet VoIP
Switch regularly, in order that the assigned NAT port remains
open.
true:
The CPE is behind a NAT.
false:
The CPE is not behind a NAT.
2.7
DAML-Format: Call Distribution & Call Forwarding
2.7.1
Introduction
This DAML-format allows the treatment of Call Distribution and Call Forwarding.
As an example the vPBX can serve. With an incoming call on a public vPBX phone number this call can be
forwarded toward different internal phone numbers.
It allows to:
create a Call Distribution/Call Forwarding
delete a Call Distribution/Call Forwarding
modify a Call Distribution/Call Forwarding
read a Call Distribution/Call Forwarding
A Call Forwarding is a simplified Call Distribution.
XML-Container for the DAML-Format of a Call Distribution & Call Forwarding
2.7.2
Alle XML Fields werden im CallForward-Container aufgelistet:
Das XML-Feld <callForward> definiert den CallForward-Container
Die Reihenfolge der XML Fields ist beliebig
35/52
All XML fields are listed in the CallForward container:
The XML filed <callForward> defines the CallForward container
Mandatory is the XML field <account> which identifies the account unambiguously.
Mandatory is the XML field is <name> which identifies the call forward element unambiguously.
The order of the XML fields is arbitrarily
CallForward-Container:
<callForward>
. . .
</callForward>
Example:
<callForward>
<name>MessageBox</name>
. . .
</callForward>
2.7.3
Create, Modify, Read and Delete of a Call Distribution & Call Forwarding
2.7.3.1
Create an Call Distribution & Call Forwarding
DAML-Document:
All available Parameter for Call Distribution & Call Forwarding see: Chapter 2.7.3.5
<callForward>
<type>CF_TYPE</type>
<priority>CF_PRIORITY</priority>
<delay>CF_DELAY</delay>
<destPattern>CF_DESTINATION_PATTERN</destPattern>
<sourcePattern>CF_SOURCE_PATTERN</sourcePattern>
<sourcePresentationPattern>CF_SOURCE_PRES_PATTERN</sourcePresentationPattern>
<destReplace>CF_DESTINATION_REPLACE</destReplace>
<timePattern>CF_TIME_PATTERN</timePattern>
<propagateBusy>CF_PROPAGATE_BUSY</propagateBusy>
<parallelCall>CF_PARALLEL_CALL</parallelCall>
<alwaysRing>CF_ALWAYS_RING</alwaysRing>
<lastDiversion>CF_LAST_DIVERSION</lastDiversion>
</callForward>
</daml>
Example 1: Call Forwarding toward the answering machine of the internal number 1001
<callForward>
36/52
<type>DIST</type>
<priority>10</priority>
<delay>10</delay>
<destPattern>1001</destPattern>
<sourcePattern/>
<sourcePresentationPattern/>
<destReplace>0861001</destReplace>
<timePattern>!12345@0800-1200/1300-1700</timePattern>
<propagateBusy>false</propagateBusy>
<parallelCall>false</parallelCall>
<alwaysRing>false</alwaysRing>
<lastDiversion>true</lastDiversion>
</callForward>
</daml>
Example 2: Unconditional Call Forwarding when the CLIP of the incoming phone number begins
with 0027.
<callForward>
<name>CFU Russia</name>
<type>CFU</type>
<destPattern/>
<sourcePattern>0027.*<sourcePattern/>
<timePattern/>
<destReplace>0123456789</destReplace>
</callForward>
</daml>
2.7.3.2
Modify an Call Distribution & Call Forwarding : Modify or Delete a Parameter
DAML-Document:
<callForward>
. . .
All available Parameter for Call Distribution & Call Forwarding see: Chapter
2.7.3.5
. . .
</callForward>
</daml>
Example 1: Modify an already configured Call Forward parameter:

<callForward>
37/52
</callForward>
</daml>
Example 2: Delete an already configured Call Forward parameter:

In this example the contents of the <sourcePresentationPattern> filed is deleted in two different
manners.
<callForward>
<sourcePresentationPattern></sourcePresentationPattern>

</callForward>
</daml>
2.7.3.3
Read a Call Distribution & Call Forwarding
DAML-Document:
<callForward>
</callForward>
</daml>
Example:
<callForward>
</callForward>
</daml>
2.7.3.4
Delete a Call Distribution & Call Forwarding
DAML-Document:
<callForward>
</callForward>
</daml>
Example:
<callForward>
</callForward>
</daml>
38/52
2.7.3.5
Special Cases
Remarks for modifying /deleting of Call Forwards:
There are side effects on Call Distribution elements of an account when simplified Call Forwardings in the Address container are modified or deleted. For details see chapter 2.6.3.5
2.7.4
Konfiguration der Parameter of the Call Distribution & Call Forwarding
2.7.4.1
XML Fields of the Call Distribution & Call Forwarding Account Parameter
XML Field:
Value Range:
Description:
<name>
CF_NAME
</name>
String:
Call Forward Name
Name of the call distribution. The name must be unequivocal within

the account.
Void (Default):
Call Forward Name
Name of the call distribution; max. 128 characters
<account>
ACC_NAME
</account>
String:
Account
Name
Unequivocal name of the account

Account Name:
<type>
CF_TYPE
</type>
Selection List:
CFU
CFF
CFB
CFR
CFNR
CFO
DIST
Defines the type of the call distribution.

CFU:
Call Forward Unconditional
CFF:
Call Forward Fallback
Call forward when no CPE is registered.
CFB:
Call Forward Busy
Call forward, when the CPE is busy.
CFR:
Call
Call
CFNR:
Call
Call
CFO:
Call
Call
DIST:
Call
Call
<priority>
CF_PRIORITY
Number:
Call For-
Forward Rejected
forward when the call is rejected.
Forward No Replay
forward when no response of the called
Forking
forking toward an additional destination
Distribution
distribution element of the account.
With several active call distribution rules of the account, this parameter determines the priority of the processing of the rule.
39/52
XML Field:
</priority>
Value Range:
ward Priority
Description:
The smaller the number, the higher is the priority.
Void (Default):
Call Forward Priority:
Priority of the call distribution element.
<delay>
CF_DELAY
</delay>
Number:
Distribution Delay
Defines the absolute distribution delay of this call distribution element measured to the beginning of the call distribution of the call.
It is considered only with the type "DIST: Call Distribution"!
Distribution Delay:
Delay in seconds
<destPattern>
CF_DESTINATIO
N_PATTERN
</destPattern
>
String:
SIP Address Pattern
Defines the search pattern how the SIP address of the called party
is examined. If the pattern matches then the distribution rule is applied.
If CF_SOURCE_PATTERN and/or CF_SOURCE_PRES_PATTERN are defined, then a logical AND must be true that the redirection rule is
applied.
SIP Address Pattern:
The address pattern can contain the SIP display, the phone number and a domain.
The address parts are separated by @ and
can contain Regex; max. 128 characters.
Text-Format:
[<SIP-DISPLAY>@][<SIP_NUMBER>][@<SIP_DOMAIN>]
Example 1: Applies if the phone number begins with

0123 (display and domain are not considered):
0123.*
Example 2: Applies if in the display "juhui" is

exactly contanined(number and domain are not
considered):
juhui@@
Example 3: Applies if both phone number 012334 or

012335 and the domain "sip.aarenet.com" are
included (display it is not considered):
01233[45]@sip.aarenet.com
<sourcePatter
n>
CF_SOURCE_PAT
TERN
</sourcePatte
rn>
String:
SIP Address Pattern
Defines the search pattern how the SIP address of the calling party
is examined. If the pattern matches then the distribution rule is applied.
If CF_DESTINATION_PATTERN and/or CF_SOURCE_PRES_PATTERN are
defined, then a logical AND must be true that the redirection rule
is applied.
40/52
XML Field:
Value Range:
Description:
Text-Format:
Examples, see above at CF_DESTINATION_PATTERN

<sourcePresen
tationPattern
>
CF_SOURCE_PRE
S_PATTERN
</sourcePrese
ntationPatter
n>
Selection List:
UNDEFINED
SHOW
HIDE
Defines the search pattern how the Calling Line Identification

presentation CLIP or "Call Line Identification Restriction CLIR" of
the calling party is examined. If the pattern matches then the distribution rule is applied.
If CF_DESTINATION_PATTERN and/or CF_SOURCE_PATTERN are defined, then a logical AND must be true that the redirection rule is
applied.
UNDEFINED (Default):
Calling Line Identification is not considered.
SHOW:
CLIP: the number of the calling party must be
presented.
HIDE:
CLIR: the number of the calling party must be
restricted.
<destReplace>
CF_DESTINATIO
N_REPLACE
</destReplace
>
String:
SIP Address Pattern
Defines how the new SIP destination address is rewritten when all
searching patterns match.
Text-Format:
Examples, see above at CF_DESTINATION_PATTERN
<timePattern>
CF_TIME_PATTE
RN
</timePattern
>
String:
Void
Time Pattern
Defined in which periods the call distribution element is valid.

Void (Default):
The call distribution element is always valid.
Time Pattern:
Temporal validity of the call distribution
element; max. 30 characters
Text-Format:
["!"][<DAY>"@"][<FROM1>"-"<TO1>]["/"<FROM2>"-"<TO2>]
DAY: 1=Monday, 2=Tuesday. 7=sunday

FROM/TO formated hours-minutes: hh-mm
"!" at the beginning means NOT (inverted)
41/52
XML Field:
Value Range:
Description:
Example 1:
Monday till Friday of from 08:00 to 12:00 and
13:00 to 17:00 (working hours):
12345@0800-1200/1300-1700
Example 2:
Beyond the working hours (see above):
!12345@0800-1200/1300-1700
Example 3:
On the weekend (the whole day):
67@
Example 4:
Every day from 08:00 to 12:00:
0800-1200
Example 5:
Every Friday after 17:00:
5@1700-2400
<propagateBus
y>
CF_PROPAGATE_
BUSY
</propagateBu
sy>
Boolean:
false
true
Defines that when this call distribution element is reached and the
destination number is busy that back to the calling party busy is
signaled. All other active call distribution elements of this call will be
stopped.
false (Default):
Busy will not be signaled.
true:
Busy will be signaled.
<parallelCall
>
CF_PARALLEL_C
ALL
</parallelCal
l>
Boolean:
false
true
<alwaysRing>
CF_ALWAYS_RIN
G
</alwaysRing>
Boolean:
false
true
Defines that when this call distribution element is reached, the preceding call distribution elements will remain active.
false (Default):
The preceding call distribution elements will
not remain active.
true:
The preceding call distribution elements will
not remain active.
Defines that when this call distribution element is reached, toward
the calling party alerting is signaled in any case (even when no terminal rings).
false (Default):
The calling party is alerting signaled when a
terminal rings.
true:
The calling party is always alerting signaled.
<lastDiversio
Boolean:
Defines that the "private" call distributions of the destination number
42/52
XML Field:
Value Range:
Description:
n>
CF_LAST_DIVER
SION
</lastDiversi
on>
false
true
are not considered for the running call distribution.

false (Default):
The "private" call distributions of the destination number are considered.
true:
The "private" call distributions of the destination number are not considered.
2.8
DAML-Format: Group
2.8.1
Introduction
This DAML-format allows the treatment of groups. Groups control the availability and visibility of resources
within the VoIP Switch.
As an example can serve the vPBX. Its public and internal phone numbers are assigned to a vPBX group.
It allows to:
create a group
delete a group
modify a group
read a group
XML-Container for the DAML-Format of a Group
2.8.2
All XML fields are listed in the address container:
The XML filed <group> defines the group container.
Mandatory is the XML field is <name> which identifies the group unambiguously.
The order of the XML fields is arbitrarily.
Group-Container:
<group>
<name>GROUP_NAME</name>
. . .
</group>
Example:
<group>
<name>customer-vpbx-123</name>
. . .
</group>
43/52
2.8.3
Create, Modify, Read and Delete of a Group
2.8.3.1
Create and Modify a Group
DAML-Document:
All available Parameter for Group see: Chapter 2.8.4
<group>
<tenant>GROUP_TENANT</tenant>
</group>
</daml>
Example of creating a Group:

<group>
</group>
</daml>
2.8.3.2
Modify an Group: Modify or Delete a Parameter
DAML-Document:
<group>
. . .
. . .
<tenant>GROUP_TENANT</tenant>
</group>
</daml>
Example 1: Modify an already configured Group parameter:

<group>
<tenant>Provider A</tenant>
</group>
</daml>
2.8.3.3
Read a Group
DAML-Document:
<group>
</group>
</daml>
44/52
Example 1: Read a certain group

<group>
</group>
</daml>
Example 2: Read all groups

<group/>
</daml>
2.8.3.4
Delete a Group
DAML-Document:
<group>
</group>
</daml>
Example:
<group>
</group>
</daml>
2.8.4
Configuration of the Parameters of a Group
2.8.4.1
XML Fields of the Group-Parameter
XML Field:
Value Range:
Description:
<name>
GROUP_NAME
</name>
String:
Void
Group
Name of the group.
<tenant>
String:
Void
Mandant
Name of the tenant to which the group belongs.
GROUP_TENANT
</tenant>
Void (Default):
Group:
Name of the group; max. 64 characters
The tenant must be already created in the system of the VoIP

Switch!
Void (Default):
Mandant:
Defined tenant; max. 128 characters
45/52
2.9
DAML Query: List of all Emergency Locations
This Query requests the names of all emergency locations which are configured in this Aarenet VoIP Switch.
DAML-Query:
https://<IP_ADDRESS_FQDN>:8447/dataaccesscenter/daml?
query=QUERY_ALL_EMERGENCY_LOCATION
Example:
https://dac.provider.com:8447/dataaccesscenter/daml?query=emergencyLocations
DAML-Response:
<daml status="ok">
<emergencyLocation>EMERGENCY_LOACTION</emergencyLocation>
. . .
</daml>
Example:
<daml status="ok">
<emergencyLocation>GN0001
</daml>
Aeugst am Albis</emergencyLocation>
Affoltern am Albis</emergencyLocation>
Bonstetten</emergencyLocation>
Hausen am Albis</emergencyLocation>
XML Field:
Value Range:
Description:
QUERY_ALL_EME
RGENCY_LOCATI
ON
String:
Query directive to request all configured emergency locations.
<emergencyLoc
ation>
EMERGENCY_LOA
CTION
</emergencyLo
cation>
String:
Emergency
Location
2.10
emergencyLoca
tions
Unambiguous name of an emergency location

Emergency Location:
Name of a emergency location; max. 64 characters
DAML Query: List of all Ruleset Names
This Query requests the names of all ruleset which are configured in this Aarenet VoIP Switch.
DAML-Query:
query=QUERY_RULESET_NAME
Example:
https://dac.provider.com:8447/dataaccesscenter/daml?query=ruleset
DAML-Response:
<daml status="ok">
<ruleset>RULESET_NAME</ruleset>
46/52
. . .
</daml>
Example:
<daml status="ok">
<ruleset>Subscriber</ruleset>
<ruleset>Signal: 2 Digit Signaling</ruleset>
<ruleset>Block International Calls</ruleset>
<ruleset>Block National Mobile Calls</ruleset>
<ruleset>Block Satellite Calls</ruleset>
</daml>
XML Field:
Value Range:
Description:
QUERY_RULESET
_NAME
String:
Query directive to request all configured ruleset names.
<ruleset>
RULESET_NAME
</ruleset>
String:
Ruleset
ruleset
Unambiguous name of a ruleset.

Ruleset:
Name of a ruleset; max. 128 characters
DAML Query: List of all Account Names
2.11
This Query requests the names of all accounts which are configured in this Aarenet VoIP Switch.
DAML-Query:
query=QUERY_ALL_ACCOUNT_NAME
Example:
https://dac.provider.com:8447/dataaccesscenter/daml?query=account
DAML-Response:
<daml status="ok">
<account>ACCOUNT_NAME</account>
. . .
</daml>
Example:
<daml status="ok">
<account>acc5267.2237.6643</account>
</daml>
XML Field:
Value Range:
Description:
QUERY_ALL_ACC
OUNT_NAME
String:
Query directive to request all account names.
account
47/52
XML Field:
Value Range:
Description:
<account>
ACC_NAME
</account
String:
Account
Name
Unambiguous name of an account.
2.12
Account Name:
Name of an account; max. 32 characters
DAML Query: List of all Announcement Names of an Address
This query requests the names of all announcement names of an address.

DAML-Query:
query=QUERY_ANNOUNCEMENT&account=QUERY_ACCOUNT&number=QUERY_NUMBER
Example:
https://dac.provider.com:8447/dataaccesscenter/daml?
query=announcements&account=aarenet21&number=21
DAML-Response:
<daml status="ok">
<message>
<id>ANNONCEMENT_ID</id>
<duration>ANNONCEMENT_DURATION</duration>
<name>ANNONCEMENT _NAME</name>
</message
. . .
</daml>
Example:
<daml status="ok">
<message>
<id>179</id>
<duration>16325</duration>
<name>Brozeiten</name>
</message>
</daml>
XML Field:
Value Range:
Description:
QUERY_ANNOUNC
EMENT
String:
Query directive to request all announcement names of an address.
QUERY_ACCOUNT
String:
Account
Name
Unambiguous name of an account
String:
Number
Unambiguous telephone number or SIP address
QUERY_NUMBER
announcements
Announcement Name:
Number:
Number or SIP address; max. 50 characters
<name>
String:
Unambiguous name of an announcement

48/52
XML Field:
Value Range:
ANNONCEMENT_N
AME
</name>
Announcement Name
<id>
ANNONCEMENT_I
D
</id>
String:
ID
<duration>
ANNONCEMENT_D
URATION
</duration>
Number:
Duration
2.13
Description:
Announcement Name:
Name of an announcement; max.
Unambiguous identification of an announcement
ID:
Arbitrary string
Duration of an announcement
Duration:
Duration in milliseconds
DAML Query: List of all VoiceMail Messages of an Address
This query requests the identifications of all meassage of an addresss VoiceMail box.
DAML-Query:
query=QUERY_MESSAGES&account=QUERY_ACCOUNT&number=QUERY_NUMBER
Example:
query=voiceMessages&account=aarenet21&number=21
DAML-Response:
<daml status="ok">
<message>
<id>MESSAGE_ID</id>
<timeStart>MESSAGE_DATE_TIME</timeStart>
<timePlayed>MESSAGE_PLAYED</timePlayed>
<duration>MESSAGE_DURATION</duration>
<number>MESSAGE_NUMBER</number>
<name>MESSAGE_NAME</name>
<saved>MESSAGE_SAVED</saved>
</message>
. . .
</daml>
Example:
<daml status="ok">
<message>
<id>179</id>
<timeStart>2013-05-24T15:53:13</timeStart>
<timePlayed>never</timePlayed>
<number>22</number>
<name>Berta</name>
<saved>false</saved>
</message>
</daml>
49/52
XML Field:
Value Range:
Description:
QUERY_MESSAGE
String:
Query directive to request all message information of an addresss

VioceMail Box.
voiceMessages
QUERY_ACCOUNT
QUERY_NUMBER
String:
Account
Name
String:
Number
Announcement Name:
Number:
<id>
MESSAGE_ID
</id>
String:
ID
Unambiguous identification of a message

ID:
Arbitrary string
<timeStart>
MESSAGE_DATE_
TIME
</timeStart>
Date/Time:
Message
Recorded
Date/time of the recording of the message.

Message Recorded:
The message recording started at date/time.
Text-Format:
Example: 2013-04-14T10:29:00
<timePlayed>
MESSAGE_PLAYE
D
</timePlayed>
Date/Time:
never
Message
Played
Date/time, when the message was played the last time.

never:
The message was never played.
Message Recorded:
The message was played the last time at
date/time.
Text-Format:
Example: 2013-04-14T10:29:00
<duration>
MESSAGE_DURAT
ION
</duration>
Number:
Duration
<number>
MESSAGE_NUMBE
R
</number>
String:
Number
<name>
MESSAGE_NAME
</name>
String:
Name
<saved>
MESSAGE_SAVED
</saved>
Boolean:
true
false
Duration of an announcement
Duration:
Telephony number of the calling side.
Number:
Arbitrary string
Name of the calling side who is included in the SIP-Header "From".
Name:
Arbitrary string
Indicates whether the message was marked by the subscriber for a
longer retention.
50/52
XML Field:
Value Range:
Description:
true:
The message is kept longer.
false:
The message is not kept longer.
2.14
DAML Query: List of the Last Connections of a Number
This query requests a list of the last n connections and connection attempts of a phone number.
This DAML query delivers the raw data of a connection. It is the job of the CRM application to transform these data into the desired form and representation.
DAML-Query:
query=QUERY_CALLS&account=QUERY_ACCOUNT&number=QUERY_NUMBER&entries=QUERY_ENTRY
Example:
query=calls&account=aarenet21&number=21&entries=10
DAML-Response:
<daml status="ok">
<call>
<time>CALL_START</time>
<duration>CALL_DURATION</duration>
<direction>CALL_DIRECTION</direction>
<number>CALL_PEER_NUMBER</number>
<charge>CALL_CHARGE</charge>
</call>
. . .
</daml>
Example:
<daml status="ok">
<call>
<time>2013-05-24T14:55:13</time>
<direction>out</direction>
<charge>0.10</charge>
</call>
<call>
<time>2013-05-24T10:20:38</time>
<direction>in</direction>
</call>
</daml>
XML Field:
Value Range:
Description:
QUERY_CALLS
String:
Query directive to request the last connections and connection attempts of a telephone number.
calls
51/52
XML Field:
Value Range:
Description:
QUERY_ACCOUNT
String:
Account
Name
String:
Number
QUERY_NUMBER
Announcement Name:
Number:
QUERY_ENTRY
<time>
CALL_START
</time>
Number:
Number of
Calls
Number of the requested connections and connection attempts.
Date/Time:
Date/time of the calls start.
Call Start
Number of Calls:
>= 0
Call Start:
The call started at date/time
Text-Format:
Example: 2013-04-14T10:29:00
<duration>
CALL_DURATION
</duration>
Number:
Duration
<direction>
CALL_DIRECTIO
N
</direction>
Selection List:
in
out
Duration of the connection

Duration:
If the duration is 0 then it was a call attempt.
Indicates whether it is an incoming or outgoing connection.
in:
Incoming connection
out:
Outgoing connection
<number>
CALL_PEER_NUM
BER
</number>
String:
Peer Number
<charge>
CALL_CHARGE
</charge>
Decimal Number:
Charge
Shows the telephone number of the other participant of the connection.

CALL_DIRECTION : in
At incoming connections this is the number of
the calling side (CLIP)
CALL_DIRECTION : out
Bei abgehende Verbindung ist dies die gewhlte Nummer.
Charge of an outgoing connection.
Charge:
Charge
52/52

Manual Voip-Switch v54 Extract Operation Daml E20

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Manual Voip-Switch v54 Extract Operation Daml E20

Uploaded by

Copyright:

Available Formats

Manual

Aarenet VoIP Switch

Document Version: e2.0

Aarenet AG, Meriedweg 11

Operational Configuration via DataAccessCenter

Information about this Manual ......................................................................... 3

Purpose of this Documentation .................................................................................................. 3

Document Conventions ............................................................................................................... 4

Obtaining of Documentation and SW Application .................................................................... 4

Operational Configuration via DataAccessCenter ......................................... 5

Functionality of the DataAccessCenter DAC ............................................................................ 5

Releasing the DataAccessCenter ............................................................................................... 7

IP Access to the DAML Interface ................................................................................................ 7

DAML-Data Exchange via HTTP ................................................................................................. 8

DAML-Format: Account ........................................................................................................... 9

DAML-Format: Address .........................................................................................................19

DAML-Format: Call Distribution & Call Forwarding ............................................................35

DAML-Format: Group .............................................................................................................43

DAML Query: List of all Emergency Locations ...................................................................46

DAML Query: List of all Ruleset Names ...............................................................................46

DAML Query: List of all Account Names .............................................................................47

DAML Query: List of all Announcement Names of an Address ........................................48

DAML Query: List of all VoiceMail Messages of an Address .............................................49

DAML Query: List of the Last Connections of a Number ...................................................51

Operational Configuration via DataAccessCenter

Information about this Manual

Purpose of this Documentation

This reference manual is aimed for the following users:

Operators who arrange accounts and its associated addresses.

Operational Configuration via DataAccessCenter

Helpful tips or references to information which aren't included in this reference

Obtaining of Documentation and SW Application

Operational Configuration via DataAccessCenter

Operational Configuration via DataAccessCenter

Functionality of the DataAccessCenter DAC

The DAML documents are exchanged with the HTTP/HTTPS protocol.

The access is protected by a HTTP-Authentication.

The interface supports XML-based data (version XML 1.0).

The XLS transformation XSLT is supported.

Customized DAML-Formats can be created when required.

Configurable Operational Parameters

DAML-Format Call Distribution & Call Forwarding :

Loading Announcement texts:

Operational Configuration via DataAccessCenter

Query of Special operational Data and State Information

Emergency call places:

Messages of the answering machine:

Introduction to the DAML Formats and XSLT Conversion

The order of the XML elements is free

Application for incoming XML documents, e.g.:

Completion of missing XML fields with the default values

Simple introduction to XML: http://www.selfxml.de/begriffe.html

Operational Configuration via DataAccessCenter

Application to outgoing XML documents, e.g.:

Queries of CDR lists and delivery as HTML formatted document

Releasing the DataAccessCenter

HTTP / HTTPS- Authorization-Credentials:

Authorization for the access to DAML-Formats and DAML-Queries:

XLTS files to be used for interpretation and formatting

The configuration of the DataAccessCenter releasing has to be accomplished in

IP Access to the DAML Interface

Must be an IP-Address or a FQDN.

Operational Configuration via DataAccessCenter