AmazonConnectCampaignService

2024/04/26 - AmazonConnectCampaignService - 3 updated api methods

Changes  This release adds support for specifying if Answering Machine should wait for prompt sound.

CreateCampaign (updated) Link ¶
Changes (request) 
{'outboundCallConfig': {'answerMachineDetectionConfig': {'awaitAnswerMachinePrompt': 'boolean'}}}

Creates a campaign for the specified Amazon Connect account. This API is idempotent.

See also: AWS API Documentation

Request Syntax

client.create_campaign(
    name='string',
    connectInstanceId='string',
    dialerConfig={
        'progressiveDialerConfig': {
            'bandwidthAllocation': 123.0,
            'dialingCapacity': 123.0
        },
        'predictiveDialerConfig': {
            'bandwidthAllocation': 123.0,
            'dialingCapacity': 123.0
        },
        'agentlessDialerConfig': {
            'dialingCapacity': 123.0
        }
    },
    outboundCallConfig={
        'connectContactFlowId': 'string',
        'connectSourcePhoneNumber': 'string',
        'connectQueueId': 'string',
        'answerMachineDetectionConfig': {
            'enableAnswerMachineDetection': True|False,
            'awaitAnswerMachinePrompt': True|False
        }
    },
    tags={
        'string': 'string'
    }
)
type name:

string

param name:

[REQUIRED]

The name of an Amazon Connect Campaign name.

type connectInstanceId:

string

param connectInstanceId:

[REQUIRED]

Amazon Connect Instance Id

type dialerConfig:

dict

param dialerConfig:

[REQUIRED]

The possible types of dialer config parameters

  • progressiveDialerConfig (dict) --

    Progressive Dialer config

    • bandwidthAllocation (float) -- [REQUIRED]

      The bandwidth allocation of a queue resource.

    • dialingCapacity (float) --

      Allocates dialing capacity for this campaign between multiple active campaigns

  • predictiveDialerConfig (dict) --

    Predictive Dialer config

    • bandwidthAllocation (float) -- [REQUIRED]

      The bandwidth allocation of a queue resource.

    • dialingCapacity (float) --

      Allocates dialing capacity for this campaign between multiple active campaigns

  • agentlessDialerConfig (dict) --

    Agentless Dialer config

    • dialingCapacity (float) --

      Allocates dialing capacity for this campaign between multiple active campaigns

type outboundCallConfig:

dict

param outboundCallConfig:

[REQUIRED]

The configuration used for outbound calls.

  • connectContactFlowId (string) -- [REQUIRED]

    The identifier of the contact flow for the outbound call.

  • connectSourcePhoneNumber (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.

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

  • answerMachineDetectionConfig (dict) --

    Answering Machine Detection config

    • enableAnswerMachineDetection (boolean) -- [REQUIRED]

      Enable or disable answering machine detection

    • awaitAnswerMachinePrompt (boolean) --

      Enable or disable await answer machine prompt

type tags:

dict

param tags:

Tag map with key and value.

  • (string) --

    Tag key.

    • (string) --

      Tag value.

rtype:

dict

returns:

Response Syntax

{
    'id': 'string',
    'arn': 'string',
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    The response for Create Campaign API

    • id (string) --

      Identifier representing a Campaign

    • arn (string) --

      The resource name of an Amazon Connect campaign.

    • tags (dict) --

      Tag map with key and value.

      • (string) --

        Tag key.

        • (string) --

          Tag value.

DescribeCampaign (updated) Link ¶
Changes (response) 
{'campaign': {'outboundCallConfig': {'answerMachineDetectionConfig': {'awaitAnswerMachinePrompt': 'boolean'}}}}

Describes the specific campaign.

See also: AWS API Documentation

Request Syntax

client.describe_campaign(
    id='string'
)
type id:

string

param id:

[REQUIRED]

Identifier representing a Campaign

rtype:

dict

returns:

Response Syntax

{
    'campaign': {
        'id': 'string',
        'arn': 'string',
        'name': 'string',
        'connectInstanceId': 'string',
        'dialerConfig': {
            'progressiveDialerConfig': {
                'bandwidthAllocation': 123.0,
                'dialingCapacity': 123.0
            },
            'predictiveDialerConfig': {
                'bandwidthAllocation': 123.0,
                'dialingCapacity': 123.0
            },
            'agentlessDialerConfig': {
                'dialingCapacity': 123.0
            }
        },
        'outboundCallConfig': {
            'connectContactFlowId': 'string',
            'connectSourcePhoneNumber': 'string',
            'connectQueueId': 'string',
            'answerMachineDetectionConfig': {
                'enableAnswerMachineDetection': True|False,
                'awaitAnswerMachinePrompt': True|False
            }
        },
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    DescribeCampaignResponse

    • campaign (dict) --

      An Amazon Connect campaign.

      • id (string) --

        Identifier representing a Campaign

      • arn (string) --

        The resource name of an Amazon Connect campaign.

      • name (string) --

        The name of an Amazon Connect Campaign name.

      • connectInstanceId (string) --

        Amazon Connect Instance Id

      • dialerConfig (dict) --

        The possible types of dialer config parameters

        • progressiveDialerConfig (dict) --

          Progressive Dialer config

          • bandwidthAllocation (float) --

            The bandwidth allocation of a queue resource.

          • dialingCapacity (float) --

            Allocates dialing capacity for this campaign between multiple active campaigns

        • predictiveDialerConfig (dict) --

          Predictive Dialer config

          • bandwidthAllocation (float) --

            The bandwidth allocation of a queue resource.

          • dialingCapacity (float) --

            Allocates dialing capacity for this campaign between multiple active campaigns

        • agentlessDialerConfig (dict) --

          Agentless Dialer config

          • dialingCapacity (float) --

            Allocates dialing capacity for this campaign between multiple active campaigns

      • outboundCallConfig (dict) --

        The configuration used for outbound calls.

        • connectContactFlowId (string) --

          The identifier of the contact flow for the outbound call.

        • connectSourcePhoneNumber (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.

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

        • answerMachineDetectionConfig (dict) --

          Answering Machine Detection config

          • enableAnswerMachineDetection (boolean) --

            Enable or disable answering machine detection

          • awaitAnswerMachinePrompt (boolean) --

            Enable or disable await answer machine prompt

      • tags (dict) --

        Tag map with key and value.

        • (string) --

          Tag key.

          • (string) --

            Tag value.

UpdateCampaignOutboundCallConfig (updated) Link ¶
Changes (request) 
{'answerMachineDetectionConfig': {'awaitAnswerMachinePrompt': 'boolean'}}

Updates the outbound call config of a campaign. This API is idempotent.

See also: AWS API Documentation

Request Syntax

client.update_campaign_outbound_call_config(
    id='string',
    connectContactFlowId='string',
    connectSourcePhoneNumber='string',
    answerMachineDetectionConfig={
        'enableAnswerMachineDetection': True|False,
        'awaitAnswerMachinePrompt': True|False
    }
)
type id:

string

param id:

[REQUIRED]

Identifier representing a Campaign

type connectContactFlowId:

string

param connectContactFlowId:

The identifier of the contact flow for the outbound call.

type connectSourcePhoneNumber:

string

param connectSourcePhoneNumber:

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 answerMachineDetectionConfig:

dict

param answerMachineDetectionConfig:

Answering Machine Detection config

  • enableAnswerMachineDetection (boolean) -- [REQUIRED]

    Enable or disable answering machine detection

  • awaitAnswerMachinePrompt (boolean) --

    Enable or disable await answer machine prompt

returns:

None