Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListContactReferences

This API is in preview release for Amazon Connect and is subject to change.

For the specified referenceTypes, returns a list of references associated with the contact. References are links to documents that are related to a contact, such as emails, attachments, or URLs.

Request Syntax


GET /contact/references/InstanceId/ContactId?nextToken=NextToken&referenceTypes=ReferenceTypes HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ContactId

The identifier of the initial contact.

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

Required: Yes

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

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.

Important

This is not expected to be set, because the value returned in the previous response is always null.

ReferenceTypes

The type of reference.

Array Members: Maximum number of 6 items.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "ReferenceSummaryList": [ 
      { ... }
   ]
}

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.

NextToken

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

Important

This is always returned as null in the response.

Type: String

ReferenceSummaryList

Information about the flows.

Type: Array of ReferenceSummary 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