Prompt in Custom Ansible Module

what is the right way to prompt user for input in a custom module?

There isn’t, modules are designed to be run remotely in ‘batch’ mode.

Use vars_prompt to get user input to pass to module.