/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::Connect::StartOutboundVoiceContact

NAME

Paws::Connect::StartOutboundVoiceContact - Arguments for method StartOutboundVoiceContact on Paws::Connect

DESCRIPTION

This class represents the parameters used for calling the method StartOutboundVoiceContact on the Amazon Connect Service service. Use the attributes of this class as arguments to method StartOutboundVoiceContact.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartOutboundVoiceContact.

SYNOPSIS

my $connect = Paws->service('Connect');
my $StartOutboundVoiceContactResponse = $connect->StartOutboundVoiceContact(
  ContactFlowId          => 'MyContactFlowId',
  DestinationPhoneNumber => 'MyPhoneNumber',
  InstanceId             => 'MyInstanceId',
  Attributes             => {
    'MyAttributeName' =>
      'MyAttributeValue',    # key: min: 1, max: 32767, value: max: 32767
  },    # OPTIONAL
  ClientToken       => 'MyClientToken',    # OPTIONAL
  QueueId           => 'MyQueueId',        # OPTIONAL
  SourcePhoneNumber => 'MyPhoneNumber',    # OPTIONAL
);

# Results:
my $ContactId = $StartOutboundVoiceContactResponse->ContactId;

# Returns a L<Paws::Connect::StartOutboundVoiceContactResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/connect/StartOutboundVoiceContact

ATTRIBUTES

Attributes => Paws::Connect::Attributes

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact 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.

ClientToken => Str

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.

REQUIRED ContactFlowId => Str

The identifier of the contact flow for the outbound call. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the contact flow. On the contact flow page, under the name of the contact 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

REQUIRED DestinationPhoneNumber => Str

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

REQUIRED InstanceId => Str

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

QueueId => Str

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 contact flow is used. If you do not specify a queue, you must specify a source phone number.

SourcePhoneNumber => Str

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.

SEE ALSO

This class forms part of Paws, documenting arguments for method StartOutboundVoiceContact in Paws::Connect

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues