Cisco Unity Connection Provisioning Interface (CUPI) API -- Phone Systems
About Phone Systems
This page contains information on how to use the API to create, list, modify, and delete Phone Systems. The phone system pages in Cisco Unity Connection Administration identify the phone systems that Cisco Unity Connection integrates with. In Connection Administration, a phone system has one or more port groups, which in turn have voice messaging ports. You can manage the phone systems to meet the changing needs of your system.
Listing Phone Systems
Example 1
The following is an example of the GET request that lists the Phone Systems:
|
The following is an example of the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
Example 2
The following is an example of the GET request that lists a particular phone system represented by <phonesystemId>:
|
The following is an example of the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
Adding a New Phone System
The following is an example of the POST request that adds the Phone Systems:
|
The actual response will depend upon the information given by you.
|
|
Note |
To create a phone system, only the <DisplayName> parameter is mandatory. |
Modifying a Phone System
The following is an example of the PUT request that modifies the Phone System as represented by <phonesystemid>:
|
The following is an example of the response from the above *PUT* request and the actual response will depend upon the information given by you:.
|
|
You can also update the following in a phone system:
-
AXL Servers
-
Phone System Associations
AXL Servers
This page contains information on how to use the API to create, list, modify, and delete Phone Systems AXL Servers. AXL servers are supported only for Cisco Unified Communications Manager phone systems and are needed when Cisco Unity Connection must have access to the Cisco Unified CM database for importing Cisco Unified CM users and for changing certain phone settings for users of Connection personal call transfer rules.
With Unity Connection 11.5(1) and later, a new field, IsPinSyncEnabled is introduced in this API, which enables synchronization of phone PIN for Cisco Unity Connection with the PIN for Cisco Unified CM. By default, the value of this field is set to false. To enable PIN synchronization, set the value of the field to true.
Note: The IsPinSyncEnabled field is applicable only for primary AXL server.
Listing AXL Servers
The following is an example of the GET request that lists the AXL Servers:
|
The following is an example of the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
Adding New AXL Server
The following is an example of the POST request that adds the AXL servers in the Phone Systems:
|
The actual response will depend upon the information given by you.
|
|
Modifying AXL Server
The following is an example of the PUT request that modifies the AXL Server as represented by <axlserverid>:
|
The following is an example of the response from the above *PUT* request and the actual response will depend upon the information given by you:.
|
|
Deleting AXL Server
The following is an example of the DELETE request that deletes an AXL Server as represented by < axlserverid >:
|
The input for the PUT request will be. The output for this request returns the successful response code.
|
Phone System Associations
This page contains information on how to use the API to list Phone Systems Associations. Phone Systems Associations are required to view a list of all of the Cisco Unity Connection users who are associated with your phone system. Listing Phone System Associations
Listing Phone Systems Associations
The following is an example of the GET request that lists the Phone Systems Associations:
|
The following is an example of the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
Deleting a Phone System
The following is an example of the DELETE request that deletes Phone System as represented by <phonesystemid>:
|
The input for the PUT request will be. The output for this request returns the successful response code.
|