機械翻訳について

ジャンプ先

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

エンゲージメント・キューの取得

get

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

この操作は、エンゲージメント・キューおよびキュー統計を取得するために使用されます。
URLパラメータとして渡されるJSONオブジェクトは、次のように定義され、URLエンコードされている必要があります -
{
"interfaceId": 0,
"interfaceName":"string",
"productId": 0,
"categoryId": 0,
"organizationId": 0,
"customFields" : [{"name":"STRING", "type":"", "value":"STRING"}]
}
カスタム・フィールド・オブジェクトのすべてのフィールドはオプションですが、'value'を指定する場合、'type'は次のいずれかである必要があります...
ブール、日付、日時、整数、ロング、文字列、小数

リクエスト

パス・パラメータ

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

問合せパラメータ

• pool(optional): string
  初期セッション確立コールから返されたプール識別子。
• request: string
  URLでエンコードされたJSONリクエスト・オブジェクト。

トップに戻る

レスポンス

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

• application/json; charset=utf-8

200 レスポンス

リクエストは正常に完了しました。

本文( )

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

タイプ: object

ソースを表示

• availableAgentSessions(optional): integer(int32)
  すべてのエージェントで使用可能なセッションの合計数。
• chatRouteId(optional): integer(int32)
  チャット・エンゲージメント・ルーティング識別子。
• clientId(optional): integer(int64)
  クライアントの一意の識別子。
• clientIdString(optional): string
  文字列としてのクライアントの一意の識別子。
• clientRequestTime(optional): string
  yyyy-MM-dd'T'HH:mm:ssXXX形式のリクエスト・クライアントのローカル時間。
• clientTransactionId(optional): integer(int64)
  クライアント・トランザクションの一意の識別子。 このフィールドに指定された値は、レスポンス・オブジェクトでエコー・バックされます。 リクエストをレスポンスにリンクするために使用されます。
• clientTransactionIdString(optional): string
  クライアント・トランザクションの一意の識別子を文字列として指定します。
• engagementsInQueue(optional): integer(int32)
  現在キューに入っているエンゲージメントの数。
• escalationQueueId(optional): integer(int64)
  エスカレーション・キューの一意の識別子。
• escalationQueueIdString(optional): string
  エスカレーション・キューの一意の識別子を文字列として指定します。
• expectedWaitSeconds(optional): integer(int64)
  キュー内の予想待機時間。情報が不適切で、それ以外の場合は0以上である場合は -1。
• expectedWaitSecondsString(optional): string
  キュー値の予想待機時間を文字列として指定します。
• outsideOperatingHours(optional): boolean
  現在の時間が営業時間外かどうかを示します。 デフォルト値は次のとおりです: 偽
• pollingOverrideMultiplier(optional): integer(int32)
  ポーリング上書き乗数。
• queueId(optional): integer(int64)
  リクエストされたキューの一意の識別子。
• queueIdString(optional): string
  リクエストされたキューの一意の識別子を文字列として指定します。
• serviceFinishTime(optional): string
  リクエスト処理がyyyy-MM-dd'T'HH:mm:ssXXX形式で完了した日時。
• serviceStartTime(optional): string
  リクエスト処理がyyyy-MM-dd'T'HH:mm:ssXXX形式で開始された日時。
• totalAgentsRequestingNewEngagement(optional): integer(int32)
  新しいエンゲージメントのキャパシティを持つ、使用可能なエージェントの合計数。
• totalAvailableAgents(optional): integer(int32)
  ステータスが使用可能なエージェントの合計数。
• totalUnavailableAgents(optional): integer(int32)
  ステータスが使用できないエージェントの合計数。

{
    "properties":{
        "queueId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of the requested queue."
        },
        "queueIdString":{
            "type":"string",
            "description":"The unique identifier of the requested queue as a string."
        },
        "expectedWaitSeconds":{
            "type":"integer",
            "format":"int64",
            "description":"The expected wait time in queue. -1 if there's inadequate information, and is zero or greater otherwise."
        },
        "expectedWaitSecondsString":{
            "type":"string",
            "description":"The expected wait time in queue value as a string."
        },
        "availableAgentSessions":{
            "type":"integer",
            "format":"int32",
            "description":"The total number of sessions available across all agents."
        },
        "totalAvailableAgents":{
            "type":"integer",
            "format":"int32",
            "description":"The total number of agents whose status is available."
        },
        "totalUnavailableAgents":{
            "type":"integer",
            "format":"int32",
            "description":"The total number of agents whose status is unavailable."
        },
        "totalAgentsRequestingNewEngagement":{
            "type":"integer",
            "format":"int32",
            "description":"The total number of agents who are available and have capacity for a new engagement."
        },
        "outsideOperatingHours":{
            "type":"boolean",
            "description":" Indicates whether the current time is outside operating hours. The default value is: false"
        },
        "escalationQueueId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of the escalation queue."
        },
        "escalationQueueIdString":{
            "type":"string",
            "description":"The unique identifier of the escalation queue as a string."
        },
        "pollingOverrideMultiplier":{
            "type":"integer",
            "format":"int32",
            "description":"The polling override multiplier."
        },
        "engagementsInQueue":{
            "type":"integer",
            "format":"int32",
            "description":"The number of engagements currently in the queue."
        },
        "chatRouteId":{
            "type":"integer",
            "format":"int32",
            "description":"The chat engagement routing identifier."
        },
        "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 date and time when the request processing started in yyyy-MM-dd'T'HH:mm:ssXXX format."
        },
        "serviceFinishTime":{
            "type":"string",
            "description":"The date and time 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

404 レスポンス

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

本文( )

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

タイプ: object

500 レスポンス

リクエストの処理中にチャット・サーバーでエラーが発生しました。

本文( )

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

タイプ: object

「トップに戻る」