AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

StartOutboundVoiceContactInput

import "github.com/aws/aws-sdk-go/service/connect"

type StartOutboundVoiceContactInput struct { Attributes map[string]*string `type:"map"` ClientToken *string `type:"string" idempotencyToken:"true"` ContactFlowId *string `type:"string" required:"true"` DestinationPhoneNumber *string `type:"string" required:"true"` InstanceId *string `min:"1" type:"string" required:"true"` QueueId *string `type:"string"` SourcePhoneNumber *string `type:"string"` }

Attributes

Type: map[string]*string

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

For example, if you want play a greeting when the customer answers the call, you can pass the customer name in attributes similar to the following:

ClientToken

Type: *string

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. If the contact is disconnected, a new contact is started.

ContactFlowId

Type: *string

The identifier for the contact flow to connect the outbound call to.

To find the ContactFlowId, open the contact flow you want to use in the Amazon Connect contact flow editor. The ID for the contact flow is displayed in the address bar as part of the URL. For example, the contact flow ID is the set of characters at the end of the URL, after 'contact-flow/' such as 78ea8fd5-2659-4f2b-b528-699760ccfc1b.

ContactFlowId is a required field

DestinationPhoneNumber

Type: *string

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

DestinationPhoneNumber is a required field

InstanceId

Type: *string

The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

InstanceId is a required field

QueueId

Type: *string

The queue to add the call to. 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 used will be the queue defined in the contact flow.

To find the QueueId, open the queue you want to use in the Amazon Connect Queue editor. The ID for the queue is displayed in the address bar as part of the URL. For example, the queue ID is the set of characters at the end of the URL, after 'queue/' such as queue/aeg40574-2d01-51c3-73d6-bf8624d2168c.

SourcePhoneNumber

Type: *string

The phone number, in E.164 format, associated with your Amazon Connect instance to use for the outbound call.

Method

GoString

func (s StartOutboundVoiceContactInput) GoString() string

GoString returns the string representation

SetAttributes

func (s *StartOutboundVoiceContactInput) SetAttributes(v map[string]*string) *StartOutboundVoiceContactInput

SetAttributes sets the Attributes field's value.

SetClientToken

func (s *StartOutboundVoiceContactInput) SetClientToken(v string) *StartOutboundVoiceContactInput

SetClientToken sets the ClientToken field's value.

SetContactFlowId

func (s *StartOutboundVoiceContactInput) SetContactFlowId(v string) *StartOutboundVoiceContactInput

SetContactFlowId sets the ContactFlowId field's value.

SetDestinationPhoneNumber

func (s *StartOutboundVoiceContactInput) SetDestinationPhoneNumber(v string) *StartOutboundVoiceContactInput

SetDestinationPhoneNumber sets the DestinationPhoneNumber field's value.

SetInstanceId

func (s *StartOutboundVoiceContactInput) SetInstanceId(v string) *StartOutboundVoiceContactInput

SetInstanceId sets the InstanceId field's value.

SetQueueId

func (s *StartOutboundVoiceContactInput) SetQueueId(v string) *StartOutboundVoiceContactInput

SetQueueId sets the QueueId field's value.

SetSourcePhoneNumber

func (s *StartOutboundVoiceContactInput) SetSourcePhoneNumber(v string) *StartOutboundVoiceContactInput

SetSourcePhoneNumber sets the SourcePhoneNumber field's value.

String

func (s StartOutboundVoiceContactInput) String() string

String returns the string representation

Validate

func (s *StartOutboundVoiceContactInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: