commubo connect API は、自然会話AIプラットフォーム「commubo」の機能を、お客様アプリケーションから簡単に制御できるように設計された Web APIです。
REST形式のAPIにより、簡単なプログラミングですぐに試して実行することができます。 また、各APIの説明の中では、Linuxなどで動作する curl コマンドの例を記載していますので、プログラミングの前にコマンドラインから 各APIの動作を確認することもできます。

commubo connect APIは、「API」と「コールバック」の2つに大きく分類されます。

お客様アプリケーションから commubo に対して、情報を取得したり操作することを目的に HTTPリクエスト を送り、その結果を得る機能です。 お客様アプリケーションは API を利用することで、お客様アプリケーションが必要とするタイミングで、必要な情報や操作を要求できます。

commubo でのすべての API 呼び出しは、認証 ページにて記載の、ご契約事業者さまの認証情報が必要です。

commubo から お客様アプリケーションに対して、発信や着信などの commubo にて発生したイベントをリアルタイムに通知することを目的に、HTTPリクエストを送る機能です。
コールバックを利用するためには、お客様アプリケーションにて REST APIサーバー機能を用意いただく必要があります。 お客様アプリケーションの REST API サーバーのエンドポイントを 「commubo connect ご契約ユーザーさま ダッシュボード・ページ」に登録いただくことで、 commubo は各イベントのタイミングでお客様アプリケーションのAPIを呼び出します。

commubo connect では、すべての情報は JSON 形式のデータフォーマットで記述します。