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

Class StartOutboundChatContactRequest

    • Method Detail

      • sourceEndpoint

        public final Endpoint sourceEndpoint()
        Returns the value of the SourceEndpoint property for this object.
        Returns:
        The value of the SourceEndpoint property for this object.

      • destinationEndpoint

        public final Endpoint destinationEndpoint()
        Returns the value of the DestinationEndpoint property for this object.
        Returns:
        The value of the DestinationEndpoint property for this object.

      • instanceId

        public final String instanceId()

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

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

      • hasSegmentAttributes

        public final boolean hasSegmentAttributes()
        For responses, this returns true if the service returned a value for the SegmentAttributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • segmentAttributes

        public final 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 and connect:SMS.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSegmentAttributes() method.

        Returns:
        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 and connect:SMS.

      • hasAttributes

        public final boolean hasAttributes()
        For responses, this returns true if the service returned a value for the Attributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • attributes

        public final Map<String,​String> attributes()

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

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAttributes() method.

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

      • contactFlowId

        public final String contactFlowId()

        The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect console user interface, 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/ 123ec456-a007-89c0-1234-xxxxxxxxxxxx

        Returns:
        The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect console user interface, 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/ 123ec456-a007-89c0-1234-xxxxxxxxxxxx

      • chatDurationInMinutes

        public final 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).

        Returns:
        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).

      • participantDetails

        public final ParticipantDetails participantDetails()
        Returns the value of the ParticipantDetails property for this object.
        Returns:
        The value of the ParticipantDetails property for this object.

      • initialSystemMessage

        public final ChatMessage initialSystemMessage()
        Returns the value of the InitialSystemMessage property for this object.
        Returns:
        The value of the InitialSystemMessage property for this object.

      • relatedContactId

        public final String relatedContactId()

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

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

      • hasSupportedMessagingContentTypes

        public final boolean hasSupportedMessagingContentTypes()
        For responses, this returns true if the service returned a value for the SupportedMessagingContentTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • supportedMessagingContentTypes

        public final List<String> supportedMessagingContentTypes()

        The supported chat message content types. Supported types are:

        • text/plain

        • text/markdown

        • application/json, application/vnd.amazonaws.connect.message.interactive

        • 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]

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSupportedMessagingContentTypes() method.

        Returns:
        The supported chat message content types. Supported types are:

        • text/plain

        • text/markdown

        • application/json, application/vnd.amazonaws.connect.message.interactive

        • 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]

      • clientToken

        public final String clientToken()

        A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.

        Returns:
        A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object