pauseContact method

Future<void> pauseContact({
  1. required String contactId,
  2. required String instanceId,
  3. String? contactFlowId,
})

Allows pausing an ongoing task contact.

May throw AccessDeniedException. May throw ConflictException. May throw InternalServiceException. May throw InvalidParameterException. May throw InvalidRequestException. May throw LimitExceededException. May throw ResourceNotFoundException. May throw ThrottlingException.

Parameter contactId : The identifier of the contact.

Parameter instanceId : The identifier of the Connect Customer instance. You can find the instanceId in the ARN of the instance.

Parameter contactFlowId : The identifier of the flow.

Implementation

Future<void> pauseContact({
  required String contactId,
  required String instanceId,
  String? contactFlowId,
}) async {
  final $payload = <String, dynamic>{
    'ContactId': contactId,
    'InstanceId': instanceId,
    if (contactFlowId != null) 'ContactFlowId': contactFlowId,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri: '/contact/pause',
    exceptionFnMap: _exceptionFns,
  );
}