AWSConnectStartTaskContactRequest

Objective-C

@interface AWSConnectStartTaskContactRequest

Swift

class AWSConnectStartTaskContactRequest

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

    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 }

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

  • A description of the task that is shown to an agent in the Contact Control Panel (CCP).

    Declaration

    Objective-C

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

    Swift

    var detail: String? { 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 }

  • The name of a task that is shown to an agent in the Contact Control Panel (CCP).

    Declaration

    Objective-C

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

    Swift

    var name: String? { get set }

  • The identifier of the previous chat, voice, or task contact. Any updates to user-defined attributes to task contacts linked using the same PreviousContactID will affect every contact in the chain. There can be a maximum of 12 linked task contacts in a chain.

    Declaration

    Objective-C

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

    Swift

    var previousContactId: String? { get set }

  • The identifier for the quick connect. Tasks that are created by using QuickConnectId will use the flow that is defined on agent or queue quick connect. For more information about quick connects, see Create quick connects.

    Declaration

    Objective-C

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

    Swift

    var quickConnectId: String? { get set }

  • A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL. ATTACHMENT is not a supported reference type during task creation.

    Declaration

    Objective-C

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

    Swift

    var references: [String : AWSConnectReference]? { get set }

  • The contactId that is related to this contact. Linking tasks together by using RelatedContactID copies over contact attributes from the related task contact to the new task contact. All updates to user-defined attributes in the new task contact are limited to the individual contact ID, unlike what happens when tasks are linked by using PreviousContactID. There are no limits to the number of contacts that can be linked by using RelatedContactId.

    Declaration

    Objective-C

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

    Swift

    var relatedContactId: String? { get set }

  • The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable scheduledTime;

    Swift

    var scheduledTime: Date? { get set }

  • A unique identifier for the task template. For more information about task templates, see Create task templates in the Amazon Connect Administrator Guide.

    Declaration

    Objective-C

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

    Swift

    var taskTemplateId: String? { get set }