Difference between revisions of "Operation daml"
m (→DAML-Query: "List of All Account Names" {{Help_Status | | }}) |
|||
(17 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
{{DISPLAYTITLE: Operational Configuration via DataAccessCenter }} | {{DISPLAYTITLE: Operational Configuration via DataAccessCenter }} | ||
− | + | {{PAGE_HEADER}} | |
− | + | {{Page_Menu_List_Help_Operation}} | |
− | + | <!-- FOOTER LEFT "© Aarenet AG 2017" --> <!-- PDF Creation Directive ------------------------------> | |
− | |||
− | |||
− | |||
− | |||
− | }} | ||
− | <!-- | ||
− | <!-- | + | {{Page_Introduction_Title}} |
+ | <!-- Transclusion : Intro Begin ------------------------------------------------------------------><section begin=intro /> | ||
The Aarenet VoIP Switch Administrator, Operator and 3rd party CRM programmer find here: | The Aarenet VoIP Switch Administrator, Operator and 3rd party CRM programmer find here: | ||
:* How to access the DataAccessCenter | :* How to access the DataAccessCenter | ||
:* The description of the Data Access Markup Language DAML protocol | :* The description of the Data Access Markup Language DAML protocol | ||
− | <!-- | + | <!-- Transclusion : Intro End --------------------------------------------------------------------><section end=intro /> |
− | __TOC__ <!-- Table of Contents | + | __TOC__ <!-- Table of Contents --------------------------------------------------------------------> |
− | + | <!-- PAGE BREAK --> <!-- PDF Creation Directive ---------------------------------------------------> | |
+ | <!-- Transclusion : Article Begin -----------------------------------------------------------------><section begin=article /> | ||
+ | {{ToTop | OperationDamlOverview }} <!--------------------------------------------------------------> | ||
= Overview of the DataAccessCenter {{Help_Status | |   }} = | = Overview of the DataAccessCenter {{Help_Status | |   }} = | ||
Line 75: | Line 72: | ||
− | <!---------------------------------------------------------------------------------------------------------------> | + | <!-- PAGE BREAK --> <!-- PDF Creation Directive ---------------------------------------------------> |
− | + | {{ToTop | OperationDamlHowto}} <!------------------------------------------------------------------> | |
= How To Start with the DataAccessCenter {{Help_Status | | }} = | = How To Start with the DataAccessCenter {{Help_Status | | }} = | ||
Line 82: | Line 79: | ||
− | <! | + | {{ToTop | OperationDamlHowtoGetInTouch}} <!--------------------------------------------------------> |
− | |||
<div id="OperationDamlHowtoScriptResidential"></div> | <div id="OperationDamlHowtoScriptResidential"></div> | ||
<div id="OperationDamlHowtoScriptSipTrunk"></div> | <div id="OperationDamlHowtoScriptSipTrunk"></div> | ||
Line 96: | Line 92: | ||
#: | #: | ||
# Download the executable DAML Test Scripts: | # Download the executable DAML Test Scripts: | ||
− | #: {{File_Download_Link | | + | #: {{File_Download_Link | daml_residential_scripts.zip | zip | "Download DAML Test Scripts for a Residential User" }} |
+ | <!-- | ||
#: {{File_Download_Link | daml_siptrunk_scripts_v10.zip | zip | "Download DAML Test Scripts for a SIP Trunk" }} | #: {{File_Download_Link | daml_siptrunk_scripts_v10.zip | zip | "Download DAML Test Scripts for a SIP Trunk" }} | ||
#: {{File_Download_Link | daml_vpbx_scripts_v10.zip | zip | "Download DAML Test Scripts for a vPBX" }} | #: {{File_Download_Link | daml_vpbx_scripts_v10.zip | zip | "Download DAML Test Scripts for a vPBX" }} | ||
+ | --> | ||
#: | #: | ||
# Play around with the DAML Test Scripts for getting a feeling how it works | # Play around with the DAML Test Scripts for getting a feeling how it works | ||
Line 107: | Line 105: | ||
− | <! | + | {{ToTop | OperationDamlHowtoCrmImplementation}} <!-------------------------------------------------> |
− | |||
== CRM Implementation {{Help_Status | | }} == | == CRM Implementation {{Help_Status | | }} == | ||
Line 144: | Line 141: | ||
− | <! | + | {{ToTop | OperationDamlHowtoBestPractices}} <!-----------------------------------------------------> |
− | |||
== Best Practices with DAML Parameters {{Help_Status | | }} == | == Best Practices with DAML Parameters {{Help_Status | | }} == | ||
Line 151: | Line 147: | ||
− | <! | + | {{ToTop | OperationDamlHowtoBestPracticesNotDocParam}} <!------------------------------------------> |
− | |||
== Not Documented DAML Parameter {{Help_Status | | }} == | == Not Documented DAML Parameter {{Help_Status | | }} == | ||
Line 170: | Line 165: | ||
− | <! | + | {{ToTop | OperationDamlHowtoBestPracticesNotDocParam}} <!------------------------------------------> |
− | |||
== Usage of Diverse DAML Parameter {{Help_Status | | Preliminary }} == | == Usage of Diverse DAML Parameter {{Help_Status | | Preliminary }} == | ||
Line 180: | Line 174: | ||
− | <!--------------------------------------------------------- | + | <!-- PAGE BREAK --> <!-- PDF Creation Directive ---------------------------------------------------> |
− | + | {{ToTop | OperationDamlOverviewProvisioningDac}} <!------------------------------------------------> | |
= Provisioning the DataAccessCenter for CRM Application Access {{Help_Status | | }} = | = Provisioning the DataAccessCenter for CRM Application Access {{Help_Status | | }} = | ||
Line 242: | Line 236: | ||
− | + | <!-- PAGE BREAK --> <!-- PDF Creation Directive ---------------------------------------------------> | |
− | <!--------------------------------------------------------- | + | {{ToTop | OperationDamlOverviewIpAccessDac}} <!----------------------------------------------------> |
− | |||
= Access via IP Network to the DataAccessCenter {{Help_Status | | }} = | = Access via IP Network to the DataAccessCenter {{Help_Status | | }} = | ||
Line 255: | Line 248: | ||
− | <!---------------------------------------------------------------------------------------------------------------> | + | <!-- PAGE BREAK --> <!-- PDF Creation Directive ---------------------------------------------------> |
− | + | {{ToTop | OperationDamlExchange}} <!---------------------------------------------------------------> | |
= DAML-Document Exchange via HTTP/HTTPS {{Help_Status | | }} = | = DAML-Document Exchange via HTTP/HTTPS {{Help_Status | | }} = | ||
Line 262: | Line 255: | ||
− | <! | + | {{ToTop | OperationDamlExchangeDigest}} <!---------------------------------------------------------> |
− | |||
== HTTP DIGEST Authentication {{Help_Status | | }} == | == HTTP DIGEST Authentication {{Help_Status | | }} == | ||
Line 271: | Line 263: | ||
− | <! | + | {{ToTop | OperationDamlExchangeHttpPost}} <!-------------------------------------------------------> |
− | |||
== HTTP POST Data Exchange {{Help_Status | | }} == | == HTTP POST Data Exchange {{Help_Status | | }} == | ||
Line 301: | Line 292: | ||
− | <! | + | {{ToTop | OperationDamlExchangeHttpGet}} <!--------------------------------------------------------> |
− | |||
== HTTP GET Data Exchange {{Help_Status | | }} == | == HTTP GET Data Exchange {{Help_Status | | }} == | ||
Line 318: | Line 308: | ||
− | <! | + | {{ToTop | OperationDamlExchangeHttpResponse}} <!---------------------------------------------------> |
− | |||
== HTTP RESPONSE (Execution and Error Codes) {{Help_Status | | }} == | == HTTP RESPONSE (Execution and Error Codes) {{Help_Status | | }} == | ||
Line 344: | Line 333: | ||
− | <!---------------------------------------------------------------------------------------------------------------> | + | <!-- PAGE BREAK --> <!-- PDF Creation Directive ---------------------------------------------------> |
− | + | {{ToTop | OperationDamlAcc}} <!--------------------------------------------------------------------> | |
= DAML-Document "Account" for Treating Customer Accounts {{Help_Status | | }} = | = DAML-Document "Account" for Treating Customer Accounts {{Help_Status | | }} = | ||
Line 362: | Line 351: | ||
− | <! | + | {{ToTop | OperationDamlAccXMLContainer}} <!--------------------------------------------------------> |
− | |||
== DAML XML-Container for "Account" {{Help_Status | | }} == | == DAML XML-Container for "Account" {{Help_Status | | }} == | ||
Line 391: | Line 379: | ||
− | <! | + | {{ToTop | OperationDamlAccTreat}} <!---------------------------------------------------------------> |
− | |||
== DAML-Document for Create, Delete, Read and Write an "Account" {{Help_Status | | }} == | == DAML-Document for Create, Delete, Read and Write an "Account" {{Help_Status | | }} == | ||
Line 398: | Line 385: | ||
− | <! | + | {{ToTop | OperationDamlAccCreate}} <!--------------------------------------------------------------> |
− | |||
=== Create an "Account" {{Help_Status | | }} === | === Create an "Account" {{Help_Status | | }} === | ||
Line 430: | Line 416: | ||
− | <! | + | {{ToTop | OperationDamlAccDelete}} <!--------------------------------------------------------------> |
− | |||
=== Delete an "Account" {{Help_Status | | }} === | === Delete an "Account" {{Help_Status | | }} === | ||
Line 451: | Line 436: | ||
− | + | {{ToTop | OperationDamlAccRead}} <!----------------------------------------------------------------> | |
− | <! | ||
− | |||
=== Read an "Account" {{Help_Status | | }} === | === Read an "Account" {{Help_Status | | }} === | ||
Line 472: | Line 455: | ||
− | + | {{ToTop | OperationDamlAccWrite}} <!---------------------------------------------------------------> | |
− | <! | ||
− | |||
=== Modify, Add or Delete an Account's Parameter or Feature {{Help_Status | | }} === | === Modify, Add or Delete an Account's Parameter or Feature {{Help_Status | | }} === | ||
Line 560: | Line 541: | ||
− | <! | + | {{ToTop | OperationDamlAccParam}} <!---------------------------------------------------------------> |
− | |||
== "Account" Parameter Configuration {{Help_Status | | }} == | == "Account" Parameter Configuration {{Help_Status | | }} == | ||
Line 567: | Line 547: | ||
− | <! | + | {{ToTop | OperationDamlAccParamAccBasic}} <!-------------------------------------------------------> |
− | |||
=== "Account" Basic Parameter {{Help_Status | | }} === | === "Account" Basic Parameter {{Help_Status | | }} === | ||
Line 594: | Line 573: | ||
− | {{ | + | {{Xml_Table_Start}} |
{{Xml_Table_Header | {{Xml_Table_Header | ||
| header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: | | header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: | ||
Line 718: | Line 697: | ||
− | <! | + | {{ToTop | OperationDamlAccParamAccRouting}} <!-----------------------------------------------------> |
− | |||
=== "Account" Routing Parameter {{Help_Status | | }} === | === "Account" Routing Parameter {{Help_Status | | }} === | ||
Line 737: | Line 715: | ||
− | {{ | + | {{Xml_Table_Start}} |
{{Xml_Table_Header | {{Xml_Table_Header | ||
| header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: | | header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: | ||
Line 822: | Line 800: | ||
− | {{ | + | {{Xml_Table_Start}} |
{{Xml_Table_Header | {{Xml_Table_Header | ||
| header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: | | header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: | ||
Line 865: | Line 843: | ||
− | <! | + | {{ToTop | OperationDamlAccParamAccTopStop}} <!-----------------------------------------------------> |
− | |||
=== "Account" TopStop Parameter {{Help_Status | | }} === | === "Account" TopStop Parameter {{Help_Status | | }} === | ||
Line 901: | Line 878: | ||
− | {{ | + | {{Xml_Table_Start}} |
{{Xml_Table_Header | {{Xml_Table_Header | ||
| header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: | | header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: | ||
Line 1,242: | Line 1,219: | ||
− | {{ | + | {{Xml_Table_Start}} |
{{Xml_Table_Header | {{Xml_Table_Header | ||
| header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: | | header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: | ||
Line 1,379: | Line 1,356: | ||
− | <!---------------------------------------------------------------------------------------------------------------> | + | <!-- PAGE BREAK --> <!-- PDF Creation Directive ---------------------------------------------------> |
− | + | {{ToTop | OperationDamlAddr}} <!-------------------------------------------------------------------> | |
= DAML-Document for Treating "Address" {{Help_Status | | }} = | = DAML-Document for Treating "Address" {{Help_Status | | }} = | ||
Line 1,396: | Line 1,373: | ||
− | <! | + | {{ToTop | OperationDamlAddrXMLContainer}}<!--------------------------------------------------------> |
− | + | == DAML XML-Container for "Address" {{Help_Status | | }} == | |
− | == DAML XML-Container for "Address" | ||
All XML fields are listed in the address container: | All XML fields are listed in the address container: | ||
Line 1,426: | Line 1,402: | ||
− | <! | + | {{ToTop | OperationDamlAddrTreat}} <!--------------------------------------------------------------> |
− | |||
== DAML-Document for Create, Delete, Read and Write an "Address" (Telephony Number) {{Help_Status | | }} == | == DAML-Document for Create, Delete, Read and Write an "Address" (Telephony Number) {{Help_Status | | }} == | ||
Line 1,433: | Line 1,408: | ||
− | <! | + | {{ToTop | OperationDamlAddrCreate}} <!-------------------------------------------------------------> |
− | |||
=== Create an "Address" {{Help_Status | | }} === | === Create an "Address" {{Help_Status | | }} === | ||
Line 1,466: | Line 1,440: | ||
− | <! | + | {{ToTop | OperationDamlAddrDelete}} <!-------------------------------------------------------------> |
− | |||
=== Delete an "Address" {{Help_Status | | }} === | === Delete an "Address" {{Help_Status | | }} === | ||
Line 1,488: | Line 1,461: | ||
− | <! | + | {{ToTop | OperationDamlAddrRead}} <!---------------------------------------------------------------> |
− | |||
=== Read an "Address" {{Help_Status | | }} === | === Read an "Address" {{Help_Status | | }} === | ||
Line 1,509: | Line 1,481: | ||
− | <! | + | {{ToTop | OperationDamlAddrWrite}} <!--------------------------------------------------------------> |
− | |||
=== Modify, Add or Delete an Address's Parameter or Feature {{Help_Status | | }} === | === Modify, Add or Delete an Address's Parameter or Feature {{Help_Status | | }} === | ||
Line 1,587: | Line 1,558: | ||
− | <! | + | {{ToTop | OperationDamlAddrParam}} <!--------------------------------------------------------------> |
− | |||
== "Address" Parameter Configuration {{Help_Status | | }} == | == "Address" Parameter Configuration {{Help_Status | | }} == | ||
Line 1,687: | Line 1,657: | ||
− | <! | + | {{ToTop | OperationDamlAddrParamSipAddrMain}} <!---------------------------------------------------> |
− | |||
=== "Address" SIP Address Main Parameter {{Help_Status | | }} === | === "Address" SIP Address Main Parameter {{Help_Status | | }} === | ||
− | {{ | + | {{Xml_Table_Start}} |
{{Xml_Table_Header | {{Xml_Table_Header | ||
| header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: | | header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: | ||
Line 1,752: | Line 1,721: | ||
− | <! | + | {{ToTop | OperationDamlAddrParamSipAddrRegistration}} <!-------------------------------------------> |
− | |||
=== "Address" SIP Address Registration Parameter {{Help_Status | | }} === | === "Address" SIP Address Registration Parameter {{Help_Status | | }} === | ||
− | {{ | + | {{Xml_Table_Start}} |
{{Xml_Table_Header | {{Xml_Table_Header | ||
| header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: | | header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: | ||
Line 1,875: | Line 1,843: | ||
− | <! | + | {{ToTop | OperationDamlAddrParamSipAddrAttributesDirectives}} <!-----------------------------------> |
− | |||
=== "Address" Number Attributes & Directives {{Help_Status | | }} === | === "Address" Number Attributes & Directives {{Help_Status | | }} === | ||
− | {{ | + | {{Xml_Table_Start}} |
{{Xml_Table_Header | {{Xml_Table_Header | ||
| header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: | | header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: | ||
Line 2,101: | Line 2,068: | ||
− | <! | + | {{ToTop | OperationDamlAddrParamFeatureClip}} <!---------------------------------------------------> |
− | |||
=== "Address" Feature: Outgoing Number Presentation {{Help_Status | | }} === | === "Address" Feature: Outgoing Number Presentation {{Help_Status | | }} === | ||
− | {{ | + | {{Xml_Table_Start}} |
{{Xml_Table_Header | {{Xml_Table_Header | ||
| header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: | | header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: | ||
Line 2,180: | Line 2,146: | ||
− | <! | + | {{ToTop | OperationDamlAddrParamFeatureVm}} <!-----------------------------------------------------> |
− | |||
=== "Address" Feature: VoiceMail Box {{Help_Status | | }} === | === "Address" Feature: VoiceMail Box {{Help_Status | | }} === | ||
− | {{ | + | {{Xml_Table_Start}} |
{{Xml_Table_Header | {{Xml_Table_Header | ||
| header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: | | header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: | ||
Line 2,403: | Line 2,368: | ||
− | <! | + | {{ToTop | OperationDamlAddrParamFeatureCf}} <!-----------------------------------------------------> |
− | |||
=== "Address" Feature: Call Forwarding {{Help_Status | | }} === | === "Address" Feature: Call Forwarding {{Help_Status | | }} === | ||
Line 2,411: | Line 2,375: | ||
− | {{ | + | {{Xml_Table_Start}} |
{{Xml_Table_Header | {{Xml_Table_Header | ||
| header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: | | header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: | ||
Line 2,512: | Line 2,476: | ||
− | <! | + | {{ToTop | OperationDamlAddrParamFeaturesDiv}} <!---------------------------------------------------> |
− | |||
=== "Address" Feature: Diverse {{Help_Status | | }} === | === "Address" Feature: Diverse {{Help_Status | | }} === | ||
− | {{ | + | {{Xml_Table_Start}} |
{{Xml_Table_Header | {{Xml_Table_Header | ||
| header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: | | header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: | ||
Line 2,635: | Line 2,598: | ||
− | <! | + | {{ToTop | OperationDamlAddrParamFeatureVpbx}} <!---------------------------------------------------> |
− | |||
=== "Address" Feature: Group {{Help_Status | | }} === | === "Address" Feature: Group {{Help_Status | | }} === | ||
Line 2,643: | Line 2,605: | ||
− | {{ | + | {{Xml_Table_Start}} |
{{Xml_Table_Header | {{Xml_Table_Header | ||
| header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: | | header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: | ||
Line 2,736: | Line 2,698: | ||
− | <! | + | {{ToTop | OperationDamlAddrParamFeatureAcAccess}} <!-----------------------------------------------> |
− | |||
=== "Address" Feature: AdminCenter Access {{Help_Status | | }} === | === "Address" Feature: AdminCenter Access {{Help_Status | | }} === | ||
− | {{ | + | {{Xml_Table_Start}} |
{{Xml_Table_Header | {{Xml_Table_Header | ||
| header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: | | header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: | ||
Line 2,809: | Line 2,770: | ||
− | <!---------------------------------------------------------------------------------------------------------------> | + | <!-- PAGE BREAK --> <!-- PDF Creation Directive ---------------------------------------------------> |
− | + | {{ToTop | OperationDamlQuery}} <!------------------------------------------------------------------> | |
= DAML-Query {{Help_Status | | }} = | = DAML-Query {{Help_Status | | }} = | ||
Line 2,816: | Line 2,777: | ||
− | <! | + | {{ToTop | OperationDamlQueryAccountNames}} <!------------------------------------------------------> |
− | |||
== DAML-Query: "List of All Account Names" {{Help_Status | | }} == | == DAML-Query: "List of All Account Names" {{Help_Status | | }} == | ||
Line 2,831: | Line 2,791: | ||
'''DAML-Query Example''':<br> | '''DAML-Query Example''':<br> | ||
{{ SW_Code | | | {{ SW_Code | | | ||
− | <nowiki>https://</nowiki><IP_ADDRESS>:8447/dataaccesscenter/daml?query=''' | + | <nowiki>https://</nowiki><IP_ADDRESS>:8447/dataaccesscenter/daml?query='''accounts''' |
}} | }} | ||
Line 2,850: | Line 2,810: | ||
<!---------------------------------------------------------------------------------------------------------------> | <!---------------------------------------------------------------------------------------------------------------> | ||
{{ToTop | OperationDamlQueryLastConnections}} | {{ToTop | OperationDamlQueryLastConnections}} | ||
+ | |||
== DAML-Query: "List of the n Last Connections of a Telephone Number" {{Help_Status | | }} == | == DAML-Query: "List of the n Last Connections of a Telephone Number" {{Help_Status | | }} == | ||
Line 2,918: | Line 2,879: | ||
'''Parameters:''' | '''Parameters:''' | ||
− | {{ | + | {{Xml_Table_Start}} |
{{Xml_Table_Header | {{Xml_Table_Header | ||
| header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: | | header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: | ||
Line 3,012: | Line 2,973: | ||
− | <! | + | {{ToTop | OperationDamlQueryRuleset}} <!-----------------------------------------------------------> |
− | |||
== DAML-Query: "List of all Ruleset Names" {{Help_Status | | }} == | == DAML-Query: "List of all Ruleset Names" {{Help_Status | | }} == | ||
Line 3,045: | Line 3,005: | ||
− | <! | + | {{ToTop | OperationDamlQueryEmergencyLocation}} <!-------------------------------------------------> |
− | |||
== DAML-Query: "List of all Emergency Locations" {{Help_Status | | }} == | == DAML-Query: "List of all Emergency Locations" {{Help_Status | | }} == | ||
Line 3,075: | Line 3,034: | ||
− | <! | + | {{ToTop | OperationDamlQueryAnnouncementName}} <!--------------------------------------------------> |
− | |||
== DAML-Query: "List of All Announcement Names of a Telephone Number" {{Help_Status | | }} == | == DAML-Query: "List of All Announcement Names of a Telephone Number" {{Help_Status | | }} == | ||
Line 3,131: | Line 3,089: | ||
'''Parameters:''' | '''Parameters:''' | ||
− | {{ | + | {{Xml_Table_Start}} |
{{Xml_Table_Header | {{Xml_Table_Header | ||
| header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: | | header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: | ||
Line 3,184: | Line 3,142: | ||
− | <! | + | {{ToTop | OperationDamlQueryMessageName}} <!-------------------------------------------------------> |
− | |||
== DAML-Query: "List of all VoiceMail Messages of a Telephone Number" {{Help_Status | | }} == | == DAML-Query: "List of all VoiceMail Messages of a Telephone Number" {{Help_Status | | }} == | ||
Line 3,252: | Line 3,209: | ||
'''Parameters:''' | '''Parameters:''' | ||
− | {{ | + | {{Xml_Table_Start}} |
{{Xml_Table_Header | {{Xml_Table_Header | ||
| header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: | | header1= Variable Name: | header2= Format: | header3= Range: | header4= Default: | header5= Description: | header6= Version: | ||
Line 3,369: | Line 3,326: | ||
− | <!------ | + | <!-- PAGE BREAK --> <!-- PDF Creation Directive ---------------------------------------------------> |
{{ToTop | OperationDamlExample}} | {{ToTop | OperationDamlExample}} | ||
= DAML-Document Examples {{Help_Status | | }} = | = DAML-Document Examples {{Help_Status | | }} = | ||
Line 3,376: | Line 3,333: | ||
− | <! | + | {{ToTop | OperationDamlExampleCreateAccResidential}} <!--------------------------------------------> |
− | |||
== Create a "Residential Account" with 1 Public Number {{Help_Status | | }} == | == Create a "Residential Account" with 1 Public Number {{Help_Status | | }} == | ||
Line 3,452: | Line 3,408: | ||
− | <! | + | {{ToTop | OperationDamlExampleCreateAccSipTrunk}} <!-----------------------------------------------> |
− | |||
== Create a "SIP Trunk" Account with 100 Public Numbers for ISDN PBX behind SIP CPE {{Help_Status | | }} == | == Create a "SIP Trunk" Account with 100 Public Numbers for ISDN PBX behind SIP CPE {{Help_Status | | }} == | ||
Line 3,559: | Line 3,514: | ||
− | <! | + | {{ToTop | OperationDamlExampleCreateAccVpbx}} <!---------------------------------------------------> |
− | |||
== Create a vPBX Account with 5 Public Numbers {{Help_Status | | }} == | == Create a vPBX Account with 5 Public Numbers {{Help_Status | | }} == | ||
Line 3,700: | Line 3,654: | ||
+ | <!-- Transclusion : Article End -------------------------------------------------------------------><section end=article /> | ||
{{ToTop}} | {{ToTop}} | ||
− | |||
{{PAGE_FOOTER}} | {{PAGE_FOOTER}} | ||
{{Page_Version |version=3.0 |author=Aarenet |date=May 2017}} | {{Page_Version |version=3.0 |author=Aarenet |date=May 2017}} |
Latest revision as of 07:50, 13 February 2019
Note | The features and/or parameters listed in this article may not be available from your telephone service provider. |
|
|
|
Introduction
The Aarenet VoIP Switch Administrator, Operator and 3rd party CRM programmer find here:
- How to access the DataAccessCenter
- The description of the Data Access Markup Language DAML protocol
Contents
- 1 Overview of the DataAccessCenter
- 2 How To Start with the DataAccessCenter
- 3 Provisioning the DataAccessCenter for CRM Application Access
- 4 Access via IP Network to the DataAccessCenter
- 5 DAML-Document Exchange via HTTP/HTTPS
- 6 DAML-Document "Account" for Treating Customer Accounts
- 7 DAML-Document for Treating "Address"
- 7.1 DAML XML-Container for "Address"
- 7.2 DAML-Document for Create, Delete, Read and Write an "Address" (Telephony Number)
- 7.3 "Address" Parameter Configuration
- 7.3.1 "Address" SIP Address Main Parameter
- 7.3.2 "Address" SIP Address Registration Parameter
- 7.3.3 "Address" Number Attributes & Directives
- 7.3.4 "Address" Feature: Outgoing Number Presentation
- 7.3.5 "Address" Feature: VoiceMail Box
- 7.3.6 "Address" Feature: Call Forwarding
- 7.3.7 "Address" Feature: Diverse
- 7.3.8 "Address" Feature: Group
- 7.3.9 "Address" Feature: AdminCenter Access
- 8 DAML-Query
- 8.1 DAML-Query: "List of All Account Names"
- 8.2 DAML-Query: "List of the n Last Connections of a Telephone Number"
- 8.3 DAML-Query: "List of all Ruleset Names"
- 8.4 DAML-Query: "List of all Emergency Locations"
- 8.5 DAML-Query: "List of All Announcement Names of a Telephone Number"
- 8.6 DAML-Query: "List of all VoiceMail Messages of a Telephone Number"
- 9 DAML-Document Examples
Overview of the DataAccessCenter
The DataAccessCenter offers a HTTP/HTTPS based interface which allows 3rd-party applications to access the operational data of the Aarenet VoIP Switch. Therefore it is predestined for the configuration of the Aarenet VoIP Switch via a CRM system of the provider.
The DataAccessCenter offers with the DAML interface (Data Access Markup Language DAML) an API and protocol to configure operational data of the Aarenet VoIP Switch.
The following features distinguish the DataAccessCenter:
- The DAML interface allows the configuration of all customer 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 checks and formalizing.
- 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.
DAML allows to configure the following operative parameters:
- "Account":
- For the creation and treatment of customers account
- "Address"
- For the creation and treatment of public and internal phone numbers in customer accounts and vPBX
- etc.
- "Account":
DAML allows queries of the configured parameters or other data:
- Account:
- Query of all account names
- Connection list:
- Query of the CDR of the last N connections of a phone number
- etc.
- Account:
The DAML protocol bases on XML formatted documents (Introduction to XML):
- 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 Aarenet VoIP Switch is considered.
The DAML protocol can be customized with XLST script. Possibilities are:
- Make the interface stable
- Define defaults
- Do some rough checks
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 DAM-documents. Vice versa outgoing XML documents can be reworked with defined XLST commands and the result sent to the CRM application.
Note |
XLST conversions must be developed and checked in corporation with the Aarenet engineering. |
How To Start with the DataAccessCenter
Get in Touch with DAML
- Get an DataAccessCenter account on:
- Test Aarenet VoIP Switch
- Pre-productive Aarenet VoIP Switch
- Get IP access to the DataAccessCenter of this Aarenet VoIP Switch
- Download the executable DAML Test Scripts:
- Play around with the DAML Test Scripts for getting a feeling how it works
- Do configuration in the ConfigCenter and read it out with DAML
CRM Implementation
- Implement the DataAccessCenter access and HTTP-Digest Authentication
- For a starter implement HTTP-Get for a query
- Basic read
- Queries for, e.g.:
- Ruleset
- Implement the basic HTTP-Post data exchange for "write, "read", "delete"
- Implement the "Account Treating" :
- Basic create, read, delete
- Parameter add, modify, delete for:
- account
- tenant
- info
- SIP credentials
- etc.
- Implement the "Address Treating" :
- Basic create, read, delete
- Parameter add, modify, delete for:
- number
- etc.
- Implement the basic HTTP-Get data exchange for data queries :
- Queries for:
- Ruleset
- etc.
- Queries for:
Best Practices with DAML Parameters
Not Documented DAML Parameter
The DAML interface development evolves continuously. This documentation may lag behind the development of features and parameters
If upon a DAML read out such a DAML parameter is discovered and its naming points to a feature of interest then:
- Login into the ConfigCenter
- Search for a matching parameter name and study its possible configurations
- Modify this possibly matching parameter
- Make e new read out via DAML and compare it with the first read out. See if it matches your expectataions.
If this process is not successfull then contact the "VoIP Switch Supplier Support"
Usage of Diverse DAML Parameter
- Use for the "Account Name" the CRM "Customer ID"
- Write in the "Account Info" information that a supporter helps to find a customer, without consulting the CRM for its ID
Provisioning the DataAccessCenter for CRM Application Access
To grant an external CRM application access to the operational data via DataAccessCenter the following configuration at DataAccessCenter component level must be set up:
- HTTP / HTTPS- Authorization-Credentials:
- Defines the username and password the CRM application has to use for accessing the DataAccessCenter
- Group-based Authorization:
- Defines to which groups the CRM application has access.
- Authorization for the use of to DAML-Documents and DAML-Queries:
- Defines which DAML-Documents and DAML-Queries the CRM application is allowed to use. It is possible to specifiy the rights to "create", "read", "write", "delete".
- 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.
Note |
The configuration of the DataAccessCenter component has to be accomplished in close collaboration between the provider and the Aarenet project manager. |
Access via IP Network to the DataAccessCenter
For the DataAccessCenter the URL must have the following form:
DAML Access:
- https://</nowiki><IP_ADDRESS>:8447/dataaccesscenter
DAML-Document Exchange via HTTP/HTTPS
HTTP DIGEST Authentication
Prior the transfer of DAML-documents a CRM application has to apply the HTTP-Digest authentication in order to get access to the DataAccessCenter interface.
HTTP POST Data Exchange
The CRM 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 within the URL.
The CRM must transfer with HTTP POST a DAML-document with the following directives:
write:
- The given data will be written. This directive creates or modifies instances.
read:
- The given data will be read and delivered.
delete:
- The given data will be deleted.
DAML-Document Example:
<daml command="read">
</daml> |
HTTP GET Data Exchange
DAMl Queries 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.
For the DataAccessCenter the URL must have the following form:
DAML-Query Example:
- https://</nowiki><IP_ADDRESS>:8447/dataaccesscenter/daml?query=DAML_QUERY_NAME
HTTP RESPONSE (Execution and Error Codes)
After the data were successfully transmitted and treated, the response code "200 OK" is returned.
Note |
"200 OK" means that the request could be treated by the DataAccessCenter but not that the outcome is correct.
|
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.
DAML-Document "Account" for Treating Customer Accounts
This DAML-document allows the treatment of accounts, its features and parameters:
The SIP addresses (phone numbers) which are associated with the account are treated with the DAML-Document for Treating "Address".
DAML XML-Container for "Account"
All XML fields are listed in the account container:
- The XML field <account> defines the XLS account container
- Mandatory is the XML field <accountName> which identifies the account unambiguously.
- The order of the XML fields is arbitrary
Account-Container for "Account":
|
DAML-Document for Create, Delete, Read and Write an "Account"
Create an "Account"
By creating an account all its features and parameters may be configured too.
DAML-Document:
<daml command="write">
</daml> |
Examples see:
Delete an "Account"
By deleting an account all its:
- Feature and parameter configurations will be deleted too
- Associated addresses and their configurations will be deleted too
DAML-Document Example:
<daml command="delete">
</daml> |
Read an "Account"
By reading an account all its:
- Feature and parameter configurations will be read
DAML-Document Example:
<daml command="read">
</daml> |
Modify, Add or Delete an Account's Parameter or Feature
By writing to an existing account its parameters can be:
- Modified
- Added
- Deleted
Warning |
Make sure that you write the account name and/or XML names correctly. Else the result may be unpredictable even when the response is 200 OK! For details see chapter "HTTP RESPONSE" |
Modifing:
By re-writing an account's parameter its configuration will be changed:
- The feature and/or parameter configurations will be modified
- Special modifying procedures are required for:
Adding:
By adding a parameter its configuration will be created:
- The feature and/or parameter configurations will be created
Deleting:
By writing an "empty" value to a parameter:
- The feature and/or parameter will be deleted
- Special deleting procedures are required for:
DAML-Document Example "Modify a parameter":
<daml command="write">
</daml> |
DAML-Document Example "Add a parameter":
<daml command="write">
</daml> |
DAML-Document Example "Delete a parameter ":
<daml command="write">
<!-- Variant 1: -->
<!-- Variant 2: -->
</daml> |
"Account" Parameter Configuration
"Account" Basic Parameter
DAML Authorization needed for:
grantAccessToAccounts <USERNAME> read/write |
List of Parameters:
|
Variable: | Format: | Range: | Default: | Description: | Version: | |
1 | <accountName> ACC_NAME </accountName> |
String | max. 32 characters | none | Mandatory configuration! Assigns the unambiguous name of the account |
5.2 |
2 | <tenant> ACC_TENANT </tenant> |
String | max. 128 characters | none | Assigns the tenant of the account
Note: |
5.2 |
3 | <info> ACC_INFO </info> |
String | max. 128 characters | none | Any information | 5.2 |
4 | <username> ACC_SIP_USERNAME </username> |
String | max. 32 characters | none | Mandatory configuration! Assigns the unambiguous SIP user name of the account Note: |
5.2 |
5 | <password> ACC_SIP_PASSWORD </password> |
String | max. 32 characters | none | Mandatory configuration! Assigns the SIP password of the account Note: |
5.2 |
6 | <maxChannels> ACC_CHANNEL </maxChannels> |
String | Empty or |
empty | Determines how many concurrent connections are possible for this account.
Value Range:
|
5.2 |
7 | <emergencyLocation> ACC_LOCATION </emergencyLocation> |
String | empty or defined emergency location; max. 64 characters | empty | Assigns one Emergency Location to the account.
Value Range:
The available locations can be requested with DAML-Query: "List of all Emergency Locations" |
5.2 |
"Account" Routing Parameter
DAML Authorization needed for:
grantAccessToAccounts <USERNAME> read/write |
List of Parameters:
|
Variable: | Format: | Range: | Default: | Description: | Version: | |
1 | <routingTable> ACC_ROUTING_TABLE </routingTable> |
String | empty or defined Routing Table Name; max. 45 characters | empty | Assigns one Routing Table to the account
Value Range:
|
5.2 |
2 | <ruleset> ACC_RULESET </ruleset> |
String | defined Ruleset Name; max. 128 characters | none | Assigns none or n Rulesets to the account
Value Range:
|
5.2 |
Note |
Remarks for modifying or deleting of Ruleset:
|
"Account" Rating Parameter
DAML Authorization needed for:
grantAccessToAccounts <USERNAME> read/write |
List of Parameters:
|
Variable: | Format: | Range: | Default: | Description: | Version: | |
1 | <pricelist> ACC_PRICELIST </pricelist> |
String | empty or defined Pricelist Name; max. 32 characters | empty | A configured Pricelist Name
Value Range:
|
5.2 |
2 | <sendAoc> ACC_AOC </sendAoc> |
String | Selection:
|
false | Activate sending advice of charge AOC to all addresses of the account. | 5.2 |
"Account" TopStop Parameter
DAML Authorization needed for:
grantAccessToAccounts <USERNAME> read/write |
List of Parameters:
|
Variable: | Format: | Range: | Default: | Description: | Version: | |
1 | <type> TOPSTOP_OWNER </type> |
String | Selection:
|
SYS | Assigns with which user role a TopStop was created. This defines also for which role the TopStop is visible.
SYS:
ACC:
ADD:
|
5.2 |
2 | <valueMax> TOPSTOP_MAX </valueMax> |
Number | Empty or |
Empty | Assigns the charging limit per month for the account. It may not be exceeded by the charging sum of all connections of this account.
Empty:
|
5.2 |
3 | <monthlyReset> TOPSTOP_RESET </monthlyReset> |
String | Selection:
|
true | Assigns if the monthly maximum limit is reset at the starting of a new month.
If set to "false" the maximum limit can be interpreted as prepaid charge. |
5.9 |
4 | <alarmLevel> TOPSTOP_ALARM_LEVEL </alarmLevel> |
Number | Empty or |
Empty | Assigns at with percentage of the monthly maximum limit a warning email is generated; e.g. 70%:
Empty:
|
5.2 |
5 | <dailyMax> TOPSTOP_DAILY_MAX </dailyMax> |
Number | Empty or |
Empty | Assigns the charging limit per day for the account. It may not be exceeded by the charging sum of all connections of this account.
Empty:
|
5.2 |
6 | <dailyReset> TOPSTOP_DAILY_RESET </dailyReset> |
String | Selection:
|
true | Assigns if the daily maximum limit is reset at the starting of a new day.
If set to "false" the maximum limit can be interpreted as prepaid charge. |
5.9 |
7 | <alarmEmail> TOPSTOP_EMAIL </alarmEmail> |
String | Empty or |
Empty | Assigns the email address which is informed when the:
Empty:
Email address:
|
5.2 |
8 | <blockAlarmSent> TOPSTOP_EMAIL_SENT </blockAlarmSent> |
String | Selection:
|
false | Read Only! Indicates that an email was sent when the daily or monthly charging limit was reached. |
5.9 |
9 | <valueCurrent> TOPSTOP_CURRENT_VALUE </valueCurrent> |
Number | >= 0.00 | Read Only! Current total charges since resetting the charging limit. |
5.9 | |
10 | mode="TOPSTOP_CURRENT_VALUE_UPDATE_MODE" | String | Selection:
|
To modify current value in <valueCurrent> the "mode" attribute is required
|
5.9 | |
11 | TOPSTOP_CURRENT_VALUE_UPDATE | Number | value >= 0.00 | Assigns the new value for the "mode=force"
Example: |
5.9 | |
12 | <dailyCurrent> TOPSTOP_CURRENT_DAILY_VALUE </dailyCurrent> |
Number | >= 0.00 | Read Only! Current total charges since resetting the charging limit. |
5.9 | |
13 | mode="TOPSTOP_CURRENT_DAILY_UPDATE_MODE" | String | Selection:
|
To modify current daily value in <dailyCurrent> the "mode" attribute is required
|
5.9 | |
14 | TOPSTOP_DAILY_VALUE_UPDATE | Number | value >= 0.00 | Assigns the new value for the "mode=force"
Example: |
5.9 |
Note |
Remarks for modifying or deleting of TopStop:
|
"Account" Advanced Parameter
DAML Authorization needed for:
grantAccessToAccounts <USERNAME> read/write |
List of Parameters:
|
Variable: | Format: | Range: | Default: | Description: | Version: | |
1 | <validAfter> ACC_VALID_AFTER </validAfter> |
String | Empty or |
Empty | Date/time of the activation of the account (and its associated addresses)
Empty:
Account Valid From:
|
5.2 |
2 | <validUntil> ACC_VALID_UNTIL </validUntil> |
String | Empty or |
Empty | Date/Time of the deactivation of the account (and its associated addresses)
Empty:
Account Valid Until:
|
5.2
|
3 | <specialArrangement> ACC_SPECIAL_ARRAGEMENT </specialArrangement> |
String
Selection:
|
{{{range}}} | false | When "Special Arrangement" is enabled then the CLIP delivered by the SIP CPE is accepted by the Aarenet VoIP Switch. The feature is also known as "CLIP no Screening".
If it is not activated then the Aarenet 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 Aarenet VoIP Switch rejects the connection setup.
Note: |
5.2 |
4 | <useMediaServer> ACC_USE_MEDIA_SERVER </useMediaServer> |
String
Selection:
|
{{{range}}} | false | This parameter is not yet described in detail. Proposed procedure see section "Not Documented DAML Parameter" | 5.2 |
5 | <sendingHoldStream> ACC_HOLD_STREAM </sendingHoldStream> |
String
Selection:
|
{{{range}}} | false | 5.2 | |
6 | <alarmOnExpiry> ACC_ALARM_ON_EXPIRY </alarmOnExpiry> |
String
Selection:
|
{{{range}}} | false | This parameter is not yet described in detail. Proposed procedure see section "Not Documented DAML Parameter" | 5.2 |
7 | <maliciousCallerId> ACC_MCID </maliciousCallerId> |
String
Selection:
|
{{{range}}} | false | This parameter is not yet described in detail. Proposed procedure see section "Not Documented DAML Parameter" | 5.2 |
DAML-Document for Treating "Address"
This DAML-document allows the treatment of a SIP address (telephone number), its features and parameters:
The account which is associated with an address is treated with the DAML-Document for Treating "Account".
DAML XML-Container for "Address"
All XML fields are listed in the address container:
- The XML field <address> defines the XLS address container
- Mandatory is the XML field <number> which identifies the address unambiguously.
- Mandatory is the XML field is <account> which identifies the associated account unambiguously
- The order of the XML fields is arbitrary
XLS Address-Container for "Address":
|
DAML-Document for Create, Delete, Read and Write an "Address" (Telephony Number)
Create an "Address"
By creating an address all its features and parameters may be configured too.
DAML-Document:
<daml command="write">
</daml> |
Examples see:
Delete an "Address"
By deleting an address all its:
- Feature and parameter configurations will be deleted too
- Associated VoiceBox messages will be deleted too
DAML-Document Example:
<daml command="delete">
</daml> |
Read an "Address"
By reading an address all its:
- Feature and parameter configurations will be read
DAML-Document Example:
<daml command="read">
</daml> |
Modify, Add or Delete an Address's Parameter or Feature
By writing to an existing address its parameters can be:
- Modified
- Added
- Deleted
Warning |
Make sure that you write the account name, number and/or XML names correctly. Else the result may be unpredictable even when the response is 200 OK! For details see HTTP RESPONSE |
Modifing:
By re-writing an account's parameter its configuration will be changed:
- The feature and/or parameter configurations will be modified
Adding:
By adding a parameter its configuration will be created:
- The feature and/or parameter configuration will be created
Deleting:
By writing an "empty" value to a parameter:
- the feature and/or parameter will be deleted
DAML-Document Example "Modify a parameter":
<daml command="write">
</daml> |
DAML-Document Example "Add a parameter":
<daml command="write">
</daml> |
DAML-Document Example "Delete a parameter ":
<daml command="write">
<!-- Variant 1: -->
<!-- Variant 2: -->
</daml> |
"Address" Parameter Configuration
DAML Authorization needed for:
grantAccessToAccounts <USERNAME> read/write |
List of Parameters:
<!-- SIP Address Main Parameterr -->
<!-- SIP Address Registration Parameter -->
<!-- Number Attributes & Directives -->
<!-- Feature: Outgoing Number Presentation -->
<!-- Feature: VoiceMail Box -->
<!-- Feature: Call Forwarding -->
<!-- Feature: Diverse -->
<!-- Feature: vPBX -->
<!-- Feature: AdminCenter Access -->
|
"Address" SIP Address Main Parameter
Variable: | Format: | Range: | Default: | Description: | Version: | |
1 | <account> ADDR_ACC_NAME </account> |
String | max. 32 characters | Empty | Mandatory configuration! Assigns the unambiguous name of the account to which the telephone number belongs |
5.2 |
2 | <number> ADDR_NUMBER </number> |
Number | max. 50 characters | false | Mandatory configuration! Assigns an unambiguous telephone number |
5.2 |
3 | <domain> ADDR_DOMAIN </domain> |
String | max. 128 characters | Empty | IP address or FQDN of the Aarenet VoIP Switch. | 5.2 |
4 | <displayName> ADDR_DISPLAY </displayName> |
String | max. 64 characters | Empty | Displayed name information at the called party side. | 5.2 |
"Address" SIP Address Registration Parameter
Variable: | Format: | Range: | Default: | Description: | Version: | |
1 | <validAfter> ADDR_VALID_AFTER </validAfter> |
String | Date/Time | Empty or |
Date/time of the activation of the telephony number (SIP address)
Empty:
Address Valid From:
|
5.2 |
2 | <validUntil> ADDR_VALID_UNTIL </validUntil> |
String | Date/Time | Empty or |
Date/time of the deactivation of the telephony number (SIP address)
Empty:
Address Valid Until:
|
5.2 |
3 | <portoutNumber> ADDR_PORTOUT_NUMBER </portoutNumber> |
String | Empty or |
Empty | Needed in Switzerland only!
When ADD_PORT_OUT_NUMBER is assigned and the number deactivated in ADD_VALID_UNTIL then the Aarenet VoIP Switch will redirect an incoming call toward this telephone number back into the PSTN. Example:
|
5.2 |
4 | <registersViaMainNumber> ADDR_REG_VIA_MAIN </registersViaMainNumber> |
String | Selection:
|
false | Assigns that this telephone number is registered via the main number of this account. | 5.2 |
5 | <singleLocation> ADDR_SINGLE_LOCATION </singleLocation> |
String | Selection:
|
false | Assigns that only one SIP CPE can register to this telephone number. | 5.10 |
6 | <balancedRouting> ADDR_REG_BALANCED </balancedRouting> |
String | Selection:
|
false | Assigns that registering SIP CPEs can provide a balancing Q value directive.
The Aarenet VoIP Switch will routing incoming calls according the balancing directive toward the SIP CPEs. |
5.2 |
"Address" Number Attributes & Directives
Variable: | Format: | Range: | Default: | Description: | Version: | |
1 | <mainNumber> ADDR_MAIN_NUMB </mainNumber> |
String | Selection:
|
false | Assigns this telephone number as the main number of this account.
→ Per account only one main number is allowed! |
5.2 |
2 | <privateNumber> ADDR_PRIVATE_NUMB </privateNumber> |
String | Selection:
|
false | Assigns this telephone number as the internal telephone number of this vPBX. | 5.2 |
3 | <baseNumber> ADDR_BASE_NUMB </baseNumber> |
String | Selection:
|
false | 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:
|
5.2 |
4 | <signalingOnly> ADDR_SIGNAL_ONLY </signalingOnly> |
String | Selection:
|
false | Assigns that this telephone number can be used only for outgoing connections. | 5.2 |
5 | <preferredNumber> ADDR_PREFERRED_NUMB </preferredNumber> |
String | Selection:
|
false | Assigns that this telephone number will always be used as CLIP for all outgoing calls from any telephone number of this account.
The number will be signaled as preferred. Either in the SIP Header "From-" or "P-Preferred". |
5.2 |
6 | <disabled> ADDR_DISABLED </disabled> |
String | Selection:
|
false | Assigns that this telephone 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 the reservation of a telephone number. |
5.2 |
7 | <blocked> ADDR_BLOCKED </blocked> |
String | Selection:
|
false | Assigns that this telephone number cannot used for outgoing connections.
Incoming connection to this telephone number are possible. |
5.2 |
8 | <queueLen> ADDR_QUEUE_LENGTH </queueLen> |
Number | Empty or |
0 | Assigns how many concurrent incoming calls toward this internal vPBX telephone number can be 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). If this this feature is working depends also from the implementation on the called SIP device! |
5.2 |
9 | <priorityCall> ADDR_PRIORITY_CALL </priorityCall> |
String | Selection:
|
false | Assigns that outgoing calls from this telephone number are handled with priority.
In extreme cases the Aarenet VoIP Switch terminates existing connections for routing a priority call toward the PSTN. |
5.2 |
10 | <endpointName> ADDR_ENPOINT_NAME </endpointName> |
String | This parameter is not yet described in detail. Proposed procedure see section "Not Documented DAML Parameter" | 6.2 | ||
11 | <mgcpProfile> ADDR_MGCP_PROfIL </mgcpProfile> |
String | This parameter is not yet described in detail. Proposed procedure see section "Not Documented DAML Parameter" | 5.2 | ||
12 | <msisdn> ADDR_FMC_1 </msisdn> |
Do not use!
This parameter is not yet described in detail. Proposed procedure see section "Not Documented DAML Parameter" |
5.10 | |||
13 | <msisdn2> ADDR_FMC_2 </msisdn2> |
String | Do not use!
This parameter is not yet described in detail. Proposed procedure see section "Not Documented DAML Parameter" |
5.10 |
"Address" Feature: Outgoing Number Presentation
Variable: | Format: | Range: | Default: | Description: | Version: | |
1 | <showClip> ADDR_CLIP_SHOW </showClip> |
String | Selection:
|
false | These two parameters ADDR_CLIP_SHOW and ADDR_CLIP_HIDE determine whether and how the CLIP of the calling side is modified by the Aarenet VoIP Switch.
|
5.2 |
2 | <hideClip> ADDR_CLIP_HIDE </hideClip> |
String | Selection:
|
false | See description of ADDR_CLIP_SHOW above. | 5.2 |
3 | <publicClip> ADDR_CLIP_PUBLIC </publicClip> |
Number | max. 50 characters | Empty | Assigns this telephone number as CLIP of this internal vPBX telephone number for outgoing connections toward the PSTN. The assigned public number must be from the public number range of this vPBX.
Note:
|
5.4 |
"Address" Feature: VoiceMail Box
Variable: | Format: | Range: | Default: | Description: | Version: | |
1 | <messageBox> . . . </messageBox> |
XML container which defines the VoiceMail Box parameters that is associated with this telephone number. | 5.2 | |||
2 | <autoAuthentication> ADDR_VM_PIN </autoAuthentication> |
Number | Empty or |
Write only!
|
5.2 | |
3 | <autoAuthentication> ADDR_VM_AUTO_AUTH </autoAuthentication> |
String | Selection:
|
false | Assigns whether the PIN is needed when the access is coming from this telephone number. | 5.2 |
4 | <skipMessageMenu> ADDR_VM_SKIP_MESSAGE </skipMessageMenu> |
String | Selection:
|
false | Assigns that the main menu of the VoiceMail Box are recited. | 5.2 |
5 | <language> ADDR_VM_LANGUAGE </language> |
String | Selection:
|
Depends on the address language ADDR_LANGUAGE | Assigns the language of the announcement texts of the VoiceMail Box.
de: German |
5.2 |
6 | <signalNewMessage> ADDR_VM_SIGNAL_NEW_MESSAGE </signalNewMessage> |
String | Selection:
|
true | Assigns that a new recorded message is signaled by the message server of the Aarenet VoIP Switch to the SIP CPE. | 5.2 |
7 | <subscribedMwiOnly> ADDR_VM_SIGNAL_MWI_ONLY </subscribedMwiOnly> |
String | Selection:
|
true | Defines whether and how the telephone is informed about a new message in the VoiceMailBox. The format is „Message Waiting Information MWI”.
false:
|
5.2 |
8 | <email> ADDR_VM_EMAIL </email> |
String | Empty or |
Empty | Assigns the email address to which a VoiceMail message will be sent. | 5.2 |
9 | <formatMp3> ADDR_VM_AUDIO_FORMAT </formatMp3> |
String | Selection:
|
false | Assigns that the message audio file is MP3 formatted.
Note: |
5.2 |
10 | <blocked> ADDR_VM_BLOCKED </blocked> |
String | Status:
|
no | Read Only! States, if the VoiceMail Box is blocked and how long it is blocked. no:
Blocked Minutes:
|
5.2 |
11 | <faxOnly> ADDR_VM_FAX_ONLY </faxOnly> |
String | Selection:
|
false | Assigns if this VoiceMail Box is enabled to receive Fax only. | 5.7 |
12 | <faxAutoDetect> ADDR_VM_FAX_VOICE_DETECT </faxAutoDetect> |
String | Selection:
|
false | Assigns that this VoiceMail Box detects automatically if an incoming message is a voice message or a Fax. | 5.7 |
"Address" Feature: Call Forwarding
Note |
It is recommended not to use the call forward CF for vPBX call distributions. Use the AdminCenter feature "Distributions" for this purpose. |
Variable: | Format: | Range: | Default: | Description: | Version: | |
1 | <cfu> ADDR_CFU </cfu> |
Telephone Number | max. 50 characters | Empty | Assigns an "Call Forwarding Unconditional CFU" redirection telephone number for this telephone number. | 5.2 |
2 | <cff> ADDR_CFF </cff> |
Telephone Number | max. 50 characters | Empty | Assigns a "Call Forwarding Fallback CFF" redirection telephone number for this telephone number. | 5.2 |
3 | <cfb> ADDR_CFB </cfb> |
Telephone Number | max. 50 characters | Empty | Assigns a "Call Forwarding Busy CFB" redirection telephone number for this telephone number. | 5.2 |
4 | <cfnr> ADDR_CFNR </cfnr> |
Telephone Number | max. 50 characters | Empty | Assigns a "Call Forwarding Not Reachable CFNR" redirection telephone number for this telephone number. | 5.2 |
5 | <cfo> ADDR_CFO </cfo> |
Telephone Number | max. 50 characters | Empty | Assigns an "Call Forking CFO" redirection telephone number for this telephone number. | 5.2 |
6 | <dnd> ADDR_DND </dnd> |
String | Selection:
|
false | Assigns "Do not Disturb DND" for this telephone number. Incoming calls are connected to a corresponding announcement. | 5.2 |
7 | <rrn> ADDR_RRN </rrn> |
String | Selection:
|
false | Assigns "Reject anonymous calls RRN" for this telephone number. Incoming calls are connected to a corresponding announcement. | 5.2 |
"Address" Feature: Diverse
Variable: | Format: | Range: | Default: | Description: | Version: | |
1 | <language> ADDR_LANGUAGE </language> |
String | Selection:
|
Depends on the address language ADDR_LANGUAGE | Assigns the language of the announcement, e.g. do not disturb, used for this telephone number.
de: German |
5.2 |
2 | <callWaiting> ADDR_MGCP_CALL_WAITING </callWaiting> |
String | Selection:
|
false | Assigns for MGCP MTA if it is allowed to signal a new incoming call during a running call
false:
true:
|
5.2 |
3 | <callHold> ADDR_MGCP_CALL_HOLD </callHold> |
String | Selection:
|
false | Assigns for MGCP MTA if it is allowed to set the calling side on hold.
false:
true:
|
5.2 |
4 | <noOfferOnBusy> ADDR_CALL_NO_OFFER </noOfferOnBusy> |
String | Selection:
|
false | Assigns if this telephone number is signaled a new incoming call during busy state. | 5.9 |
5 | <recordingEmail> ADDR_CALL_RECORD_EMAIL </recordingEmail> |
String | Empty or |
Empty | Assigns the email address to which a recorded call will be sent.
Note:
|
5.7 |
6 | <autoRecord> ADDR_CALL_RECORD_AUTOMATIC </autoRecord> |
String | Selection:
|
false | Assigns if all calls will be recorded automatically and sent to the assigned email address in ADDR_CALL_RECORD_EMAIL. | 5.8 |
"Address" Feature: Group
Note |
Groups are an important feature for the creation of a vPBX and the presence services within a vPBX. |
Variable: | Format: | Range: | Default: | Description: | Version: | |
1 | <pbx> ADDR_GROUP_VPBX </pbx> |
String | max. 64 characters | none | Assigns to which vPBX this telephone number belongs.
|
5.2 |
2 | <groupMember> ADDR_GROUP_VPBX_MEMBER </groupMember> |
String | Assigns from which other groups this telephone number may refer additional authorizations.
A telephone number can be member of n groups.
|
5.2 | ||
3 | <presenceGroup> ADDR_GROUP_PRESENCE </presenceGroup> |
String | max. 64 characters | none | Assigns the group whose members are allowed to subscribe for the Presence service of this telephone number.
|
5.2 |
4 | <monitorGroup> ADDR_GROUP_MONITOR </monitorGroup> |
String | max. 64 characters | none | Assigns the group whose members are allowed to subscribe for the Monitor service of this telephone number.
|
5.2 |
5 | <messageGroup> ADDR_GROUP_MESSAGE </messageGroup> |
String | max. 64 characters | none | Assigns the group whose members are allowed to subscribe for the Message service of this telephone number.
|
5.2 |
"Address" Feature: AdminCenter Access
Variable: | Format: | Range: | Default: | Description: | Version: | |
1 | <addressAdmin> . . . </addressAdmin> |
String | This parameter is not yet described in detail. Proposed procedure see section "Not Documented DAML Parameter" | 5.2 | ||
2 | <username> ADDR_ADMIN_UN </username> |
String | This parameter is not yet described in detail. Proposed procedure see section "Not Documented DAML Parameter" | 5.2 | ||
3 | <password> ADDR_ADMIN_PW </password> |
String | This parameter is not yet described in detail. Proposed procedure see section "Not Documented DAML Parameter" | 5.2 | ||
4 | <language> ADDR_ADMIN_LANGUAGE </language> |
String | This parameter is not yet described in detail. Proposed procedure see section "Not Documented DAML Parameter" | 5.2 | ||
5 | <email> ADDR_ADMIN_EMAIL </email> |
String | Empty | This parameter is not yet described in detail. Proposed procedure see section "Not Documented DAML Parameter" | 5.2 |
DAML-Query
DAML-Query: "List of All Account Names"
This Query requests the names of all accounts which are configured in this Aarenet VoIP Switch.
The CRM must transfer a HTTP GET with the following parameters:
query=account
- Query directive to request all account names
DAML-Query Example:
https://<IP_ADDRESS>:8447/dataaccesscenter/daml?query=accounts |
DAML-Response Example:
<daml status="ok">
</daml> |
DAML-Query: "List of the n Last Connections of a Telephone 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.
Warning |
Limit the requested number of entries as it blocks the database during the query execution! |
The CRM must transfer a HTTP GET with the following parameters:
query=calls
- Query directive to request the last connections and connection attempts of a telephone number
account=QUERY_ACCOUNT
- Unambiguous name of an account
number=QUERY_NUMBER
- Unambiguous telephone number or SIP address
entries=QUERY_ENTRY
- Number of the requested connections and connection attempts
DAML-Query Example:
https://<IP_ADDRESS>:8447/dataaccesscenter/daml?query=calls&account=an-acc-0021&number=01234567890&entries=10 |
DAML-Response:
<daml status="ok">
</daml> |
DAML-Response Example:
<daml status="ok">
</daml> |
Parameters:
Variable: | Format: | Range: | Default: | Description: | Version: | |
1 | <call> . . . </call> |
none | none | none | Container which holds the call details | 5.2 |
2 | <time> CALL_START </time> |
yyyy-MM-dd'T'HH:mm:ss | none | none | Date/time of the call’s start | 5.2 |
3 | <duration> CALL_DURATION </duration> |
yyyy-MM-dd'T'HH:mm:ss | >=0 | none | Duration of the connection in milliseconds.
If the duration is 0 then it was a call attempt. |
5.2 |
4 | <direction> CALL_DIRECTION </direction> |
String | Selection:
|
none | Indicates whether it is an incoming or outgoing connection.
in:
out:
|
5.2 |
5 | <number> CALL_PEER_NUMBER </number> |
String | Telephone Number | none | Shows the telephone number of the other participant of the connection.
The meaning depends on the CALL_DIRECTION :
out:
|
5.2 |
6 | <charge> CALL_CHARGE </charge> |
String | >= 0.00 | none | Charge of an outgoing connection | 5.2 |
DAML-Query: "List of all Ruleset Names"
This Query requests the names of all ruleset which are configured in this Aarenet VoIP Switch.
The CRM must transfer a HTTP GET with the following parameters:
query=rulesets
- Query directive to request all configured ruleset names
DAML-Query Example:
https://<IP_ADDRESS>:8447/dataaccesscenter/daml?query=rulesets |
DAML-Response Example:
<daml status="ok">
</daml> |
DAML-Query: "List of all Emergency Locations"
This Query requests the names of all emergency locations which are configured in this Aarenet VoIP Switch.
The CRM must transfer a HTTP GET with the following parameters:
query=emergencyLocations
- Query directive to request all configured emergency locations
DAML-Query Example:
https://<IP_ADDRESS>:8447/dataaccesscenter/daml?query=emergencyLocations |
DAML-Response Example:
<daml status="ok">
</daml> |
DAML-Query: "List of All Announcement Names of a Telephone Number"
This query requests the names of all announcement names of a telephone number.
The CRM must transfer a HTTP GET with the following parameters:
query=announcements
- Query directive to request all announcement names of a telephone number.
account=QUERY_ACCOUNT
- Unambiguous name of an account
number=QUERY_NUMBER
- Unambiguous telephone number or SIP address
DAML-Query Example:
https://<IP_ADDRESS>:8447/dataaccesscenter/daml?query=announcements&account=an-acc-0021&number=01234567890 |
DAML-Response:
<daml status="ok">
</daml> |
DAML-Response Example:
<daml status="ok">
</daml> |
Parameters:
Variable: | Format: | Range: | Default: | Description: | Version: | |
1 | <message> . . . </message> |
none | none | none | Container which holds the announcement parameters | 5.2 |
2 | <id> ANNONCEMENT_ID </id> |
Number | >=0 | none | Unambiguous identification of the announcement | 5.2 |
3 | <name> ANNONCEMENT_NAME </name> |
String | none | Name of the announcement | 5.2 | |
4 | <duration> ANNONCEMENT_DURATION </duration> |
Number | >=0, in milliseconds | none | Duration of the announcement | 5.2 |
DAML-Query: "List of all VoiceMail Messages of a Telephone Number"
This query requests the identifications of all messages of a telephone number's VoiceMail box.
The CRM must transfer a HTTP GET with the following parameters:
query=voiceMessages
- Query directive to request all message information of a telephone number’s VoiceMail Box.
account=QUERY_ACCOUNT
- Unambiguous name of an account
number=QUERY_NUMBER
- Unambiguous telephone number or SIP address
DAML-Query Example:
https://<IP_ADDRESS>:8447/dataaccesscenter/daml?query=voiceMessages&account=an-acc-0021&number=01234567890 |
DAML-Response:
<daml status="ok">
</daml> |
DAML-Response Example:
<daml status="ok">
</daml> |
Parameters:
Variable: | Format: | Range: | Default: | Description: | Version: | |
1 | <message> . . . </message> |
none | none | none | Container which holds the message parameters | 5.2 |
2 | <id> MESSAGE_ID </id> |
Number | >=0 | none | Unambiguous identification of the message | 5.2 |
3 | <name> MESSAGE_NAME </name> |
String | none | Name in the <Display> part of the SIP-Header "From:" | 5.2 | |
4 | <number> MESSAGE_NUMBER </number> |
Number | >=0 | none | Telephony number of the calling side. | 5.2 |
5 | <timeStart> MESSAGE_DATE_TIME </timeStart> |
yyyy-MM-dd'T'HH:mm:ss | none | Date/time of the recording of the message | 5.2 | |
6 | <timePlayed> MESSAGE_PLAYED </timePlayed> |
String | Selection:
|
none | Date/time, when the message was played the last time. never:
|
5.2 |
7 | <timeStart> MESSAGE_DATE_TIME </timeStart> |
yyyy-MM-dd'T'HH:mm:ss | none | Date/time of the recording of the message | 5.2 | |
8 | <duration> MESSAGE_DURATION </duration> |
Number | >=0, in milliseconds | none | Duration of the message | 5.2 |
9 | <saved> MESSAGE_SAVED </saved> |
String | Selection:
|
none | Indicates whether the message was marked by the user for a longer retention | 5.2 |
DAML-Document Examples
Create a "Residential Account" with 1 Public Number
Requirement:
- Account for private customer with one telephone number
- Customer public number 0987654321
- Account TopStop with 50.00, warning at 70%, email to user@home.com
- Block calls toward 09* numbers
- VoiceMail Box active with email to user@home.com
- CFF to telephone number 0123456789
See also: "Download DAML Test Scripts for a Residential User"
<daml command="write"> <!-- Define the Residential Account -->
</daml> |
Create a "SIP Trunk" Account with 100 Public Numbers for ISDN PBX behind SIP CPE
Requirement:
- SIP Trunk Account for a customer with an ISDN PBX connected to SIP CPE
- 100 public telephone number block 0555555550 – 99
- The main telephone number is 0555555550, the other telephone numbers are registered via main number
- Account TopStop with 2000.00, warning at 70%, email to info@customer.com
- Block calls toward 09* numbers
- CFF to mobile number 03333333
- Signaling 3 digit 500 – 599 toward the SIP CPE/PBX
- No VoiceMail Boxes
See also: "Download DAML Test Scripts for a SIP Trunk"
<daml command="write"> <!-- Define the SIP Trunk Account -->
</daml> |
Create a vPBX Account with 5 Public Numbers
Requirement:
- Account for vPBX
- 3 public telephone numbers 0123456787 – 89
- vPBX requirement:
- Access for vPBX administrator
- Max. 8 channels
- Max. 10 internal telephone numbers
- Max. 5 App "an IP-Phone"
- Account TopStop with 150.00, warning at 70%, email to info@customer.com
- Block calls toward 09* numbers
See also: "Download DAML Test Scripts for a vPBX"
<daml command="write">
</daml> |
© Aarenet Inc 2018
Version: 3.0
Author: Aarenet
Date: May 2017