Cisco IPICS API リファレンス ガイド
API 関数
API 関数
発行日;2012/01/13 | 英語版ドキュメント(2011/02/01 版) | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 3MB) | フィードバック

目次

API 関数

関数の概要

API 関数

activateVtg

addChannelToVtg

addPhoneAssociatedToUser

addRadioToVtg

addUserToUserGroup

addUserToVtg

addVtgToVtg

associateChannelsToUser

associateRadiosToUser

createChannel

createUser

createUserGroup

createVtg

deactivateVtg

deleteChannel

deleteUser

deleteVTG

dialAllVtgMembers

dialVtgMember

dialVtgMembers

disableChannel

disableUser

enableChannel

enableUser

executeNotificationPolicy

executePolicy

getAllChannelGroups

getAllChannels

getAllChannelsInChannelGroup

getAllPolicies

getAllRadios

getAllUserGroups

getAllUsers

getAllVtgs

getBelongingOpsViewForUser

getChannelsAssociatedToUser

getChannelStatus

getDigitIds

getPhonesAssociatedToUser

getPoliciesAssociatedToUser

getPolicyExecutionStatus

getRadiosAssociatedToUser

getUserAddress

getUserAudioStatus

getUserDialPreference

getUserGroupMembers

getUserListenerStatus

getUserNotificationPreference

getUserRoles

getUsersAssociatedToRadio

getUserStatus

getVtgParticipants

getVtgParticipantStatus

getVtgStatus

getVtgsAssociatedToUser

isActiveChannel

isActiveUser

isActiveVtg

notifyAllVtgMembers

notifyVtgMember

notifyVtgMembers

removeChannelFromVtg

removePhoneAssociatedToUser

removeUserFromVtg

removeVtgFromVtg

setBelongingOpsViewForUser

setDialPreference

setDigitIds

setDigitPassword

setNotificationPreference

setUserAddress

setUserAudioStatus

setUserListenerStatus

API 関数

この章では、Cisco IPICS API の各関数について詳しく説明します。次のトピックについて説明します。

「関数の概要」

「API 関数」

関数の概要

表 2-1 に、Cisco IPICS API 関数の概要を示します。各関数については、記載されている項で詳しく説明します。

 

表 2-1 API 関数の概要

関数名および参照先
説明

ユーザ管理の関数

「addPhoneAssociatedToUser」

電話機とユーザを関連付ける

「addUserToUserGroup」

ユーザをユーザ グループに追加する

「associateChannelsToUser」

1 つまたは複数のチャネルをユーザに関連付ける

「associateRadiosToUser」

1 つまたは複数の無線を指定されたユーザに関連付ける

「createUser」

Cisco IPICS ユーザを作成する

「createUserGroup」

ユーザ グループを作成する

「deleteUser」

Cisco IPICS ユーザを削除する

「disableUser」

Cisco IPICS ユーザを無効にする

「enableUser」

Cisco IPICS ユーザを有効にする

「isActiveUser」

ユーザがアクティブまたは無効のどちらであるのかを判別する

「removePhoneAssociatedToUser」

電話機とユーザの関連付けを解除する

「setBelongingOpsViewForUser」

ops ビューを指定されたユーザに割り当てる

「setDialPreference」

ユーザの新しいダイヤル プリファレンスを追加する

「setDigitIds」

ユーザのディジット ID を設定する

「setDigitPassword」

ユーザのディジット パスワードを設定する

「setNotificationPreference」

ユーザの新しい通知プリファレンスを追加する

「setUserAddress」

ユーザの物理アドレスを追加する

「setUserAudioStatus」

ユーザが PMC 上でオーディオを再生および転送できる機能を有効または無効にする

「setUserListenerStatus」

ユーザが PMC 上でオーディオを転送できる機能を有効または無効にする

VTG 管理に関する関数

「activateVtg」

VTG をアクティブにする(VTG がまだアクティブでない場合)

「addChannelToVtg」

アクティブまたは非アクティブ VTG にチャネルを追加する

「addRadioToVtg」

アクティブまたは非アクティブ VTG に無線を追加する

「addUserToVtg」

アクティブまたは非アクティブ VTG にユーザを追加する

「addVtgToVtg」

VTG を別の VTG に追加する

「createVtg」

指定された名前で VTG を作成する

「deactivateVtg」

VTG を非アクティブにする

「deleteVTG」

VTG を削除する

「isActiveVtg」

VTG がアクティブまたは無効のどちらであるのかを判別する

「removeChannelFromVtg」

チャネルを VTG から削除する

「removeUserFromVtg」

ユーザを VTG から削除する

「removeVtgFromVtg」

VTG を VTG から削除する

チャネル管理の関数

「createChannel」

指定された VTG 名と短い名前を使用してチャネルを作成する

「deleteChannel」

チャネルを削除する

「disableChannel」

現在のチャネルがアイドル状態の場合に、チャネルを無効状態に変更する

「enableChannel」

現在のチャネルが無効状態の場合に、チャネルをアイドル状態に変更する

「isActiveChannel」

チャネルがアクティブまたは無効のどちらであるのかを判別する

ポリシーおよびダイヤル機能管理の関数

「dialAllVtgMembers」

VTG の一部であるユーザ グループのメンバーを含む、VTG のすべてのユーザ メンバーにダイヤルアウトする

「dialVtgMember」

VTG の指定されたメンバーにダイヤルアウトする

「dialVtgMembers」

リストに記載されたユーザまたは VTG のすべてのユーザにダイヤルアウトする

「executeNotificationPolicy」

指定された ID を持つ通知ポリシーを実行する

「executePolicy」

指定されたポリシーを実行する

「notifyAllVtgMembers」

VTG のユーザ グループのメンバーも含め、VTG のすべてのユーザに通知を送信する

「notifyVtgMember」

VTG の特定のメンバーに通知を送信する

「notifyVtgMembers」

リストに記載されたユーザまたは VTG のすべてのユーザに通知を送信する

ステータス取得の関数

「getAllChannels」

すべてのチャネルを取得する

「getAllChannelGroups」

すべてのチャネル グループを取得する

「getAllChannelsInChannelGroup」

指定されたチャネル グループに属するすべてのチャネルを取得する

「getAllPolicies」

すべてのポリシーを取得する

「getAllRadios」

すべての無線を取得する

「getAllUsers」

すべての Cisco IPICS ユーザを取得する

「getAllUserGroups」

すべてのユーザ グループを取得する

「getAllVtgs」

すべての VTG を取得する

「getBelongingOpsViewForUser」

指定されたユーザが属する ops ビューを取得する

「getChannelsAssociatedToUser」

指定されたユーザに関連付けられているすべてのチャネルを取得する

「getChannelStatus」

指定されたチャネルのステータスを取得する

「getDigitIds」

ユーザの ディジット ID を取得する

「getPhonesAssociatedToUser」

指定されたユーザに関連付けられているすべての電話機を取得する

「getPoliciesAssociatedToUser」

指定されたユーザに関連付けられているすべてのポリシーを取得する

「getPolicyExecutionStatus」

指定されたポリシーの実行ステータスを取得する

「getRadiosAssociatedToUser」

指定されたユーザに関連付けられている無線のリストを返す

「getUserAddress」

指定されたユーザの物理アドレスを取得する

「getUserAudioStatus」

ユーザの PMC でオーディオが無効または有効のどちらであるのかを示すフラグを返す

「getUserDialPreference」

指定されたユーザに関連付けられているダイヤル プリファレンスを取得する

「getUserGroupMembers」

指定されたユーザ グループのすべてのユーザを取得する

「getUserListenerStatus」

ユーザの PMC が受信専用モードであるかどうかを示すフラグを返す

「getUserNotificationPreference」

指定されたユーザに関連付けられている通知プリファレンスを取得する

「getUserRoles」

指定されたユーザのロール リストを取得する

「getUsersAssociatedToRadio」

指定された無線に関連付けられているユーザのリストを返す

「getUserStatus」

1 人または複数のユーザのアクティブ ステータスを取得する

「getVtgParticipants」

VTG の参加者全員を取得する

「getVtgParticipantStatus」

VTG の参加者のステータスを取得する

「getVtgStatus」

VTG の ID、名前、説明、ステータスを取得する

「getVtgsAssociatedToUser」

ユーザに関連付けられているすべての VTG を取得する

API 関数

ここでは、各 Cisco IPICS API 関数の詳細について説明します。関数の説明には、次の情報が含まれます。

関数名:関数の名前

説明:関数の一般的な動作

パラメータ:関数に必要なパラメータ

返される結果:関数に対して Cisco IPICS から返される結果の説明

例外:関数がスローできる例外および例外の原因となる状況の説明

応答例:関数が受け取れる応答の例

activateVtg

 

関数名

activateVtg

説明

VTG をアクティブにする(VTG がまだ非アクティブな場合)。

パラメータ

vtgId (整数) - アクティブにする VTG の ID。

返される結果

VTG がアクティブになった場合は true。VTG がアクティブになっていない場合は false。

例外

指定された ID を持つ VTG が存在しない場合、マルチキャスト プールが設定されていない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:activateVtgResponse>
<ns:ActivateVtgReturn>true</ns:ActivateVtgReturn>
</ns:activateVtgResponse>

addChannelToVtg

 

関数名

addChannelToVtg

説明

アクティブまたは非アクティブの VTG にチャネルを追加する。

パラメータ

vtgId (整数) - ユーザを追加する VTG の ID。

channelId (整数) - 指定された VTG に追加するチャネルの ID。

返される結果

チャネルが VTG に追加された場合、またはチャネルがすでに VTG に参加している場合は true。チャネルが VTG に追加されていない場合は false。

例外

指定された ID を持つ VTG がシステムに存在しない場合、チャネルがシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:addChannelToVtgResponse>
<ns:addChannelToVtgReturn>true</ns:addChannelToVtgReturn>
</ns:addChannelToVtgResponse>

addPhoneAssociatedToUser

 

関数名

addPhoneAssociatedToUser

説明

電話機とユーザを関連付ける。

パラメータ

userLogin (ストリング) - 電話機を関連付けるユーザの一意のログイン ID。

dialNumber (ストリング) - ユーザに関連付ける電話機のダイヤル番号。

返される結果

電話機がユーザに関連付けられた場合、または電話機がユーザにすでに関連付けられている場合は true。電話機がユーザに関連付けられていない場合は false。

例外

指定された ID を持つユーザがシステムに存在しない場合、指定されたダイヤル番号を持つ電話機がシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:addPhoneAssociatedToUserResponse>
<ns:addPhoneAssociatedToUserReturn>true
</ns:addPhoneAssociatedToUserReturn>
</ns:addPhoneAssociatedToUserResponse>

addRadioToVtg

 

関数名

addRadioToVtg

説明

アクティブまたは非アクティブの VTG に無線を追加する。

パラメータ

radioId (整数) - 追加する無線の ID。

vtgId (整数) - 無線を追加する VTG の ID。

返される結果

無線が VTG に追加された場合、または無線がすでに VTG に存在する場合は true。無線が VTG に追加されていない場合は false。

例外

指定された ID を持つ VTG が存在しない場合、無線がシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:addRadioToVtgResponse>
<ns:addRadioToVtgReturn>true</ns:addRadioToVtgReturn>
</ns:addRadioToVtgResponse>

addUserToUserGroup

 

関数名

addUserToUserGroup

説明

ユーザをユーザ グループに追加する。

パラメータ

userLogin (ストリング) - 指定されたユーザ グループに追加するユーザの一意のログイン ID。

userGroupId (整数) - ユーザを追加するユーザ グループの ID。

返される結果

ユーザがユーザ グループに追加された場合、またはユーザがすでにユーザ グループに属している場合は true。ユーザがユーザ グループに追加されていない場合は false。

例外

指定された ID を持つユーザ グループが存在しない場合、ユーザがシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:addUserToUserGroupResponse>
<ns:addUserToUserGroupReturn>true
</ns:addUserToUserGroupReturn>
</ns:addUserToUserGroupResponse>

addUserToVtg

 

関数名

addUserToVtg

説明

アクティブまたは非アクティブの VTG にユーザを追加する。

パラメータ

userLogin (ストリング) - 指定された VTG に追加するユーザの一意のログイン ID。

vtgId (整数) - ユーザを追加する VTG の ID。

返される結果

ユーザが VTG に追加された場合、またはユーザがすでに VTG に存在する場合は true。ユーザが VTG に追加されていない場合は false。

例外

指定された ID を持つ VTG が存在しない場合、ユーザがシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:addUserToVtgResponse>
<ns:addUserToVtgReturn>true</ns:addUserToVtgReturn>
</ns:addUserToVtgResponse>

addVtgToVtg

 

関数名

addVtgToVtg

説明

アクティブまたは非アクティブの別の VTG に VTG を追加する。

パラメータ

vtgIdAdd (整数) - 追加する VTG の ID。

vtgId (整数) - 別の VTG を追加する VTG の ID。

返される結果

指定された VTG が別の VTG に追加された場合、または指定された VTG が別の VTG にすでに存在する場合は true。指定された VTG が別の VTG に追加されていない場合は false。

例外

いずれかの VTG が存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:addVtgToVtgResponse>
<ns:addVtgToVtgReturn>true</ns:addVtgToVtgReturn>
</ns:addVtgToVtgResponse>

associateChannelsToUser

 

関数名

associateChannelsToUser

説明

1 つまたは複数のチャネルをユーザに関連付ける。

パラメータ

userLogin (ストリング) - 1 つまたは複数のチャネルを関連付けるユーザの一意のログイン ID。

ChannelContainerVO - チャネル値オブジェクトの集合。各オブジェクトには、チャネル ID とチャネル名が含まれています。VO オブジェクトは次のように定義されます。

ChannelContainerVO

ChannelVO[] channelVOs

ChannelVO

整数の ID

ストリング名

ChannelContainerVO channelContainerVO

返される結果

--

例外

指定された ID を持つユーザがシステムに存在しない場合、指定された ID を持つチャネルがシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:associateChannelsToUserResponse>
<ns:associateChannelsToUserReturn/>
</ns:associateChannelsToUserResponse>

associateRadiosToUser

 

関数名

associateRadiosToUser

説明

1 つまたは複数の無線をユーザに関連付ける。

パラメータ

userLogin (ストリング) - 1 つまたは複数の無線を関連付けるユーザの一意のログイン ID。

RadioContainerVO - 無線値オブジェクトの集合。各オブジェクトには、無線 ID と無線名が含まれています。VO オブジェクトは次のように定義されます。

RadioContainerVO

RadioVO[] radioVOs

RadioVO

整数の ID

ストリング名

RadioContainerVO radioContainerVO

返される結果

--

例外

指定された ID を持つユーザがシステムに存在しない場合、指定された ID を持つ無線がシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:associateRadiosToUserResponse>
<ns:associateRadiosToUserReturn/>
</ns:associateRadiosToUserResponse>

createChannel

 

関数名

createChannel

説明

指定された名前と短い名前を使用してチャネルを作成する。

パラメータ

channelName (ストリング) - 作成するチャネルの一意の名前。

channelShortName (ストリング) - 作成するチャネルの一意の短い名前。

返される結果

チャネルが作成された場合は channelId (整数)。

例外

指定された名前のチャネルがすでに存在する場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:createChannelResponse>
<ns:createChannelReturn>321</ns:createChannelReturn>
</ns:createChannelResponse>

createUser

 

関数名

createUser

説明

Cisco IPICS ユーザを作成する。

パラメータ

userLogin (ストリング) - 作成するユーザの一意のログイン ID。

userPassword (ストリング) - 作成するユーザのパスワード。パスワードには、文字、数字、特殊文字を使用できますが、スペースは使用できません。パスワードは、Cisco IPICS Administration で設定されたパラメータに従って検証されます。

firstName (ストリング) - ユーザの姓。

lastName (ストリング) - ユーザの名。

返される結果

作成されたユーザの(整数の)ID。

例外

指定されたログイン ID を持つユーザがすでにシステムに存在する場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:createUserResponse>
<ns:createUserReturn>21061</ns:createUserReturn>
</ns:createUserResponse>

createUserGroup

 

関数名

createUserGroup

説明

指定された名前と説明を使用して Cisco IPICS ユーザ グループを作成する。

パラメータ

groupName (ストリング) - 作成するユーザ グループの名前。このストリングには、スペースも含めて 32 文字まで指定できます。

groupDescription (ストリング) - 作成するユーザ グループの説明。このストリングには、スペースも含めて 85 文字まで指定できます。

返される結果

作成されたユーザ グループの(整数の)ID。

例外

groupName が一意でない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:createUserGroupResponse>
<ns:createUserGroupReturn>5887</ns:createUserGroupReturn>
</ns:createUserGroupResponse>

createVtg

 

関数名

createVtg

説明

指定された名前を使用して VTG を作成する。

パラメータ

vtgName (ストリング) - 作成する VTG の一意の名前。

description (ストリング) - VTG の説明。

返される結果

VTG が作成された場合は vtgId (整数)。

例外

指定された名前の VTG がシステムに存在する場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:createVtgResponse>
<ns:createVtgReturn>452</ns:createVtgReturn>
</ns:createVtgResponse>

deactivateVtg

 

関数名

deactivateVtg

説明

VTG を非アクティブにする。

パラメータ

vtgId (整数) - 非アクティブにする VTG の ID。

返される結果

VTG が非アクティブになった場合は true。VTG が非アクティブになっていない場合は false。

例外

指定された ID を持つ VTG がシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:deactivateVtgResponse>
<ns:DeactivateVtgReturn>true</ns:DeactivateVtgReturn>
</nsdeactivateVtgResponse>

deleteChannel

 

関数名

deleteChannel

説明

チャネルを削除する。

パラメータ

channelId (整数) - 削除するチャネルの ID。

返される結果

チャネルが削除された場合は true。チャネルが削除されなかった場合は false。

例外

指定された ID を持つチャネルがシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:deleteChannelResponse>
<ns:DeleteChannelReturn>true</ns:DeleteChannelReturn>
</ns:deleteChannelResponse>

deleteUser

 

関数名

deleteUser

説明

Cisco IPICS ユーザを削除する。

パラメータ

userId (整数) - 削除するユーザの ID。

返される結果

ユーザが削除された場合は true。ユーザが削除されなかった場合は false。

例外

指定された ID を持つユーザがシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:deleteUserResponse>
<ns:DeleteUserReturn>true</ns:DeleteUserReturn>
</ns:deleteUserResponse>

deleteVTG

 

関数名

deleteVTG

説明

VTG を削除する。

パラメータ

vtgId (整数) - 削除する VTG の ID。

返される結果

VTG が削除された場合は true。VTG が削除されなかった場合は false。

例外

指定された ID を持つ VTG がシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:deleteVTGResponse>
<ns:DeleteVtgReturn>true</ns:DeleteVtgReturn>
</ns:deleteVTGResponse>

dialAllVtgMembers

 

関数名

dialAllVtgMembers

説明

VTG の一部であるユーザ グループのメンバーを含む、VTG のすべてのユーザ メンバーにダイヤルアウトする。

パラメータ

vtgId (整数) - ダイヤルするメンバーが含まれている VTG の一意の ID。

trigger (ストリング) - カスタム ダイヤルアウト スクリプトを呼び出すトリガーの名前。

トリガー パラメータがヌルの場合は、デフォルトのダイヤルアウト アプリケーションが使用されます。

トリガー パラメータは /<trigger_name> という形式のストリングです。オプションで、カスタム ダイヤルアウト アプリケーションに必要な HTTP パラメータが後に続きます。たとえば、追加のパラメータが必要な場合のトリガー パラメータは /custom_dialout?param1=value1 となり、追加のパラメータが不要な場合は /custom_dialout となります。

返される結果

ダイヤルアウトが成功した場合は true。ダイヤルアウトが失敗した場合は false。

例外

指定された ID を持つ VTG がシステムに存在しない場合、VTG がアクティブでない場合、トリガーがシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:dialAllVtgMembersResponse>
<ns:dialAllVtgMembersReturn>true</ns:dialAllVtgMembersRetur>
</ns:dialAllVtgMembersResponse>

dialVtgMember

 

関数名

dialVtgMember

説明

VTG の指定されたメンバーにダイヤルアウトする。

パラメータ

vtgId (整数) - ダイヤルするメンバーが含まれている VTG の一意の ID。

trigger (ストリング) - カスタム ダイヤルアウト スクリプトを呼び出すトリガーの名前。

トリガー パラメータがヌルの場合は、デフォルトのダイヤルアウト アプリケーションが使用されます。

トリガー パラメータは /<trigger_name> という形式のストリングです。オプションで、カスタム ダイヤルアウト アプリケーションに必要な HTTP パラメータが後に続きます。たとえば、追加のパラメータが必要な場合のトリガー パラメータは /custom_dialout?param1=value1 となり、追加のパラメータが不要な場合は /custom_dialout となります。

userLogin - ダイヤルする VTG メンバーのログイン ID。

返される結果

ダイヤルアウトが成功した場合は true。ダイヤルアウトが失敗した場合は false。

例外

指定された ID を持つ VTG がシステムに存在しない場合、VTG がアクティブでない場合、トリガーがシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:dialVtgMemberResponse>
<ns:dialVtgMemberReturn>true</ns:dialVtgMemberReturn>
</ns:dialVtgMemberResponse>

dialVtgMembers

 

関数名

dialVtgMembers

説明

リストに記載されたユーザまたは VTG のすべてのユーザにダイヤルアウトする。

パラメータ

vtgId (整数) - 招待状を送信する VTG の一意の ID。

userContainerVO - UserContainerVO にラップされた UserVO アレイ。ヌルの場合は、VTG のすべてのユーザにダイヤルします。VO オブジェクトは次のように定義されます。

UserContainerVO

UserVO[] userVOs

UserVO

ストリング userLogin

ストリング名

整数の ID

ストリング firstName

ストリング lastName

userContainerVO がヌルの場合は、VTG のすべてのユーザにダイヤルします。

返される結果

なし。

例外

指定された ID を持つ VTG がシステムに存在しない場合、VTG がアクティブでない場合、指定されたユーザが VTG のメンバーでない場合、指定されたユーザが存在しない場合、オペレーションが失敗した場合は RemoteException。

応答例

<ns:dialVtgMembersResponse>
<ns:dialVtgMembersReturn/>
</ns:dialVtgMembersResponse>

disableChannel

 

関数名

disableChannel

説明

チャネルを無効状態に変更する。現在のチャネルがアイドル状態の場合にだけ適用されます。

パラメータ

channelId (整数) - 無効にするチャネルの一意の ID。

返される結果

チャネルが無効状態に変更された場合は true。チャネルが無効状態に変更されなかった場合は false。

例外

指定された ID を持つチャネルがシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:disableChannelResponse>
<ns:disableChannelReturn>true</ns:disableChannelReturn>
</ns:disableChannelResponse>

disableUser

 

関数名

disableUser

説明

Cisco IPICS ユーザを無効にする。

パラメータ

userLogin (ストリング) - 無効にするユーザの一意のログイン ID。

返される結果

ユーザが無効になった場合は true。ユーザが無効にならなかった場合は false。

例外

指定された ID を持つユーザがシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:disableUserResponse>
<ns:disableChannelReturn>true</ns:disableChannelReturn>
</ns:disableUserResponse>

enableChannel

 

関数名

enableChannel

説明

チャネルをアイドル状態に変更する。現在のチャネルが無効状態の場合にだけ適用されます。

パラメータ

channelId (整数) - 有効にするチャネルの一意の ID。

返される結果

チャネルがアイドル状態に変更された場合は true。チャネルがアイドル状態に変更されなかった場合は false。

例外

指定された ID を持つチャネルがシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:enableChannelResponse>
<ns:enableChannelReturn>true</ns:enableChannelReturn>
</ns:enableChannelResponse>

enableUser

 

関数名

enableUser

説明

Cisco IPICS ユーザを有効にする。

パラメータ

userLogin (ストリング) - 有効にするユーザの一意のログイン ID。

返される結果

ユーザが有効になった場合は true。ユーザが有効にならなかった場合は false。

例外

指定されたログイン ID を持つユーザがシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:enableUserResponse>
<ns:enableUserReturn>true</ns:enableUserReturn>
/<ns:enableUserResponse>

executeNotificationPolicy

 

関数名

executeNotificationPolicy

説明

指定された ID を持つ通知ポリシーを実行する。通知ポリシーの実行時に、通知(ダイヤル)アクションで定義されている記録済みのプロンプトは、指定されたテキスト メッセージから生成される Text-to-Speech(TTS)プロンプトで上書きされます。

パラメータ

policyId (整数) - 実行するポリシーの一意の ID。

msgText (ストリング) - TTS 関数によって受信者に再生されるメッセージのテキスト。

返される結果

--

例外

次の場合は RemoteException。

指定されたポリシー ID がシステムに存在しない場合

ポリシーが汎用ポリシーでない場合

ポリシーに通知(ダイヤル)アクションが含まれていない場合

TTS サービスが使用できない場合

その他の理由によりオペレーションが失敗した場合

応答例

<ns:executeNotificationPolicyResponse>
<ns:executeNotificationPolicy>
<ns:setUserListenerStatusReturn/>
</ns:executeNotificationPolicy>
</ns:executeNotificationPolicyResponse>

executePolicy

 

関数名

executePolicy

説明

指定されたポリシーを実行する。

パラメータ

policyId (整数) - 実行するポリシーの一意の ID。

返される結果

ポリシーが実行された場合は true。ポリシーが実行されなかった場合は false。

例外

指定された ID を持つポリシーがシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:executePolicyResponse>
<ns:executePolicyReturn>true</ns:executePolicyReturn>
</ns:executePolicyResponse>

getAllChannelGroups

 

関数名

getAllChannelGroups

説明

すべてのチャネル グループを取得する。

パラメータ

なし。

返される結果

ChannelGroupContainerVO にラップされた ChannelGroupVO アレイ。

例外

オペレーションが失敗した場合は RemoteException。

応答例

<ns:getAllChannelGroupsResponse>
<ns:getAllChannelGroupsReturn>
<ns:channelGroupVOs>
<ns:channelGroupVO>
<ns:name>Test ChanneGroup 1</ns:name>
<ns:id>154</ns:id>
</ns:channelGroupVO>
</ns:channelGroupVOs>
</ns:getAllChannelGroupsReturn>
</ns:getAllChannelGroupsResponse>

getAllChannels

 

関数名

getAllChannels

説明

すべてのチャネルを取得する。

パラメータ

なし。

返される結果

ChannelContainerVO にラップされた ChannelVO アレイ。

例外

オペレーションが失敗した場合は RemoteException。

応答例

<ns:getAllChannelsResponse>
<ns:getAllChannelsReturn>
<ns:channelVOs>
<ns:channelVO>
<ns:name>TestChannel1</ns:name>
<ns:id>140</ns:id>
</ns:channelVO>
<ns:channelVO>
<ns:name>TestChannel2</ns:name>
<ns:id>145</ns:id>
</ns:channelVO>
</ns:channelVOs>
</ns:getAllChannelsReturn>
</ns:getAllChannelsResponse>

getAllChannelsInChannelGroup

 

関数名

getAllChannelsInChannelGroup

説明

指定されたチャネル グループに属するすべてのチャネルを取得する。

パラメータ

channelGroupId (整数) - すべてのチャネルを取得するチャネル グループの一意の ID。

返される結果

ChannelContainerVO にラップされた ChannelVO アレイ。

例外

指定された ID を持つチャネル グループがシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:getAllChannelsInChannelGroupResponse>
<ns:getAllChannelsInChannelGroupReturn>
<ns:channelVOs>
<ns:channelVO>
<ns:name>TestChannel1</ns:name>
<ns:id>140</ns:id>
</ns:channelVO>
</ns:channelVOs>
</ns:getAllChannelsInChannelGroupReturn>
</ns:getAllChannelsInChannelGroupResponse>

getAllPolicies

 

関数名

getAllPolicies

説明

すべてのポリシーを取得する。

パラメータ

なし。

返される結果

PolicyContainerVO にラップされた PolicyVO アレイ。

例外

オペレーションが失敗した場合は RemoteException。

応答例

<ns:getAllPoliciesResponse>
<ns:getAllPoliciesReturn>
<ns:policyVOs>
<ns:policyVO>
<ns:name>TestPolicy1</ns:name>
<ns:description>MyTestPolicy</ns:description>
<ns:id>21</ns:id>
</ns:policyVO>
/ns:policyVOs>
</ns:getAllPoliciesReturn>
</ns:getAllPoliciesResponse>

getAllRadios

 

関数名

getAllRadios

説明

すべての Cisco IPICS 無線を取得する。

パラメータ

なし。

返される結果

RadioContainerVO にラップされた RadioVO アレイ。

例外

オペレーションが失敗した場合は RemoteException。

応答例

<ns:getAllRadiosResponse>
<ns:getAllRadiosReturn><ns:radioVOs>
<ns:radioVO>
<ns:name>Nextel1</ns:name>
<ns:id>5967</ns:id>
</ns:radioVO>
<ns:radioVO>
<ns:name>Tone1</ns:name>
<ns:id>6015</ns:id>
</ns:radioVO>
</ns:radioVOs>
</ns:getAllRadiosReturn>
</ns:getAllRadiosResponse>

getAllUserGroups

 

関数名

getAllUserGroups

説明

すべてのユーザ グループを取得する。

パラメータ

なし。

返される結果

UserGroupContainerVO にラップされた UserGroupVO アレイ。

例外

オペレーションが失敗した場合は RemoteException。

応答例

<ns:getAllUserGroupsResponse>
<ns:getAllUserGroupsReturn>
<ns:userGroupVOs>
<ns:userGroupVO>
<ns:name>TestUserGroup1</ns:name>
<ns:id>187</ns:id>
</ns:userGroupVO>
<ns:userGroupVO>
<ns:name>TestUserGroup2</ns:name>
<ns:id>188</ns:id>
</ns:userGroupVO>
</ns:userGroupVOs>
</ns:getAllUserGroupsReturn>
</ns:getAllUserGroupsResponse>

getAllUsers

 

関数名

getAllUsers

説明

すべての Cisco IPICS ユーザを取得する。

パラメータ

なし。

返される結果

UserContainerVO にラップされた UserVO アレイ。

例外

オペレーションが失敗した場合は RemoteException。

応答例

<ns:getAllUsersResponse>
<ns:getAllUsersReturn>
<ns:userVOs>
<ns:userVO>
<ns:userLogin>testuser1</ns:userLogin>
<ns:name>User1,Test (testuser1)</ns:name>
<ns:id>110</ns:id>
<ns:firstName>Test</ns:firstName>
<ns:lastName>User1</ns:lastName>
</ns:userVO>
<ns:userVO>
<ns:userLogin>testuser2</ns:userLogin>
<ns:name>User2,Test (testuser2)</ns:name>
<ns:id>121</ns:id>
<ns:firstName>Test</ns:firstName>
<ns:lastName>User2</ns:lastName>
</ns:userVO>
</ns:userVOs>
</ns:getAllUsersReturn>
</ns:getAllUsersResponse>

getAllVtgs

 

関数名

getAllVtgs

説明

すべての VTG を取得する。

パラメータ

なし。

返される結果

VtgContainerVO にラップされた VtgVO アレイ。

例外

オペレーションが失敗した場合は RemoteException。

応答例

</ns:getAlltgsResponse>
<ns:getAllVtgsReturn>
<ns:vtgVOs>
<ns:vtgVO>
<ns:name>TestVTG1</ns:name>
<ns:id>148</ns:id>
</ns:vtgVO>
<ns:vtgVO>
<ns:name>TestVTG2</ns:name>
<ns:id>150</ns:id>
</ns:vtgVO>
</ns:vtgVOs>
</ns:getAllVtgsReturn>
</ns:getAlltgsResponse>

getBelongingOpsViewForUser

 

関数名

getBelongingOpsViewForUser

説明

ユーザが属する ops ビューを取得する。

パラメータ

userLogin (ストリング) - ops ビューを取得するユーザの ID。

返される結果

ops ビューの ID(整数)。

例外

指定された ID を持つユーザがシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:getBelongingOpsViewForUserResponse>
<ns:getBelongingOpsViewForUserReturn>1
</ns:getBelongingOpsViewForUserReturn>
</ns:getBelongingOpsViewForUserResponse>

getChannelsAssociatedToUser

 

関数名

getChannelsAssociatedToUser

説明

指定されたユーザに関連付けられているすべてのチャネルを取得する。

パラメータ

userLogin (ストリング) - 関連付けられているチャネルを取得するユーザの一意の ID。

返される結果

ChannelContainerVO にラップされた ChannelVO アレイ。

例外

指定された ID を持つユーザがシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:getChannelsAssociatedToUserResponse>
<ns:getChannelsAssociatedToUserReturn>
<ns:channelVOs>
<ns:channelVO>
<ns:name>Fire Channel 1</ns:name>
<ns:id>336</ns:id>
</ns:channelVO>
</ns:channelVOs>
</ns:getChannelsAssociatedToUserReturn>
</ns:getChannelsAssociatedToUserResponse>

getChannelStatus

 

関数名

getChannelStatus

説明

指定されたチャネルのステータスを取得する。

パラメータ

channelId (整数) - ステータスを取得するチャネルの一意の ID。

返される結果

チャネルのステータス(ストリング):無効、アイドル、保留、またはアクティブ。

例外

指定された ID を持つチャネルがシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:getChannelStatusResponse>
<ns:getChannelStatusReturn>idle</ns:getChannelStatusReturn>
</ns:getChannelStatusResponse>

getDigitIds

 

関数名

getDigitIds

説明

ユーザの ディジット ID を取得する。

パラメータ

userLogin (整数) - ディジット ID を取得するユーザの ID。

返される結果

digitIds (ストリング) - 指定されたユーザのディジット ID。

例外

指定された ID を持つユーザがシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:getDigitIdsResponse>
<ns:getDigitIdsReturn>2274</ns:getDigitIdsReturn>
</ns:getDigitIdsResponse>

getPhonesAssociatedToUser

 

関数名

getPhonesAssociatedToUser

説明

指定されたユーザに関連付けられているすべての電話機を取得する。

パラメータ

userLogin (ストリング) - 関連付けられている電話機を取得するユーザの一意の ID。

返される結果

PhoneContainerVO にラップされた PhoneVO アレイ。

例外

指定された ID を持つユーザがシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:getPhonesAssociatedToUserResponse>
<ns:getPhonesAssociatedToUserReturn>
<ns:phoneVOs>
<ns: phoneVO>
<ns:name>TestPhone1</ns:name>
<ns:id>211</ns:id>
<ns:sipDn>111111111</ns: sipDn >
<ns:dialDestination>5555555555</ns: dialDestination >
</ns: phoneVO >
</ns: phoneVOs >
</ns: getPhonesAssociatedToUserReturn>
</ns:getPhonesAssociatedToUserResponse>

getPoliciesAssociatedToUser

 

関数名

getPoliciesAssociatedToUser

説明

指定されたユーザに関連付けられているすべてのポリシーを取得する。

パラメータ

userLogin (ストリング) - 関連付けられているポリシーを取得するユーザの一意の ID。

返される結果

PolicyContainerVO にラップされた PolicyVO アレイ。

例外

指定された ID を持つユーザがシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:getPoliciesAssociatedToUserResponse>
<ns:getPoliciesAssociatedToUserReturn>
<ns:policyVOs>
<ns:policyVO>
<ns:name>TestPolicy1</ns:name>
<ns:id>21</ns:id>
</ns:policyVO>
</ns:policyVOs>
</ns:getPoliciesAssociatedToUserReturn>
</ns:getPoliciesAssociatedToUserResponse>

getPolicyExecutionStatus

 

関数名

getPolicyExecutionStatus

説明

指定されたポリシーの実行ステータスを取得する。

パラメータ

policyId (整数) - 実行ステータスを取得するポリシーの一意の ID。

返される結果

PolicyExecutionStatusVO。指定されたポリシーを最後に実行した日付とステータスが含まれています。

例外

指定された ID を持つポリシーがシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:getPolicyExecutionStatusResponse>
<ns:getPolicyExecutionStatusReturn>
<ns:statusMessage>All actions have succeeded.</ns: statusMessage>
<ns:executionDate>2007-08-06 11:28:05</ns:executionDate>
</ns:getPolicyExecutionStatusReturn>
</ns:getPolicyExecutionStatusResponse>

getRadiosAssociatedToUser

 

関数名

getRadiosAssociatedToUser

説明

ユーザに関連付けられている無線のリストを返す。

パラメータ

userLogin (ストリング) - 関連付けられている無線を取得するユーザの一意の ID。

返される結果

RadioContainerVO にラップされた RadioVO アレイ。

例外

指定された ID を持つユーザがシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:getRadiosAssociatedToUserResponse>
<ns:getRadiosAssociatedToUserReturn>
<ns:radioVOs>
<ns:radioVO>
<ns:name>EFJohnson1</ns:name>
<ns:id>5858</ns:id>
</ns:radioVO>
</ns:radioVOs>
</ns:getRadiosAssociatedToUserReturn>
</ns:getRadiosAssociatedToUserResponse>

getUserAddress

 

関数名

getUserAddress

説明

ユーザの物理アドレスを取得する。

パラメータ

userLogin (ストリング) - アドレスを取得するユーザの一意のログイン ID。

返される結果

AddressVO

例外

指定された ID を持つユーザがシステムに存在しない場合は RemoteException。

応答例

<ns:getUserAddressResponse>
<ns:getUserAddressReturn>
<ns:country>USA</ns:country>
<ns:street>300 E Main</ns:street>
<ns:state>Michigan</ns:state>
<ns:zip>954123</ns:zip>
<ns:streetExtra>Suite 100</ns:streetExtra>
<ns:city>Lansing</ns:city>
</ns:getUserAddressReturn>
</ns:getUserAddressResponse>

getUserAudioStatus

 

関数名

getUserAudioStatus

説明

ユーザの PMC でオーディオが無効または有効のどちらであるのかを示すフラグを返す。オーディオが無効な場合、PMC はオーディオを転送または受信できません。

パラメータ

userLogin (ストリング) - PMC オーディオ ステータスを取得するユーザの一意のログイン ID。

返される結果

isDisabled オーディオが無効な場合は true。オーディオが有効な場合は false。

例外

指定された ID を持つユーザがシステムに存在しない場合は RemoteException。

応答例

<ns:getUserAudioStatusResponse>
<ns: userAudioStatus> true</ns:userAudioStatus>
</ns:getUserAudioStatusResponse>

getUserDialPreference

 

関数名

getUserDialPreference

説明

指定されたユーザに関連付けられているダイヤル プリファレンスを取得する。

パラメータ

userLogin (ストリング) - ダイヤル プリファレンスを取得するユーザの一意のログイン ID。

返される結果

DialAddressContainerVO にラップされた DialAddressVO アレイ。

例外

指定された ID を持つユーザがシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:getUserDialPreferenceResponse>
<ns:getUserDialPreferenceReturn>
<ns:dialAddressVOs>
<ns:dialAddressVO>
<ns:type>Business</ns:type>
<ns:dialPreferenceOrder>0</ns:dialPreferenceOrder>
<ns:dialNumber>408-555-5555</ns:dialNumber>
<ns:id>21020</ns:id>
</ns:dialAddressVO>
<ns:dialAddressVO>
<ns:type>Home</ns:type>
<ns:dialPreferenceOrder>1</ns:dialPreferenceOrder>
<ns:dialNumber>614-555-5555</ns:dialNumber>
<ns:id>21019</ns:id>
</ns:dialAddressVO>
</ns:dialAddressVOs>
</ns:getUserDialPreferenceReturn>
</ns:getUserDialPreferenceResponse>

getUserGroupMembers

 

関数名

getUserGroupMembers

説明

指定されたユーザ グループのすべてのユーザを取得する。

パラメータ

userGroupId (整数) - すべてのメンバーを取得するユーザ グループの一意の ID。

返される結果

UserContainerVO にラップされた UserVO アレイ。

例外

指定された ID を持つユーザ グループがシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:getUserGroupMembersResponse>
<ns:getUserGroupMembersReturn>
<ns:userVOs>
<ns:userVO>
<ns:userLogin>testuser1</ns:userLogin>
<ns:name>User1,Test (testuser1)</ns:name>
<ns:id>110</ns:id>
<ns:firstName>Test</ns:firstName>
<ns:lastName>User1</ns:lastName>
</ns:userVO>
</ns:userVOs>
</ns:getUserGroupMembersReturn>
</ns:getUserGroupMembersResponse>

getUserListenerStatus

 

関数名

getUserListenerStatus

説明

ユーザの PMC が受信専用モードであるかどうかを示すフラグを返す。このモードでは、ユーザは消音されています。

パラメータ

userLogin (ストリング) - PMC オーディオ ステータスを取得するユーザの一意のログイン ID。

返される結果

ListenOnly オーディオが消音されている場合は true。ユーザが消音されていない場合は false。

例外

指定された ID を持つユーザがシステムに存在しない場合は RemoteException。

応答例

<ns:getUserListenerStatusResponse>
<ns: userListenerStatus> true</ns:userListenerStatus>
</ns:getUserListenerStatusResponse>

getUserNotificationPreference

 

関数名

getUserNotificationPreference

説明

指定されたユーザに関連付けられている通知プリファレンスを取得する。

パラメータ

userLogin (ストリング) - 通知プリファレンスを取得するユーザの一意の ID。

返される結果

NotificationAddressContainerVO にラップされた NotificationAddressVO アレイ。

例外

指定された ID を持つユーザがシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:getUserNotificationPreferenceResponse>
<ns:getUserNotificationPreferenceReturn>
<ns:notificationAddressVOs>
<ns:notificationAddressVO>
<ns:notificationAddress>test@cisco.com</ns:notification
Address>
<ns:type>Email</ns:type>
<ns:id>21018</ns:id>
</ns:notificationAddressVO>
<ns:notificationAddressVO>
<ns:notificationAddress>page@cisco.com</ns:notification
Address>
<ns:type>Pager</ns:type>
<ns:id>21017</ns:id>
</ns:notificationAddressVO>
</ns:notificationAddressVOs>
</ns:getUserNotificationPreferenceReturn>
</ns:getUserNotificationPreferenceResponse>

getUserRoles

 

関数名

getUserRoles

説明

指定されたユーザのロール リストを取得する。

パラメータ

userLogin (ストリング) - ロールを取得するユーザの一意の ID。

返される結果

UserRoleContainerVO にラップされた UserRoleVO アレイ。

例外

指定された ID を持つユーザがシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:getUserRolesResponse>
<ns:getUserRolesReturn>
<ns:userRoleVOs>
<ns:userRoleVO>
<ns:name>dispatcher</ns:name>
<ns:id>3</ns:id>
ns:displayName>Dispatcher</ns:displayName>
</ns:userRoleVO>
<ns:userRoleVO>
<ns:name>all</ns:name>
<ns:id>5</ns:id>
ns:displayName>All</ns:displayName>
</ns:userRoleVO>
<ns:userRoleVO>
<ns:name>opsadmin</ns:name>
<ns:id>6</ns:id>
<ns:displayName>Ops View Administrator</ns:displayName>
</ns:userRoleVO>
</ns:userRoleVOs>
</ns:getUserRolesReturn
</ns:getUserRolesResponse>

getUsersAssociatedToRadio

 

関数名

getUsersAssociatedToRadio

説明

無線に関連付けられているユーザのリストを返す。

パラメータ

radioId (ストリング) - 関連付けられているユーザを取得する無線の一意の ID。

返される結果

UserContainer VO にラップされた User VO のアレイ。

例外

指定された ID を持つ無線がシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:getUsersAssociatedToRadioResponse>
<ns:getUsersAssociatedToRadioReturn>
<ns:userVOs>
<ns:userVO>
<ns:userLogin>testuser12</ns:userLogin>
<ns:name>Blow,Joe (testuser12)</ns:name>
<ns:id>5382</ns:id>
<ns:firstName>Joe</ns:firstName>
<ns:lastName>Blow</ns:lastName>
</ns:userVO>
<ns:userVO>
<ns:userLogin>testuser16</ns:userLogin>
<ns:name>Blow,Joe (testuser16)</ns:name>
<ns:id>5535</ns:id>
<ns:firstName>Joe</ns:firstName>
<ns:lastName>Blow</ns:lastName>
</ns:userVO>
</ns:userVOs>
</ns:getUsersAssociatedToRadioReturn>
</ns:getUsersAssociatedToRadioResponse>

getUserStatus

 

関数名

getUserStatus

説明

1 人または複数のユーザのアクティブ ステータスを取得する。

パラメータ

userLogin (ストリング) - アクティブ ステータスを取得する 1 人または複数のユーザの一意の ID。

返される結果

ユーザのステータス(ストリング) - 指定されたユーザごとに有効または無効。

例外

指定されたユーザ ID がシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:getUserStatusResponse>
<ns:getUserStatusReturn>
<ns:statusMessage>true.</ns:statusMessage>
</ns:getUserStatusReturn>
</ns:getUserStatusResponse>

getVtgParticipants

 

関数名

getVtgParticipants

説明

VTG の参加者全員を取得する。

パラメータ

vtgId (整数) - 参加者全員を取得する VTG の ID。

返される結果

VtgParticipantContainerVO にラップされた VtgParticipant VO アレイ。ユーザ、ユーザ グループ、チャネル、チャネル グループ、および VTG を含みます。

例外

指定された ID を持つ VTG がシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:getVtgParticipantsResponse>
<ns:getVtgParticipantsReturn>
<ns:userGroupParticipants>
<ns:vtgParticipantVO>
<ns:participantId>118</ns:participantId>
<ns:groupId>0</ns:groupId>
<ns:resourceType>user-group</ns:resourceType>
<ns:status>active</ns:status>
<ns:name>TestUserGroup2</ns:name>
<ns:id>21026</ns:id>
</ns:vtgParticipantVO>
</ns:userGroupParticipants>
ns:channelGroupParticipants>
<ns:vtgParticipantVO>
<ns:participantId>125</ns:participantId>
<ns:groupId>0</ns:groupId>
<ns:resourceType>channel-group</ns:resourceType>
<ns:status>active</ns:status>
<ns:name>TestChannelGroup1</ns:name>
<ns:id>21021</ns:id>
</ns:vtgParticipantVO>
</ns:channelGroupParticipants>
<ns:vtgParticipants>
<ns:vtgParticipantVO>
<ns:participantId>928</ns:participantId>
<ns:groupId>0</ns:groupId>
<ns:resourceType>vtg</ns:resourceType>
<ns:status>error</ns:status>
<ns:name>Test VTG 2</ns:name>
<ns:id>21028</ns:id>
</ns:vtgParticipantVO>
</ns:vtgParticipants>
<ns:userParticipants>
<ns:vtgParticipantVO>
<ns:participantId>953</ns:participantId>
<ns:groupId>0</ns:groupId>
<ns:resourceType>user</ns:resourceType>
<ns:status>active</ns:status>
<ns:name>Test0, Some</ns:name>
<ns:id>21024</ns:id>
</ns:vtgParticipantVO>
<ns:vtgParticipantVO>
<ns:participantId>954</ns:participantId>
<ns:groupId>0</ns:groupId>
<ns:resourceType>user</ns:resourceType>
<ns:status>active</ns:status>
<ns:name>Test1, Some</ns:name>
<ns:id>21025</ns:id>
</ns:vtgParticipantVO>
</ns:userParticipants>
<ns:channelParticipants>
<ns:vtgParticipantVO>
<ns:participantId>119</ns:participantId>
<ns:groupId>0</ns:groupId>
<ns:resourceType>channel</ns:resourceType>
<ns:status>error</ns:status>
<ns:name>TestChannel1</ns:name>
<ns:id>21016</ns:id>
</ns:vtgParticipantVO>
</ns:channelParticipants>
</ns:getVtgParticipantsReturn>
</ns:getVtgParticipantsResponse>

getVtgParticipantStatus

 

関数名

getVtgParticipantStatus

説明

VTG の参加者のステータスを取得する。

パラメータ

vtgId (整数) - 参加者のステータスをクエリする VTG の一意の ID。

participantID (整数) - ステータスがクエリされる参加者の一意の ID。

resourceType (ストリング) - 参加者のタイプ:ユーザ、ユーザ グループ、チャネル、チャネル グループ、または VTG。

返される結果

(ストリング)VTG の参加者のステータス(切断、エラー、保留、またはアクティブ)。

例外

指定された ID を持つ VTG がシステムに存在しないかアクティブでない場合、指定された ID を持つ参加者がシステムに存在しない場合、リソースのタイプが無効な場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:getVtgParticipantStatusResponse>
<ns:getVtgParticipantStatusReturn>active</
<ns:getVtgParticipantStatusReturn>
</ns:getVtgParticipantStatusResponse>

getVtgStatus

 

関数名

getVtgStatus

説明

VTG の ID、名前、説明、およびステータス(アイドル、アクティブ、保留、または無効)を取得する。

パラメータ

vtgId (整数) - ステータスを取得する VTG の一意の ID。

返される結果

(ストリング)VTG のステータス(アイドル、保留、またはアクティブ)。

vtgContainerVO。1 つの vtgVO とその属性(vtgId、vtgName、description、status)が含まれています。

例外

指定された ID を持つ VTG がシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:getVtgStatusResponse>
<ns:getVtgStatusReturn>
<ns:vtgVOs>
<ns:vtgVO>
<ns:description/>
<ns:status>idle</ns:status>
<ns:name>Fire Incident</ns:name>
<ns:id>326</ns:id>
</ns:vtgVO>
</ns:vtgVOs>
</ns:getVtgStatusReturn>
</ns:getVtgStatusResponse>

getVtgsAssociatedToUser

 

関数名

getVtgsAssociatedToUser

説明

ユーザに関連付けられているすべての VTG を取得する。

パラメータ

userLogin (ストリング) - 関連付けられている VTG を取得するユーザの一意のログイン ID。

返される結果

VtgContainerVO にラップされた VtgVO アレイ。

例外

指定された ID を持つユーザがシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:getVtgsAssociatedToUserResponse>
<ns:getVtgsAssociatedToUserReturn>
<ns:vtgVOs>
<ns:vtgVO>
<ns:name>TestVTG1</ns:name>
<ns:id>148</ns:id>
</ns:vtgVO>
</ns:vtgVOs>
</ns:getVtgsAssociatedToUserReturn>
</ns:getVtgsAssociatedToUserResponse>

isActiveChannel

 

関数名

isActiveChannel

説明

チャネルが有効または無効のどちらであるのかを判別する。

パラメータ

channelId (整数) - クエリするチャネルの ID。

返される結果

チャネルが有効な場合は true。チャネルが無効な場合は false。

例外

指定された ID を持つチャネルがシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:isActiveChannelResponse>
<ns:isActiveChannelReturn>true</ns:isActiveChannelReturn>
</ns:isActiveChannelResponse>

isActiveUser

 

関数名

isActiveUser

説明

ユーザが有効または無効のどちらであるのかを判別する。

パラメータ

userLogin (ストリング) - クエリするユーザの一意のログイン ID。

返される結果

ユーザが有効な場合は true。ユーザが無効な場合は false。

例外

指定された ID を持つユーザがシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:isActiveUserResponse>
<ns:isActiveUserReturn>true</ns:isActiveUserReturn>
</ns:isActiveUserResponse>

isActiveVtg

 

関数名

isActiveVtg

説明

VTG が有効または無効のどちらであるのかを判別する。

パラメータ

vtgId (整数) - クエリする VTG の一意のログイン ID。

返される結果

VTG が有効な場合は true。VTG が無効な場合は false。

例外

指定された ID を持つ VTG がシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:isActiveVtgResponse>
<ns:isActiveVtgReturn>true</ns:isActiveVtgReturn>
</ns:isActiveVtgResponse>

notifyAllVtgMembers

 

関数名

notifyAllVtgMembers

説明

VTG のユーザ グループのメンバーを含む、VTG のすべてのユーザに通知を送信する。

パラメータ

vtgId (整数) - メンバーに通知が送信される VTG の一意の ID。

返される結果

通知が成功した場合は true。通知が失敗した場合は false。

例外

指定された ID を持つ VTG がシステムに存在しない場合、VTG がアクティブでない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:notifyAllVtgMembersResponse>
<ns:notifyAllVtgMembersReturn>true</
ns:notifyAllVtgMembersReturn>
</ns:notifyAllVtgMembersResponse>

notifyVtgMember

 

関数名

notifyVtgMember

説明

VTG の特定のメンバーに通知を送信する。

パラメータ

vtgId (整数) - メンバーに通知が送信される VTG の一意の ID。

userLogin (ストリング) - 通知が送信される VTG メンバーの一意のログイン ID。

返される結果

通知が成功した場合は true。通知が失敗した場合は false。

例外

指定された ID を持つ VTG がシステムに存在しない場合、VTG がアクティブでない場合、ユーザが VTG の参加者でない場合、ユーザが存在しない場合、オペレーションが失敗した場合は RemoteException。

応答例

<ns:notifyVtgMemberResponse>
<ns:notifyVtgMemberReturn>true</ns:notifyVtgMemberReturn>
</ns:notifyVtgMemberResponse>

notifyVtgMembers

 

関数名

notifyVtgMembers

説明

リストに記載されたユーザまたは VTG のすべてのユーザに通知を送信する。

パラメータ

返される結果

なし。

例外

指定された ID を持つ VTG がシステムに存在しない場合、VTG がアクティブでない場合、ユーザが VTG の参加者でない場合、ユーザが存在しない場合、オペレーションが失敗した場合は RemoteException。

応答例

<ns:notifyVtgMembersResponse>
<ns:notifyVtgMembersReturn/>
</ns:notifyVtgMembersResponse>

removeChannelFromVtg

 

関数名

removeChannelFromVtg

説明

チャネルを VTG から削除する。

パラメータ

vtgId (整数) - チャネルを削除する VTG の一意の ID。

channelId (整数) - VTG から削除するチャネルの一意の ID。

返される結果

チャネルが VTG から削除された場合は true。チャネルが VTG から削除されなかった場合は false。

例外

指定された ID を持つ VTG がシステムに存在しない場合、指定されたチャネルがシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:removeChannelFromVtgResponse>
<ns:removeChannelFromVtgReturn>true</
ns:removeChannelFromVtgReturn>
</ns:removeChannelFromVtgResponse>

removePhoneAssociatedToUser

 

関数名

removePhoneAssociatedToUser

説明

電話機とユーザの関連付けを解除する。

パラメータ

userLogin (ストリング) - 電話機の関連付けを解除するユーザのログイン ID。

dialNumber (ストリング) - ユーザから関連付けを解除する電話機のダイヤル番号。

返される結果

関連付けの解除が成功した場合、または電話機がユーザからすでに関連付けを解除されている場合は true。関連付けを解除できなかった場合は false。

例外

指定された ID を持つユーザがシステムに存在しない場合、指定されたダイヤル番号がシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:removePhoneAssociatedToUserResponse>
<ns:removePhoneAssociatedToUserReturn>true
</ns:removePhoneAssociatedToUserReturn>
</ns:removePhoneAssociatedToUserResponse>

removeUserFromVtg

 

関数名

removeUserFromVtg

説明

参加者を VTG から削除する。

パラメータ

userLogin (ストリング) - VTG から削除するユーザの一意のログイン ID。

vtgId (整数) - ユーザを削除する VTG の一意の ID。

返される結果

ユーザが VTG から削除された場合、または VTG のメンバーでない場合は true。ユーザが VTG から削除されなかった場合は false。

例外

指定された ID を持つ VTG がシステムに存在しない場合、ユーザがシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:removeUserFromVtgResponse>
<ns:removeUserFromVtgReturn>true</
ns:removeUserFromVtgReturn>
</ns:removeUserFromVtgResponse>

removeVtgFromVtg

 

関数名

removeVtgFromVtg

説明

別の VTG を VTG から削除する。

パラメータ

vtgIdRem (ストリング) - 削除する VTG の ID。

vtgId (整数) - 別の VTG を削除する VTG の一意の ID。

返される結果

別の VTG が VTG から削除された場合、または VTG のメンバーでない場合は true。別の VTG が VTG から削除されなかった場合は false。

例外

指定された ID を持つ VTG がシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:removeVtgFromVtgResponse>
<ns:removeVtgFromVtgReturn>true</ns:removeVtgFromVtgReturn>
</ns:removeVtgFromVtgResponse>

setBelongingOpsViewForUser

 

関数名

setBelongingOpsViewForUser

説明

ops ビューをユーザに割り当てる。

パラメータ

userLogin (ストリング) - ops ビューを割り当てるユーザのログイン ID。

opsViewId (整数) - ユーザに割り当てる ops ビューの ID。

返される結果

--

例外

指定された ID を持つユーザがシステムに存在しない場合、指定された ID を持つ ops ビューがシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:setBelongingOpsViewForUserResponse>
<ns:setBelongingOpsViewForUserReturn/>
</ns:setBelongingOpsViewForUserResponse>

setDialPreference

 

関数名

setDialPreference

説明

ユーザの新しいダイヤル プリファレンスを追加する。

パラメータ

userLogin (ストリング) - ダイヤル プリファレンスを設定するユーザの一意のログイン ID。

dialType (ストリング) - ダイヤル タイプのプリファレンス(BUSINESS、BUSINESS2、BUSINESS3、CAR、HOME、HOME2、HOME3、MOBILE、MOBILE2、MOBILE3、OTHER、PRIMARY、SECONDARY)。

dialNumber (ストリング) - ダイヤルする電話番号。

dialOrder (整数) - 複数のダイヤル タイプが設定されている場合に、このダイヤル タイプが実行される順番。

返される結果

--

例外

指定された ID を持つユーザがシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:setDialPreferenceReturn>
<ns:prefId>7978</ns: prefId>
</ns:setDialPreferenceReturn>

setDigitIds

 

関数名

setDigitIds

説明

ユーザのディジット ID を設定する。

パラメータ

userLogin (ストリング) - ディジット ID を設定するユーザの一意のログイン ID。

digitIds (ストリング) - ユーザのディジット ID。

返される結果

--

例外

指定された ID を持つユーザがシステムに存在しない場合、無効なディジット文字が入力された場合、オペレーションが失敗した場合は RemoteException。

応答例

<ns:setDigitIdsResponse>
<ns:setDigitIdsResponse>
<ns:setDigitIdsReturn>true</ns:seDigitIdsReturn>
<ns:setDigitIdsResponse>
</ns:setDigitIdsResponse>

setDigitPassword

 

関数名

setDigitPassword

説明

ユーザのディジット パスワードを設定する。

パラメータ

userLogin (ストリング) - ディジット パスワードを設定するユーザの一意のログイン ID。

password (ストリング) - 作成するユーザのパスワード。パスワードには、文字、数字、特殊文字を使用できますが、スペースは使用できません。パスワードは、Cisco IPICS Administration で設定されたパラメータに従って検証されます。

返される結果

--

例外

指定された ID を持つユーザがシステムに存在しない場合、パスワードの検証に失敗した場合、オペレーションが失敗した場合は、Remote Exception。

応答例

<ns:setDigitPasswordResponse>
<ns:setDigitIDsResponse>
</ns:setDigitPasswordResponse>

setNotificationPreference

 

関数名

setNotificationPreference

説明

ユーザの新しい通知プリファレンスを追加する。

パラメータ

userLogin (ストリング) - ダイヤル プリファレンスを設定するユーザの一意のログイン ID。

notificationType (ストリング) - 通知タイプのプリファレンス(EMAIL、PAGER、SMS)。

notificationAddress (ストリング) - 指定された通知タイプのアドレス。

返される結果

--

例外

指定された ID を持つユーザがシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:setNotificationPreferenceResponse>
<ns:setNotificationPreferenceReturn>
<ns:prefId>7978</ns: prefId>
</ns:seNotificationPreferenceReturn>
</ns:setNotificationPreferenceResponse>

setUserAddress

 

関数名

setUserAddress

説明

ユーザの物理アドレスを追加する。

パラメータ

userLogin (ストリング) - 物理アドレスを追加するユーザの一意のログイン ID。

AddressVO - アドレス情報。VO オブジェクトは次のように定義されます。

ストリング street

ストリング streetExtra

ストリング city

ストリング state

ストリング zip

ストリング country

返される結果

--

例外

指定された ID を持つユーザがシステムに存在しない場合、またはオペレーションが失敗した場合は RemoteException。

応答例

<ns:setUserAddressResponse>
<ns:setUserAddress Return/>
</ns:setUserAddressResponse>

setUserAudioStatus

 

関数名

setUserAudioStatus

説明

ユーザが PMC 上でオーディオを再生および転送できる機能を有効または無効にする。

(注) ユーザのオーディオ ステータスが有効でも受信ステータスが無効であれば、そのユーザはオーディオを転送できません(ユーザは消音されています)。「setUserListenerStatus」を参照してください。

パラメータ

userLogin (ストリング) - PMC オーディオを有効または無効にするユーザの一意のログイン ID。

audioDisabled (ブール値) - true の場合は、オーディオ機能を無効にする。false の場合は、オーディオ機能を有効にします。

返される結果

--

例外

指定された ID を持つユーザがシステムに存在しない場合は RemoteException。

応答例

<ns:setUserAudioStatusResponse>
<ns:setUserAudioStatus>
<ns:setUserAudioStatusReturn/>
</ns:setUserAudioStatus>
</ns:setUserAudioStatusResponse>

setUserListenerStatus

 

関数名

setUserListenerStatus

説明

ユーザが PMC 上でオーディオを転送できる機能を有効または無効にする(ユーザの消音を解除または消音にする)。

(注) ユーザのオーディオ ステータスが無効な場合(「setUserAudioStatus」を参照)、ユーザは常にオーディオを転送できません。

パラメータ

userLogin (ストリング) - PMC オーディオを有効または無効にするユーザの一意のログイン ID。

mute (ブール値) - true の場合は、ユーザを消音にする。false の場合は、ユーザを消音にしません。

返される結果

--

例外

指定された ID を持つユーザがシステムに存在しない場合は RemoteException。

応答例

<ns:setUserListenerStatusResponse>
<ns:setUserListenerStatus>
<ns:setUserListenerStatusReturn/>
</ns:setUserListenerStatus>
</ns:setUserAudioStatusResponse>