XML API について
XML API をイネーブルにするには、次の概念を理解しておく必要があります。
• 「XML API の定義」
• 「IXI を使用した XML API プロビジョニング」
• 「Cisco Unified CME 用の XML API」
XML API の定義
XML API は、外部のネットワーク管理システム(NMS)が Cisco Unified CME 操作を設定およびモニタするための、Cisco Unified CME に対するインターフェイスを提供します。
IXI を使用した XML API プロビジョニング
以前のバージョンの Cisco Unified CME では、XML インターフェイスは、HTTP ポートを使用した設定機能とモニタリング機能を提供していました。XML インターフェイスは HTTP サーバ プロセスで実行され、着信 XML 要求をオンデマンドで同時に解析して処理します。
Cisco Unified CME 4.0 以降のバージョンでは、XML インターフェイスは Cisco IOS XML Infrastructure(IXI)を通して提供されており、パーサー層とトランスポート層がアプリケーションから分離されています。このモジュール化によって拡張性が提供され、将来の XML サポートを開発できるようになります。Cisco Unified CME 4.0 以降のバージョンでは、すべての Cisco Unified CME 機能に XML サポートが提供されています。
Cisco Unified CME 用の XML API
eXtensible Markup Language(XML)アプリケーション プログラミング インターフェイス(API)は、Cisco Unified Communications Manager Express(Cisco Unified CME)8.5 以降のバージョンでサポートされています。
• 「対象読者」
• 「前提条件」
• 「Cisco Unified CME 用の XML API」
• 「例」
対象読者
このマニュアルは、C++、Java、またはそれらと同等の高級プログラミング言語に関する知識のある読者を対象としています。次の分野での知識または経験も必要です。
• TCP/IP プロトコル
• Hypertext Transport Protocol
• ソケット プログラミング
• XML
さらに、このプログラミング ガイドのユーザは、AXL での要求、応答、およびエラーを定義するために使用されている XML スキーマについても確実に把握している必要があります。XML スキーマの詳細については、『 XML Schema Part 0: Primer Second Edition 』を参照してください。
前提条件
• Cisco Unified CME:Cisco Unified CME で XML API が設定されていること。設定情報については、『 Cisco Unified CME Administrator Guide 』の「 Configuring the XML API 」の項を参照してください。
Cisco Unified CME 用 XML API について
Cisco Unified CME の XML API サポートは、XML を使用して、Cisco ルータでデータの挿入、取得、更新、および削除を実行するためのメカニズムを提供します。
要求方式は、HTTP POST を使用して Cisco Unified CME アプリケーションおよび Cisco Unified SRST アプリケーションで XML サーバに渡される XML 構造体です。XML サーバはその XML 構造体を受信し、要求を実行します。要求が正常に完了すると、適切な XML 応答が返されます。
(注) XML バッファ サイズの制限により、単一要求で複数のエンティティに関するクエリーを行うと、失敗する可能性があります。この制限のため、アプリケーションは、そのクエリーに対する粒度を 1 つの要求ごとに 1 つのエンティティに調整する必要があります。
表 144 に、XML API に関する要求方式と応答方式、および各方式の目的とパラメータを示します。
表 144 XML API の方式:要求と応答
|
|
|
|
システム |
コンフィギュレーション コマンドの実行 |
ISexecCLI |
コマンド |
ISexecCLIResult |
ルータの設定を nvram に保存 |
ISSaveConfig |
-- |
ISSaveConfigResult |
SCCP |
GCisco Unified CME または Cisco Unified SRST のシステム ステータスの取得。 |
ISgetGlobal |
-- |
ISGlobal |
IP Phone のステータスの取得 |
ISgetDevice |
次のいずれかの組み合わせ: ISDevID ISDevName ISKeyword: – all – allTag – available |
ISDevices |
電話テンプレートの設定の取得 |
ISgetDeviceTemplate |
次のいずれかの組み合わせ: ISDevTemplateID ISKeyword: – all – allTag – available |
ISDeviceTemplates |
内線番号の設定の取得 |
ISgetExtension |
次のいずれかの組み合わせ: ISExtID ISExtNumber ISKeyword: – all – allTag – available |
ISExtensions |
内線番号テンプレートの設定の取得 |
ISgetExtensionTemplate |
次のいずれかの組み合わせ: ISExtTemplateID ISKeyword: – all – allTag – available |
ISExtensionTemplates |
ユーザ情報の取得 |
ISgetUser |
ISuserID |
ISuser |
ユーザ プロファイル情報の取得 |
ISgetuserProfile |
次のいずれかの組み合わせ: ISUserProfileID ISuserID ISKeyword: – all – allTag – available |
ISUserProfiles |
ユーティリティ ディレクトリの設定の取得 |
ISgetUtilityDirectory |
-- |
ISUtilityDirectory |
SIP |
SIP を実行している Cisco Unified CME のシステム ステータスの取得 |
ISgetVoiceRegGlobal |
-- |
ISSipGlobal |
IP Phone のステータスの取得 |
ISgetSipDevice |
次のいずれかの組み合わせ: ISPoolID ISPoolName ISKeyword: – all – allTag – available |
ISSipDevices |
内線番号の設定の取得 |
ISgetSipExtension |
次のいずれかの組み合わせ: ISVoiceRegDNID ISVoiceRegNumber ISKeyword: – all – allTag – available |
ISSipExtensions |
セッション サーバのステータスの取得 |
ISgetSessionServer |
次のいずれかの組み合わせ: ISSessionServerID ISSessionServerName ISKeyword: – all – allTag – available |
ISSessionServers |
音声ハント グループのステータスの取得 |
ISgetVoiceHuntGroup |
ISVoiceHuntGroupID ISKeyword: – all – allTag – available |
ISVoiceHuntGroups |
プレゼンスの設定の取得 |
ISgetPresenceGlobal |
-- |
ISPresenceGlobal |
ISexecCLI
ISexecCLI を使用すると、Cisco ルータ上で Cisco IOS コマンドのリストを実行できます。要求には、実行するコマンドごとに CLI パラメータと Cisco IOS コマンド文字列が含まれている必要があります。
要求:例
<SOAP-ENV:Envelope>
<SOAP-ENV:Body>
<axl>
<request xsi:type="ISexecCLI">
<ISexecCLI>
<CLI>ephone 4</CLI>
<CLI>mac-address 000D.BC80.EB51</CLI>
<CLI>type 7960</CLI>
<CLI>button 1:1</CLI>
</ISexecCLI>
</request>
</axl>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
応答:例
次の例で、ISexecCLIResponse の値「0」は、要求が正常に完了した場合の応答です。
<SOAP-ENV:Envelope >
<SOAP-ENV:Body>
<axl >
<response xsi:type="ISexecCLIResponse" >
<ISexecCLIResponse>0</ISexecCLIResponse>
<ISexecCLIError></ISexecCLIError>
</response>
</axl>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
次の例は、要求が失敗した場合の応答を示しています。ISexecCLIResponse の値によって、要求が失敗した行番号が識別されます。コマンド リスト内の、それ以降のコマンドは実行されません。リスト内のその前のすべてのコマンドは実行されました。
<SOAP-ENV:Envelope >
<SOAP-ENV:Body>
<axl >
<response xsi:type="ISexecCLIResponse" >
<ISexecCLIResponse>4</ISexecCLIResponse>
<ISexecCLIError> invalid input dn parameter for button 1</ISexecCLIError>
</response>
</axl>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
ISSaveConfig
ISSaveConfig は、ルータ上の実行コンフィギュレーションを、同じルータ上のスタートアップ コンフィギュレーションに保存します。
要求:例
<request>
<ISSaveConfig />
</request>
応答:例
次の例は、ISSaveConfig 要求が正常に完了したことを示しています。
<response xsi:type=" ISSaveConfig">
<ISSaveConfigResult>success</ISSaveConfigResult>
</request>
次の例は、要求が失敗した場合の応答を示しています。
<response xsi:type=" ISSaveConfig">
<ISSaveConfigResult>fail</ISSaveConfigResult>
</request>
次の例は、要求が遅延した場合の応答を示しています。一般的には、別のターミナル セッションが Cisco Unified CME に接続されていることが原因です。他のすべてのターミナル セッションが接続解除された後、実行コンフィギュレーションがバックグラウンド プロセスによって後から保存されます。
<response xsi:type=" ISSaveConfig">
<ISSaveConfigResult>delay</ISSaveConfigResult>
</request>
ISgetGlobal
ISgetGlobal を使用すると、Cisco Unified CME システムのシステム コンフィギュレーション情報とステータス情報を取得できます。
要求:例
<request xsi:type="ISgetGlobal">
<ISgetGlobal></ISgetGlobal>
</request>
応答:例
<response>
<ISGlobal>
<ISAddress>10.4.188.90</ISAddress>
<ISMode>ITS</ISMode>
<ISVersion>7.2</ISVersion>
<ISDeviceRegistered>0</ISDeviceRegistered>
<ISPeakDeviceRegistered>1</ISPeakDeviceRegistered>
<ISPeakDeviceRegisteredTime>9470</ISPeakDeviceRegisteredTime>
<ISKeepAliveInterval>30</ISKeepAliveInterval>
<ISConfiguredDevice>32</ISConfiguredDevice>
<ISConfiguredExtension>74</ISConfiguredExtension>
<ISServiceEngine>0.0.0.0</ISServiceEngine>
<ISName>ngm-2800</ISName>
<ISPortNumber>2000</ISPortNumber>
<ISMaxConference>8</ISMaxConference>
<ISMaxRedirect>10</ISMaxRedirect>
<ISMaxEphone>48</ISMaxEphone>
<ISMaxDN>180</ISMaxDN>
<ISVoiceMail>6050</ISVoiceMail>
<ISUrlServices>
<ISUrlService>
<ISUrlType>EPHONE_URL_INFO</ISUrlType>
<ISUrlLink>http://1.4.188.101/localdir</ISUrlLink>
</ISUrlService>
<ISUrlService>
<ISUrlType>EPHONE_URL_DIRECTOREIES</ISUrlType>
<ISUrlLink>http://1.4.188.101/localdir</ISUrlLink>
</ISUrlService>
<ISUrlService>
<ISUrlType>EPHONE_URL_MESSAGES</ISUrlType>
<ISUrlLink>http://1.4.188.101/localdir</ISUrlLink>
</ISUrlService>
<ISUrlService>
<ISUrlType>EPHONE_URL_SERVICES</ISUrlType>
<ISUrlLink>http://1.4.188.101/localdir</ISUrlLink>
</ISUrlService>
<ISUrlService>
<ISUrlType>EPHONE_URL_PROXYSERV</ISUrlType>
<ISUrlLink>http://1.4.188.101/localdir</ISUrlLink>
</ISUrlService>
<ISUrlService>
<ISUrlType>EPHONE_URL_IDLE</ISUrlType>
<ISUrlLink>ttp://1.4.188.101/localdir</ISUrlLink>
</ISUrlService>
<ISUrlService>
<ISUrlType>EPHONE_URL_AUTH</ISUrlType>
<ISUrlLink>http://1.4.188.101/localdir</ISUrlLink>
</ISUrlService>
</ISUrlServices>
<global-after-hours>
<block_list>
<block_item>
<pattern_id>1</pattern_id>
<blocking_pattern>1234</blocking_pattern>
<blocking_option />
</block_item>
<block_item>
<pattern_id>2</pattern_id>
<blocking_pattern>2345</blocking_pattern>
<blocking_option>7-24</blocking_option>
</block_item>
</block_list>
<date_list>
<date_item>
<month>Nov</month>
<day_of_month>12</day_of_month>
<start_time>12:00</start_time>
<stop_time>13:00</stop_time>
</date_item>
</date_list>
<day_list>
<day_item>
<day_of_week>Mon</day_of_week>
<start_time>12:00</start_time>
<stop_time>13:00</stop_time>
</day_item>
</day_list>
<after-hours_login>
<http>true</http>
</after-hours_login>
<override-code>2222</override-code>
<pstn-prefix_list>
<pstn-prefix_item>
<index>1</index>
<pstn-prefix>22</pstn-prefix>
</pstn-prefix_item>
</pstn-prefix_list>
</global-after-hours>
<application_name>calling</application_name>
<auth_credential_list>
<credential_item>
<index>1</index>
<user>test</user>
<password>test</password>
</credential_item>
</auth_credential_list>
<auto>
<assign_list>
<assign_item>
<group_id>1</group_id>
<start_tag>70</start_tag>
<stop_tag>93</stop_tag>
<type>anl</type>
<cfw />
<timeout>0</timeout>
</assign_item>
<assign_item>
<group_id>2</group_id>
<start_tag>1</start_tag>
<stop_tag>20</stop_tag>
<cfw>1234</cfw>
<timeout>80</timeout>
</assign_item>
</assign_list>
</auto>
<auto-reg-ephone>true</auto-reg-ephone>
<bulk-speed-dial_list>
<bulk-speed-dial_item>
<list>1</list>
<url />
</bulk-speed-dial_item>
</bulk-speed-dial_list>
<prefix>123</prefix>
<global-call-forward>
<pattern_list>
<pattern_item>
<index>2</index>
<pattern>.T</pattern>
</pattern_item>
</pattern_list>
<callfwd_system>
<redirecting-expanded>false</redirecting-expanded>
</callfwd_system>
</global-call-forward>
<call-park>
<select>
<no-auto-match>true</no-auto-match>
</select>
<application_system>true</application_system>
<redirect_system>true</redirect_system>
</call-park>
<caller-id>
<block_code>*1</block_code>
<name-only>true</name-only>
</caller-id>
<calling-number>
<initiator>true</initiator>
<local>false</local>
<secondary>false</secondary>
</calling-number>
<cnf-file>
<location>
<TFTP>flash:/its/</TFTP>
<flash>true</flash>
</location>
<option>perphonetype</option>
</cnf-file>
<default_codec>Unknown</default_codec>
<conference>
<hardware>true</hardware>
</conference>
<date-format>mm-dd-yy</date-format>
<device-security-mode>none</device-security-mode>
<dialplan-pattern_list>
<dialplan-pattern_item>
<index>1</index>
<pattern>1234</pattern>
<extension-length>4</extension-length>
<extension-pattern />
<demote>false</demote>
<no-reg>false</no-reg>
</dialplan-pattern_item>
<dialplan-pattern_item>
<index>2</index>
<pattern>1233</pattern>
<extension-length>4</extension-length>
<extension-pattern />
<demote>true</demote>
<no-reg>false</no-reg>
</dialplan-pattern_item>
<dialplan-pattern_item>
<index>3</index>
<pattern>1232</pattern>
<extension-length>4</extension-length>
<extension-pattern>1111</extension-pattern>
<demote>false</demote>
<no-reg>false</no-reg>
</dialplan-pattern_item>
<dialplan-pattern_item>
<index>4</index>
<pattern>1231</pattern>
<extension-length>4</extension-length>
<extension-pattern />
<demote>false</demote>
<no-reg>true</no-reg>
</dialplan-pattern_item>
</dialplan-pattern_list>
<directory>
<entry_list>
<entry_item>
<tag>1</tag>
<number>1234</number>
<name>directory</name>
</entry_item>
</entry_list>
<option>last-name-first</option>
</directory>
<dn-webedit>false</dn-webedit>
<em>
<external>true</external>
<keep-history>true</keep-history>
<logout>12:00 00:-1 -1:-1</logout>
</em>
<ephone-reg>true</ephone-reg>
<extension-assigner>
<tag-type>provision-tag</tag-type>
</extension-assigner>
<fac>
<standard>true</standard>
<custom_list>
<custom_item>
<fac_string>callfwd all</fac_string>
<fac_list>**1</fac_list>
<alias>0</alias>
<alias_map />
</custom_item>
<custom_item>
<fac_string>callfwd cancel</fac_string>
<fac_list>**2</fac_list>
<alias>0</alias>
<alias_map />
</custom_item>
<custom_item>
<fac_string>pickup local</fac_string>
<fac_list>**3</fac_list>
<alias>0</alias>
<alias_map />
</custom_item>
<custom_item>
<fac_string>pickup group</fac_string>
<fac_list>**4</fac_list>
<alias>0</alias>
<alias_map />
</custom_item>
<custom_item>
<fac_string>pickup direct</fac_string>
<fac_list>**5</fac_list>
<alias>0</alias>
<alias_map />
</custom_item>
<custom_item>
<fac_string>park</fac_string>
<fac_list>**6</fac_list>
<alias>0</alias>
<alias_map />
</custom_item>
<custom_item>
<fac_string>dnd</fac_string>
<fac_list>**7</fac_list>
<alias>0</alias>
<alias_map />
</custom_item>
<custom_item>
<fac_string>redial</fac_string>
<fac_list>**8</fac_list>
<alias>0</alias>
<alias_map />
</custom_item>
<custom_item>
<fac_string>voicemail</fac_string>
<fac_list>**9</fac_list>
<alias>0</alias>
<alias_map />
</custom_item>
<custom_item>
<fac_string>ephone-hunt join</fac_string>
<fac_list>*3</fac_list>
<alias>0</alias>
<alias_map />
</custom_item>
<custom_item>
<fac_string>ephone-hunt cancel</fac_string>
<fac_list>#3</fac_list>
<alias>0</alias>
<alias_map />
</custom_item>
<custom_item>
<fac_string>ephone-hunt hlog</fac_string>
<fac_list>*4</fac_list>
<alias>0</alias>
<alias_map />
</custom_item>
<custom_item>
<fac_string>ephone-hunt hlog-phone</fac_string>
<fac_list>*5</fac_list>
<alias>0</alias>
<alias_map />
</custom_item>
<custom_item>
<fac_string>trnsfvm</fac_string>
<fac_list>*6</fac_list>
<alias>0</alias>
<alias_map />
</custom_item>
<custom_item>
<fac_string>dpark-retrieval</fac_string>
<fac_list>*0</fac_list>
<alias>0</alias>
<alias_map />
</custom_item>
<custom_item>
<fac_string>cancel call waiting</fac_string>
<fac_list>*1</fac_list>
<alias>0</alias>
<alias_map />
</custom_item>
</custom_list>
</fac>
<fxo>
<hook-flash>true</hook-flash>
</fxo>
<hunt-group>
<logout>HLog</logout>
<report>
<url_info>
<prefix>tftp://223.255.254.253/ngm/huntgp/2800/data</prefix>
<hg_suffix>
<low>-1</low>
<high>0</high>
</hg_suffix>
</url_info>
<delay>0</delay>
<duration>24</duration>
<internal>
<duration>5</duration>
<hg_suffix>
<low>1</low>
<high>5</high>
</hg_suffix>
</internal>
</report>
</hunt-group>
<internal-call>
<moh-group>-1</moh-group>
</internal-call>
<ip>
<qos>
<dscp_list>
<dscp_item>
<index>0</index>
<af11>media</af11>
</dscp_item>
<dscp_item>
<index>1</index>
<af12>signal</af12>
</dscp_item>
<dscp_item>
<index>2</index>
<af13>video</af13>
</dscp_item>
<dscp_item>
<index>3</index>
<af21>service</af21>
</dscp_item>
<dscp_item>
<index>4</index>
<af22>media</af22>
</dscp_item>
<dscp_item>
<index>5</index>
<af23>media</af23>
</dscp_item>
<dscp_item>
<index>6</index>
<af31>media</af31>
</dscp_item>
<dscp_item>
<index>7</index>
<af32>media</af32>
</dscp_item>
<dscp_item>
<index>8</index>
<af33>media</af33>
</dscp_item>
<dscp_item>
<index>9</index>
<af41>media</af41>
</dscp_item>
<dscp_item>
<index>10</index>
<af42>media</af42>
</dscp_item>
<dscp_item>
<index>11</index>
<af43>media</af43>
</dscp_item>
<dscp_item>
<index>12</index>
<cs1>media</cs1>
</dscp_item>
<dscp_item>
<index>13</index>
<cs2>media</cs2>
</dscp_item>
<dscp_item>
<index>14</index>
<cs3>media</cs3>
</dscp_item>
<dscp_item>
<index>15</index>
<cs4>media</cs4>
</dscp_item>
<dscp_item>
<index>16</index>
<cs5>media</cs5>
</dscp_item>
<dscp_item>
<index>17</index>
<cs6>media</cs6>
</dscp_item>
<dscp_item>
<index>18</index>
<cs7>media</cs7>
</dscp_item>
<dscp_item>
<index>19</index>
<default>media</default>
</dscp_item>
<dscp_item>
<index>20</index>
<ef>media</ef>
</dscp_item>
</dscp_list>
</qos>
<source-address>
<primary>10.4.188.90</primary>
<port>2000</port>
<secondary>1.4.188.90</secondary>
<rehome>0</rehome>
<strict-match>true</strict-match>
</source-address>
</ip>
<keepalive>
<timeout>30</timeout>
<aux_timeout>30</aux_timeout>
</keepalive>
<live-record>999</live-record>
<load_list>
<phone_7914>hehe</phone_7914>
<phone_7915-12>hehe</phone_7915-12>
<phone_7915-24>hehe</phone_7915-24>
<phone_7916-12>hehe</phone_7916-12>
<phone_7916-24>hehe</phone_7916-24>
<phone_12SP>hehe</phone_12SP>
<phone_7902>hehe</phone_7902>
<phone_7906>hehe</phone_7906>
<phone_7910>hehe</phone_7910>
<phone_7911>SCCP11.9-0-1FT6-4DEV</phone_7911>
<phone_7912>hehe</phone_7912>
<phone_7920>hehe</phone_7920>
<phone_7921>hehe</phone_7921>
<phone_7925>hehe</phone_7925>
<phone_7931>hehe</phone_7931>
<phone_7935>hehe</phone_7935>
<phone_7936>hehe</phone_7936>
<phone_7937>hehe</phone_7937>
<phone_7960-7940>P00308000501</phone_7960-7940>
<phone_7941>hehe</phone_7941>
<phone_7941GE>hehe</phone_7941GE>
<phone_7942>hehe</phone_7942>
<phone_7961>SCCP41.8-4-2-38S</phone_7961>
<phone_7962>hehe</phone_7962>
<phone_7965>hehe</phone_7965>
<phone_7970>hehe</phone_7970>
<phone_7971>hehe</phone_7971>
<phone_7975>hehe</phone_7975>
<phone_7985>hehe</phone_7985>
<phone_ata>hehe</phone_ata>
<phone_6921>hehe</phone_6921>
<phone_6941>hehe</phone_6941>
<phone_6961>hehe</phone_6961>
</load_list>
<load-cfg-file_list>
<load-cfg-file_item>
<cfg_file>flash:its/vrf1/XMLDefaultCIPC.cnf.xml</cfg_file>
<alias>cnf.xml</alias>
<sign>false</sign>
</load-cfg-file_item>
</load-cfg-file_list>
<log>
<table>
<max-size>150</max-size>
<retain-timer>15</retain-timer>
</table>
</log>
<login>
<timeout>60</timeout>
<clear>24:0</clear>
</login>
<max-conferences>
<count>8</count>
<gain>-6</gain>
</max-conferences>
<max-dn>
<count>180</count>
<global_preference>0</global_preference>
<no-reg>secondary</no-reg>
</max-dn>
<max-ephones>48</max-ephones>
<max-redirect>10</max-redirect>
<modem>
<passthrough>
<payload-type>100</payload-type>
</passthrough>
<relay_sse>
<payload-type>118</payload-type>
</relay_sse>
<relay_sprt>
<payload-type>120</payload-type>
</relay_sprt>
</modem>
<moh_file>flash:music-on-hold.au</moh_file>
<moh-file-buffer>10000</moh-file-buffer>
<multicast>
<moh_ipaddr>239.10.10.10</moh_ipaddr>
<port>2000</port>
<route_list>
<route_item>
<index>1</index>
<route>10.10.10.10</route>
</route_item>
</route_list>
</multicast>
<mwi-server>
<prefix />
<reg-e164>true</reg-e164>
<relay>true</relay>
</mwi-server>
<network-locale_list>
<network-locale_item>
<index>0</index>
<locale>US</locale>
</network-locale_item>
<network-locale_item>
<index>1</index>
<locale>US</locale>
</network-locale_item>
<network-locale_item>
<index>2</index>
<locale>US</locale>
</network-locale_item>
<network-locale_item>
<index>3</index>
<locale>US</locale>
</network-locale_item>
<network-locale_item>
<index>4</index>
<locale>US</locale>
</network-locale_item>
</network-locale_list>
<night-service>
<option>everyday</option>
<code>*234</code>
<date_list>
<date_item>
<index>1</index>
<month>Jan</month>
<day_of_month>1</day_of_month>
<start_time>12:00</start_time>
<stop_time>14:00</stop_time>
</date_item>
</date_list>
<day_list>
<day_item>
<index>1</index>
<day_of_week>Sun</day_of_week>
<start_time>12:00</start_time>
<stop_time>16:00</stop_time>
</day_item>
<day_item>
<index>2</index>
<day_of_week>Mon</day_of_week>
<start_time>12:00</start_time>
<stop_time>16:00</stop_time>
</day_item>
<day_item>
<index>3</index>
<day_of_week>Tue</day_of_week>
<start_time>12:00</start_time>
<stop_time>16:00</stop_time>
</day_item>
<day_item>
<index>4</index>
<day_of_week>Wed</day_of_week>
<start_time>12:00</start_time>
<stop_time>16:00</stop_time>
</day_item>
<day_item>
<index>5</index>
<day_of_week>Thu</day_of_week>
<start_time>12:00</start_time>
<stop_time>16:00</stop_time>
</day_item>
<day_item>
<index>6</index>
<day_of_week>Fri</day_of_week>
<start_time>12:00</start_time>
<stop_time>16:00</stop_time>
</day_item>
<day_item>
<index>7</index>
<day_of_week>Sat</day_of_week>
<start_time>12:00</start_time>
<stop_time>16:00</stop_time>
</day_item>
</day_list>
<everyday>
<start_time>12:00</start_time>
<stop_time>16:00</stop_time>
</everyday>
<weekday>
<start_time>12:00</start_time>
<stop_time>16:00</stop_time>
</weekday>
<weekend>
<start_time>12:00</start_time>
<stop_time>16:00</stop_time>
</weekend>
</night-service>
<pin>1234</pin>
<pin_override>true</pin_override>
<privacy>true</privacy>
<privacy-on-hold>false</privacy-on-hold>
<protocol>
<mode>dual-stack</mode>
<preference>ipv4</preference>
</protocol>
<sdspfarm>
<conference_options>
<mute-on>124</mute-on>
<mute-off>234</mute-off>
<hardware>false</hardware>
</conference_options>
<units>4</units>
<tag_list>
<tag_item>
<tag>1</tag>
<device>mtp-conf</device>
</tag_item>
</tag_list>
<transcode>
<sessions>4</sessions>
</transcode>
<unregister>
<force>1</force>
</unregister>
</sdspfarm>
<secondary-dialtone>4567</secondary-dialtone>
<secure-signaling>
<trustpoint />
</secure-signaling>
<server-security-mode />
<service>
<local-directory>true</local-directory>
<local-directory_authenticate>false</local-directory_authenticate>
<dss>false</dss>
<dnis>
<overlay>false</overlay>
<dir-lookup>false</dir-lookup>
</dnis>
<directed-pickup>true</directed-pickup>
<directed-pickup_gpickup>false</directed-pickup_gpickup>
<phone_list>
<phone_item>
<index>1</index>
<phone_params>displayOnTime</phone_params>
<phone_text>time.xml</phone_text>
</phone_item>
</phone_list>
</service>
<ssh>
<userid>ngm</userid>
<password>ngm</password>
</ssh>
<standby>
<user>ngm</user>
<password>ngm</password>
</standby>
<system_message>LITTLE TWIN STARS (2800)</system_message>
<tftp-server-credentials>
<trustpoint />
</tftp-server-credentials>
<time-format>12</time-format>
<time-webedit>false</time-webedit>
<time-zone>0</time-zone>
<timeouts>
<busy_timeout>10</busy_timeout>
<interdigit_timeout>10</interdigit_timeout>
<ringing_timeout>180</ringing_timeout>
<transfer-recall_timeout>0</transfer-recall_timeout>
<night-service-bell_timeout>12</night-service-bell_timeout>
</timeouts>
<transfer-digit-collect>new-call</transfer-digit-collect>
<transfer-pattern_list>
<transfer-pattern_item>
<index>1</index>
<pattern>....</pattern>
<blind>false</blind>
</transfer-pattern_item>
<transfer-pattern_item>
<index>2</index>
<pattern>.T</pattern>
<blind>false</blind>
</transfer-pattern_item>
</transfer-pattern_list>
<transfer-system>
<type>full-consult</type>
<dss>false</dss>
</transfer-system>
<trunk_optimization_pre_connect>false</trunk_optimization_pre_connect>
<url_list>
<information>
<url>http://1.4.188.101/localdir</url>
</information>
<directories>
<url>http://1.4.188.101/localdir</url>
</directories>
<messages>
<url>http://1.4.188.101/localdir</url>
</messages>
<services>
<url>http://1.4.188.101/localdir</url>
<name />
</services>
<proxy_server>
<url>http://1.4.188.101/localdir</url>
</proxy_server>
<idle>
<url>http://1.4.188.101/localdir</url>
<idle_timeout>90</idle_timeout>
</idle>
<authentication>
<url>http://1.4.188.101/localdir</url>
<user />
<password />
</authentication>
</url_list>
<user-locale_list>
<user-locale_item>
<index>0</index>
<locale>US</locale>
<package>en</package>
<load />
</user-locale_item>
<user-locale_item>
<index>1</index>
<locale>US</locale>
<package>en</package>
<load />
</user-locale_item>
<user-locale_item>
<index>2</index>
<locale>US</locale>
<package>en</package>
<load />
</user-locale_item>
<user-locale_item>
<index>3</index>
<locale>US</locale>
<package>en</package>
<load />
</user-locale_item>
<user-locale_item>
<index>4</index>
<locale>US</locale>
<package>en</package>
<load />
</user-locale_item>
</user-locale_list>
<video>
<maximum>
<bit-rate>10000000</bit-rate>
</maximum>
</video>
<voicemail>6050</voicemail>
<web>
<system_admin>
<name>Admin</name>
<secret>-1</secret>
<password />
</system_admin>
<customer_admin>
<name>ngm</name>
<secret>5</secret>
<password>$1$.nfD$zn3h3bp/4grULFS87ZHHV/</password>
</customer_admin>
<customize>
<load />
</customize>
</web>
<xml>
<user>cisco</user>
<password>cisco</password>
<level>0</level>
</xml>
</ISGlobal>
</response>
ISgetDevice
ISgetDevice を使用すると、IP Phone の設定情報とステータス情報を取得できます。
要求メッセージで、次のパラメータの任意の組み合わせを使用して、1 つ以上の SCCP 電話機を指定します。
• クエリー対象の SCCP 電話機の ephone タグ番号を含む ISDevID。
• クエリー対象の SCCP 電話機の MAC アドレスを含む ISDevName。
• 次のいずれかのオプションを含む ISKeyword:
– all:設定済みのすべての SCCP 電話機
– allTag:設定済みのすべての SCCP 電話機の ephone タグ番号
– available:次に使用可能な設定対象の ephone タグ番号
要求:例
<request xsi:type="ISgetDevice">
<ISgetDevice>
<ISDevID>1</ISDevID>
<ISDevName>SEP0012DA8AC43D</ISDevName>
<ISDevName>allKeyphone</ISDevName>
</ISgetDevice>
</request>
応答:例
<ISDevName>SEP0016C7C7AF9D</ISDevName>
<ISDevType>Others</ISDevType>
<ISconfigDevType>7911</ISconfigDevType>
<ISDevUsername>test</ISDevUsername>
<ISDevLineButtonID>1</ISDevLineButtonID>
<ISDevLineButtonMode>MONITOR_RING</ISDevLineButtonMode>
<after-hours_exempt>false</after-hours_exempt>
<block-blind-xf-fallback>false</block-blind-xf-fallback>
<capf-ip-in-cnf>false</capf-ip-in-cnf>
<codec_name>g711ulaw</codec_name>
<dspfarm-assist>false</dspfarm-assist>
<fastdial_number>1234</fastdial_number>
<fastdial_name>home LINE</fastdial_name>
<feature-button>1</feature-button>
<feature_type>Dnd</feature_type>
<feature-button>2</feature-button>
<feature_type>Flash</feature_type>
<drop-last>false</drop-last>
<local-only>true</local-only>
<keypad-normalize>false</keypad-normalize>
<keyphone>false</keyphone>
<multicast-moh>true</multicast-moh>
<night-service_bell>true</night-service_bell>
<privacy-button>false</privacy-button>
<busy-trigger-per-button>0</busy-trigger-per-button>
<emergency-resp_location>0</emergency-resp_location>
<max-calls-per-button>0</max-calls-per-button>
<nte-end-digit-delay>0</nte-end-digit-delay>
<aux_timeout>30</aux_timeout>
<em_service>true</em_service>
<directory_service>false</directory_service>
<myphoneapp_service>false</myphoneapp_service>
<reservation-group>park</reservation-group>
<phone_number>1234</phone_number>
<addon_type>7914</addon_type>
<auto_select_line>0</auto_select_line>
<phone_number>1234</phone_number>
<capf-auth-str>7777</capf-auth-str>
<description>ephoneOne</description>
<device-security-mode>none</device-security-mode>
<feature-ring>true</feature-ring>
<ephone-template>1</ephone-template>
<logout-profile>0</logout-profile>
<display_all_missed_calls>true</display_all_missed_calls>
<offhook-guard-timer>0</offhook-guard-timer>
<speeddial-fastdial>true</speeddial-fastdial>
<call-list>true</call-list>
<provision-tag>1</provision-tag>
<username>test</username>
<password>test</password>
<video_enable>true</video_enable>
<vm-device-id>SEP0016C7C7AF9D</vm-device-id>
<Xipv4Address>0.0.0.0</Xipv4Address>
<ExtNumber>6176</ExtNumber>
<ExtStatus>false</ExtStatus>
<LineState>idle</LineState>
<ISKeyPhone>false</ISKeyPhone>
<ISLogoutProfileID>0</ISLogoutProfileID>
<ISUserProfileID>0</ISUserProfileID>
<ISDevStatus>unregistered</ISDevStatus>
<ISDevLastStatus>deceased</ISDevLastStatus>
<ISDevChangeTime>4040</ISDevChangeTime>
<ISDevKeepAlives>0</ISDevKeepAlives>
ISgetDeviceTemplate
ISgetDeviceTemplate を使用すると、IP Phone テンプレートの設定情報とステータス情報を取得できます。
要求メッセージで、次のパラメータの任意の組み合わせを使用して、1 つ以上の電話テンプレートを指定します。
• クエリー対象の電話テンプレート タグ番号を含む ISDevTemplateID。
• 次のいずれかのオプションを含む ISKeyword:
– all:設定済みのすべての電話テンプレート
– allTag:設定済みのすべての電話テンプレートに対する電話テンプレート タグ番号
– available:次に使用可能な設定対象の電話テンプレート タグ番号
要求:例
<request>
<ISgetDeviceTemplate>
<ISgetDevTemplateID>1</ISgetDevTemplateID>
<ISgetDeviceTemplate>
</request>
応答:例
<response>
<ISDeviceTemplates>
<ISDeviceTemplate>
<ISDevTemplateID>1</ISDevTemplateID>
<after-hours>
<block_list>
<block_item>
<pattern_id>1</pattern_id>
<blocking_pattern>1234</blocking_pattern>
<blocking_option>7-24</blocking_option>
</block_item>
</block_list>
<date_list>
<date_item>
<month>Jan</month>
<day_of_month>1</day_of_month>
<start_time>12:00</start_time>
<stop_time>14:00</stop_time>
</date_item>
</date_list>
<day_list>
<day_item>
<day_of_week>Mon</day_of_week>
<start_time>12:00</start_time>
<stop_time>14:00</stop_time>
</day_item>
</day_list>
<exempt>true</exempt>
<after-hours_login>
<http>true</http>
</after-hours_login>
<override-code>1234</override-code>
</after-hours>
<block-blind-xf-fallback>false</block-blind-xf-fallback>
<button-layout_phone_7931>0</button-layout_phone_7931>
<button-layout_list>
<button-layout_item>
<button-layout>1,9</button-layout>
<button-type>line</button-type>
</button-layout_item>
<button-layout_item>
<button-layout>4-5,7</button-layout>
<button-type>speed-dial</button-type>
</button-layout_item>
<button-layout_item>
<button-layout>2-3</button-layout>
<button-type>feature</button-type>
</button-layout_item>
<button-layout_item>
<button-layout>11</button-layout>
<button-type>url</button-type>
</button-layout_item>
</button-layout_list>
<capf-ip-in-cnf>false</capf-ip-in-cnf>
<codec>
<codec_name>g711ulaw</codec_name>
<dspfarm-assist>false</dspfarm-assist>
</codec>
<adhoc_conference>
<add-mode>
<creator>false</creator>
</add-mode>
<admin>false</admin>
<drop-mode>
<creator>false</creator>
<local>false</local>
</drop-mode>
</adhoc_conference>
<fastdial_list>
<fastdial_item>
<fastdial>1</fastdial>
<fastdial_number>1234</fastdial_number>
<fastdial_name>office</fastdial_name>
</fastdial_item>
</fastdial_list>
<feature-button_list>
<feature-button_item>
<feature-button>1</feature-button>
<feature_type>HLog</feature_type>
</feature-button_item>
<feature-button_item>
<feature-button>2</feature-button>
<feature_type>Park</feature_type>
</feature-button_item>
<feature-button_item>
<feature-button>3</feature-button>
<feature_type>Privacy</feature_type>
</feature-button_item>
</feature-button_list>
<url-button_list>
<url-button_item>
<url-button>1</url-button>
<url-button_type>em</url-button_type>
</url-button_item>
<url-button_item>
<url-button>3</url-button>
<url-button_type>myphoneapp</url-button_type>
</url-button_item>
<url-button_item>
<url-button>6</url-button>
<url-button_type>service</url-button_type>
<url-button_url>hello</url-button_url>
<url-button_name>helloworld</url-button_name>
</url-button_item>
</url-button_list>
<features_blocked>Pickup Park GPickup</features_blocked>
<keep-conference>
<hangup>false</hangup>
<drop-last>false</drop-last>
<endcall>false</endcall>
<local-only>false</local-only>
</keep-conference>
<keypad-normalize>false</keypad-normalize>
<keyphone>false</keyphone>
<mlpp>
<indication>true</indication>
<preemption>true</preemption>
<max_priority>-1</max_priority>
</mlpp>
<mtp>false</mtp>
<multicast-moh>true</multicast-moh>
<night-service_bell>false</night-service_bell>
<privacy />
<privacy-button>false</privacy-button>
<phone_service>
<param_list>
<param_item>
<param>displayOnTime</param>
<text>170</text>
</param_item>
</param_list>
</phone_service>
<softkeys>
<alerting_keys />
<connected_keys />
<hold_keys />
<idle_keys />
<remote-in-use_keys>CBarge Newcall</remote-in-use_keys>
<ringing_keys />
<seized_keys />
</softkeys>
<transfer-park>
<blocked>false</blocked>
</transfer-park>
<transfer-pattern>
<blocked>false</blocked>
</transfer-pattern>
<busy-trigger-per-button>0</busy-trigger-per-button>
<emergency-resp_location>0</emergency-resp_location>
<max-calls-per-button>0</max-calls-per-button>
<network_locale>0</network_locale>
<nte-end-digit-delay>0</nte-end-digit-delay>
<transfer_max-length>0</transfer_max-length>
<user_locale>0</user_locale>
<keepalive>
<timeout>30</timeout>
<aux_timeout>30</aux_timeout>
</keepalive>
<lpcor>
<type>none</type>
</lpcor>
<exclude-services>
<em_service>false</em_service>
<directory_service>true</directory_service>
<myphoneapp_service>true</myphoneapp_service>
</exclude-services>
<park>
<reservation-group>1234</reservation-group>
</park>
<paging-dn>
<dn>0</dn>
<mode>multicast</mode>
</paging-dn>
<speed-dial_list>
<speed-dial_item>
<index>1</index>
<phone_number>1234</phone_number>
<label>play</label>
</speed-dial_item>
</speed-dial_list>
<ssh>
<userid>test</userid>
<password>test</password>
</ssh>
<phone_type>
<name>7960</name>
<addon_list>
<addon_item>
<addon>1</addon>
<addon_type>7914</addon_type>
</addon_item>
</addon_list>
</phone_type>
<url_services_list>
<url_services_item>
<services_id>1</services_id>
<url>http</url>
<name>HTTP</name>
</url_services_item>
</url_services_list>
</ISDeviceTemplate>
</ISDeviceTemplates>
</response>
ISgetExtension
ISgetExtension を使用すると、内線番号の設定情報とステータス情報を取得できます。
要求メッセージで、次のパラメータの任意の組み合わせを使用して、1 つ以上の内線番号を指定します。
• クエリー対象の内線 ID 番号を含む ISExtID。
• クエリー対象の内線番号を含む ISExtNumber。
• 次のいずれかのオプションを含む ISKeyword:
– all:設定済みのすべての内線番号の詳細を表示します
– allTag:設定済みのすべての内線 ID 番号のリストを表示します
– available:次に使用可能な設定対象の内線 ID 番号
要求:例
<request>
<ISExtension>
<ISVExtID>1</ISExtID>
<ISExtNumber>1</ISExtNumber>
</ISExtension>
</request>
応答:例
<response>
<ISExtensions>
<ISExtension>
<ISExtID>1</ISExtID>
<ISExtNumber>6001</ISExtNumber>
<ISExtSecNumber>6111</ISExtSecNumber>
<ISExtType>normal</ISExtType>
<ISExtStatus>up</ISExtStatus>
<ISExtChangeTime>3122733</ISExtChangeTime>
<ISExtUsage>0</ISExtUsage>
<ISExtHomeAddress>0.0.0.0</ISExtHomeAddress>
<ISExtMultiLines>0</ISExtMultiLines>
<ISExtPortName>EFXS 50/0/1</ISExtPortName>
<ISExtLineMode>DUAL_LINE</ISExtLineMode>
<ISExtCallStatus>IDLE</ISExtCallStatus>
<Mobility>false</Mobility>
<SNRnumber>1111</SNRnumber>
<SNRdelay>10</SNRdelay>
<SNRtimeout>5</SNRtimeout>
<SNRnoanNumber />
<ISAllowWatch>true</ISAllowWatch>
<ISSessionServerIDs>
<ISSessionServerID>1</ISSessionServerID>
</ISSessionServerIDs>
<firstName />
<lastName>ephoneDnOne</lastName>
<callForwardAll>1234</callForwardAll>
<ISDevList>
<ISDeviceID>8</ISDeviceID>
</ISDevList>
<allow>
<watch>true</watch>
</allow>
<call-forward>
<all>
<number>1234</number>
</all>
<busy>
<number>9000</number>
<option>secondary</option>
<dialplan-pattern>false</dialplan-pattern>
</busy>
<max-length>
<number />
</max-length>
<night-service-activated>
<number>2323</number>
</night-service-activated>
<noan>
<number>1234</number>
<timeout>80</timeout>
<dialplan-pattern>true</dialplan-pattern>
<option />
</noan>
</call-forward>
<call-waiting>
<cw_beep>
<accept>true</accept>
<generate>true</generate>
</cw_beep>
<cw_ring>true</cw_ring>
</call-waiting>
<corlist>
<incoming />
<outgoing />
</corlist>
<cti>
<notify>true</notify>
<watch>true</watch>
</cti>
<description>ephoneDnOne</description>
<hold-alert>
<timeout>15</timeout>
<mode>idle</mode>
<ring-silent-dn>true</ring-silent-dn>
</hold-alert>
<huntstop>
<channel>8</channel>
</huntstop>
<moh-group>0</moh-group>
<mwi>
<type>qsig</type>
<mode />
</mwi>
<mwi-type>both</mwi-type>
<pickup-group />
<transfer-recall_timeout>0</transfer-recall_timeout>
<translate>
<called>1</called>
<calling>2</calling>
</translate>
<translation-profile>
<incoming>in</incoming>
<outgoing>out</outgoing>
</translation-profile>
<application>
<name>calling</name>
<out-bound>calling</out-bound>
</application>
<port-caller-id>
<block>false</block>
<local>false</local>
<transfer_passthrough>false</transfer_passthrough>
</port-caller-id>
<conference_dn>
<mode />
<unlocked>false</unlocked>
</conference_dn>
<ephone-dn-template>0</ephone-dn-template>
<ephone-hunt_login>true</ephone-hunt_login>
<feed>
<ip_addr>0.0.0.0</ip_addr>
<port>0</port>
<route>0.0.0.0</route>
<out-call />
</feed>
<fwd-local-calls>true</fwd-local-calls>
<intercom>
<dn-plar />
<barge-in>false</barge-in>
<label />
<no-mute>true</no-mute>
<ptt>false</ptt>
<no-auto-answer>true</no-auto-answer>
</intercom>
<label />
<loopback-dn>
<dn>0</dn>
<auto-con>false</auto-con>
<loopback-codec />
<forward>0</forward>
<prefix />
<retry>0</retry>
<strip>0</strip>
<suffix />
</loopback-dn>
<mailbox-selection>
<last-redirect-num>false</last-redirect-num>
</mailbox-selection>
<moh>
<ip_addr>0.0.0.0</ip_addr>
<port>0</port>
<route>0.0.0.0</route>
<out-call />
</moh>
<name>ephoneDnOne</name>
<night-service_bell>false</night-service_bell>
<telephony_number>
<primary>6001</primary>
<secondary>6111</secondary>
<no-reg>true</no-reg>
<no-reg_option />
</telephony_number>
<paging>
<group />
<ip_addr>0.0.0.0</ip_addr>
<port>0</port>
</paging>
<park-slot>
<directed>false</directed>
<reserved-for />
<reservation-group />
<timeout>0</timeout>
<limit>0</limit>
<notify />
<only>false</only>
<transfer_destination />
<recall>true</recall>
<alternate />
<retry>0</retry>
<retry_limit>0</retry_limit>
</park-slot>
<pickup-call>
<any-group>false</any-group>
</pickup-call>
<dn_preference>
<order>0</order>
<secondary>9</secondary>
</dn_preference>
<queueing-dn>
<mode />
<timeout>180</timeout>
<transfer_number />
</queueing-dn>
<ring>
<type>external</type>
<line>primary</line>
</ring>
<session-server>
<server>1</server>
</session-server>
<snr_info>
<value>1111</value>
<delay>10</delay>
<timeout>5</timeout>
<cfwd-noan />
</snr_info>
<transfer-mode />
<trunk>
<number />
<timeout>3</timeout>
<transfer-timeout>0</transfer-timeout>
<monitor-port />
</trunk>
<whisper-intercom>
<speed-dial />
<label />
</whisper-intercom>
</ISExtension>
</ISExtensions>
</response>
ISgetExtensionTemplate
ISgetExtensionTemplates を使用すると、内線テンプレートの設定情報とステータス情報を取得できます。
要求メッセージで、次のパラメータの任意の組み合わせを使用して、1 つ以上の内線番号を指定します。
• クエリー対象の内線テンプレート ID 番号を含む ISExtTemplateID。
• 次のいずれかのオプションを含む ISKeyword:
– all:設定済みのすべての内線テンプレートの詳細を表示します
– allTag:設定済みのすべての内線テンプレート ID 番号のリストを表示します
– available:次に使用可能な設定対象の内線テンプレート ID 番号
要求:例
<request>
<ISExtensionTemplates>
<ISExtensionTemplateID>1</ISExtensionTemplateID>
</ISgetExtensionTemplate>
</request>
応答:例
<response>
<ISExtensionTemplates>
<ISExtensionTemplate>
<ISExtTemplateID>1</ISExtTemplateID>
<allow>
<watch>false</watch>
</allow>
<call-forward>
<all>
<number>1234</number>
</all>
<busy>
<number>3456</number>
<option>primary</option>
<dialplan-pattern>false</dialplan-pattern>
</busy>
<max-length>
<number>4</number>
</max-length>
<night-service-activated>
<number>7777</number>
</night-service-activated>
<noan>
<number>9999</number>
<timeout>80</timeout>
<dialplan-pattern>false</dialplan-pattern>
<option>secondary</option>
</noan>
</call-forward>
<call-waiting>
<cw_beep>
<accept>true</accept>
<generate>true</generate>
</cw_beep>
<cw_ring>true</cw_ring>
</call-waiting>
<caller-id_blocked>true</caller-id_blocked>
<corlist>
<incoming />
<outgoing />
</corlist>
<cti>
<notify>false</notify>
<watch>false</watch>
</cti>
<description>ephoneDnTemplate</description>
<hold-alert>
<timeout>15</timeout>
<mode>idle</mode>
<ring-silent-dn>true</ring-silent-dn>
</hold-alert>
<huntstop>
<channel>8</channel>
</huntstop>
<moh-group>0</moh-group>
<mwi>
<type>sip</type>
<mode>on-off</mode>
</mwi>
<mwi-type>both</mwi-type>
<pickup-group>1</pickup-group>
<transfer-recall_timeout>400</transfer-recall_timeout>
<translate>
<called>1</called>
<calling>0</calling>
</translate>
<translation-profile>
<incoming>1</incoming>
<outgoing>1</outgoing>
</translation-profile>
</ISExtensionTemplate>
</ISExtensionTemplates>
</response>
ISgetUser
ISgetUser を使用すると、Cisco Unified CME 内の特定ユーザの情報を取得できます。要求は、Cisco Unified CME で設定されたユーザ名を持つ ISuserID パラメータを含んでいる必要があります。要求に有効な ISuserID が含まれる場合、応答には、このユーザの user-name タグ番号(ISuserTag)とタイプが含まれます。
ISuserType の値は、次に示すように、Cisco Unified CME 内でユーザ名がどのように設定されているかに対応しています。
• 0:INVALID_CME_USER
• 1:EPHONE_USER
• 2:LOGOUT_PROFILE_USER
• 3:USER_PROFILE_USER
要求に無効な ISuserID が含まれる場合、ISuserTag と ISuserType の値はどちらも「0」になります。
要求:例
<request>
<ISgetUser>
<ISuserID>a</ISuserID>
</ISgetUser>
</request>
応答:例
<response>
<ISuser>
<ISuserID>a</ISuserID>
<ISuserType>3</ISuserType>
<ISuserTag>1</ISuserTag>
</ISuser>
</response>
ISgetUserProfile
ISgetUserProfile を使用すると、特定のユーザ プロファイルのステータスと設定情報を取得できます。
次のいずれかの組み合わせを使用します。
• 特定ユーザのユーザ プロファイル ID を含む ISUserProfileID。
• 特定ユーザのユーザ ID を含む ISuserID。
• 次のいずれかのオプションを含む ISKeyword:
– all:設定済みのすべてのユーザ プロファイルの詳細を表示します。
– allTag:設定済みのすべてのユーザ プロファイル ID のリストを表示します。
– available:次に使用可能なユーザ プロファイル。
要求:例
<request>
<ISgetUserProfile>
<ISUserProfileID>1</ISUserProfileID>
</ISgetUserProfile>
</request>
応答:例
<response>
<ISUserProfiles>
<ISUserProfile>
<ISUserProfileID>1</ISUserProfileID>
<ISuserID>a</ISuserID>
<ISpassword>a</ISpassword>
<ISuserPin>12</ISuserPin>
<ISPrivacyButton>no</ISPrivacyButton>
<ISuserMaxIdleTime>0</ISuserMaxIdleTime>
<SpeedDials>
<SpeedDial>
<SpeedDialIndex>1</SpeedDialIndex>
<SpeedDialNumber>901</SpeedDialNumber>
<SpeedDialLabel />
<SpeedDialBLF>no</SpeedDialBLF>
</SpeedDial>
<SpeedDial>
<SpeedDialIndex>2</SpeedDialIndex>
<SpeedDialNumber>902</SpeedDialNumber>
<SpeedDialLabel />
<SpeedDialBLF>no</SpeedDialBLF>
</SpeedDial>
<SpeedDial>
<SpeedDialIndex>3</SpeedDialIndex>
<SpeedDialNumber>2002</SpeedDialNumber>
<SpeedDialLabel>2002Label</SpeedDialLabel>
<SpeedDialBLF>no</SpeedDialBLF>
</SpeedDial>
<SpeedDial>
<SpeedDialIndex>5</SpeedDialIndex>
<SpeedDialNumber>2004</SpeedDialNumber>
<SpeedDialLabel>2004</SpeedDialLabel>
<SpeedDialBLF>yes</SpeedDialBLF>
</SpeedDial>
</SpeedDials>
<UserNumbers>
<UserNumber>
<ISExtNumber>2003</ISExtNumber>
<ISExtMode>NORMAL</ISExtMode>
<ISExtOverlayGroup>0</ISExtOverlayGroup>
<ISExtCombo>no</ISExtCombo>
</UserNumber>
<UserNumber>
<ISExtNumber>201</ISExtNumber>
<ISExtMode>NORMAL</ISExtMode>
<ISExtOverlayGroup>0</ISExtOverlayGroup>
<ISExtCombo>no</ISExtCombo>
</UserNumber>
<UserNumber>
<ISExtNumber>202</ISExtNumber>
<ISExtMode>NORMAL</ISExtMode>
<ISExtOverlayGroup>0</ISExtOverlayGroup>
<ISExtCombo>no</ISExtCombo>
</UserNumber>
</UserNumbers>
<ISuserCurrentPhone>
<CurrentPhoneType>Unknown</CurrentPhoneType>
<CurrentPhoneID>0</CurrentPhoneID>
</ISuserCurrentPhone>
</ISUserProfile>
</ISUserProfiles>
</response>
ISgetUtilityDirectory
ISgetUtilityDirectory を使用すると、ディレクトリ情報に関するステータス情報と設定情報を取得できます。
要求:例
<request>
<ISgetUtilityDirectory>
</ISgetUtilityDirectory>
</request>
応答:例
<response>
<ISUtilityDirectory>
<ISDirectoryEntry>
<ISDirectoryTag>1</ISDirectoryTag>
<ISDirectoryNumber>12345</ISDirectoryNumber>
<firstName>first</firstName>
<lastName>last</lastName>
</ISDirectoryEntry>
<ISDirectoryEntry>
<ISDirectoryTag>2</ISDirectoryTag>
<ISDirectoryNumber>67890</ISDirectoryNumber>
<firstName>first2</firstName>
<lastName>last 2</lastName>
</ISDirectoryEntry>
</ISUtilityDirectory>
</response
ISgetVoiceRegGlobal
ISgetVoiceRegGlobal を使用すると、SIP のグローバル パラメータのステータス情報と設定情報を取得できます。
要求:例
<request>
<ISgetVoiceRegGlobal>
</ISgetVoiceRegGlobal>
</request>
応答:例
<response>
<ISSipGlobal>
<ISAddress>10.10.10.1</ISAddress>
<ISMode>cme</ISMode>
<ISVersion>7.1</ISVersion>
<ISAuthModes>
<ISAuthMode>ood_refer</ISAuthMode>
<ISAuthMode>presence</ISAuthMode>
</ISAuthModes>
<ISPortNumber>5060</ISPortNumber>
<ISMaxPool>10</ISMaxPool>
<ISMaxDN>100</ISMaxDN>
<ISMaxRedirect>5</ISMaxRedirect>
</ISSipGlobal>
</response>
ISgetSipDevice
SIP 電話機の場合は、要求メッセージで次のパラメータの任意の組み合わせを使用して、1 台以上の SIP 電話機を指定します。
• クエリー対象の SIP 電話機の音声レジスタ プール タグ番号を含む ISPoolID。
• クエリー対象の SIP 電話機の音声レジスタ プール名を含む ISPoolName
• 次のいずれかのオプションを含む ISKeyword:
– all:設定済みのすべての SIP 電話機
– allTag:設定済みのすべての SIP 電話機に対する音声レジスタ プール タグ番号
– available:次に使用可能な設定対象の電話タグ番号
要求:例
<request>
<ISgetSipDevice>
<ISPoolID>1</ISPoolID>
</ISgetSipDevice>
</request>
応答:例
<response>
<ISSipDevices>
<ISSipDevice>
<ISPoolID>1</ISPoolID>
<ISDevMac>0013.1978.3CA5</ISDevMac>
<ISSessionServerID>0</ISSessionServerID>
<ISDevAddr>
<Xipv4Address>0</Xipv4Address>
</ISDevAddr>
<ISSipPhoneLineList>
<ExtMapStatus>
<LineId>1</LineId>
<ExtId>1</ExtId>
<ExtNumber>901</ExtNumber>
<LineState>idle</LineState>
</ExtMapStatus>
<ExtMapStatus>
<LineId>2</LineId>
<ExtId>2</ExtId>
<ExtNumber>902</ExtNumber>
<LineState>idle</LineState>
</ExtMapStatus>
</ISSipPhoneLineList>
<ISPoolMaxRegistration>42</ISPoolMaxRegistration>
<ISPoolDtmfRelay>rtp-nte</ISPoolDtmfRelay>
<ISDevCodec>g729r8</ISDevCodec>
</ISSipDevice>
</ISSipDevices>
</response>
ISgetSipExtension
ISgetSipExtension を使用すると、内線番号の設定情報とステータス情報を取得できます。
要求メッセージで、次のパラメータの任意の組み合わせを使用して、1 つ以上の内線番号を指定します。
• クエリー対象の内線 ID 番号を含む ISVoiceRegDNID。
• クエリー対象の内線番号を含む ISVoiceRegNumber。
• 次のいずれかのオプションを含む ISKeyword:
– all:設定済みのすべての内線番号の詳細を表示します
– allTag:設定済みのすべての内線 ID 番号のリストを表示します
– available:次に使用可能な設定対象の内線 ID 番号
要求:例
<request>
<ISgetSipExtension>
<ISVoiceRegDNID>1</ISVoiceRegDNID>
</ISgetSipExtension>
</request>
応答:例
<response>
<ISSipExtensions>
<ISSipExtension>
<ISVoiceRegDNID>1</ISVoiceRegDNID>
<ISExtNumber>901</ISExtNumber>
<ISSessionServerIDs>
<ISSessionServerID>1</ISSessionServerID>
<ISSessionServerID>2</ISSessionServerID>
</ISSessionServerIDs>
<ISAllowWatch>true</ISAllowWatch>
<firstName>Henry</firstName>
<lastName>Mann</lastName>
<ISSipDevList>
<ISPoolID>1</ISPoolID>
<ISPoolID>2</ISPoolID>
</ISSipDevList>
</ISSipExtension>
</ISSipExtensions>
</response>
ISgetSessionServer
ISgetSessionServer を使用すると、Cisco Unified CME 内のセッション サーバの設定情報を取得できます。
要求メッセージで、次のパラメータの任意の組み合わせを使用して、1 つ以上のセッション サーバを指定します。
• セッション サーバ タグ番号を含む ISSessionServerID。
• セッション サーバ タグ番号を含む ISSessionserverName。
• 次のいずれかのキーワードを指定した ISKeyword:
– all:設定済みのすべてのセッション サーバ
– allTag:設定済みのすべてのセッション サーバのセッション サーバ タグ番号
– available:次に使用可能な設定対象のセッション サーバ タグ番号
要求:例
<request>
<ISgetSessionServer>
<ISSessionServerID>1</ISSessionServerID>
</ISgetSessionServer>
</request>
応答:例
<response>
<ISSessionServers>
<ISSessionServer>
<ISSessionServerID>1</ISSessionServerID>
<ISSessionRegisterID>SS1</ISSessionRegisterID>
<ISSessionKeepAlives>60</ISSessionKeepAlives>
</ISSessionServer>
</ISSessionServers>
</response>
ISgetVoiceHuntGroup
ISgetVoiceHuntGroupID を使用すると、音声ハント グループに関するステータス情報と設定情報を取得できます。
要求メッセージで、次のパラメータの任意の組み合わせを使用して、1 つ以上の音声ハント グループを指定します。
• 音声ハント グループ ID 番号を含む ISVoiceHuntGroupID。
• 次のいずれかのキーワードを指定した ISKeyword:
– all:設定済みのすべての音声ハント グループ
– allTag:設定済みのすべての音声ハント グループの音声ハント グループ ID 番号
– available:次に使用可能な設定対象の音声ハント グループ ID 番号
要求:例
<request>
<ISgetVoiceHuntGroup>
<ISVoiceHuntGroupID>1</ISVoiceHuntGroupID>
</ISgetVoiceHuntGroup>
</request>
応答:例
<response>
<ISVoiceHuntGroups>
<ISVoiceHuntGroup>
<ISVoiceHuntGroupID>1</ISVoiceHuntGroupID>
<ISVoiceHuntGroupType>longest-idle</ISVoiceHuntGroupType>
<ISVoiceHuntGroupPilotNumber>200</ISVoiceHuntGroupPilotNumber>
<ISVoiceHuntGroupPilotPeerTag>200</ISVoiceHuntGroupPilotPeerTag>
<ISVoiceHuntGroupPilotPreference>0</ISVoiceHuntGroupPilotPreference>
<ISVoiceHuntGroupSecPilotNumber />
<ISVoiceHuntGroupSecPilotPeerTag>-1</ISVoiceHuntGroupSecPilotPeerTag>
<ISVoiceHuntGroupSecPilotPreference>0</ISVoiceHuntGroupSecPilotPreference>
<ISVoiceHuntGroupListSize>2</ISVoiceHuntGroupListSize>
<ISVoiceHuntGroupListNums>
<ISVoiceHuntGroupListNum>201</ISVoiceHuntGroupListNum>
<ISVoiceHuntGroupListNum>202</ISVoiceHuntGroupListNum>
</ISVoiceHuntGroupListNums>
<ISVoiceHuntGroupFinalNum />
<ISVoiceHuntGroupTimeout>180</ISVoiceHuntGroupTimeout>
<ISVoiceHuntGroupHops>2</ISVoiceHuntGroupHops>
</ISVoiceHuntGroup>
</ISVoiceHuntGroups>
</response>
ISgetPresenceGlobal
ISgetPresenceGlobal を使用すると、Cisco Unified CME のプレゼンス エンジンの設定情報とステータスを取得できます。
要求:例
<request>
<ISgetPresenceGlobal />
</request>
応答:例
<response>
<ISPresenceGlobal>
<ISPresenceEnable>true</ISPresenceEnable>
<ISMode>cme</ISMode>
<ISAllowSub>true</ISAllowSub>
<ISAllowWatch>true</ISAllowWatch>
<ISMaxSubAllow>100</ISMaxSubAllow>
<ISSipUaPresenceStatus>false</ISSipUaPresenceStatus>
</ISPresenceGlobal>
</response>