AmazonConnectCampaignService

2023/08/31 - AmazonConnectCampaignService - 3 updated api methods

Changes  Amazon Connect outbound campaigns has launched agentless dialing mode which enables customers to make automated outbound calls without agent engagement. This release updates three of the campaign management API's to support the new agentless dialing mode and the new dialing capacity field.

CreateCampaign (updated) Link ¶
Changes (request) 
{'dialerConfig': {'agentlessDialerConfig': {'dialingCapacity': 'double'},
                  'predictiveDialerConfig': {'dialingCapacity': 'double'},
                  'progressiveDialerConfig': {'dialingCapacity': 'double'}}}

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
        }
    },
    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

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': {'dialerConfig': {'agentlessDialerConfig': {'dialingCapacity': 'double'},
                               'predictiveDialerConfig': {'dialingCapacity': 'double'},
                               'progressiveDialerConfig': {'dialingCapacity': 'double'}}}}

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
            }
        },
        '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

      • tags (dict) --

        Tag map with key and value.

        • (string) --

          Tag key.

          • (string) --

            Tag value.

UpdateCampaignDialerConfig (updated) Link ¶
Changes (request) 
{'dialerConfig': {'agentlessDialerConfig': {'dialingCapacity': 'double'},
                  'predictiveDialerConfig': {'dialingCapacity': 'double'},
                  'progressiveDialerConfig': {'dialingCapacity': 'double'}}}

Updates the dialer config of a campaign. This API is idempotent.

See also: AWS API Documentation

Request Syntax

client.update_campaign_dialer_config(
    id='string',
    dialerConfig={
        'progressiveDialerConfig': {
            'bandwidthAllocation': 123.0,
            'dialingCapacity': 123.0
        },
        'predictiveDialerConfig': {
            'bandwidthAllocation': 123.0,
            'dialingCapacity': 123.0
        },
        'agentlessDialerConfig': {
            'dialingCapacity': 123.0
        }
    }
)
type id

string

param id

[REQUIRED]

Identifier representing a Campaign

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

returns

None