PlcmVeq

PlcmVeq

A system virtual entry queue. There are two kind of VEQ. 1) Virtual Entry Queue. 2) Direct Dial Virtual Entry Queue. Content-Type: application/vnd.plcm.plcm-veq+xml. All attributes are used in ETag calculation except for entity-tag and atom-link.


PlcmVeq Fields

NameTypeDescriptionAttributes
atomLinkList Array of LinkSee Definition of Link
conferenceIdSupportPlcmConferenceIdSupport
veqIdentifierVeqIdentifier ID which uniquely identifies each VEQ. This is system generated unique identifier. This attribute is read-only.
veqNumberVeqNumber ID in sip:id@host, and may be a portion of the dial string. This is not applicable for direct dial VEQ.
dialInNumberstring Dial string to access VEQ. This attribute is read-only.
mcuEntryQueueMcuEntryQueue Entry queue name on media servers. Mandatory
descriptionDescription Description of the VEQ.
maxVmrAttemptsMaxVmrAttempts How many times may an end user attempt to enter a VMR number? Mandatory
promptSetPromptSet Prompt set associated with VEQ. This is not applicable for direct dial VEQ.
responseTimeoutint Window of time in which DTMF must be provided upon prompt for input. Range for valid timeout is 5-60. This is not applicable for direct dial VEQ.
dtmfTerminatorstring Key to terminate DTMF input. This is not applicable for direct dial VEQ. Pattern for valid key is [*#]
operatorUristring URI to connect to operator. This is not applicable for direct dial VEQ.
operatorRequestKeystring Key to manually request for operator connect. This is not applicable for direct dial VEQ. Pattern for valid key is [0-9*#]{1,4}
operatorCancelKeystring Key to cancel operator connect request. This is not applicable for direct dial VEQ. Pattern for valid key is [0-9*#]{1,4}
operatorCancelTimeoutint Window of time in which a manual operator request can be cancelled. Range for valid timeout is 1-10. This is not applicable for direct dial VEQ.
isExternalIvrboolean States that entry queue can be associated with traditional or external control IVR. The value of this attribute will be set by system based on entry queue type.
isPublishableboolean Is this a publishable VEQ?
tenantUidTenantUid CAA tenant/External Lync system UID associated with this VEQ.
isDirectDialboolean States that VEQ is a direct dial queue or not. Mandatory
scriptEnabledboolean Flag indicating that the preliminary script is enabled.
scriptstring An executable Javascript script that defines filtering and/or transformation actions applied to a VEQ.
entityTagEntityTag The unique value generated from the server object instance. This value is the same value that MUST be applied to the HTTP Entity Tag (ETag) header for a single instance of this object. Client modification of this field is not allowed for this instance.


Nested Types/Restrictions


NameTypeRestrictions
EntityTagstring
Length of value must be >=1
Length of value must be <=64
TenantUidstring
Length of value must be >=0
Length of value must be <=256
PromptSetstring
Length of value must be >=0
Length of value must be <=256
MaxVmrAttemptsint
Descriptionstring
Length of value must be >=0
Length of value must be <=80
McuEntryQueuestring
Length of value must be >=1
Length of value must be <=256
VeqNumber
Length of value must be >=0
Length of value must be <=20
VeqIdentifierstring
Length of value must be >=0
Length of value must be <=256
T0string
Pattern of value must match the regular expression [0-9]*