Cisco Unity Connection Survivable Remote Site Voicemail（SRSV）完全リファレンス ガイド リリース 9.1(1)

偏向のない言語

この製品のマニュアルセットは、偏向のない言語を使用するように配慮されています。このマニュアルセットでの偏向のない言語とは、年齢、障害、性別、人種的アイデンティティ、民族的アイデンティティ、性的指向、社会経済的地位、およびインターセクショナリティに基づく差別を意味しない言語として定義されています。製品ソフトウェアのユーザーインターフェイスにハードコードされている言語、RFP のドキュメントに基づいて使用されている言語、または参照されているサードパーティ製品で使用されている言語によりドキュメントに例外が存在する場合があります。シスコのインクルーシブランゲージに対する取り組みの詳細は、こちらをご覧ください。

翻訳について

このドキュメントは、米国シスコ発行ドキュメントの参考和訳です。リンク情報につきましては、日本語版掲載時点で、英語版にアップデートがあり、リンク先のページが移動/変更されている場合がありますことをご了承ください。あくまでも参考和訳となりますので、正式な内容については米国サイトのドキュメントを参照ください。

マニュアルのコンテンツ
このマニュアル内で検索
ご利用いただける言語
Download Options

Book Title

Cisco Unity Connection Survivable Remote Site Voicemail（SRSV）完全リファレンス ガイド リリース 9.1(1)

Chapter Title

Cisco サバイバブル リモート サイト ボイスメール（SRSV）API

検索結果

Updated:
2013年6月19日

章のタイトル： Cisco サバイバブル リモート サイト ボイスメール（SRSV）API

Cisco サバイバブル リモート サイト ボイスメール（SRSV）API

この章の内容は、次のとおりです。

• 「ブランチの一覧表示」

• 「個々のブランチのデータの表示」

• 「ブランチの作成」

• 「ブランチの更新」

• 「ブランチの削除」

• 「ブランチへのユーザの割り当て」

• 「ブランチのユーザの削除」

• 「特定のブランチに属しているすべてのユーザの一覧表示」

• 「ブランチのコール ハンドラの作成」

ブランチの一覧表示

次に、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>

次の表は、データ フィールドの一覧です。

表 24-1 データ フィールドの説明：ブランチの一覧表示

フィールド名
読み取り/書き込み
有効な値
説明

ObjectId

読み取り/書き込み

objectid

中央の Connection サーバにあるブランチのオブジェクト ID。

IsAlive

読み取り

true/false

中央の Connection サーバとブランチの Connection SRSV サーバ間の接続ステータス。

IsDisabled

読み取り/書き込み

true/false

中央の Connection サーバのブランチの無効ステータス。

OperatorObjectId

読み取り/書き込み

objectid

中央の Connection サーバのブランチのオペレータ ユーザとして割り当てられているユーザのオブジェクト ID。

Port

読み取り/書き込み

ポート番号

ブランチ サーバの PAT ポート番号。

ProvisionState

読み取り/書き込み

0：アイドル

1：スケジュール済み

2：進行中

中央の Connection サーバのブランチの現在のプロビジョニング ステータス。

ServerAddress

読み取り/書き込み

FQDN、IP アドレス

ブランチ サーバのアドレス。

SyncGreetings

読み取り/書き込み

true/false

ユーザのグリーティングの同期を有効または無効にするオプション。

SyncVoiceName

読み取り/書き込み

true/false

ユーザの音声名の同期を有効または無効にするオプション。

UserName

読み取り/書き込み

文字列

中央の Connection とブランチの Connection SRSV サーバ間の REST 通信に使用されるユーザ名。

VmUploadState

読み取り/書き込み

0：アイドル

1：スケジュール済み

2：進行中

中央の Connection サーバのブランチの現在のボイスメールのアップロード ステータスが表示されます。

DisplayName

読み取り/書き込み

文字列

中央の Connection サーバ上のブランチの Connection SRSV サーバの表示名。

PartitionObjectId

読み取り/書き込み

ObjectId

中央の Connection サーバのブランチに関連付けられているパーティションのオブジェクト ID。

SmtpDomain

読み取り/書き込み

ドメイン名（Domain Name）

ブランチの Connection SRSV サーバの SMTP ドメイン。

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

次に、中央の 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>

 

次の表は、データ フィールドの一覧です。

表 24-2 データ フィールドの説明：個々のブランチのデータの表示
フィールド名
読み取り/書き込み
有効な値
説明

URI

読み取り

ブランチにアクセスするための URL。

特定のブランチのサーバ アドレス。

ObjectId

読み取り/書き込み

オブジェクト ID

中央の Connection サーバにあるブランチのオブジェクト ID。

IsAlive

読み取り/書き込み

true/false

中央とブランチの Connection サーバ間の接続ステータス。

IsDisabled

読み取り/書き込み

true/false

中央の Connection サーバのブランチの無効ステータス。

OperatorObjectId

読み取り/書き込み

Objectid

中央の Connection サーバのブランチのオペレータ ユーザとして割り当てられているユーザのオブジェクト ID。

Port

読み取り/書き込み

ポート番号

ブランチ サーバの PAT ポート番号。

Provision

読み取り/書き込み

状態 0 = アイドル、1 = スケジュール済み、2 = 進行中

中央の Connection サーバのブランチの現在のプロビジョニング ステータス。

ServerAddress

読み取り/書き込み

FQDN、IP アドレス

ブランチの Connection サーバのアドレス。

SyncGreetings

読み取り/書き込み

true/false

ユーザのグリーティングの同期を有効または無効にするオプション。

SyncVoiceName

読み取り/書き込み

true/false

ユーザの音声名の同期を有効または無効にするオプション。

UserName

読み取り/書き込み

文字列

特定のブランチの管理者のユーザ名。

VmUploadState

読み取り/書き込み

0：アイドル

1：スケジュール済み

2：進行中

中央の Connection サーバのブランチの現在のボイスメールのアップロード ステータス。

DisplayName

読み取り/書き込み

文字列

中央の Connection サーバ上のブランチ サーバの表示名。

PartitionObjectId

読み取り/書き込み

ObjectId

中央の Connection サーバのブランチに関連付けられているパーティションのオブジェクト ID。

PartitionURI

読み取り/書き込み

URL パーティション

中央の Connection サーバのブランチに関連付けられている URL。

SmtpDomain

読み取り/書き込み

ドメイン名（Domain Name）

ブランチ サーバの SMTP ドメイン。

ブランチの作成

次に、中央の 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

 

次の表は、データ フィールドの一覧です。

表 24-3 データ フィールドの説明：ブランチの作成

フィールド名
読み取り/書き込み
有効な値
説明

IsDisabled

読み取り/書き込み

true/false

ブランチを有効化、つまりアクティブにします。

OperatorObjectId

読み取り/書き込み

オペレータのオブジェクト ID。

ブランチの Connection サーバで受信したメッセージを同期するために使用する必要があるオペレータまたはユーザ。

Port

読み取り/書き込み

ポート番号

ブランチが Cisco Unity Connection と通信するために使用するポート番号。

ServerAddress

読み取り/書き込み

FQDN、IP アドレス

ブランチの Connection SRSV サーバの IP アドレスまたは完全修飾ドメイン名（FQDN）。

SyncGreetings

読み取り/書き込み

true/false

ブランチの Connection SRSV サーバのユーザに対するグリーティングを同期します。

SyncVoiceName

読み取り/書き込み

true/false

ブランチの Connection SRSV サーバのユーザの録音された音声名を同期します。

UserName

読み取り/書き込み

文字列

ブランチの Connection サーバの管理者のユーザ名。

Password

読み取り/書き込み

文字列

ブランチの Connection サーバの管理者のパスワード。

DisplayName

読み取り/書き込み

文字列

中央の Connection サーバ上のブランチ サーバの表示名。

PartitionObjectId

読み取り/書き込み

ObjectId

中央の Connection サーバのブランチに関連付けられているパーティションのオブジェクト ID。

SmtpDomain

読み取り/書き込み

ドメイン名（Domain Name）

ブランチ サーバの SMTP ドメイン。

ブランチの更新

次に、中央の 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 に示されているプロパティのみ、ブランチの修正時に書き込み可能です。任意の時点において、1 つのブランチにスケジュール設定できるのは、プロビジョニングとボイスメール アップロードのいずれか一方だけです。そのため、ProvisionState プロパティと VmUploadState プロパティを同時に要求 XML に指定することはできません。これらのフィールドの値は 1 のみです。

この API に返される成功の応答コードは 201 です。エラー応答コードとデータは、ユーザが指定する情報によって異なります。

応答コード：201

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

 

次の表は、データ フィールドの一覧です。

表 24-4 データ フィールドの説明：ブランチの更新
フィールド名
読み取り/書き込み
有効な値
説明

IsDisabled

読み取り/書き込み

true/false

ブランチを有効化、つまりアクティブにします。

OperatorObjectId

読み取り/書き込み

オペレータのオブジェクト ID。

ブランチの Connection サーバで受信したメッセージを同期するために使用する必要があるオペレータまたはユーザ。

Port

読み取り/書き込み

ポート番号

ブランチが Cisco Unity Connection と通信するために使用するポート番号。

ServerAddress

読み取り/書き込み

FQDN、IP アドレス

ブランチの Connection サーバの IP アドレスまたは完全修飾ドメイン名（FQDN）。

SyncGreetings

読み取り/書き込み

true/false

ブランチのユーザに対するグリーティングを同期します。

SyncVoiceName

読み取り/書き込み

true/false

ブランチのユーザの録音された音声名を同期します。

UserName

読み取り/書き込み

文字列

ブランチの Connection SRSV サーバの管理者のユーザ名。

Password

読み取り/書き込み

文字列

ブランチの Connection SRSV サーバの管理者のパスワード。

DisplayName

読み取り/書き込み

文字列

中央の Connection サーバ上のブランチ サーバの表示名。

PartitionObjectId

読み取り/書き込み

ObjectId

中央の Connection サーバのブランチに関連付けられているパーティションのオブジェクト ID。

SmtpDomain

読み取り/書き込み

ドメイン名（Domain Name）

ブランチ サーバの SMTP ドメイン。

ProvisionState

読み取り/書き込み

0：アイドル

1：スケジュール済み

2：進行中

中央の Connection サーバのブランチの現在のプロビジョニング ステータス。

VmUploadState

読み取り/書き込み

0：アイドル

1：スケジュール済み

2：進行中

中央の Connection サーバのブランチの現在のボイスメールのアップロード ステータス。

ブランチの削除

次に、中央の Connection サーバのブランチを削除するために使用される Delete 要求の例を示します。

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

 

ブランチは、プロビジョニングやボイスメールのアップロードが進行中状態でない場合に、この API を使用してのみ削除できます。

この API に返される成功の応答コードは 201 です。エラー応答コードとデータは、ユーザが指定する情報によって異なります。

応答コード：201 データ：NA

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

次に、ブランチのパーティションを割り当てることでユーザにブランチを割り当てるために使用される 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>

 

表 24-5 データ フィールドの説明：特定のブランチに属しているすべてのユーザの一覧表示
フィールド名
読み取り/書き込み
有効な値
説明

URI

読み取り

ブランチにアクセスするための URL。

特定のブランチのサーバ アドレス。

ObjectId

読み取り/書き込み

オブジェクト ID

中央の Connection サーバにあるブランチのオブジェクト ID。

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

次に、コール ハンドラを作成するために使用される PUT 要求の例を示します。

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

 

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

 

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

応答コード：201

/vmrest/handlers/callhandlers/<callhandlerObjectId>

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

Feedbackフィードバック

シスコに問い合わせ