Unified CM : API ドキュメントの紹介

[Yoshiyuki Anzai]

• はじめに
• Collaboration Dev Center
• Cisco Java Telephony API (JTAPI)
• Web Dialer
• User Data Service (UDS)
• XML ベースの設定管理 API
• Administrative XML (AXL)
• Serviceability XML (SXML)
• Platform API - Platform Administrative Web Service (PAWS)
• axltoolkit - Python ライブラリ
• 参考情報

 

はじめに

本ドキュメントでは Cisco Unified Communications Manager (Unified CM) にて提供される以下の API ドキュメントの紹介をします。

• JTAPI
• User Data Service (UDS)
• Web Dialer
• Administrative XML (AXL)
• Serviceability XML (SXML)
• Platform API - Platform Administrative Web Services (PAWS)

Collaboration Dev Center

Cisco DEVNET 内の Collaboration Dev Center には Collaboration 製品で利用できる各 API について一覧を公開しています。併せてご確認ください。

また、以下 Cisco Live! のドキュメントにて Collaboration 製品の API の活用法が紹介されています。

• Cisco Live! - BRKCOL-2256 Using Collaboration API's to solve Real-World Challenges 

Cisco Java Telephony API (JTAPI)

JTAPI を利用することで Unified CM と連携する CTI アプリケーションを作成ができます。

• DevNet - JTAPI 
• Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 12.5(1) 

コールイベントやデバイスをモニタリングし、呼制御を行う 3rd Party Application の作成が可能になります。

Web Dialer

Click-to-Dial (ブラウザからクリックによる発信) を可能にする API です。後述する AXL, SXML, PAWS と同様に XML ベースでリクエストを行います。

• WebDialer Developer Guide 
• What is WebDialer? 

User Data Service (UDS)

UDS は Unified CM の内部でもコンタクトサービスとして利用されている REST ベースの API となります。

• What is UDS? 
• UDS API Reference  

UDS では一例として以下の機能が提供されています。

• Unified CM の管理
  • バージョン情報の取得
  • IP Phone サービスの管理
• 個人ユーザーの管理
  • クレデンシャル・スピードダイヤルの管理
  • Call Forwarding の転送先の管理
  • デバイス設定
  • IP Phone サービスの登録・その他個人設定
• ディレクトリサービス - ユーザーの検索

XML ベースの設定管理 API

以下の AXL, SXML, Platform API はいずれも XML を HTTP リクエストで送信することで Unified CM を管理します。下記の Sandbox を利用して API の動作確認ができます。

• Cisco UC Manager 12.0 Sandbox 

Administrative XML (AXL)

Unified CM Admin で提供される設定変更に該当する操作を提供する SOAP / WSDL ベースの API です。以下のドキュメントが公開されています。

• CUCM Administrative XML (AXL) 
• DEVNET Collaboration Dev Center - Cisco Administrative XML (AXL) 
• AXL Documentation 

AXL を利用することで IP Phone のプロビジョニングや設定変更を Unified CM Admin GUI を経由せずに実施できます。

Serviceability XML (SXML)

Unified CM Serviceability で提供される以下の5つの機能を提供する API です。

• Real-Time Information (RiSPort) → API Reference
• Call Detail Records (CDRonDemand) → API Reference
• Performance Monitoring (PerfMon) → API Reference
• Service Control (ControlCenter) → API Reference
• Log Collection (Log Collection, DimeGetFile) → API Reference

AXL 同様に SOAP / WSDL ベースの API となります。API を介して Perfmon の確認やログの収集を 実施できます。

• What is Unified CM Serviceability? 

Platform API - Platform Administrative Web Service (PAWS)

Unified CM OS Admin に相当する Platform に関する設定管理機能を提供する API です。AXL, SXML と同様に XML ベースの API となり、例として以下の機能が実装されています。

• アップグレード・アップグレードの中止
• バージョン切り替え
• リブート
• ノード情報の取得・ハードウェア情報の取得
• インストールする COP ファイルの検証

下記ドキュメントも併せてご確認ください。

• What is PAWS? 
• PAWS - API Reference 

axltoolkit - Python ライブラリ

• https://github.com/pgiralt/axltoolkit 

ここまでで紹介した AXL, SXML, PAWS API を活用した Python ライブラリです。詳細については BRKCOL-2256 で紹介されています。

参考情報

• Cisco Developer Documentation : API ドキュメント一覧が確認できます。

[Yoshiyuki Anzai]

 

はじめに

本ドキュメントでは Cisco Unified Communications Manager (Unified CM) にて提供される以下の API ドキュメントの紹介をします。

• JTAPI
• User Data Service (UDS)
• Web Dialer
• Administrative XML (AXL)
• Serviceability XML (SXML)
• Platform API - Platform Administrative Web Services (PAWS)

Collaboration Dev Center

Cisco DEVNET 内の Collaboration Dev Center には Collaboration 製品で利用できる各 API について一覧を公開しています。併せてご確認ください。

また、以下 Cisco Live! のドキュメントにて Collaboration 製品の API の活用法が紹介されています。

• Cisco Live! - BRKCOL-2256 Using Collaboration API's to solve Real-World Challenges 

Cisco Java Telephony API (JTAPI)

JTAPI を利用することで Unified CM と連携する CTI アプリケーションを作成ができます。

• DevNet - JTAPI 
• Cisco Unified JTAPI Developers Guide for Cisco Unified Communications Manager Release 12.5(1) 

コールイベントやデバイスをモニタリングし、呼制御を行う 3rd Party Application の作成が可能になります。

Web Dialer

Click-to-Dial (ブラウザからクリックによる発信) を可能にする API です。後述する AXL, SXML, PAWS と同様に XML ベースでリクエストを行います。

• WebDialer Developer Guide 
• What is WebDialer? 

User Data Service (UDS)

UDS は Unified CM の内部でもコンタクトサービスとして利用されている REST ベースの API となります。

• What is UDS? 
• UDS API Reference  

UDS では一例として以下の機能が提供されています。

• Unified CM の管理
  • バージョン情報の取得
  • IP Phone サービスの管理
• 個人ユーザーの管理
  • クレデンシャル・スピードダイヤルの管理
  • Call Forwarding の転送先の管理
  • デバイス設定
  • IP Phone サービスの登録・その他個人設定
• ディレクトリサービス - ユーザーの検索

XML ベースの設定管理 API

以下の AXL, SXML, Platform API はいずれも XML を HTTP リクエストで送信することで Unified CM を管理します。下記の Sandbox を利用して API の動作確認ができます。

• Cisco UC Manager 12.0 Sandbox 

Administrative XML (AXL)

Unified CM Admin で提供される設定変更に該当する操作を提供する SOAP / WSDL ベースの API です。以下のドキュメントが公開されています。

• CUCM Administrative XML (AXL) 
• DEVNET Collaboration Dev Center - Cisco Administrative XML (AXL) 
• AXL Documentation 

AXL を利用することで IP Phone のプロビジョニングや設定変更を Unified CM Admin GUI を経由せずに実施できます。

Serviceability XML (SXML)

Unified CM Serviceability で提供される以下の5つの機能を提供する API です。

• Real-Time Information (RiSPort) → API Reference
• Call Detail Records (CDRonDemand) → API Reference
• Performance Monitoring (PerfMon) → API Reference
• Service Control (ControlCenter) → API Reference
• Log Collection (Log Collection, DimeGetFile) → API Reference

AXL 同様に SOAP / WSDL ベースの API となります。API を介して Perfmon の確認やログの収集を 実施できます。

• What is Unified CM Serviceability? 

Platform API - Platform Administrative Web Service (PAWS)

Unified CM OS Admin に相当する Platform に関する設定管理機能を提供する API です。AXL, SXML と同様に XML ベースの API となり、例として以下の機能が実装されています。

• アップグレード・アップグレードの中止
• バージョン切り替え
• リブート
• ノード情報の取得・ハードウェア情報の取得
• インストールする COP ファイルの検証

下記ドキュメントも併せてご確認ください。

• What is PAWS? 
• PAWS - API Reference 

axltoolkit - Python ライブラリ

• https://github.com/pgiralt/axltoolkit 

ここまでで紹介した AXL, SXML, PAWS API を活用した Python ライブラリです。詳細については BRKCOL-2256 で紹介されています。

参考情報

• Cisco Developer Documentation : API ドキュメント一覧が確認できます。