PHP WHMCS UpdateClientDomain用法及代码示例

更新客户端域

请求参数

参数	类型	说明	必需的
action	string	“UpdateClientDomain”	Required
domainid	int	要更新的客户端域的 ID。	Required
dnsmanagement	bool	是否启用或禁用 DNS 管理。	Optional
emailforwarding	bool	是否启用或禁用电子邮件转发。	Optional
idprotection	bool	是否启用或禁用 ID 保护。	Optional
donotrenew	bool	是否阻止续订。	Optional
type	string	域名订单的类型(“注册”或“转让”)。	Optional
regdate	string	域的注册日期。格式：Y-m-d	Optional
nextduedate	string	域的下一个到期日。格式：Y-m-d	Optional
expirydate	string	域的到期日期。格式：Y-m-d	Optional
domain	string	要更改的域名。	Optional
firstpaymentamount	float	域上的第一笔付款数量。	Optional
recurringamount	float	自动续订发票的经常性数量。	Optional
registrar	string	与域关联的注册商。示例：enom、resellerclub、customregistrarname	Optional
regperiod	int	域名的注册期限。	Optional
paymentmethod	string	以系统格式关联的付款方式(例如，paypal)。	Optional
subscriptionid	string	要与域关联的订阅 ID。	Optional
status	string	要将域更改为的状态。	Optional
notes	string	域的管理员注释。	Optional
promoid	int	要关联的促销 ID。	Optional
autorecalc	bool	是否重新计算域的经常性数量(这将忽略任何传递的 $recurringamount)。	Optional
updatens	bool	是否在注册商处更新名称服务器。	Optional
ns1	string	第一个要保存的名称服务器。	Optional
ns2	string	要保存的第二个名称服务器。	Optional
ns3	string	要保存的第三个名称服务器。	Optional
ns4	string	要保存的第四个名称服务器。	Optional
ns5	string	要保存的第五个名称服务器。	Optional

响应参数

参数	类型	说明
result	string	操作结果：成功或错误
domainid	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' => 'UpdateClientDomain',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'domainid' => '1',
            'status' => 'Terminated',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

示例请求(本地 API)

$command = 'UpdateClientDomain';
$postData = array(
    'domainid' => '1',
    'status' => 'Terminated',
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

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

示例响应 JSON

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

错误响应

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

• 未找到域 ID
• 注册商未激活
• 需要 ns1 和 ns2
• 注册商错误消息