PHP WHMCS ModuleCustom用法及代碼示例

為給定服務運行自定義模塊操作。

請求參數

參數	類型	說明	必需的
action	string	“ModuleCustom”	Required
serviceid	int	為其運行操作的服務 ID	Required
func_name	string	要運行的自定義函數的名稱	Required

響應參數

參數	類型	說明
result	string	操作結果：成功或錯誤

示例請求 (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' => 'ModuleCustom',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'serviceid' => '1',
            'func_name' => 'reboot',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

示例請求(本地 API)

$command = 'ModuleCustom';
$postData = array(
    'serviceid' => '1',
    'func_name' => 'reboot',
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

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

示例響應 JSON

{
    "result": "success"
}

錯誤響應

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

• 服務 ID 為必填項
• 未找到服務 ID
• 服務未分配給模塊
• 服務器響應消息