選取您的 Cookie 偏好設定

我們使用提供自身網站和服務所需的基本 Cookie 和類似工具。我們使用效能 Cookie 收集匿名統計資料,以便了解客戶如何使用我們的網站並進行改進。基本 Cookie 無法停用,但可以按一下「自訂」或「拒絕」以拒絕效能 Cookie。

如果您同意,AWS 與經核准的第三方也會使用 Cookie 提供實用的網站功能、記住您的偏好設定,並顯示相關內容,包括相關廣告。若要接受或拒絕所有非必要 Cookie,請按一下「接受」或「拒絕」。若要進行更詳細的選擇,請按一下「自訂」。

GetCurrentUserData - Amazon Connect
此頁面尚未翻譯為您的語言。 請求翻譯

GetCurrentUserData

Gets the real-time active user data from the specified Amazon Connect instance.

Request Syntax

POST /metrics/userdata/InstanceId HTTP/1.1 Content-type: application/json { "Filters": { "Agents": [ "string" ], "ContactFilter": { "ContactStates": [ "string" ] }, "Queues": [ "string" ], "RoutingProfiles": [ "string" ], "UserHierarchyGroups": [ "string" ] }, "MaxResults": number, "NextToken": "string" }

URI Request Parameters

The request uses the following URI parameters.

InstanceId

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

Request Body

The request accepts the following data in JSON format.

Filters

The filters to apply to returned user data. You can filter up to the following limits:

  • Queues: 100

  • Routing profiles: 100

  • Agents: 100

  • Contact states: 9

  • User hierarchy groups: 1

The user data is retrieved for only the specified values/resources in the filter. A maximum of one filter can be passed from queues, routing profiles, agents, and user hierarchy groups.

Currently tagging is only supported on the resources that are passed in the filter.

Type: UserDataFilters object

Required: Yes

MaxResults

The maximum number of results to return per page.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Type: String

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "ApproximateTotalCount": number, "NextToken": "string", "UserDataList": [ { "ActiveSlotsByChannel": { "string" : number }, "AvailableSlotsByChannel": { "string" : number }, "Contacts": [ { "AgentContactState": "string", "Channel": "string", "ConnectedToAgentTimestamp": number, "ContactId": "string", "InitiationMethod": "string", "Queue": { "Arn": "string", "Id": "string" }, "StateStartTimestamp": number } ], "HierarchyPath": { "LevelFive": { "Arn": "string", "Id": "string" }, "LevelFour": { "Arn": "string", "Id": "string" }, "LevelOne": { "Arn": "string", "Id": "string" }, "LevelThree": { "Arn": "string", "Id": "string" }, "LevelTwo": { "Arn": "string", "Id": "string" } }, "MaxSlotsByChannel": { "string" : number }, "NextStatus": "string", "RoutingProfile": { "Arn": "string", "Id": "string" }, "Status": { "StatusArn": "string", "StatusName": "string", "StatusStartTimestamp": number }, "User": { "Arn": "string", "Id": "string" } } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ApproximateTotalCount

The total count of the result, regardless of the current page size.

Type: Long

NextToken

If there are additional results, this is the token for the next set of results.

Type: String

UserDataList

A list of the user data that is returned.

Type: Array of UserData objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceException

Request processing failed because of an error or failure with the service.

HTTP Status Code: 500

InvalidParameterException

One or more of the specified parameters are not valid.

HTTP Status Code: 400

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

隱私權網站條款Cookie 偏好設定
© 2025, Amazon Web Services, Inc.或其附屬公司。保留所有權利。