機械翻訳について
  1. Engagement Cloud Oracle FusionサービスでのチャットのチャットREST APIREST API
  2. さらに学ぶ
  3. RESTクライアントの操作

RESTクライアントの操作

REST APIはHTTPメソッドを使用してコンテンツを送受信するため、HTTPメッセージの送受信をサポートする任意のプログラミング言語またはツールを使用して操作できます。 まず、HTTPリクエストを作成するためのツールを選択します。

RESTクライアントの選択に関する考慮事項

Fusion Applicationsと対話する多数のクライアントから、次のようなクライアントを選択できます:

  • PostmanやAdvanced REST Clientなどのサードパーティのスタンドアロン・クライアント。
  • 独自のカスタム・スタンドアロン・クライアント。 カスタム・スタンドアロン・クライアントを実装するには、サンプル実装OracleMobileChatを参照してください。
  • 接続アプリケーションのクライアント。
  • cURLコマンドライン・ユーティリティ。

クライアントを使用して、次のタスクを実行できます:

  • REST APIアカウントのユーザー名、パスワードおよびリクエストURLをテストします。
  • 様々なタイプのHTTPリクエストを構成および送信します。

cURLを使用してHTTPリクエストを送信する方法

この例では、URL構文を使用してデータを転送する一般的なコマンドライン・ユーティリティであるcURLを使用して、RESTサービスにリクエストを送信します。ほとんどのUNIX、WindowsおよびMacintosh環境では、cURLを使用できます。 詳細は、「WindowsへのcURLコマンドライン・ツールのインストール」を参照してください。

次の表に、RESTサービスに使用できる、一般的に使用されるcURLオプションを示します。

オプション 説明

-u

username:password

サーバー認証のユーザー名とパスワードを指定します。

-d

指定したデータ(JSONリクエスト本文)をサーバーに送信します。 データをアットマーク(@)で開始する場合は、データの読取り元のファイル名が後に続く必要があります。 例: -d@example_request_payload.json

-H

リクエストに追加のHTTPヘッダーを指定します。 複数のヘッダーを指定するには、各ヘッダーの前に-Hオプションを付けます。

次に例を示します。
  • 承認: 認証トークン
  • Content-Type: リクエスト本文の形式(POSTなど)
  • 受入: レスポンス本文の形式

-o

<file>

出力を標準出力ではなくファイルに書き込みます。

-X

HTTPサーバーとの通信時に使用するリクエスト・メソッドを指定します。 デフォルトのメソッドはGETです。

次の表に、cURLを使用したREST API操作の例をFusion Applicationsに示します。

操作 cURLコマンドの例

POSTを使用して、チャット・メッセージをエージェントに投稿 

curl -X POST "https://chat_rest_server_domain.com/engagement/api/consumer/sdi_11_20_18_2022_21-3586727808788512-Fusion/v1/postMessage?pool=353:2" -H "Accept: application/json;charset=utf-8" -H "Content-Type: application/json" -H "SessionId: 170c233dfi4gy1vkwyw6yxdq1a" -d "{\"clientRequestTime\" : \"2019-01-14T14:35:14.226Z\",\"clientTransactionId\" : 1,\"body\" : \"This is a test message.\",\"offTheRecord\" : false}"

POSTを使用して、エンゲージメント・キューの統計を取得 

curl -X POST "https://chat_rest_server_domain.com/engagement/api/consumer/sdi_11_20_18_2022_21-3586727808788512-Fusion/v1/getQueueStats?pool=353:2" -H "Accept: application/json;charset=utf-8" -H "Content-Type: application/json" -d "{\"queueId\" : 1,\"chatProactiveAvailableType\" : \"AGENTS\"}"

クライアントを使用したHTTPリクエストの送信方法

スタンドアロン・クライアント、サードパーティのブラウザ拡張機能、または拡張RESTクライアントなどのアドオンを使用して、HTTPリクエストを送信できます。

次の表に、クライアントを使用したREST API操作の例をFusion Applicationsに示します。

操作 レスポンス/ペイロードの例

POST: メッセージを投稿します。

次のリクエストURIおよびリクエスト本文でPOSTを使用して、チャット・メッセージをエージェントに送信します:

リクエストURL: 

https://chat_rest_server_domain.com/engagement/api/consumer/sdi_11_20_18_2022_21-3586727808788512-Fusion/v1/postMessage?pool=353:2

リクエスト・ヘッダー:

  • Accept: application/json;charset=utf-8
  • Content-Type: application/json; charset=UTF-8
  • SessionId: 170c233dfi4gy1vkwyw6yxdq1a

リクエスト本文:

{
   "clientRequestTime" : "2019-01-14T14:35:14.226Z",
   "clientTransactionId" : 1,
   "body" : "This is a test message.",
   "offTheRecord" : false
}
 
{
    "clientRequestTime": "2019-01-14T14:35:14.226Z",
    "serviceStartTime": "2019-01-11T10:12:41.806Z",
    "serviceFinishTime": "2019-01-11T10:12:41.819Z",
    "clientId": 246,
    "clientIdString": "246",
    "clientTransactionId": 1,
    "clientTransactionIdString": "1"
}

POST: キュー統計を取得します。

次のリクエストURIおよびリクエスト本文でPOSTを使用して、エンゲージメント・キュー統計を取得します:

リクエストURL:

https://chat_rest_server_domain.com/engagement/api/consumer/sdi_11_20_18_2022_21-3586727808788512-Fusion/v1/getQueueStats?pool=353:2

リクエスト・ヘッダー:

  • Accept: application/json;charset=utf-8
  • Content-Type: application/json; charset=UTF-8

リクエスト本文:

{
   "queueId" : 1,
   "chatProactiveAvailableType" : "AGENTS"
}
 
{
    "clientRequestTime": null,
    "serviceStartTime": "2019-01-29T10:22:31.139Z",
    "serviceFinishTime": "2019-01-29T10:22:31.140Z",
    "clientTransactionId": 0,
    "clientTransactionIdString": "0",
    "queueId": 1,
    "queueIdString": "1",
    "expectedWaitSeconds": 0,
    "expectedWaitSecondsString": "0",
    "availableAgentSessions": 5
}