Schema documentation for component SetupExtension

Namespace

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

Annotations

Set extension type parameters: request

Diagram

Properties

content:

complex

Model

extendedNumber{0,1} , (phoneTerminal{0,1} | phoneQueue{0,1} | queueCenter{0,1} | IVR{0,1} | voicemailCenter{0,1} | conference{0,1} | callback{0,0} | callingCard{0,0} | intercomPaging{0,0})

Children

IVR, callback, callingCard, conference, extendedNumber, intercomPaging, phoneQueue, phoneTerminal, queueCenter, voicemailCenter

Instance

<SetupExtension xmlns="http://4psa.com/ExtensionMessages.xsd/5.2.5" xmlns:common="http://4psa.com/Common.xsd/5.2.5">
  <common:extendedNumber>{0,1}</common:extendedNumber>
  <phoneTerminal>{0,1}</phoneTerminal>
  <phoneQueue>{0,1}</phoneQueue>
  <queueCenter>{0,1}</queueCenter>
  <IVR>{0,1}</IVR>
  <voicemailCenter>{0,1}</voicemailCenter>
  <conference>{0,1}</conference>
  <callback>{0,0}</callback>
  <callingCard>{0,0}</callingCard>
  <intercomPaging>{0,0}</intercomPaging>
</SetupExtension>

Source

<xs:element name="SetupExtension">
  <xs:annotation>
    <xs:documentation>Set extension type parameters: request</xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="common:extendedNumber" minOccurs="0"/>
      <xs:choice>
        <xs:element name="phoneTerminal" type="extensionData:PhoneTerminal" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Phone terminal extension</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="phoneQueue" type="extensionData:PhoneQueue" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Queue extension</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="queueCenter" type="extensionData:QueueCenterInfo" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Queue center extension</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="IVR" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Interactive voice response
								extension</xs:documentation>
          </xs:annotation>
          <xs:complexType>
            <xs:complexContent>
              <xs:extension base="extensionData:IVR">
                <xs:sequence>
                  <xs:element name="cloneID" type="common:string" minOccurs="0">
                    <xs:annotation>
                      <xs:documentation>Clone IVR settings from extension
												ID</xs:documentation>
                    </xs:annotation>
                  </xs:element>
                </xs:sequence>
              </xs:extension>
            </xs:complexContent>
          </xs:complexType>
        </xs:element>
        <xs:element name="voicemailCenter" type="extensionData:VoicemailCenterInfo" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Voicemail center extension</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="conference" type="extensionData:ConferenceInfo" minOccurs="0">
          <xs:annotation>
            <xs:documentation>Conference extension</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="callback" minOccurs="0" maxOccurs="0">
          <xs:annotation>
            <xs:documentation>Call callback extension</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="callingCard" minOccurs="0" maxOccurs="0">
          <xs:annotation>
            <xs:documentation>Calling card extension</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="intercomPaging" minOccurs="0" maxOccurs="0">
          <xs:annotation>
            <xs:documentation>Intercom/paging extension</xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:choice>
    </xs:sequence>
  </xs:complexType>
</xs:element>

Namespace

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

Annotations

Phone terminal extension

Diagram

Type

PhoneTerminal

Type hierarchy

PhoneCallerIDInfo
- PhoneTerminal

Properties

content:	complex
minOccurs:	0

Model

Children

SIPIdentity, anonymous, block, callWaiting, callerIDInternal, callerIDOnTransfer, callerIDRefs, callerName, callerNumber, defaultCallerIDRef, dnd, dndSnd, dndSndActive, mohFolder, noAnswer, parkTimeout, phoneAccess, phoneAccessPassword, sendCallerID, sendCallerNo, virtualizationCode

Instance

<phoneTerminal xmlns="http://4psa.com/ExtensionMessages.xsd/5.2.5" xmlns:extensionData="http://4psa.com/ExtensionData.xsd/5.2.5">
  <extensionData:sendCallerID>{0,1}</extensionData:sendCallerID>
  <extensionData:callerName>{0,1}</extensionData:callerName>
  <extensionData:sendCallerNo>{0,1}</extensionData:sendCallerNo>
  <extensionData:callerNumber>{0,1}</extensionData:callerNumber>
  <extensionData:defaultCallerIDRef>{0,1}</extensionData:defaultCallerIDRef>
  <extensionData:callerIDRefs>{0,unbounded}</extensionData:callerIDRefs>
  <extensionData:anonymous>{0,1}</extensionData:anonymous>
  <extensionData:callerIDInternal>{0,1}</extensionData:callerIDInternal>
  <extensionData:callerIDOnTransfer>{0,1}</extensionData:callerIDOnTransfer>
  <extensionData:SIPIdentity>{0,1}</extensionData:SIPIdentity>
  <extensionData:mohFolder>{0,1}</extensionData:mohFolder>
  <extensionData:noAnswer>{0,1}</extensionData:noAnswer>
  <extensionData:parkTimeout>{0,1}</extensionData:parkTimeout>
  <extensionData:virtualizationCode>{0,1}</extensionData:virtualizationCode>
  <extensionData:callWaiting>{0,1}</extensionData:callWaiting>
  <extensionData:dnd>{0,1}</extensionData:dnd>
  <extensionData:dndSndActive>{0,1}</extensionData:dndSndActive>
  <extensionData:dndSnd>{0,1}</extensionData:dndSnd>
  <extensionData:phoneAccess>{0,1}</extensionData:phoneAccess>
  <extensionData:block>{0,1}</extensionData:block>
  <extensionData:phoneAccessPassword>{0,1}</extensionData:phoneAccessPassword>
</phoneTerminal>

Source

<xs:element name="phoneTerminal" type="extensionData:PhoneTerminal" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Phone terminal extension</xs:documentation>
  </xs:annotation>
</xs:element>

Namespace

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

Annotations

Queue extension

Diagram

Type

PhoneQueue

Type hierarchy

PhoneCallerIDInfo
- PhoneQueue

Properties

content:	complex
minOccurs:	0

Model

sendCallerID{0,1} , callerName{0,1} , sendCallerNo{0,1} , callerNumber{0,1} , defaultCallerIDRef{0,1} , callerIDRefs* , anonymous{0,1} , callerIDInternal{0,1} , callerIDOnTransfer{0,1} , SIPIdentity{0,1} , name{0,1} , size{0,1} , distribution{0,1} , waitFor{0,1} , service{0,1} , record{0,1} , recordStorage{0,1} , agentMaxRings{0,1} , callBetween{0,1} , delayFor{0,1} , pickupAnnounceSnd{0,1} , reportWaitTime{0,1} , restartTimer{0,1} , welcomeSndActive{0,1} , welcomeSnd{0,1} , announcePosition , announceHoldTime , announceWait , announceWaitMin{0,1} , announceWaitMax{0,1} , announcePosFreq{0,1} , periodicAnnounceFreq{0,1} , exitToExtension{0,1} , reconnect{0,1} , reconnectTime{0,1} , musicOnHoldFolder{0,1} , thereAreSnd{0,1} , holdTimeSnd{0,1} , youAreNextSnd{0,1} , thankYouSnd{0,1} , callsWaitingSnd{0,1} , reportHoldSnd{0,1} , periodicAnnounceSnd{0,1} , secondSnd{0,1} , minuteSnd{0,1} , timeoutStatus{0,1} , timeout{0,1} , timeoutParam{0,1} , allowCalls{0,1} , emptyStatus{0,1} , emptyTransfer{0,1} , dropCalls{0,1} , unavailableStatus{0,1} , unavailableTransfer{0,1} , disconnectSndActive{0,1} , disconnectSnd{0,1}

Children

SIPIdentity, agentMaxRings, allowCalls, announceHoldTime, announcePosFreq, announcePosition, announceWait, announceWaitMax, announceWaitMin, anonymous, callBetween, callerIDInternal, callerIDOnTransfer, callerIDRefs, callerName, callerNumber, callsWaitingSnd, defaultCallerIDRef, delayFor, disconnectSnd, disconnectSndActive, distribution, dropCalls, emptyStatus, emptyTransfer, exitToExtension, holdTimeSnd, minuteSnd, musicOnHoldFolder, name, periodicAnnounceFreq, periodicAnnounceSnd, pickupAnnounceSnd, reconnect, reconnectTime, record, recordStorage, reportHoldSnd, reportWaitTime, restartTimer, secondSnd, sendCallerID, sendCallerNo, service, size, thankYouSnd, thereAreSnd, timeout, timeoutParam, timeoutStatus, unavailableStatus, unavailableTransfer, waitFor, welcomeSnd, welcomeSndActive, youAreNextSnd

Instance

<phoneQueue xmlns="http://4psa.com/ExtensionMessages.xsd/5.2.5" xmlns:extensionData="http://4psa.com/ExtensionData.xsd/5.2.5">
  <extensionData:sendCallerID>{0,1}</extensionData:sendCallerID>
  <extensionData:callerName>{0,1}</extensionData:callerName>
  <extensionData:sendCallerNo>{0,1}</extensionData:sendCallerNo>
  <extensionData:callerNumber>{0,1}</extensionData:callerNumber>
  <extensionData:defaultCallerIDRef>{0,1}</extensionData:defaultCallerIDRef>
  <extensionData:callerIDRefs>{0,unbounded}</extensionData:callerIDRefs>
  <extensionData:anonymous>{0,1}</extensionData:anonymous>
  <extensionData:callerIDInternal>{0,1}</extensionData:callerIDInternal>
  <extensionData:callerIDOnTransfer>{0,1}</extensionData:callerIDOnTransfer>
  <extensionData:SIPIdentity>{0,1}</extensionData:SIPIdentity>
  <extensionData:name>{0,1}</extensionData:name>
  <extensionData:size unlimited="true">{0,1}</extensionData:size>
  <extensionData:distribution>{0,1}</extensionData:distribution>
  <extensionData:waitFor>{0,1}</extensionData:waitFor>
  <extensionData:service>{0,1}</extensionData:service>
  <extensionData:record>{0,1}</extensionData:record>
  <extensionData:recordStorage unlimited="true">{0,1}</extensionData:recordStorage>
  <extensionData:agentMaxRings>{0,1}</extensionData:agentMaxRings>
  <extensionData:callBetween>{0,1}</extensionData:callBetween>
  <extensionData:delayFor>{0,1}</extensionData:delayFor>
  <extensionData:pickupAnnounceSnd>{0,1}</extensionData:pickupAnnounceSnd>
  <extensionData:reportWaitTime>{0,1}</extensionData:reportWaitTime>
  <extensionData:restartTimer>{0,1}</extensionData:restartTimer>
  <extensionData:welcomeSndActive>{0,1}</extensionData:welcomeSndActive>
  <extensionData:welcomeSnd>{0,1}</extensionData:welcomeSnd>
  <extensionData:announcePosition>{1,1}</extensionData:announcePosition>
  <extensionData:announceHoldTime>{1,1}</extensionData:announceHoldTime>
  <extensionData:announceWait>{1,1}</extensionData:announceWait>
  <extensionData:announceWaitMin>{0,1}</extensionData:announceWaitMin>
  <extensionData:announceWaitMax>{0,1}</extensionData:announceWaitMax>
  <extensionData:announcePosFreq>{0,1}</extensionData:announcePosFreq>
  <extensionData:periodicAnnounceFreq>{0,1}</extensionData:periodicAnnounceFreq>
  <extensionData:exitToExtension>{0,1}</extensionData:exitToExtension>
  <extensionData:reconnect>{0,1}</extensionData:reconnect>
  <extensionData:reconnectTime>{0,1}</extensionData:reconnectTime>
  <extensionData:musicOnHoldFolder>{0,1}</extensionData:musicOnHoldFolder>
  <extensionData:thereAreSnd>{0,1}</extensionData:thereAreSnd>
  <extensionData:holdTimeSnd>{0,1}</extensionData:holdTimeSnd>
  <extensionData:youAreNextSnd>{0,1}</extensionData:youAreNextSnd>
  <extensionData:thankYouSnd>{0,1}</extensionData:thankYouSnd>
  <extensionData:callsWaitingSnd>{0,1}</extensionData:callsWaitingSnd>
  <extensionData:reportHoldSnd>{0,1}</extensionData:reportHoldSnd>
  <extensionData:periodicAnnounceSnd>{0,1}</extensionData:periodicAnnounceSnd>
  <extensionData:secondSnd>{0,1}</extensionData:secondSnd>
  <extensionData:minuteSnd>{0,1}</extensionData:minuteSnd>
  <extensionData:timeoutStatus>{0,1}</extensionData:timeoutStatus>
  <extensionData:timeout>{0,1}</extensionData:timeout>
  <extensionData:timeoutParam>{0,1}</extensionData:timeoutParam>
  <extensionData:allowCalls>{0,1}</extensionData:allowCalls>
  <extensionData:emptyStatus>{0,1}</extensionData:emptyStatus>
  <extensionData:emptyTransfer>{0,1}</extensionData:emptyTransfer>
  <extensionData:dropCalls>{0,1}</extensionData:dropCalls>
  <extensionData:unavailableStatus>{0,1}</extensionData:unavailableStatus>
  <extensionData:unavailableTransfer>{0,1}</extensionData:unavailableTransfer>
  <extensionData:disconnectSndActive>{0,1}</extensionData:disconnectSndActive>
  <extensionData:disconnectSnd>{0,1}</extensionData:disconnectSnd>
</phoneQueue>

Source

<xs:element name="phoneQueue" type="extensionData:PhoneQueue" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Queue extension</xs:documentation>
  </xs:annotation>
</xs:element>

Namespace

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

Annotations

Queue center extension

Diagram

Type

QueueCenterInfo

Type hierarchy

PhoneCallerIDInfo
- QueueCenterInfo

Properties

content:	complex
minOccurs:	0

Model

Children

SIPIdentity, anonymous, callerIDInternal, callerIDOnTransfer, callerIDRefs, callerName, callerNumber, connectionSnd, connectionSndActive, defaultCallerIDRef, sendCallerID, sendCallerNo

Instance

<queueCenter xmlns="http://4psa.com/ExtensionMessages.xsd/5.2.5" xmlns:extensionData="http://4psa.com/ExtensionData.xsd/5.2.5">
  <extensionData:sendCallerID>{0,1}</extensionData:sendCallerID>
  <extensionData:callerName>{0,1}</extensionData:callerName>
  <extensionData:sendCallerNo>{0,1}</extensionData:sendCallerNo>
  <extensionData:callerNumber>{0,1}</extensionData:callerNumber>
  <extensionData:defaultCallerIDRef>{0,1}</extensionData:defaultCallerIDRef>
  <extensionData:callerIDRefs>{0,unbounded}</extensionData:callerIDRefs>
  <extensionData:anonymous>{0,1}</extensionData:anonymous>
  <extensionData:callerIDInternal>{0,1}</extensionData:callerIDInternal>
  <extensionData:callerIDOnTransfer>{0,1}</extensionData:callerIDOnTransfer>
  <extensionData:SIPIdentity>{0,1}</extensionData:SIPIdentity>
  <extensionData:connectionSnd>{0,1}</extensionData:connectionSnd>
  <extensionData:connectionSndActive>{0,1}</extensionData:connectionSndActive>
</queueCenter>

Source

<xs:element name="queueCenter" type="extensionData:QueueCenterInfo" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Queue center extension</xs:documentation>
  </xs:annotation>
</xs:element>

Namespace

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

Annotations

Interactive voice response
extension

Diagram

Type

extension of IVR

Type hierarchy

PhoneCallerIDInfo
- IVR

Properties

content:	complex
minOccurs:	0

Model

Children

SIPIdentity, anonymous, callerIDInternal, callerIDOnTransfer, callerIDRefs, callerName, callerNumber, cloneID, defaultCallerIDRef, description, lifetime, lifetimeExpire, mohFolder, name, sendCallerID, sendCallerNo, sound, timeout, transferExtension

Instance

<IVR xmlns="http://4psa.com/ExtensionMessages.xsd/5.2.5" xmlns:extensionData="http://4psa.com/ExtensionData.xsd/5.2.5">
  <extensionData:sendCallerID>{0,1}</extensionData:sendCallerID>
  <extensionData:callerName>{0,1}</extensionData:callerName>
  <extensionData:sendCallerNo>{0,1}</extensionData:sendCallerNo>
  <extensionData:callerNumber>{0,1}</extensionData:callerNumber>
  <extensionData:defaultCallerIDRef>{0,1}</extensionData:defaultCallerIDRef>
  <extensionData:callerIDRefs>{0,unbounded}</extensionData:callerIDRefs>
  <extensionData:anonymous>{0,1}</extensionData:anonymous>
  <extensionData:callerIDInternal>{0,1}</extensionData:callerIDInternal>
  <extensionData:callerIDOnTransfer>{0,1}</extensionData:callerIDOnTransfer>
  <extensionData:SIPIdentity>{0,1}</extensionData:SIPIdentity>
  <extensionData:name>{0,1}</extensionData:name>
  <extensionData:description>{0,1}</extensionData:description>
  <extensionData:timeout>{0,1}</extensionData:timeout>
  <extensionData:mohFolder>{0,1}</extensionData:mohFolder>
  <extensionData:lifetime>{0,1}</extensionData:lifetime>
  <extensionData:lifetimeExpire>{0,1}</extensionData:lifetimeExpire>
  <extensionData:transferExtension>{0,1}</extensionData:transferExtension>
  <extensionData:sound>{0,1}</extensionData:sound>
  <cloneID>{0,1}</cloneID>
</IVR>

Source

<xs:element name="IVR" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Interactive voice response
								extension</xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:complexContent>
      <xs:extension base="extensionData:IVR">
        <xs:sequence>
          <xs:element name="cloneID" type="common:string" minOccurs="0">
            <xs:annotation>
              <xs:documentation>Clone IVR settings from extension
												ID</xs:documentation>
            </xs:annotation>
          </xs:element>
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>
</xs:element>

Namespace

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

Annotations

Clone IVR settings from extension
ID

Diagram

Type

string

Properties

content:	simple
minOccurs:	0

Facets

whiteSpace	collapse
maxLength	255

Source

<xs:element name="cloneID" type="common:string" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Clone IVR settings from extension
												ID</xs:documentation>
  </xs:annotation>
</xs:element>

Namespace

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

Annotations

Voicemail center extension

Diagram

Type

VoicemailCenterInfo

Properties

content:	complex
minOccurs:	0

Model

connectionSndActive{0,1} , connectionSnd{0,1}

Children

connectionSnd, connectionSndActive

Instance

<voicemailCenter xmlns="http://4psa.com/ExtensionMessages.xsd/5.2.5" xmlns:extensionData="http://4psa.com/ExtensionData.xsd/5.2.5">
  <extensionData:connectionSndActive>{0,1}</extensionData:connectionSndActive>
  <extensionData:connectionSnd>{0,1}</extensionData:connectionSnd>
</voicemailCenter>

Source

<xs:element name="voicemailCenter" type="extensionData:VoicemailCenterInfo" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Voicemail center extension</xs:documentation>
  </xs:annotation>
</xs:element>

Namespace

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

Annotations

Conference extension

Diagram

Type

ConferenceInfo

Type hierarchy

PhoneCallerIDInfo
- ConferenceInfo

Properties

content:	complex
minOccurs:	0

Model

Children

SIPIdentity, announceExtension, announceExtensionCount, anonymous, callerIDInternal, callerIDOnTransfer, callerIDRefs, callerName, callerNumber, close, connectionSnd, connectionSndActive, defaultCallerIDRef, mohActive, mohFolder, record, sendCallerID, sendCallerNo, size, storage

Instance

<conference xmlns="http://4psa.com/ExtensionMessages.xsd/5.2.5" xmlns:extensionData="http://4psa.com/ExtensionData.xsd/5.2.5">
  <extensionData:sendCallerID>{0,1}</extensionData:sendCallerID>
  <extensionData:callerName>{0,1}</extensionData:callerName>
  <extensionData:sendCallerNo>{0,1}</extensionData:sendCallerNo>
  <extensionData:callerNumber>{0,1}</extensionData:callerNumber>
  <extensionData:defaultCallerIDRef>{0,1}</extensionData:defaultCallerIDRef>
  <extensionData:callerIDRefs>{0,unbounded}</extensionData:callerIDRefs>
  <extensionData:anonymous>{0,1}</extensionData:anonymous>
  <extensionData:callerIDInternal>{0,1}</extensionData:callerIDInternal>
  <extensionData:callerIDOnTransfer>{0,1}</extensionData:callerIDOnTransfer>
  <extensionData:SIPIdentity>{0,1}</extensionData:SIPIdentity>
  <extensionData:connectionSndActive>{0,1}</extensionData:connectionSndActive>
  <extensionData:connectionSnd>{0,1}</extensionData:connectionSnd>
  <extensionData:size>{0,1}</extensionData:size>
  <extensionData:record>{0,1}</extensionData:record>
  <extensionData:storage unlimited="true">{0,1}</extensionData:storage>
  <extensionData:mohActive>{0,1}</extensionData:mohActive>
  <extensionData:mohFolder>{0,1}</extensionData:mohFolder>
  <extensionData:close>{0,1}</extensionData:close>
  <extensionData:announceExtensionCount>{0,1}</extensionData:announceExtensionCount>
  <extensionData:announceExtension>{0,1}</extensionData:announceExtension>
</conference>

Source

<xs:element name="conference" type="extensionData:ConferenceInfo" minOccurs="0">
  <xs:annotation>
    <xs:documentation>Conference extension</xs:documentation>
  </xs:annotation>
</xs:element>

Namespace

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

Annotations

Call callback extension

Diagram

Properties

minOccurs:	0
maxOccurs:	0

Source

<xs:element name="callback" minOccurs="0" maxOccurs="0">
  <xs:annotation>
    <xs:documentation>Call callback extension</xs:documentation>
  </xs:annotation>
</xs:element>

Namespace

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

Annotations

Calling card extension

Diagram

Properties

minOccurs:	0
maxOccurs:	0

Source

<xs:element name="callingCard" minOccurs="0" maxOccurs="0">
  <xs:annotation>
    <xs:documentation>Calling card extension</xs:documentation>
  </xs:annotation>
</xs:element>

Namespace

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

Annotations

Intercom/paging extension

Diagram

Properties

minOccurs:	0
maxOccurs:	0

Source

<xs:element name="intercomPaging" minOccurs="0" maxOccurs="0">
  <xs:annotation>
    <xs:documentation>Intercom/paging extension</xs:documentation>
  </xs:annotation>
</xs:element>

Showing: