Start Web Rtc Contact

connect_start_web_rtc_contact

R Documentation

Places an inbound in-app, web, or video call to a contact, and then initiates the flow

Description

Places an inbound in-app, web, or video call to a contact, and then initiates the flow. It performs the actions in the flow that are specified (in ContactFlowId) and present in the Amazon Connect instance (specified as InstanceId).

Usage

connect_start_web_rtc_contact(Attributes, ClientToken, ContactFlowId,
  InstanceId, AllowedCapabilities, ParticipantDetails, RelatedContactId,
  References, Description)

Arguments

Attributes

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, -, and _ characters.

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.

The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.

ContactFlowId

[required] The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

InstanceId

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

AllowedCapabilities

Information about the video sharing capabilities of the participants (customer, agent).

ParticipantDetails

[required]

RelatedContactId

The unique identifier for an Amazon Connect contact. This identifier is related to the contact starting.

References

A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL. ATTACHMENT is not a supported reference type during task creation.

Description

A description of the task that is shown to an agent in the Contact Control Panel (CCP).

Value

A list with the following syntax:

list(
  ConnectionData = list(
    Attendee = list(
      AttendeeId = "string",
      JoinToken = "string"
    ),
    Meeting = list(
      MediaRegion = "string",
      MediaPlacement = list(
        AudioHostUrl = "string",
        AudioFallbackUrl = "string",
        SignalingUrl = "string",
        TurnControlUrl = "string",
        EventIngestionUrl = "string"
      ),
      MeetingFeatures = list(
        Audio = list(
          EchoReduction = "AVAILABLE"|"UNAVAILABLE"
        )
      ),
      MeetingId = "string"
    )
  ),
  ContactId = "string",
  ParticipantId = "string",
  ParticipantToken = "string"
)

Request syntax

svc$start_web_rtc_contact(
  Attributes = list(
    "string"
  ),
  ClientToken = "string",
  ContactFlowId = "string",
  InstanceId = "string",
  AllowedCapabilities = list(
    Customer = list(
      Video = "SEND"
    ),
    Agent = list(
      Video = "SEND"
    )
  ),
  ParticipantDetails = list(
    DisplayName = "string"
  ),
  RelatedContactId = "string",
  References = list(
    list(
      Value = "string",
      Type = "URL"|"ATTACHMENT"|"NUMBER"|"STRING"|"DATE"|"EMAIL"
    )
  ),
  Description = "string"
)