Network.AWS.Connect.StartOutboundVoiceContact

The StartOutboundVoiceContact operation initiates a contact flow to place an outbound call to a customer.

There is a throttling limit placed on usage of the API that includes a RateLimit of 2 per second, and a BurstLimit of 5 per second.

If you are using an IAM account, it must have permissions to the connect:StartOutboundVoiceContact action.

Creating a Request

startOutboundVoiceContact

Arguments

:: Text

sovcDestinationPhoneNumber

-> Text

sovcContactFlowId

-> Text

sovcInstanceId

-> StartOutboundVoiceContact

Creates a value of StartOutboundVoiceContact with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sovcClientToken - 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.
• sovcQueueId - The queue to which to add the call. If you specify a queue, the phone displayed for caller ID is the phone number defined for the queue. If you do not specify a queue, the queue used is the queue defined in the contact flow specified by ContactFlowId . To find the QueueId , open the queue 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 QueueId value is the set of characters at the end of the URL, after "queue/", such as aeg40574-2d01-51c3-73d6-bf8624d2168c .
• sovcAttributes - 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. Attribute keys can include only alphanumeric, dash, and underscore characters. For example, to play a greeting when the customer answers the call, you can pass the customer name in attributes similar to the following:
• sovcSourcePhoneNumber - The phone number, in E.164 format, associated with your Amazon Connect instance to use to place the outbound call.
• sovcDestinationPhoneNumber - The phone number, in E.164 format, of the customer to call with the outbound contact.
• sovcContactFlowId - The identifier for the contact flow to execute for the outbound call. This is a GUID value only. Amazon Resource Name (ARN) values are not supported. To find the ContactFlowId , open the contact flow to use in the Amazon Connect contact flow designer. The ID for the contact flow is displayed in the address bar as part of the URL. For example, an address displayed when you open a contact flow is similar to the following: https://myconnectinstance.awsapps.com/connect/contact-flows/edit?id=arn:aws:connect:us-east-1:361814831152:instance/2fb42df9-78a2-4b99-b484-f5cf80dc300c/contact-flow//b0b8f2dd-ed1b-4c44-af36-ce189a178181/ . At the end of the URL, you see contact-flow/b0b8f2dd-ed1b-4c44-af36-ce189a178181 . The ContactFlowID for this contact flow is b0b8f2dd-ed1b-4c44-af36-ce189a178181 . Make sure to include only the GUID after the "contact-flow/" in your requests.
• sovcInstanceId - The identifier for your Amazon Connect instance. To find the InstanceId value for your Amazon Connect instance, open the Amazon Connect console . Select the instance alias of the instance and view the instance ID in the Overview section. 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.

data StartOutboundVoiceContact

See: startOutboundVoiceContact smart constructor.

Instances

Eq StartOutboundVoiceContact

Methods

(==) :: StartOutboundVoiceContact -> StartOutboundVoiceContact -> Bool

(/=) :: StartOutboundVoiceContact -> StartOutboundVoiceContact -> Bool

Data StartOutboundVoiceContact

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StartOutboundVoiceContact -> c StartOutboundVoiceContact

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StartOutboundVoiceContact

toConstr :: StartOutboundVoiceContact -> Constr

dataTypeOf :: StartOutboundVoiceContact -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c StartOutboundVoiceContact)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StartOutboundVoiceContact)

gmapT :: (forall b. Data b => b -> b) -> StartOutboundVoiceContact -> StartOutboundVoiceContact

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StartOutboundVoiceContact -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StartOutboundVoiceContact -> r

gmapQ :: (forall d. Data d => d -> u) -> StartOutboundVoiceContact -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> StartOutboundVoiceContact -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> StartOutboundVoiceContact -> m StartOutboundVoiceContact

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StartOutboundVoiceContact -> m StartOutboundVoiceContact

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StartOutboundVoiceContact -> m StartOutboundVoiceContact

Read StartOutboundVoiceContact

Methods

readsPrec :: Int -> ReadS StartOutboundVoiceContact

readList :: ReadS [StartOutboundVoiceContact]

readPrec :: ReadPrec StartOutboundVoiceContact

readListPrec :: ReadPrec [StartOutboundVoiceContact]

Show StartOutboundVoiceContact

Methods

showsPrec :: Int -> StartOutboundVoiceContact -> ShowS

show :: StartOutboundVoiceContact -> String

showList :: [StartOutboundVoiceContact] -> ShowS

Generic StartOutboundVoiceContact

Associated Types

type Rep StartOutboundVoiceContact :: * -> *

Methods

from :: StartOutboundVoiceContact -> Rep StartOutboundVoiceContact x

to :: Rep StartOutboundVoiceContact x -> StartOutboundVoiceContact

Hashable StartOutboundVoiceContact

Methods

hashWithSalt :: Int -> StartOutboundVoiceContact -> Int

hash :: StartOutboundVoiceContact -> Int

ToJSON StartOutboundVoiceContact

Methods

toJSON :: StartOutboundVoiceContact -> Value

toEncoding :: StartOutboundVoiceContact -> Encoding

toJSONList :: [StartOutboundVoiceContact] -> Value

toEncodingList :: [StartOutboundVoiceContact] -> Encoding

NFData StartOutboundVoiceContact

Methods

rnf :: StartOutboundVoiceContact -> ()

AWSRequest StartOutboundVoiceContact

Associated Types

type Rs StartOutboundVoiceContact :: *

Methods

request :: StartOutboundVoiceContact -> Request StartOutboundVoiceContact

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * StartOutboundVoiceContact -> ClientResponse -> m (Response StartOutboundVoiceContact)

ToHeaders StartOutboundVoiceContact

Methods

toHeaders :: StartOutboundVoiceContact -> [Header]

ToPath StartOutboundVoiceContact

Methods

toPath :: StartOutboundVoiceContact -> ByteString

ToQuery StartOutboundVoiceContact

Methods

toQuery :: StartOutboundVoiceContact -> QueryString

type Rep StartOutboundVoiceContact

type Rep StartOutboundVoiceContact = D1 * (MetaData "StartOutboundVoiceContact" "Network.AWS.Connect.StartOutboundVoiceContact" "amazonka-connect-1.6.0-Cvyjp9YiCJJ5KbPhYlqW9W" False) (C1 * (MetaCons "StartOutboundVoiceContact'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_sovcClientToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sovcQueueId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_sovcAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text Text)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_sovcSourcePhoneNumber") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_sovcDestinationPhoneNumber") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sovcContactFlowId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_sovcInstanceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))))

type Rs StartOutboundVoiceContact

type Rs StartOutboundVoiceContact = StartOutboundVoiceContactResponse

Request Lenses

sovcClientToken :: Lens' StartOutboundVoiceContact (Maybe Text)

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.

sovcQueueId :: Lens' StartOutboundVoiceContact (Maybe Text)

The queue to which to add the call. If you specify a queue, the phone displayed for caller ID is the phone number defined for the queue. If you do not specify a queue, the queue used is the queue defined in the contact flow specified by ContactFlowId . To find the QueueId , open the queue 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 QueueId value is the set of characters at the end of the URL, after "queue/", such as aeg40574-2d01-51c3-73d6-bf8624d2168c .

sovcAttributes :: Lens' StartOutboundVoiceContact (HashMap Text Text)

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. Attribute keys can include only alphanumeric, dash, and underscore characters. For example, to play a greeting when the customer answers the call, you can pass the customer name in attributes similar to the following:

sovcSourcePhoneNumber :: Lens' StartOutboundVoiceContact (Maybe Text)

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

sovcDestinationPhoneNumber :: Lens' StartOutboundVoiceContact Text

The phone number, in E.164 format, of the customer to call with the outbound contact.

sovcContactFlowId :: Lens' StartOutboundVoiceContact Text

The identifier for the contact flow to execute for the outbound call. This is a GUID value only. Amazon Resource Name (ARN) values are not supported. To find the ContactFlowId , open the contact flow to use in the Amazon Connect contact flow designer. The ID for the contact flow is displayed in the address bar as part of the URL. For example, an address displayed when you open a contact flow is similar to the following: https://myconnectinstance.awsapps.com/connect/contact-flows/edit?id=arn:aws:connect:us-east-1:361814831152:instance/2fb42df9-78a2-4b99-b484-f5cf80dc300c/contact-flow//b0b8f2dd-ed1b-4c44-af36-ce189a178181/ . At the end of the URL, you see contact-flow/b0b8f2dd-ed1b-4c44-af36-ce189a178181 . The ContactFlowID for this contact flow is b0b8f2dd-ed1b-4c44-af36-ce189a178181 . Make sure to include only the GUID after the "contact-flow/" in your requests.

sovcInstanceId :: Lens' StartOutboundVoiceContact Text

The identifier for your Amazon Connect instance. To find the InstanceId value for your Amazon Connect instance, open the Amazon Connect console . Select the instance alias of the instance and view the instance ID in the Overview section. 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.

Destructuring the Response

startOutboundVoiceContactResponse

Arguments

:: Int

sovcrsResponseStatus

-> StartOutboundVoiceContactResponse

Creates a value of StartOutboundVoiceContactResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sovcrsContactId - The unique identifier of this contact within your Amazon Connect instance.
• sovcrsResponseStatus - -- | The response status code.

data StartOutboundVoiceContactResponse

See: startOutboundVoiceContactResponse smart constructor.

Instances

Eq StartOutboundVoiceContactResponse

Methods

(==) :: StartOutboundVoiceContactResponse -> StartOutboundVoiceContactResponse -> Bool

(/=) :: StartOutboundVoiceContactResponse -> StartOutboundVoiceContactResponse -> Bool

Data StartOutboundVoiceContactResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StartOutboundVoiceContactResponse -> c StartOutboundVoiceContactResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StartOutboundVoiceContactResponse

toConstr :: StartOutboundVoiceContactResponse -> Constr

dataTypeOf :: StartOutboundVoiceContactResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c StartOutboundVoiceContactResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StartOutboundVoiceContactResponse)

gmapT :: (forall b. Data b => b -> b) -> StartOutboundVoiceContactResponse -> StartOutboundVoiceContactResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StartOutboundVoiceContactResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StartOutboundVoiceContactResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> StartOutboundVoiceContactResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> StartOutboundVoiceContactResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> StartOutboundVoiceContactResponse -> m StartOutboundVoiceContactResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StartOutboundVoiceContactResponse -> m StartOutboundVoiceContactResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StartOutboundVoiceContactResponse -> m StartOutboundVoiceContactResponse

Read StartOutboundVoiceContactResponse

Methods

readsPrec :: Int -> ReadS StartOutboundVoiceContactResponse

readList :: ReadS [StartOutboundVoiceContactResponse]

readPrec :: ReadPrec StartOutboundVoiceContactResponse

readListPrec :: ReadPrec [StartOutboundVoiceContactResponse]

Show StartOutboundVoiceContactResponse

Methods

showsPrec :: Int -> StartOutboundVoiceContactResponse -> ShowS

show :: StartOutboundVoiceContactResponse -> String

showList :: [StartOutboundVoiceContactResponse] -> ShowS

Generic StartOutboundVoiceContactResponse

Associated Types

type Rep StartOutboundVoiceContactResponse :: * -> *

Methods

from :: StartOutboundVoiceContactResponse -> Rep StartOutboundVoiceContactResponse x

to :: Rep StartOutboundVoiceContactResponse x -> StartOutboundVoiceContactResponse

NFData StartOutboundVoiceContactResponse

Methods

rnf :: StartOutboundVoiceContactResponse -> ()

type Rep StartOutboundVoiceContactResponse

type Rep StartOutboundVoiceContactResponse = D1 * (MetaData "StartOutboundVoiceContactResponse" "Network.AWS.Connect.StartOutboundVoiceContact" "amazonka-connect-1.6.0-Cvyjp9YiCJJ5KbPhYlqW9W" False) (C1 * (MetaCons "StartOutboundVoiceContactResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_sovcrsContactId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_sovcrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

sovcrsContactId :: Lens' StartOutboundVoiceContactResponse (Maybe Text)

The unique identifier of this contact within your Amazon Connect instance.

sovcrsResponseStatus :: Lens' StartOutboundVoiceContactResponse Int

• - | The response status code.