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