In Cisco Unity Connection 10.0(1) and later, the administrator can use the CUPI APIs for listing, viewing, creating, and deleting HTTP(S) Link. Administrator can use these API for performing operations on Cisco Unity Connection locations joined in the HTTP(S) network.

+

In Cisco Unity Connection 10.0(1) and later, the administrator can use the CUPI APIs for listing, viewing, creating, and deleting HTTPS Link. Administrator can use these API for performing operations on Cisco Unity Connection locations joined in the HTTPS network.

-

== Listing of HTTP(S) Links ==

+

== Listing of HTTPS Links ==

-

Administrator can use this API to fetch the information related to the Cisco Unity Connection locations joined in the HTTP(S) network.

+

Administrator can use this API to fetch the information related to the Cisco Unity Connection locations joined in the HTTPS network.

-

The following is an example of the GET request that fetches the information related to the locations joined in an HTTP(S) network.

+

The following is an example of the GET request that fetches the information related to the locations joined in an HTTPS network.

<pre>

<pre>

Line 260:

Line 260:

'''JSON Example'''

'''JSON Example'''

-

To view a particular HTTP(S) link:

+

To view a particular HTTPS link:

<pre>

<pre>

Line 320:

Line 320:

| String

| String

| Read-Only

| Read-Only

-

| URI of Http(s) Link

+

| URI of HTTPS Link

|-

|-

| BaseFeedURL

| BaseFeedURL

Line 393:

Line 393:

|}

|}

-

== Creating the HTTP(S) Link ==

+

== Creating the HTTPS Link ==

-

Administrator can use this API to add a Unity Connection server to an HTTP(S) network. The mandatory fields for creating HTTP(S) link are:

+

Administrator can use this API to add a Unity Connection server to an HTTPS network. The mandatory fields for creating HTTPS link are:

*RemoteServer

*RemoteServer

*RemoteUsername

*RemoteUsername

Line 493:

Line 493:

| Boolean

| Boolean

| Write

| Write

-

| If true Enable the task to synchronize all directory information after an Http(s) link is established.

+

| If true Enable the task to synchronize all directory information after an HTTPS link is established.

|-

|-

| EnableVoicenameSync

| EnableVoicenameSync

| Boolean

| Boolean

| Write

| Write

-

| If true Enable the task to synchronize all recorded names after an Http(s) link is established.

+

| If true Enable the task to synchronize all recorded names after an HTTPS link is established.

|}

|}

== Updating the HTTP(S) Link ==

== Updating the HTTP(S) Link ==

-

Administrator can use this API to modify directly connected location in an HTTP(S) network.

+

Administrator can use this API to modify directly connected location in an HTTPS network.

The following is an example of the PUT request that modifies the HTTP(S) Link as represented by the httpsLinkObjectId:

The following is an example of the PUT request that modifies the HTTP(S) Link as represented by the httpsLinkObjectId:

Line 609:

Line 609:

|}

|}

-

== Removing An HTTP(S) Location ==

+

== Removing An HTTPS Location ==

-

Administrator can use the following two APIs to unjoin the directly connected Unity Connection location from an HTTP(S) network.

+

Administrator can use the following two APIs to unjoin the directly connected Unity Connection location from an HTTPS network.

-

=== Deleting an HTTP(S) Link ===

+

=== Deleting an HTTPS Link ===

-

Administrator can use this API to unjoin a particular HTTP(S) Link from the network. This API marks selected HTTP(S) link as deleted, which is removed from the Unity Connection location after “Remove Objects Associated With Deleted Network Location” task runs.

+

Administrator can use this API to unjoin a particular HTTPS Link from the network. This API marks selected HTTPS link as deleted, which is removed from the Unity Connection location after “Remove Objects Associated With Deleted Network Location” task runs.

<pre>

<pre>

Line 644:

Line 644:

</pre>

</pre>

-

=== Deleting self-location from HTTP(S) network ===

+

=== Deleting self-location from HTTPS network ===

-

Administrator can use this API to unjoin self-location from the HTTP(S) network. This API marks all the HTTP(S) links as deleted, which are removed from the Unity Connection location after “Remove Objects Associated With Deleted Network Location” task runs.

+

Administrator can use this API to unjoin self-location from the HTTPS network. This API marks all the HTTPS links as deleted, which are removed from the Unity Connection location after “Remove Objects Associated With Deleted Network Location” task runs.

About HTTPS Networking

In Cisco Unity Connection 10.0(1) and later, the administrator can use the CUPI APIs for listing, viewing, creating, and deleting HTTPS Link. Administrator can use these API for performing operations on Cisco Unity Connection locations joined in the HTTPS network.

Listing of HTTPS Links

Administrator can use this API to fetch the information related to the Cisco Unity Connection locations joined in the HTTPS network.
The following is an example of the GET request that fetches the information related to the locations joined in an HTTPS network.

GET https://<connection-server>/vmrest/httpslinks/

The following is an example of response from the above *GET* request and the actual result will depend upon the information that has been provided by you:

Note: LocationBaseURLSub tag (representing the feed url of the subscriber) is displayed only if the joined Unity Connection location is a cluster.

Explanation of Data FieldsThe following chart lists the data fields:

Parameter

Data Type

Operations

Description

AcceptCertificateErrors

Boolean

Read/write

If true Cisco Unity Connection ignore any problems with the SSL certificate of the network link

AcceptSelfSignedCertificates

Boolean

Read/Write

If true allow the remote location to use a self-signed certificate to negotiate SSLwith the network link.

URI

String

Read-Only

URI of Http(s) Link

BaseFeedURL

varchar

Read-Only

Specifies the URL used by reader to fetch the information about directory and voice name.

DisplayName

nvarchar

Read/Write

Specifies the display name of the network link.

LastUsn

bigint

Read-Only

Specifies the last USN synched.

MaxUsn

bigint

Read-Only

Specifies the maximum USN received in feed response.

ObjectCount

int

Read-Only

Specifies a count of objects synchronized by the local Unity Connection location from the network link.

ObjectId

char

Read-Only

Acts as a primary key for the API. The ObjectID is a unique system-generated identifier for an http(s) link object.

Status

smallint

Read-Only

Indicates the status of the directory synchronization with the network link.

Values can be:

0-Idle

1-synching

TimeOfLastFailure

datetime

Read-Only

Reflects the time at which the last error had occurred while synchronizing with the network link.

TimeOfLastSync

datetime

Read-Only

Reflects the time at which the network link was last synchronized.

UseSSL

boolean

Read/Write

Controls whether or not SSL will be used when communicating with the network link.

VoiceNameSyncStatus

smallint

Read-Only

Indicates the status of voice name synchronization with the network link

Values can be:

0- Idle

1- Synching

SyncDistributionLists

Boolean

Read/write

Allow replication of system distribution lists and their memberships.

Values can be:

0- false

1- true

Note: This option cannot be disabled once enabled.

Deleted

boolean

Read-Only

Indicates whether the network link has been marked for deletion.

Values can be:

0- false

1- true

DirectorySynchronizationRole

smallint

Read-Only

Specifies the directory synchronization mode of the network link in the cluster.

Values can be:

0- Standard

1- Alert

LocationBaseURLSub

nvarchar

Read-Only

Specifies the feeder URL for subscriber machine used by reader to fetch the directory information.

WarningMode

boolean

Read-Only

Indicates whether or not the synchronization from the network is in warning mode.

Values can be:

0- false

1- true

Viewing of HTTP(S) Links

Administrator can use this API to fetch the information related to a particular HTTP(S) link in an HTTP(S) network.
The following is an example of the GET request that displays the details of a specific HTTP(S) link associated with the httpsLinkObjectid provided:

The following is the response from the above PUT request and the actual response will depend upon the information given by you:

Response Code : 204
No Content

Explanation of Data FieldsThe following chart lists the data fields:

Parameter

Data Type

Operations

Description

DisplayName

nvarchar

Read/Write

Specifies the display name of the network link.

RemoteServer

String

Write

IP address/Hostname/Fully-Qualified Domain Name (FQDN) of the remote location with which HTTPS link is established.

Note: In case UseSSL option needs to be enabled, please make sure the remote SSL certificate common name (CN) matches the RemoteServer.

UseSSL

Boolean

Read/Write

If true Encrypt the data passed between the locations

Values can be:

0-false

1-true

AcceptSelfSignedCertificates

Boolean

Read/Write

If true Allow the remote location to use a self-signed certificate to negotiate SSL with this site

Values can be :

0-false

1-true

AcceptCertificateErrors

Boolean

Read/Write

If true Cisco Unity Connection ignore any problems with the SSL certificate of the remote location.

Values can be :

0-false

1-true

SyncDistributionLists

Boolean

Read/write

Allow replication of system distribution lists and their memberships.

Values can be:

0-false

1-true

Note: This option cannot be disabled once enabled.

Removing An HTTPS Location

Administrator can use the following two APIs to unjoin the directly connected Unity Connection location from an HTTPS network.

Deleting an HTTPS Link

Administrator can use this API to unjoin a particular HTTPS Link from the network. This API marks selected HTTPS link as deleted, which is removed from the Unity Connection location after “Remove Objects Associated With Deleted Network Location” task runs.

The following is the response from the above DELETE request and the actual response will depend upon the information given by you:

Response Code :200
Success message

Deleting self-location from HTTPS network

Administrator can use this API to unjoin self-location from the HTTPS network. This API marks all the HTTPS links as deleted, which are removed from the Unity Connection location after “Remove Objects Associated With Deleted Network Location” task runs.