この製品のマニュアルセットは、偏向のない言語を使用するように配慮されています。このマニュアルセットでの偏向のない言語とは、年齢、障害、性別、人種的アイデンティティ、民族的アイデンティティ、性的指向、社会経済的地位、およびインターセクショナリティに基づく差別を意味しない言語として定義されています。製品ソフトウェアのユーザーインターフェイスにハードコードされている言語、RFP のドキュメントに基づいて使用されている言語、または参照されているサードパーティ製品で使用されている言語によりドキュメントに例外が存在する場合があります。シスコのインクルーシブランゲージに対する取り組みの詳細は、こちらをご覧ください。
このドキュメントは、米国シスコ発行ドキュメントの参考和訳です。リンク情報につきましては、日本語版掲載時点で、英語版にアップデートがあり、リンク先のページが移動/変更されている場合がありますことをご了承ください。あくまでも参考和訳となりますので、正式な内容については米国サイトのドキュメントを参照ください。
次に、Cisco Unity Connection サーバに関連付けられたブランチを一覧表示する *GET* 要求の例を示します。
GET https://<connection-server>/vmrest/branches
以下は、上記の *GET* 要求からの応答例です。ただし、実際の結果は、入力される情報によって異なります。
<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>
次に、中央の Unity Connection サーバに関連する個々のブランチのプロパティを一覧表示する *GET* 要求の例を示します。
GET https://<connection-server>/vmrest/branches/<objectid>
以下は、上記の *GET* 要求からの応答例です。ただし、実際の結果は、入力される情報によって異なります。
<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>
中央の Unity Connection サーバにおける、ブランチ担当オペレータ ユーザとして割り当てられているユーザのオブジェクト ID。 |
|||
中央の Unity Connection サーバにおける、ブランチに関連付けられているパーティションのオブジェクト ID。 |
|||
次に、中央の 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 です。エラー応答コードとデータは、入力される情報によって異なります。
/vmrest/branches/c3816faf-8dc6-48f3-9c6a-b8e93bba1c42
中央の Unity Connection サーバにおける、ブランチに関連付けられているパーティションのオブジェクト ID。 |
|||
次に、中央の 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 に示されているプロパティのみ、ブランチの修正時に書き込み可能です。特定の時点において、1 つのブランチにスケジュール設定できるのは、プロビジョニングまたはボイスメール アップロードのいずれか一方だけです。そのため、ProvisionState プロパティと VmUploadState プロパティを同時に要求 XML に指定することはできません。これらのフィールドに設定可能な値は 1 だけです。
この API に返される成功の応答コードは 201 です。エラー応答コードとデータは、入力される情報によって異なります。
/vmrest/branches/c3816faf-8dc6-48f3-9c6a-b8e93bba1c42
中央の Unity Connection サーバにおける、ブランチに関連付けられているパーティションのオブジェクト ID。 |
|||
次に、中央の Unity Connection サーバのブランチを削除するために使用される Delete 要求の例を示します。
DELETE /vmrest/branches/c3816faf-8dc6-48f3-9c6a-b8e93bba1c42
この API を使用しているブランチでプロビジョニングやボイスメールのアップロードが進行中の場合、そのブランチは削除できません。
この API に返される成功の応答コードは 201 ですが、エラー応答コードとデータは入力される情報によって異なります。
次に、ブランチのパーティションを割り当てることでユーザにブランチを割り当てるために使用される PUT 要求の例を示します。
PUT /vmrest/users/<userObjectId> <User> <PartitionObjectId>partitionObjectIdMappedToBranch</PartitionObjectId> </User>
ブランチのパーティション情報を取得する場合は、API を使用してブランチの詳細を表示できます。詳細については、「個々のブランチのデータの表示」の項を参照してください。この項の応答 XML に指定されている PartitionObjectId 要素はブランチにマッピングされるパーティションを表します。
次に、ユーザのパーティションをブランチにマッピングされていない他のパーティションに変更して、ブランチからユーザを削除するために使用される PUT 要求の例を示します。
PUT /vmrest/users/<userObjectId> <User> <PartitionObjectId>partitionObjectIdNotMappedToBranch</PartitionObjectId> </User>
API を使用してブランチのパーティション情報を表示できます。詳細については、「個々のブランチのデータの表示」の項を参照してください。この項の応答 XML に指定されている PartitionObjectId 要素はブランチにマッピングされるパーティションを表します。
次に、ブランチのパーティション オブジェクト ID で検索して、特定のブランチに属しているユーザを一覧表示するために使用される GET 要求の例を示します。
GET /vmrest/users?query=(PartitionObjectId is partitionObjectIdMappedToBranch)
<Users total="10"> <User> <URI>/vmrest/users/cb13e6a9-7322-45fa-91cd-7a0b1e21b754</URI> <ObjectId>cb13e6a9-7322-45fa-91cd-7a0b1e21b754</ObjectId> </User> </Users>
次に、コール ハンドラを作成するために使用される PUT 要求の例を示します。
POST /vmrest/handlers/callhandlers?templateObjectId=<callhandlerTemplateObjectId> <Callhandler> <DisplayName>Test</DisplayName> </Callhandler>
これは、ブランチでも使用できるコール ハンドラを作成するための既存の API です。
/vmrest/handlers/callhandlers/<callhandlerObjectId>