Search K

Appearance

operations

User Operations ​

This section documents the API operations for User service.

AddUser ​

AddUser

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

Description: Add extension: request

Properties ​

PropertyValue
contentcomplex

Extends ​

Base type: userData:UserInfo

Elements ​

ElementTypeDescription
accountData:templateIDaccountData:templateID (optional)
accountData:verboseaccountData:verbose (optional)
accountData:notifyOnlyaccountData:notifyOnly (optional)
common:scopecommon:scope (optional)
otherNotifyEmailcommon:email (optional)The email address where to send email when a new account is created; usually used in automation.
accountData:dkuaccountData:dku (optional)
accountData:accountFlagaccountData:accountFlag (0..*)
(choice)One of the following
└ accountData:parentIDaccountData:parentID
└ accountData:parentIdentifieraccountData:parentIdentifier
└ accountData:parentLoginaccountData:parentLogin

XSD Source ​

xml
<xs:element name="AddUser">
  <xs:annotation>
    <xs:documentation>Add extension: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="userData:UserInfo">
          <xs:sequence>
            <xs:element name="accountData:templateID" type="accountData:templateID" minOccurs="0"/>
            <xs:element name="accountData:verbose" type="accountData:verbose" minOccurs="0"/>
            <xs:element name="accountData:notifyOnly" type="accountData:notifyOnly" minOccurs="0"/>
            <xs:element name="common:scope" type="common:scope" minOccurs="0"/>
            <xs:element name="otherNotifyEmail" type="common:email" minOccurs="0">
              <xs:annotation>
                <xs:documentation>The email address where to send email when a new account is created; usually used in automation.</xs:documentation>
              </xs:annotation>
            </xs:element>
            <xs:element name="accountData:dku" type="accountData:dku" minOccurs="0"/>
            <xs:element name="accountData:accountFlag" type="accountData:accountFlag" minOccurs="0" maxOccurs="unbounded"/>
            <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:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>
AddUserResponse

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

Description: Add extension: response

Properties ​

PropertyValue
contentcomplex

Extends ​

Base type: userData:ExtendedUserInfo

Elements ​

ElementTypeDescription
accountData:chargingPlanIDaccountData:chargingPlanID (optional)
accountData:chargingPlanIdentifieraccountData:chargingPlanIdentifier (optional)
common:resultcommon:result (optional)
common:noticecommon:notice (0..*)
accountData:templateaccountData:template (optional)

XSD Source ​

xml
<xs:element name="AddUserResponse">
  <xs:annotation>
    <xs:documentation>Add extension: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="userData:ExtendedUserInfo">
          <xs:sequence>
            <xs:element name="accountData:chargingPlanID" type="accountData:chargingPlanID" minOccurs="0"/>
            <xs:element name="accountData:chargingPlanIdentifier" type="accountData:chargingPlanIdentifier" 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:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>

EditUser ​

EditUser

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

Description: Edit extension: request

Properties ​

PropertyValue
contentcomplex

Extends ​

Base type: userData:UserInfo

Elements ​

ElementTypeDescription
(choice)One of the following
└ common:IDcommon:ID
└ common:identifiercommon:identifier

XSD Source ​

xml
<xs:element name="EditUser">
  <xs:annotation>
    <xs:documentation>Edit extension: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="userData:UserInfo">
          <xs:sequence>
            <xs:choice>
              <xs:element name="common:ID" type="common:ID" minOccurs="0"/>
              <xs:element name="common:identifier" type="common:identifier" minOccurs="0"/>
            </xs:choice>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>
EditUserResponse

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

Description: Edit extension: response

Properties ​

PropertyValue
contentcomplex

Extends ​

Base type: common:updateObject

XSD Source ​

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

SetUserStatus ​

SetUserStatus

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

Description: Change extension status:request

Properties ​

PropertyValue
contentcomplex

Elements ​

ElementTypeDescription
accountData:statusaccountData:status (optional)
accountData:phoneStatusaccountData:phoneStatus (optional)
common:scopecommon:scope (optional)
(choice)One of the following
└ common:IDcommon:ID
└ common:identifiercommon:identifier

XSD Source ​

xml
<xs:element name="SetUserStatus">
  <xs:annotation>
    <xs:documentation>Change extension status:request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="accountData:status" type="accountData:status" minOccurs="0"/>
        <xs:element name="accountData:phoneStatus" type="accountData:phoneStatus" minOccurs="0"/>
        <xs:element name="common:scope" type="common:scope" minOccurs="0"/>
        <xs:choice>
          <xs:element name="common:ID" type="common:ID"/>
          <xs:element name="common:identifier" type="common:identifier"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>
SetUserStatusResponse

Type: common:updateObject

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

Description: Change extension status: response

Properties ​

PropertyValue
contentcomplex

XSD Source ​

xml
<xs:element name="SetUserStatusResponse" type="common:updateObject">
  <xs:annotation>
    <xs:documentation>Change extension status: response</xs:documentation>
  </xs:annotation>
</xs:element>

SetUserCpAccess ​

SetUserCpAccess

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

Description: Change extension control panel access:request

Properties ​

PropertyValue
contentcomplex

Elements ​

ElementTypeDescription
accountData:cpAccessaccountData:cpAccess
(choice)One of the following
└ common:IDcommon:ID
└ common:identifiercommon:identifier

XSD Source ​

xml
<xs:element name="SetUserCpAccess">
  <xs:annotation>
    <xs:documentation>Change extension control panel access:request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="accountData:cpAccess" type="accountData:cpAccess"/>
        <xs:choice>
          <xs:element name="common:ID" type="common:ID"/>
          <xs:element name="common:identifier" type="common:identifier"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>
SetUserCpAccessResponse

Type: common:updateObject

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

Description: Change extension control panel access: response

Properties ​

PropertyValue
contentcomplex

XSD Source ​

xml
<xs:element name="SetUserCpAccessResponse" type="common:updateObject">
  <xs:annotation>
    <xs:documentation>Change extension control panel access: response</xs:documentation>
  </xs:annotation>
</xs:element>

GetUsers ​

GetUsers

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

Description: Get all extensions: request

Properties ​

PropertyValue
contentcomplex

Elements ​

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

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

XSD Source ​

xml
<xs:element name="GetUsers">
  <xs:annotation>
    <xs:documentation>Get all extensions: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="accountData:templateID" type="accountData:templateID" minOccurs="0"/>
        <xs:element name="accountData:serverID" type="accountData:serverID" 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:element name="common:scope" type="common:scope" 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:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>
GetUsersResponse

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

Description: Get all extensions: response

Properties ​

PropertyValue
contentcomplex

Elements ​

ElementTypeDescription
useruserData:UserList (0..*)User data on succes
common:noticecommon:notice (0..*)

XSD Source ​

xml
<xs:element name="GetUsersResponse">
  <xs:annotation>
    <xs:documentation>Get all extensions: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="user" type="userData:UserList" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>User 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>

GetUserDetails ​

GetUserDetails

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

Description: Get details extension data: request

Properties ​

PropertyValue
contentcomplex

Elements ​

ElementTypeDescription
(choice)One of the following
└ common:IDcommon:ID
└ common:identifiercommon:identifier

XSD Source ​

xml
<xs:element name="GetUserDetails">
  <xs:annotation>
    <xs:documentation>Get details extension data: 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:identifier" type="common:identifier" minOccurs="0"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>
GetUserDetailsResponse

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

Description: Get detailed extension data: response

Properties ​

PropertyValue
contentcomplex

Extends ​

Base type: userData:ExtendedUserInfo

Elements ​

ElementTypeDescription
accountData:chargingPlanIDaccountData:chargingPlanID (optional)
accountData:chargingPlanIdentifieraccountData:chargingPlanIdentifier (optional)

XSD Source ​

xml
<xs:element name="GetUserDetailsResponse">
  <xs:annotation>
    <xs:documentation>Get detailed extension data: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="userData:ExtendedUserInfo">
          <xs:sequence>
            <xs:element name="accountData:chargingPlanID" type="accountData:chargingPlanID" minOccurs="0"/>
            <xs:element name="accountData:chargingPlanIdentifier" type="accountData:chargingPlanIdentifier" minOccurs="0"/>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>

DelUser ​

DelUser

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

Description: Delete extensions: request

Properties ​

PropertyValue
contentcomplex

Elements ​

ElementTypeDescription
(choice)One of the following
└ common:IDcommon:ID
└ common:identifiercommon:identifier

XSD Source ​

xml
<xs:element name="DelUser">
  <xs:annotation>
    <xs:documentation>Delete extensions: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:choice>
          <xs:element name="common:ID" type="common:ID"/>
          <xs:element name="common:identifier" type="common:identifier"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>
DelUserResponse

Type: common:delObject

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

Description: Delete extensions: response

Properties ​

PropertyValue
contentcomplex

XSD Source ​

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

UpdateUserPL ​

UpdateUserPL

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

Description: Update extension permissions and limits: request

Properties ​

PropertyValue
contentcomplex

Extends ​

Base type: userData:RelativeUserPLInfo

Elements ​

ElementTypeDescription
(choice)One of the following
└ common:IDcommon:ID
└ common:identifiercommon:identifier

XSD Source ​

xml
<xs:element name="UpdateUserPL">
  <xs:annotation>
    <xs:documentation>Update extension permissions and limits: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="userData:RelativeUserPLInfo">
          <xs:sequence>
            <xs:choice>
              <xs:element name="common:ID" type="common:ID" minOccurs="0"/>
              <xs:element name="common:identifier" type="common:identifier" minOccurs="0"/>
            </xs:choice>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>
UpdateUserPLResponse

Type: common:updateObject

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

Description: Update extension permissions and limits: response

Properties ​

PropertyValue
contentcomplex

XSD Source ​

xml
<xs:element name="UpdateUserPLResponse" type="common:updateObject">
  <xs:annotation>
    <xs:documentation>Update extension permissions and limits: response</xs:documentation>
  </xs:annotation>
</xs:element>

SetUserPL ​

SetUserPL

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

Description: Update extension permissions and limits: request

Properties ​

PropertyValue
contentcomplex

Extends ​

Base type: userData:UserPLInfo

Elements ​

ElementTypeDescription
shareVoicemailuserData:shareBetween (optional)Share voicemail messages with other
							users |

| shareFaxes | userData:shareBetween (optional) | Share fax messages with other users | | shareRecordings | userData:shareBetween (optional) | Share recorded messages with other users | | shareCallHistory | userData:shareBetween (optional) | Share call history with other users | | (choice) | | One of the following | | └ common:ID | common:ID | | | └ common:identifier | common:identifier | |

XSD Source ​

xml
<xs:element name="SetUserPL">
  <xs:annotation>
    <xs:documentation>Update extension permissions and limits: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="userData:UserPLInfo">
          <xs:sequence>
            <xs:element name="shareVoicemail" type="userData:shareBetween" minOccurs="0" maxOccurs="1">
              <xs:annotation>
                <xs:documentation>Share voicemail messages with other
								users</xs:documentation>
              </xs:annotation>
            </xs:element>
            <xs:element name="shareFaxes" type="userData:shareBetween" minOccurs="0" maxOccurs="1">
              <xs:annotation>
                <xs:documentation>Share fax messages with other users</xs:documentation>
              </xs:annotation>
            </xs:element>
            <xs:element name="shareRecordings" type="userData:shareBetween" minOccurs="0" maxOccurs="1">
              <xs:annotation>
                <xs:documentation>Share recorded messages with other
								users</xs:documentation>
              </xs:annotation>
            </xs:element>
            <xs:element name="shareCallHistory" type="userData:shareBetween" minOccurs="0" maxOccurs="1">
              <xs:annotation>
                <xs:documentation>Share call history with other users</xs:documentation>
              </xs:annotation>
            </xs:element>
            <xs:choice>
              <xs:element name="common:ID" type="common:ID" minOccurs="0"/>
              <xs:element name="common:identifier" type="common:identifier" minOccurs="0"/>
            </xs:choice>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
</xs:element>
SetUserPLResponse

Type: common:updateObject

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

Description: Update extension permissions and limits: response

Properties ​

PropertyValue
contentcomplex

XSD Source ​

xml
<xs:element name="SetUserPLResponse" type="common:updateObject">
  <xs:annotation>
    <xs:documentation>Update extension permissions and limits: response</xs:documentation>
  </xs:annotation>
</xs:element>

GetUserPL ​

GetUserPL

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

Description: Get extension permissions and limits: request

Properties ​

PropertyValue
contentcomplex

Elements ​

ElementTypeDescription
(choice)One of the following
└ common:IDcommon:ID
└ common:identifiercommon:identifier

XSD Source ​

xml
<xs:element name="GetUserPL">
  <xs:annotation>
    <xs:documentation>Get extension permissions and limits: request</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:choice>
          <xs:element name="common:ID" type="common:ID"/>
          <xs:element name="common:identifier" type="common:identifier"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>
GetUserPLResponse

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

Description: Get extension permissions and limits: response

Properties ​

PropertyValue
contentcomplex

Elements ​

ElementTypeDescription
extensionPLinline (optional)User permissions and limits data
common:noticecommon:notice (0..*)

XSD Source ​

xml
<xs:element name="GetUserPLResponse">
  <xs:annotation>
    <xs:documentation>Get extension permissions and limits: response</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="extensionPL" minOccurs="0">
          <xs:annotation>
            <xs:documentation>User permissions and limits data</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>

GetUserGroups ​

GetUserGroups

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

Description: Get list of group IDs

Properties ​

PropertyValue
contentcomplex

Elements ​

ElementTypeDescription
sharecommon:booleanGroups that this extension can share info
						with |

| (choice) | | One of the following | | └ common:ID | common:ID | | | └ common:identifier | common:identifier | |

XSD Source ​

xml
<xs:element name="GetUserGroups">
  <xs:annotation>
    <xs:documentation>Get list of group IDs</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="share" type="common:boolean">
          <xs:annotation>
            <xs:documentation>Groups that this extension can share info
							with</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:choice>
          <xs:element name="common:ID" type="common:ID"/>
          <xs:element name="common:identifier" type="common:identifier"/>
        </xs:choice>
      </xs:sequence>
    </xs:complexType>
</xs:element>
GetUserGroupsResponse

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

Description: Get IDs of all groups that the extension is part of

Properties ​

PropertyValue
contentcomplex

Elements ​

ElementTypeDescription
groupsinline (0..*)List of groups
common:noticecommon:notice (0..*)

XSD Source ​

xml
<xs:element name="GetUserGroupsResponse">
  <xs:annotation>
    <xs:documentation>Get IDs of all groups that the extension is part of</xs:documentation>
  </xs:annotation>
    <xs:complexType>
      <xs:sequence>
        <xs:element name="groups" minOccurs="0" maxOccurs="unbounded">
          <xs:annotation>
            <xs:documentation>List of groups</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="common:notice" type="common:notice" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
</xs:element>
Last updated: Dec 4, 2025