Menu
Amazon Connect Service
API Reference (API Version 2017-08-08)

StopContact

Ends the contact initiated by the StartOutboundVoiceContact operation.

If you are using an IAM account, it must have permissions to the connect:StopContact operation.

Request Syntax

POST /contact/stop HTTP/1.1 Content-type: application/json { "ContactId": "string", "InstanceId": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ContactId

The unique identifier of the contact to end. This is the ContactId value returned from the StartOutboundVoiceContact operation.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

InstanceId

The identifier of the Amazon Connect instance in which the contact is active.

Type: String

Required: Yes

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

ContactNotFoundException

The contact with the specified ID is not active or does not exist.

HTTP Status Code: 410

InternalServiceException

Request processing failed due to an error or failure with the service.

HTTP Status Code: 500

InvalidParameterException

One or more of the parameters provided to the operation are not valid.

HTTP Status Code: 400

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

Example

Example policy that grants permissions to this operation:

{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "connect:StopContact" ], "Resource": "arn:aws:connect:us-west-2:854005473701:instance/97940ff5-2ce5-424b-a570-8d954e6862bd/contact/*" } ] }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: