Skip to content
operations

Extension Operations

This section documents the API operations for Extension service.

AddExtension

AddExtension

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

Description: Add extension: request

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
extensionData:extensionNoextensionData:extensionNo (optional)
accountData:templateIDaccountData:templateID (optional)
extensionData:extensionTypeextensionData:extensionType (optional)
extensionData:labelextensionData:label
passwordAutocommon:boolean (optional)Password auto generation
extensionData:passwordextensionData:password (optional)
forceUpdatecommon:boolean (optional)Force user update on duplicate login (new login computed)
accountData:verboseaccountData:verbose (optional)
accountData:notifyOnlyaccountData:notifyOnly (optional)
otherNotifyEmailcommon:email (optional)
(choice)One of the following
└ accountData:parentIDaccountData:parentID
└ accountData:parentIdentifieraccountData:parentIdentifier
└ accountData:parentLoginaccountData:parentLogin

XSD Source

xml
<xs:element name="AddExtension">
  <xs:annotation>
    <xs:documentation>Add extension: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="extensionData:extensionNo" type="extensionData:extensionNo" minOccurs="0"/>
        <xs:element name="accountData:templateID" type="accountData:templateID" minOccurs="0"/>
        <xs:element name="extensionData:extensionType" type="extensionData:extensionType" minOccurs="0"/>
        <xs:element name="extensionData:label" type="extensionData:label"/>
        <xs:element name="passwordAuto" type="common:boolean" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Password auto generation</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="extensionData:password" type="extensionData:password" minOccurs="0"/>
        <xs:element name="forceUpdate" type="common:boolean" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Force user update on duplicate login (new login computed)</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="accountData:verbose" type="accountData:verbose" minOccurs="0"/>
        <xs:element name="accountData:notifyOnly" type="accountData:notifyOnly" minOccurs="0"/>
        <xs:element name="otherNotifyEmail" type="common:email" minOccurs="0"/>
        <xs:choice>
          <xs:element name="accountData:parentID" type="accountData:parentID" minOccurs="0"/>
          <xs:element name="accountData:parentIdentifier" type="accountData:parentIdentifier" minOccurs="0"/>
          <xs:element name="accountData:parentLogin" type="accountData:parentLogin" minOccurs="0"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>
AddExtensionResponse

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

Description: Add extension: response

Properties

PropertyValue
contentcomplex

Extends

Base type: extensionData:ExtendedExtensionInfo

Elements

ElementTypeDescription
extensionData:extensionTypeextensionData:extensionType (optional)
extensionData:extensionNoextensionData:extensionNo (optional)
common:resultcommon:result (optional)
common:noticecommon:notice (0..*)
accountData:templateaccountData:template (optional)
extensionData:passwordextensionData:password (optional)

XSD Source

xml
<xs:element name="AddExtensionResponse">
  <xs:annotation>
    <xs:documentation>Add extension: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="extensionData:ExtendedExtensionInfo">
          <xs:sequence>
            <xs:element name="extensionData:extensionType" type="extensionData:extensionType" minOccurs="0"/>
            <xs:element name="extensionData:extensionNo" type="extensionData:extensionNo" minOccurs="0"/>
            <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="accountData:template" type="accountData:template" minOccurs="0"/>
            <xs:element name="extensionData:password" type="extensionData:password" minOccurs="0"/>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>

EditExtension

EditExtension

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

Description: Edit extension: request

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
common:extendedNumbercommon:extendedNumber (optional)
extensionData:labelextensionData:label
passwordcommon:password (optional)User password
(choice)One of the following
└ accountData:fromUseraccountData:fromUser
└ accountData:fromUserIdentifieraccountData:fromUserIdentifier

XSD Source

xml
<xs:element name="EditExtension">
  <xs:annotation>
    <xs:documentation>Edit extension: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:extendedNumber" type="common:extendedNumber" minOccurs="0"/>
        <xs:element name="extensionData:label" type="extensionData:label"/>
        <xs:element name="password" type="common:password" minOccurs="0">
          <xs:annotation>
            <xs:documentation>User password</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:choice>
          <xs:element name="accountData:fromUser" type="accountData:fromUser" minOccurs="0"/>
          <xs:element name="accountData:fromUserIdentifier" type="accountData:fromUserIdentifier" minOccurs="0"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>
EditExtensionResponse

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

Description: Edit extension: response

Properties

PropertyValue
contentcomplex

Extends

Base type: common:updateExtensionObject

XSD Source

xml
<xs:element name="EditExtensionResponse">
  <xs:annotation>
    <xs:documentation>Edit extension: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="common:updateExtensionObject">
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>

GetExtensions

GetExtensions

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

Description: Get all extensions: request

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
extensionData:extensionTypeextensionData:extensionType (optional)
accountData:templateIDaccountData:templateID (optional)
common:filtercommon:filter (optional)Filter extension list name, company, email, login,
						number |

| (choice) | | One of the following | | └ accountData:parentID | accountData:parentID | | | └ accountData:parentIdentifier | accountData:parentIdentifier | |

XSD Source

xml
<xs:element name="GetExtensions">
  <xs:annotation>
    <xs:documentation>Get all extensions: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="extensionData:extensionType" type="extensionData:extensionType" minOccurs="0"/>
        <xs:element name="accountData:templateID" type="accountData:templateID" minOccurs="0"/>
        <xs:element name="common:filter" type="common:filter" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Filter extension list name, company, email, login,
							number</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:choice>
          <xs:element name="accountData:parentID" type="accountData:parentID" minOccurs="0"/>
          <xs:element name="accountData:parentIdentifier" type="accountData:parentIdentifier" minOccurs="0"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>
GetExtensionsResponse

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

Description: Get all extensions: response

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
extensionextensionData:ExtensionList (0..*)Extension data on succes
common:noticecommon:notice (0..*)

XSD Source

xml
<xs:element name="GetExtensionsResponse">
  <xs:annotation>
    <xs:documentation>Get all extensions: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="extension" type="extensionData:ExtensionList" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>Extension data on succes</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

GetExtensionDetails

GetExtensionDetails

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

Description: Get details extension data: request

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
common:extendedNumbercommon:extendedNumber

XSD Source

xml
<xs:element name="GetExtensionDetails">
  <xs:annotation>
    <xs:documentation>Get details extension data: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:extendedNumber" type="common:extendedNumber" minOccurs="1"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>
GetExtensionDetailsResponse

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

Description: Get detailed extension data: response

Properties

PropertyValue
contentcomplex

Extends

Base type: extensionData:ExtendedExtensionInfo

Elements

ElementTypeDescription
extensionData:extensionTypeextensionData:extensionType (optional)
extensionData:extensionNoextensionData:extensionNo (optional)

XSD Source

xml
<xs:element name="GetExtensionDetailsResponse">
  <xs:annotation>
    <xs:documentation>Get detailed extension data: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="extensionData:ExtendedExtensionInfo">
          <xs:sequence>
            <xs:element name="extensionData:extensionType" type="extensionData:extensionType" minOccurs="0"/>
            <xs:element name="extensionData:extensionNo" type="extensionData:extensionNo" minOccurs="0"/>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>

DelExtension

DelExtension

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

Description: Delete extensions: request

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
common:extendedNumbercommon:extendedNumber (1..*)

XSD Source

xml
<xs:element name="DelExtension">
  <xs:annotation>
    <xs:documentation>Delete extensions: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:extendedNumber" type="common:extendedNumber" minOccurs="1" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>
DelExtensionResponse

Type: common:delObject

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

Description: Delete extensions: response

Properties

PropertyValue
contentcomplex

XSD Source

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

SetSIPPreferences

SetSIPPreferences

Type: extensionData:SIPPreferencesInfo

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

Description: Set phone terminal SIP preferences: request

Properties

PropertyValue
contentcomplex

XSD Source

xml
<xs:element name="SetSIPPreferences" type="extensionData:SIPPreferencesInfo">
  <xs:annotation>
    <xs:documentation>Set phone terminal SIP preferences: request</xs:documentation>
  </xs:annotation>
</xs:element>
SetSIPPreferencesResponse

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

Description: Phone terminal SIP preferences: response

Properties

PropertyValue
contentcomplex

Elements

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

XSD Source

xml
<xs:element name="SetSIPPreferencesResponse">
  <xs:annotation>
    <xs:documentation>Phone terminal SIP preferences: 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:sequence>
    </xs:complexType>
</xs:element>

GetSIPPreferences

GetSIPPreferences

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

Description: Phone terminal SIP preferences: request

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
common:extendedNumbercommon:extendedNumber

XSD Source

xml
<xs:element name="GetSIPPreferences">
  <xs:annotation>
    <xs:documentation>Phone terminal SIP preferences: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:extendedNumber" type="common:extendedNumber" minOccurs="1"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>
GetSIPPreferencesResponse

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

Description: Phone terminal SIP preferences: response

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
dataextensionData:SIPPreferencesInfo (optional)
common:resultcommon:result (optional)
common:noticecommon:notice (0..*)

XSD Source

xml
<xs:element name="GetSIPPreferencesResponse">
  <xs:annotation>
    <xs:documentation>Phone terminal SIP preferences: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="data" type="extensionData:SIPPreferencesInfo" minOccurs="0"/>
        <xs:element name="common:result" type="common:result" minOccurs="0"/>
        <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

GetProvisionFile

GetProvisionFile

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

Description: Phone terminal provisioning file: request

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
common:extendedNumbercommon:extendedNumber

XSD Source

xml
<xs:element name="GetProvisionFile">
  <xs:annotation>
    <xs:documentation>Phone terminal provisioning file: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:extendedNumber" type="common:extendedNumber" minOccurs="1"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>
GetProvisionFileResponse

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

Description: Phone terminal provisioning file: response

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
extensionData:locationextensionData:location (0..*)
common:resultcommon:result (optional)
common:noticecommon:notice (0..*)

XSD Source

xml
<xs:element name="GetProvisionFileResponse">
  <xs:annotation>
    <xs:documentation>Phone terminal provisioning file: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="extensionData:location" type="extensionData:location" minOccurs="0" maxOccurs="unbounded"/>
        <xs:element name="common:result" type="common:result" minOccurs="0"/>
        <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

AddCallRulesIn

AddCallRulesIn

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

Description: Add incoming call rules: request

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
ruleextensionData:callRuleChoice (1..10)
common:extendedNumbercommon:extendedNumber

XSD Source

xml
<xs:element name="AddCallRulesIn">
  <xs:annotation>
    <xs:documentation>Add incoming call rules: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="rule" type="extensionData:callRuleChoice" maxOccurs="10"/>
        <xs:element name="common:extendedNumber" type="common:extendedNumber" minOccurs="1" maxOccurs="1"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>
AddCallRulesInResponse

Type: common:updateObject

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

Description: Add incoming call rules: response

Properties

PropertyValue
contentcomplex

XSD Source

xml
<xs:element name="AddCallRulesInResponse" type="common:updateObject">
  <xs:annotation>
    <xs:documentation>Add incoming call rules: response</xs:documentation>
  </xs:annotation>
</xs:element>

EditCallRulesIn

EditCallRulesIn

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

Description: Edit incoming call rules (change rule's order, modify status for group rules) request

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
ruleinline (0..*)
ordercommon:unsignedInt (0..*)Call rule order within incoming call rules group (List of
						rule IDs) |

| common:extendedNumber | common:extendedNumber (optional) | |

XSD Source

xml
<xs:element name="EditCallRulesIn">
  <xs:annotation>
    <xs:documentation>Edit incoming call rules (change rule's order, modify status for group rules) request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="rule" minOccurs="0" maxOccurs="unbounded"/>
        <xs:element name="order" type="common:unsignedInt" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>Call rule order within incoming call rules group (List of
							rule IDs)</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:extendedNumber" type="common:extendedNumber" minOccurs="0"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>
EditCallRulesInResponse

Type: common:updateObject

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

Description: Edit incoming call rules (change rule's order, modify status for group rules) response

Properties

PropertyValue
contentcomplex

XSD Source

xml
<xs:element name="EditCallRulesInResponse" type="common:updateObject">
  <xs:annotation>
    <xs:documentation>Edit incoming call rules (change rule's order, modify status for group
				rules) response</xs:documentation>
  </xs:annotation>
</xs:element>

GetCallRulesIn

GetCallRulesIn

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

Description: Get incoming call rules request

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
(choice)One of the following
└ common:extendedNumbercommon:extendedNumber

XSD Source

xml
<xs:element name="GetCallRulesIn">
  <xs:annotation>
    <xs:documentation>Get incoming call rules request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:choice>
          <xs:element name="common:extendedNumber" type="common:extendedNumber" minOccurs="1"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>
GetCallRulesInResponse

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

Description: Get incoming call rules list response

Properties

PropertyValue
contentcomplex

Elements

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

XSD Source

xml
<xs:element name="GetCallRulesInResponse">
  <xs:annotation>
    <xs:documentation>Get incoming call rules list 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>

DelCallRulesIn

DelCallRulesIn

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

Description: Delete incoming call rules: request

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
common:IDcommon:ID (1..*)Incoming call rule ID
common:extendedNumbercommon:extendedNumber (optional)

XSD Source

xml
<xs:element name="DelCallRulesIn">
  <xs:annotation>
    <xs:documentation>Delete incoming call rules: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:ID" type="common:ID" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>Incoming call rule ID</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:extendedNumber" type="common:extendedNumber" minOccurs="0"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>
DelCallRulesInResponse

Type: common:delObject

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

Description: Delete incoming call rules: response

Properties

PropertyValue
contentcomplex

XSD Source

xml
<xs:element name="DelCallRulesInResponse" type="common:delObject">
  <xs:annotation>
    <xs:documentation>Delete incoming call rules: response</xs:documentation>
  </xs:annotation>
</xs:element>

GetAvailableCallerID

GetAvailableCallerID

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

Description: Get list of available Caller-IDs: request

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
(choice)One of the following
└ common:extendedNumbercommon:extendedNumber

XSD Source

xml
<xs:element name="GetAvailableCallerID">
  <xs:annotation>
    <xs:documentation>Get list of available Caller-IDs: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:choice>
          <xs:element name="common:extendedNumber" type="common:extendedNumber" minOccurs="0"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>
GetAvailableCallerIDResponse

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

Description: Get list of available Caller-IDs response

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
CallerIDinline (0..*)Available Caller-ID
common:noticecommon:notice (0..*)

XSD Source

xml
<xs:element name="GetAvailableCallerIDResponse">
  <xs:annotation>
    <xs:documentation>Get list of available Caller-IDs response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="CallerID" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>Available Caller-ID</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

AddCardCode

AddCardCode

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

Description: Add calling card code: request

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
codeextensionData:CardCodeInfo (1..10)Calling card code
common:extendedNumbercommon:extendedNumber (optional)

XSD Source

xml
<xs:element name="AddCardCode">
  <xs:annotation>
    <xs:documentation>Add calling card code: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="code" type="extensionData:CardCodeInfo" maxOccurs="10">
          <xs:annotation>
            <xs:documentation>Calling card code</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:extendedNumber" type="common:extendedNumber" minOccurs="0"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>
AddCardCodeResponse

Type: common:updateObject

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

Description: Add calling card code: response

Properties

PropertyValue
contentcomplex

XSD Source

xml
<xs:element name="AddCardCodeResponse" type="common:updateObject">
  <xs:annotation>
    <xs:documentation>Add calling card code: response</xs:documentation>
  </xs:annotation>
</xs:element>

EditCardCode

EditCardCode

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

Description: Edit card code (modify status, code and PIN number): request

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
extensionData:codeextensionData:code (optional)
extensionData:PINextensionData:PIN (optional)
accountData:statusaccountData:status (optional)Calling card status
common:IDcommon:IDCalling card code ID

XSD Source

xml
<xs:element name="EditCardCode">
  <xs:annotation>
    <xs:documentation>Edit card code (modify status, code and PIN number):
				request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="extensionData:code" type="extensionData:code" minOccurs="0"/>
        <xs:element name="extensionData:PIN" type="extensionData:PIN" minOccurs="0"/>
        <xs:element name="accountData:status" type="accountData:status" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Calling card status</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:ID" type="common:ID">
          <xs:annotation>
            <xs:documentation>Calling card code ID</xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
</xs:element>
EditCardCodeResponse

Type: common:updateObject

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

Description: Edit calling card code: response

Properties

PropertyValue
contentcomplex

XSD Source

xml
<xs:element name="EditCardCodeResponse" type="common:updateObject">
  <xs:annotation>
    <xs:documentation>Edit calling card code: response</xs:documentation>
  </xs:annotation>
</xs:element>

GetCardCode

GetCardCode

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

Description: Get calling card code: request

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
(choice)Either of
└ common:IDcommon:IDCalling card code ID
└ common:filtercommon:filterFilter card codes list by code
└ common:extendedNumbercommon:extendedNumber

XSD Source

xml
<xs:element name="GetCardCode">
  <xs:annotation>
    <xs:documentation>Get calling card code: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:choice>
          <xs:element name="common:ID" type="common:ID" minOccurs="0"/>
          <xs:element name="common:filter" type="common:filter" minOccurs="0"/>
          <xs:element name="common:extendedNumber" type="common:extendedNumber" minOccurs="0"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>
GetCardCodeResponse

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

Description: Get calling card code: response

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
common:extendedNumbercommon:extendedNumber (optional)
codeextensionData:CardCodeList (0..*)

XSD Source

xml
<xs:element name="GetCardCodeResponse">
  <xs:annotation>
    <xs:documentation>Get calling card code: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:extendedNumber" type="common:extendedNumber" minOccurs="0"/>
        <xs:element name="code" type="extensionData:CardCodeList" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

DelCardCode

DelCardCode

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

Description: Delete calling card code: request

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
common:IDcommon:ID (1..*)Calling card code ID
common:extendedNumbercommon:extendedNumber (optional)

XSD Source

xml
<xs:element name="DelCardCode">
  <xs:annotation>
    <xs:documentation>Delete calling card code: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:ID" type="common:ID" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>Calling card code ID</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:extendedNumber" type="common:extendedNumber" minOccurs="0"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>
DelCardCodeResponse

Type: common:delObject

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

Description: Delete calling card code: response

Properties

PropertyValue
contentcomplex

XSD Source

xml
<xs:element name="DelCardCodeResponse" type="common:delObject">
  <xs:annotation>
    <xs:documentation>Delete calling card code: response</xs:documentation>
  </xs:annotation>
</xs:element>

AddCardCodeCredit

AddCardCodeCredit

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

Description: Add a calling card code credit: request

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
extensionData:codeCreditextensionData:codeCredit (1..*)
common:extendedNumbercommon:extendedNumber (optional)

XSD Source

xml
<xs:element name="AddCardCodeCredit">
  <xs:annotation>
    <xs:documentation>Add a calling card code credit: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="extensionData:codeCredit" type="extensionData:codeCredit" maxOccurs="unbounded"/>
        <xs:element name="common:extendedNumber" type="common:extendedNumber" minOccurs="0"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>
AddCardCodeCreditResponse

Type: common:updateObject

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

Description: Add a calling card code credit: response

Properties

PropertyValue
contentcomplex

XSD Source

xml
<xs:element name="AddCardCodeCreditResponse" type="common:updateObject">
  <xs:annotation>
    <xs:documentation>Add a calling card code credit: response</xs:documentation>
  </xs:annotation>
</xs:element>

GetCardCodeRecharges

GetCardCodeRecharges

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

Description: Get calling card code recharges history: request

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
common:IDcommon:IDCalling card code ID

XSD Source

xml
<xs:element name="GetCardCodeRecharges">
  <xs:annotation>
    <xs:documentation>Get calling card code recharges history: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:ID" type="common:ID">
          <xs:annotation>
            <xs:documentation>Calling card code ID</xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
</xs:element>
GetCardCodeRechargesResponse

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

Description: Get calling card code recharges history: response

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
codeIDcommon:positiveIntegerCalling card code ID
rechargeextensionData:RechargeInfo (0..*)Calling card code rechargement
common:noticecommon:notice (0..*)

XSD Source

xml
<xs:element name="GetCardCodeRechargesResponse">
  <xs:annotation>
    <xs:documentation>Get calling card code recharges history: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="codeID" type="common:positiveInteger">
          <xs:annotation>
            <xs:documentation>Calling card code ID</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="recharge" type="extensionData:RechargeInfo" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>Calling card code rechargement</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

AddAuthCallerID

AddAuthCallerID

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

Description: Add authorized CallerID to callback extension: request

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
CallerIDextensionData:CallerIDInfo (1..10)Authorized Caller-IDs
common:extendedNumbercommon:extendedNumber

XSD Source

xml
<xs:element name="AddAuthCallerID">
  <xs:annotation>
    <xs:documentation>Add authorized CallerID to callback extension:
				request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="CallerID" type="extensionData:CallerIDInfo" maxOccurs="10">
          <xs:annotation>
            <xs:documentation>Authorized Caller-IDs</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:extendedNumber" type="common:extendedNumber" minOccurs="1"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>
AddAuthCallerIDResponse

Type: common:updateObject

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

Description: Add authorized CallerID to callback extension: response

Properties

PropertyValue
contentcomplex

XSD Source

xml
<xs:element name="AddAuthCallerIDResponse" type="common:updateObject">
  <xs:annotation>
    <xs:documentation>Add authorized CallerID to callback extension:
				response</xs:documentation>
  </xs:annotation>
</xs:element>

EditAuthCallerID

EditAuthCallerID

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

Description: Edit authorized CallerID (modify status, Caller-ID and PIN number): request

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
common:IDcommon:IDAuthorized Caller ID record ID
extensionData:CallerIDextensionData:CallerID (optional)
extensionData:PINextensionData:PIN (optional)
accountData:statusaccountData:status (optional)Authorized caller ID status

XSD Source

xml
<xs:element name="EditAuthCallerID">
  <xs:annotation>
    <xs:documentation>Edit authorized CallerID (modify status, Caller-ID and PIN number):
				request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:ID" type="common:ID">
          <xs:annotation>
            <xs:documentation>Authorized Caller ID record ID</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="extensionData:CallerID" type="extensionData:CallerID" minOccurs="0"/>
        <xs:element name="extensionData:PIN" type="extensionData:PIN" minOccurs="0"/>
        <xs:element name="accountData:status" type="accountData:status" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Authorized caller ID status</xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
</xs:element>
EditAuthCallerIDResponse

Type: common:updateObject

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

Description: Edit authorized CallerID: response

Properties

PropertyValue
contentcomplex

XSD Source

xml
<xs:element name="EditAuthCallerIDResponse" type="common:updateObject">
  <xs:annotation>
    <xs:documentation>Edit authorized CallerID: response</xs:documentation>
  </xs:annotation>
</xs:element>

GetAuthCallerID

GetAuthCallerID

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

Description: Get authorized CallerID for callback extension: request

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
(choice)Either of
└ common:IDcommon:IDAuthorized Caller-ID record ID
└ common:filtercommon:filterFilter authorized CallerID list by
							Caller-ID |

| └ common:extendedNumber | common:extendedNumber | |

XSD Source

xml
<xs:element name="GetAuthCallerID">
  <xs:annotation>
    <xs:documentation>Get authorized CallerID for callback extension:
				request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:choice>
          <xs:element name="common:ID" type="common:ID" minOccurs="0"/>
          <xs:element name="common:filter" type="common:filter" minOccurs="0"/>
          <xs:element name="common:extendedNumber" type="common:extendedNumber" minOccurs="0"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>
GetAuthCallerIDResponse

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

Description: Get authorized CallerID for callback extension: response

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
CallerIDextensionData:CallerIDList (0..*)Authorized Caller ID
common:extendedNumbercommon:extendedNumber (optional)

XSD Source

xml
<xs:element name="GetAuthCallerIDResponse">
  <xs:annotation>
    <xs:documentation>Get authorized CallerID for callback extension:
				response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="CallerID" type="extensionData:CallerIDList" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>Authorized Caller ID</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:extendedNumber" type="common:extendedNumber" minOccurs="0"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

DelAuthCallerID

DelAuthCallerID

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

Description: Delete authorized CallerID from callback extension: request

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
IDcommon:positiveInteger (1..*)Authorized Caller-ID record ID
common:extendedNumbercommon:extendedNumber (optional)

XSD Source

xml
<xs:element name="DelAuthCallerID">
  <xs:annotation>
    <xs:documentation>Delete authorized CallerID from callback extension:
				request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="ID" type="common:positiveInteger" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>Authorized Caller-ID record ID</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:extendedNumber" type="common:extendedNumber" minOccurs="0"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>
DelAuthCallerIDResponse

Type: common:delObject

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

Description: Delete authorized CallerID from callback extension: response

Properties

PropertyValue
contentcomplex

XSD Source

xml
<xs:element name="DelAuthCallerIDResponse" type="common:delObject">
  <xs:annotation>
    <xs:documentation>Delete authorized CallerID from callback extension:
				response</xs:documentation>
  </xs:annotation>
</xs:element>

AddAuthCallerIDCredit

AddAuthCallerIDCredit

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

Description: Add authorized CallerID credit: request

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
CallerIDCreditextensionData:CreditInfo (1..*)
common:extendedNumbercommon:extendedNumber

XSD Source

xml
<xs:element name="AddAuthCallerIDCredit">
  <xs:annotation>
    <xs:documentation>Add authorized CallerID credit: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="CallerIDCredit" type="extensionData:CreditInfo" maxOccurs="unbounded"/>
        <xs:element name="common:extendedNumber" type="common:extendedNumber" minOccurs="1"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>
AddAuthCallerIDCreditResponse

Type: common:updateObject

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

Description: Add authorized CallerID credit: response

Properties

PropertyValue
contentcomplex

XSD Source

xml
<xs:element name="AddAuthCallerIDCreditResponse" type="common:updateObject">
  <xs:annotation>
    <xs:documentation>Add authorized CallerID credit: response</xs:documentation>
  </xs:annotation>
</xs:element>

GetAuthCallerIDRecharges

GetAuthCallerIDRecharges

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

Description: Get authorized CallerID recharges history: request

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
common:IDcommon:IDCaller-ID record ID

XSD Source

xml
<xs:element name="GetAuthCallerIDRecharges">
  <xs:annotation>
    <xs:documentation>Get authorized CallerID recharges history: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:ID" type="common:ID">
          <xs:annotation>
            <xs:documentation>Caller-ID record ID</xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
</xs:element>
GetAuthCallerIDRechargesResponse

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

Description: Get authorized CallerID recharges history: response

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
common:IDcommon:IDCaller-ID record ID
rechargeextensionData:RechargeInfo (0..*)

XSD Source

xml
<xs:element name="GetAuthCallerIDRechargesResponse">
  <xs:annotation>
    <xs:documentation>Get authorized CallerID recharges history: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:ID" type="common:ID">
          <xs:annotation>
            <xs:documentation>Caller-ID record ID</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="recharge" type="extensionData:RechargeInfo" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

SetupExtension

SetupExtension

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

Description: Set extension type parameters: request

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
common:extendedNumbercommon:extendedNumber (optional)
(choice)One of the following
└ phoneTerminalextensionData:PhoneTerminalPhone terminal extension
└ phoneQueueextensionData:PhoneQueueQueue extension
└ queueCenterextensionData:QueueCenterInfoQueue center extension
└ IVRinlineInteractive voice response
							extension |

| └ voicemailCenter | extensionData:VoicemailCenterInfo | Voicemail center extension | | └ conference | extensionData:ConferenceInfo | Conference extension | | └ callback | inline | Call callback extension | | └ callingCard | inline | Calling card extension | | └ intercomPaging | inline | Intercom/paging extension |

XSD Source

xml
<xs:element name="SetupExtension">
  <xs:annotation>
    <xs:documentation>Set extension type parameters: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:extendedNumber" type="common:extendedNumber" minOccurs="0"/>
        <xs:choice>
          <xs:element name="phoneTerminal" type="extensionData:PhoneTerminal" minOccurs="0"/>
          <xs:element name="phoneQueue" type="extensionData:PhoneQueue" minOccurs="0"/>
          <xs:element name="queueCenter" type="extensionData:QueueCenterInfo" minOccurs="0"/>
          <xs:element name="IVR" minOccurs="0"/>
          <xs:element name="voicemailCenter" type="extensionData:VoicemailCenterInfo" minOccurs="0"/>
          <xs:element name="conference" type="extensionData:ConferenceInfo" minOccurs="0"/>
          <xs:element name="callback" minOccurs="0"/>
          <xs:element name="callingCard" minOccurs="0"/>
          <xs:element name="intercomPaging" minOccurs="0"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>
SetupExtensionResponse

Type: common:updateExtensionObject

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

Description: Set extension type parameters: response

Properties

PropertyValue
contentcomplex

XSD Source

xml
<xs:element name="SetupExtensionResponse" type="common:updateExtensionObject">
  <xs:annotation>
    <xs:documentation>Set extension type parameters: response</xs:documentation>
  </xs:annotation>
</xs:element>

GetExtensionSettings

GetExtensionSettings

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

Description: Get extension type parameters: request

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
common:extendedNumbercommon:extendedNumber

XSD Source

xml
<xs:element name="GetExtensionSettings">
  <xs:annotation>
    <xs:documentation>Get extension type parameters: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:extendedNumber" type="common:extendedNumber" minOccurs="1"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>
GetExtensionSettingsResponse

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

Description: Get extension type parameters: response

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
common:extendedNumbercommon:extendedNumber (optional)
extensionData:extensionTypeextensionData:extensionType (optional)
(choice)One of the following
└ phoneTerminalextensionData:ExtendedPhoneTerminalPhone terminal extension
└ phoneQueueextensionData:ExtendedQueueQueue extension
└ IVRextensionData:IVRInteractive voice response
							extension |

| └ voicemailCenter | extensionData:VoicemailInfo | Voicemail center extension | | └ queueCenter | extensionData:QueueCenterInfo | Queue login center extension | | └ conference | extensionData:ConferenceInfo | Conference extension | | └ callback | inline | Call callback extension | | └ callingCard | inline | Calling card extension | | └ intercomPaging | inline | Intercom/paging extension |

XSD Source

xml
<xs:element name="GetExtensionSettingsResponse">
  <xs:annotation>
    <xs:documentation>Get extension type parameters: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:extendedNumber" type="common:extendedNumber" minOccurs="0"/>
        <xs:element name="extensionData:extensionType" type="extensionData:extensionType" minOccurs="0"/>
        <xs:choice>
          <xs:element name="phoneTerminal" type="extensionData:ExtendedPhoneTerminal" minOccurs="0"/>
          <xs:element name="phoneQueue" type="extensionData:ExtendedQueue" minOccurs="0"/>
          <xs:element name="IVR" type="extensionData:IVR" minOccurs="0"/>
          <xs:element name="voicemailCenter" type="extensionData:VoicemailInfo" minOccurs="0"/>
          <xs:element name="queueCenter" type="extensionData:QueueCenterInfo" minOccurs="0"/>
          <xs:element name="conference" type="extensionData:ConferenceInfo" minOccurs="0"/>
          <xs:element name="callback" minOccurs="0"/>
          <xs:element name="callingCard" minOccurs="0"/>
          <xs:element name="intercomPaging" minOccurs="0"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>

SetVoicemail

SetVoicemail

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

Description: Set voicemail parameters: request

Properties

PropertyValue
contentcomplex

Extends

Base type: extensionData:Voicemail

Elements

ElementTypeDescription
common:extendedNumbercommon:extendedNumber (optional)

XSD Source

xml
<xs:element name="SetVoicemail">
  <xs:annotation>
    <xs:documentation>Set voicemail parameters: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="extensionData:Voicemail">
          <xs:sequence>
            <xs:element name="common:extendedNumber" type="common:extendedNumber" minOccurs="0"/>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>
SetVoicemailResponse

Type: common:updateExtensionObject

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

Description: Set voicemail params: response

Properties

PropertyValue
contentcomplex

XSD Source

xml
<xs:element name="SetVoicemailResponse" type="common:updateExtensionObject">
  <xs:annotation>
    <xs:documentation>Set voicemail params: response</xs:documentation>
  </xs:annotation>
</xs:element>

GetVoicemailSettings

GetVoicemailSettings

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

Description: Get voicemail parameters:request

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
common:extendedNumbercommon:extendedNumber

XSD Source

xml
<xs:element name="GetVoicemailSettings">
  <xs:annotation>
    <xs:documentation>Get voicemail parameters:request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:extendedNumber" type="common:extendedNumber" minOccurs="1"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>
GetVoicemailSettingsResponse

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

Description: Get voicemail parameters:request

Properties

PropertyValue
contentcomplex

Extends

Base type: extensionData:Voicemail

Elements

ElementTypeDescription
common:extendedNumbercommon:extendedNumber (optional)

XSD Source

xml
<xs:element name="GetVoicemailSettingsResponse">
  <xs:annotation>
    <xs:documentation>Get voicemail parameters:request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="extensionData:Voicemail">
          <xs:sequence>
            <xs:element name="common:extendedNumber" type="common:extendedNumber" minOccurs="0"/>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>

SetConference

SetConference

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

Description: Set conference parameters: request

Properties

PropertyValue
contentcomplex

Extends

Base type: extensionData:Conference

Elements

ElementTypeDescription
common:extendedNumbercommon:extendedNumber (optional)

XSD Source

xml
<xs:element name="SetConference">
  <xs:annotation>
    <xs:documentation>Set conference parameters: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="extensionData:Conference">
          <xs:sequence>
            <xs:element name="common:extendedNumber" type="common:extendedNumber" minOccurs="0"/>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>
SetConferenceResponse

Type: common:updateExtensionObject

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

Description: Set conference parameters: response

Properties

PropertyValue
contentcomplex

XSD Source

xml
<xs:element name="SetConferenceResponse" type="common:updateExtensionObject">
  <xs:annotation>
    <xs:documentation>Set conference parameters: response</xs:documentation>
  </xs:annotation>
</xs:element>

GetConferenceSettings

GetConferenceSettings

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

Description: Get conference parameters: request

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
common:extendedNumbercommon:extendedNumber

XSD Source

xml
<xs:element name="GetConferenceSettings">
  <xs:annotation>
    <xs:documentation>Get conference parameters: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:extendedNumber" type="common:extendedNumber" minOccurs="1"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>
GetConferenceSettingsResponse

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

Description: Get conference parameters: request

Properties

PropertyValue
contentcomplex

Extends

Base type: extensionData:Conference

Elements

ElementTypeDescription
common:extendedNumbercommon:extendedNumber (optional)

XSD Source

xml
<xs:element name="GetConferenceSettingsResponse">
  <xs:annotation>
    <xs:documentation>Get conference parameters: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="extensionData:Conference">
          <xs:sequence>
            <xs:element name="common:extendedNumber" type="common:extendedNumber" minOccurs="0"/>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>

SetCallRecording

SetCallRecording

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

Description: Set call recording parameters: request

Properties

PropertyValue
contentcomplex

Extends

Base type: extensionData:CallRecording

Elements

ElementTypeDescription
common:extendedNumbercommon:extendedNumber (optional)

XSD Source

xml
<xs:element name="SetCallRecording">
  <xs:annotation>
    <xs:documentation>Set call recording parameters: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="extensionData:CallRecording">
          <xs:sequence>
            <xs:element name="common:extendedNumber" type="common:extendedNumber" minOccurs="0"/>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>
SetCallRecordingResponse

Type: common:updateExtensionObject

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

Description: Set call recording parameters: response

Properties

PropertyValue
contentcomplex

XSD Source

xml
<xs:element name="SetCallRecordingResponse" type="common:updateExtensionObject">
  <xs:annotation>
    <xs:documentation>Set call recording parameters: response</xs:documentation>
  </xs:annotation>
</xs:element>

GetCallRecordingSettings

GetCallRecordingSettings

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

Description: Get call recording parameters: request

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
common:extendedNumbercommon:extendedNumber

XSD Source

xml
<xs:element name="GetCallRecordingSettings">
  <xs:annotation>
    <xs:documentation>Get call recording parameters: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:extendedNumber" type="common:extendedNumber" minOccurs="1"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>
GetCallRecordingSettingsResponse

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

Description: Get call recording parameters: response

Properties

PropertyValue
contentcomplex

Extends

Base type: extensionData:CallRecording

Elements

ElementTypeDescription
common:extendedNumbercommon:extendedNumber (optional)

XSD Source

xml
<xs:element name="GetCallRecordingSettingsResponse">
  <xs:annotation>
    <xs:documentation>Get call recording parameters: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="extensionData:CallRecording">
          <xs:sequence>
            <xs:element name="common:extendedNumber" type="common:extendedNumber" minOccurs="0"/>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>

SetFaxCenter

SetFaxCenter

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

Description: Set fax center parameters: request

Properties

PropertyValue
contentcomplex

Extends

Base type: extensionData:FaxCenter

Elements

ElementTypeDescription
common:extendedNumbercommon:extendedNumber (optional)

XSD Source

xml
<xs:element name="SetFaxCenter">
  <xs:annotation>
    <xs:documentation>Set fax center parameters: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="extensionData:FaxCenter">
          <xs:sequence>
            <xs:element name="common:extendedNumber" type="common:extendedNumber" minOccurs="0"/>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>
SetFaxCenterResponse

Type: common:updateObject

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

Description: Set conference parameters: response

Properties

PropertyValue
contentcomplex

XSD Source

xml
<xs:element name="SetFaxCenterResponse" type="common:updateObject">
  <xs:annotation>
    <xs:documentation>Set conference parameters: response</xs:documentation>
  </xs:annotation>
</xs:element>

GetFaxCenterSettings

GetFaxCenterSettings

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

Description: Get fax center parameters: request

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
common:extendedNumbercommon:extendedNumber

XSD Source

xml
<xs:element name="GetFaxCenterSettings">
  <xs:annotation>
    <xs:documentation>Get fax center parameters: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:extendedNumber" type="common:extendedNumber" minOccurs="1"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>
GetFaxCenterSettingsResponse

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

Description: Get fax center parameters: response

Properties

PropertyValue
contentcomplex

Extends

Base type: extensionData:FaxCenter

Elements

ElementTypeDescription
common:extendedNumbercommon:extendedNumber (optional)

XSD Source

xml
<xs:element name="GetFaxCenterSettingsResponse">
  <xs:annotation>
    <xs:documentation>Get fax center parameters: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="extensionData:FaxCenter">
          <xs:sequence>
            <xs:element name="common:extendedNumber" type="common:extendedNumber" minOccurs="0"/>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>

AssignQueueAgent

AssignQueueAgent

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

Description: Assign queue agent: request

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
common:extendedNumbercommon:extendedNumber
extensionData:agentExtendedNumberextensionData:agentExtendedNumber
extensionData:penaltyextensionData:penalty (optional)
extensionData:supervisorextensionData:supervisor (optional)
extensionData:authextensionData:auth (optional)
PINcommon:string (optional)Queue login PIN

XSD Source

xml
<xs:element name="AssignQueueAgent">
  <xs:annotation>
    <xs:documentation>Assign queue agent: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:extendedNumber" type="common:extendedNumber" minOccurs="1"/>
        <xs:element name="extensionData:agentExtendedNumber" type="extensionData:agentExtendedNumber"/>
        <xs:element name="extensionData:penalty" type="extensionData:penalty" minOccurs="0"/>
        <xs:element name="extensionData:supervisor" type="extensionData:supervisor" minOccurs="0"/>
        <xs:element name="extensionData:auth" type="extensionData:auth" minOccurs="0"/>
        <xs:element name="PIN" type="common:string" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Queue login PIN</xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
</xs:element>
AssignQueueAgentResponse

Type: common:updateExtensionObject

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

Description: Assign queue agent: response

Properties

PropertyValue
contentcomplex

XSD Source

xml
<xs:element name="AssignQueueAgentResponse" type="common:updateExtensionObject">
  <xs:annotation>
    <xs:documentation>Assign queue agent: response</xs:documentation>
  </xs:annotation>
</xs:element>

UnassignQueueAgent

UnassignQueueAgent

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

Description: Unassign queue agent: request

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
common:extendedNumbercommon:extendedNumber (1..*)
extensionData:queueExtendedNumberextensionData:queueExtendedNumber

XSD Source

xml
<xs:element name="UnassignQueueAgent">
  <xs:annotation>
    <xs:documentation>Unassign queue agent: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:extendedNumber" type="common:extendedNumber" minOccurs="1" maxOccurs="unbounded"/>
        <xs:element name="extensionData:queueExtendedNumber" type="extensionData:queueExtendedNumber"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>
UnassignQueueAgentResponse

Type: common:updateExtensionObject

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

Description: Unassign queue agent: response

Properties

PropertyValue
contentcomplex

XSD Source

xml
<xs:element name="UnassignQueueAgentResponse" type="common:updateExtensionObject">
  <xs:annotation>
    <xs:documentation>Unassign queue agent: response</xs:documentation>
  </xs:annotation>
</xs:element>

UnassignQueueRemoteAgent

UnassignQueueRemoteAgent

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

Description: Unassign queue remote agent: request

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
agentIDxs:decimal (1..*)
extensionData:queueExtendedNumberextensionData:queueExtendedNumber

XSD Source

xml
<xs:element name="UnassignQueueRemoteAgent">
  <xs:annotation>
    <xs:documentation>Unassign queue remote agent: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="agentID" type="xs:decimal" minOccurs="1" maxOccurs="unbounded"/>
        <xs:element name="extensionData:queueExtendedNumber" type="extensionData:queueExtendedNumber"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>
UnassignQueueRemoteAgentResponse

Type: common:updateExtensionObject

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

Description: Unassign queue remote agent: response

Properties

PropertyValue
contentcomplex

XSD Source

xml
<xs:element name="UnassignQueueRemoteAgentResponse" type="common:updateExtensionObject">
  <xs:annotation>
    <xs:documentation>Unassign queue remote agent: response</xs:documentation>
  </xs:annotation>
</xs:element>

SetQueueAgent

SetQueueAgent

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

Description: Set queue agent preferences: request

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
common:extendedNumbercommon:extendedNumber
extensionData:agentExtendedNumberextensionData:agentExtendedNumber (optional)
extensionData:supervisorextensionData:supervisor
extensionData:penaltyextensionData:penalty

XSD Source

xml
<xs:element name="SetQueueAgent">
  <xs:annotation>
    <xs:documentation>Set queue agent preferences: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:extendedNumber" type="common:extendedNumber"/>
        <xs:element name="extensionData:agentExtendedNumber" type="extensionData:agentExtendedNumber" minOccurs="0" maxOccurs="1"/>
        <xs:element name="extensionData:supervisor" type="extensionData:supervisor"/>
        <xs:element name="extensionData:penalty" type="extensionData:penalty"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>
SetQueueAgentResponse

Type: common:updateExtensionObject

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

Description: Set queue agent preferences: response

Properties

PropertyValue
contentcomplex

XSD Source

xml
<xs:element name="SetQueueAgentResponse" type="common:updateExtensionObject">
  <xs:annotation>
    <xs:documentation>Set queue agent preferences: response</xs:documentation>
  </xs:annotation>
</xs:element>

SetQueueMember

SetQueueMember

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

Description: Set queue member preferences: request

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
common:extendedNumbercommon:extendedNumber
extensionData:authextensionData:auth
PINcommon:stringQueue login PIN

XSD Source

xml
<xs:element name="SetQueueMember">
  <xs:annotation>
    <xs:documentation>Set queue member preferences: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:extendedNumber" type="common:extendedNumber"/>
        <xs:element name="extensionData:auth" type="extensionData:auth"/>
        <xs:element name="PIN" type="common:string">
          <xs:annotation>
            <xs:documentation>Queue login PIN</xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
</xs:element>
SetQueueMemberResponse

Type: common:updateExtensionObject

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

Description: Set queue member preferences: response

Properties

PropertyValue
contentcomplex

XSD Source

xml
<xs:element name="SetQueueMemberResponse" type="common:updateExtensionObject">
  <xs:annotation>
    <xs:documentation>Set queue member preferences: response</xs:documentation>
  </xs:annotation>
</xs:element>

GetQueueAgents

GetQueueAgents

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

Description: Get queue agents list: request

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
common:extendedNumbercommon:extendedNumber
filterinline (optional)Filter agents by type: local, remote or all. Filter is
						default set to all in order to get all agents assigned to queue
						extension. |

XSD Source

xml
<xs:element name="GetQueueAgents">
  <xs:annotation>
    <xs:documentation>Get queue agents list: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:extendedNumber" type="common:extendedNumber" minOccurs="1" maxOccurs="1"/>
        <xs:element name="filter" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Filter agents by type: local, remote or all. Filter is
							default set to all in order to get all agents assigned to queue
							extension.</xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
</xs:element>
GetQueueAgentsResponse

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

Description: Get queue agents list: response

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
localAgentsinline (0..*)Local agents data on succes
common:noticecommon:notice (0..*)
remoteAgentsextensionData:RemoteAgent (0..*)Remote agents data on success

XSD Source

xml
<xs:element name="GetQueueAgentsResponse">
  <xs:annotation>
    <xs:documentation>Get queue agents list: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="localAgents" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>Local agents data on succes</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
        <xs:element name="remoteAgents" type="extensionData:RemoteAgent" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>Remote agents data on success</xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
</xs:element>

GetQueueMembership

GetQueueMembership

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

Description: Get queues for phone terminal membership: request

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
(choice)One of the following
└ common:extendedNumbercommon:extendedNumber

XSD Source

xml
<xs:element name="GetQueueMembership">
  <xs:annotation>
    <xs:documentation>Get queues for phone terminal membership: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:choice>
          <xs:element name="common:extendedNumber" type="common:extendedNumber"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>
GetQueueMembershipResponse

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

Description: Get queues for phone terminal membership: response

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
memberextensionData:QueueMember (0..*)Extension data on succes
common:noticecommon:notice (0..*)

XSD Source

xml
<xs:element name="GetQueueMembershipResponse">
  <xs:annotation>
    <xs:documentation>Get queues for phone terminal membership: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="member" type="extensionData:QueueMember" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>Extension data on succes</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

AssignQueueRemoteAgent

AssignQueueRemoteAgent

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

Description: Assign queue remote agent: request

Properties

PropertyValue
contentcomplex

Extends

Base type: extensionData:RemoteAgent

Elements

ElementTypeDescription
PINcommon:string (optional)PIN
extensionData:authextensionData:auth (optional)Require authorization before connecting to
								queue |

| common:extendedNumber | common:extendedNumber | |

XSD Source

xml
<xs:element name="AssignQueueRemoteAgent">
  <xs:annotation>
    <xs:documentation>Assign queue remote agent: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="extensionData:RemoteAgent">
          <xs:sequence>
            <xs:element name="PIN" type="common:string" minOccurs="0">
              <xs:annotation>
                <xs:documentation>PIN</xs:documentation>
              </xs:annotation>
            </xs:element>
            <xs:element name="extensionData:auth" type="extensionData:auth" minOccurs="0">
              <xs:annotation>
                <xs:documentation>Require authorization before connecting to
									queue</xs:documentation>
              </xs:annotation>
            </xs:element>
            <xs:element name="common:extendedNumber" type="common:extendedNumber"/>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>
AssignQueueRemoteAgentResponse

Type: common:updateExtensionObject

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

Description: Assign queue remote agent: response

Properties

PropertyValue
contentcomplex

XSD Source

xml
<xs:element name="AssignQueueRemoteAgentResponse" type="common:updateExtensionObject">
  <xs:annotation>
    <xs:documentation>Assign queue remote agent: response</xs:documentation>
  </xs:annotation>
</xs:element>

SetQueueRemoteAgent

SetQueueRemoteAgent

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

Description: Set queue remote agent preferences: request

Properties

PropertyValue
contentcomplex

Extends

Base type: extensionData:RemoteAgent

Elements

ElementTypeDescription
common:extendedNumbercommon:extendedNumber
extensionData:authextensionData:auth (optional)
PINcommon:string (optional)PIN

XSD Source

xml
<xs:element name="SetQueueRemoteAgent">
  <xs:annotation>
    <xs:documentation>Set queue remote agent preferences: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="extensionData:RemoteAgent">
          <xs:sequence>
            <xs:element name="common:extendedNumber" type="common:extendedNumber"/>
            <xs:element name="extensionData:auth" type="extensionData:auth" minOccurs="0"/>
            <xs:element name="PIN" type="common:string" minOccurs="0">
              <xs:annotation>
                <xs:documentation>PIN</xs:documentation>
              </xs:annotation>
            </xs:element>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>
SetQueueRemoteAgentResponse

Type: common:updateExtensionObject

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

Description: Set queue remote agent preferences: response

Properties

PropertyValue
contentcomplex

XSD Source

xml
<xs:element name="SetQueueRemoteAgentResponse" type="common:updateExtensionObject">
  <xs:annotation>
    <xs:documentation>Set queue remote agent preferences: response</xs:documentation>
  </xs:annotation>
</xs:element>

AddScheduledConference

AddScheduledConference

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

Description: Add scheduled conference: request

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
scheduleextensionData:ScheduledConference
common:extendedNumbercommon:extendedNumber

XSD Source

xml
<xs:element name="AddScheduledConference">
  <xs:annotation>
    <xs:documentation>Add scheduled conference: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="schedule" type="extensionData:ScheduledConference"/>
        <xs:element name="common:extendedNumber" type="common:extendedNumber"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>
AddScheduledConferenceResponse

Type: extensionData:updateScheduledConfObject

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

Description: Add scheduled conference: response

Properties

PropertyValue
contentcomplex

XSD Source

xml
<xs:element name="AddScheduledConferenceResponse" type="extensionData:updateScheduledConfObject">
  <xs:annotation>
    <xs:documentation>Add scheduled conference: response</xs:documentation>
  </xs:annotation>
</xs:element>

EditScheduledConference

EditScheduledConference

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

Description: Edit scheduled conference: request

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
scheduleinline
common:extendedNumbercommon:extendedNumber

XSD Source

xml
<xs:element name="EditScheduledConference">
  <xs:annotation>
    <xs:documentation>Edit scheduled conference: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="schedule"/>
        <xs:element name="common:extendedNumber" type="common:extendedNumber"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>
EditScheduledConferenceResponse

Type: extensionData:updateScheduledConfObject

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

Description: Edit scheduled conference: response

Properties

PropertyValue
contentcomplex

XSD Source

xml
<xs:element name="EditScheduledConferenceResponse" type="extensionData:updateScheduledConfObject">
  <xs:annotation>
    <xs:documentation>Edit scheduled conference: response</xs:documentation>
  </xs:annotation>
</xs:element>

GetScheduledConferences

GetScheduledConferences

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

Description: Get scheduled conferences: request

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
common:extendedNumbercommon:extendedNumber
(choice)Either of
└ common:filtercommon:filterFilter scheduled conferences by name or ID
└ intervalinlineTime interval when the conferences were scheduled

XSD Source

xml
<xs:element name="GetScheduledConferences">
  <xs:annotation>
    <xs:documentation>Get scheduled conferences: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="common:extendedNumber" type="common:extendedNumber"/>
        <xs:choice>
          <xs:element name="common:filter" type="common:filter" minOccurs="0"/>
          <xs:element name="interval" minOccurs="0"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>
GetScheduledConferencesResponse

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

Description: Get scheduled conferences: response

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
scheduleinline (0..*)
common:extendedNumbercommon:extendedNumber (optional)
common:noticecommon:notice (0..*)

XSD Source

xml
<xs:element name="GetScheduledConferencesResponse">
  <xs:annotation>
    <xs:documentation>Get scheduled conferences: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="schedule" minOccurs="0" maxOccurs="unbounded"/>
        <xs:element name="common:extendedNumber" type="common:extendedNumber" minOccurs="0"/>
        <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

GetScheduledConferenceDetails

GetScheduledConferenceDetails

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

Description: Get scheduled conference details: request

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
conferenceNumbercommon:stringScheduled conference number
common:extendedNumbercommon:extendedNumber

XSD Source

xml
<xs:element name="GetScheduledConferenceDetails">
  <xs:annotation>
    <xs:documentation>Get scheduled conference details: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="conferenceNumber" type="common:string">
          <xs:annotation>
            <xs:documentation>Scheduled conference number</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:extendedNumber" type="common:extendedNumber"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>
GetScheduledConferenceDetailsResponse

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

Description: Get scheduled conference details: response

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
scheduleinline
common:extendedNumbercommon:extendedNumber
common:noticecommon:notice (0..*)

XSD Source

xml
<xs:element name="GetScheduledConferenceDetailsResponse">
  <xs:annotation>
    <xs:documentation>Get scheduled conference details: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="schedule"/>
        <xs:element name="common:extendedNumber" type="common:extendedNumber"/>
        <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

GetScheduledConferenceSessions

GetScheduledConferenceSessions

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

Description: Get scheduled conference sessions: request

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
startedxs:date (optional)Filter by the date when the scheduled session started
endedxs:date (optional)Filter by the date when the scheduled session ended
conferenceNumbercommon:stringScheduled conference number
common:extendedNumbercommon:extendedNumber

XSD Source

xml
<xs:element name="GetScheduledConferenceSessions">
  <xs:annotation>
    <xs:documentation>Get scheduled conference sessions: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="started" type="xs:date" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Filter by the date when the scheduled session started</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="ended" type="xs:date" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Filter by the date when the scheduled session ended</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="conferenceNumber" type="common:string">
          <xs:annotation>
            <xs:documentation>Scheduled conference number</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:extendedNumber" type="common:extendedNumber"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>
GetScheduledConferenceSessionsResponse

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

Description: Get scheduled conference sessions: response

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
scheduledSessionsextensionData:ScheduledConferenceSession (0..*)
conferenceNumbercommon:string (optional)Scheduled conference number
common:extendedNumbercommon:extendedNumber (optional)
common:noticecommon:notice (0..*)

XSD Source

xml
<xs:element name="GetScheduledConferenceSessionsResponse">
  <xs:annotation>
    <xs:documentation>Get scheduled conference sessions: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="scheduledSessions" type="extensionData:ScheduledConferenceSession" minOccurs="0" maxOccurs="unbounded"/>
        <xs:element name="conferenceNumber" type="common:string" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Scheduled conference number</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:extendedNumber" type="common:extendedNumber" minOccurs="0"/>
        <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

DelScheduledConference

DelScheduledConference

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

Description: Delete scheduled conference: request

Properties

PropertyValue
contentcomplex

Elements

ElementTypeDescription
conferenceNumbercommon:string (1..*)Scheduled conference number
common:extendedNumbercommon:extendedNumber (optional)

XSD Source

xml
<xs:element name="DelScheduledConference">
  <xs:annotation>
    <xs:documentation>Delete scheduled conference: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="conferenceNumber" type="common:string" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>Scheduled conference number</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:extendedNumber" type="common:extendedNumber" minOccurs="0"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>
DelScheduledConferenceResponse

Type: common:delObject

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

Description: Delete scheduled conference: response

Properties

PropertyValue
contentcomplex

XSD Source

xml
<xs:element name="DelScheduledConferenceResponse" type="common:delObject">
  <xs:annotation>
    <xs:documentation>Delete scheduled conference: response</xs:documentation>
  </xs:annotation>
</xs:element>

Last updated: Dec 4, 2025