Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

BatchPutContact

Note

Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API.

Allows you to create a batch of contacts in Amazon Connect. The outbound campaigns capability ingests dial requests via the PutDialRequestBatch API. It then uses BatchPutContact to create contacts corresponding to those dial requests. If agents are available, the dial requests are dialed out, which results in a voice call. The resulting voice call uses the same contactId that was created by BatchPutContact.

Request Syntax


PUT /contact/batch/InstanceId HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "ContactDataRequestList": [ 
      { 
         "Attributes": { 
            "string" : "string" 
         },
         "Campaign": { 
            "CampaignId": "string"
         },
         "CustomerEndpoint": { 
            "Address": "string",
            "Type": "string"
         },
         "QueueId": "string",
         "RequestIdentifier": "string",
         "SystemEndpoint": { 
            "Address": "string",
            "Type": "string"
         }
      }
   ]
}

URI Request Parameters

The request uses the following URI parameters.

InstanceId

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

Request Body

The request accepts the following data in JSON format.

ClientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

Type: String

Length Constraints: Maximum length of 500.

Required: No

ContactDataRequestList

List of individual contact requests.

Type: Array of ContactDataRequest 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

{
   "FailedRequestList": [ 
      { 
         "FailureReasonCode": "string",
         "FailureReasonMessage": "string",
         "RequestIdentifier": "string"
      }
   ],
   "SuccessfulRequestList": [ 
      { 
         "ContactId": "string",
         "RequestIdentifier": "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.

FailedRequestList

List of requests for which contact creation failed.

Type: Array of FailedRequest objects

SuccessfulRequestList

List of requests for which contact was successfully created.

Type: Array of SuccessfulRequest objects

Errors

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

AccessDeniedException

You do not have sufficient permissions to perform this action.

HTTP Status Code: 403

IdempotencyException

An entity with the same name already exists.

HTTP Status Code: 409

InternalServiceException

Request processing failed because of an error or failure with the service.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

LimitExceededException

The allowed limit for the resource has been exceeded.

HTTP Status Code: 429

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404