マネージャー API

コンタクト センター AI プラットフォーム(CCAI プラットフォーム)には、プラットフォームとの統合をサポートする API エンドポイントが多数用意されています。マネージャー API は、システムの設定と構成、イベントとアクティビティに関連する機能を拡張します。

マネージャー API エンドポイントは、次のいずれかのグループに分類されます。

  • エージェント: 個々のエージェント リソース

  • エージェント アクティビティ: エージェント ウィジェットがユーザー ステータスを変更するか、通知を受信するたび

  • キャンペーン: アウトバウンド ダイヤラーに関連付けられたイベント

  • Calls: 単一の通話リソース

  • Chats: 単一のチャット リソース

  • Emails: 単一のメールリソース

  • メニュー: エージェントが割り当てられているキュー。エンドユーザーは、エージェントからサポートを受けるためにこのキューにアクセスします。

  • チーム: エージェントが所属するチーム

  • ユーザー ステータス: エージェント ウィジェットが取り得る個々のステータス

基本認証

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

  1. CCAI Platform ポータルに移動します。

  2. [Settings] > [Developer Settings] > [API Credentials] に移動します。

  3. 新しい API 認証情報を追加して、名前を指定します。

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

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

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

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

https://customer.uc1.ccaiplatform.com

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

ベース URL

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

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

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

レート上限

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