Start Contact Streaming

connect_start_contact_streaming

R Documentation

Initiates real-time message streaming for a new chat contact

Description

Initiates real-time message streaming for a new chat contact.

For more information about message streaming, see Enable real-time chat message streaming in the Amazon Connect Administrator Guide.

For more information about chat, see the following topics in the Amazon Connect Administrator Guide:

• Concepts: Web and mobile messaging capabilities in Amazon Connect

• Amazon Connect Chat security best practices

Usage

connect_start_contact_streaming(InstanceId, ContactId,
  ChatStreamingConfiguration, ClientToken)

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. This is the identifier of the contact associated with the first interaction with the contact center.

ChatStreamingConfiguration

[required] The streaming configuration, such as the Amazon SNS streaming endpoint.

ClientToken

[required] 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.

Value

A list with the following syntax:

list(
  StreamingId = "string"
)

Request syntax

svc$start_contact_streaming(
  InstanceId = "string",
  ContactId = "string",
  ChatStreamingConfiguration = list(
    StreamingEndpointArn = "string"
  ),
  ClientToken = "string"
)