Apps API

コンタクト センター AI プラットフォーム(CCAI プラットフォーム)には、プラットフォームとの統合をサポートする API エンドポイントが用意されています。Apps API は、通話、チャット、SMS など、プラットフォームがサポートするチャネルの機能を拡張します。エンドポイントは次のカテゴリに分類されます。

基本認証

リクエストでは基本認証を使用します。API 認証情報を作成する手順は次のとおりです。

  1. CCAI プラットフォーム ポータルに移動します。

  2. [設定] > [デベロッパー設定] > [API 認証情報] に移動します。

  3. 新しい API 認証情報を追加して名前を入力します。

API 呼び出しの認証情報は次のとおりです。

  • サブドメインは {username} 変数として使用されます。

  • トークンは {​password} 変数として使用されます。

インストールごとに独自のサブドメインがあります。サブドメインを確認するには、ブラウザで URL を見つけます。次のようになります。

https://customer.uc1.ccaiplatform.com

サブドメイン(この例では customer)を {subdomain} 変数に置き換えます。URL の残りの部分(この例では rest.of.url.com)を {domain} 変数に置き換えます。

ベース URL

API は、すべての API リクエストに次のベース URL を使用します。

https://{subdomain}.{domain​}/apps/api/v1

/calls への言及は https://{subdomain​}.​{domain​}/apps/api/v1/calls を意味します。

レートに関する上限

システムは、リクエストを 1 秒あたり 10 リクエストに制限します。

API レスポンスで認識されない JSON キーが返される可能性がある

すべての API アップデートには下位互換性があります。既存の API レスポンスに新しい JSON キーをいつでも導入する権利を有します。継続的な機能を維持するため、認識されないキーは無視してレスポンスを防御的に処理することをおすすめします。