Package software.amazon.awssdk.services.connect.model

Interface StartChatContactRequest.Builder

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

  • Method Details

    • instanceId

      StartChatContactRequest.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.

    • contactFlowId

      StartChatContactRequest.Builder contactFlowId(String contactFlowId)

      The identifier of the flow for initiating the chat. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

      arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/ 846ec553-a005-41c0-8341-xxxxxxxxxxxx

      Parameters:
      contactFlowId - The identifier of the flow for initiating the chat. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

      arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/ 846ec553-a005-41c0-8341-xxxxxxxxxxxx

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

    • attributes

      StartChatContactRequest.Builder attributes(Map<String,String> attributes)

      A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows just like any other contact attributes.

      There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

      Parameters:
      attributes - A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows just like any other contact attributes.

      There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

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

    • participantDetails

      StartChatContactRequest.Builder participantDetails(ParticipantDetails participantDetails)

      Information identifying the participant.

      Parameters:
      participantDetails - Information identifying the participant.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • participantDetails

      default StartChatContactRequest.Builder participantDetails(Consumer<ParticipantDetails.Builder> participantDetails)

      Information identifying the participant.

      This is a convenience method that creates an instance of the ParticipantDetails.Builder avoiding the need to create one manually via ParticipantDetails.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to participantDetails(ParticipantDetails).

      Parameters:
      participantDetails - a consumer that will call methods on ParticipantDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • initialMessage

      StartChatContactRequest.Builder initialMessage(ChatMessage initialMessage)

      The initial message to be sent to the newly created chat. If you have a Lex bot in your flow, the initial message is not delivered to the Lex bot.

      Parameters:
      initialMessage - The initial message to be sent to the newly created chat. If you have a Lex bot in your flow, the initial message is not delivered to the Lex bot.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • initialMessage

      default StartChatContactRequest.Builder initialMessage(Consumer<ChatMessage.Builder> initialMessage)

      The initial message to be sent to the newly created chat. If you have a Lex bot in your flow, the initial message is not delivered to the Lex bot.

      This is a convenience method that creates an instance of the ChatMessage.Builder avoiding the need to create one manually via ChatMessage.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to initialMessage(ChatMessage).

      Parameters:
      initialMessage - a consumer that will call methods on ChatMessage.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clientToken

      StartChatContactRequest.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.

    • chatDurationInMinutes

      StartChatContactRequest.Builder chatDurationInMinutes(Integer chatDurationInMinutes)

      The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).

      Parameters:
      chatDurationInMinutes - The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • supportedMessagingContentTypes

      StartChatContactRequest.Builder supportedMessagingContentTypes(Collection<String> supportedMessagingContentTypes)

      The supported chat message content types. Supported types are text/plain, text/markdown, application/json, application/vnd.amazonaws.connect.message.interactive, and application/vnd.amazonaws.connect.message.interactive.response.

      Content types must always contain text/plain. You can then put any other supported type in the list. For example, all the following lists are valid because they contain text/plain: [text/plain, text/markdown, application/json], [text/markdown, text/plain], [text/plain, application/json, application/vnd.amazonaws.connect.message.interactive.response].

      The type application/vnd.amazonaws.connect.message.interactive is required to use the Show view flow block.

      Parameters:
      supportedMessagingContentTypes - The supported chat message content types. Supported types are text/plain, text/markdown, application/json, application/vnd.amazonaws.connect.message.interactive, and application/vnd.amazonaws.connect.message.interactive.response.

      Content types must always contain text/plain. You can then put any other supported type in the list. For example, all the following lists are valid because they contain text/plain: [text/plain, text/markdown, application/json], [text/markdown, text/plain], [text/plain, application/json, application/vnd.amazonaws.connect.message.interactive.response] .

      The type application/vnd.amazonaws.connect.message.interactive is required to use the Show view flow block.

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

    • supportedMessagingContentTypes

      StartChatContactRequest.Builder supportedMessagingContentTypes(String... supportedMessagingContentTypes)

      The supported chat message content types. Supported types are text/plain, text/markdown, application/json, application/vnd.amazonaws.connect.message.interactive, and application/vnd.amazonaws.connect.message.interactive.response.

      Content types must always contain text/plain. You can then put any other supported type in the list. For example, all the following lists are valid because they contain text/plain: [text/plain, text/markdown, application/json], [text/markdown, text/plain], [text/plain, application/json, application/vnd.amazonaws.connect.message.interactive.response].

      The type application/vnd.amazonaws.connect.message.interactive is required to use the Show view flow block.

      Parameters:
      supportedMessagingContentTypes - The supported chat message content types. Supported types are text/plain, text/markdown, application/json, application/vnd.amazonaws.connect.message.interactive, and application/vnd.amazonaws.connect.message.interactive.response.

      Content types must always contain text/plain. You can then put any other supported type in the list. For example, all the following lists are valid because they contain text/plain: [text/plain, text/markdown, application/json], [text/markdown, text/plain], [text/plain, application/json, application/vnd.amazonaws.connect.message.interactive.response] .

      The type application/vnd.amazonaws.connect.message.interactive is required to use the Show view flow block.

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

    • persistentChat

      StartChatContactRequest.Builder persistentChat(PersistentChat persistentChat)

      Enable persistent chats. For more information about enabling persistent chat, and for example use cases and how to configure for them, see Enable persistent chat.

      Parameters:
      persistentChat - Enable persistent chats. For more information about enabling persistent chat, and for example use cases and how to configure for them, see Enable persistent chat.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • persistentChat

      default StartChatContactRequest.Builder persistentChat(Consumer<PersistentChat.Builder> persistentChat)

      Enable persistent chats. For more information about enabling persistent chat, and for example use cases and how to configure for them, see Enable persistent chat.

      This is a convenience method that creates an instance of the PersistentChat.Builder avoiding the need to create one manually via PersistentChat.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to persistentChat(PersistentChat).

      Parameters:
      persistentChat - a consumer that will call methods on PersistentChat.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • relatedContactId

      StartChatContactRequest.Builder relatedContactId(String relatedContactId)

      The unique identifier for an Amazon Connect contact. This identifier is related to the chat starting.

      You cannot provide data for both RelatedContactId and PersistentChat.

      Parameters:
      relatedContactId - The unique identifier for an Amazon Connect contact. This identifier is related to the chat starting.

      You cannot provide data for both RelatedContactId and PersistentChat.

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

    • segmentAttributes

      StartChatContactRequest.Builder segmentAttributes(Map<String,SegmentAttributeValue> segmentAttributes)

      A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.

      Attribute keys can include only alphanumeric, -, and _.

      This field can be used to show channel subtype, such as connect:Guide.

      The types application/vnd.amazonaws.connect.message.interactive and application/vnd.amazonaws.connect.message.interactive.response must be present in the SupportedMessagingContentTypes field of this API in order to set SegmentAttributes as { "connect:Subtype": {"valueString" : "connect:Guide" }}.

      Parameters:
      segmentAttributes - A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.

      Attribute keys can include only alphanumeric, -, and _.

      This field can be used to show channel subtype, such as connect:Guide.

      The types application/vnd.amazonaws.connect.message.interactive and application/vnd.amazonaws.connect.message.interactive.response must be present in the SupportedMessagingContentTypes field of this API in order to set SegmentAttributes as { "connect:Subtype": {"valueString" : "connect:Guide" }}.

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

    • overrideConfiguration

      StartChatContactRequest.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

      StartChatContactRequest.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.