AWSConnectStartOutboundVoiceContactRequest

Objective-C

@interface AWSConnectStartOutboundVoiceContactRequest

Swift

class AWSConnectStartOutboundVoiceContactRequest

  • Configuration of the answering machine detection for this outbound call.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSConnectAnswerMachineDetectionConfig *_Nullable answerMachineDetectionConfig;

    Swift

    var answerMachineDetectionConfig: AWSConnectAnswerMachineDetectionConfig? { 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, dash, and underscore characters.

    Declaration

    Objective-C

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

    Swift

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

  • The campaign identifier of the outbound communication.

    Declaration

    Objective-C

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

    Swift

    var campaignId: 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 outbound 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 voice contact 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 phone number of the customer, in E.164 format.

    Declaration

    Objective-C

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

    Swift

    var destinationPhoneNumber: 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 voice contact 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 queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the flow is used. If you do not specify a queue, you must specify a source phone number.

    Declaration

    Objective-C

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

    Swift

    var queueId: String? { get set }

  • A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Contacts can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL. ATTACHMENT is not a supported reference type during voice contact 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 voice, task, or chat by using RelatedContactID copies over contact attributes from the related contact to the new contact. All updates to user-defined attributes in the new contact are limited to the individual contact ID. 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 phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.

    Declaration

    Objective-C

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

    Swift

    var sourcePhoneNumber: String? { get set }

  • Denotes the class of traffic. Calls with different traffic types are handled differently by Amazon Connect. The default value is GENERAL. Use CAMPAIGN if EnableAnswerMachineDetection is set to true. For all other cases, use GENERAL.

    Declaration

    Objective-C

    @property (nonatomic) AWSConnectTrafficType trafficType;

    Swift

    var trafficType: AWSConnectTrafficType { get set }