Create Participant

connect_create_participant

R Documentation

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

Description¶

Adds a new participant into an on-going chat contact or webRTC call. For more information, see Customize chat flow experiences by integrating custom participants or Enable multi-user web, in-app, and video calling.

Usage¶

connect_create_participant(InstanceId, ContactId, ClientToken,
  ParticipantDetails)

Arguments¶

InstanceId

[required] The identifier of the Connect Customer 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 Connect Customer. Supports contacts in the CHAT channel and VOICE (WebRTC) channels. For WebRTC calls, this should be the initial contact ID that was generated when the contact was first created (from the StartWebRTCContact API) in the VOICE channel

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 for chat contact and CUSTOMER for voice contact.

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",
    ParticipantCapabilities = list(
      Video = "SEND",
      ScreenShare = "SEND"
    )
  )
)