當前位置: 首頁>>編程示例 >>用法及示例精選 >>正文


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。非經特殊聲明,原始代碼版權歸原作者所有,本譯文未經允許或授權,請勿轉載或複製。