機械翻訳について

ジャンプ先

• リクエスト
• レスポンス
• 例

エンゲージメントの完了

post

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

この操作は、エンド・ユーザーがエージェントとのチャット・エンゲージメントを終了するために使用します。

リクエスト

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

• application/json; charset=utf-8

パス・パラメータ

• fqSiteName: string
  セッションを確立するためにコールによって返されるサイトの名前。

問合せパラメータ

• pool: string
  セッションの確立レスポンスで指定されている、またはRNEngagementConfigurationChangedMessageシステム・メッセージで指定されているプールID。

ヘッダー・パラメータ

• SessionId: string
  コンシューマ・セッションの一意の識別子。

本文( )

リクエスト情報を含むオブジェクト。

ルート・スキーマ : com.rightnow.chat.rest.consumer_api.model.requests.v1.ConcludeEngagementRequest

タイプ: object

ソースを表示

• clientRequestTime(optional): string
  yyyy-MM-dd'T'HH:mm:ssXXX形式のリクエスト・クライアントのローカル時間。
• clientTransactionId(optional): integer(int64)
  クライアント・トランザクションの一意の識別子。 このフィールドに指定された値は、レスポンス・オブジェクトでエコー・バックされます。 リクエストをレスポンスにリンクするために使用されます。

{
    "properties":{
        "clientRequestTime":{
            "type":"string",
            "description":"The local time of the requesting client in yyyy-MM-dd'T'HH:mm:ssXXX format."
        },
        "clientTransactionId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of the client transaction. The value specified in this field is echoed back in the response object. It is used to link requests to responses."
        }
    }
}

トップに戻る

レスポンス

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

• application/json; charset=utf-8

200 レスポンス

チャット・セッションは正常に終了しました。

本文( )

ルート・スキーマ : com.rightnow.chat.rest.consumer_api.model.responses.v1.ConcludeEngagementResponse

タイプ: object

ソースを表示

• clientId(optional): integer(int64)
  クライアントの一意の識別子。
• clientIdString(optional): string
  文字列としてのクライアントの一意の識別子。
• clientRequestTime(optional): string
  yyyy-MM-dd'T'HH:mm:ssXXX形式のリクエスト・クライアントのローカル時間。
• clientTransactionId(optional): integer(int64)
  クライアント・トランザクションの一意の識別子。 このフィールドに指定された値は、レスポンス・オブジェクトでエコー・バックされます。 リクエストをレスポンスにリンクするために使用されます。
• clientTransactionIdString(optional): string
  文字列としてのクライアント・トランザクションの一意の識別子。
• serviceFinishTime(optional): string
  リクエスト処理がyyyy-MM-dd'T'HH:mm:ssXXX形式で完了した時間。
• serviceStartTime(optional): string
  リクエスト処理がyyyy-MM-dd'T'HH:mm:ssXXX形式で開始した時間。

{
    "properties":{
        "clientRequestTime":{
            "type":"string",
            "description":"The local time of the requesting client in yyyy-MM-dd'T'HH:mm:ssXXX format."
        },
        "clientTransactionId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of the client transaction. The value specified in this field is echoed back in the response object. It is used to link requests to responses."
        },
        "clientTransactionIdString":{
            "type":"string",
            "description":"The unique identifier of the client transaction as a String."
        },
        "serviceStartTime":{
            "type":"string",
            "description":"The time when the request processing started in yyyy-MM-dd'T'HH:mm:ssXXX format."
        },
        "serviceFinishTime":{
            "type":"string",
            "description":"The time when the request processing completed in yyyy-MM-dd'T'HH:mm:ssXXX format."
        },
        "clientId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of the client."
        },
        "clientIdString":{
            "type":"string",
            "description":"The unique identifier of the client as a String."
        }
    }
}

400 レスポンス

リクエスト・オブジェクトの検証に失敗しました。

本文( )

ルート・スキーマ : スキーマ

タイプ: object

403 レスポンス

コンシューマ・セッション識別子が不明です。

本文( )

ルート・スキーマ : スキーマ

タイプ: object

404 レスポンス

リソースが見つかりませんでした。

本文( )

ルート・スキーマ : スキーマ

タイプ: 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/concludeEngagement?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}"

リクエスト本文の例

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

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

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

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

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

応答本文の例

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

{
    "clientRequestTime": "2019-01-14T14:35:14.226Z",
    "serviceStartTime": "2019-01-11T10:12:48.339Z",
    "serviceFinishTime": "2019-01-11T10:12:48.362Z",
    "clientId": 246,
    "clientIdString": "246",
    "clientTransactionId": 1,
    "clientTransactionIdString": "1"
}

「トップに戻る」