Batch Put Contact

connect_batch_put_contact

R Documentation

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

Description

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.

Usage

connect_batch_put_contact(ClientToken, InstanceId,
  ContactDataRequestList)

Arguments

ClientToken

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

InstanceId

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

ContactDataRequestList

[required] List of individual contact requests.

Value

A list with the following syntax:

list(
  SuccessfulRequestList = list(
    list(
      RequestIdentifier = "string",
      ContactId = "string"
    )
  ),
  FailedRequestList = list(
    list(
      RequestIdentifier = "string",
      FailureReasonCode = "INVALID_ATTRIBUTE_KEY"|"INVALID_CUSTOMER_ENDPOINT"|"INVALID_SYSTEM_ENDPOINT"|"INVALID_QUEUE"|"MISSING_CAMPAIGN"|"MISSING_CUSTOMER_ENDPOINT"|"MISSING_QUEUE_ID_AND_SYSTEM_ENDPOINT"|"REQUEST_THROTTLED"|"IDEMPOTENCY_EXCEPTION"|"INTERNAL_ERROR",
      FailureReasonMessage = "string"
    )
  )
)

Request syntax

svc$batch_put_contact(
  ClientToken = "string",
  InstanceId = "string",
  ContactDataRequestList = list(
    list(
      SystemEndpoint = list(
        Type = "TELEPHONE_NUMBER"|"VOIP"|"CONTACT_FLOW",
        Address = "string"
      ),
      CustomerEndpoint = list(
        Type = "TELEPHONE_NUMBER"|"VOIP"|"CONTACT_FLOW",
        Address = "string"
      ),
      RequestIdentifier = "string",
      QueueId = "string",
      Attributes = list(
        "string"
      ),
      Campaign = list(
        CampaignId = "string"
      )
    )
  )
)