Connect / Client / start_outbound_voice_contact

start_outbound_voice_contact#

Connect.Client.start_outbound_voice_contact(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.start_outbound_voice_contact(
    Name='string',
    Description='string',
    References={
        'string': {
            'Value': 'string',
            'Type': 'URL'|'ATTACHMENT'|'NUMBER'|'STRING'|'DATE'|'EMAIL'
        }
    },
    RelatedContactId='string',
    DestinationPhoneNumber='string',
    ContactFlowId='string',
    InstanceId='string',
    ClientToken='string',
    SourcePhoneNumber='string',
    QueueId='string',
    Attributes={
        'string': 'string'
    },
    AnswerMachineDetectionConfig={
        'EnableAnswerMachineDetection': True|False,
        'AwaitAnswerMachinePrompt': True|False
    },
    CampaignId='string',
    TrafficType='GENERAL'|'CAMPAIGN'
)
Parameters:

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

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

  • References (dict) –

    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.

    • (string) –

      • (dict) –

        Well-formed data on a contact, used by agents to complete a contact request. You can have up to 4,096 UTF-8 bytes across all references for a contact.

        • Value (string) – [REQUIRED]

          A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).

        • Type (string) – [REQUIRED]

          The type of the reference. DATE must be of type Epoch timestamp.

  • RelatedContactId (string) – 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.

  • DestinationPhoneNumber (string) –

    [REQUIRED]

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

  • ContactFlowId (string) –

    [REQUIRED]

    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

  • InstanceId (string) –

    [REQUIRED]

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

  • ClientToken (string) –

    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.

    This field is autopopulated if not provided.

  • SourcePhoneNumber (string) – 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.

  • QueueId (string) – 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.

  • Attributes (dict) –

    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.

    • (string) –

      • (string) –

  • AnswerMachineDetectionConfig (dict) –

    Configuration of the answering machine detection for this outbound call.

    • EnableAnswerMachineDetection (boolean) –

      The flag to indicate if answer machine detection analysis needs to be performed for a voice call. If set to true, TrafficType must be set as CAMPAIGN.

    • AwaitAnswerMachinePrompt (boolean) –

      Wait for the answering machine prompt.

  • CampaignId (string) – The campaign identifier of the outbound communication.

  • TrafficType (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'ContactId': 'string'
}

Response Structure

  • (dict) –

    • ContactId (string) –

      The identifier of this contact within the Amazon Connect instance.

Exceptions