put_dial_request_batch

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(
    dialRequests=[
        {
            'attributes': {
                'string': 'string'
            },
            'clientToken': 'string',
            'expirationTime': datetime(2015, 1, 1),
            'phoneNumber': 'string'
        },
    ],
    id='string'
)

Parameters

• dialRequests (list) --

  [REQUIRED]

  A list of dial requests.

  • (dict) --

    A dial request for a campaign.

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

    • clientToken (string) -- [REQUIRED]

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

    • expirationTime (datetime) -- [REQUIRED]

      Timestamp with no UTC offset or timezone

    • phoneNumber (string) -- [REQUIRED]

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

• id (string) --

  [REQUIRED]

  Identifier representing a Campaign

Return type

dict

Returns

Response Syntax

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

Response Structure

• (dict) --

  PutDialRequestBatchResponse

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

      • failureCode (string) --

        A predefined code indicating the error that caused the failure.

      • id (string) --

        Identifier representing a Dial request

  • 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

Exceptions

• ConnectCampaignService.Client.exceptions.InternalServerException
• ConnectCampaignService.Client.exceptions.ResourceNotFoundException
• ConnectCampaignService.Client.exceptions.ValidationException
• ConnectCampaignService.Client.exceptions.ConflictException
• ConnectCampaignService.Client.exceptions.InvalidCampaignStateException
• ConnectCampaignService.Client.exceptions.AccessDeniedException
• ConnectCampaignService.Client.exceptions.ThrottlingException