StopContact
Ends the specified contact. Use this API to stop queued callbacks. It does not work for voice contacts that use the following initiation methods:
-
DISCONNECT
-
TRANSFER
-
QUEUE_TRANSFER
Chat and task contacts can be terminated in any state, regardless of initiation method.
Request Syntax
POST /contact/stop HTTP/1.1
Content-type: application/json
{
"ContactId": "string",
"DisconnectReason": {
"Code": "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 ID of the contact.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: Yes
- DisconnectReason
-
The reason a contact can be disconnected. Only Amazon Connect outbound campaigns can provide this field.
Type: DisconnectReason object
Required: No
- InstanceId
-
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
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. Applies to Voice calls only, not to Chat or Task contacts.
HTTP Status Code: 410
- InternalServiceException
-
Request processing failed because of an error or failure with the service.
HTTP Status Code: 500
- InvalidParameterException
-
One or more of the specified parameters 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
