ConnectCampaignService / Client / put_dial_request_batch

put_dial_request_batch#

ConnectCampaignService.Client.put_dial_request_batch(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.put_dial_request_batch(
    id='string',
    dialRequests=[
        {
            'clientToken': 'string',
            'phoneNumber': 'string',
            'expirationTime': datetime(2015, 1, 1),
            'attributes': {
                'string': 'string'
            }
        },
    ]
)
Parameters:

  • id (string) –

    [REQUIRED]

    Identifier representing a Campaign

  • dialRequests (list) –

    [REQUIRED]

    A list of dial requests.

    • (dict) –

      A dial request for a campaign.

      • clientToken (string) – [REQUIRED]

        Client provided parameter used for idempotency. Its value must be unique for each request.

      • phoneNumber (string) – [REQUIRED]

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

      • expirationTime (datetime) – [REQUIRED]

        Timestamp with no UTC offset or timezone

      • attributes (dict) – [REQUIRED]

        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.

        • (string) –

          The key of the attribute. Attribute keys can include only alphanumeric, dash, and underscore characters.

          • (string) –

            The value of the attribute.

Return type:

dict

Returns:

Response Syntax

{
    'successfulRequests': [
        {
            'clientToken': 'string',
            'id': 'string'
        },
    ],
    'failedRequests': [
        {
            'clientToken': 'string',
            'id': 'string',
            'failureCode': 'InvalidInput'|'RequestThrottled'|'UnknownError'
        },
    ]
}

Response Structure

  • (dict) –

    PutDialRequestBatchResponse

    • successfulRequests (list) –

      A list of successful requests identified by the unique client token.

      • (dict) –

        A successful request identified by the unique client token.

        • clientToken (string) –

          Client provided parameter used for idempotency. Its value must be unique for each request.

        • id (string) –

          Identifier representing a Dial request

    • failedRequests (list) –

      A list of failed requests.

      • (dict) –

        A failed request identified by the unique client token.

        • clientToken (string) –

          Client provided parameter used for idempotency. Its value must be unique for each request.

        • id (string) –

          Identifier representing a Dial request

        • failureCode (string) –

          A predefined code indicating the error that caused the failure.

Exceptions