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

Interface StartOutboundVoiceContactRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, ConnectRequest.Builder, CopyableBuilder<StartOutboundVoiceContactRequest.Builder,StartOutboundVoiceContactRequest>, SdkBuilder<StartOutboundVoiceContactRequest.Builder,StartOutboundVoiceContactRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
StartOutboundVoiceContactRequest
public static interface StartOutboundVoiceContactRequest.Builder extends ConnectRequest.Builder, SdkPojo, CopyableBuilder<StartOutboundVoiceContactRequest.Builder,StartOutboundVoiceContactRequest>

  • Method Details

    • name

      StartOutboundVoiceContactRequest.Builder name(String name)

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

      Parameters:
      name - The name of a voice contact that is shown to an agent in the Contact Control Panel (CCP).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      StartOutboundVoiceContactRequest.Builder description(String description)

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

      Parameters:
      description - A description of the voice contact that is shown to an agent in the Contact Control Panel (CCP).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • references

      StartOutboundVoiceContactRequest.Builder references(Map<String,Reference> references)

      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.

      Parameters:
      references - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • relatedContactId

      StartOutboundVoiceContactRequest.Builder relatedContactId(String relatedContactId)

      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.

      Parameters:
      relatedContactId - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • destinationPhoneNumber

      StartOutboundVoiceContactRequest.Builder destinationPhoneNumber(String destinationPhoneNumber)

      The phone number of the customer, in E.164 format.

      Parameters:
      destinationPhoneNumber - The phone number of the customer, in E.164 format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • contactFlowId

      StartOutboundVoiceContactRequest.Builder contactFlowId(String contactFlowId)

      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

      Parameters:
      contactFlowId - 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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • instanceId

      StartOutboundVoiceContactRequest.Builder instanceId(String instanceId)

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

      Parameters:
      instanceId - The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      StartOutboundVoiceContactRequest.Builder clientToken(String clientToken)

      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.

      Parameters:
      clientToken - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourcePhoneNumber

      StartOutboundVoiceContactRequest.Builder sourcePhoneNumber(String sourcePhoneNumber)

      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.

      Parameters:
      sourcePhoneNumber - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queueId

      StartOutboundVoiceContactRequest.Builder queueId(String queueId)

      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.

      Parameters:
      queueId - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attributes

      StartOutboundVoiceContactRequest.Builder attributes(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.

      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.

      Parameters:
      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.

      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • answerMachineDetectionConfig

      StartOutboundVoiceContactRequest.Builder answerMachineDetectionConfig(AnswerMachineDetectionConfig answerMachineDetectionConfig)

      Configuration of the answering machine detection for this outbound call.

      Parameters:
      answerMachineDetectionConfig - Configuration of the answering machine detection for this outbound call.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • answerMachineDetectionConfig

      default StartOutboundVoiceContactRequest.Builder answerMachineDetectionConfig(Consumer<AnswerMachineDetectionConfig.Builder> answerMachineDetectionConfig)

      Configuration of the answering machine detection for this outbound call.

      This is a convenience method that creates an instance of the AnswerMachineDetectionConfig.Builder avoiding the need to create one manually via AnswerMachineDetectionConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to answerMachineDetectionConfig(AnswerMachineDetectionConfig).

      Parameters:
      answerMachineDetectionConfig - a consumer that will call methods on AnswerMachineDetectionConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • campaignId

      StartOutboundVoiceContactRequest.Builder campaignId(String campaignId)

      The campaign identifier of the outbound communication.

      Parameters:
      campaignId - The campaign identifier of the outbound communication.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • trafficType

      StartOutboundVoiceContactRequest.Builder trafficType(String trafficType)

      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.

      Parameters:
      trafficType - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • trafficType

      StartOutboundVoiceContactRequest.Builder trafficType(TrafficType trafficType)

      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.

      Parameters:
      trafficType - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      StartOutboundVoiceContactRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      StartOutboundVoiceContactRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.