Documentation for ChannelMessagesInfo

Table of Contents

top

Schema Document Properties

Target Namespace http://4psa.com/ChannelMessagesInfo.xsd/2.0.0
Element and Attribute Namespaces
  • Global element and attribute declarations belong to this schema's target namespace.
  • By default, local element declarations belong to this schema's target namespace.
  • By default, local attribute declarations have no namespace.
Schema Composition
  • This schema imports schema(s) from the following namespace(s):

Declared Namespaces

Prefix Namespace
Default namespace http://4psa.com/ChannelMessagesInfo.xsd/2.0.0
channelData http://4psa.com/ChannelData.xsd/2.0.0
xml http://www.w3.org/XML/1998/namespace
xs http://www.w3.org/2001/XMLSchema
common http://4psa.com/Common.xsd/2.0.0
Schema Component Representation
<xs:schema targetNamespace="http://4psa.com/ChannelMessagesInfo.xsd/2.0.0" elementFormDefault="qualified" id="ChannelMessagesInfo">
<xs:import namespace="http://4psa.com/ChannelData.xsd/2.0.0" schemaLocation="ChannelData.xsd"/>
<xs:import namespace="http://4psa.com/Common.xsd/2.0.0" schemaLocation="../Common.xsd"/>
...
</xs:schema>
top

Global Definitions

Complex Type: AddCallRulesOutResponseType

Super-types: common:updateObject < AddCallRulesOutResponseType (by extension)
Sub-types: None
Name AddCallRulesOutResponseType
Abstract no
Documentation Add outgoing routing rules in a group: response response type
XML Instance Representation
<...>
<ID> positiveInteger </ID> [0..10]

'Object ID'

<result> xs:string (value comes from list: {'success'|'partial'|'failure'}) </result> [0..1]

'Operation result'

<notice> notice </notice> [0..*]
</...>
Schema Component Representation
<xs:complexType name="AddCallRulesOutResponseType">
<xs:complexContent>
<xs:extension base=" common:updateObject "/>
</xs:complexContent>
</xs:complexType>
top

Complex Type: AddPublicNoResponseType

Super-types: common:updateObject < AddPublicNoResponseType (by extension)
Sub-types: None
Name AddPublicNoResponseType
Abstract no
Documentation Add public phone number: response type
XML Instance Representation
<...>
<ID> positiveInteger </ID> [0..10]

'Object ID'

<result> xs:string (value comes from list: {'success'|'partial'|'failure'}) </result> [0..1]

'Operation result'

<notice> notice </notice> [0..*]
</...>
Schema Component Representation
<xs:complexType name="AddPublicNoResponseType">
<xs:complexContent>
<xs:extension base=" common:updateObject "/>
</xs:complexContent>
</xs:complexType>
top

Complex Type: AssignPublicNoResponseType

Super-types: common:updateObject < AssignPublicNoResponseType (by extension)
Sub-types: None
Name AssignPublicNoResponseType
Abstract no
Documentation Assign public phone numbers: response type
XML Instance Representation
<...>
<ID> positiveInteger </ID> [0..10]

'Object ID'

<result> xs:string (value comes from list: {'success'|'partial'|'failure'}) </result> [0..1]

'Operation result'

<notice> notice </notice> [0..*]
</...>
Schema Component Representation
<xs:complexType name="AssignPublicNoResponseType">
<xs:complexContent>
<xs:extension base=" common:updateObject "/>
</xs:complexContent>
</xs:complexType>
top

Complex Type: DelCallRulesOutGroupResponseType

Super-types: common:delObject < DelCallRulesOutGroupResponseType (by extension)
Sub-types: None
Name DelCallRulesOutGroupResponseType
Abstract no
Documentation Delete outgoing routing rules group: response type
XML Instance Representation
<...>
<items> xs:integer </items> [0..1]

'Number of affected items'

<result> xs:string (value comes from list: {'success'|'partial'|'failure'}) </result> [0..1]

'Operation result'

</...>
Schema Component Representation
<xs:complexType name="DelCallRulesOutGroupResponseType">
<xs:complexContent>
<xs:extension base=" common:delObject "/>
</xs:complexContent>
</xs:complexType>
top

Complex Type: DelChannelGroupResponseType

Super-types: common:delObject < DelChannelGroupResponseType (by extension)
Sub-types: None
Name DelChannelGroupResponseType
Abstract no
Documentation Delete channels: response type
XML Instance Representation
<...>
<items> xs:integer </items> [0..1]

'Number of affected items'

<result> xs:string (value comes from list: {'success'|'partial'|'failure'}) </result> [0..1]

'Operation result'

</...>
Schema Component Representation
<xs:complexType name="DelChannelGroupResponseType">
<xs:complexContent>
<xs:extension base=" common:delObject "/>
</xs:complexContent>
</xs:complexType>
top

Complex Type: DelChannelResponseType

Super-types: common:delObject < DelChannelResponseType (by extension)
Sub-types: None
Name DelChannelResponseType
Abstract no
Documentation Delete channel: response type
XML Instance Representation
<...>
<items> xs:integer </items> [0..1]

'Number of affected items'

<result> xs:string (value comes from list: {'success'|'partial'|'failure'}) </result> [0..1]

'Operation result'

</...>
Schema Component Representation
<xs:complexType name="DelChannelResponseType">
<xs:complexContent>
<xs:extension base=" common:delObject "/>
</xs:complexContent>
</xs:complexType>
top

Complex Type: DelPublicNoResponseType

Super-types: common:delObject < DelPublicNoResponseType (by extension)
Sub-types: None
Name DelPublicNoResponseType
Abstract no
Documentation Delete public phone number response type
XML Instance Representation
<...>
<items> xs:integer </items> [0..1]

'Number of affected items'

<result> xs:string (value comes from list: {'success'|'partial'|'failure'}) </result> [0..1]

'Operation result'

</...>
Schema Component Representation
<xs:complexType name="DelPublicNoResponseType">
<xs:complexContent>
<xs:extension base=" common:delObject "/>
</xs:complexContent>
</xs:complexType>
top

Complex Type: EditPublicNoResponseType

Super-types: common:updateObject < EditPublicNoResponseType (by extension)
Sub-types: None
Name EditPublicNoResponseType
Abstract no
Documentation Edit public phone number: response type
XML Instance Representation
<...>
<ID> positiveInteger </ID> [0..10]

'Object ID'

<result> xs:string (value comes from list: {'success'|'partial'|'failure'}) </result> [0..1]

'Operation result'

<notice> notice </notice> [0..*]
</...>
Schema Component Representation
<xs:complexType name="EditPublicNoResponseType">
<xs:complexContent>
<xs:extension base=" common:updateObject "/>
</xs:complexContent>
</xs:complexType>
top

Complex Type: GetCallRulesOutGroupResponseType

Super-types: None
Sub-types: None
Name GetCallRulesOutGroupResponseType
Abstract no
Documentation Get outgoing routing rules group: response type
XML Instance Representation
<...>
<userID> common:positiveInteger </userID> [1]

'User ID'

<rulesGroup> channelData:CallRulesOutGroupList </rulesGroup> [0..*]
<notice> common:notice </notice> [0..*]
</...>
Schema Component Representation
<xs:complexType name="GetCallRulesOutGroupResponseType">
<xs:sequence>
<xs:sequence>
<xs:element name="userID" type=" common:positiveInteger "/>
<xs:element name="rulesGroup" type=" channelData:CallRulesOutGroupList " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:element name="notice" type=" common:notice " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: GetCallRulesOutResponseType

Super-types: None
Sub-types: None
Name GetCallRulesOutResponseType
Abstract no
Documentation Get outgoing routing rules in group: response type
XML Instance Representation
<...>
<ID> common:positiveInteger </ID> [0..1]

'Outgoing routing rules group ID'

<name> common:string </name> [0..1]

'Outgoing routing rule group name'

<userID> common:positiveInteger </userID> [0..1]

'Outgoing routing rule group owner ID'

<rules> [0..*]
<mstns:action> xs:string (value comes from list: {'block'|'transfer'|'process'|'portability'}) </mstns:action> [0..1]

'Action: \'block\', \'transfer\', \'process\', \'portability\'. Default block'

<mstns:engine> common:string </mstns:engine> [0..1]

'Portability engine'

<mstns:number> xs:string (pattern = [*XZN\-\.\[\]\d]+) (Whitespace policy: collapse) </mstns:number> [1]
<mstns:intervalID> common:positiveInteger </mstns:intervalID> [0..1]

'Time interval ID'

<mstns:comingFrom> xs:string (pattern = [0-9\*\.]+) (Whitespace policy: collapse) </mstns:comingFrom> [0..1]
<mstns:channelID> common:positiveInteger </mstns:channelID> [0..1]

'Channel ID. Default: Best cost'

<mstns:prefixOperation> xs:string (value comes from list: {'prefix'|'replace'|'add'|'substract'}) </mstns:prefixOperation> [0..1]

'Prefix operation, required just for {action: transfer, process}: \'prefix\',\'replace\',\'add\' or \'substract\'. Default prefix'

<mstns:prefix> xs:decimal </mstns:prefix> [0..1]

'Required for prefixOperation:replace, prefix.'

<mstns:digits> common:integer </mstns:digits> [0..1]

'For prefixOperation:substract only'

<mstns:digitsAfter> common:integer </mstns:digitsAfter> [0..1]

'For prefixOperation:substract only'

<mstns:numberAdd> common:integer </mstns:numberAdd> [0..1]

'For prefixOperation:add only'

<mstns:digitsAfterAdd> xs:decimal </mstns:digitsAfterAdd> [0..1]

'For prefixOperation:add only'

<mstns:final> common:boolean </mstns:final> [0..1]

'Final transfer rule'

<mstns:position> common:unsignedInt </mstns:position> [0..1]

'Default: first position'

<ruleID> common:positiveInteger </ruleID> [1]

'Outgoing routing rule ID'

<status> common:boolean </status> [1]

'Outgoing routing rule status'

</rules>
<notice> [0..*]
<message> common:text </message> [0..1]
<code> common:text </code> [0..1]
</notice>
</...>
Schema Component Representation
<xs:complexType name="GetCallRulesOutResponseType">
<xs:sequence>
<xs:sequence>
<xs:element name="ID" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="name" type=" common:string " minOccurs="0"/>
<xs:element name="userID" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="rules" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" channelData:RoutingRuleInfo ">
<xs:sequence>
<xs:element name="ruleID" type=" common:positiveInteger "/>
<xs:element name="status" type=" common:boolean "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:element name="notice" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence>
<xs:element name="message" type=" common:text " minOccurs="0"/>
<xs:element name="code" type=" common:text " minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
top

Complex Type: GetChannelGroupsResponseType

Super-types: None
Sub-types: None
Name GetChannelGroupsResponseType
Abstract no
Documentation Get channel groups: response type
XML Instance Representation
<...>
<group> channelData:ChannelGroupList </group> [0..*]

'Channel groups list on success'

<notice> common:notice </notice> [0..*]
</...>
Schema Component Representation
<xs:complexType name="GetChannelGroupsResponseType">
<xs:sequence>
<xs:element name="group" type=" channelData:ChannelGroupList " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="notice" type=" common:notice " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: GetChannelsResponseType

Super-types: None
Sub-types: None
Name GetChannelsResponseType
Abstract no
Documentation Get channels: response type
XML Instance Representation
<...>
<channel> channelData:ChannelList </channel> [0..*]

'Channel data'

<notice> common:notice </notice> [0..*]
</...>
Schema Component Representation
<xs:complexType name="GetChannelsResponseType">
<xs:sequence>
<xs:element name="channel" type=" channelData:ChannelList " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="notice" type=" common:notice " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: GetCodecsResponseType

Super-types: None
Sub-types: None
Name GetCodecsResponseType
Abstract no
Documentation Get channel codecs: response type
XML Instance Representation
<...>
<codecs> [0..1]

'Codecs list'


<assigned> channelData:Codecs </assigned> [0..*]

'Channel codecs'

<available> channelData:Codecs </available> [0..*]

'Available codecs'

</codecs>
<channelID> common:positiveInteger </channelID> [0..1]

'Channel ID'

</...>
Schema Component Representation
<xs:complexType name="GetCodecsResponseType">
<xs:sequence>
<xs:element name="codecs" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="assigned" type=" channelData:Codecs " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="available" type=" channelData:Codecs " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="channelID" type=" common:positiveInteger " minOccurs="0"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: GetGroupSelectionResponseType

Super-types: None
Sub-types: None
Name GetGroupSelectionResponseType
Abstract no
Documentation Get channel groups (available and assigned) : response type
XML Instance Representation
<...>
<channelGroup> channelData:ChannelGroupSelection </channelGroup> [1]

'A list with available and assigned channel groups on success'

<notice> common:notice </notice> [0..*]
</...>
Schema Component Representation
<xs:complexType name="GetGroupSelectionResponseType">
<xs:sequence>
<xs:element name="channelGroup" type=" channelData:ChannelGroupSelection "/>
<xs:element name="notice" type=" common:notice " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: GetNoSelectionResponseType

Super-types: None
Sub-types: None
Name GetNoSelectionResponseType
Abstract no
Documentation Get public phone number selection: response type
XML Instance Representation
<...>
<publicNo> channelData:PublicNoSelection </publicNo> [1]

'Available and assigned public phone numbers'

<notice> common:notice </notice> [0..*]
</...>
Schema Component Representation
<xs:complexType name="GetNoSelectionResponseType">
<xs:sequence>
<xs:element name="publicNo" type=" channelData:PublicNoSelection "/>
<xs:element name="notice" type=" common:notice " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: GetPublicNoResponseType

Super-types: None
Sub-types: None
Name GetPublicNoResponseType
Abstract no
Documentation Get public phone number: response type
XML Instance Representation
<...>
<publicNo> channelData:PublicNoList </publicNo> [0..*]
<notice> common:notice </notice> [0..*]
</...>
Schema Component Representation
<xs:complexType name="GetPublicNoResponseType">
<xs:sequence>
<xs:element name="publicNo" type=" channelData:PublicNoList " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="notice" type=" common:notice " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: UpdateCallRulesOutGroupResponseType

Super-types: common:updateObject < UpdateCallRulesOutGroupResponseType (by extension)
Sub-types: None
Name UpdateCallRulesOutGroupResponseType
Abstract no
Documentation Add/Edit outgoing routing rules group: response type
XML Instance Representation
<...>
<ID> positiveInteger </ID> [0..10]

'Object ID'

<result> xs:string (value comes from list: {'success'|'partial'|'failure'}) </result> [0..1]

'Operation result'

<notice> notice </notice> [0..*]
</...>
Schema Component Representation
<xs:complexType name="UpdateCallRulesOutGroupResponseType">
<xs:complexContent>
<xs:extension base=" common:updateObject "/>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UpdateChannelGroupResponseType

Super-types: common:updateObject < UpdateChannelGroupResponseType (by extension)
Sub-types: None
Name UpdateChannelGroupResponseType
Abstract no
Documentation Add/Edit channel group: response type
XML Instance Representation
<...>
<ID> positiveInteger </ID> [0..10]

'Object ID'

<result> xs:string (value comes from list: {'success'|'partial'|'failure'}) </result> [0..1]

'Operation result'

<notice> notice </notice> [0..*]
</...>
Schema Component Representation
<xs:complexType name="UpdateChannelGroupResponseType">
<xs:complexContent>
<xs:extension base=" common:updateObject "/>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UpdateChannelResponseType

Super-types: common:updateObject < UpdateChannelResponseType (by extension)
Sub-types: None
Name UpdateChannelResponseType
Abstract no
Documentation Add/Edit channel: response type
XML Instance Representation
<...>
<ID> positiveInteger </ID> [0..10]

'Object ID'

<result> xs:string (value comes from list: {'success'|'partial'|'failure'}) </result> [0..1]

'Operation result'

<notice> notice </notice> [0..*]
</...>
Schema Component Representation
<xs:complexType name="UpdateChannelResponseType">
<xs:complexContent>
<xs:extension base=" common:updateObject "/>
</xs:complexContent>
</xs:complexType>
top

Generated by <oXygen/> XML Editor using a modified version of xs3p that adds schema diagrams and chunking support. Last modified: