Ends the specified contact¶

Description¶

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
• EXTERNAL_OUTBOUND
• MONITOR

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

Usage¶

connect_stop_contact(ContactId, InstanceId, DisconnectReason)

Arguments¶

• ContactId

  [required] The ID of the contact.

• InstanceId

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

• DisconnectReason

  The reason a contact can be disconnected. Only Connect Customer outbound campaigns can provide this field. For a list and description of all the possible disconnect reasons by channel (including outbound campaign voice contacts) see DisconnectReason under ContactTraceRecord in the Connect Customer Administrator Guide.

Value¶

An empty list.

Request syntax¶

svc$stop_contact(
  ContactId = "string",
  InstanceId = "string",
  DisconnectReason = list(
    Code = "string"
  )
)