Cisco Unity Connection Survivable Remote Site Voicemail の完全なリファレンスガイド（SRSV）

ブランチの一覧表示

次に、Cisco Unity Connection サーバーに関連付けられているブランチをリストする *GET* リクエストの例を示します。

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

次に、上記の *GET* リクエストからのレスポンスの例を示しますが、実際の結果は提供された情報によって異なります。

レスポンスコード：200


<Branches total="2">
 <Branch>
  <URI>/vmrest/branches/1e0ed69d-028d-4156-9d68-f14a90438448</URI>
  <ObjectId>1e0ed69d-028d-4156-9d68-f14a90438448</ObjectId>
  <IsAlive>true</IsAlive>
  <IsDisabled>false</IsDisabled>
  <OperatorObjectId>159bb671-cbba-4964-b06b-871f990e1de8</OperatorObjectId>
  <Port>443</Port>
  <ProvisionState>0</ProvisionState>
  <ServerAddress>mysrsv.cisco.com</ServerAddress>
  <SyncGreetings>false</SyncGreetings>
  <SyncVoiceName>false</SyncVoiceName>
  <UserName>admin</UserName>
  <VmUploadState>0</VmUploadState>
  <DisplayName>Branch1</DisplayName>
  <PartitionObjectId>d6ac04c5-fb36-4e21-9e60-d15e0f9c6971</PartitionObjectId>
  <PartitionURI>/vmrest/partitions/d6ac04c5-fb36-4e21-9e60-d15e0f9c6971</PartitionURI>
  <SmtpDomain>mysrsv.cisco.com</SmtpDomain>
  </Branch>
  <Branch>
  <URI>/vmrest/branches/c3816faf-8dc6-48f3-9c6a-b8e93bba1c42</URI>
  <ObjectId>c3816faf-8dc6-48f3-9c6a-b8e93bba1c42</ObjectId>
  <IsAlive>true</IsAlive>
  <IsDisabled>false</IsDisabled>
  <OperatorObjectId>159bb671-cbba-4964-b06b-871f990e1de8</OperatorObjectId>
  <Port>443</Port>
  <ProvisionState>0</ProvisionState>
  <ServerAddress>mysrsv1.cisco.com</ServerAddress>
  <SyncGreetings>false</SyncGreetings>
  <SyncVoiceName>false</SyncVoiceName>
  <UserName>admin</UserName>
  <VmUploadState>0</VmUploadState>
  <DisplayName>Branch2</DisplayName>
  <PartitionObjectId>765cd618-0cff-43a4-b781-efdba282dba4</PartitionObjectId>
  <PartitionURI>/vmrest/partitions/765cd618-0cff-43a4-b781-efdba282dba4</PartitionURI>
  <SmtpDomain>mysrsv1.cisco.com</SmtpDomain>
  </Branch>
 </Branches>

次の表に、データフィールドを示します。

表 1. データフィールドの説明：ブランチのリスト
フィールド名	読み取り/書き込み	使用可能な値	説明
ObjectId	読み取り/書き込み	objectid	中央 Unity Connection サーバーにあるブランチのオブジェクト ID。
IsAlive	読み取り	true/false	中央 Unity Connection サーバーとブランチサーバー間の接続ステータス。
IsDisabled	読み取り/書き込み	true/false	中央 Unity Connection サーバーのブランチの無効ステータス。
OperatorObjectId	読み取り/書き込み	objectid	中央 Unity Connection サーバー上のブランチのオペレータユーザーとして割り当てられているユーザーのオブジェクト ID。
Port	読み取り/書き込み	ポート番号	ブランチサーバーの PAT ポート番号。
ProvisionState	読み取り/書き込み	0：Idle（アイドル）、 1：Scheduled（スケジュール済み）、 2：In-progress（処理中）	中央 Unity Connection サーバー上のブランチの現在のプロビジョニングステータス。
ServerAddress	読み取り/書き込み	FQDN、IP アドレス	ブランチサーバーのアドレス。
SyncGreetings	読み取り/書き込み	true/false	ユーザーのグリーティングの同期を有効または無効にするオプション。
SyncVoiceName	読み取り/書き込み	true/false	ユーザーの音声名の同期を有効/無効にするオプション。
UserName	読み取り/書き込み	文字列	中央 Unity Connection とブランチサーバー間の REST 通信に使用されるユーザー名。
VmUploadState	読み取り/書き込み	0：Idle（アイドル）、 1：Scheduled（スケジュール済み）、 2：In-progress（処理中）	ブランチから中央 Unity Connection サーバーへの現在のボイスメールアップロードステータスを表示します。
DisplayName	読み取り/書き込み	文字列	中央 Unity Connection サーバー上のブランチ Unity Connection SRSV サーバーの表示名。
PartitionObjectId	読み取り/書き込み	ObjectId	中央 Unity Connection サーバーのブランチに関連付けられているパーティションオブジェクト ID。
SmtpDomain	読み取り/書き込み	ドメイン名	ブランチサーバーのSMTPドメイン。

個々のブランチのデータを表示する

次に、中央 Unity Connection サーバーに関連付けられている個々のブランチのプロパティをリストする *GET* リクエストの例を示します。

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

次に、上記の *GET* リクエストからのレスポンスの例を示しますが、実際の結果は提供された情報によって異なります。

レスポンスコード：200


<Branch>
 <URI>/vmrest/branches/c3816faf-8dc6-48f3-9c6a-b8e93bba1c42</URI>
 <ObjectId>c3816faf-8dc6-48f3-9c6a-b8e93bba1c42</ObjectId>
 <IsAlive>true</IsAlive>
 <IsDisabled>false</IsDisabled>
 <OperatorObjectId>159bb671-cbba-4964-b06b-871f990e1de8</OperatorObjectId>
 <Port>443</Port>
 <ProvisionState>0</ProvisionState>
 <ServerAddress>mysrsv.cisco.com</ServerAddress>
 <SyncGreetings>false</SyncGreetings>
 <SyncVoiceName>false</SyncVoiceName>
 <UserName>admin</UserName>
 <VmUploadState>0</VmUploadState>
 <DisplayName>branch16</DisplayName>
 <PartitionObjectId>765cd618-0cff-43a4-b781-efdba282dba4</PartitionObjectId>
 <PartitionURI>/vmrest/partitions/765cd618-0cff-43a4-b781-efdba282dba4</PartitionURI>
 <SmtpDomain>mysrsv.cisco.com</SmtpDomain>
</Branch>

次の表に、データフィールドを示します。

表 2. データフィールドの説明：個々のブランチのデータの表示
フィールド名	読み取り/書き込み	使用可能な値	説明
URI	読み取り	ブランチにアクセスするための URL。	特定のブランチのサーバーアドレス。
ObjectId	読み取り/書き込み	オブジェクト ID	中央 Unity Connection サーバーにあるブランチのオブジェクト ID。
IsAlive	読み取り/書き込み	true/false	中央ブランチの Unity Connection サーバー間の接続ステータス。
IsDisabled	読み取り/書き込み	true/false	中央 Unity Connection サーバーのブランチの無効ステータス。
OperatorObjectId	読み取り/書き込み	Objectid	中央 Unity Connection サーバー上のブランチのオペレータユーザーとして割り当てられているユーザーのオブジェクト ID。
ポート	読み取り/書き込み	ポート番号	ブランチサーバーの PAT ポート番号。
プロビジョニング	読み取り/書き込み	状態 0：アイドル（Idle）、1：スケジュール済み（Scheduled）、2：処理中（In-progress）	中央 Unity Connection サーバー上のブランチの現在のプロビジョニングステータス。
ServerAddress	読み取り/書き込み	FQDN、IP アドレス	ブランチ Unity Connection サーバーのアドレス。
SyncGreetings	読み取り/書き込み	true/false	ユーザーのグリーティングの同期を有効または無効にするオプション。
SyncVoiceName	読み取り/書き込み	true/false	ユーザーの音声名の同期を有効/無効にするオプション。
UserName	読み取り/書き込み	文字列	特定のブランチの管理者のユーザー名。
VmUploadState	読み取り/書き込み	0：Idle（アイドル）、 1：Scheduled（スケジュール済み）、 2：In-progress（処理中）	中央 Unity Connection サーバー上のブランチの現在のボイスメールアップロードステータス。
DisplayName	読み取り/書き込み	文字列	中央 Unity Connection サーバー上のブランチサーバーの表示名。
PartitionObjectId	読み取り/書き込み	ObjectId	中央 Unity Connection サーバーのブランチに関連付けられているパーティションオブジェクト ID。
PartitionURI	読み取り/書き込み	URL Partition	中央 Unity Connection サーバーのブランチに関連付けられている URL。
SmtpDomain	読み取り/書き込み	ドメイン名	ブランチサーバーのSMTPドメイン。

ブランチを作成する

次に、中央 Unity Connection サーバーでブランチを作成するために使用される *POST* リクエストの例を示します。

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


<Branch>
<IsDisabled>false</IsDisabled>
<OperatorObjectId>159bb671-cbba-4964-b06b-871f990e1de8</OperatorObjectId>
<Port>443</Port>
<ServerAddress>mysrsv.cisco.com</ServerAddress>
<SyncGreetings>false</SyncGreetings>
<SyncVoiceName>false</SyncVoiceName>
<UserName>admin</UserName>
<Password>test</Password>
<DisplayName>branch16</DisplayName>
<PartitionObjectId>765cd618-0cff-43a4-b781-efdba282dba4</PartitionObjectId>
<SmtpDomain>mysrsv.cisco.com</SmtpDomain>
</Branch>

必須プロパティは、ServerAddress、UserName、Password、DisplayName、PartitionObjectId、および SmtpDomain です。

この API に対して返される成功レスポンスコードは 201 です。エラーレスポンスコードとデータは、提供された情報によって異なります。

レスポンスコード：201


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

次の表に、データフィールドを示します。

表 3. データフィールドの説明：ブランチの作成
フィールド名	読み取り/書き込み	使用可能な値	説明
IsDisabled	読み取り/書き込み	true/false	ブランチを有効またはアクティブにします。
OperatorObjectId	読み取り/書き込み	演算子のオブジェクト ID。	ブランチサーバーが受信したメッセージを同期するために使用する必要があるオペレータまたはユーザー。
Port	読み取り/書き込み	ポート番号	ブランチが Cisco Unity Connection との通信に使用するポート番号。
ServerAddress	読み取り/書き込み	FQDN、IP アドレス	ブランチサーバーの IP アドレスまたは完全修飾ドメイン名（FQDN）。
SyncGreetings	読み取り/書き込み	true/false	ブランチサーバー上のユーザーのグリーティングを同期します。
SyncVoiceName	読み取り/書き込み	true/false	ブランチサーバー上のユーザーの録音された音声名を同期します。
UserName	読み取り/書き込み	文字列	ブランチ Unity Connection サーバーの管理者のユーザー名。
Password	読み取り/書き込み	文字列	ブランチサーバーの管理者のパスワード。
DisplayName	読み取り/書き込み	文字列	中央 Unity Connection サーバー上のブランチサーバーの表示名。
PartitionObjectId	読み取り/書き込み	ObjectId	中央 Unity Connection サーバーのブランチに関連付けられているパーティションオブジェクト ID。
SmtpDomain	読み取り/書き込み	ドメイン名	ブランチサーバーのSMTPドメイン。

ブランチを更新する

次に、中央 Unity Connection サーバーのブランチを更新するために使用される *PUT* 要求の例を示します。

PUT https://<connection-server>/vmrest/branches/c3816faf-8dc6-48f3-9c6a-b8e93bba1c42


<Branch>
<IsDisabled>false</IsDisabled>
<OperatorObjectId>159bb671-cbba-4964-b06b-871f990e1de8</OperatorObjectId>
<Port>443</Port>
<ServerAddress>mysrsv.cisco.com</ServerAddress>
<SyncGreetings>false</SyncGreetings>
<SyncVoiceName>false</SyncVoiceName>
<UserName>admin</UserName>
<Password>test</Password>
<DisplayName>branch16</DisplayName>
<PartitionObjectId>765cd618-0cff-43a4-b781-efdba282dba4</PartitionObjectId>
<SmtpDomain>mysrsv.cisco.com</SmtpDomain>
<ProvisionState>1</ProvisionState>
<VmUploadState>0</VmUploadState>
</Branch>

この *PUT* リクエストは、プロビジョニングとボイスメールのアップロードのためにブランチをスケジュールするためにも使用されます。ブランチの変更時には、上記の XML に記載されているプロパティのみが書き込み可能です。プロパティ（ProvisionState および VmUploadState）は、特定の時点でプロビジョニングまたはボイスメールのアップロードのためにブランチをスケジュールできるため、同時にリクエスト XML に配置することはできません。これらのフィールドの値は 1 のみです。

この API に対して返される成功レスポンスコードは 201 です。エラーレスポンスコードとデータは、提供された情報によって異なります。

レスポンスコード：201


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

次の表に、データフィールドを示します。

表 4. データフィールドの説明：ブランチの更新
フィールド名	読み取り/書き込み	使用可能な値	説明
IsDisabled	読み取り/書き込み	true/false	ブランチを有効またはアクティブにします。
OperatorObjectId	読み取り/書き込み	演算子のオブジェクト ID。	ブランチサーバーが受信したメッセージを同期するために使用する必要があるオペレータまたはユーザー。
Port	読み取り/書き込み	ポート番号	ブランチが Unity Connection との通信に使用するポート番号。
ServerAddress	読み取り/書き込み	FQDN、IP アドレス	ブランチサーバーの IP アドレスまたは完全修飾ドメイン名（FQDN）。
SyncGreetings	読み取り/書き込み	true/false	ブランチのユーザーのグリーティングを同期します。
SyncVoiceName	読み取り/書き込み	true/false	ブランチのユーザーの録音された音声名を同期します。
UserName	読み取り/書き込み	文字列	ブランチサーバーの管理者のユーザー名。
Password	読み取り/書き込み	文字列	ブランチサーバーの管理者のパスワード。
DisplayName	読み取り/書き込み	文字列	中央 Unity Connection サーバー上のブランチサーバーの表示名。
PartitionObjectId	読み取り/書き込み	ObjectId	中央 Unity Connection サーバーのブランチに関連付けられているパーティションオブジェクト ID。
SMTPドメイン	読み取り/書き込み	ドメイン名	ブランチサーバーのSMTPドメイン。
ProvisionState	読み取り/書き込み	0：Idle（アイドル）、 1：Scheduled（スケジュール済み）、 2：In-progress（処理中）	中央 Unity Connection サーバーのブランチの現在のプロビジョニングステータス。
VmUploadState	読み取り/書き込み	0：Idle（アイドル）、 1：Scheduled（スケジュール済み）、 2：In-progress（処理中）	中央 Unity Connection サーバー上のブランチの現在のボイスメールアップロードステータス。

ブランチを削除する

次に、中央 Unity Connection サーバー上のブランチを削除するために使用される削除リクエストの例を示します。


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

この API を使用するブランチは、プロビジョニングまたはボイスメールのアップロードのために [進行中（In-Progress）] 状態の場合、削除できません。

この API に対して返される成功応答コードは 201 ですが、エラーレスポンスコードとデータは、提供された情報によって異なります。

レスポンスコード：201

データ：なし

ブランチへユーザーを割り当てる

次に、ブランチパーティションを割り当てることによってブランチをユーザーに割り当てるために使用される Put リクエストの例を示します。


PUT /vmrest/users/<userObjectId>
<User>
<PartitionObjectId>partitionObjectIdMappedToBranch</PartitionObjectId>
</User>

ブランチのパーティション情報を取得するには、API を使用してブランチの詳細を表示します。詳細については、「個々のブランチのデータを表示する」の項を参照してください。このセクションのレスポンス XML で指定された PartitionObjectId 要素は、ブランチにマッピングされたパーティションを示します。

レスポンスコード：204

ブランチからユーザーを削除する

次に、そのブランチにマッピングされていない他のパーティションにパーティションを変更することによって、ブランチからユーザーを削除するために使用される Put リクエストの例を示します。


PUT /vmrest/users/<userObjectId>
<User>
<PartitionObjectId>partitionObjectIdNotMappedToBranch</PartitionObjectId>
</User>

API を使用して、ブランチのパーティション情報を表示できます。詳細については、「個々のブランチのデータを表示する」の項を参照してください。このセクションのレスポンス XML で指定された PartitionObjectId 要素は、ブランチにマッピングされたパーティションを示します。

レスポンスコード：204

特定のブランチのすべてのユーザーを一覧表示する

次に、ブランチのパーティションオブジェクト ID で検索することによって、特定のブランチの一部であるユーザーを一覧表示するために使用される Get 要求の例を示します。


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

レスポンスコード：200


<Users total="10">
<User>
<URI>/vmrest/users/cb13e6a9-7322-45fa-91cd-7a0b1e21b754</URI> <ObjectId>cb13e6a9-7322-45fa-91cd-7a0b1e21b754</ObjectId>
</User>
</Users>

表 5. データフィールドの説明：特定のブランチのすべてのユーザー部分の一覧表示
フィールド名	読み取り/書き込み	使用可能な値	説明
URI	読み取り	ブランチにアクセスするための URL。	特定のブランチのサーバーアドレス。
ObjectId	読み取り/書き込み	オブジェクト ID	中央 Unity Connection サーバーにあるブランチのオブジェクト ID。

ブランチのコールハンドラを作成する

次に、コールハンドラの作成に使用される Put リクエストの例を示します。


POST /vmrest/handlers/callhandlers?templateObjectId=<callhandlerTemplateObjectId>

<Callhandler>
<DisplayName>Test</DisplayName>
</Callhandler>

これは、ブランチでも使用できるコールハンドラを作成するための既存の API です。

レスポンスコード：201


/vmrest/handlers/callhandlers/<callhandlerObjectId>

偏向のない言語

翻訳について

Book Title

Cisco Unity Connection Survivable Remote Site Voicemail の完全なリファレンスガイド（SRSV）

Chapter Title

Cisco Unity Connection Survivable Remote Site Voicemail API

検索結果

章のタイトル： Cisco Unity Connection Survivable Remote Site Voicemail API

Cisco Unity Connection Survivable Remote Site Voicemail API

ブランチの一覧表示

個々のブランチのデータを表示する

ブランチを作成する

ブランチを更新する

ブランチを削除する

ブランチへユーザーを割り当てる

ブランチからユーザーを削除する

特定のブランチのすべてのユーザーを一覧表示する

ブランチのコールハンドラを作成する

このドキュメントは役に立ちましたか?

シスコに問い合わせ