サードパーティのアプリケーションと自動ダイヤル機能の自動化をICTBroadcastを統合するために、RESTベースのAPIを使用して

以下は、APIの我々は完全な自動化とシームレスな機能を達成するためのサードパーティ製アプリケーションとの統合を提供するのリストです。

REST API

このREST APIはICTBroadcastのいくつかの重要な機能を呼び出すための外部インタフェースを提供します。 ICTBroadcastは、アプリケーションスコープの外部からアクセスするために必要なすべての機能を定義するREST APIの3つのクラスのAPI_User、API_contactとAPI_Campaignを定義しています。次は、コードの例ですと、これらの関数を呼び出す方法について説明します。

User_Create

この関数は、ICTBroadcastで新しいユーザーを作成します。コードに従うことで、この関数を呼び出す方法を説明します

パラメータ

$user: ユーザー·データを含むシリアライズ配列

値を返す

返し配列が成功した場合は、ユーザーデータを含む。そうでなければ偽の値を含む配列を返します。

User_Update

この機能は、ユーザデータを更新する。

パラメータ

$user_id: データ利用者のIDが更新される

$user:ユーザのデータ

値を返す

成功した場合は、ユーザーデータを含むJSONエンコードされた文字列を返します。そうでなければ偽の値を含む配列を返します。

User_Get

この機能は、id引数として提供され、ユーザのデータを返します。

パラメータ

$user_id: ユーザーのID

$search: 検索

$value: 値

値を返す

成功した場合は、ユーザーデータを含むJSONエンコードされた文字列を返します。そうでなければ偽の値を含む配列を返します。

User_Delete

この関数は、削除は、そのIDのユーザーが提供されている。

パラメータ

$user_id: ユーザーのID

値を返す

成功したが、そうでない場合はfalseを返し削除した場合にtrueを返します。

User_Extension_Create

この関数は、指定したユーザの内線番号を作成します。

パラメータ

$user_id: ユーザーのID

$extension: 新しい拡張機能のための配列データを含む

値を返す

成功した場合、拡張データを含むJSONエンコードされた文字列を返します。そうでなければ偽の値を含む配列を返します。

User_Role_List

この関数は、すべての使用可能なロールを返します。

パラメータ

なし

値を返す

成功した場合は、ユーザーのロールを含むJSONエンコードされた文字列を返します。

User_Payment_Create

この関数は、ユーザーアカウントにクレジットが追加されます

パラメータ

$user_id: ユーザーのID

$value: 追加するには、支払われた金額

$description: 簡単な説明

$type: 支払いの種類

値を返す

クレジットを追加した場合はtrueを返し成功は、それ以外の場合はfalseを返します。

User_Login

この関数では、ユーザーにログインします。

パラメータ

$session_id: セッションID

値を返す

成功すれば返しセッション名は、そうでない場合はfalseを返します。

User_Logout

この関数は、彼をログアウトするために、ユーザセッションを破棄します。

パラメータ

$session_id: セッションID

値を返す

成功すれば返しセッション名は、そうでない場合はfalseを返します。

Campaign_Status

この関数は、IDが与えられているキャンペーンのステータスを提供します。

パラメータ

$campaign_id: 状態キャンペーンのIDが必要です

値を返す

成功した場合、キャンペーンのステータスデータを含むJSONエンコードされた文字列を返します。

Campaign_Start

この関数は、IDが与えられているキャンペーンを開始します。

パラメータ

$campaign_id: キャンペーンのID

値を返す

成功した場合、キャンペーンのステータスデータを含むJSONエンコードされた文字列を返します。

Campaign_Stop

この関数は、IDが与えられているキャンペーンを停止します。

パラメータ

$campaign_id: キャンペーンのID

値を返す

成功した場合、キャンペーンのステータスデータを含むJSONエンコードされた文字列を返します。

Campaign_Contact_Create

この関数は、IDが与えられているキャンペーンによってダイヤルされる与えられた連絡先を追加。

パラメータ

$contact_id: アレイが作成される連絡先データを含む。

$campaign_id: キャンペーンのID

値を返す

成功した場合、キャンペーンのデータを含むJSONエンコードされた文字列を返します。

Campaign_Summary

この関数は、キャンペーンの概要を返します。これは、キャンペーンの各連絡先の(忙しい、混雑、無応答が、失敗した)の状態を一覧表示されます。

パラメータ

$campaign_id: 状態キャンペーンのIDが必要です

$usr_id: ユーザーのIDは、このキャンペーンを所有

値を返す

成功した場合、キャンペーンのデータを含むJSONエンコードされた文字列を返します。

Campaign_Result

この関数は、キャンペーン、そのステータスを更新します。

パラメータ

$campaign_id: 状態キャンペーンのIDが必要です

$status: キャンペーンのステータス

$usr_id: ユーザーのIDは、このキャンペーンを所有

値を返す

成功した場合、キャンペーンのデータを含むJSONエンコードされた文字列を返します。

Contact_Create

この関数は、指定されたグループの新しい連絡先を作成します。

パラメータ

$contact: 連絡先データを含む配列.

$contact_group_id: 連絡先グループのID。

値を返す

返しJSONは成功した場合は連絡先の文字列を含んだ状態をエンコード。

Contact_Delete

この関数は、IDが与えられている連絡先を削除します。

パラメータ

$contact_id:削除する連絡先のID。

値を返す

返しJSONは成功した場合は連絡先の文字列を含んだ状態をエンコード。