AWSConnectStartChatContactRequest

Objective-C

@interface AWSConnectStartChatContactRequest

Swift

class AWSConnectStartChatContactRequest

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDictionary<NSString *, NSString *> *_Nullable attributes;

    Swift

    var attributes: [String : String]? { get set }

  • 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).

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable chatDurationInMinutes;

    Swift

    var chatDurationInMinutes: NSNumber? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable clientToken;

    Swift

    var clientToken: String? { get set }

  • 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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable contactFlowId;

    Swift

    var contactFlowId: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSConnectChatMessage *_Nullable initialMessage;

    Swift

    var initialMessage: AWSConnectChatMessage? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable instanceId;

    Swift

    var instanceId: String? { get set }

  • Information identifying the participant.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSConnectParticipantDetails *_Nullable participantDetails;

    Swift

    var participantDetails: AWSConnectParticipantDetails? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSConnectPersistentChat *_Nullable persistentChat;

    Swift

    var persistentChat: AWSConnectPersistentChat? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable relatedContactId;

    Swift

    var relatedContactId: String? { get set }

  • 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" }}.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDictionary<NSString *, AWSConnectSegmentAttributeValue *> *_Nullable segmentAttributes;

    Swift

    var segmentAttributes: [String : AWSConnectSegmentAttributeValue]? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable supportedMessagingContentTypes;

    Swift

    var supportedMessagingContentTypes: [String]? { get set }