Search K

Appearance

operations

Channel Operations ​

This section documents the API operations for Channel service.

AddChannel ​

AddChannel

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Add channel: request

Properties ​

PropertyValue
contentcomplex

Elements ​

ElementTypeDescription
typeinline (optional)Channel type: sip, dahdi, enum. Default value:
						sip |

| (choice) | | Either of | | └ SIP | channelData:SIPChannelInfo | SIP channel | | └ Dahdi | inline | Not available |

XSD Source ​

xml
<xs:element name="AddChannel">
  <xs:annotation>
    <xs:documentation>Add channel: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="type" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Channel type: sip, dahdi, enum. Default value:
							sip</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:choice>
          <xs:element name="SIP" type="channelData:SIPChannelInfo" minOccurs="0"/>
          <xs:element name="Dahdi" minOccurs="0"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>
AddChannelResponse

Type: common:updateObject

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Add channel: response

Properties ​

PropertyValue
contentcomplex

XSD Source ​

xml
<xs:element name="AddChannelResponse" type="common:updateObject">
  <xs:annotation>
    <xs:documentation>Add channel: response</xs:documentation>
  </xs:annotation>
</xs:element>

EditChannel ​

EditChannel

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Edit channel: request

Properties ​

PropertyValue
contentcomplex

Elements ​

ElementTypeDescription
common:IDcommon:IDChannel ID
(choice)Either of
└ SIPchannelData:SIPChannelInfoSIP channel
└ DahdiinlineNot available

XSD Source ​

xml
<xs:element name="EditChannel">
  <xs:annotation>
    <xs:documentation>Edit channel: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:ID" type="common:ID">
          <xs:annotation>
            <xs:documentation>Channel ID</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:choice>
          <xs:element name="SIP" type="channelData:SIPChannelInfo" minOccurs="0"/>
          <xs:element name="Dahdi" minOccurs="0"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>
EditChannelResponse

Type: common:updateObject

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Edit channel: response

Properties ​

PropertyValue
contentcomplex

XSD Source ​

xml
<xs:element name="EditChannelResponse" type="common:updateObject">
  <xs:annotation>
    <xs:documentation>Edit channel: response</xs:documentation>
  </xs:annotation>
</xs:element>

GetChannels ​

GetChannels

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Get channels: request

Properties ​

PropertyValue
contentcomplex

Elements ​

ElementTypeDescription
groupIDcommon:positiveInteger (optional)Channel group ID
enabledcommon:boolean (optional)1: only enabled channels, 2: disabled channels, 0: all
						channels. Default: all |

| channelData:flow | channelData:flow (optional) | | | common:filter | common:filter (optional) | Filter channels list by name, login, hostname or channel group name. |

XSD Source ​

xml
<xs:element name="GetChannels">
  <xs:annotation>
    <xs:documentation>Get channels: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="groupID" type="common:positiveInteger" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Channel group ID</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="enabled" type="common:boolean" minOccurs="0">
          <xs:annotation>
            <xs:documentation>1: only enabled channels, 2: disabled channels, 0: all
							channels. Default: all</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="channelData:flow" type="channelData:flow" minOccurs="0"/>
        <xs:element name="common:filter" type="common:filter" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Filter channels list by name, login, hostname or channel
							group name.</xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
</xs:element>
GetChannelsResponse

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Get channels: response

Properties ​

PropertyValue
contentcomplex

Elements ​

ElementTypeDescription
channelchannelData:ChannelList (0..*)Channel data
common:noticecommon:notice (0..*)

XSD Source ​

xml
<xs:element name="GetChannelsResponse">
  <xs:annotation>
    <xs:documentation>Get channels: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="channel" type="channelData:ChannelList" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>Channel data</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

DelChannel ​

DelChannel

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Delete channel: request

Properties ​

PropertyValue
contentcomplex

Elements ​

ElementTypeDescription
common:IDcommon:ID (1..*)Channel ID

XSD Source ​

xml
<xs:element name="DelChannel">
  <xs:annotation>
    <xs:documentation>Delete channel: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:ID" type="common:ID" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>Channel ID</xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
</xs:element>
DelChannelResponse

Type: common:delObject

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Delete channel: response

Properties ​

PropertyValue
contentcomplex

XSD Source ​

xml
<xs:element name="DelChannelResponse" type="common:delObject">
  <xs:annotation>
    <xs:documentation>Delete channel: response</xs:documentation>
  </xs:annotation>
</xs:element>

GetCodecs ​

GetCodecs

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Get the available codecs for channel setup: request

Properties ​

PropertyValue
contentcomplex

Elements ​

ElementTypeDescription
channelData:channelIDchannelData:channelID (optional)

XSD Source ​

xml
<xs:element name="GetCodecs">
  <xs:annotation>
    <xs:documentation>Get the available codecs for channel setup: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="channelData:channelID" type="channelData:channelID" minOccurs="0"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>
GetCodecsResponse

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Get the available codecs: response

Properties ​

PropertyValue
contentcomplex

Elements ​

ElementTypeDescription
codecsinline (optional)Codecs list
channelData:channelIDchannelData:channelID (optional)

XSD Source ​

xml
<xs:element name="GetCodecsResponse">
  <xs:annotation>
    <xs:documentation>Get the available codecs: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="codecs" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Codecs list</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="channelData:channelID" type="channelData:channelID" minOccurs="0"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

GetPublicNoPoll ​

GetPublicNoPoll

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Get user available and assigned public phone numbers: request

Properties ​

PropertyValue
contentcomplex

Elements ​

ElementTypeDescription
(choice)One of the following
└ common:extendedNumbercommon:extendedNumber
└ common:userIdentifiercommon:userIdentifier
└ common:userIDcommon:userID

XSD Source ​

xml
<xs:element name="GetPublicNoPoll">
  <xs:annotation>
    <xs:documentation>Get user available and assigned public phone numbers:
				request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:choice>
          <xs:element name="common:extendedNumber" type="common:extendedNumber"/>
          <xs:element name="common:userIdentifier" type="common:userIdentifier"/>
          <xs:element name="common:userID" type="common:userID"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>
GetPublicNoPollResponse

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Get user available and assigned public phone numbers: response

Properties ​

PropertyValue
contentcomplex

Elements ​

ElementTypeDescription
publicNochannelData:PublicNoSelectionAvailable and assigned public phone numbers
common:noticecommon:notice (0..*)

XSD Source ​

xml
<xs:element name="GetPublicNoPollResponse">
  <xs:annotation>
    <xs:documentation>Get user available and assigned public phone numbers:
				response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="publicNo" type="channelData:PublicNoSelection">
          <xs:annotation>
            <xs:documentation>Available and assigned public phone numbers</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

AssignPublicNo ​

AssignPublicNo

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Assign available public phone numbers: request

Properties ​

PropertyValue
contentcomplex

Elements ​

ElementTypeDescription
(choice)One of the following
└ common:userIDcommon:userID
└ common:userIdentifiercommon:userIdentifier
└ common:extendedNumbercommon:extendedNumber

XSD Source ​

xml
<xs:element name="AssignPublicNo">
  <xs:annotation>
    <xs:documentation>Assign available public phone numbers: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:choice>
          <xs:element name="common:userID" type="common:userID"/>
          <xs:element name="common:userIdentifier" type="common:userIdentifier"/>
          <xs:element name="common:extendedNumber" type="common:extendedNumber"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>
AssignPublicNoResponse

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Assign available public phone numbers: response

Properties ​

PropertyValue
contentcomplex

Elements ​

ElementTypeDescription
common:resultcommon:result (optional)
common:noticecommon:notice (0..*)
common:IDcommon:ID (0..*)

XSD Source ​

xml
<xs:element name="AssignPublicNoResponse">
  <xs:annotation>
    <xs:documentation>Assign available public phone numbers: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:result" type="common:result" minOccurs="0"/>
        <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
        <xs:element name="common:ID" type="common:ID" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

UnassignPublicNo ​

UnassignPublicNo

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Unassign available public phone numbers: request

Properties ​

PropertyValue
contentcomplex

Elements ​

ElementTypeDescription
didIDcommon:positiveInteger (1..*)Public phone number ID
(choice)One of the following
└ common:userIDcommon:userID
└ common:userIdentifiercommon:userIdentifier
└ common:extendedNumbercommon:extendedNumber

XSD Source ​

xml
<xs:element name="UnassignPublicNo">
  <xs:annotation>
    <xs:documentation>Unassign available public phone numbers: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="didID" type="common:positiveInteger" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>Public phone number ID</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:choice>
          <xs:element name="common:userID" type="common:userID"/>
          <xs:element name="common:userIdentifier" type="common:userIdentifier"/>
          <xs:element name="common:extendedNumber" type="common:extendedNumber"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>
UnassignPublicNoResponse

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Unassign available public phone numbers: response

Properties ​

PropertyValue
contentcomplex

Elements ​

ElementTypeDescription
common:resultcommon:result (optional)
common:noticecommon:notice (0..*)
(choice)One of the following
└ IDcommon:positiveIntegerObject ID
└ common:identifiercommon:identifier
└ common:extendedNumbercommon:extendedNumber

XSD Source ​

xml
<xs:element name="UnassignPublicNoResponse">
  <xs:annotation>
    <xs:documentation>Unassign available public phone numbers: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:result" type="common:result" minOccurs="0"/>
        <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
        <xs:choice>
          <xs:element name="ID" type="common:positiveInteger" minOccurs="0"/>
          <xs:element name="common:identifier" type="common:identifier" minOccurs="0"/>
          <xs:element name="common:extendedNumber" type="common:extendedNumber" minOccurs="0"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>

AddPublicNo ​

AddPublicNo

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Add public phone numbers: request

Properties ​

PropertyValue
contentcomplex

Elements ​

ElementTypeDescription
publicNoinline (1..10)

XSD Source ​

xml
<xs:element name="AddPublicNo">
  <xs:annotation>
    <xs:documentation>Add public phone numbers: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="publicNo" maxOccurs="10"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>
AddPublicNoResponse

Type: common:updateObject

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Add public phone numbers: response

Properties ​

PropertyValue
contentcomplex

XSD Source ​

xml
<xs:element name="AddPublicNoResponse" type="common:updateObject">
  <xs:annotation>
    <xs:documentation>Add public phone numbers: response</xs:documentation>
  </xs:annotation>
</xs:element>

EditPublicNo ​

EditPublicNo

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Edit public phone number: request

Properties ​

PropertyValue
contentcomplex

Extends ​

Base type: channelData:PublicNoInfo

Elements ​

ElementTypeDescription
didIDcommon:positiveIntegerPublic phone number ID

XSD Source ​

xml
<xs:element name="EditPublicNo">
  <xs:annotation>
    <xs:documentation>Edit public phone number: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="channelData:PublicNoInfo">
          <xs:sequence>
            <xs:element name="didID" type="common:positiveInteger">
              <xs:annotation>
                <xs:documentation>Public phone number ID</xs:documentation>
              </xs:annotation>
            </xs:element>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>
EditPublicNoResponse

Type: common:updateObject

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Edit public phone number: response

Properties ​

PropertyValue
contentcomplex

XSD Source ​

xml
<xs:element name="EditPublicNoResponse" type="common:updateObject">
  <xs:annotation>
    <xs:documentation>Edit public phone number: response</xs:documentation>
  </xs:annotation>
</xs:element>

GetPublicNo ​

GetPublicNo

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Get public phone numbers: request

Properties ​

PropertyValue
contentcomplex

Elements ​

ElementTypeDescription
channelData:channelIDchannelData:channelID
inUsecommon:boolean (optional)Usage filter. For unset numbers: 1
typeinline (optional)Assignation method: 'stacked' or
						'exclusive'. |

| common:filter | common:filter (optional) | Filter public number list by external number, DID or callback extension | | (choice) | | One of the following | | └ common:userID | common:userID | Client that uses the public phone number | | └ common:userIdentifier | common:userIdentifier | Client (identifier) that uses the public phone number | | └ common:extendedNumber | common:extendedNumber | |

XSD Source ​

xml
<xs:element name="GetPublicNo">
  <xs:annotation>
    <xs:documentation>Get public phone numbers: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="channelData:channelID" type="channelData:channelID"/>
        <xs:element name="inUse" type="common:boolean" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Usage filter. For unset numbers: 1</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="type" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Assignation method: 'stacked' or
							'exclusive'.</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:filter" type="common:filter" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Filter public number list by external number, DID or
							callback extension</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:choice>
          <xs:element name="common:userID" type="common:userID" minOccurs="0"/>
          <xs:element name="common:userIdentifier" type="common:userIdentifier" minOccurs="0"/>
          <xs:element name="common:extendedNumber" type="common:extendedNumber" minOccurs="0"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>
GetPublicNoResponse

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Get public phone numbers: response

Properties ​

PropertyValue
contentcomplex

Elements ​

ElementTypeDescription
publicNochannelData:PublicNoList (0..*)
common:noticecommon:notice (0..*)

XSD Source ​

xml
<xs:element name="GetPublicNoResponse">
  <xs:annotation>
    <xs:documentation>Get public phone numbers: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="publicNo" type="channelData:PublicNoList" minOccurs="0" maxOccurs="unbounded"/>
        <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

DelPublicNo ​

DelPublicNo

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Delete public phone number: request

Properties ​

PropertyValue
contentcomplex

Elements ​

ElementTypeDescription
common:IDcommon:ID (1..*)Public phone number ID

XSD Source ​

xml
<xs:element name="DelPublicNo">
  <xs:annotation>
    <xs:documentation>Delete public phone number: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:ID" type="common:ID" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>Public phone number ID</xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
</xs:element>
DelPublicNoResponse

Type: common:delObject

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Delete public phone numbers: response

Properties ​

PropertyValue
contentcomplex

XSD Source ​

xml
<xs:element name="DelPublicNoResponse" type="common:delObject">
  <xs:annotation>
    <xs:documentation>Delete public phone numbers: response</xs:documentation>
  </xs:annotation>
</xs:element>

AddChannelGroup ​

AddChannelGroup

Type: channelData:ChannelGroupInfo

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Add channel group: request

Properties ​

PropertyValue
contentcomplex

XSD Source ​

xml
<xs:element name="AddChannelGroup" type="channelData:ChannelGroupInfo">
  <xs:annotation>
    <xs:documentation>Add channel group: request</xs:documentation>
  </xs:annotation>
</xs:element>
AddChannelGroupResponse

Type: common:updateObject

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Add channel group: response

Properties ​

PropertyValue
contentcomplex

XSD Source ​

xml
<xs:element name="AddChannelGroupResponse" type="common:updateObject">
  <xs:annotation>
    <xs:documentation>Add channel group: response</xs:documentation>
  </xs:annotation>
</xs:element>

EditChannelGroup ​

EditChannelGroup

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Edit channel group: request

Properties ​

PropertyValue
contentcomplex

Extends ​

Base type: channelData:ChannelGroupInfo

Elements ​

ElementTypeDescription
common:IDcommon:IDChannel group ID

XSD Source ​

xml
<xs:element name="EditChannelGroup">
  <xs:annotation>
    <xs:documentation>Edit channel group: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="channelData:ChannelGroupInfo">
          <xs:sequence>
            <xs:element name="common:ID" type="common:ID">
              <xs:annotation>
                <xs:documentation>Channel group ID</xs:documentation>
              </xs:annotation>
            </xs:element>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>
EditChannelGroupResponse

Type: common:updateObject

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Edit channel group: response

Properties ​

PropertyValue
contentcomplex

XSD Source ​

xml
<xs:element name="EditChannelGroupResponse" type="common:updateObject">
  <xs:annotation>
    <xs:documentation>Edit channel group: response</xs:documentation>
  </xs:annotation>
</xs:element>

GetChannelGroups ​

GetChannelGroups

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Get channel groups request

Properties ​

PropertyValue
contentcomplex

Elements ​

ElementTypeDescription
channelData:channelIDchannelData:channelID (optional)
filtercommon:string (optional)Filter channel group list by name or channel
						name |

XSD Source ​

xml
<xs:element name="GetChannelGroups">
  <xs:annotation>
    <xs:documentation>Get channel groups request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="channelData:channelID" type="channelData:channelID" minOccurs="0"/>
        <xs:element name="filter" type="common:string" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Filter channel group list by name or channel
							name</xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
</xs:element>
GetChannelGroupsResponse

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Get channel groups response

Properties ​

PropertyValue
contentcomplex

Elements ​

ElementTypeDescription
groupchannelData:ChannelGroupList (0..*)Channel groups list on success
common:noticecommon:notice (0..*)

XSD Source ​

xml
<xs:element name="GetChannelGroupsResponse">
  <xs:annotation>
    <xs:documentation>Get channel groups response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="group" type="channelData:ChannelGroupList" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>Channel groups list on success</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

DelChannelGroup ​

DelChannelGroup

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Delete channel group request

Properties ​

PropertyValue
contentcomplex

Elements ​

ElementTypeDescription
common:IDcommon:ID (1..*)

XSD Source ​

xml
<xs:element name="DelChannelGroup">
  <xs:annotation>
    <xs:documentation>Delete channel group request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:ID" type="common:ID" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>
DelChannelGroupResponse

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Delete channel group response

Properties ​

PropertyValue
contentcomplex

Extends ​

Base type: common:delObject

Elements ​

ElementTypeDescription
common:noticecommon:notice (0..*)

XSD Source ​

xml
<xs:element name="DelChannelGroupResponse">
  <xs:annotation>
    <xs:documentation>Delete channel group response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="common:delObject">
          <xs:sequence>
            <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>

GetChannelGroupPoll ​

GetChannelGroupPoll

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Get channel available and assigned groups: request

Properties ​

PropertyValue
contentcomplex

Elements ​

ElementTypeDescription
channelData:channelIDchannelData:channelID

XSD Source ​

xml
<xs:element name="GetChannelGroupPoll">
  <xs:annotation>
    <xs:documentation>Get channel available and assigned groups: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="channelData:channelID" type="channelData:channelID"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>
GetChannelGroupPollResponse

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Get channel available and assigned channnel groups:response

Properties ​

PropertyValue
contentcomplex

Elements ​

ElementTypeDescription
channelGroupchannelData:ChannelGroupSelectionA list with available and assigned channel groups on
						success |

| common:notice | common:notice (0..*) | |

XSD Source ​

xml
<xs:element name="GetChannelGroupPollResponse">
  <xs:annotation>
    <xs:documentation>Get channel available and assigned channnel
				groups:response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="channelGroup" type="channelData:ChannelGroupSelection">
          <xs:annotation>
            <xs:documentation>A list with available and assigned channel groups on
							success</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

AddCallRulesOutGroup ​

AddCallRulesOutGroup

Type: channelData:RoutingRuleGroupInfo

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Add outgoing routing rules group: request

Properties ​

PropertyValue
contentcomplex

XSD Source ​

xml
<xs:element name="AddCallRulesOutGroup" type="channelData:RoutingRuleGroupInfo">
  <xs:annotation>
    <xs:documentation>Add outgoing routing rules group: request</xs:documentation>
  </xs:annotation>
</xs:element>
AddCallRulesOutGroupResponse

Type: common:updateObject

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Add outgoing routing rules group: response

Properties ​

PropertyValue
contentcomplex

XSD Source ​

xml
<xs:element name="AddCallRulesOutGroupResponse" type="common:updateObject">
  <xs:annotation>
    <xs:documentation>Add outgoing routing rules group: response</xs:documentation>
  </xs:annotation>
</xs:element>

EditCallRulesOutGroup ​

EditCallRulesOutGroup

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Edit outgoing routing rules group (modify group name, status, change rules order, modify status for group rules) request

Properties ​

PropertyValue
contentcomplex

Elements ​

ElementTypeDescription
IDcommon:positiveInteger (optional)Outgoing routing rules group ID
namecommon:string (optional)Outgoing routing rules group name
statuscommon:boolean (optional)Outgoing routing rules group status
ruleStatusinline (0..*)Rule status
changeOrdercommon:positiveInteger (0..*)New order for the routing rules

XSD Source ​

xml
<xs:element name="EditCallRulesOutGroup">
  <xs:annotation>
    <xs:documentation>Edit outgoing routing rules group (modify group name, status, change
				rules order, modify status for group rules) request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="ID" type="common:positiveInteger" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Outgoing routing rules group ID</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="name" type="common:string" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Outgoing routing rules group name</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="status" type="common:boolean" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Outgoing routing rules group status</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="ruleStatus" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>Rule status</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="changeOrder" type="common:positiveInteger" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>New order for the routing rules</xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
</xs:element>
EditCallRulesOutGroupResponse

Type: common:updateObject

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Edit outgoing routing rules group (modify group name, status, change rules order, modify status for group rules) response

Properties ​

PropertyValue
contentcomplex

XSD Source ​

xml
<xs:element name="EditCallRulesOutGroupResponse" type="common:updateObject">
  <xs:annotation>
    <xs:documentation>Edit outgoing routing rules group (modify group name, status, change
				rules order, modify status for group rules) response</xs:documentation>
  </xs:annotation>
</xs:element>

GetCallRulesOutGroup ​

GetCallRulesOutGroup

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Get outgoing routing rules group request

Properties ​

PropertyValue
contentcomplex

Elements ​

ElementTypeDescription
common:userIDcommon:userID (optional)Routing rules group owner ID
statuscommon:boolean (optional)1: enabled groups, 0: all groups. Default value:
						0. |

| common:filter | common:filter (optional) | Filter outgoing call rules list by name |

XSD Source ​

xml
<xs:element name="GetCallRulesOutGroup">
  <xs:annotation>
    <xs:documentation>Get outgoing routing rules group request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:userID" type="common:userID" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Routing rules group owner ID</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="status" type="common:boolean" minOccurs="0">
          <xs:annotation>
            <xs:documentation>1: enabled groups, 0: all groups. Default value:
							0.</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:filter" type="common:filter" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Filter outgoing call rules list by name</xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
</xs:element>
GetCallRulesOutGroupResponse

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Get outgoing routing rules group response

Properties ​

PropertyValue
contentcomplex

Elements ​

ElementTypeDescription
common:noticecommon:notice (0..*)

XSD Source ​

xml
<xs:element name="GetCallRulesOutGroupResponse">
  <xs:annotation>
    <xs:documentation>Get outgoing routing rules group response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

DelCallRulesOutGroup ​

DelCallRulesOutGroup

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Delete outgoing routing rules group request.

Properties ​

PropertyValue
contentcomplex

Elements ​

ElementTypeDescription
common:IDcommon:ID (1..*)Outgoing routing rule group ID

XSD Source ​

xml
<xs:element name="DelCallRulesOutGroup">
  <xs:annotation>
    <xs:documentation>Delete outgoing routing rules group request.</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:ID" type="common:ID" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>Outgoing routing rule group ID</xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
</xs:element>
DelCallRulesOutGroupResponse

Type: common:delObject

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Delete outgoing routing rules group response.

Properties ​

PropertyValue
contentcomplex

XSD Source ​

xml
<xs:element name="DelCallRulesOutGroupResponse" type="common:delObject">
  <xs:annotation>
    <xs:documentation>Delete outgoing routing rules group response.</xs:documentation>
  </xs:annotation>
</xs:element>

AddCallRulesOut ​

AddCallRulesOut

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Add group outgoing routing rule: request

Properties ​

PropertyValue
contentcomplex

Elements ​

ElementTypeDescription
common:IDcommon:ID (optional)Outgoing routing rules group ID
ruleschannelData:RoutingRuleInfo (1..*)

XSD Source ​

xml
<xs:element name="AddCallRulesOut">
  <xs:annotation>
    <xs:documentation>Add group outgoing routing rule: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:ID" type="common:ID" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Outgoing routing rules group ID</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="rules" type="channelData:RoutingRuleInfo" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>
AddCallRulesOutResponse

Type: common:updateObject

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Add group outgoing routing rule: response

Properties ​

PropertyValue
contentcomplex

XSD Source ​

xml
<xs:element name="AddCallRulesOutResponse" type="common:updateObject">
  <xs:annotation>
    <xs:documentation>Add group outgoing routing rule: response</xs:documentation>
  </xs:annotation>
</xs:element>

GetCallRulesOut ​

GetCallRulesOut

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Get outgoing routing rule in a certain group request

Properties ​

PropertyValue
contentcomplex

Elements ​

ElementTypeDescription
common:IDcommon:ID (optional)Outgoing routing rules group ID

XSD Source ​

xml
<xs:element name="GetCallRulesOut">
  <xs:annotation>
    <xs:documentation>Get outgoing routing rule in a certain group
				request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:ID" type="common:ID" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Outgoing routing rules group ID</xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
</xs:element>
GetCallRulesOutResponse

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Get outgoing routing rule in a certain group response

Properties ​

PropertyValue
contentcomplex

Elements ​

ElementTypeDescription
common:noticecommon:notice (0..*)

XSD Source ​

xml
<xs:element name="GetCallRulesOutResponse">
  <xs:annotation>
    <xs:documentation>Get outgoing routing rule in a certain group
				response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

DelCallRulesOut ​

DelCallRulesOut

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Delete outgoing routing rules request.

Properties ​

PropertyValue
contentcomplex

Elements ​

ElementTypeDescription
rulesGroupIDcommon:positiveInteger (optional)Outgoing routing rules group ID
common:IDcommon:ID (1..*)Outgoint routing rule ID

XSD Source ​

xml
<xs:element name="DelCallRulesOut">
  <xs:annotation>
    <xs:documentation>Delete outgoing routing rules request.</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="rulesGroupID" type="common:positiveInteger" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Outgoing routing rules group ID</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:ID" type="common:ID" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>Outgoint routing rule ID</xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
</xs:element>
DelCallRulesOutResponse

Type: common:delObject

Namespace: http://4psa.com/ChannelMessages.xsd/5.2.5

Description: Delete outgoing routing rules response.

Properties ​

PropertyValue
contentcomplex

XSD Source ​

xml
<xs:element name="DelCallRulesOutResponse" type="common:delObject">
  <xs:annotation>
    <xs:documentation>Delete outgoing routing rules response.</xs:documentation>
  </xs:annotation>
</xs:element>
Last updated: Dec 4, 2025