APIフレームワークアクション

API Frameworkアクションは、スクリプトでCXoneAPIを使用できるようにするStudioアクションです。スニペットやRestAPIアクションの使用などの従来の統合方法でAPIを呼び出す代わりに、アクションを使用できます。APIアクションはすべて、Studioの[フレームワーク]タブにあります。

APIアクションは標準のStudioアクションとは異なります。現在のところオンラインヘルプには記載されていません。ただし、APIアクションに対応するAPIは、CXone開発者ポータル中央から右上に矢印が向いている正方形。に文書化されています。スクリプトでAPIアクションを使用する際はこのドキュメントを参照できます。

すべてのCXone APIがStudioに対応するAPIアクションを持っているわけではありません。

APIアクションにはセキュリティユーザーが必要です。SETSECURITYUSERアクションを使って、スクリプトにセキュリティユーザーを設定できます。

APIアクションバージョン

CXone APIの新しいバージョンがリリースされる際、対応するアクションの新バージョンもStudioでリリースされることがあります。一般的に、アクションの最新バージョンを使用することをお勧めします。古いバージョンでもほとんどの場合は動作します。さまざまなバージョンを試して、どれが機能し、必要な機能を提供するかを確認することもできます。

一部のAPIアクションでは、アクション名にバージョンが含まれています。[フレームワーク]タブのアクションのツリー構造を見るとわかります。すべてのAPIアクションにバージョン番号が含まれているわけではありません。これらのアクションについては、アクションの拡張プロパティでバージョンを確認できます。[プロパティ]タブで拡張プロパティを確認できるのは、[フレームワーク]タブでアクションが選択されている場合だけです。

すべてのAPIのすべてのバージョンがStudioに対応するアクションを持っているわけではありません。

APIアクションの拡張プロパティを表示する

アクションは[フレームワーク]タブで選択され、その拡張プロパティが[プロパティ]タブに表示されます。

  1. Studioで、タブを並べ替えて[プロパティ]タブと[フレームワーク]タブが両方表示されるようにします。
  2. [フレームワーク］タブで、[API]をクリックします。
  3. プロパティタブにアクションの拡張プロパティが表示されます。特に、APIアクションについて学習する際は、以下のプロパティが役立ちます。
    • その他>パラメータ>動詞：このプロパティはアクションに関連するメソッドまたは動詞を表示します。
    • その他>パラメータ>バージョン：このプロパティはAPIのバージョンを表示します。
    • その他>ウェブ>URI：このプロパティは、開発者ポータルでAPIのドキュメントを検索する際に役立ちます。

    • その他>パラメータ：セクションでは、プロパティを展開して各アクションのプロパティに関する追加情報を確認できます。

APIドキュメンテーションを検索

CXoneAPIはCXoneデベロッパー・ポータルに文書化されています。StudioのAPIアクションには、APIに対応するドキュメントへの直接リンクがありません。しかし、アクションの拡張プロパティにある情報を使用して、文書を探すことができます。

URIを使用するには、CXoneシステム全体と、さまざまなCXone APIについての一般的な知識が必要です。これは、StudioのアクションにどのAPIが一致するかを判断するのは容易でないためです。コンタクトがCXoneを通過する一般的なフローを理解しておくと、アクションのURIを正しく解釈し、そこで見つかった手がかりをデベロッパーポータルのAPIドキュメントの構造に適用するのに役立ちます。このセクションの例は、必要となる可能性のある解釈を示しています。

デベロッパー・ポータルのAPIセクションのホームページには、各CXone APIの概要が紹介されています。

例1

行動とそのAPIには、時として直接的な相関関係があります。

アクションの名前とURIに基づいて、考慮すべき最初の2つのAPIは、エージェントAPIと管理者APIです。それぞれのAPI呼び出しのリストを確認すると、エージェントAPIを排除できます。その説明によると、エージェントセッションを管理するために使用され、以下の画像に示すように、スキルに関連するコールはないようです。

デベロッパー・ポータルのエージェントAPI用のAPI呼び出しのリスト。

管理者APIは、スキルなどのシステムオブジェクトと連携することを示しています。このAPIで利用可能なAPI呼び出しのリストには、以下の画像に示すように、スキルが含まれます。

デベロッパー・ポータルのドキュメントにある管理者APIで利用可能なコールのリスト。

スキルのセクションを展開すると、エンドポイントの1つがGET /skills/agentsです。このエンドポイントの短い説明に、「スキルの割り当てを返す」とあります。

スキル別エージェント割り当てアクションの一致APIです。

例2

次の例のように、相関関係が明白でないこともあります。このような場合、CXoneAPIとプラットフォーム自体に関する知識を応用して、対応するAPIエンドポイントを見つける必要があります。—

このアクションの名前とURIから、どのAPIを最初に確認すべきかはすぐにはわかりません。何から始めるべきかがわからない場合、各APIのドキュメントに目を通して、コンタクトに関連するセクションを調べることをお勧めします。トップレベルのコンタクトセクションがあるのは管理者APIだけです。残念ながら、このAPIにはアクティブなコンタクトに関するエンドポイントが含まれていません。

デベロッパー・ポータルのドキュメントにあるデジタルエンゲージメントAPIで利用可能なコールのリスト。

管理者APIのコンタクトセクションで利用可能なエンドポイントのリスト。

この時点で、アクション名とURIにあるactiveという単語に注目します。CXoneの知識から、activeは現在処理中のコンタクトを示すことがわかっています。そこで、リアルタイムデータAPIをより詳しく見ることにします。このAPIにはセクションが1つしかなく、それを展開すると、エンドポイントの1つがGET /contacts/activeとなっています。このエンドポイントの短い説明に、「アクティブコンタクトを返す」とあります。

リアルタイムデータAPIのリアルタイムセクションで利用可能なエンドポイントのリスト。