Interface CreatePersistentContactAssociationRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, ConnectRequest.Builder, CopyableBuilder<CreatePersistentContactAssociationRequest.Builder,CreatePersistentContactAssociationRequest>, SdkBuilder<CreatePersistentContactAssociationRequest.Builder,CreatePersistentContactAssociationRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreatePersistentContactAssociationRequest
public static interface CreatePersistentContactAssociationRequest.Builder extends ConnectRequest.Builder, SdkPojo, CopyableBuilder<CreatePersistentContactAssociationRequest.Builder,CreatePersistentContactAssociationRequest>

  • Method Details

    • instanceId

      CreatePersistentContactAssociationRequest.Builder instanceId(String instanceId)

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

      Parameters:
      instanceId - The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • initialContactId

      CreatePersistentContactAssociationRequest.Builder initialContactId(String initialContactId)

      This is the contactId of the current contact that the CreatePersistentContactAssociation API is being called from.

      Parameters:
      initialContactId - This is the contactId of the current contact that the CreatePersistentContactAssociation API is being called from.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rehydrationType

      CreatePersistentContactAssociationRequest.Builder rehydrationType(String rehydrationType)

      The contactId chosen for rehydration depends on the type chosen.

      • ENTIRE_PAST_SESSION: Rehydrates a chat from the most recently terminated past chat contact of the specified past ended chat session. To use this type, provide the initialContactId of the past ended chat session in the sourceContactId field. In this type, Amazon Connect determines what the most recent chat contact on the past ended chat session and uses it to start a persistent chat.

      • FROM_SEGMENT: Rehydrates a chat from the specified past chat contact provided in the sourceContactId field.

      The actual contactId used for rehydration is provided in the response of this API.

      To illustrate how to use rehydration type, consider the following example: A customer starts a chat session. Agent a1 accepts the chat and a conversation starts between the customer and Agent a1. This first contact creates a contact ID C1. Agent a1 then transfers the chat to Agent a2. This creates another contact ID C2. At this point Agent a2 ends the chat. The customer is forwarded to the disconnect flow for a post chat survey that creates another contact ID C3. After the chat survey, the chat session ends. Later, the customer returns and wants to resume their past chat session. At this point, the customer can have following use cases:

      • Use Case 1: The customer wants to continue the past chat session but they want to hide the post chat survey. For this they will use the following configuration:

        • Configuration

          • SourceContactId = "C2"

          • RehydrationType = "FROM_SEGMENT"

        • Expected behavior

          • This starts a persistent chat session from the specified past ended contact (C2). Transcripts of past chat sessions C2 and C1 are accessible in the current persistent chat session. Note that chat segment C3 is dropped from the persistent chat session.

      • Use Case 2: The customer wants to continue the past chat session and see the transcript of the entire past engagement, including the post chat survey. For this they will use the following configuration:

        • Configuration

          • SourceContactId = "C1"

          • RehydrationType = "ENTIRE_PAST_SESSION"

        • Expected behavior

          • This starts a persistent chat session from the most recently ended chat contact (C3). Transcripts of past chat sessions C3, C2 and C1 are accessible in the current persistent chat session.

      Parameters:
      rehydrationType - The contactId chosen for rehydration depends on the type chosen.

      • ENTIRE_PAST_SESSION: Rehydrates a chat from the most recently terminated past chat contact of the specified past ended chat session. To use this type, provide the initialContactId of the past ended chat session in the sourceContactId field. In this type, Amazon Connect determines what the most recent chat contact on the past ended chat session and uses it to start a persistent chat.

      • FROM_SEGMENT: Rehydrates a chat from the specified past chat contact provided in the sourceContactId field.

      The actual contactId used for rehydration is provided in the response of this API.

      To illustrate how to use rehydration type, consider the following example: A customer starts a chat session. Agent a1 accepts the chat and a conversation starts between the customer and Agent a1. This first contact creates a contact ID C1. Agent a1 then transfers the chat to Agent a2. This creates another contact ID C2. At this point Agent a2 ends the chat. The customer is forwarded to the disconnect flow for a post chat survey that creates another contact ID C3. After the chat survey, the chat session ends. Later, the customer returns and wants to resume their past chat session. At this point, the customer can have following use cases:

      • Use Case 1: The customer wants to continue the past chat session but they want to hide the post chat survey. For this they will use the following configuration:

        • Configuration

          • SourceContactId = "C2"

          • RehydrationType = "FROM_SEGMENT"

        • Expected behavior

          • This starts a persistent chat session from the specified past ended contact (C2). Transcripts of past chat sessions C2 and C1 are accessible in the current persistent chat session. Note that chat segment C3 is dropped from the persistent chat session.

      • Use Case 2: The customer wants to continue the past chat session and see the transcript of the entire past engagement, including the post chat survey. For this they will use the following configuration:

        • Configuration

          • SourceContactId = "C1"

          • RehydrationType = "ENTIRE_PAST_SESSION"

        • Expected behavior

          • This starts a persistent chat session from the most recently ended chat contact (C3). Transcripts of past chat sessions C3, C2 and C1 are accessible in the current persistent chat session.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • rehydrationType

      CreatePersistentContactAssociationRequest.Builder rehydrationType(RehydrationType rehydrationType)

      The contactId chosen for rehydration depends on the type chosen.

      • ENTIRE_PAST_SESSION: Rehydrates a chat from the most recently terminated past chat contact of the specified past ended chat session. To use this type, provide the initialContactId of the past ended chat session in the sourceContactId field. In this type, Amazon Connect determines what the most recent chat contact on the past ended chat session and uses it to start a persistent chat.

      • FROM_SEGMENT: Rehydrates a chat from the specified past chat contact provided in the sourceContactId field.

      The actual contactId used for rehydration is provided in the response of this API.

      To illustrate how to use rehydration type, consider the following example: A customer starts a chat session. Agent a1 accepts the chat and a conversation starts between the customer and Agent a1. This first contact creates a contact ID C1. Agent a1 then transfers the chat to Agent a2. This creates another contact ID C2. At this point Agent a2 ends the chat. The customer is forwarded to the disconnect flow for a post chat survey that creates another contact ID C3. After the chat survey, the chat session ends. Later, the customer returns and wants to resume their past chat session. At this point, the customer can have following use cases:

      • Use Case 1: The customer wants to continue the past chat session but they want to hide the post chat survey. For this they will use the following configuration:

        • Configuration

          • SourceContactId = "C2"

          • RehydrationType = "FROM_SEGMENT"

        • Expected behavior

          • This starts a persistent chat session from the specified past ended contact (C2). Transcripts of past chat sessions C2 and C1 are accessible in the current persistent chat session. Note that chat segment C3 is dropped from the persistent chat session.

      • Use Case 2: The customer wants to continue the past chat session and see the transcript of the entire past engagement, including the post chat survey. For this they will use the following configuration:

        • Configuration

          • SourceContactId = "C1"

          • RehydrationType = "ENTIRE_PAST_SESSION"

        • Expected behavior

          • This starts a persistent chat session from the most recently ended chat contact (C3). Transcripts of past chat sessions C3, C2 and C1 are accessible in the current persistent chat session.

      Parameters:
      rehydrationType - The contactId chosen for rehydration depends on the type chosen.

      • ENTIRE_PAST_SESSION: Rehydrates a chat from the most recently terminated past chat contact of the specified past ended chat session. To use this type, provide the initialContactId of the past ended chat session in the sourceContactId field. In this type, Amazon Connect determines what the most recent chat contact on the past ended chat session and uses it to start a persistent chat.

      • FROM_SEGMENT: Rehydrates a chat from the specified past chat contact provided in the sourceContactId field.

      The actual contactId used for rehydration is provided in the response of this API.

      To illustrate how to use rehydration type, consider the following example: A customer starts a chat session. Agent a1 accepts the chat and a conversation starts between the customer and Agent a1. This first contact creates a contact ID C1. Agent a1 then transfers the chat to Agent a2. This creates another contact ID C2. At this point Agent a2 ends the chat. The customer is forwarded to the disconnect flow for a post chat survey that creates another contact ID C3. After the chat survey, the chat session ends. Later, the customer returns and wants to resume their past chat session. At this point, the customer can have following use cases:

      • Use Case 1: The customer wants to continue the past chat session but they want to hide the post chat survey. For this they will use the following configuration:

        • Configuration

          • SourceContactId = "C2"

          • RehydrationType = "FROM_SEGMENT"

        • Expected behavior

          • This starts a persistent chat session from the specified past ended contact (C2). Transcripts of past chat sessions C2 and C1 are accessible in the current persistent chat session. Note that chat segment C3 is dropped from the persistent chat session.

      • Use Case 2: The customer wants to continue the past chat session and see the transcript of the entire past engagement, including the post chat survey. For this they will use the following configuration:

        • Configuration

          • SourceContactId = "C1"

          • RehydrationType = "ENTIRE_PAST_SESSION"

        • Expected behavior

          • This starts a persistent chat session from the most recently ended chat contact (C3). Transcripts of past chat sessions C3, C2 and C1 are accessible in the current persistent chat session.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sourceContactId

      CreatePersistentContactAssociationRequest.Builder sourceContactId(String sourceContactId)

      The contactId from which a persistent chat session must be started.

      Parameters:
      sourceContactId - The contactId from which a persistent chat session must be started.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      CreatePersistentContactAssociationRequest.Builder clientToken(String clientToken)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

      Parameters:
      clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreatePersistentContactAssociationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreatePersistentContactAssociationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.