SearchContacts
Searches contacts in an Amazon Connect instance.
Request Syntax
POST /search-contacts HTTP/1.1
Content-type: application/json
{
"InstanceId": "string",
"MaxResults": number,
"NextToken": "string",
"SearchCriteria": {
"AgentHierarchyGroups": {
"L1Ids": [ "string" ],
"L2Ids": [ "string" ],
"L3Ids": [ "string" ],
"L4Ids": [ "string" ],
"L5Ids": [ "string" ]
},
"AgentIds": [ "string" ],
"Channels": [ "string" ],
"ContactAnalysis": {
"Transcript": {
"Criteria": [
{
"MatchType": "string",
"ParticipantRole": "string",
"SearchText": [ "string" ]
}
],
"MatchType": "string"
}
},
"InitiationMethods": [ "string" ],
"QueueIds": [ "string" ],
"SearchableContactAttributes": {
"Criteria": [
{
"Key": "string",
"Values": [ "string" ]
}
],
"MatchType": "string"
},
"SearchableSegmentAttributes": {
"Criteria": [
{
"Key": "string",
"Values": [ "string" ]
}
],
"MatchType": "string"
}
},
"Sort": {
"FieldName": "string",
"Order": "string"
},
"TimeRange": {
"EndTime": number,
"StartTime": number,
"Type": "string"
}
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- InstanceId
-
The identifier of Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
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
Length Constraints: Minimum length of 1. Maximum length of 100000.
Required: No
- SearchCriteria
-
The search criteria to be used to return contacts.
Type: SearchCriteria object
Required: No
- Sort
-
Specifies a field to sort by and a sort order.
Type: Sort object
Required: No
- TimeRange
-
Time range that you want to search results.
Type: SearchContactsTimeRange object
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Contacts": [
{
"AgentInfo": {
"ConnectedToAgentTimestamp": number,
"Id": "string"
},
"Arn": "string",
"Channel": "string",
"DisconnectTimestamp": number,
"Id": "string",
"InitialContactId": "string",
"InitiationMethod": "string",
"InitiationTimestamp": number,
"PreviousContactId": "string",
"QueueInfo": {
"EnqueueTimestamp": number,
"Id": "string"
},
"ScheduledTimestamp": number,
"SegmentAttributes": {
"string" : {
"ValueString": "string"
}
}
}
],
"NextToken": "string",
"TotalCount": number
}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.
- Contacts
-
Information about the contacts.
Type: Array of ContactSearchSummary objects
- NextToken
-
If there are additional results, this is the token for the next set of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100000.
- TotalCount
-
The total number of contacts which matched your search query.
Type: Long
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:
