ContextQMD
Back to Astrbot

Connect to VoceChat

docs/en/platform/vocechat.md

4.24.21.9 KB
Original Source

Connect to VoceChat

[!TIP] AstrBot does not include this adapter by default. Install astrbot_plugin_vocechat, developed by HikariFroya.

[!WARNING] This adapter is community-maintained and not officially maintained by AstrBot.

Deploy VoceChat

VoceChat is an open-source instant messaging platform with simple multi-platform deployment.

See deployment methods on the VoceChat official website.

Install astrbot_plugin_vocechat

In AstrBot Dashboard Plugin Market, search for astrbot_plugin_vocechat and install it.

After installation, go to Bots -> + Create Bot -> VoceChat. If VoceChat is missing, restart AstrBot or verify plugin installation.

Enable the adapter in the configuration dialog.

Configuration

  • vocechat_server_url (required): full VoceChat server URL, e.g. http://localhost:3009 or https://your.vocechat.domain (no trailing /).
  • api_key (required): API key generated for the bot account in VoceChat.
  • webhook_path (recommended default/custom): webhook path used by AstrBot to receive VoceChat messages, e.g. /vocechat_webhook.
  • webhook_listen_host (usually 0.0.0.0): listen host for AstrBot webhook server.
  • webhook_port (required): listen port for AstrBot webhook server, e.g. 8080.
  • get_user_nickname_from_api (boolean, default true): fetch nickname via VoceChat API.
  • send_plain_as_markdown (boolean, default false): send plain text in markdown format.
  • default_bot_self_uid (required): UID of your VoceChat bot account.

After configuration, click Save and test in VoceChat.

Issue Reporting

If needed, report issues to: