IVR Prompt Set

[tags: DMA]

Resource Root

https://localhost:8443/api/rest/ivr-promptset

Summary

Resources	Methods
https://localhost:8443/api/rest/ivr-promptset	GET Retrieves a list of all the IVR prompt sets. POST Creates an IVR prompt set.
https://localhost:8443/api/rest/ivr-promptset/{ivr-promptset-name}	GET Retrieves the information of a selected IVR prompt set specified by identifier which is the prompt set name. DELETE Removes the IVR prompt set specified by IVR prompt set identifier which is the prompt set name.

Resources

https://localhost:8443/api/rest/ivr-promptset

Methods

GET

Retrieves a list of all the IVR prompt sets.

[tags: DMA]

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-ivr-promptset-list+xml application/vnd.plcm.plcm-ivr-promptset-list+json	Prompt set information successfully retrieved
403	application/vnd.plcm.plcm-error+xml	User has insufficient permissions to perform the operation. User roles required: administrator
304		IVR prompt set information has not changed since the last get request. Note: The API client must provide the "plcm-ivr-promptset-list" representation's ETag value in the "If-None-Match" HTTP header to ensure the retrieval. This will improve network performance by reducing bandwidth consumption. If the API client chooses to exclude an ETag value from a previous, identical request in the "If-None-Match" header, then the HTTP response will contain the search results in the message body. The "plcm-ivr-promptset-list" ETag can be accessed from the initial search result's HTTP response header. This also assumes no other client made changes to IVR prompt set on the server.

POST

Creates an IVR prompt set.
Prompt set name is required
[tags: DMA]

Request

Representations

multipart/form-data

Response

Status	Representation	Description
201		IVR prompt set created successfully. Note: Because the creation of the prompt set happens asynchronously, an Etag header is not included in the response. However, a location header is included containing the URL of the created prompt set. Depending on the load of the system, the prompt set may not be immediately available.
400	text/plain	Bad request.
403	application/vnd.plcm.plcm-error+xml	Unable to get permission. DMA roles required: administrator
409	application/vnd.plcm.plcm-error+xml	Invalid prompt set archive file.Manifest file doesn't exist
409	application/vnd.plcm.plcm-error+xml	Invalid prompt set archive file.Manifest file doesn't contain prompt set name.
409	application/vnd.plcm.plcm-error+xml	Invalid prompt set archive file.Manifest file should not contain format
409	application/vnd.plcm.plcm-error+xml	Invalid prompt set archive file.Manifest file should not contain language
429	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Too many requests. Maximum number of concurrent requests in progress. Try back later.

https://localhost:8443/api/rest/ivr-promptset/{ivr-promptset-name}

Template Parameters

Name	Type	Description
ivr-promptset-name	xs:string	Prompt set name arg doc

Methods

GET

Retrieves the information of a selected IVR prompt set specified by identifier which is the prompt set name.
DMA roles required: administrator
[tags: DMA]

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-ivr-promptset+xml application/vnd.plcm.plcm-ivr-promptset+json	IVR prompt set information successfully retrieved.
403	application/vnd.plcm.plcm-error+xml	Unable to get permission. DMA roles required: administrator
404	application/vnd.plcm.plcm-error+xml	No such IVR prompt set.

DELETE

Removes the IVR prompt set specified by IVR prompt set identifier which is the prompt set name.
[tags: DMA]

Response

Status	Representation	Description
204		IVR prompt set successfully deleted.
403	application/vnd.plcm.plcm-error+xml	Unable to get permission. DMA roles required: administrator
404	application/vnd.plcm.plcm-error+xml	The IVR prompt set does not exist.
409	application/vnd.plcm.plcm-error+xml	Default IVR prompt set can't be deleted
409	application/vnd.plcm.plcm-error+xml	IVR prompt set assigned to a VEQ can't be deleted.