アクティビティ・ステータスの変更
post
/engagement/api/consumer/{fqSiteName}/v1/activity
この操作では、エンド・ユーザーの現在のアクティビティ(RESPONDINGやLISTENINGなど)を示すアクティビティ変更メッセージが送信されます。
リクエスト
サポートされるメディア・タイプ
- application/json; charset=utf-8
パス・パラメータ
- fqSiteName: string
セッションを確立するためにコールによって返されるサイトの名前。
問合せパラメータ
- pool: string
セッションの確立レスポンスで指定されている、またはRNEngagementConfigurationChangedMessageシステム・メッセージで指定されているプールID。
ヘッダー・パラメータ
- SessionId: string
コンシューマ・セッションの一意の識別子。
リクエスト情報を含むオブジェクト。
ルート・スキーマ : com.rightnow.chat.rest.consumer_api.model.requests.v1.PostActivityChangeRequest
タイプ:
ソースを表示
object- clientRequestTime(optional): string
yyyy-MM-dd'T'HH:mm:ssXXX形式のリクエスト・クライアントのローカル時間。
- clientTransactionId(optional): integer(int64)
クライアント・トランザクションの一意の識別子。 このフィールドに指定された値は、レスポンス・オブジェクトでエコー・バックされます。 リクエストをレスポンスにリンクするために使用されます。
- mode: string
許可された値:
[ "LISTENING", "RESPONDING" ]ユーザーの現在のアクティビティ。 値が'LISTENING'の場合、エンド・ユーザーがリスニングしていることを示します(入力しません)。 値がRESPONDINGの場合、エンド・ユーザーがレスポンスを入力していることを示します。 - sneakPreviewFocus(optional): boolean
エンド・ユーザー・チャットがエージェントのフォーカスにあるかどうかを示します。 trueの場合、エンド・ユーザー・チャットがフォーカスされます。 falseの場合、エンド・ユーザー・チャットはフォーカスされません。 デフォルト値はfalseです。
- sneakPreviewText(optional): string
スニーク・プレビューに表示されるテキスト。
レスポンス
サポートされるメディア・タイプ
- application/json; charset=utf-8
200 レスポンス
リクエストは正常に完了しました。
ルート・スキーマ : com.rightnow.chat.rest.consumer_api.model.responses.v1.PostActivityChangeResponse
タイプ:
ソースを表示
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
文字列としてのクライアント・トランザクションの一意の識別子。
- engagementId(optional): integer(int64)
チャット・エンゲージメントの一意の識別子。
- engagementIdString(optional): string
文字列としてのチャット・エンゲージメントの一意の識別子。
- mode: string
許可された値:
[ "LISTENING", "RESPONDING" ]ユーザーの現在のアクティビティ。 値が'LISTENING'の場合、エンド・ユーザーがリスニングしていることを示します(入力しません)。 値がRESPONDINGの場合、エンド・ユーザーがレスポンスを入力していることを示します。 - serviceFinishTime(optional): string
リクエスト処理がyyyy-MM-dd'T'HH:mm:ssXXX形式で完了した時間。
- serviceStartTime(optional): string
リクエスト処理がyyyy-MM-dd'T'HH:mm:ssXXX形式で開始した時間。
- sneakPreviewInterval(optional): integer(int32)
スニーク・プレビュー・メッセージを送信する間、エンド・ユーザーが待機する必要があるミリ秒数。
- sneakPreviewState(optional): string
許可された値:
[ "NONE", "ENABLED", "DISABLED", "SITE_UNAVAILABLE", "SERVICE_UNAVAILABLE" ]エンド・ユーザーのパースペクティブから見たスニーク・プレビュー機能の現在の状態。
- NONE: スニーク・プレビューの状態が設定されていない(または未定義)
- 有効: スニーク・プレビューはエンド・ユーザー・インタフェースで有効です
- 無効: スニーク・プレビューはエンド・ユーザー・インタフェースでは無効です
- SITE_UNAVAILABLE: スニーク・プレビューはエンド・ユーザー・インタフェースで有効になっていますが、サイトでは無効になっています
- SERVICE_UNAVAILABLE: スニーク・プレビューはエンド・ユーザー・インタフェースで有効化されていますが、グローバルに無効化されています
- sneakPreviewText(optional): string
スニーク・プレビューに表示されるテキスト。
400 レスポンス
リクエスト・オブジェクトの検証に失敗しました。
ルート・スキーマ : スキーマ
タイプ:
object403 レスポンス
コンシューマ・セッション識別子が不明です。
ルート・スキーマ : スキーマ
タイプ:
object404 レスポンス
リソースが見つかりませんでした。
ルート・スキーマ : スキーマ
タイプ:
object500 レスポンス
リクエストの処理中にチャット・サーバーでエラーが発生しました。
ルート・スキーマ : スキーマ
タイプ:
object例
次の例は、cURLを使用してPOSTリクエストを発行してアクティビティ変更メッセージを送信する方法を示しています:
cURLコマンドの例
curl -X POST https://chat_rest_server_domain.com/engagement/api/consumer/day119_181100_sql_238h/v1/activity?pool=297:1 -H 'Content-Type: application/json; charset=UTF-8' -H 'SessionId: 192hyto5qomm8r8rpzzmuzsa6' -d '{"mode":"LISTENING"}'
リクエスト本文の例
次に、JSON形式のリクエスト本文の例を示します。
{
"mode":"LISTENING"
}
レスポンス・ヘッダーの例
次に、レスポンス・ヘッダーの例を示します。
Status: 200 OK Content-Type: application/json;charset=utf-8
応答本文の例
次に、JSON形式のレスポンス本文の例を示します。
{
"engagementId": 34,
"engagementIdString": "34",
"mode": "LISTENING",
"sneakPreviewState": "DISABLED",
"sneakPreviewInterval": 3000,
"sneakPreviewText": null,
"clientRequestTime": null,
"clientTransactionId": null,
"clientTransactionIdString": null,
"serviceStartTime": "2018-10-23T13:46:57.709Z",
"serviceFinishTime": "2018-10-23T13:46:57.726Z",
"clientId": 34,
"clientIdString": "34"
}