CommuniGate ProユニファイドコミュニケーションサーバーAPI

組織に新しい複雑なシステムをインストールしたすべての人は、ソフトウェア開発者が管理またはユーザーインターフェイスに対する特定のニーズを提供しなかったという事実に直面していました。



通信の場合、これは通常、セキュリティ、従業員の監視、および統計の収集を目的として、通信、通話、およびメッセージの追加処理の必要性によって通常補完されます。



この記事では、CommuniGate Proサーバーのツールキットについて説明します

• 管理タスクを自動化する
• 手紙と電話の処理
• サードパーティのプログラムとスクリプトの接続
• HTMLインターフェイスの構築
• さまざまなプラットフォームでのUCクライアントおよびユーティリティの作成

CLI

コマンドラインインターフェイスは、多くの製品を管理する標準的な方法です。 管理タスクの自動化に便利です。 コマンドの形式と完全な説明は記事の範囲を超えていますが、 マニュアルでそれらを見ることができます、いくつかの例を挙げます：

poppwdによるアクセス

サーバーでCLIにアクセスするには、いくつかの方法があります。 コマンドに慣れるのに最も便利なものの1つは、PWDモジュールと考えることができます。 標準のサーバー構成では、OSのコマンドラインに「telnet server.address 8106」と入力するだけです（またはOSとバージョンに応じて「telnet server.address 106」）。 当初、このモジュールは単にパスワード変更プロトコルの実装でした-poppwd：

$ telnet localhost 8106 Trying 127.0.0.1... Connected to localhost. Escape character is '^]'. 200 mymac.ru CommuniGate Pro PWD Server 6.0.5 ready <1.1381912847@mymac.ru> user postmaster 300 please send the PASS pass ****** 200 login OK, proceed newpass ****** 200 Password updated
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

しかし、1つのテキストコマンドについて説明する理由はありません。

 listdomains 200 data follow (mymac.ru) listaccounts mymac.ru 200 data follow { pbx = macnt; postmaster = macnt; user1 = macnt; user2 = macnt; }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

この回答のmacntという言葉は、 マルチメールボックスアカウントを意味します

HTTPアクセス

CLIコマンドは、server.name：[http port] / CLI /に「command」パラメーターを指定した単純なPOSTまたはGET要求を送信することでも実行できます。

図書館

ベアテキストアクセスは実際のタスクにはあまり便利ではないため、CLIを操作するためのPerlおよびJavaライブラリを作成しました。



当社のWebサイトには、頻繁に発生するタスクを解決するためのCLIスクリプトの例を提供する特別なセクションがあります。



CLIコマンドは、XIMSSプロトコル（cliExecuteコマンド）およびCG / PLプログラム（ExecuteCLI（）関数）でも実行できます。これについては、対応するセクションで説明します。

郵便および信号規則

おそらく、APIにルールを追加することをストレッチと呼ぶことができますが、Communigate Proでは、ルールはアカウントとメールボックス間で文字や呼び出しをリダイレクトするだけでなく、サードパーティプログラム（さまざまなフィルターなど）に文字を送信したり、CG / PLプログラムを実行したり、スクリプトを実行したりするためにも使用されますオペレーティングシステムで-一般に、それらは単独で、または他のAPIとの両方で統合のために積極的に使用されます。

Communigate Proの信号は、リアルタイム通信で使用される特別なオブジェクトです。 信号は、リアルタイム通信の単位です。 さまざまな参加者（SIP、XMPPクライアント、PBXアプリケーションなど）が互いに信号を送信して、ダイアログやその他のアクションのステータスを整理、中断、更新します。

ルールの仕組み

ルールは、サーバー、ドメイン、アカウント（アカウント）レベルの3つのレベルに分かれています。 これらの各レベルには、シグナルとメールに個別のルールがあります。



各ルールには名前と優先度があり、シグナルルールには「いつ」条件があります。 優先度が高いほど、同じ残りの条件の下で、ルールは機能します。 「いつ」条件は、ルールが動作する瞬間を決定します-信号が処理される秒、または特定のコードでエラーが発生したとき（応答しない、ビジーまたはその他のエラー）：











メールメッセージを処理する手順：

• すべてのサーバールールが適用されます
• ルーティングの結果としてローカルアカウントに入ったこれらの文字は、ドメインルールおよびアカウントのルールによって次のように処理されます。
  
  
  • 優先度が5を超えるドメインルール
  • アカウントルール
  • 優先度が5以下のドメインルール
  
  
  

信号処理順序：

• サーバーシグナリングルールは、空の「いつ」フィールドを使用して適用されます（つまり、すぐに適用されます）
• ルーティングの結果としてローカルアカウントになったシグナルは、残りのサーバールール（空のフィールドではない場合）、ドメインルール、およびアカウント内のルールによって次のように処理されます。
  
  
  • 優先度> 5のサーバールール
  • 優先度が5を超えるドメインルール
  • アカウントルール
  • 優先度が5以下のドメインルール
  • 優先度が5以下のサーバールール
  
  
  

使用例

ドメイン転送の制限：



特定のドメイン外の受信者とのすべての呼び出しは、指定されたアドレスにリダイレクトされます。

ヘルパー

Communigate Proはヘルパープロトコルを実装しているため、サーバーの外部のプログラムをさまざまなタスクに使用できます。



たとえば、特定の条件下で、メールルールがドメインで処理するメッセージまたは外部認証がトリガーされるメッセージのフィルターを開始すると、サーバーはヘルパープログラムを開始します。 その後、標準入力から開始してヘルパープロトコルコマンドを送信し、標準出力から応答を読み取ります。



ヘルパープロトコルの一般的なセッションの例（I-プログラムへの入力、O-出力）：

 O: * My Helper program started I: 00001 INTF 1 O: 00001 INTF 1 I: 00002 COMMAND parameters O: 00002 OK I: 00003 COMMAND parameters I: 00004 COMMAND parameters O: * processing 00003 will take some time O: 00004 ERROR description O: 00003 OK I: 00005 QUIT O: * processed: 5 requests. Quitting. O: 00005 OK
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ここで、INTFコマンドはプロトコルバージョンに同意し、QUITはセッションを終了します。*は情報メッセージであり、サーバーは応答しませんが、ログに書き込みます。



このプロトコルでは、次の目的のために、より専門的なプロトコルが開発されています。

• ボディ加工手紙
• 外部認証
• バナーシステム接続
• 認証へのRADIUS要求の追加
• クラスター負荷分散管理

それらはすべて、設定->一般->ヘルパーWebAdminインターフェースページで接続されています。



実行可能ファイルへのすべてのパスは、Communigate Proベースディレクトリ（ユーザーデータを含むディレクトリ）からカウントされます。

ボディ加工手紙

メールハンドラは、たとえば次のようなメールルールによってトリガーされます。







これと他のヘルパーのコマンドの詳細な説明はマニュアルにあります 。 この記事では、一般的な説明のみを提供します。



このタイプのヘルパーは、主にアンチウイルスおよびアンチスパムエンジンをCGProに接続するために使用されます。

外部認証

通常、外部認証のヘルパープロトコルは次の場合に使用されます。

• サーバーで直接サポートされていない認証方法が必要です
• 一部のアカウントは別のシステム（ADなど）にあります
• 複雑なルーティングが必要
• サービス\アカウント設定の外部管理が必要

このタイプのヘルパーの例は、 このページにあります 。

その他の助手

バナーシステムのヘルパーは、サーバーにXIMSSおよび他の（たとえば、HTTP）クライアントのバナーを提供します。

RADIUSヘルパーを使用すると、RADIUSプロトコルを使用して認証プロセスに追加のチェックを追加できます。

ロードバランサーは、 Communigate Pro クラスター構成でのロードバランサーの管理に役立ちます 。

WSP

WSSP（Webサーバー側ページ）は、Webページテンプレート用の言語です。

WSSPについて説明する前に、サーバー上でWebスキンを整理することについて少し説明する必要があります。



各Webスキンは、3種類のファイルで構成されています。

• 静的ファイル-グラフィックス、スタイル、...
• WSSPファイル
• 言語と文字列ファイル

Communigate Pro配布キットには、標準（ストック）Webインターフェイスの小さなセットが付属しています。 それらの1つは匿名（名前なし）で、残りは名前付きです。 これらのデモスキンは、サーバーのアプリケーションフォルダー（実行可能ファイルが存在するOS内のフォルダー）に格納されているため、サーバーが更新されると置き換えられます。 管理者は 、構成のデモスキンを変更しないでください 。更新をインストールすると、これらの変更が失われる可能性があります。 代わりに、スキンファイルが階層を形成するという事実を利用してください。

スキンのファイル階層

各スキンは、サーバー、ドメイン、または標準にすることができます。



ユーザーのブラウザからのリクエストを処理するとき、サーバーは通常、スキンから特定の名前のファイルを取得する必要があります。 さらに、ドメインスキンでファイルが見つからない場合、同じ名前のサーバースキンで検索されます。 サーバールームでそれを見つけられなかった場合は、ストックルームを探します。 それでもファイルが見つからず、現在のスキンに名前が付けられている場合、ファイルは名前のないスキンで検索されます。



したがって、独自のファイルを名前のないサーバースキンにアップロードすると、サーバー管理者は標準のファイルではなく自分のファイルが使用されていることを確認できます。



つまり、このアプローチを使用すると、標準スキンに小さな変更を加えることも、独自のスキンをゼロから開発することもできます。

文字列ファイル

.dataファイルには、 CG / PL辞書形式のテキストデータ（UFT-8）が含まれています;これらのデータは、さまざまなサーバーモジュールによって使用され、インターフェイスで文字列を形成したり、値を設定したりします。



これらのファイルも階層を形成しますが、すでにディクショナリのキーレベルにあります。つまり、ドメインのstrings.dataファイルにキーがない場合、サーバーはサーバーレベルのstrings.dataファイルなどでそれを見つけようとします。



インターフェイス内の文字列のデフォルト言語は英語です。 ユーザー（セッション）の言語が英語と異なる場合、言語ファイル（french.data、russian.data）のキーの値が、strings.dataファイルの値を置き換えます。



このようなシステムでは、わずかに変更されたインターフェイス（strings.dataファイル）に、完全なセットではなく、値が変更されたキー（会社名、ブランド名など）のみを含めることができます。

リクエスト処理

ブラウザがHTTPプロトコルを使用してサーバーに接続すると、サーバーはリクエストからホスト名を抽出し、その名前のドメインを探します。 ドメインが見つかった場合、サーバーはこのドメインのユーザーのデフォルトWebインターフェースとして選択されたスキンを見つけます。 login.wsspページが開始します。



Wsspファイルは、いくつかの追加要素を含むマークアップコード（通常はHTML）で構成されます。

• 両側が二重文字％で区切られたテキスト（%%要素%%）
• この形式の構造-

そのような文書の例：

 <html> <body> <h1>   %%server%%.   %%ID%%.</h1> <!--%%IF EXISTS(lastLogin)-->     %%lastLogin%% <!--%%ENDIF--> </body> </html>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

サーバーによる処理後、すべての特別な構造は「環境」からの文字列または文字列の配列に置き換えられます-スキンの.dataファイルのキー値、サーバーのドメイン名または他のオブジェクト、設定値。



他のファイルはすべてクライアントに渡されます。



基本的なデモWebインターフェースは、WSSPページの機能の優れた例として見ることができます。 しかし、WSSPは、データ形式の変換やさまざまなモジュールへのアクセス、サーバー上でのアクションの実行に関してかなり制限されています。 そして、より強力なツールが助けになります。

Cg / pl

CG / PL言語とその上でのPBXアプリケーションの開発については、 この記事ですでにHabréについて話しました。



PBXに加えて、WebインターフェイスCommunigate Proの開発に積極的に使用されています。 基本的なWebスキン（ユーザー->インターフェイス）のファイルのリストを開くと、HTTPリクエストを処理する小さなCG / PLプログラムの14個のファイルがあります。



HTTP要求を処理するためにCG / PLプログラムを呼び出すには、テキストエディターでそれを記述し、.wcgpとして保存し、Webスキンにロードする必要があります。



その後、フォームのURLへのリクエスト：

 http://domain.name:[port]/programFile.wcgp/?Skin=skin_name
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

実行するプログラムを実行します。

 http://domain.name:[port]/auth/programFile.wcgp/?Skin=skin_name
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

事前認証でアカウントに代わって実行する

 http://domain.name:[port]/sys/programFile.wcgp
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

この要求は、サーバーの名前のないスキンでのみプログラムを検索し、ユーザーとしてpostmaster（サーバー管理者）を実行します



例として、「listaccounts」CLIコマンドを実行し、結果をJSON形式に変換する小さなスクリプトを考えます。

 entry sysEntry is void(executeCLI("listaccounts mymac.ru")); accountList = Vars().executeCLIResult; SetHTTPResponseCode(200); SetHTTPResponseData(ObjectToJSON(accountList)); end entry;
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

Ximss

音声、インスタントメッセージ（SMSを含む）、カレンダー、連絡先、メール、ファイルサーバーなど、このような大量のサーバー側機能を使用すると、サービスプロバイダーは統合クライアントの作成に特定の困難を経験します。 SIP、DAVプロトコルのセット、SMTP、IMAP、XMPPを実装するライブラリを選択または開発する必要があります。 この場合、これらのプロトコルからのメッセージとデータ形式を解析する負担はクライアントにあります。



これらの問題を解決するために、 XIMSSプロトコル（メッセージング、スケジューリング、およびシグナリングへのXMLインターフェイス）を開発しました 。



このプロトコルのすべてのコマンドは、透過的な属性を持つ単純なXMLドキュメントです。 たとえば、次の単純なコマンドは、着信コールを2人のユーザーにリダイレクト（分岐）します。

 C:<callRedirect id="A018" callLeg="inp003" > <To>user1@example.com</To><To>user2@example.com</To> </callRedirect> S:<response id="A018"/>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

すべてのデータ形式（MIME、vCard）は、使いやすい形式でXIMSSクライアントに送られます。



このプロトコルにより、サーバーで使用可能なすべてのCLIコマンドを実行することもできます。これにより、管理者を含むあらゆる種類の設定を調整できます。



多くのプラットフォームで、既製のXIMSSライブラリを開発しました。



XIMSSクライアントの機能の例として、Webバージョン（HTML5およびFlash）をブースbestvoip.ruで試すことができる一連のPronto！アプリケーションをお勧めします。

結論として

Communigate Proは、さまざまなレベルで動作を制御できるプラットフォームです。 クライアントからメイン通信モジュールへのアクセス、および標準プロトコルに基づいた独自の機能の開発。 同時に、ソリューションは安定しており、重い負荷に耐えることができます。



すべてのCommunigate APIの合計のしきい値はかなり大きいように見えるかもしれませんが、通信サービス管理者が直面するほとんどのタスクをカバーしています。