> For the complete documentation index, see [llms.txt](https://wiki.vtx.team/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wiki.vtx.team/panel/sspanel-whmcs-guest-config.md).

# SSPanel 和 WHMCS 的 guest\_config 接口（必要）

SSPanel 和 WHMCS 因没有相应接口以查询注册验证码、邮箱后缀白名单、登陆标语，特增加 guest\_config 接口已解决此问题。

{% hint style="danger" %}
1.3.2之后，SSPanel 和 WHMCS 通过检测该 guest\_config 接口测活 API ，所以 SSPanel 和WHMCS 必须添加此接口！
{% endhint %}

### 使用方法

在网站根目录 `/public` 添加 `guest_config.txt` 文件，内容如下：

```
{
	"is_email_verify": true,
	"is_invite_force": false,
	"email_whitelist_suffix": [
		"gmail.com",
		"outlook.com"
	],
	"app_description": "欢迎使用xxxx"
}
```

{% hint style="info" %}
"is\_email\_verify" 为是否开启邮箱验证，`false` 为不开启，`true` 为开启
{% endhint %}

{% hint style="info" %}
"is\_invite\_force" 为是否开启强制邀请，`false` 为不开启，`true` 为开启
{% endhint %}

{% hint style="info" %}
"email\_whitelist\_suffix" 为邮箱后缀白名单，请按格式填写。

```
"email_whitelist_suffix": null #不限制邮箱后缀
```

{% endhint %}

{% hint style="info" %}
"app\_description" 为客户端登陆界面左下角机场名称下的简介，可随意自定义
{% endhint %}