PHP WHMCS SetConfigurationValue用法及代碼示例

僅通過本地 API 設置係統配置值。

請求參數

參數	類型	說明	必需的
action	string	“SetConfigurationValue”	Required
setting	string	要更改的設置名稱	Required
value	string	要設置的值。將值留空以取消設置。	Required

響應參數

參數	類型	說明
result	string	操作結果：成功或錯誤
value_changed	bool	確認值已更改

示例請求 (CURL)

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://www.example.com/includes/api.php');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
    http_build_query(
        array(
            'action' => 'SetConfigurationValue',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'setting' => 'PremiumDomains',
            'value' => '',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

示例請求(本地 API)

$command = 'SetConfigurationValue';
$postData = array(
    'setting' => 'PremiumDomains',
    'value' => '',
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

$results = localAPI($command, $postData, $adminUsername);
print_r($results);

示例響應 JSON

{
    "result": "success",
    "value_changed": "true"
}

錯誤響應

可能的錯誤條件響應包括：

• 需要設置參數
• 參數設置名稱無效
• 參數值是必需的