当前位置: 首页>>代码示例 >>用法及示例精选 >>正文


PHP WHMCS AddContact用法及代码示例


将联系人添加到客户帐户。

请求参数

参数 类型 说明 必需的
action string “AddContact” Required
clientid int Required
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 2 个字符的 ISO 国家代码 Optional
phonenumber string Optional
tax_id 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

响应参数

参数 类型 说明
result string 操作结果:成功或错误
contactid 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' => 'AddContact',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'clientid' => '1',
            'firstname' => 'Jane',
            'lastname' => 'Doe',
            'email' => '[email protected]',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

示例请求(本地 API)

$command = 'AddContact';
$postData = array(
    'clientid' => '1',
    'firstname' => 'Jane',
    '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",
    "contactid": "1"
}

警告响应

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

可能的警告消息包括:

  • 不再支持子帐户。请使用AddUser和CreateClientInvite

错误响应

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

  • 未找到客户端 ID
  • 重复的电子邮件地址

相关用法


注:本文由纯净天空筛选整理自whmcs.com大神的英文原创作品 AddContact。非经特殊声明,原始代码版权归原作者所有,本译文未经允许或授权,请勿转载或复制。