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 的要求，您必須至少啟用一個電子郵件地址才能接收域相關通知。要禁用域通知，請創建一個設置為接收它們的備用聯係人
• 重複的電子郵件地址
• 輸入的電子郵件地址無效
• 發現多種信用卡支付方式
• 發現多個銀行賬戶支付方式