AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Ends the specified contact. Use this API to stop queued callbacks. It does not work for voice contacts that use the following initiation methods:

Chat and task contacts can be terminated in any state, regardless of initiation method.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginStopContact and EndStopContact.

Namespace: Amazon.Connect
Assembly: AWSSDK.Connect.dll
Version: 3.x.y.z

Syntax

C#
public abstract Task<StopContactResponse> StopContactAsync(
         StopContactRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.Connect.Model.StopContactRequest

Container for the necessary parameters to execute the StopContact service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the StopContact service method, as returned by Connect.

Exceptions

ExceptionCondition
ContactNotFoundException The contact with the specified ID is not active or does not exist. Applies to Voice calls only, not to Chat or Task contacts.
InternalServiceException Request processing failed because of an error or failure with the service.
InvalidParameterException One or more of the specified parameters are not valid.
InvalidRequestException The request is not valid.
ResourceNotFoundException The specified resource was not found.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also