StopContactStreamingCommand

Suggest an Edit

Ends message streaming on a specified contact. To restart message streaming on that contact, call the StartContactStreaming  API.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ConnectClient, StopContactStreamingCommand } from "@aws-sdk/client-connect"; // ES Modules import
// const { ConnectClient, StopContactStreamingCommand } = require("@aws-sdk/client-connect"); // CommonJS import
const client = new ConnectClient(config);
const input = { // StopContactStreamingRequest
  InstanceId: "STRING_VALUE", // required
  ContactId: "STRING_VALUE", // required
  StreamingId: "STRING_VALUE", // required
};
const command = new StopContactStreamingCommand(input);
const response = await client.send(command);
// {};

StopContactStreamingCommand Input

See StopContactStreamingCommandInput for more details

Parameter
Type
Description
ContactId
Required
string | undefined

The identifier of the contact. This is the identifier of the contact that is associated with the first interaction with the contact center.

InstanceId
Required
string | undefined

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

StreamingId
Required
string | undefined

The identifier of the streaming configuration enabled.

StopContactStreamingCommand Output

See StopContactStreamingCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
InternalServiceException
server

Request processing failed because of an error or failure with the service.

InvalidParameterException
client

One or more of the specified parameters are not valid.

InvalidRequestException
client

The request is not valid.

ResourceNotFoundException
client

The specified resource was not found.

ConnectServiceException
Base exception class for all service exceptions from Connect service.