Documentation for ChannelMessages

Table of Contents

top

Schema Document Properties

Target Namespace http://4psa.com/ChannelMessages.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

Declared Namespaces

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

Global Declarations

Element: AddCallRulesOutGroupRequest

Name AddCallRulesOutGroupRequest
Type channelData:RoutingRuleGroupInfo
Nillable no
Abstract no
Documentation Add outgoing routing rules group: request
Logical Diagram
XML Instance Representation
<AddCallRulesOutGroupRequest>
<name> common:string </name> [0..1]

'Routing rule name'

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

'Client ID for the outgoing routing rule'

<default> common:boolean </default> [0..1]

'Set as default routing group'

<rules> RoutingRuleInfo </rules> [1..*]

'Outgoing routing rules in group'

</AddCallRulesOutGroupRequest>
Schema Component Representation
<xs:element name="AddCallRulesOutGroupRequest" type=" channelData:RoutingRuleGroupInfo "/>
top

Element: AddCallRulesOutGroupResponse

Name AddCallRulesOutGroupResponse
Type messagesInfo:UpdateCallRulesOutGroupResponseType
Nillable no
Abstract no
Documentation Add outgoing routing rules group: response
Logical Diagram
XML Instance Representation
<AddCallRulesOutGroupResponse>
<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..*]
</AddCallRulesOutGroupResponse>
Schema Component Representation
<xs:element name="AddCallRulesOutGroupResponse" type=" messagesInfo:UpdateCallRulesOutGroupResponseType "/>
top

Element: AddCallRulesOutRequest

Name AddCallRulesOutRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Add group outgoing routing rule: request
Logical Diagram
XML Instance Representation
<AddCallRulesOutRequest>
<ID> common:positiveInteger </ID> [0..1]

'Outgoing routing rules group ID'

<rules> channelData:RoutingRuleInfo </rules> [1..*]
</AddCallRulesOutRequest>
Schema Component Representation
<xs:element name="AddCallRulesOutRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="ID" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="rules" type=" channelData:RoutingRuleInfo " maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: AddCallRulesOutResponse

Name AddCallRulesOutResponse
Type messagesInfo:AddCallRulesOutResponseType
Nillable no
Abstract no
Documentation Add group outgoing routing rule: response
Logical Diagram
XML Instance Representation
<AddCallRulesOutResponse>
<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..*]
</AddCallRulesOutResponse>
Schema Component Representation
<xs:element name="AddCallRulesOutResponse" type=" messagesInfo:AddCallRulesOutResponseType "/>
top

Element: AddChannelGroupRequest

Name AddChannelGroupRequest
Type channelData:ChannelGroupInfo
Nillable no
Abstract no
Documentation Add channel group: request
Logical Diagram
XML Instance Representation
<AddChannelGroupRequest>
<name> common:string </name> [0..1]

'Channel group name'

<notes> common:text </notes> [0..1]

'Channel group notes'

<channelID> common:positiveInteger </channelID> [0..*]

'Channels for the group'

</AddChannelGroupRequest>
Schema Component Representation
<xs:element name="AddChannelGroupRequest" type=" channelData:ChannelGroupInfo "/>
top

Element: AddChannelGroupResponse

Name AddChannelGroupResponse
Type messagesInfo:UpdateChannelGroupResponseType
Nillable no
Abstract no
Documentation Add channel group: response
Logical Diagram
XML Instance Representation
<AddChannelGroupResponse>
<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..*]
</AddChannelGroupResponse>
Schema Component Representation
<xs:element name="AddChannelGroupResponse" type=" messagesInfo:UpdateChannelGroupResponseType "/>
top

Element: AddChannelRequest

Name AddChannelRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Add channel: request
Logical Diagram
XML Instance Representation
<AddChannelRequest>
<type> xs:string (value comes from list: {'sip'|'dahdi'|'iax'|'enum'}) </type> [0..1]

'Channel type: sip, dahdi, iax, enum. Default value: sip'

Start Choice [1]

'Either of'
<SIP> channelData:SIPChannelInfo </SIP> [0..1]

'SIP channel'

End Choice
</AddChannelRequest>
Schema Component Representation
<xs:element name="AddChannelRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="type" default="sip" minOccurs="0">
<xs:simpleType>
<xs:restriction base=" xs:string ">
<xs:enumeration value="sip"/>
<xs:enumeration value="dahdi"/>
<xs:enumeration value="iax"/>
<xs:enumeration value="enum"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:choice>
<xs:element name="SIP" type=" channelData:SIPChannelInfo " minOccurs="0"/>
<xs:element name="Dahdi" minOccurs="0" maxOccurs="0"/>
<xs:element name="IAX" minOccurs="0" maxOccurs="0"/>
<xs:element name="Enum" minOccurs="0" maxOccurs="0"/>
</xs:choice>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: AddChannelResponse

Name AddChannelResponse
Type messagesInfo:UpdateChannelResponseType
Nillable no
Abstract no
Documentation Add channel: response
Logical Diagram
XML Instance Representation
<AddChannelResponse>
<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..*]
</AddChannelResponse>
Schema Component Representation
<xs:element name="AddChannelResponse" type=" messagesInfo:UpdateChannelResponseType "/>
top

Element: AddPublicNoRequest

Name AddPublicNoRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Add public phone numbers: request
Logical Diagram
XML Instance Representation
<AddPublicNoRequest>
<publicNo> [1..10]
<phoneNo> common:string </phoneNo> [1]

'Public phone number'

<did> common:string </did> [1]

'DID (Direct Inward Dialing) number'

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

'Location'

<cost> common:float </cost> [0..1]

'Monthly amount paid to provider'

<incomingCost> [0..1]

'Incoming calls cost: {cost} money_unit every {interval} seconds'


<cost> common:float </cost> [0..1]
<interval> common:integer </interval> [0..1]
</incomingCost>
<type> xs:string (value comes from list: {'exclusive'|'stacked'}) </type> [0..1]

'Assignation method: stacked or exclusive'

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

'Channel ID'

</publicNo>
</AddPublicNoRequest>
Schema Component Representation
<xs:element name="AddPublicNoRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="publicNo" maxOccurs="10">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" channelData:PublicNoInfo ">
<xs:sequence>
<xs:element name="channelID" type=" common:positiveInteger "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: AddPublicNoResponse

Name AddPublicNoResponse
Type messagesInfo:AddPublicNoResponseType
Nillable no
Abstract no
Documentation Add public phone numbers: response
Logical Diagram
XML Instance Representation
<AddPublicNoResponse>
<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..*]
</AddPublicNoResponse>
Schema Component Representation
<xs:element name="AddPublicNoResponse" type=" messagesInfo:AddPublicNoResponseType "/>
top

Element: AssignPublicNoRequest

Name AssignPublicNoRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Assign available public phone numbers: request
Logical Diagram
XML Instance Representation
<AssignPublicNoRequest>
<didID> common:positiveInteger </didID> [1..*]

'Public phone number ID'

Start Choice [1]
<userID> common:positiveInteger </userID> [1]

'User ID'

<userIdentifier> common:string </userIdentifier> [1]

'User identifier'

End Choice
</AssignPublicNoRequest>
Schema Component Representation
<xs:element name="AssignPublicNoRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="didID" type=" common:positiveInteger " maxOccurs="unbounded"/>
<xs:choice>
<xs:element name="userID" type=" common:positiveInteger "/>
<xs:element name="userIdentifier" type=" common:string "/>
</xs:choice>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: AssignPublicNoResponse

Name AssignPublicNoResponse
Type messagesInfo:AssignPublicNoResponseType
Nillable no
Abstract no
Documentation Assign available public phone numbers: response
Logical Diagram
XML Instance Representation
<AssignPublicNoResponse>
<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..*]
</AssignPublicNoResponse>
Schema Component Representation
<xs:element name="AssignPublicNoResponse" type=" messagesInfo:AssignPublicNoResponseType "/>
top

Element: DelCallRulesOutGroupRequest

Name DelCallRulesOutGroupRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Delete outgoing routing rules group request.
Logical Diagram
XML Instance Representation
<DelCallRulesOutGroupRequest>
<ID> common:positiveInteger </ID> [1..*]

'Outgoing routing rule group ID'

</DelCallRulesOutGroupRequest>
Schema Component Representation
<xs:element name="DelCallRulesOutGroupRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="ID" type=" common:positiveInteger " maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: DelCallRulesOutGroupResponse

Name DelCallRulesOutGroupResponse
Type messagesInfo:DelCallRulesOutGroupResponseType
Nillable no
Abstract no
Documentation Delete outgoing routing rules group response.
Logical Diagram
XML Instance Representation
<DelCallRulesOutGroupResponse>
<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'

</DelCallRulesOutGroupResponse>
Schema Component Representation
<xs:element name="DelCallRulesOutGroupResponse" type=" messagesInfo:DelCallRulesOutGroupResponseType "/>
top

Element: DelCallRulesOutRequest

Name DelCallRulesOutRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Delete outgoing routing rules request.
Logical Diagram
XML Instance Representation
<DelCallRulesOutRequest>
<rulesGroupID> common:positiveInteger </rulesGroupID> [0..1]

'Outgoing routing rules group ID'

<ID> common:positiveInteger </ID> [1..*]

'Outgoint routing rule ID'

</DelCallRulesOutRequest>
Schema Component Representation
<xs:element name="DelCallRulesOutRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="rulesGroupID" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="ID" type=" common:positiveInteger " maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: DelCallRulesOutResponse

Name DelCallRulesOutResponse
Type messagesInfo:DelCallRulesOutGroupResponseType
Nillable no
Abstract no
Documentation Delete outgoing routing rules response.
Logical Diagram
XML Instance Representation
<DelCallRulesOutResponse>
<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'

</DelCallRulesOutResponse>
Schema Component Representation
<xs:element name="DelCallRulesOutResponse" type=" messagesInfo:DelCallRulesOutGroupResponseType "/>
top

Element: DelChannelGroupRequest

Name DelChannelGroupRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Delete channel group request
Logical Diagram
XML Instance Representation
<DelChannelGroupRequest>
<ID> common:positiveInteger </ID> [1..*]

'Channel group ID'

</DelChannelGroupRequest>
Schema Component Representation
<xs:element name="DelChannelGroupRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="ID" type=" common:positiveInteger " maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: DelChannelGroupResponse

Name DelChannelGroupResponse
Type messagesInfo:DelChannelGroupResponseType
Nillable no
Abstract no
Documentation Delete channel group response
Logical Diagram
XML Instance Representation
<DelChannelGroupResponse>
<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'

</DelChannelGroupResponse>
Schema Component Representation
<xs:element name="DelChannelGroupResponse" type=" messagesInfo:DelChannelGroupResponseType "/>
top

Element: DelChannelRequest

Name DelChannelRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Delete channel: request
Logical Diagram
XML Instance Representation
<DelChannelRequest>
<ID> common:positiveInteger </ID> [1..*]

'Channel ID'

</DelChannelRequest>
Schema Component Representation
<xs:element name="DelChannelRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="ID" type=" common:positiveInteger " maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: DelChannelResponse

Name DelChannelResponse
Type messagesInfo:DelChannelResponseType
Nillable no
Abstract no
Documentation Delete channel: response
Logical Diagram
XML Instance Representation
<DelChannelResponse>
<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'

</DelChannelResponse>
Schema Component Representation
<xs:element name="DelChannelResponse" type=" messagesInfo:DelChannelResponseType "/>
top

Element: DelPublicNoRequest

Name DelPublicNoRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Delete public phone number: request
Logical Diagram
XML Instance Representation
<DelPublicNoRequest>
<ID> common:positiveInteger </ID> [1..*]

'Public phone number ID'

</DelPublicNoRequest>
Schema Component Representation
<xs:element name="DelPublicNoRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="ID" type=" common:positiveInteger " maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: DelPublicNoResponse

Name DelPublicNoResponse
Type messagesInfo:DelPublicNoResponseType
Nillable no
Abstract no
Documentation Delete public phone numbers: response
Logical Diagram
XML Instance Representation
<DelPublicNoResponse>
<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'

</DelPublicNoResponse>
Schema Component Representation
<xs:element name="DelPublicNoResponse" type=" messagesInfo:DelPublicNoResponseType "/>
top

Element: EditCallRulesOutGroupRequest

Name EditCallRulesOutGroupRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Edit outgoing routing rules group (modify group name, status, change rules order, modify status for group rules) request
Logical Diagram
XML Instance Representation
<EditCallRulesOutGroupRequest>
<ID> common:positiveInteger </ID> [0..1]

'Outgoing routing rules group ID'

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

'Outgoing routing rules group name'

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

'Outgoing routing rules group status'

<ruleStatus> [0..*]

'Rule status'


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

'Outgoing routing rule ID'

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

'Outgoing routing rule status'

</ruleStatus>
<changeOrder> common:positiveInteger </changeOrder> [0..*]

'New order for the routing rules'

</EditCallRulesOutGroupRequest>
Schema Component Representation
<xs:element name="EditCallRulesOutGroupRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="ID" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="name" type=" common:string " minOccurs="0"/>
<xs:element name="status" type=" common:boolean " default="1" minOccurs="0"/>
<xs:element name="ruleStatus" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence>
<xs:element name="ruleID" type=" common:positiveInteger "/>
<xs:element name="status" type=" common:boolean " default="1"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="changeOrder" type=" common:positiveInteger " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: EditCallRulesOutGroupResponse

Name EditCallRulesOutGroupResponse
Type messagesInfo:UpdateCallRulesOutGroupResponseType
Nillable no
Abstract no
Documentation Edit outgoing routing rules group (modify group name, status, change rules order, modify status for group rules) response
Logical Diagram
XML Instance Representation
<EditCallRulesOutGroupResponse>
<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..*]
</EditCallRulesOutGroupResponse>
Schema Component Representation
<xs:element name="EditCallRulesOutGroupResponse" type=" messagesInfo:UpdateCallRulesOutGroupResponseType "/>
top

Element: EditChannelGroupRequest

Name EditChannelGroupRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Edit channel group: request
Logical Diagram
XML Instance Representation
<EditChannelGroupRequest>
<name> common:string </name> [0..1]

'Channel group name'

<notes> common:text </notes> [0..1]

'Channel group notes'

<channelID> common:positiveInteger </channelID> [0..*]

'Channels for the group'

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

'Channel group ID'

</EditChannelGroupRequest>
Schema Component Representation
<xs:element name="EditChannelGroupRequest">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" channelData:ChannelGroupInfo ">
<xs:sequence>
<xs:element name="ID" type=" common:positiveInteger "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: EditChannelGroupResponse

Name EditChannelGroupResponse
Type messagesInfo:UpdateChannelGroupResponseType
Nillable no
Abstract no
Documentation Edit channel group: response
Logical Diagram
XML Instance Representation
<EditChannelGroupResponse>
<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..*]
</EditChannelGroupResponse>
Schema Component Representation
<xs:element name="EditChannelGroupResponse" type=" messagesInfo:UpdateChannelGroupResponseType "/>
top

Element: EditChannelRequest

Name EditChannelRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Edit channel: request
Logical Diagram
XML Instance Representation
<EditChannelRequest>
<ID> common:positiveInteger </ID> [1]

'Channel ID'

Start Choice [1]

'Either of'
<SIP> channelData:SIPChannelInfo </SIP> [0..1]

'SIP channel'

End Choice
</EditChannelRequest>
Schema Component Representation
<xs:element name="EditChannelRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="ID" type=" common:positiveInteger "/>
<xs:choice>
<xs:element name="SIP" type=" channelData:SIPChannelInfo " minOccurs="0"/>
<xs:element name="Dahdi" minOccurs="0" maxOccurs="0"/>
<xs:element name="IAX" minOccurs="0" maxOccurs="0"/>
</xs:choice>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: EditChannelResponse

Name EditChannelResponse
Type messagesInfo:UpdateChannelResponseType
Nillable no
Abstract no
Documentation Edit channel: response
Logical Diagram
XML Instance Representation
<EditChannelResponse>
<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..*]
</EditChannelResponse>
Schema Component Representation
<xs:element name="EditChannelResponse" type=" messagesInfo:UpdateChannelResponseType "/>
top

Element: EditPublicNoRequest

Name EditPublicNoRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Edit public phone number: request
Logical Diagram
XML Instance Representation
<EditPublicNoRequest>
<phoneNo> common:string </phoneNo> [1]

'Public phone number'

<did> common:string </did> [1]

'DID (Direct Inward Dialing) number'

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

'Location'

<cost> common:float </cost> [0..1]

'Monthly amount paid to provider'

<incomingCost> [0..1]

'Incoming calls cost: {cost} money_unit every {interval} seconds'


<cost> common:float </cost> [0..1]
<interval> common:integer </interval> [0..1]
</incomingCost>
<type> xs:string (value comes from list: {'exclusive'|'stacked'}) </type> [0..1]

'Assignation method: stacked or exclusive'

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

'Public phone number ID'

</EditPublicNoRequest>
Schema Component Representation
<xs:element name="EditPublicNoRequest">
<xs:complexType>
<xs:complexContent>
<xs:extension base=" channelData:PublicNoInfo ">
<xs:sequence>
<xs:element name="didID" type=" common:positiveInteger "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: EditPublicNoResponse

Name EditPublicNoResponse
Type messagesInfo:EditPublicNoResponseType
Nillable no
Abstract no
Documentation Edit public phone number: response
Logical Diagram
XML Instance Representation
<EditPublicNoResponse>
<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..*]
</EditPublicNoResponse>
Schema Component Representation
<xs:element name="EditPublicNoResponse" type=" messagesInfo:EditPublicNoResponseType "/>
top

Element: GetCallRulesOutGroupRequest

Name GetCallRulesOutGroupRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Get outgoing routing rules group request
Logical Diagram
XML Instance Representation
<GetCallRulesOutGroupRequest>
<userID> common:positiveInteger </userID> [0..1]

'Routing rules group owner ID'

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

'1: enabled groups, 0: all groups. Default value: 0.'

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

'Filter outgoing call rules list by name'

</GetCallRulesOutGroupRequest>
Schema Component Representation
<xs:element name="GetCallRulesOutGroupRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="userID" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="status" type=" common:boolean " default="0" minOccurs="0"/>
<xs:element name="filter" type=" common:string " minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: GetCallRulesOutGroupResponse

Name GetCallRulesOutGroupResponse
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Get outgoing routing rules group response
Logical Diagram
XML Instance Representation
<GetCallRulesOutGroupResponse>
<userID> common:positiveInteger </userID> [1]

'User ID'

<rulesGroup> channelData:CallRulesOutGroupList </rulesGroup> [0..*]
<notice> common:notice </notice> [0..*]
</GetCallRulesOutGroupResponse>
Schema Component Representation
<xs:element name="GetCallRulesOutGroupResponse">
<xs:complexType>
<xs:complexContent></xs:complexContent>
</xs:complexType>
</xs:element>
top

Element: GetCallRulesOutRequest

Name GetCallRulesOutRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Get outgoing routing rule in a certain group request
Logical Diagram
XML Instance Representation
<GetCallRulesOutRequest>
<ID> common:positiveInteger </ID> [0..1]

'Outgoing routing rules group ID'

</GetCallRulesOutRequest>
Schema Component Representation
<xs:element name="GetCallRulesOutRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="ID" type=" common:positiveInteger " minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: GetCallRulesOutResponse

Name GetCallRulesOutResponse
Type messagesInfo:GetCallRulesOutResponseType
Nillable no
Abstract no
Documentation Get outgoing routing rule in a certain group response
Logical Diagram
XML Instance Representation
<GetCallRulesOutResponse>
<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..*]
<action> xs:string (value comes from list: {'block'|'transfer'|'process'|'portability'}) </action> [0..1]

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

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

'Portability engine'

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

'Time interval ID'

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

'Channel ID. Default: Best cost'

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

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

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

'Required for prefixOperation:replace, prefix.'

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

'For prefixOperation:substract only'

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

'For prefixOperation:substract only'

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

'For prefixOperation:add only'

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

'For prefixOperation:add only'

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

'Final transfer rule'

<position> common:unsignedInt </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>
</GetCallRulesOutResponse>
Schema Component Representation
<xs:element name="GetCallRulesOutResponse" type=" messagesInfo:GetCallRulesOutResponseType "/>
top

Element: GetChannelGroupPollRequest

Name GetChannelGroupPollRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Get channel available and assigned groups: request
Logical Diagram
XML Instance Representation
<GetChannelGroupPollRequest>
<channelID> common:positiveInteger </channelID> [1]

'Channel ID'

</GetChannelGroupPollRequest>
Schema Component Representation
<xs:element name="GetChannelGroupPollRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="channelID" type=" common:positiveInteger "/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: GetChannelGroupPollResponse

Name GetChannelGroupPollResponse
Type messagesInfo:GetGroupSelectionResponseType
Nillable no
Abstract no
Documentation Get channel available and assigned channnel groups:response
Logical Diagram
XML Instance Representation
<GetChannelGroupPollResponse>
<channelGroup> channelData:ChannelGroupSelection </channelGroup> [1]

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

<notice> common:notice </notice> [0..*]
</GetChannelGroupPollResponse>
Schema Component Representation
<xs:element name="GetChannelGroupPollResponse" type=" messagesInfo:GetGroupSelectionResponseType "/>
top

Element: GetChannelGroupsRequest

Name GetChannelGroupsRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Get channel groups request
Logical Diagram
XML Instance Representation
<GetChannelGroupsRequest>
<channelID> common:positiveInteger </channelID> [0..1]

'Channel ID'

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

'Filter channel group list by name or channel name'

</GetChannelGroupsRequest>
Schema Component Representation
<xs:element name="GetChannelGroupsRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="channelID" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="filter" type=" common:string " minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: GetChannelGroupsResponse

Name GetChannelGroupsResponse
Type messagesInfo:GetChannelGroupsResponseType
Nillable no
Abstract no
Documentation Get channel groups response
Logical Diagram
XML Instance Representation
<GetChannelGroupsResponse>
<group> channelData:ChannelGroupList </group> [0..*]

'Channel groups list on success'

<notice> common:notice </notice> [0..*]
</GetChannelGroupsResponse>
Schema Component Representation
<xs:element name="GetChannelGroupsResponse" type=" messagesInfo:GetChannelGroupsResponseType "/>
top

Element: GetChannelsRequest

Name GetChannelsRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Get channels: request
Logical Diagram
XML Instance Representation
<GetChannelsRequest>
<groupID> common:positiveInteger </groupID> [0..1]

'Channel group ID'

<enabled> common:boolean </enabled> [0..1]

'1: only enabled channels, 2: disabled channels, 0: all channels. Default: all'

<flow> xs:string (value comes from list: {'in'|'out'|'both'}) </flow> [0..1]

'Channel capabilities. Default both.'

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

'Filter channels list by name, login, hostname or channel group name.'

</GetChannelsRequest>
Schema Component Representation
<xs:element name="GetChannelsRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="groupID" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="enabled" type=" common:boolean " default="1" minOccurs="0"/>
<xs:element name="flow" default="both" minOccurs="0">
<xs:simpleType>
<xs:restriction base=" xs:string ">
<xs:enumeration value="in"/>
<xs:enumeration value="out"/>
<xs:enumeration value="both"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="filter" type=" common:string " minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: GetChannelsResponse

Name GetChannelsResponse
Type messagesInfo:GetChannelsResponseType
Nillable no
Abstract no
Documentation Get channels: response
Logical Diagram
XML Instance Representation
<GetChannelsResponse>
<channel> channelData:ChannelList </channel> [0..*]

'Channel data'

<notice> common:notice </notice> [0..*]
</GetChannelsResponse>
Schema Component Representation
<xs:element name="GetChannelsResponse" type=" messagesInfo:GetChannelsResponseType "/>
top

Element: GetCodecsRequest

Name GetCodecsRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Get the available codecs for channel setup: request
Logical Diagram
XML Instance Representation
<GetCodecsRequest>
<channelID> common:positiveInteger </channelID> [0..1]

'Channel ID'

</GetCodecsRequest>
Schema Component Representation
<xs:element name="GetCodecsRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="channelID" type=" common:positiveInteger " minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: GetCodecsResponse

Name GetCodecsResponse
Type messagesInfo:GetCodecsResponseType
Nillable no
Abstract no
Documentation Get the available codecs: response
Logical Diagram
XML Instance Representation
<GetCodecsResponse>
<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'

</GetCodecsResponse>
Schema Component Representation
<xs:element name="GetCodecsResponse" type=" messagesInfo:GetCodecsResponseType "/>
top

Element: GetPublicNoPollRequest

Name GetPublicNoPollRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Get user available and assigned public phone numbers: request
Logical Diagram
XML Instance Representation
<GetPublicNoPollRequest>
Start Choice [1]
<userID> common:positiveInteger </userID> [1]

'User ID'

<userIdentifier> common:string </userIdentifier> [1]

'User identifier'

End Choice
</GetPublicNoPollRequest>
Schema Component Representation
<xs:element name="GetPublicNoPollRequest">
<xs:complexType>
<xs:choice>
<xs:element name="userID" type=" common:positiveInteger "/>
<xs:element name="userIdentifier" type=" common:string "/>
</xs:choice>
</xs:complexType>
</xs:element>
top

Element: GetPublicNoPollResponse

Name GetPublicNoPollResponse
Type messagesInfo:GetNoSelectionResponseType
Nillable no
Abstract no
Documentation Get user available and assigned public phone numbers: response
Logical Diagram
XML Instance Representation
<GetPublicNoPollResponse>
<publicNo> channelData:PublicNoSelection </publicNo> [1]

'Available and assigned public phone numbers'

<notice> common:notice </notice> [0..*]
</GetPublicNoPollResponse>
Schema Component Representation
<xs:element name="GetPublicNoPollResponse" type=" messagesInfo:GetNoSelectionResponseType "/>
top

Element: GetPublicNoRequest

Name GetPublicNoRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Get public phone numbers: request
Logical Diagram
XML Instance Representation
<GetPublicNoRequest>
<channelID> common:positiveInteger </channelID> [1]

'Channel ID'

<inUse> common:boolean </inUse> [0..1]

'Usage filter. For unset numbers: 1'

<type> xs:string (value comes from list: {'exclusive'|'stacked'}) </type> [0..1]

'Assignation method: \'stacked\' or \'exclusive\'.'

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

'Filter public number list by external number, DID or callback extension'

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

'Client that uses the public phone number'

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

'Client (identifier) that uses the public phone number'

End Choice
</GetPublicNoRequest>
Schema Component Representation
<xs:element name="GetPublicNoRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="channelID" type=" common:positiveInteger "/>
<xs:element name="inUse" type=" common:boolean " default="0" minOccurs="0"/>
<xs:element name="type" minOccurs="0">
<xs:simpleType>
<xs:restriction base=" xs:string ">
<xs:enumeration value="exclusive"/>
<xs:enumeration value="stacked"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="filter" type=" common:string " minOccurs="0"/>
<xs:choice>
<xs:element name="userID" type=" common:positiveInteger " minOccurs="0"/>
<xs:element name="userIdentifier" type=" common:string " minOccurs="0"/>
</xs:choice>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: GetPublicNoResponse

Name GetPublicNoResponse
Type messagesInfo:GetPublicNoResponseType
Nillable no
Abstract no
Documentation Get public phone numbers: response
Logical Diagram
XML Instance Representation
<GetPublicNoResponse>
<publicNo> channelData:PublicNoList </publicNo> [0..*]
<notice> common:notice </notice> [0..*]
</GetPublicNoResponse>
Schema Component Representation
<xs:element name="GetPublicNoResponse" type=" messagesInfo:GetPublicNoResponseType "/>
top

Element: UnassignPublicNoRequest

Name UnassignPublicNoRequest
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Unassign available public phone numbers: request
Logical Diagram
XML Instance Representation
<UnassignPublicNoRequest>
<didID> common:positiveInteger </didID> [1..*]

'Public phone number ID'

Start Choice [1]
<userID> common:positiveInteger </userID> [1]

'User ID'

<userIdentifier> common:string </userIdentifier> [1]

'User identifier'

End Choice
</UnassignPublicNoRequest>
Schema Component Representation
<xs:element name="UnassignPublicNoRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="didID" type=" common:positiveInteger " maxOccurs="unbounded"/>
<xs:choice>
<xs:element name="userID" type=" common:positiveInteger "/>
<xs:element name="userIdentifier" type=" common:string "/>
</xs:choice>
</xs:sequence>
</xs:complexType>
</xs:element>
top

Element: UnassignPublicNoResponse

Name UnassignPublicNoResponse
Type messagesInfo:AssignPublicNoResponseType
Nillable no
Abstract no
Documentation Unassign available public phone numbers: response
Logical Diagram
XML Instance Representation
<UnassignPublicNoResponse>
<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..*]
</UnassignPublicNoResponse>
Schema Component Representation
<xs:element name="UnassignPublicNoResponse" type=" messagesInfo:AssignPublicNoResponseType "/>
top

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