Virtual Entry Queue



[tags: DMA,RPRM]

Resource Root

https://localhost:8443/api/rest/veqs

Summary


Resources Methods
https://localhost:8443/api/rest/veqs

GET  Retrieves a list of VEQs configured in system.

POST  Creates a VEQ in the system.

https://localhost:8443/api/rest/veqs/mcu-entry-queues

GET Retrieves a list of MCU entry queues.

https://localhost:8443/api/rest/veqs/debug-preliminary

POST  Test a preliminary script for parameters of a call and the DTMF string entered by a caller.

https://localhost:8443/api/rest/veqs/{value}

GET  Retrieves information about a VEQ.

PUT  Updates information about a VEQ.

DELETE  Deletes information about a virtual entry queue.

Resources


https://localhost:8443/api/rest/veqs


Methods

GET


Retrieves a list of VEQs configured in system.
[tags: DMA,RPRM]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-veq-list+xml
application/vnd.plcm.plcm-veq-list+json
VEQ information retrieved successfully.
304
VEQ information has not changed since the last search.

Note: The API client must provide the "plcm-veq-list" representation's
ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval.
This will improve network performance by reducing bandwidth consumption.

If the API client chooses to exclude an ETag value from a previous, identical
search in the "If-None-Match" header, then the HTTP response will contain the
search results in the message body.

The "plcm-veq-list" ETag can be accessed from the initial search result's HTTP
response header. Also, subsequent searches require the identical search filter
to ensure an equivalent ETag value. This also assumes no other client made changes to
VEQs on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.

POST


Creates a VEQ in the system.
[tags: DMA,RPRM]

Request

Representations

application/vnd.plcm.plcm-veq+xml
application/vnd.plcm.plcm-veq+json

Response

Status Representation Description
201 VEQ created successfully.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
veq-number is null.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Virtual entry queue number can not be specified for direct-dial virtual entry queue. This should be null.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
dtmf-terminator is not valid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
operator-request-key is not valid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
operator-cancel-key is not valid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
DTMF termination key can not be part of operator request key considering existing and default values.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The entry queue name is invalid.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
conference-id-support or its attribute(s) are null.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The IVR prompt set name is invalid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
tenant-uid is invalid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
max-vmr-attempts is invalid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
response-timeout is invalid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
operator-cancel-timeout is invalid.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The virtual entry queue number already exists.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The virtual entry queue number is already in use for a VMR.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The direct dial virtual entry queue already exists.

https://localhost:8443/api/rest/veqs/mcu-entry-queues


Methods

GET

Retrieves a list of MCU entry queues. [tags: DMA]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-mcu-entry-queue-list+xml
application/vnd.plcm.plcm-mcu-entry-queue-list+json
MCU entry queue list successfully retrieved.
304
MCU entry queue information has not changed since the last retrieval.

Note: The API client must provide the "plcm-mcu-entry-queue-list" representation's
ETag value in the "If-None-Match" HTTP header to ensure conditional
retrieval. This will improve network performance by reducing bandwidth
consumption.

If the API client chooses to exclude an ETag value from a previous, identical
search in the "If-None-Match" header, then the HTTP response will contain the
search results in the message body.

The "plcm-mcu-entry-queue-list" ETag can be accessed from the initial search result's HTTP
response header.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.

https://localhost:8443/api/rest/veqs/debug-preliminary


Methods

POST


Test a preliminary script for parameters of a call and the DTMF string entered by a caller. [tags: DMA].

Request

Representations

application/vnd.plcm.plcm-dial-rule-preliminary-debug-request+xml
application/vnd.plcm.plcm-dial-rule-preliminary-debug-request+json

Response

Status Representation Description
200 application/vnd.plcm.plcm-dial-rule-preliminary-debug-result+xml
application/vnd.plcm.plcm-dial-rule-preliminary-debug-result+json
The debug session was completed.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
dtmf-digits are invalid or null.

https://localhost:8443/api/rest/veqs/{value}


Template Parameters

Name Type Description
value xs:string Unique identifier or number of the VEQ. A fixed identifier value "direct-dial" represents direct dial VEQ.

Methods

GET


Retrieves information about a VEQ.
[tags: DMA,RPRM]

Request

Query Parameters

Name Type Description
type xs:string
Specifies an enumerated type that will indicate that the resource should be read by its
configured number or immutable, unique identifier such as a UID, integer, etc.

The purpose of allowing the API client to specify an enumerated type ensures the option
to read this resource by its configured number. Unfortunately, the number can be modified
in the system and, as a result, will invalidate the resource URL. However, the API client
has the option of reading this resource by its immutable, unique identifier that can be
retrieved in the entity body.

Note 1: The URL form is https://{host}:{port}/api/rest/{resource}/{veq-identifier}?type={identifier|number}
Note 2: If the "identifier" enumeration is specified, the the veq-identifier should correspond to the unique identifier.
Otherwise, the resource cannot not be found.
Note 3: If the "number" enumeration is specified, then the veq-identifier should correspond to the virtual entry queue number.
Otherwise, the resource cannot not be found.
Note 4: The read will default to the "identifier" type enumeration. As a result, the {veq-identifier} parameter
can simply specify the unique identifier and the query parameter, "?type=identifier", is not required.

Response

Status Representation Description
200 application/vnd.plcm.plcm-veq+xml
application/vnd.plcm.plcm-veq+json
VEQ information successfully retrieved.
304
VEQ information has not changed since the last retrieval.
Note: The API client must provide the "plcm-veq" representation's
ETag value in the "If-None-Match" HTTP header to ensure conditional
retrieval. This will improve network performance by reducing bandwidth
consumption.

If the API client chooses to exclude an ETag value from a previous,
identical single VEQ retrieval in the "If-None-Match" header, then
the HTTP response will contain the VEQ representation in the message
body.

The "plcm-veq" ETag can be accessed from the initial retrieval result's HTTP
response header.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The virtual entry queue identifier is invalid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Invalid resource identifier type. Valid types are: [identifier,number]

PUT


Updates information about a VEQ.
[tags: DMA,RPRM]

Request

Query Parameters

Name Type Description
type xs:string
Specifies an enumerated type that will indicate that the resource should be read by its
configured number or immutable, unique identifier such as a UID, integer, etc.

The purpose of allowing the API client to specify an enumerated type ensures the option
to read this resource by its configured number. Unfortunately, the number can be modified
in the system and, as a result, will invalidate the resource URL. However, the API client
has the option of reading this resource by its immutable, unique identifier that can be
retrieved in the entity body.

Note 1: The URL form is https://{host}:{port}/api/rest/{resource}/{veq-identifier}?type={identifier|number}
Note 2: If the "identifier" enumeration is specified, the the veq-identifier should correspond to the unique identifier.
Otherwise, the resource cannot not be found.
Note 3: If the "number" enumeration is specified, then the veq-identifier should correspond to the virtual entry queue number.
Otherwise, the resource cannot not be found.
Note 4: The read will default to the "identifier" type enumeration. As a result, the {veq-identifier} parameter
can simply specify the unique identifier and the query parameter, "?type=identifier", is not required.

Representations

application/vnd.plcm.plcm-veq+xml
application/vnd.plcm.plcm-veq+json

Response

Status Representation Description
204
VEQ information successfully updated.
Note: The response will only contain both an ETag value and link to the updated VEQ resource.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
veq-identifier is null.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
veq-number is null.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
veq-identifier does not match the identifier associated with the resource.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Invalid identifier value for direct-dial virtual entry queue. This should be 'direct-dial' or null.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Virtual entry queue number can not be specified for direct-dial virtual entry queue. This should be null.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
dtmf-terminator is not valid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
operator-request-key is not valid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
operator-cancel-key is not valid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
DTMF termination key can not be part of operator request key considering existing and default values.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The entry queue name is invalid.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
conference-id-support or its attribute(s) are null.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The IVR prompt set name is invalid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
tenant-uid is invalid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
max-vmr-attempts is invalid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
response-timeout is invalid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
operator-cancel-timeout is invalid.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The virtual entry queue identifier is invalid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The virtual entry queue number already exists.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The virtual entry queue number is already in use for a VMR.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Invalid resource identifier type. Valid types are: [identifier,number]
412 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

The VEQ resource has changed on the server.

Note: The response will contain the ETag value and link that reflects
the server's VEQ resource in the HTTP response header.

The API client must supply the ETag in the message body that is bounded by
the "entity-tag" XML tag. Refer to the "plcm-veq.xsd" for details.
If the message body does not contain the ETag value, the server will
look for the ETag in the "If-Match" header.
428 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

The API client must supply the ETag in the message body that is bounded by
the "entity-tag" XML tag. Refer to the "plcm-veq.xsd" for details.
If the message body does not contain the ETag value, the server will
look for the ETag in the "If-Match" header.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The request contained ETags in both the header and the body and they do not match.

DELETE


Deletes information about a virtual entry queue.
[tags: DMA,RPRM]

Request

Query Parameters

Name Type Description
type xs:string
Specifies an enumerated type that will indicate that the resource should be read by its
configured number or immutable, unique identifier such as a UID, integer, etc.

The purpose of allowing the API client to specify an enumerated type ensures the option
to read this resource by its configured number. Unfortunately, the number can be modified
in the system and, as a result, will invalidate the resource URL. However, the API client
has the option of reading this resource by its immutable, unique identifier that can be
retrieved in the entity body.

Note 1: The URL form is https://{host}:{port}/api/rest/{resource}/{veq-identifier}?type={identifier|number}
Note 2: If the "identifier" enumeration is specified, the the veq-identifier should correspond to the unique identifier.
Otherwise, the resource cannot not be found.
Note 3: If the "number" enumeration is specified, then the veq-identifier should correspond to the virtual entry queue number.
Otherwise, the resource cannot not be found.
Note 4: The read will default to the "identifier" type enumeration. As a result, the {veq-identifier} parameter
can simply specify the unique identifier and the query parameter, "?type=identifier", is not required.

Response

Status Representation Description
204 VEQ information successfully deleted
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The virtual entry queue identifier is invalid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Invalid resource identifier type. Valid types are: [identifier,number]