Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

StartOutboundVoiceContact

Places an outbound call to a contact, and then initiates the flow. It performs the actions in the flow that's specified (in ContactFlowId).

Agents do not initiate the outbound API, which means that they do not dial the contact. If the flow places an outbound call to a contact, and then puts the contact in queue, the call is then routed to the agent, like any other inbound case.

There is a 60-second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.

Note

UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.

Note

Campaign calls are not allowed by default. Before you can make a call with TrafficType = CAMPAIGN, you must submit a service quota increase request to the quota Amazon Connect campaigns.

Request Syntax


PUT /contact/outbound-voice HTTP/1.1
Content-type: application/json

{
   "AnswerMachineDetectionConfig": { 
      "AwaitAnswerMachinePrompt": boolean,
      "EnableAnswerMachineDetection": boolean
   },
   "Attributes": { 
      "string" : "string" 
   },
   "CampaignId": "string",
   "ClientToken": "string",
   "ContactFlowId": "string",
   "Description": "string",
   "DestinationPhoneNumber": "string",
   "InstanceId": "string",
   "Name": "string",
   "QueueId": "string",
   "References": { 
      "string" : { 
         "Arn": "string",
         "Status": "string",
         "StatusReason": "string",
         "Type": "string",
         "Value": "string"
      }
   },
   "RelatedContactId": "string",
   "SourcePhoneNumber": "string",
   "TrafficType": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

AnswerMachineDetectionConfig

Configuration of the answering machine detection for this outbound call.

Type: AnswerMachineDetectionConfig object

Required: No

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.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 32767.

Value Length Constraints: Minimum length of 0. Maximum length of 32767.

Required: No

CampaignId

The campaign identifier of the outbound communication.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: No

ClientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS 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.

Type: String

Length Constraints: Maximum length of 500.

Required: No

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

Type: String

Length Constraints: Maximum length of 500.

Required: Yes

Description

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 4096.

Required: No

DestinationPhoneNumber

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

Type: String

Pattern: \\+[1-9]\\d{1,14}$

Required: Yes

InstanceId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

Name

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Required: No

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.

Type: String

Required: No

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.

Type: String to Reference object map

Key Length Constraints: Minimum length of 1. Maximum length of 4096.

Required: No

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No

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.

Type: String

Pattern: \\+[1-9]\\d{1,14}$

Required: No

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.

Type: String

Valid Values: GENERAL | CAMPAIGN

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ContactId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ContactId

The identifier of this contact within the Amazon Connect instance.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Errors

For information about the errors that are common to all actions, see Common Errors.

DestinationNotAllowedException

Outbound calls to the destination number are not allowed.

HTTP Status Code: 403

InternalServiceException

Request processing failed because of an error or failure with the service.

HTTP Status Code: 500

InvalidParameterException

One or more of the specified parameters are not valid.

HTTP Status Code: 400

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

LimitExceededException

The allowed limit for the resource has been exceeded.

HTTP Status Code: 429

OutboundContactNotPermittedException

The contact is not permitted.

HTTP Status Code: 403

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404