About Cisco Unity Connection Survivable Remote Site Voicemail (SRSV)

Cisco Unity Connection Survivable Remote Site Voicemail (SRSV) is a survivable voicemail solution that works in conjunction with Cisco Unity Connection Survivable Remote Site Telephony (SRST) in order to provide voicemail service to a branch site when connectivity to a central voicemail service is lost.

Listing the Branches

The following is an example of the *GET* request that lists the branches present in the Connection server:

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

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:

This *PUT* request is also used for scheduling a branch for provisioning and voicemail upload.
Only the properties mentioned in above XML are writable at the time of modifying a branch. The properties, ProvisionState and VmUploadState, can not be put in the request XML at the same time as a branch can be scheduled either for provisioning or voicemail upload, at a given point of time. The value of those fields can only be 1.

The successful response code returned for this API is 201. The error response code and data will depend upon the information provided by you:

Response Code: 201

/vmrest/branches/c3816faf-8dc6-48f3-9c6a-b8e93bba1c42

Explanation of Data FieldsThe following chart lists the data fields:

Field Name

Read/Write

Possible Values

Description

IsDisabled

Read/Write

true/false

Enables or activates the branch.

OperatorObjectId

Read/Write

Object ID of the operator.

The operator or the user that must be used to synchronize the messages received by the branch Connection server.

Port

Read/Write

Port number

A port number that the branch uses to communicate with Cisco Unity Connection.

ServerAddress

Read/Write

FQDN, IP Address

The IP address or the Fully Qualified Domain Name (FQDN) of the branch Connection server.

SyncGreetings

Read/Write

true/false

Synchronize the greetings for the users on the branch.

SyncVoiceName

Read/Write

true/false

Synchronize the recorded voice name of the user on the branch.

UserName

Read/Write

String

The user name of the administrator of the branch Connection SRSV server.

Password

Read/Write

String

The password of the administrator of the branch Connection SRSV server.

DisplayName

Read/Write

String

Display name of the branch server on the central Connection server.

PartitionObjectId

Read/Write

ObjectId

Partition object ID associated with the branch on the central Connection server.

SmtpDomain

Read/Write

Domain name

Smtp domain of the branch server.

ProvisionState

Read/Write

0 – Idle, 1 – Scheduled, 2 – In-progress

Current provisioning status of branch on central Connection server.

VmUploadState

Read/Write

0 – Idle, 1 – Scheduled, 2 – In-progress

Current voicemail upload status of branch on central Connection server.

Deleting a Branch

The following is an example of the Delete request that is used for deleting a branch on the central Connection server:

DELETE /vmrest/branches/c3816faf-8dc6-48f3-9c6a-b8e93bba1c42

A branch using this API can only be deleted, if the branch is not in the in-progress state neither for provisioning nor voicemail upload.

The successful response code returned for this API is 201. The error response code and data will depend upon the information provided by you:

Response Code: 201
Data: NA

Assigning a User to Branch

The following is an example of the Put request that is used for assigning a branch to a user by allocating the branch partition to it:

To fetch the partition information of a branch, you can use the API to view the details of a branch. Refer to the Viewing Data for an Individual Branch section for more information. The PartitionObjectId element given in the response XML of this section denotes the partition mapped with the branch.

Response Code: 204

Removing a User from a Branch

The following is an example of the Put request that is used for removing a user from a branch by modifying its partition to some other partition that is not mapped to that branch:

To fetch the partition information of a branch, you can use the API to view the details of a branch. Refer to the Viewing Data for an Individual Branch, page 21-3 section for more information. The PartitionObjectId element given in the response XML of this section denotes the partition mapped with the branch.

Response Code: 204

Listing All Users Those Are Part of a Particular Branch

The following is an example of the Get request that is used to list the users those are part of a particular branch by searching with the partition object ID of the branch:

GET /vmrest/users?query=(PartitionObjectId is partitionObjectIdMappedToBranch)