PHP WHMCS UpdateClient用法及代码示例

使用传递的参数更新客户端。

请求参数

参数	类型	说明	必需的
action	string	“UpdateClient”	Required
clientid	int	要更新的客户端的 ID。	Optional
clientemail	string	要更新的客户的电子邮件地址。 $clientid 或 $clientemail 是必需的。	Optional
firstname	string		Optional
lastname	string		Optional
companyname	string		Optional
email	string		Optional
address1	string		Optional
address2	string		Optional
city	string		Optional
state	string		Optional
postcode	string		Optional
country	string	Two-character ISO 国家代码。	Optional
phonenumber	string		Optional
tax_id	string	客户税号。	Optional
cardtype	string	信用卡类型。提供全名：Visa、Mastercard、American Express等。	Deprecated
cardnum	string	信用卡号码。	Deprecated
expdate	string	格式：MMYY	Deprecated
startdate	string	格式：MMYY(如果适用)	Deprecated
issuenumber	string	信用卡发行号(如适用)。	Deprecated
cvv	string	信用卡 CVV 号码(不会被存储)。	Deprecated
bankcode	string	客户银行账户代码(如适用)。	Deprecated
bankacct	string	客户银行帐号(如适用)。	Deprecated
currency	int	来自 tblcurrencies 的货币 ID。	Optional
groupid	int	来自 tblclientgroups 的客户端组 ID。	Optional
customfields	string	Base64 编码的自定义字段值的序列化数组。	Optional
language	string	默认语言设置。提供全名：‘english’, ‘french’等。	Optional
clientip	string	用户的 IP 地址。	Optional
notes	string	Admin-only 注释。	Optional
status	string	状态。例如，“Active”。	Optional
paymentmethod	string	默认付款方式。	Optional
email_preferences[general]	bool	客户是否应该接收一般电子邮件。	Optional
email_preferences[product]	bool	客户是否应该收到产品电子邮件。	Optional
email_preferences[domain]	bool	客户端是否应接收域电子邮件。	Optional
email_preferences[invoice]	bool	客户是否应收到发票电子邮件。	Optional
email_preferences[support]	bool	客户是否应该收到支持电子邮件。	Optional
email_preferences[affiliate]	bool	客户是否应该收到附属电子邮件。	Optional
marketingoptin	bool	将此设置为 ‘true’ 以选择客户加入营销电子邮件。	Optional
clearcreditcard	bool	将此设置为‘true’ 以清除存储的信用卡详细信息。	Optional
skipvalidation	bool	将此设置为 ‘true’ 以忽略必填字段验证。	Optional
latefeeoveride	bool	是否覆盖账户的滞纳金设置。	Optional
overideduenotices	bool	是否覆盖帐户的过期通知设置。	Optional
taxexempt	bool	该帐户是否免征税款。	Optional
separateinvoices	bool	是否将共享到期日期和付款方式的项目分组到帐户的一张发票中。	Optional
disableautocc	bool	是否启用或禁用自动信用卡处理。	Optional
overrideautoclose	bool	是否启用或禁用自动信用卡处理。	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' => 'UpdateClient',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'clientid' => '1',
            'firstname' => 'John',
            'lastname' => 'Doe',
            'email' => '[email protected]',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

示例请求(本地 API)

$command = 'UpdateClient';
$postData = array(
    'clientid' => '1',
    'firstname' => 'John',
    'lastname' => 'Doe',
    'email' => '[email protected]',
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

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

示例响应 JSON

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

警告响应

使用已删除或标记为已弃用的 API 函数时会返回警告响应。我们建议遵循警告中的任何建议操作，以确保未来的兼容性。

可能的警告消息包括：

• 信用卡相关参数现已弃用，可能会在未来版本中删除。请改用AddPayMethod 或UpdatePayMethod。
• 信用卡相关参数现已弃用，可能会在未来版本中删除。请改用DeletePayMethod。

错误响应

可能的错误条件响应包括：

• 未找到客户端 ID
• 根据 ICANN 的要求，您必须至少启用一个电子邮件地址才能接收域相关通知。要禁用域通知，请创建一个设置为接收它们的备用联系人
• 重复的电子邮件地址
• 输入的电子邮件地址无效
• 发现多种信用卡支付方式
• 发现多个银行账户支付方式