デバイスの API を使用して、デバイスの設定、統合の構築、および拡張機能の作成を行うことができます。
デバイスに対してプログラムを実行するには、デバイスにローカルユーザがいる必要があります。 ローカル ユーザの作成については、「ローカル ユーザの管理」の項目をご覧ください。
API には複数の方法でアクセスできます。 選択する方法に関係なく、API の構造は同じです。 用途に最も適した接続方法を選択してください。
-
SSH(セキュアな TCP/IP 接続 デフォルトでは有効になっています)。
-
Telnet(DX、MX、および SX シリーズのデバイスでのみ使用可能 デフォルトでは、ディセーブルです)。
-
HTTP/HTTPS(HTTPSはデフォルトで有効)。
-
IP アドレス、DNS、ネットワークがない状態でもシリアル接続を使用できます。 デフォルトでは有効になっています)。
API ガイド
API の使用方法とコマンドの説明については、 https://roomos.cisco.com/ を参照してください。
すべての製品の API コマンド、構文、セマンティクスについては、当ガイドで説明しています。
デバイスが Webex に登録されている場合に適用されないコマンド
API で使用できる設定、コマンド、およびステータスの一部は、オンプレミスの登録済みデバイスにのみ適用されます。 上記は、Webex に登録されているデバイスには適用されません。 API ガイドのサポートされるコマンドのマトリックスでは、これらの項目は、「オンプレミスのみ」とマークされています。
適用されない設定、コマンドおよびステータスはすべて、H.323、H.320、SIP、NTP、CUCM、LDAP、近接通信、および相手先カメラ制御に関連するものです。
適用されない設定とステータスは、後のソフトウェアリリースで Webex 登録済みデバイスから削除されます。 上記カテゴリに対して API コマンドのプログラムを作成しないことを推薦します。