Dial Plan



[tags: DMA]

Resource Root

https://localhost:8443/api/rest/dial-plans

Summary


Resources Methods
https://localhost:8443/api/rest/dial-plans

GET  Retrieves the list of dial plans.

POST  Creates a new Dial Plan [tags: DMA] .

https://localhost:8443/api/rest/dial-plans/dial-rules/default

GET  Returns default values of dial rule.

https://localhost:8443/api/rest/dial-plans/{dial-plan-identifier}

GET  Retrieves a single dial plan.

PUT  Updates information about an existing dial plan.

DELETE  Deletes the dial plan.

https://localhost:8443/api/rest/dial-plans/{dial-plan-identifier}/dial-rules

GET  Get the dial rule list [tags: DMA] .

POST  Creates a dial rule.

https://localhost:8443/api/rest/dial-plans/{dial-plan-identifier}/dial-rules/preliminary-script

POST  Returns the plcm-preliminary-script.

https://localhost:8443/api/rest/dial-plans/{dial-plan-identifier}/dial-rules/test

POST  A testing mechanism for the current dial plan.

https://localhost:8443/api/rest/dial-plans/{dial-plan-identifier}/dial-rules/debug-preliminary

POST  Test a dial rule preliminary script.

https://localhost:8443/api/rest/dial-plans/{dial-plan-identifier}/dial-rules/{dial-rule-identifier}

GET  Retrieves information about a dial rule.

PUT  Updates information about an existing dial rule.

DELETE  Deletes the dial rule.

Resources


https://localhost:8443/api/rest/dial-plans


Methods

GET


Retrieves the list of dial plans.
[tags: DMA]

Response

Status Representation Description
200 application/vnd.plcm.plcm-dial-plan-list+xml
application/vnd.plcm.plcm-dial-plan-list+json
Dial plan information successfully retrieved
304
Dial plan information has not changed since the last retrieval.

Note: The API client must provide the "plcm-dial-plan-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-dial-plan-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
dial plans on the server.

POST


Creates a new Dial Plan
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-dial-plan+xml
application/vnd.plcm.plcm-dial-plan+json

Response

Status Representation Description
201 Dial plan successfully created.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. Administrator user role required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Attempted to create a duplicate dial plan

https://localhost:8443/api/rest/dial-plans/dial-rules/default


Methods

GET


Returns default values of dial rule.

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-dial-rule-defaults+xml
application/vnd.plcm.plcm-dial-rule-defaults+json
Default values returned.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. Administrator user role required.

https://localhost:8443/api/rest/dial-plans/{dial-plan-identifier}


Template Parameters

Name Type Description
dial-plan-identifier xs:string The unique identifier of the dial plan

Methods

GET


Retrieves a single dial plan.
[tags: DMA]

Response

Status Representation Description
200 application/vnd.plcm.plcm-dial-plan+xml
application/vnd.plcm.plcm-dial-plan+json
Dial plan information successfully retrieved
304
Dial plan information has not changed since the last retrieval.

Note: The API client must provide the "plcm-dial-plan-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-dial-plan-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
dial plans on the server.

PUT


Updates information about an existing dial plan.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-dial-plan+xml
application/vnd.plcm.plcm-dial-plan+json

Response

Status Representation Description
204
Dial plan information successfully updated.
Note: The response will only contain both an ETag value
and link to the updated dial plan resource.
304
Dial plan information has not changed since the last retrieval.
Note: The API client must provide the "plcm-dial-plan" 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 dial plan retrieval in the "If-None-Match" header, then
the HTTP response will contain the dial plan representation in the message
body.

The "plcm-dial-plan" ETag can be accessed from the initial retrieval result's HTTP
response header. Also, subsequent retrievals require the identical domain and
user name to ensure an equivalent ETag value. This also assumes no other client made changes to
dial plan on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. Administrator user role required.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
No such dial plan
412 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

The dial plan resource has changed on the server.

Note: The response will contain the ETag value and link that reflects
the server's dial rule 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-dial-plan.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-dial-plan.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.

DELETE


Deletes the dial plan.
[tags: DMA]

Response

Status Representation Description
204 Dial plan successfully deleted
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. Administrator user role required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Only dial plans that have no dial rules or listening points may be deleted.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
No such dial plan.

https://localhost:8443/api/rest/dial-plans/{dial-plan-identifier}/dial-rules


Template Parameters

Name Type Description
dial-plan-identifier xs:string The unique identifier of the dial plan

Methods

GET


Get the dial rule list
[tags: DMA]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-dial-rule-list+xml
application/vnd.plcm.plcm-dial-rule-list+json
application/vnd.plcm.plcm-dial-rule-list-v2+xml
application/vnd.plcm.plcm-dial-rule-list-v2+json
List returned
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. Administrator user role required.

POST


Creates a dial rule.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-dial-rule+xml
application/vnd.plcm.plcm-dial-rule+json
application/vnd.plcm.plcm-dial-rule-v2+xml
application/vnd.plcm.plcm-dial-rule-v2+json

Response

Status Representation Description
201 Dial rule successfully created.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. Administrator user role required.

https://localhost:8443/api/rest/dial-plans/{dial-plan-identifier}/dial-rules/preliminary-script


Template Parameters

Name Type Description
dial-plan-identifier xs:string The unique identifier of the dial plan

Methods

POST


Returns the plcm-preliminary-script.xml, which contains the translated script for the dial rule, built from supplied
parameters. If query parameters are not provided, the default value(s) will be used.
[tags: DMA]

Request

Query Parameters

Name Type Description
actionName xs:string Identifies the dial rule action for the default script. Only RESOLVE_CONF_ROOM_WITH_AUTODIAL is supported at this time.
confAutodialMatchingType xs:string Specifies the Conference with Autodial matching type option. Values are "TEAMS", "GENERIC", and "OTHER".
tenantId xs:string Specifies the Conference with Autodial matching tenant ID option. This can be a literal or regex expression.
A null or blank value defaults to '[^:#*.]+'.
roomId xs:string Specifies the Conference with Autodial matching room id option. This can be a literal or regex expression.
A null or blank value defaults to '[^:#*.]+'.
domain xs:string Specifies the Conference with Autodial matching domain option. This can be a literal or regex expression.
A null or blank value defaults to '[^:#*]+'.

Response

Status Representation Description
200 application/vnd.plcm.plcm-preliminary-script+xml
application/vnd.plcm.plcm-preliminary-script+json
The translated script is returned

https://localhost:8443/api/rest/dial-plans/{dial-plan-identifier}/dial-rules/test


Template Parameters

Name Type Description
dial-plan-identifier xs:string The unique identifier of the dial plan

Methods

POST


A testing mechanism for the current dial plan. You can specify various caller parameters
and a dial string, and see how each dial rule handles such a call and what its final disposition would be.

[tags: DMA]

Request

Representations

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

Response

Status Representation Description
200 application/vnd.plcm.plcm-dial-rule-test-result+xml
application/vnd.plcm.plcm-dial-rule-test-result+json
The dial rule test has completed.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. Administrator user role required.

https://localhost:8443/api/rest/dial-plans/{dial-plan-identifier}/dial-rules/debug-preliminary


Template Parameters

Name Type Description
dial-plan-identifier xs:string The unique identifier of the dial plan

Methods

POST


Test a dial rule preliminary script.
It lets you specify parameters of a call and the dial string, and see what effect the script has on the dial string.
This test is a dry run, and has no effect other than to show what would happen given a set of values.

[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. Administrator user role required.

https://localhost:8443/api/rest/dial-plans/{dial-plan-identifier}/dial-rules/{dial-rule-identifier}


Template Parameters

Name Type Description
dial-plan-identifier xs:string The unique identifier of the dial plan
dial-rule-identifier xs:string The unique identifier of the dial rule

Methods

GET


Retrieves information about a dial rule.
[tags: DMA]

Response

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

The "plcm-dial-rule" ETag can be accessed from the initial retrieval result's HTTP
response header. Also, subsequent retrievals require the identical domain and
user name to ensure an equivalent ETag value. This also assumes no other client made changes to
dial rule on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. Administrator user role required.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
No such dial rule

PUT


Updates information about an existing dial rule.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-dial-rule+xml
application/vnd.plcm.plcm-dial-rule+json
application/vnd.plcm.plcm-dial-rule-v2+xml
application/vnd.plcm.plcm-dial-rule-v2+json

Response

Status Represent