AWSConnectStartWebRTCContactRequest

Objective-C

@interface AWSConnectStartWebRTCContactRequest

Swift

class AWSConnectStartWebRTCContactRequest
  • Information about the video sharing capabilities of the participants (customer, agent).

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSConnectAllowedCapabilities *_Nullable allowedCapabilities;

    Swift

    var allowedCapabilities: AWSConnectAllowedCapabilities? { get set }
  • 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, -, and _ 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.

    The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.

    Declaration

    Objective-C

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

    Swift

    var clientToken: String? { get set }
  • The identifier of the flow for the call. 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 customer’s details.

    Declaration

    Objective-C

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

    Swift

    var participantDetails: AWSConnectParticipantDetails? { 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 unique identifier for an Amazon Connect contact. This identifier is related to the contact starting.

    Declaration

    Objective-C

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

    Swift

    var relatedContactId: String? { get set }