機械翻訳について
  1. Oracle FusionサービスでのチャットのREST API
  2. タスク
  3. 消費者インタラクション

エンゲージメントの作成

post

/engagement/api/consumer/{fqSiteName}/v1/requestEngagement

この操作は、エンド・ユーザーがチャット・エンゲージメントを作成するために使用します。 セッションが開始され、チャット・サーバーによってエンゲージメントIDが生成されると、チャット・エンゲージメントが作成され、エンド・ユーザーがチャット・セッションを実行する準備が整います。 認可ヘッダーには、JSON webトークン(JWT)の前にBearerプレフィクスを含める必要があります。

リクエスト

サポートされるメディア・タイプ
パス・パラメータ
  • セッションを確立するためにコールによって返されるサイトの名前。
問合せパラメータ
  • セッションの確立レスポンスで指定されている、またはRNEngagementConfigurationChangedMessageシステム・メッセージで指定されているプールID。
ヘッダー・パラメータ
  • リクエストを認証するためのJWTを含むHTTPリクエスト・ヘッダー。
本文( )
リクエスト情報を含むオブジェクト。
ルート・スキーマ : com.rightnow.chat.rest.consumer_api.model.requests.v1.RequestEngagementRequest
タイプ: object
ソースを表示
  • yyyy-MM-dd'T'HH:mm:ssXXX形式のリクエスト・クライアントのローカル時間。
  • クライアント・トランザクションの一意の識別子。 このフィールドに指定された値は、レスポンス・オブジェクトでエコー・バックされます。 リクエストをレスポンスにリンクするために使用されます。
トップに戻る

レスポンス

サポートされるメディア・タイプ

200 レスポンス

チャット・セッションは正常に作成されました。
本文( )
ルート・スキーマ : com.rightnow.chat.rest.consumer_api.model.responses.v1.RequestEngagementResponse
タイプ: object
ソースを表示
  • チャットがコンシューマによって破棄または取り消されたときに表示されるサーベイの一意の認証パラメータ。 チャットが破棄または取り消されたときにサーベイを表示するには、cancelledSurveyAuthパラメータとcancelledSurveyIdパラメータの両方が必要です。
  • チャットがコンシューマによって破棄または取り消されたときに表示されるサーベイの一意の識別子。 チャットが破棄または取り消されたときにサーベイを表示するには、cancelledSurveyAuthパラメータとcancelledSurveyIdパラメータの両方が必要です。
  • 取り消されたサーベイの一意の識別子(文字列)。
  • クライアントの一意の識別子。
  • 文字列としてのクライアントの一意の識別子。
  • yyyy-MM-dd'T'HH:mm:ssXXX形式のリクエスト・クライアントのローカル時間。
  • クライアント・トランザクションの一意の識別子。 このフィールドに指定された値は、レスポンス・オブジェクトでエコー・バックされます。 リクエストをレスポンスにリンクするために使用されます。
  • 文字列としてのクライアント・トランザクションの一意の識別子。
  • コンシューマまたはエージェントによってチャットが完了したときに表示されるサーベイの一意の認証パラメータ。 チャット完了時にサーベイを表示するには、completedSurveyAuthパラメータとcompletedSurveyIdパラメータの両方が必要です。
  • コンシューマまたはエージェントによってチャットが完了したときに表示されるサーベイの一意の識別子。 チャット完了時にサーベイを表示するには、completedSurveyAuthパラメータとcompletedSurveyIdパラメータの両方が必要です。
  • 完了したサーベイの一意の識別子(文字列)。
  • チャット・エンゲージメントの一意の識別子。
  • 文字列としてのチャット・エンゲージメントの一意の識別子。
  • 結果のタイプ。 たとえば、SUCCESSです。
  • リクエスト処理がyyyy-MM-dd'T'HH:mm:ssXXX形式で完了した時間。
  • リクエスト処理がyyyy-MM-dd'T'HH:mm:ssXXX形式で開始した時間。
  • セッションの一意の識別子。
  • スニーク・プレビュー・メッセージを送信する間、エンド・ユーザーが待機する必要があるミリ秒数。
  • 許可された値: [ "NONE", "ENABLED", "DISABLED", "SITE_UNAVAILABLE", "SERVICE_UNAVAILABLE" ]

    エンド・ユーザーのパースペクティブから見たスニーク・プレビュー機能の現在の状態。

    • NONE: スニーク・プレビューの状態が設定されていない(または未定義)
    • 有効: スニーク・プレビューはエンド・ユーザー・インタフェースで有効です。
    • 無効: スニーク・プレビューはエンド・ユーザー・インタフェースでは無効です。
    • SITE_UNAVAILABLE: スニーク・プレビューはエンド・ユーザー・インタフェースで有効になっていますが、サイトでは無効になっています。
    • SERVICE_UNAVAILABLE: スニーク・プレビューはエンド・ユーザー・インタフェースで有効になっていますが、グローバルには無効になっています。

400 レスポンス

リクエスト・オブジェクトの検証に失敗しました。
本文( )
ルート・スキーマ : スキーマ
タイプ: object

403 レスポンス

JWTの検証に失敗しました。
本文( )
ルート・スキーマ : スキーマ
タイプ: object

404 レスポンス

リソースが見つかりませんでした。
本文( )
ルート・スキーマ : スキーマ
タイプ: object

408 レスポンス

リクエストがタイムアウトしました。
本文( )
ルート・スキーマ : スキーマ
タイプ: object

409 レスポンス

エンゲージメントはルーティング・ルールを介してデキューされました。
本文( )
ルート・スキーマ : スキーマ
タイプ: object

500 レスポンス

リクエストの処理中にチャット・サーバーでエラーが発生しました。
本文( )
ルート・スキーマ : スキーマ
タイプ: object
トップに戻る

例

次の例は、cURLを使用してPOSTリクエストを発行してチャット・エンゲージメントを作成する方法を示しています。

cURLコマンドの例

curl -X POST "https://chat_rest_server_domain.com/engagement/api/consumer/sdi_11_20_18_2022_21-3586727808788512-Fusion/v1/requestEngagement?pool=353:2" -H "Accept: application/json;charset=utf-8" -H "Authorization: Bearer eyJhbGciOiJSUz...tr0Cw5qyvZMd64fyCA" -H "Content-Type: application/json;charset=utf-8" -d "{\"clientRequestTime\" : \"2019-01-14T14:35:14.226Z\",\"clientTransactionId\" : 1}"

リクエスト本文の例

次に、JSON形式のリクエスト本文の例を示します。

{
   "clientRequestTime" : "2019-01-14T14:35:14.226Z",
   "clientTransactionId" : 1
}

レスポンス・ヘッダーの例

次に、レスポンス・ヘッダーの例を示します。

Status: 200 OK
Content-Type: application/json;charset=utf-8

応答本文の例

次に、JSON形式のレスポンス本文の例を示します。

{
    "engagementId": 226,
    "engagementIdString": "226",
    "cancelledSurveyId": 0,
    "cancelledSurveyIdString": "0",
    "completedSurveyId": 0,
    "completedSurveyIdString": "0",
    "cancelledSurveyAuth": "",
    "completedSurveyAuth": "",
    "resultType": "SUCCESS",
    "sessionId": "170c233dfi4gy1vkwyw6yxdq1a",
    "sneakPreviewState": "DISABLED",
    "sneakPreviewInterval": 3000,
    "clientRequestTime": "2019-01-14T14:35:14.226Z",
    "clientTransactionId": 1,
    "clientTransactionIdString": "1",
    "serviceStartTime": "2019-01-11T10:12:13.175Z",
    "serviceFinishTime": "2019-01-11T10:12:13.298Z",
    "clientId": 246,
    "clientIdString": "246"
}
「トップに戻る」