Manual Voip-switch v54 Extract Operation Daml e20

8/10/2019 Manual Voip-switch v54 Extract Operation Daml e20

1/52

Copyright Aarenet AG., Niederwangen, Switzerland. Copying of this document or parts of it is prohibited.

Manual

Aarenet VoIP Switch

Operational Configuration via

DataAccessCenter

Document Version: e2.0

Aarenet VoIP Switch Software Release: V5.4

Aarenet AG, Meriedweg 11

CH3172 Niederwangen

T +41 31 980 28 11, F +41 31 980 28 12www.Aarenet.com, [email protected]


2/52

Operational Configuration via DataAccessCenter

Copyright Aarenet AG 2/52

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

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

2.1 Functionality of the DataAccessCenter DAC ............................................................................ 52.1.1

Overview ........................................................................................................................................ 5

2.1.2 Configurable Operational Parameters ........................................................................................... 52.1.3

Query of Special operational Data and State Information ............................................................. 6

2.1.4

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 DAML-Data Exchange via HTTP ................................................................................................. 82.4.1

HTTP-DIGEST Authentication ....................................................................................................... 8

2.4.2 HTTP POST Data Exchange for DAML-Formats ........................................................................... 82.4.3 HTTP-GET Data Exchange for DAML-Queries ............................................................................. 82.4.4

HTTP RESPONSE of the DataAccessCenter ................................................................................ 9

2.5 DAML-Format: Account........................................................................................................... 92.5.1 Introduction ..................................................................................................................................... 92.5.2

XML-Container for the DAML-Format of an Account.................................................................. 9

2.5.3 Create, Modify, Read and Delete of an Account....................................................................... 10

2.5.4

Konfiguration der Parameter of an Account.............................................................................. 13

2.6 DAML-Format: Address......................................................................................................... 192.6.1 Introduction ................................................................................................................................... 192.6.2 XML-Container for the DAML-Format of an Address................................................................ 192.6.3

Create, Modify, Read and Delete of an Address....................................................................... 20

2.6.4 Konfiguration der Parameter of an Address.............................................................................. 23

2.7 DAML-Format: Call Distribution & Call Forwarding............................................................ 352.7.1

Introduction ................................................................................................................................... 35

2.7.2 XML-Container for the DAML-Format of a Call Distribution & Call Forwarding........................ 352.7.3 Create, Modify, Read and Delete of a Call Distribution & Call Forwarding............................... 362.7.4

Konfiguration der Parameter of the Call Distribution & Call Forwarding................................... 39

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

2.8.1

Introduction ................................................................................................................................... 43

2.8.2

XML-Container for the DAML-Format of a Group...................................................................... 43

2.8.3 Create, Modify, Read and Delete of a Group............................................................................. 442.8.4 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


3/52



1 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 ofthe 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 VoIPSwitch.


4/52



1.3 Document Conventions

NNote:

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

WWarning:

Warnings to situations which may cause danger of injury, device damage or dataloss.

Warnings to situations which may cause interruptions of the telephony service forthe subscriber.

C

Configuration:

Tip to a configuration situation which is not intuitively recognizable.

VVersion:

Tip to a situation which is dependent of the Aarenet VoIP System software version.

1.4 Obtaining of Documentation and SW Application

This documentation and PC applications can be obtained by means of e-mail from the Aarenet support or theAarenet download site:

[email protected]

http://www.aarenet.com/downloads

1.5 Feedbacks

Comments, suggestions, error messages can be reported via e-mail to Aarenet support:

[email protected]
mailto:[email protected]://www.aarenet.com/downloadsmailto:[email protected]:[email protected]://www.aarenet.com/downloadsmailto:[email protected]


5/52



2 Operational Configuration via DataAccessCenter

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 ac-cess the operational data of the Aarenet VoIP Switch. It is predestined therefore for the binding of a CRMsystem of the operator to the Aarenet VoIP Switch.

The DataAccessCenter DAC offers with the DAML interface (Data Access Markup Language DAML) an APIto 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 numbersand 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. readout 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 de-scribed 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 andvPBX

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 internalphone numbers

Other DAML-Formats can be enabled in arrangement with the Aarenet project manager or support. TheseDAML-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


6/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 DAML-Queries 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 appli-cation 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 ispossible to treat incoming XML documents, e.g. from a CRM application, with defined XLST commands, be-fore they are processed as DAML formats. Vice versa outgoing XML documents can be reworked with de-fined XLST commands and the result sent to the CRM application.

NXLST conversions must be developed and checked in corporation with the Aarenetengineering.

Application for incoming XML documents, e.g.:

Completion of missing XML fields with the default values

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


7/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 atcomponent 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 ap-plication has.

5. XLTS files to be used for interpretation and formattingDefines, whether the configuration data must be pre and/or reworked by means of XLST con-versions.

NThe configuration of the DataAccessCenter releasing has to be accomplished inclose collaboration between the provider and the Aarenet project manager.

2.3 IP Access to the DAML Interface

For the DataAccessCenter the URL must have the following form:

DAML Access:

https://:8447/dataaccesscenter

Example:

https://192.168.1.1:8447/dataaccesscenter

https://dac.provider.com:8447/dataaccesscenter

Element: Value Range: Description:

String:

IP Address FQDN

Must be an IP-Address or a FQDN.

Mandatory configuration!

IP Address:IP Address

FQDN:Full Qualified Domain Name
https://192.168.1.1:8447/dataaccesscenterhttps://192.168.1.1:8447/dataaccesscenterhttps://192.168.1.1:8447/dataaccesscenterhttps://dac.provider.com:8447/dataaccesscenterhttps://dac.provider.com:8447/dataaccesscenterhttps://dac.provider.com:8447/dataaccesscenterhttps://dac.provider.com:8447/dataaccesscenterhttps://dac.provider.com:8447/dataaccesscenterhttps://192.168.1.1:8447/dataaccesscenter


8/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 as-signed 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. Bythe use of the directive POST big data volumes can be transmitted in the HTTP body. Moreover, they are notvisible 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 formattedDAML-directive:

DAML-Document:

. . .

Example:

acc0001


DAML_DIRECTIVE

Selection List:

write read delete

DAML Directive


write:The given data should be written. This di-

rective 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. con-nections list.

DAML-Queries are executed with HTTP GET Requests.


9/52



DAML-Query:

https://: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 " or "5xx " is re-

turned, e.g., "500 Internal Server Error".

If the cause of the problem is not deductive from the error message, the error situation can be examinedfrom 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 DAML-format "Address" (see chapter2.6).

2.5.2 XML-Container for the DAML-Format of an Account

All XML fields are listed in the account container:

The XML filed defines the account container Mandatory is the XML field which identifies the account unambiguously.

The order of the XML fields is arbitrarily

Account-Container for Account:

ACC_NAME. . .

Example:

an-acc-0001


10/52



Aarenet. . .

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: Chapter2.5.4

ACC_NAME

ACC_TENANT

ACC_INFOACC_SIP_USERNAMEACC_SIP_PASSWORD

ACC_CHANNELACC_LOCATION

ACC_ROUTINGTABLEACC_RULSET

ACC_PRICELISTACC_AOC

TOPSTOP_USER_TYPE

TOPSTOP_MAXTOPSTOP_ALARM_LEVELTOPSTOP_EMAILTOPSTOP_CURRENT_VALUE

ACC_VALID_AFTERACC_VALID_UNTIL

ACC_SPECIAL_ARRAGEMENTACC_ALARM_ON_EXPIRYACC_USE_MEDIA_SERVERACC_MCID

ACC_SUBSC_USERNAMEACC_SUBSC_PASSWORDACC_SUBSC_LANGUAGE

CF_NAMECF_TYPECF_PRIORITY

CF_DELAYCF_DESTINATION_PATTERNCF_SOURCE_PATTERNCF_SOURCE_PRES_PATTERN

CF_DESTINATION_REPLACE

CF_TIME_PATTERNCF_PROPAGATE_BUSY


11/52



CF_PARALLEL_CALLCF_ALWAYS_RINGCF_LAST_DIVERSION

Example of creating an Account:

an-acc-0021

AarenetTest Account: Tel 012 345 67 89asdfe434twdvsg76wv5v25v34260GN0355 Kniz

Route to PSTN

SubscriberBlock : 09xx

Standard Pricelisttrue

[email protected]

2013-04-14T10:29:00

falsefalsefalsefalse

acc-21acc-21-passworden

2.5.3.2 Modify an Account: Modify or Delete a Parameter

DAML-Document:

ACC_NAME

. . .All available Parameter for Account see: Chapter 2.5.3.5

. . .


12/52



Example 1: Modify an already configured Account parameter:

an-acc-00212014-01-01T00:00:00

Example 2: Delete an already configured Account parameter:

In this example the contents of the filed is deleted in two different manners.

an-acc-0021

2.5.3.3 Read an Account

DAML-Document:

ACC_NAME

Example:

an-acc-0021

2.5.3.4 Delete an Account

DAML-Document:

ACC_NAME

Example:

an-acc-0021


13/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 accountmust 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:

ACC_NAME

String:

AccountName

Unambiguous name of the account


Account Name:Arbitrary string; max. 32 characters

ACC_TENANT

String:

Void Mandant

Name of the mandant to which the account belongs.

The mandant must be already created in the system of the VoIPSwitch!

Void (Default):

Mandant:Definierter Mandant; max. 128 characters

ACC_INFO

String:

Void Infor-

mation

Any information

Void (Default):

Information:Arbitrary string; max. 128 characters

ACC_SIP_USERNAME

String:

SIP UserSIP user name.

Mandatory configuration!The SIP user name must be unique!

SIP User:

Arbitrary string; max. 32 charactersACC_SIP_PASSWORD

String:

SIP Pass-word

SIP password


SIP Password:Arbitrary string; max. 32 characters

ACC_CHANNEL

Number:

Void Number of

Channel

Determines how many concurrent connections are possible.

If the value is 0 the no incoming and outgoing connections are pos-sible.

Void (Default):No channel limitation


14/52


15/52




ACC_AOC

Boolean:

false true

Activate sending advice of charge AOC to all addresses of the ac-count.

false (Default):

Advice of charge is not activatedtrue:Advice of charge is activated

2.5.4.3 XML Fields of the Advanced Account Parameters


ACC_VALID_AFTER

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 xml-DateTime Data Type:

yyyy-MM-dd'T'HH:mm:ss

Example: 2013-04-14T10:29:00

ACC_VALID_UNT

IL

Date/Time:

Void Account

Valid Un-til

Date/time of the deactivation of the account

The addresses associated with the account are also not active anymore.

Void (Default):The account is active.

Account Valid Until:The account is deactivated beginning atDate/Time.

Text-Format:

The format corresponds with the XML Standardxml-DateTime Data Type:


Example: 2013-05-01T00:00:00

ACC_SPECIAL_ARRAGEMENT

Boolean:

false true

When "Spezial Arragement" is enabled then the CLIP delivered bythe CPE is accepted by the VoIP Switch (known also as "CLIP noScreening").If it is not activated, the VoIP Switch compares the delivered CLIPwith the addresses of this account and replaces it with the bestmatch. If there is no best no best then the main number is used asCLIP. If the account has no main number defined in, then the VoIPSwitch rejects the connection setup.

According to thejuridical situation of a country this feature may

not or only used restrictedly!


16/52




false (Default):The feature is not activated.

true:

The feature is activated.

ACC_ALARM_ON_EXPIRY

Boolean:

false true

If a SIP registration is not renewed, an email is generated by theAarenet VoIP Switch.

The email address is a configuration of the componentServiceCenter


true:The feature is activated.

ACC_USE_MEDIA_SERVER

Boolean: false true

Is the feature Use always Media Server activated then all mediastreams will be routed via a MediaServer of the Aarenet VoIPSwitch



ACC_MCID

Boolean:

false true

Is the feature Force Call ID (MCID) activated then the CLIP of allincoming anonymous calls to this account is reactivated (CLIR CLIP), if possible

According to thejuridical situation of a country this feature maynot or only used restrictedly! The prescribed legal action has tobe observed!



. . .

For the customer account operator the operative access to the ac-count and its addresses is unlocked.They will be enabled to do limited operative configurations via:

AdminCenter

SubscriberCenter

ACC_SUBSC_USERNAME

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:Arbitrary string; max. 128 characters

ACC_SUBSC_PAS

SWORD

String:

Void

AccountPassword

Password for the account login

Void (Default):No access

Account Password:


17/52




Arbitrary string; max. 128 characters

ACC_SUBSC_LANGUAGE

Selection List:

en de

Defines the used language in the GUI

en (Default):Englisch

de:German

2.5.4.4 XML Fields of the TopStop Account Parameter

XML Fields of the TopStop Account Parameter:

TOPSTOP_USERTOPSTOP_MAXTOPSTOP_ALARM_LEVEL

TOPSTOP_EMAILTOPSTOP_CURRENT_VALUE


. . .

Any number of TopStop can be associated with an account.

The XML field can be defined n times

within an account container therefore.

TOPSTOP_USER

Selection List:

SYS ACC ADD

Der Parameter definiert, mit welcher Rolle dieser TopStop erstelltwurde. Er definiert somit auch, fr welche Rolle dieses TopStop

sichtbar sein soll.The parameter defines with which role a TopStop was created. Thisdefines also for which role the TopStop is visible.

SYS (Default):The TopStop was created by a system adminis-trator. It is visible only for this role.

ACC:The TopStop was created by an account opera-tor. It is visible for the roles of the sys-tem administrator and account operator.

ADD:

The TopStop was created by a subscriber. Itis visible for the system administrator, ac-count operator and subscriber.

TOPSTOP_MAX

Decimal Num-ber:

Void TopStop

MaximumValue

Defines the charging limit per month for the account. It may not beexceeded 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 emailaddress is defined.

Void (Default):No charging limit is superviced

TopStop Maximum Value:Maximal charging limitValue Range: >= 0.00


18/52




TOPSTOP_ALARM_LEVEL

Decimal Num-ber:

Void TopStop

Alarm Lev-el

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 emailaddress is defined.

Void (Default):No level is monitored.

TopStop Alarm Level:An email alarm is generated if x% of thecharging limit is used:Value Range: 0.0 1.0

TOPSTOP_EMAIL

String:

Void Email

Adresse

If defines an email address which is informed if the level or thecharging limits is reached.

Void (Default):No email will be sent.

Email address:At overrun of the level and the charging lim-it an email is sent; max. 64 characters.

TOPSTOP_CURRENT_VALUE

Decimal Num-ber:

TopStopCurrentValue

Current total charges of this account since early beginning of themonth.

The value can be only read out

TopStop Current Value:Current total charges

Value Range: >= 0.00

2.5.4.5 XML Fields of the Attribute Account Parameter

XML Fields fr ein Attribut:

ACC_ATTRIBUTE_NAMEACC_ATTRIBUTE_VALUE


. . .

Any number of attributes can be assigned to an account.

The XML field can be defined n times with-

in an account container therefore.

ACC_ATTRIBUTE_NAME

String:

AttributeName

An attribute name can be used.

The attribute must be already created in the ConfigCenter compo-nent of the VoIP Switch!

Attribute Name:

Name of a configured attribute; max. 256characters.


19/52




ACC_ATTRIBUTE_VALUE

String:

AttributeValue

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

2.6.2 XML-Container for the DAML-Format of an Address

All XML fields are listed in the address container:

The XML filed defines the account container.

Mandatory is the XML field is which identifies the account unambiguously.

Mandatory is the XML field is which identifies the address (phone number) unam-biguously.

The order of the XML fields is arbitrarily.

Address-Container for Address :

ADD_NUMBERACC_NAME. . .

Example:

0123456789an-acc-0001. . .


20/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: Chapter2.6.4

ADD_NUMBERACC_NAME

ADD_DOMAINADD_DISP_NAME

ADD_SHOW_CLIPADD_HIDE_CLIP

ADD_LANGUAGE

ADD_MAIN_NUMBERADD_REG_VIA_MAIN

ADD_BASE_NUMBERADD_PREF_NUMBER

ADD_VALID_AFTERADD_VALID_UNTILADD_PORT_OUT_NUMBER

ADD_SINGLE_REGISTRATIONADD_BALANCED_ROUTING

ADD_DISABLED_ADDRESSADD_OUTGOING_BLOCKEDADD_NO_OFFER_ON_BUSYADD_SIGNALING_ONLY

ADD_CFU_SHORTADD_CFB_SHORTADD_CFNR_SHORTADD_CFO_SHORTADD_CFF_SHORT

ADD_DNDADD_RRN

ADD_SUBSC_USERNAMEADD_SUBSC_PASSWORDADD_SUBSC_LANGUAGE

ADD_VM_PIN

ADD_VM_EMAIL

ADD_VM_AUTO_AUTHADD_VM_BLOCK

ADD_VM_SIG_NEW_MESSAGE

ADD_VM_MWI_ONLY

ADD_VM_LANGUAGEADD_VM_SKIP_MESSAGE_MENU


21/52


22/52



0123456789an-acc-0021

2014-01-01T00:00:00

Example 2: Delete an already configured Account parameter:

In this example the contents of the filed is deleted in two different manners.

0123456789an-acc-0021

2.6.3.3 Read an Address

DAML-Document:

ADD_NUMBER

ACC_NAME

Example:

0123456789an-acc-0021

2.6.3.4 Delete an Address

DAML-Document:

ADD_NUMBERACC_NAME

Example:


23/52



0123456789an-acc-0021


Remarks for deleting of TopStop:

If within an address a TopStop has to be deleted all other configured TopStops of this accountmust 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 dis-

tributions of the account which is associated with this address are deleted:ADD_CFU_SHORTADD_CFB_SHORTADD_CFNR_SHORTADD_CFO_SHORTADD_CFF_SHORT

Weiterhin bentigte Anrufweiterleitungen und Anrufverteilungen mssen wieder geschriebenwerden.

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


ACC_NAME

String:

AccountName

Unequivocal name of the account to which the phone number be-longs


Account Name:Arbitrary string; max. 32 characters

ADD_NUMBER

String:

SIP Number

Unequivocal phone number or SIP address.

Format SIP address:@


Void (Default):Invalid configuration

SIP Number:Arbitrary string; max. 50 characters


24/52




ADD_DOMAIN

String:

Void IP Address FQDN

IP address or FQDN of the SIP Registrar and SIP Proxy.


Void (Default):

IP Address:Arbitrary string; max. 128 characters

FQDN:Arbitrary string; max. 128 characters

ADD_DISP_NAME

String:

Void Display

Name

Displayed name information at the called party side.


The display information from the SIP terminal will be overwritten!

Void (Default):

Display Name:Arbitrary string; max. 64 characters

ADD_SHOW_CLIP

Boolean:

true false

These two parameters determine whether and how the CLIP of thecalling 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: falseCLIP will be always shownpermanent CLIP

ADD_SHOW_CLIP: false

ADD_HIDE_CLIP: trueCLIP will be never shown permanent CLIR

ADD_SHOW_CLIP: trueADD_HIDE_CLIP: trueInvalid, the result is undefined!

ADD_HIDE_CLIP

Boolean:

true false

ADD_LANGUAGE

Selection List:

de en fr it

Defines the used language for inband information, which are playedby the Aarenet VoIP Switch, e.g. The subscriber is not wanted tobe disturbed at the moment

de: German

en: English

fr: France

it: Italian

ADD_MAIN_NUMBER

Boolean: true false

Defines if the number is the main number of the account.

If a CPE registers the main number with the correct SIP Credentialsat the account, then the main number and all other numbers


25/52




which are selected with registered via main number are auto-matically 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. Alsoall numbers of the account withADD_REG_VIA_MAINare automatically regis-tered.

ADD_REG_VIA_MAIN

Boolean:

true false

This number is registered via the main number. It is not necessarythat 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 ifthe main number is registered.

ADD_BASE_NUMBER

Boolean:

true false

This number is the base number of this account. The base numberserves as a search pattern to identify an open number space.

Per account there can be only one base number!

Example:

Base Number : 012345Regexp: 012345.*

Matches, e.g. the numbers:012345 0012345 100012345 99999

false (Default):The number is no base number.

true:The number is the base number of the account.

ADD_PREF_NUMBER

Boolean:

true false

This number will always be used as CLIP by the Aarenet VoIPSwitch for all outgoing calls from any number of this account.

The number will be signaled as preferred. Either in the SIP HeaderFrom- or P-Preferred.

false (Default):The number is not a fix CLIP

true:The number defines the fix CLIP of the ac-count.


26/52



2.6.4.2 XML Fields of the Advanced Address Parameter


ADD_VALID_AFTER

Date/Time:

Void Address

Valid From

Date/time of the activation of the telephony number (SIP address)

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 standardxml-DateTime Data Type:


Example: 2013-04-14T10:29:00

ADD_VALID_UNTIL

Date/Time:

Void Address

Valid Un-til

Date/time of the deactivation of the telephony number (SIP ad-dress)

Void (Default):The number is not deactivated.

Address Valid Until:The number is deactivated starting atDate/Time.

Text-Format:

The format conforms to the XML standardxml-DateTime Data Type:


Example: 2013-05-01T00:00:00

ADD_PORT_OUT_NUMBER

String:

Void Port Out

Number

WhenADD_PORT_OUT_NUMBERis defined and the number deac-tivated with Date/TimeADD_VALID_UNTILthen the Aarenet VoIPSwitch will redirect an incoming call toward this number back intothe PSTN.

According the settings of the ServiceCenter component thisADD_PORT_OUT_NUMBERis part of a rewriting rule which is ap-

plied to the destination number before the call is redirected to-ward the PSTN.

In Switzerland the NPRN of the new provider is setExample:

Outported Number : 0123456789

NPRN new provider : 098000

Setting inADD_PORT_OUT_NUMBER: 98000

The rewriting result will be: 0980000123456789

Void (Default):

Port Out Number:Arbitrary string; max. 50 characters

ADD_SINGLE_RE

Boolean:

true false

Defines, whether several CPE can register on this number.

true (Default):


27/52




GISTRATION

Several CPE can register on the number.

false:Only one CPE is allowed to register on thenumber.

ADD_BALANCED_ROUTING

Boolean: true false

When the CPE provides with the registration a Q value then incom-ing connections are routed to that CPE which has delivered the big-gest q value.

false (Default):The Q value delivered by the CPE is not con-sidered.

true:The Q value delivered by the CPE is consid-ered.

ADD_DISABLED_

ADDRESS

Boolean:

true false

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.

ADD_OUTGOING_BLOCKED

Boolean:

true false

The number cannot start outgoing connections. Incoming connec-tion to this number are routed normally.

false (Default):The number is not disabled for outgoing con-nections.

true:The number is disabled for outgoing connec-tions.

ADD_NO_OFFER_ON_BUSY

Boolean:

true false

When the number is in an active connection then newly incomingconnections are not offered.

false (Default):Incoming calls are always offered.

true:If a connection is active no new incomingconnections are offered.

ADD_SIGNALING_ONLY

Boolean:

true false

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 outgoingconnections.

true:The number can handle only outgoing connec-tions.

ADD_CFU_SHORT

String:

CF Desti-nationNumber

Configures a general Unconditional Call Forwarding CFUto the

redirection destination.

This call forwarding is valid for all phone numbers of the account.


28/52




It is automatically configured with the default DAML priority for CallForwarding.

For complex call forwarding see chapter2.7Follow the special procedure by modifying or deleting of this redi-

rection, see chapter2.6.3.5

CF Destination Number:Arbitrary string; max. 50 characters

ADD_CFB_SHORT

String:


Configures a general Call Forwarding Busy CFBto the redirectiondestination.

This call forwarding is valid for all phone numbers of the account.It is automatically configured with the default DAML priority for Call

Forwarding.For complex call forwarding see chapter2.7Follow the special procedure by modifying or deleting of this redi-

rection, see chapter2.6.3.5.


ADD_CFNR_SHORT

String:


Configures a general Call Forwarding not Reachable CFNRto theredirection destination.





ADD_CFO_SHORT

String:


Configures a general Call Forking CFOto the redirection destina-tion.

This call forking is valid for all phone numbers of the account.It is automatically configured with the default DAML priority for Call



CF Destination Number:B Arbitrary string; max. 50 characters

ADD_CFF_SHORT

String:


Configures a general Call Forwarding Fall Back CFFto the redirec-tion destination.


Forwarding Fall Back CFF.For complex call forwarding see chapter2.7Follow the special procedure by modifying or deleting of this redi-




29/52




ADD_DND

Boolean:

true false

Do not Disturb, incoming calls are rejected with an inband mes-sage.

false (Default):

Incoming calls are accepted.true:Incoming calls are rejected.

ADD_RRN

Boolean:

true false

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 readoutsto his address is enabled by the:

AdminCenter

SubscriberCenter

iPhoneCenter

ADD_SUBSC_USERNAME

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:Arbitrary string; max. 128 characters

ADD_SUBSC_PASSWORD

String:

Void Subscriber

Password

Password for the subscriber login

Void (Default):No Access

Subscriber Password:Arbitrary string; max. 128 characters

ADD_SUBSC_LANGUAGE

Selection List:

en de

Defines the used language in the GUI.

en (Default):Englisch.

de:German.

2.6.4.3 XML Fields of the VoiceMailBox Address Parameter


. . .

Per address VoiceMailBox can be associated and configured.

ADD_VM_PIN

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):


30/52


31/52




Fr: French

it: Italian

ADD_VM_SKIP_MESSAGE_MENU

Selection List:

true false

Defines whether the menu of the VoiceMailBox are recited.

false (Default):The menu are recited.

true:The menu are not recited.

2.6.4.4 XML Fields of the vPBX Address Parameter


VPBX_PBX_GROU

P

Selection List:

Void vPBX Group

The name of the group which defines the vPBX. The address willbecome a member of this vPBX group

The vPBX group must be already created in the System of theAarenet VoIP Switch!

Void (Default):

vPBX Group:The name of a configured vPBX group; max. 64characters.

. . .

A vPBX may belong to several groups.

The XML field can be defined n times withinan address container therefore

VPBX_MEMBER_OF_GROUP

Selection List:

Void Group Mem-

ber

A configured superior group can be selected.

The group must be already created in the System of the AarenetVoIP Switch!

Void (Default):

Group Member:The name of a configured group; max. 64 char-acters.

VPBX_PRIVATE_ADD

Boolean:

true false

Defines the number as a private number. Therefore it is visible andcallable only within the vPBX group.

false (Default):It is a public number.

true:It is a vPBX private number.

VPBX_PUBLIC_CLIP

String:

CLIP Num-ber

Defines the public identity of this private number for outgoing con-nections toward the PSTN. The assigned public number will beused as CLIP and must be from the public number range of thevPBX.

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


32/52




are possible!

Void (Default):

CLIP Number:An already defined public number of thisvPBX; max. 50 characters

VPBX_QUEUE_LENGTH

Number:

Void Call Queue

Defines how many concurrently incoming calls toward the privatenumber are offered at the same time. The calling sides receive thealerting tone.The call queue is used for presenting incoming calls by the monitorfunction (see belowVPBX_MONITOR_GROUP).

The functionality is depended on the implementation on the SIP de-vice!

Void (Default):The call queue is switched off

Call cue:If the value is bigger than 0 the number be-haves like a call queue.

VPBX_MONITOR_GROUP

Selection List:

Void Monitor

Group

Name of the group whose members are allowed to subscribe for theMonitor information of this internal number ("monitoring).

Monitor information are visible in this group and related superiorgroups.

The group must be already created in the system of the AarenetVoIP Switch!

Void (Default):

Monitor Group:The name of a configured group; max. 64 char-acters.

VPBX_PRESENCE_GROUP

Selection List:

Void Presence

Group

Name of the group whose members are allowed to subscribe for thePresence information of this internal number.

Presence information are visible in this group and related superiorgroups.

The group must be already created in the system of the Aarenet

VoIP Switch!

Void (Default):

Presence Group:The name of a configured group; max. 64 char-acters.

VPBX_MESSAGE_GROUP

Selection List:

Void Message

Group

Name der Gruppe, deren Mitgliedern erlaubt ist sich fr den Mes-sage Dienst dieser internen Nummer anzumelden.

Name of the group whose members are allowed to subscribe for theMessage Service of this internal number.

Message information are visible in this group and related superiorgroups.


33/52




The group must be already created in the system of the AarenetVoIP Switch!

Void (Default):

Message Group:The name of a configured group; max. 64 char-acters.

2.6.4.5 XML Fields of the MGCP Address Parameter


ADD_MGCP_PROFILE

Selection List:

Void

MGCP Pro-file

A configured profile MGCP can be selected.

The MGCP profiles must be already created in the System of theAarenet VoIP Switch!

Void (Default):

MGCP Profile:The name of a configured MGCP profile; max.32 characters.

ADD_MGCP_ENDPOINT

String:

Void MGCP End-

point Name

Unequivocal identification of the MGCP MTA and the associatedFXS port.

The MGCP-MTA delivers this information together with it IP address

in the MGCP message RSIP. The Aarenet VoIP Switch com-pares its identification with theADD_MGCP_ENDPOINTparameter

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 forwhich the MGCP messages must be processed

The unequivocal identification of the MGCP MTA.Usually the MTA MAC address of the device is used.

Syntax: @

Example:First FXS-Port of MGCP MTA:

0@0024d1aecd5aSecond 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.

Boolean: If during a connection the MGCP MTA is able to signal a next in-


34/52


35/52




ADD_BALANCED_ROUTING is active. The higher a q-value the higher the probability that a CPE re-

ceives 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.

true

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 VoIPSwitch regularly, in order that the assigned NAT port remainsopen.

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 beforwarded 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

N A Call Forwarding is a simplified Call Distribution.

2.7.2 XML-Container for the DAML-Format of a Call Distribution & Call For-warding

Alle XML Fields werden im CallForward-Container aufgelistet:

Das XML-Feld definiert den CallForward-Container

Die Reihenfolge der XML Fields ist beliebig


36/52



All XML fields are listed in the CallForward container:

The XML filed defines the CallForward container

Mandatory is the XML field which identifies the account unambiguously.

Mandatory is the XML field is which identifies the call forward element unambiguously.

The order of the XML fields is arbitrarily

CallForward-Container:

CF_NAMEACC_NAME. . .

Example:

MessageBoxan-acc-0001. . .

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: Chapter2.7.3.5

CF_NAMEACC_NAME

CF_TYPECF_PRIORITY

CF_DELAYCF_DESTINATION_PATTERNCF_SOURCE_PATTERN

CF_SOURCE_PRES_PATTERNCF_DESTINATION_REPLACE

CF_TIME_PATTERNCF_PROPAGATE_BUSYCF_PARALLEL_CALLCF_ALWAYS_RINGCF_LAST_DIVERSION

Example 1: Call Forwarding toward the answering machine of the internal number 1001

MessageBoxan-acc-0021


37/52



DIST10

101001

0861001

!12345@0800-1200/1300-1700falsefalsefalsetrue

Example 2: Unconditional Call Forwarding when the CLIP of the incoming phone number begins

with 0027.

CFU Russiaan-acc-0021

CFU10

0027.*

0123456789

2.7.3.2 Modify an Call Distribution & Call Forwarding: Modify or Delete a Parameter

DAML-Document:

CF_NAME

ACC_NAME. . .All available Parameter for Call Distribution & Call Forwarding see: Chapter

2.7.3.5. . .

Example 1: Modify an already configured Call Forward parameter:

CFU Russia

an-acc-0021

20


38/52



Example 2: Delete an already configured Call Forward parameter:

In this example the contents of the filed is deleted in two different

manners.

CFU Russiaan-acc-0021

2.7.3.3 Read a Call Distribution & Call Forwarding

DAML-Document:

CF_NAMEACC_NAME

Example:

MessageBoxan-acc-0021

2.7.3.4 Delete a Call Distribution & Call Forwarding

DAML-Document:

CF_NAMEACC_NAME

Example:

MessageBox

an-acc-0021


39/52




Remarks for modifying /deleting of Call Forwards:

There are side effects on Call Distribution elements of an account when simplified Call Forward-ings in the Address container are modified or deleted. For details see chapter2.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


CF_NAME

String:

Call For-ward Name

Name of the call distribution. The name must be unequivocal withinthe account.



Call Forward NameName of the call distribution; max. 128 char-acters

ACC_NAME

String:

AccountName

Unequivocal name of the account


Account Name:

Arbitrary string; max. 32 characters

CF_TYPE

Selection List:

CFU CFF CFB CFR CFNR CFO DIST

Defines the type of the call distribution.


CFU:Call Forward Unconditional

CFF:Call Forward FallbackCall forward when no CPE is registered.

CFB:Call Forward Busy

Call forward, when the CPE is busy.CFR:

Call Forward RejectedCall forward when the call is rejected.

CFNR:Call Forward No ReplayCall forward when no response of the called

CFO:Call ForkingCall forking toward an additional destination

DIST:Call Distribution

Call distribution element of the account.CF_PRIORITY

Number:

Call For-

With several active call distribution rules of the account, this param-eter determines the priority of the processing of the rule.


40/52




ward Pri-ority

The smaller the number, the higher is the priority.



Call Forward Priority:Priority of the call distribution element.

CF_DELAY

Number:

Distribu-tion Delay

Defines the absolute distribution delay of this call distribution ele-ment 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

CF_DESTINATION_PATTERN

String:

SIP Ad-dress Pat-tern

Defines the search pattern how the SIP address of the called partyis examined. If the pattern matches then the distribution rule is ap-plied.

If CF_SOURCE_PATTERNand/or CF_SOURCE_PRES_PATTERN are de-

fined, then a logical AND must be true that the redirection rule isapplied.

SIP Address Pattern:The address pattern can contain the SIP dis-play, the phone number and a domain.The address parts are separated by @ andcan contain Regex; max. 128 characters.

Text-Format:[@][][@]

Example 1: Applies if the phone number begins with0123 (display and domain are not considered):

0123.*

Example 2: Applies if in the display "juhui" isexactly contanined(number and domain are notconsidered):

juhui@@

Example 3: Applies if both phone number 012334 or012335 and the domain "sip.aarenet.com" areincluded (display it is not considered):

01233[45]@sip.aarenet.com

CF_SOURCE_PATTERN

String:

SIP Ad-dress Pat-tern

Defines the search pattern how the SIP address of the calling partyis examined. If the pattern matches then the distribution rule is ap-plied.

If CF_DESTINATION_PATTERNand/or CF_SOURCE_PRES_PATTERN are

defined, then a logical AND must be true that the redirection ruleis applied.

SIP Address Pattern:The address pattern can contain the SIP dis-play, the phone number and a domain.


41/52


42/52




Example 1:Monday till Friday of from 08:00 to 12:00 and13: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

CF_PROPAGATE_BUSY

Boolean:

false true

Defines that when this call distribution element is reached and thedestination number is busy that back to the calling party busy issignaled. All other active call distribution elements of this call will bestopped.


false (Default):Busy will not be signaled.

true:Busy will be signaled.

CF_PARALLEL_CALL

Boolean:

false true

Defines that when this call distribution element is reached, the pre-ceding call distribution elements will remain active.


false (Default):The preceding call distribution elements willnot remain active.

true:

The preceding call distribution elements willnot remain active.

CF_ALWAYS_RING

Boolean:

false true

Defines that when this call distribution element is reached, towardthe calling party alerting is signaled in any case (even when no ter-minal rings).


false (Default):The calling party is alerting signaled when aterminal rings.

true:

The calling party is always alerting sig-naled.


43/52


44/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: Chapter2.8.4

GROUP_NAMEGROUP_TENANT

Example of creating a Group:

customer-vpbx-123Aarenet

2.8.3.2 Modify an Group: Modify or Delete a Parameter

DAML-Document:All available Parameter for Group see: Chapter2.8.4

GROUP_NAME

. . .All available Parameter for Group see: Chapter 2.8.4

. . .

GROUP_TENANT

Example 1: Modify an already configured Group parameter:

customer-vpbx-321

Provider A

2.8.3.3 Read a Group

DAML-Document:

GROUP_NAME


45/52



Example 1: Read acertaingroup

customer-vpbx-123

Example 2: Read all groups

2.8.3.4 Delete a Group

DAML-Document:

GROUP_NAME

Example:

customer-vpbx-123

2.8.4 Configuration of the Parameters of a Group

2.8.4.1 XML Fields of the Group-Parameter


GROUP_NAME

String:

Void Group

Name of the group.

Void (Default):

Group:Name of the group; max. 64 characters

GROUP_TENANT

String:

Void Mandant

Name of the tenant to which the group belongs.

The tenant must be already created in the system of the VoIPSwitch!

Void (Default):

Mandant:

Defined tenant; max. 128 characters


46/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://:8447/dataaccesscenter/daml?

query=QUERY_ALL_EMERGENCY_LOCATION

Example:

https://dac.provider.com:8447/dataaccesscenter/daml?query=emergencyLocations

DAML-Response:

EMERGENCY_LOACTION. . .

Example:

GN0001 Aeugst am AlbisGN0002 Affoltern am AlbisGN0003 BonstettenGN0004 Hausen am Albis


QUERY_ALL_EMERGENCY_LOCATION

String:emergencyLocations

Query directive to request all configured emergency locations.

EMERGENCY_LOACTION

String:

EmergencyLocation

Unambiguous name of an emergency location

Emergency Location:Name of a emergency location; max. 64 charac-ters

2.10 DAML Query: List of all Ruleset NamesThis Query requests the names of all ruleset which are configured in this Aarenet VoIP Switch.

DAML-Query:

https://:8447/dataaccesscenter/daml? query=QUERY_RULESET_NAME

Example:

https://dac.provider.com:8447/dataaccesscenter/daml?query=ruleset

DAML-Response:

RULESET_NAME


47/52



. . .

Example:

SubscriberSignal: 2 Digit SignalingSignal: 3 Digit SignalingSignal: 4 Digit SignalingBlock International CallsBlock National Mobile CallsBlock Satellite Calls


QUERY_RULESET_NAME

String:ruleset

Query directive to request all configured ruleset names.

RULESET_NAME

String:

Ruleset

Unambiguous name of a ruleset.

Ruleset:Name of a ruleset; max. 128 characters

2.11 DAML Query: List of all Account Names

This Query requests the names of all accounts which are configured in this Aarenet VoIP Switch.

DAML-Query:https://:8447/dataaccesscenter/daml?

query=QUERY_ALL_ACCOUNT_NAME

Example:

https://dac.provider.com:8447/dataaccesscenter/daml?query=account

DAML-Response:

ACCOUNT_NAME

. . .

Example:

acc5267.2237.6643acc5267.4732.7245acc5267.8227.3926acc5267.1127.7489


QUERY_ALL_ACCOUNT_NAME

String:account

Query directive to request all account names.


48/52




ACC_NAME


49/52




ANNONCEMENT_NAME

Announce-ment Name Announcement Name:

Name of an announcement; max.

ANNONCEMENT_ID

String:

ID

Unambiguous identification of an announcement

ID:Arbitrary string

ANNONCEMENT_DURATION

Number:

Duration

Duration of an announcement

Duration:Duration in milliseconds

2.13 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:

https://:8447/dataaccesscenter/daml? query=QUERY_MESSAGES&account=QUERY_ACCOUNT&number=QUERY_NUMBER

Example:

https://dac.provider.com:8447/dataaccesscenter/daml?query=voiceMessages&account=aarenet21&number=21

DAML-Response:

MESSAGE_IDMESSAGE_DATE_TIMEMESSAGE_PLAYEDMESSAGE_DURATIONMESSAGE_NUMBERMESSAGE_NAMEMESSAGE_SAVED

. . .

Example:

1792013-05-24T15:53:13never1431522Bertafalse


50/52




QUERY_MESSAGE String:voiceMessages

Query directive to request all message information of an addresssVioceMail Box.

QUERY_ACCOUNT String:

AccountName

Unambiguous name of an account

Announcement Name:Name of an account; max. 32 characters

QUERY_NUMBER String:

NumberUnambiguous telephone number or SIP address

Number:Number or SIP address; max. 50 characters

MESSAGE_ID

String:

ID

Unambiguous identification of a message

ID:Arbitrary string

MESSAGE_DATE_TIME

Date/Time:

MessageRecorded

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

MESSAGE_PLAYE

D

Date/Time:

never

MessagePlayed

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 atdate/time.

Text-Format:


Example: 2013-04-14T10:29:00

MESSAGE_DURATION

Number:

Duration

Duration of an announcement

Duration:Duration in milliseconds

MESSAGE_NUMBER

String:

NumberTelephony number of the calling side.

Number:Arbitrary string

MESSAGE_NAME

String:

Name

Name of the calling side who is included in the SIP-Header "From".

Name:Arbitrary string

MESSAGE_SAVED

Boolean:

true false

Indicates whether the message was marked by the subscriber for alonger retention.


51/52




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 the-se data into the desired form and representation.

DAML-Query:

https://:8447/dataaccesscenter/daml? query=QUERY_CALLS&account=QUERY_ACCOUNT&number=QUERY_NUMBER&entries=QUERY_ENTRY

Example:

https://dac.provider.com:8447/dataaccesscenter/daml? query=calls&account=aarenet21&number=21&entries=10

DAML-Response:

CALL_STARTCALL_DURATIONCALL_DIRECTION

CALL_PEER_NUMBERCALL_CHARGE

. . .

Example:

2013-05-24T14:55:1312527out

01234567890.10

2013-05-24T10:20:380in0987654321


QUERY_CALLS String:calls

Query directive to request the last connections and connection at-tempts of a telephone number.


52/52



QUERY_ACCOUNT String:

AccountName

Unambiguous name of an account

Announcement Name:Name of an account; max. 32 characters

QUERY_NUMBER String: Number

Unambiguous telephone number or SIP address

Number:Number or SIP address; max. 50 characters

QUERY_ENTRY Number:

Number ofCalls

Number of the requested connections and connection attempts.

Number of Calls:>= 0

CALL_START

Date/Time:

Call StartDate/time of the calls start.

Call Start:

The call started at date/time

Text-Format:


Example: 2013-04-14T10:29:00

CALL_DURATION

Number:

Duration

Duration of the connection

Duration:Duration in millisecondsIf the duration is 0 then it was a call at-

tempt.CALL_DIRECTION

Selection List:

in out

Indicates whether it is an incoming or outgoing connection.

in:Incoming connection

out:Outgoing connection

CALL_PEER_NUMBER

String:

Peer Num-ber

Shows the telephone number of the other participant of the connec-tion.

CALL_DIRECTION: inAt incoming connections this is the number of

the calling side (CLIP)CALL_DIRECTION: out

Bei abgehende Verbindung ist dies die gewhl-te Nummer.

CALL_CHARGE

Decimal Num-ber:

Charge

Charge of an outgoing connection.

Charge:ChargeValue Range: >= 0.00

Manual Voip-switch v54 Extract Operation Daml e20

Documents