PHP WHMCS DeactivateModule用法及代碼示例

停用給定的模塊。

請求參數

參數	類型	說明	必需的
action	string	“DeactivateModule”	Required
moduleType	string	要停用的模塊類型	Required
moduleName	string	要停用的模塊名稱	Required
newGateway	string	停用網關模塊時將各個實體切換到的網關。	Optional

響應參數

參數	類型	說明
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' => 'DeactivateModule',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'moduleType' => 'gateway',
            'moduleName' => 'paypal',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

示例請求(本地 API)

$command = 'DeactivateModule';
$postData = array(
    'moduleType' => 'gateway',
    'moduleName' => 'paypal',
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

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

示例響應 JSON

{
    "result": "success"
}

錯誤響應

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

• 提供的模塊類型無效。支持的模塊類型包括：xxx
• 提供的模塊名稱無效。
• 模塊類型不支持模塊停用。
• 停用失敗：xxx
• 發生意外錯誤：xxx