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.
| Name | Type | Description | Attributes |
|---|---|---|---|
| atomLinkList | List of link | See Definition of link | |
| conference-id-support | PlcmConferenceIdSupport | ||
| veq-identifier | VeqIdentifier | ID which uniquely identifies each VEQ. This is system generated unique identifier. This attribute is read-only. | |
| veq-number | VeqNumber | ID in sip:id@host, and may be a portion of the dial string. This is not applicable for direct dial VEQ. | |
| dial-in-number | xs:string | Dial string to access VEQ. This attribute is read-only. | |
| mcu-entry-queue | McuEntryQueue | Entry queue name on media servers. | Mandatory |
| description | Description | Description of the VEQ. | |
| max-vmr-attempts | MaxVmrAttempts | How many times may an end user attempt to enter a VMR number? | Mandatory |
| prompt-set | PromptSet | Prompt set associated with VEQ. This is not applicable for direct dial VEQ. | |
| response-timeout | xs:int | 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. | |
| dtmf-terminator | xs:string | Key to terminate DTMF input. This is not applicable for direct dial VEQ. Pattern for valid key is [*#] | |
| operator-uri | xs:string | URI to connect to operator. This is not applicable for direct dial VEQ. | |
| operator-request-key | xs:string | Key to manually request for operator connect. This is not applicable for direct dial VEQ. Pattern for valid key is [0-9*#]{1,4} | |
| operator-cancel-key | xs:string | Key to cancel operator connect request. This is not applicable for direct dial VEQ. Pattern for valid key is [0-9*#]{1,4} | |
| operator-cancel-timeout | xs:int | 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. | |
| is-external-ivr | xs:boolean | 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. | |
| is-publishable | xs:boolean | Is this a publishable VEQ? | |
| tenant-uid | TenantUid | CAA tenant/External Lync system UID associated with this VEQ. | |
| is-direct-dial | xs:boolean | States that VEQ is a direct dial queue or not. | Mandatory |
| script-enabled | xs:boolean | Flag indicating that the preliminary script is enabled. | |
| script | xs:string | An executable Javascript script that defines filtering and/or transformation actions applied to a VEQ. | |
| entity-tag | EntityTag | 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. |
| Name | Type | Restrictions |
|---|---|---|
| EntityTag | xs:string | Length of value must be >=1 Length of value must be <=64 |
| TenantUid | xs:string | Length of value must be >=0 Length of value must be <=256 |
| PromptSet | xs:string | Length of value must be >=0 Length of value must be <=256 |
| MaxVmrAttempts | xs:int | |
| Description | xs:string | Length of value must be >=0 Length of value must be <=80 |
| McuEntryQueue | xs:string | Length of value must be >=1 Length of value must be <=256 |
| VeqNumber | T0 | Length of value must be >=0 Length of value must be <=20 |
| VeqIdentifier | xs:string | Length of value must be >=0 Length of value must be <=256 |
| T0 | xs:string | Pattern of value must match the regular expression [0-9]* |