Documentation for EndpointMessages

Target Namespace	http://4psa.com/EndpointMessages.xsd/2.0.0
Element and Attribute Namespaces	Global element and attribute declarations belong to this schema's target namespace. By default, local element declarations belong to this schema's target namespace. By default, local attribute declarations have no namespace.
Schema Composition	This schema imports schema(s) from the following namespace(s): http://4psa.com/EndpointData.xsd/2.0.0 (at EndpointData.xsd) http://4psa.com/EndpointMessagesInfo.xsd/2.0.0 (at EndpointMessagesInfo.xsd) http://4psa.com/Common.xsd/2.0.0 (at ../Common.xsd)

Prefix	Namespace
Default namespace	http://4psa.com/EndpointMessages.xsd/2.0.0
common	http://4psa.com/Common.xsd/2.0.0
xml	http://www.w3.org/XML/1998/namespace
messagesInfo	http://4psa.com/EndpointMessagesInfo.xsd/2.0.0
xs	http://www.w3.org/2001/XMLSchema
endpointData	http://4psa.com/EndpointData.xsd/2.0.0

Name	AddEndpointRequest
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	Add endpoint: request

XML Instance Representation

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

'Set this endpoint as trusted'

<phoneLang> common:code </phoneLang> [0..1]

'Phone language'

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

'Outgoing routing rules group id'

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

'Extension template ID'

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

'Endpoint number'

Start Choice [1]

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

'Owner ID'

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

'Owner identifier'

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

'Owner login'

End Choice
Start Choice [1]

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

'Context user ID for requests made on behalf of this user.'

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

'Context user identifier for requests made on behalf of this user.'

End Choice
Start Choice [1]

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

'Charging plan ID'

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

'Charging plan identifier'

End Choice

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

'Response verbosity. Set 1 to receive detailed information on newly created account'

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

'Mask of 4 bits to setup notification preferences ARCE (ADMIN{0/1}, RESELLER{0/1}, CLIENT{0/1}, EXTENSION{0/1})'

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

'Scope identifier for the enrollment server. Scope:automation is reserved for VoipNow Automation'

</AddEndpointRequest>

Schema Component Representation

<xs:element name="AddEndpointRequest">

<xs:complexType>

<xs:complexContent>

<xs:extension base=" endpointData:EndpointInfo ">

<xs:sequence>

<xs:element name="templateID" type=" common:positiveInteger " minOccurs="0"/>

<xs:element name="endpointNo" type=" common:integer " minOccurs="0"/>

<xs:choice>

<xs:element name="parentID" type=" common:positiveInteger " minOccurs="0"/>

<xs:element name="parentIdentifier" type=" common:string " minOccurs="0"/>

<xs:element name="parentLogin" type=" common:string " minOccurs="0"/>

</xs:choice>

<xs:choice>

<xs:element name="fromUser" type=" common:positiveInteger " minOccurs="0"/>

<xs:element name="fromUserIdentifier" type=" common:string " minOccurs="0"/>

</xs:choice>

<xs:choice>

<xs:element name="chargingPlanID" type=" common:positiveInteger " minOccurs="0"/>

<xs:element name="chargingPlanIdentifier" type=" common:string " minOccurs="0"/>

</xs:choice>

<xs:element name="verbose" type=" common:boolean " default="0" minOccurs="0"/>

<xs:element name="notifyOnly" type=" xs:decimal " minOccurs="0"/>

<xs:element name="scope" type=" common:string " minOccurs="0"/>

</xs:sequence>

</xs:extension>

</xs:complexContent>

</xs:complexType>

</xs:element>

Element: AddEndpointResponse

Name	AddEndpointResponse
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	Add endpoint: response

XML Instance Representation

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

'Endpoint user ID'

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

'Unique client identifier'

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

'Endpoint ID'

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

'Owner ID'

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

'Owner identifier'

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

'User status'

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

'User control panel access'

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

'User template ID'

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

'Owner name'

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

'Charging plan name'

<crDate> xs:dateTime </crDate> [0..1]

'Creation date'

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

'Scope identifier for the enrollment server. Scope:automation is reserved for VoipNow Automation'

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

'Endpoint number'

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

'Charging plan ID'

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

'Charging plan identifier'

<result> xs:string (value comes from list: {'success'|'partial'|'failure'}) </result> [0..1]

'Operation result'

<notice> common:notice </notice> [0..*]

</AddEndpointResponse>

Schema Component Representation

<xs:element name="AddEndpointResponse">

<xs:complexType>

<xs:complexContent>

<xs:extension base=" messagesInfo:GetEndpointDetailsResponseType ">

<xs:sequence>

<xs:element name="result" minOccurs="0">

<xs:simpleType>

<xs:restriction base=" xs:string ">

<xs:enumeration value="success"/>

<xs:enumeration value="partial"/>

<xs:enumeration value="failure"/>

</xs:restriction>

</xs:simpleType>

</xs:element>

<xs:element name="notice" type=" common:notice " minOccurs="0" maxOccurs="unbounded"/>

</xs:sequence>

</xs:extension>

</xs:complexContent>

</xs:complexType>

</xs:element>

Element: DelEndpointRequest

Name	DelEndpointRequest
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	Delete endpoints: request

XML Instance Representation

<DelEndpointRequest>
Start Choice [1]

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

'Endpoint user ID'

<identifier> common:string </identifier> [1..*]

'Endpoint user identifier'

End Choice
</DelEndpointRequest>

Schema Component Representation

<xs:element name="DelEndpointRequest">

<xs:complexType>

<xs:choice>

<xs:element name="ID" type=" common:positiveInteger " maxOccurs="unbounded"/>

<xs:element name="identifier" type=" common:string " maxOccurs="unbounded"/>

</xs:choice>

</xs:complexType>

</xs:element>

Element: DelEndpointResponse

Name	DelEndpointResponse
Type	common:delObject
Nillable	no
Abstract	no
Documentation	Delete endpoints: response

XML Instance Representation

<items> xs:integer </items> [0..1]

'Number of affected items'

<result> xs:string (value comes from list: {'success'|'partial'|'failure'}) </result> [0..1]

'Operation result'

</DelEndpointResponse>

Schema Component Representation

<xs:element name="DelEndpointResponse" type=" common:delObject "/>

Element: EditEndpointRequest

Name	EditEndpointRequest
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	Edit endpoint: request

XML Instance Representation

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

'Set this endpoint as trusted'

<phoneLang> common:code </phoneLang> [0..1]

'Phone language'

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

'Outgoing routing rules group id'

Start Choice [1]

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

'Endpoint user ID'

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

'Endpoint user identifier'

End Choice
Start Choice [1]

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

'Context user ID for requests made on behalf of this user.'

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

'Context user identifier for requests made on behalf of this user.'

End Choice
Start Choice [1]

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

'Charging plan ID'

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

'Charging plan identifier'

End Choice
</EditEndpointRequest>

Schema Component Representation

<xs:element name="EditEndpointRequest">

<xs:complexType>

<xs:complexContent>

<xs:extension base=" endpointData:EndpointInfo ">

<xs:sequence>

<xs:choice>

<xs:element name="ID" type=" common:positiveInteger " minOccurs="0"/>

<xs:element name="identifier" type=" common:string " minOccurs="0"/>

</xs:choice>

<xs:choice>

<xs:element name="fromUser" type=" common:positiveInteger " minOccurs="0"/>

<xs:element name="fromUserIdentifier" type=" common:string " minOccurs="0"/>

</xs:choice>

<xs:choice>

<xs:element name="chargingPlanID" type=" common:positiveInteger " minOccurs="0"/>

<xs:element name="chargingPlanIdentifier" type=" common:string " minOccurs="0"/>

</xs:choice>

</xs:sequence>

</xs:extension>

</xs:complexContent>

</xs:complexType>

</xs:element>

Element: EditEndpointResponse

Name	EditEndpointResponse
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	Edit endpoint: response

XML Instance Representation

<ID> positiveInteger </ID> [0..10]

'Object ID'

<result> xs:string (value comes from list: {'success'|'partial'|'failure'}) </result> [0..1]

'Operation result'

<notice> notice </notice> [0..*]

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

'User unique identifier'

</EditEndpointResponse>

Schema Component Representation

<xs:element name="EditEndpointResponse">

<xs:complexType>

<xs:complexContent>

<xs:extension base=" common:updateObject ">

<xs:sequence>

<xs:element name="identifier" type=" common:string " minOccurs="0"/>

</xs:sequence>

</xs:extension>

</xs:complexContent>

</xs:complexType>

</xs:element>

Element: GetAvailableCallerIDRequest

Name	GetAvailableCallerIDRequest
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	Get list of available Caller-IDs: request

XML Instance Representation

<GetAvailableCallerIDRequest>
Start Choice [1]

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

'Endpoint user ID'

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

'Endpoint user identifier'

End Choice
</GetAvailableCallerIDRequest>

Schema Component Representation

<xs:element name="GetAvailableCallerIDRequest">

<xs:complexType>

<xs:choice>

<xs:element name="ID" type=" common:positiveInteger "/>

<xs:element name="identifier" type=" common:string "/>

</xs:choice>

</xs:complexType>

</xs:element>

Element: GetAvailableCallerIDResponse

Name	GetAvailableCallerIDResponse
Type	messagesInfo:GetAvailableCallerIDResponseType
Nillable	no
Abstract	no
Documentation	Get list of available Caller-IDs response

XML Instance Representation

<CallerID> [0..*]

'Available Caller-ID'

<endpointNo> xs:decimal </endpointNo> [1]

'Endpoint number'

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

'Contact name'

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

'Public phone number'

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

'Caller-ID reference ID'

</CallerID>

<notice> common:notice </notice> [0..*]

</GetAvailableCallerIDResponse>

Schema Component Representation

<xs:element name="GetAvailableCallerIDResponse" type=" messagesInfo:GetAvailableCallerIDResponseType "/>

Element: GetEndpointDetailsRequest

Name	GetEndpointDetailsRequest
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	Get details endpoint data: request

XML Instance Representation

<GetEndpointDetailsRequest>
Start Choice [1]

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

'Endpoint user ID'

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

'Endpoint user identifier'

End Choice
</GetEndpointDetailsRequest>

Schema Component Representation

<xs:element name="GetEndpointDetailsRequest">

<xs:complexType>

<xs:choice>

<xs:element name="ID" type=" common:positiveInteger " minOccurs="0"/>

<xs:element name="identifier" type=" common:string " minOccurs="0"/>

</xs:choice>

</xs:complexType>

</xs:element>

Element: GetEndpointDetailsResponse

Name	GetEndpointDetailsResponse
Type	messagesInfo:GetEndpointDetailsResponseType
Nillable	no
Abstract	no
Documentation	Get detailed endpoint data: response

XML Instance Representation

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

'Endpoint user ID'

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

'Unique client identifier'

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

'Endpoint ID'

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

'Owner ID'

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

'Owner identifier'

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

'User status'

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

'User control panel access'

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

'User template ID'

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

'Owner name'

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

'Charging plan name'

<crDate> xs:dateTime </crDate> [0..1]

'Creation date'

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

'Scope identifier for the enrollment server. Scope:automation is reserved for VoipNow Automation'

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

'Endpoint number'

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

'Charging plan ID'

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

'Charging plan identifier'

</GetEndpointDetailsResponse>

Schema Component Representation

<xs:element name="GetEndpointDetailsResponse" type=" messagesInfo:GetEndpointDetailsResponseType "/>

Element: GetEndpointPLRequest

Name	GetEndpointPLRequest
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	Get endpoint permissions and limits: request

XML Instance Representation

<GetEndpointPLRequest>
Start Choice [1]

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

'Endpoint user ID'

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

'Endpoint user identifier'

End Choice
</GetEndpointPLRequest>

Schema Component Representation

<xs:element name="GetEndpointPLRequest">

<xs:complexType>

<xs:choice>

<xs:element name="ID" type=" common:positiveInteger "/>

<xs:element name="identifier" type=" common:string "/>

</xs:choice>

</xs:complexType>

</xs:element>

Element: GetEndpointPLResponse

Name	GetEndpointPLResponse
Type	messagesInfo:GetEndpointPLResponseType
Nillable	no
Abstract	no
Documentation	Get endpoint permissions and limits: response

XML Instance Representation

<endpointPL> endpointData:EndpointPLInfo </endpointPL> [0..1]

'Endpoint permissions and limits data'

<notice> common:notice </notice> [0..*]

</GetEndpointPLResponse>

Schema Component Representation

<xs:element name="GetEndpointPLResponse" type=" messagesInfo:GetEndpointPLResponseType "/>

Element: GetEndpointSettingsRequest

Name	GetEndpointSettingsRequest
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	Get endpoint type parameters: request

XML Instance Representation

<GetEndpointSettingsRequest>
Start Choice [1]

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

'Endpoint user ID'

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

'Endpoint user identifier'

End Choice
</GetEndpointSettingsRequest>

Schema Component Representation

<xs:element name="GetEndpointSettingsRequest">

<xs:complexType>

<xs:choice>

<xs:element name="ID" type=" common:positiveInteger "/>

<xs:element name="identifier" type=" common:string "/>

</xs:choice>

</xs:complexType>

</xs:element>

Element: GetEndpointSettingsResponse

Name	GetEndpointSettingsResponse
Type	endpointData:EndpointSetup
Nillable	no
Abstract	no
Documentation	Get endpoint type parameters: response

XML Instance Representation

<GetEndpointSettingsResponse>
Start Choice [1]

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

'Endpoint user ID'

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

'Endpoint user identifier'

End Choice

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

'Caller-ID name in public calls. Values: 1- server, 0-equipment, 2-anonymous. Default: by server.'

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

'Caller-ID number in public calls. Values: 1- server, 0-equipment, 2-anonymous. Default: by server.'

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

'Public Caller-ID to be used'

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

'CallerID on internal calls like on public calls (if public callerID is available)'

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

'Send SIP P-Asserted-Identity header'

<ringEndpoint> common:integer </ringEndpoint> [1]

'Time interval to ring endpoint. Default value: 30 seconds'

<dtmf> xs:string (value comes from list: {'rfc2833'|'inband'|'info'|'auto'}) </dtmf> [0..1]

'DTMF mode. Default rfc2833.'

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

'Ping endpoint to check its status'

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

'Allowed codecs'

Start Choice [1]

<lockIP> common:ip </lockIP> [0..*]

'Lock endpoint to IP(s)'

<host> common:ip </host> [0..1]

'Phone is on IP {host} port {port}'

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

End Choice

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

'Equipment description'

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

'Enable/ Disable function'

<recordStorage> common:unlimitedUInt </recordStorage> [0..1]

'Call recording storage space (MB)'

<recordTrigger> xs:int (value comes from list: {'0'|'2'}) </recordTrigger> [0..1]

'Record triggered. Default value: 0'

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

'Terminal advertised by the extension if registered'

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

'Extension state, from the network perspective connection'

<registration> common:dateTime </registration> [0..1]

'Extension\'s registration expires on/expired on'

<IP> common:ip </IP> [0..1]

'Registered extension IP address'

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

</GetEndpointSettingsResponse>

Schema Component Representation

<xs:element name="GetEndpointSettingsResponse" type=" endpointData:EndpointSetup "/>

Element: GetEndpointsRequest

Name	GetEndpointsRequest
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	Get all endpoints: request

XML Instance Representation

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

'Set CTRLPANEL to filter only account added from 4PSA VoipNow control panel'

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

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

'Filter endpoint list name, company, email, login, number'

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

'Scope identifier for the enrollment server. Scope:automation is reserved for VoipNow Automation'

Start Choice [1]

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

'Owner ID'

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

'Owner identifier'

End Choice
</GetEndpointsRequest>

Schema Component Representation

<xs:element name="GetEndpointsRequest">

<xs:complexType>

<xs:sequence>

<xs:element name="serverID" type=" common:string " minOccurs="0"/>

<xs:element name="templateID" type=" common:positiveInteger " minOccurs="0"/>

<xs:element name="filter" type=" common:string " minOccurs="0"/>

<xs:element name="scope" type=" common:string " minOccurs="0"/>

<xs:choice>

<xs:element name="parentID" type=" common:positiveInteger " minOccurs="0"/>

<xs:element name="parentIdentifier" type=" common:string " minOccurs="0"/>

</xs:choice>

</xs:sequence>

</xs:complexType>

</xs:element>

Element: GetEndpointsResponse

Name	GetEndpointsResponse
Type	messagesInfo:GetEndpointResponseType
Nillable	no
Abstract	no
Documentation	Get all endpoints: response

XML Instance Representation

<endpoint> endpointData:EndpointList </endpoint> [0..*]

'Endpoint data on succes'

<notice> common:notice </notice> [0..*]

</GetEndpointsResponse>

Schema Component Representation

<xs:element name="GetEndpointsResponse" type=" messagesInfo:GetEndpointResponseType "/>

Element: SetEndpointCpAccessRequest

Name	SetEndpointCpAccessRequest
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	Change endpoint control panel access:request

XML Instance Representation

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

'Endpoint status'

Start Choice [1]

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

'Endpoint user ID'

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

'Endpoint user identifier'

End Choice
</SetEndpointCpAccessRequest>

Schema Component Representation

<xs:element name="SetEndpointCpAccessRequest">

<xs:complexType>

<xs:sequence>

<xs:element name="cpAccess" type=" common:boolean "/>

<xs:choice>

<xs:element name="ID" type=" common:positiveInteger "/>

<xs:element name="identifier" type=" common:string "/>

</xs:choice>

</xs:sequence>

</xs:complexType>

</xs:element>

Element: SetEndpointCpAccessResponse

Name	SetEndpointCpAccessResponse
Type	common:updateObject
Nillable	no
Abstract	no
Documentation	Change endpoint control panel access: response

XML Instance Representation

<ID> positiveInteger </ID> [0..10]

'Object ID'

<result> xs:string (value comes from list: {'success'|'partial'|'failure'}) </result> [0..1]

'Operation result'

<notice> notice </notice> [0..*]

</SetEndpointCpAccessResponse>

Schema Component Representation

<xs:element name="SetEndpointCpAccessResponse" type=" common:updateObject "/>

Element: SetEndpointPLRequest

Name	SetEndpointPLRequest
Type	endpointData:EndpointPLInfo
Nillable	no
Abstract	no
Documentation	Update endpoint permissions and limits: request

XML Instance Representation

<SetEndpointPLRequest>
Start Choice [1]

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

'Endpoint user ID'

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

'Endpoint user identifier'

End Choice

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

'Endpoint SIP management'

<concurentCalls> common:unlimitedUInt </concurentCalls> [0..1]

'Maximum concurrent calls'

<accountExpire> common:unlimitedDate </accountExpire> [0..1]

'Account expiration date'

</SetEndpointPLRequest>

Schema Component Representation

<xs:element name="SetEndpointPLRequest" type=" endpointData:EndpointPLInfo "/>

Element: SetEndpointPLResponse

Name	SetEndpointPLResponse
Type	common:updateObject
Nillable	no
Abstract	no
Documentation	Update endpoint permissions and limits: response

XML Instance Representation

<ID> positiveInteger </ID> [0..10]

'Object ID'

<result> xs:string (value comes from list: {'success'|'partial'|'failure'}) </result> [0..1]

'Operation result'

<notice> notice </notice> [0..*]

</SetEndpointPLResponse>

Schema Component Representation

<xs:element name="SetEndpointPLResponse" type=" common:updateObject "/>

Element: SetEndpointStatusRequest

Name	SetEndpointStatusRequest
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	Change endpoint status:request

XML Instance Representation

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

'Endpoint status'

<phoneStatus> xs:string (value comes from list: {'1'|'16'|'32'|'64'}) </phoneStatus> [0..1]

'Client phone status. Default value:1.'

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

'Scope identifier for the enrollment server. Scope:automation is reserved for VoipNow Automation'

Start Choice [1]

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

'Endpoint user ID'

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

'Endpoint user identifier'

End Choice
</SetEndpointStatusRequest>

Schema Component Representation

<xs:element name="SetEndpointStatusRequest">

<xs:complexType>

<xs:sequence>

<xs:element name="status" type=" common:boolean " minOccurs="0"/>

<xs:element name="phoneStatus" default="1" minOccurs="0">

<xs:simpleType>

<xs:restriction base=" xs:string ">

<xs:enumeration value="1"/>

<xs:enumeration value="16"/>

<xs:enumeration value="32"/>

<xs:enumeration value="64"/>

</xs:restriction>

</xs:simpleType>

</xs:element>

<xs:element name="scope" type=" common:string " default="automation" minOccurs="0"/>

<xs:choice>

<xs:element name="ID" type=" common:positiveInteger "/>

<xs:element name="identifier" type=" common:string "/>

</xs:choice>

</xs:sequence>

</xs:complexType>

</xs:element>

Element: SetEndpointStatusResponse

Name	SetEndpointStatusResponse
Type	common:updateObject
Nillable	no
Abstract	no
Documentation	Change endpoint status: response

XML Instance Representation

<ID> positiveInteger </ID> [0..10]

'Object ID'

<result> xs:string (value comes from list: {'success'|'partial'|'failure'}) </result> [0..1]

'Operation result'

<notice> notice </notice> [0..*]

</SetEndpointStatusResponse>

Schema Component Representation

<xs:element name="SetEndpointStatusResponse" type=" common:updateObject "/>

Element: SetupEndpointRequest

Name	SetupEndpointRequest
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	Set endpoint type parameters: request

XML Instance Representation

<SetupEndpointRequest>
Start Choice [1]

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

'Endpoint user ID'

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

'Endpoint user identifier'

End Choice

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

'Caller-ID name in public calls. Values: 1- server, 0-equipment, 2-anonymous. Default: by server.'

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

'Caller-ID number in public calls. Values: 1- server, 0-equipment, 2-anonymous. Default: by server.'

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

'Public Caller-ID to be used'

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

'CallerID on internal calls like on public calls (if public callerID is available)'

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

'Send SIP P-Asserted-Identity header'

<ringEndpoint> common:integer </ringEndpoint> [1]

'Time interval to ring endpoint. Default value: 30 seconds'

<dtmf> xs:string (value comes from list: {'rfc2833'|'inband'|'info'|'auto'}) </dtmf> [0..1]

'DTMF mode. Default rfc2833.'

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

'Ping endpoint to check its status'

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

'Allowed codecs'

Start Choice [1]

<lockIP> common:ip </lockIP> [0..*]

'Lock endpoint to IP(s)'

<host> common:ip </host> [0..1]

'Phone is on IP {host} port {port}'

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

End Choice

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

'Equipment description'

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

'Enable/ Disable function'

<recordStorage> common:unlimitedUInt </recordStorage> [0..1]

'Call recording storage space (MB)'

<recordTrigger> xs:int (value comes from list: {'0'|'2'}) </recordTrigger> [0..1]

'Record triggered. Default value: 0'

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

'Terminal advertised by the extension if registered'

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

'Extension state, from the network perspective connection'

<registration> common:dateTime </registration> [0..1]

'Extension\'s registration expires on/expired on'

<IP> common:ip </IP> [0..1]

'Registered extension IP address'

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

</SetupEndpointRequest>

Schema Component Representation

<xs:element name="SetupEndpointRequest">

<xs:complexType>

<xs:complexContent>

<xs:extension base=" endpointData:EndpointSetup "/>

</xs:complexContent>

</xs:complexType>

</xs:element>

Element: SetupEndpointResponse

Name	SetupEndpointResponse
Type	common:updateObject
Nillable	no
Abstract	no
Documentation	Set endpoint type parameters: response

XML Instance Representation

<ID> positiveInteger </ID> [0..10]

'Object ID'

<result> xs:string (value comes from list: {'success'|'partial'|'failure'}) </result> [0..1]

'Operation result'

<notice> notice </notice> [0..*]

</SetupEndpointResponse>

Schema Component Representation

<xs:element name="SetupEndpointResponse" type=" common:updateObject "/>

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

Table of Contents

Schema Document Properties

Declared Namespaces

Global Declarations

Element: AddEndpointRequest

Element: AddEndpointResponse

Element: DelEndpointRequest

Element: DelEndpointResponse

Element: EditEndpointRequest

Element: EditEndpointResponse

Element: GetAvailableCallerIDRequest

Element: GetAvailableCallerIDResponse

Element: GetEndpointDetailsRequest

Element: GetEndpointDetailsResponse

Element: GetEndpointPLRequest

Element: GetEndpointPLResponse

Element: GetEndpointSettingsRequest

Element: GetEndpointSettingsResponse

Element: GetEndpointsRequest

Element: GetEndpointsResponse

Element: SetEndpointCpAccessRequest

Element: SetEndpointCpAccessResponse

Element: SetEndpointPLRequest

Element: SetEndpointPLResponse

Element: SetEndpointStatusRequest

Element: SetEndpointStatusResponse

Element: SetupEndpointRequest

Element: SetupEndpointResponse