PHP WHMCS DeleteClient用法及代碼示例

刪除客戶端。

刪除客戶記錄和所有相關數據。此操作無法撤消。

請求參數

參數	類型	說明	必需的
action	string	“DeleteClient”	Required
clientid	int	要刪除的客戶ID	Required
deleteusers	bool	刪除不與任何其他客戶端關聯的任何用戶。	Optional
deletetransactions	bool	刪除此帳戶上的所有交易	Optional

響應參數

參數	類型	說明
result	string	操作結果：成功或錯誤
clientid	int	被刪除的客戶 ID

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

示例請求(本地 API)

$command = 'DeleteClient';
$postData = array(
    'clientid' => '1',
    'deleteusers' => false,
    'deletetransactions' => true,
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

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

示例響應 JSON

{
    "result": "success",
    "clientid": "1"
}

錯誤響應

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

• 未找到客戶端 ID
• 客戶端刪除失敗：xxxxxx