Hc_cfc_options - Управление настройками сервиса CFC
Hc_cfc_options_clean
Команда сброса настроек сервиса CFC.
Аналог команды в CoCon:
/cluster/core/<CORE>/cfc/clean
/domain/<DOMAIN>/cfc/clean
Метод HTTP-запроса:
POST
Шаблон HTTP-запроса:
http://host:port/commands/cfc_options_clean
Код HTTP-ответа:
- 200 – в случае успеха;
- 404 – в случае ошибки.
XSD-схема XML-запроса/ответа:
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:annotation>
<xs:documentation xml:lang="en">
Clean properties of CFC service.
Usage: http://server:9999/commands/cfc_options_clean.
Implementation: hc_cfc_options_clean.erl.
Git: git@git.eltex.loc:httpTerminal.git.
Copyright (c) 2015, Eltex. All rights reserved.
</xs:documentation>
</xs:annotation>
<xs:include schemaLocation="error.xsd"/>
<xs:include schemaLocation="ecm_common.xsd"/>
<!-- resultType-->
<xs:complexType name="resultType">
<xs:all>
<xs:element name="domain_options" type="domainCleanOutType" minOccurs="1"/>
</xs:all>
</xs:complexType>
<!-- in-->
<xs:element name="in">
<xs:complexType>
<xs:sequence>
<xs:element name="request">
<xs:complexType>
<xs:all>
<xs:element name="domain_options" type="domainCleanInType"/>
</xs:all>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<!-- out -->
<xs:element name="out">
<xs:complexType>
<xs:choice>
<xs:element name="result" type="resultType"/>
<xs:element name="error" type="errorType"/>
</xs:choice>
</xs:complexType>
</xs:element>
</xs:schema>
CODE
Пример:
Запрос:
http://192.168.1.21:9999/commands/cfc_options_clean
<?xml version="1.0"?>
<in
xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_cfc_options_clean.xsd">
<request>
<domain_options>
<system />
<domain name="biysk.local">
<option name="authorisation_failure"/>
<option name="enable"/>
<option name="external_acp_causes"/>
</domain>
</domain_options>
</request>
</in>
CODE
Код ответа:
200
Ответ:
<?xml version="1.0"?>
<out
xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_cfc_options_clean.xsd">
<result>
<domain_options>
<system/>
<domain name="biysk.local">
<success option="authorisation_failure"/>
<success option="enable"/>
<success option="external_acp_causes"/>
</domain>
</domain_options>
</result>
</out>
CODE
Hc_cfc_options_info
Команда просмотра информации о настройках сервиса CFC.
Аналог команды в CoCon:
/cluster/core/<CORE>/cfc/info
/domain/<DOMAIN>/cfc/info
Метод HTTP-запроса:
POST
Шаблон HTTP-запроса:
http://host:port/commands/cfc_options_info
Код HTTP-ответа:
- 200 – в случае успеха;
- 404 – в случае ошибки.
XSD-схема XML-запроса/ответа:
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:annotation>
<xs:documentation xml:lang="en">
Show properties of CFC service.
Usage: http://server:9999/commands/cfc_options_info.
Implementation: hc_cfc_options_info.erl.
Git: git@git.eltex.loc:httpTerminal.git.
Copyright (c) 2015, Eltex. All rights reserved.
Tone id format:
tone://?f2=425&off_msec=4000&on_msec=1000&f1=0
system://PATH/FILE.wav
domain://PATH/FILE.wav
</xs:documentation>
</xs:annotation>
<xs:include schemaLocation="error.xsd"/>
<xs:include schemaLocation="ecm_common.xsd"/>
<xs:complexType name="CfcOptionsType">
<xs:complexContent>
<xs:extension base="baseOptionsType">
<xs:attribute name="apty_abandon" type="xs:string" use="optional"/>
<xs:attribute name="apty_disc" type="xs:string" use="optional"/>
<xs:attribute name="authorisation_failure" type="xs:string" use="optional"/>
<xs:attribute name="bpty_busy_ndub" type="xs:string" use="optional"/>
<xs:attribute name="bpty_busy_udub" type="xs:string" use="optional"/>
<xs:attribute name="bpty_disc" type="xs:string" use="optional"/>
<xs:attribute name="bpty_no_answer" type="xs:string" use="optional"/>
<xs:attribute name="call_being_forwarded" type="xs:string" use="optional"/>
<xs:attribute name="called_party_rejected" type="xs:string" use="optional"/>
<xs:attribute name="collect_information_failure" type="xs:string" use="optional"/>
<xs:attribute name="conversation_timeout" type="xs:string" use="optional"/>
<xs:attribute name="do_not_disturb" type="xs:string" use="optional"/>
<xs:attribute name="destination_out_of_order" type="xs:string" use="optional"/>
<xs:attribute name="anonymity_disallowed" type="xs:string" use="optional"/>
<xs:attribute name="enable" type="xs:boolean" use="optional"/>
<xs:attribute name="external_acp_causes" type="xs:string" use="optional"/>
<xs:attribute name="external_isup_causes" type="xs:string" use="optional"/>
<xs:attribute name="foreground" type="xs:boolean" use="optional"/>
<xs:attribute name="invalid_collected_information" type="xs:string" use="optional"/>
<xs:attribute name="invalid_number" type="xs:string" use="optional"/>
<xs:attribute name="no_circuit_available" type="xs:string" use="optional"/>
<xs:attribute name="no_requested_circuit_available" type="xs:string" use="optional"/>
<xs:attribute name="normal" type="xs:string" use="optional"/>
<xs:attribute name="not_reachable" type="xs:string" use="optional"/>
<xs:attribute name="number_incomplete" type="xs:string" use="optional"/>
<xs:attribute name="o_no_answer" type="xs:string" use="optional"/>
<xs:attribute name="origination_denied" type="xs:string" use="optional"/>
<xs:attribute name="route_failure1" type="xs:string" use="optional"/>
<xs:attribute name="route_failure2" type="xs:string" use="optional"/>
<xs:attribute name="route_select_failure" type="xs:string" use="optional"/>
<xs:attribute name="ss7_failure" type="xs:string" use="optional"/>
<xs:attribute name="system_failure" type="xs:string" use="optional"/>
<xs:attribute name="t_exception" type="xs:string" use="optional"/>
<xs:attribute name="termination_denied" type="xs:string" use="optional"/>
<xs:attribute name="unassigned_number" type="xs:string" use="optional"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- resultType-->
<xs:complexType name="resultType">
<xs:all>
<xs:element name="domain_options" type="domainInfoOutType" minOccurs="1"/>
</xs:all>
</xs:complexType>
<!-- in-->
<xs:element name="in">
<xs:complexType>
<xs:sequence>
<xs:element name="request">
<xs:complexType>
<xs:all>
<xs:element name="domain_options" type="domainInfoInType" minOccurs="1"/>
</xs:all>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<!-- out -->
<xs:element name="out">
<xs:complexType>
<xs:choice>
<xs:element name="result" type="resultType"/>
<xs:element name="error" type="errorType"/>
</xs:choice>
</xs:complexType>
</xs:element>
</xs:schema>
CODE
Пример:
Запрос:
http://192.168.1.21:9999/commands/cfc_options_info
<?xml version="1.0"?>
<in
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="hc_cfc_options_info.xsd">
<request>
<domain_options domain="biysk.local"/>
</request>
</in>
CODE
Код ответа:
200
Ответ:
<?xml version="1.0"?>
<out
xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_cfc_options_info.xsd">
<result>
<domain_options>
<system>
<options xs:type="CfcOptionsType"/>
</system>
<domain name="biysk.local">
<options xs:type="CfcOptionsType" unassigned_number="system://sounds/ai_notconnected.wav" termination_denied="system://sounds/ai_tempdenied.wav" t_exception="system://sounds/ai_system_problem.wav" system_failure="system://sounds/ai_system_problem.wav" ss7_failure="system://sounds/ai_system_problem.wav" route_select_failure="system://sounds/ai_out_of_order.wav" route_failure2="" route_failure1="" origination_denied="system://sounds/ai_notaccess.wav" o_no_answer="system://sounds/ai_no_answer.wav" number_incomplete="system://sounds/ai_invalidnumber.wav" not_reachable="system://sounds/ai_not_reachable.wav" normal="" no_requested_circuit_available="system://sounds/ai_badroute.wav" no_circuit_available="system://sounds/ai_badroute.wav" invalid_number="system://sounds/ai_invalidnumber.wav" invalid_collected_information="system://sounds/ai_wrong_number.wav" foreground="false" external_isup_causes="1:system://sounds/ai_number_absent.wav;2:system://sounds/ai_wrong_number.wav;3:system://sounds/ai_wrong_number.wav;18:system://sounds/ai_not_reachable.wav;19:system://sounds/ai_no_answer.wav;20:system://sounds/ai_notconnected.wav;21:system://sounds/ai_notaccess.wav;22:system://sounds/ai_number_not_ready.wav;27:system://sounds/ai_out_of_order.wav;28:system://sounds/ai_invalidnumber.wav;34:system://sounds/ai_overload.wav;44:system://sounds/ai_overload.wav;38:system://sounds/ai_error.wav;41:system://sounds/ai_error.wav;42:system://sounds/ai_system_problem.wav;102:system://sounds/ai_timeout.wav" external_acp_causes="" enable="true" do_not_disturb="" destination_out_of_order="system://sounds/ai_error.wav" conversation_timeout="system://sounds/ai_conversation_timeout.wav" collect_information_failure="system://sounds/ai_wrong_number.wav" called_party_rejected="" call_being_forwarded="" bpty_no_answer="system://sounds/ai_no_answer.wav" bpty_disc="" bpty_busy_udub="" bpty_busy_ndub="" authorisation_failure="system://sounds/ai_wrong_number.wav" apty_disc="" apty_abandon="" anonymity_disallowed=""/>
</domain>
</domain_options>
</result>
</out>
CODE
Hc_cfc_options_set
Команда изменения свойств сервиса CFC.
Аналог команды в CoCon:
/cluster/core/<CORE>/cfc/set
/domain/<DOMAIN>/cfc/set
Метод HTTP-запроса:
POST
Шаблон HTTP-запроса:
http://host:port/commands/cfc_options_set
Код HTTP-ответа:
- 200 – в случае успеха;
- 404 – в случае ошибки.
XSD-схема XML-запроса/ответа:
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:annotation>
<xs:documentation xml:lang="en">
Set CFC properties
Usage: http://server:9999/commands/cfc_options_set.
Implementation: hc_cfc_options_set.erl.
Git: git@git.eltex.loc:httpTerminal.git.
Copyright (c) 2015, Eltex. All rights reserved.
Tone id format:
tone://?f2=425&off_msec=4000&on_msec=1000&f1=0
system://PATH/FILE.wav
domain://PATH/FILE.wav
</xs:documentation>
</xs:annotation>
<xs:include schemaLocation="error.xsd"/>
<xs:include schemaLocation="ecm_common.xsd"/>
<xs:complexType name="CfcOptionsType">
<xs:complexContent>
<xs:extension base="baseOptionsType">
<xs:attribute name="apty_abandon" type="xs:string" use="optional"/>
<xs:attribute name="apty_disc" type="xs:string" use="optional"/>
<xs:attribute name="authorisation_failure" type="xs:string" use="optional"/>
<xs:attribute name="bpty_busy_ndub" type="xs:string" use="optional"/>
<xs:attribute name="bpty_busy_udub" type="xs:string" use="optional"/>
<xs:attribute name="bpty_disc" type="xs:string" use="optional"/>
<xs:attribute name="bpty_no_answer" type="xs:string" use="optional"/>
<xs:attribute name="call_being_forwarded" type="xs:string" use="optional"/>
<xs:attribute name="called_party_rejected" type="xs:string" use="optional"/>
<xs:attribute name="collect_information_failure" type="xs:string" use="optional"/>
<xs:attribute name="conversation_timeout" type="xs:string" use="optional"/>
<xs:attribute name="do_not_disturb" type="xs:string" use="optional"/>
<xs:attribute name="destination_out_of_order" type="xs:string" use="optional"/>
<xs:attribute name="anonymity_disallowed" type="xs:string" use="optional"/>
<xs:attribute name="enable" type="xs:boolean" use="optional"/>
<xs:attribute name="external_acp_causes" type="xs:string" use="optional"/>
<xs:attribute name="external_isup_causes" type="xs:string" use="optional"/>
<xs:attribute name="foreground" type="xs:boolean" use="optional"/>
<xs:attribute name="invalid_collected_information" type="xs:string" use="optional"/>
<xs:attribute name="invalid_number" type="xs:string" use="optional"/>
<xs:attribute name="no_circuit_available" type="xs:string" use="optional"/>
<xs:attribute name="no_requested_circuit_available" type="xs:string" use="optional"/>
<xs:attribute name="normal" type="xs:string" use="optional"/>
<xs:attribute name="not_reachable" type="xs:string" use="optional"/>
<xs:attribute name="number_incomplete" type="xs:string" use="optional"/>
<xs:attribute name="o_no_answer" type="xs:string" use="optional"/>
<xs:attribute name="origination_denied" type="xs:string" use="optional"/>
<xs:attribute name="route_failure1" type="xs:string" use="optional"/>
<xs:attribute name="route_failure2" type="xs:string" use="optional"/>
<xs:attribute name="route_select_failure" type="xs:string" use="optional"/>
<xs:attribute name="ss7_failure" type="xs:string" use="optional"/>
<xs:attribute name="system_failure" type="xs:string" use="optional"/>
<xs:attribute name="t_exception" type="xs:string" use="optional"/>
<xs:attribute name="termination_denied" type="xs:string" use="optional"/>
<xs:attribute name="unassigned_number" type="xs:string" use="optional"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- resultType-->
<xs:complexType name="resultType">
<xs:all>
<xs:element name="domain_options" type="domainSetOutType" minOccurs="1"/>
</xs:all>
</xs:complexType>
<!-- in-->
<xs:element name="in">
<xs:complexType>
<xs:sequence>
<xs:element name="request">
<xs:complexType>
<xs:all>
<xs:element name="domain_options" type="domainSetInType"/>
</xs:all>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<!-- out -->
<xs:element name="out">
<xs:complexType>
<xs:choice>
<xs:element name="result" type="resultType" minOccurs="1" maxOccurs="1"/>
<xs:element name="error" type="errorType" minOccurs="1" maxOccurs="1"/>
</xs:choice>
</xs:complexType>
</xs:element>
</xs:schema>
CODE
Пример:
Запрос:
http://192.168.1.21:9999/commands/cfc_options_set
<?xml version="1.0"?>
<in
xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_cfc_options_set.xsd">
<request>
<domain_options>
<system>
<options xs:type="CfcOptionsType"/>
</system>
<domain name="biysk.local">
<options xs:type="CfcOptionsType" enable="true" normal="" foreground="true" not_reachable="ai_not_reachable" external_isup_causes="1:ai_number_absent;21:ai_not_pay" external_acp_causes="test:ai_wrong_number" />
</domain>
</domain_options>
</request>
</in>
CODE
Код ответа:
200
Ответ:
<?xml version="1.0"?>
<out
xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_cfc_options_set.xsd">
<result>
<domain_options>
<system/>
<domain name="biysk.local">
<success option="enable"/>
<success option="external_acp_causes"/>
<success option="external_isup_causes"/>
<success option="foreground"/>
<success option="normal"/>
<success option="not_reachable"/>
</domain>
</domain_options>
</result>
</out>
CODE