[ aws . connectcampaigns ]

put-dial-request-batch

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  put-dial-request-batch
--dial-requests <value>
--id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--dial-requests (list)

A list of dial requests.

(structure)

A dial request for a campaign.

attributes -> (map)

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.

key -> (string)

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

value -> (string)

The value of the attribute.

clientToken -> (string)

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

expirationTime -> (timestamp)

Timestamp with no UTC offset or timezone

phoneNumber -> (string)

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

Shorthand Syntax:

attributes={KeyName1=string,KeyName2=string},clientToken=string,expirationTime=timestamp,phoneNumber=string ...

JSON Syntax:

[
  {
    "attributes": {"string": "string"
      ...},
    "clientToken": "string",
    "expirationTime": timestamp,
    "phoneNumber": "string"
  }
  ...
]

--id (string)

Identifier representing a Campaign

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

failedRequests -> (list)

A list of failed requests.

(structure)

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.

(structure)

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