PutDialRequestBatch - Amazon Connect High-Volume Outbound Communications

PutDialRequestBatch

Note

Only the Amazon Pinpoint service principle is allowed to assume a role in your account and call this API.

Takes in a list of DialRequests to be dialed as part of a high-volume outbound campaign.

Request Syntax

PUT /campaigns/id/dial-requests HTTP/1.1 Content-type: application/json { "dialRequests": [ { "attributes": { "string" : "string" }, "clientToken": "string", "expirationTime": number, "phoneNumber": "string" } ] }

URI Request Parameters

The request uses the following URI parameters.

id

The identifier of the campaign.

Length Constraints: Minimum length of 0. Maximum length of 256.

Required: Yes

Request Body

The request accepts the following data in JSON format.

dialRequests

Dial requests.

Type: Array of DialRequest objects

Array Members: Minimum number of 1 item. Maximum number of 25 items.

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "failedRequests": [ { "clientToken": "string", "failureCode": "string", "id": "string" } ], "successfulRequests": [ { "clientToken": "string", "id": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

failedRequests

Failed dial requests.

Type: Array of FailedRequest objects

Array Members: Minimum number of 0 items. Maximum number of 25 items.

successfulRequests

Successful dial requests.

Type: Array of SuccessfulRequest objects

Array Members: Minimum number of 0 items. Maximum number of 25 items.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

InternalServerException

This exception occurs when there is an internal failure in the high-volume outbound communications.

HTTP Status Code: 500

InvalidCampaignStateException

An attempt was made to modify a campaign that is in a state that is not valid. Check your campaign to ensure that it is in a valid state before retrying the operation.

HTTP Status Code: 409

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWSservice.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: