Create Participant

connect_create_participant

R Documentation

Adds a new participant into an on-going chat contact¶

Description¶

Adds a new participant into an on-going chat contact. For more information, see Customize chat flow experiences by integrating custom participants.

Usage¶

connect_create_participant(InstanceId, ContactId, ClientToken,
  ParticipantDetails)

Arguments¶

InstanceId

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

ContactId

[required] The identifier of the contact in this instance of Amazon Connect. Only contacts in the CHAT channel are supported.

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.

ParticipantDetails

[required] Information identifying the participant.

The only Valid value for ParticipantRole is CUSTOM_BOT.

DisplayName is Required.

Value¶

A list with the following syntax:

list(
  ParticipantCredentials = list(
    ParticipantToken = "string",
    Expiry = "string"
  ),
  ParticipantId = "string"
)

Request syntax¶

svc$create_participant(
  InstanceId = "string",
  ContactId = "string",
  ClientToken = "string",
  ParticipantDetails = list(
    ParticipantRole = "AGENT"|"CUSTOMER"|"SYSTEM"|"CUSTOM_BOT"|"SUPERVISOR",
    DisplayName = "string"
  )
)