IVR Template



[tags: DMA_INTERNAL]

Resource Root

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

Summary


Resources Methods
https://localhost:8443/api/rest/ivr-templates

GET  Retrieves a list of IVR templates configured on the system.

POST  Creates an IVR template on the system.

https://localhost:8443/api/rest/ivr-templates/{value}

GET  Retrieves information about an IVR template.

PUT  Updates information about an IVR template.

DELETE  Deletes information about an IVR template.

Resources


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


Methods

GET


Retrieves a list of IVR templates configured on the system.
[tags: DMA_INTERNAL]

Request

Response

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

Note: The API client must provide the "plcm-ivr-template-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-ivr-template-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, provisioner.

POST


Creates an IVR template on the system.
[tags: DMA_INTERNAL]

Request

Representations

application/vnd.plcm.plcm-ivr-template+xml
application/vnd.plcm.plcm-ivr-template+json

Response

Status Representation Description
201 IVR template created successfully.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
ivr-template-identifier is malformed.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
name is missing.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
name is not valid.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
description is not valid.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
max-prompt-attempts is not valid.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
response-timeout is not valid.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
dtmf-terminator is not valid.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
chairperson-identifier-key is not valid.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
mute-code is not valid.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
unmute-code is not valid.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
mute-all-code is not valid.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
unmute-all-code is not valid.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
lock-code is not valid.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
unlock-code is not valid.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
dial-out-code is not valid.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
help-menu-code is not valid.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
terminate-conference-code is not valid.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
upgrade-to-chairperson-code is not valid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Codes conflict with each other.
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
A template with the same ivr-template-identifier already exists.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
A template with the same name already exists.

https://localhost:8443/api/rest/ivr-templates/{value}


Template Parameters

Name Type Description
value xs:string Unique identifier of the IVR template.

Methods

GET


Retrieves information about an IVR template.
[tags: DMA_INTERNAL]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-ivr-template+xml
application/vnd.plcm.plcm-ivr-template+json
IVR template information successfully retrieved.
304
IVR template information has not changed since the last retrieval.
Note: The API client must provide the "plcm-ivr-template" 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 IVR template retrieval in the "If-None-Match" header, then
the HTTP response will contain the IVR template representation in the message
body.

The "plcm-ivr-template" 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, provisioner.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The IVR template identifier is malformed.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The IVR template does not exist.

PUT


Updates information about an IVR template.
[tags: DMA_INTERNAL]

Request

Representations

application/vnd.plcm.plcm-ivr-template+xml
application/vnd.plcm.plcm-ivr-template+json

Response

Status Representation Description
204
IVR template information successfully updated.
Note: The response will only contain both an ETag value and link to the updated IVR template resource.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The IVR template identifier is malformed.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
ivr-template-identifier is null.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
ivr-template-identifier does not match the identifier associated with the resource.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
name is missing.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
name is not valid.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
description is not valid.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
max-prompt-attempts is not valid.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
response-timeout is not valid.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
dtmf-terminator is not valid.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
chairperson-identifier-key is not valid.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
mute-code is not valid.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
unmute-code is not valid.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
mute-all-code is not valid.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
unmute-all-code is not valid.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
lock-code is not valid.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
unlock-code is not valid.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
dial-out-code is not valid.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
help-menu-code is not valid.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
terminate-conference-code is not valid.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
upgrade-to-chairperson-code is not valid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Codes conflict with each other.
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
A template with the same ivr-template-identifier already exists.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
A template with the same name already exists.
412 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

The IVR template resource has changed on the server.

Note: The response will contain the ETag value and link that reflects
the server's IVR template 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-ivr-template.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 an IVR template.
[tags: DMA_INTERNAL]

Request

Response

Status Representation Description
204 IVR template information successfully deleted
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 IVR template identifier is malformed.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The IVR template does not exist.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The IVR template is in use by a conference template.