PHP WHMCS GetContacts用法及代码示例

获取符合通过条件的客户联系人

请求参数

参数	类型	说明	必需的
action	string	“GetContacts”	Required
limitstart	int	返回的日志数据的偏移量(默认值：0)	Optional
limitnum	int	返回的记录数(默认：25)	Optional
userid	int	查找特定客户 ID 的联系人	Optional
firstname	string	查找具有特定名字的联系人	Optional
lastname	string	查找具有特定姓氏的联系人	Optional
companyname	string	查找具有特定公司名称的联系人	Optional
email	string	查找具有特定电子邮件地址的联系人	Optional
address1	string	查找具有特定地址行的联系人 1	Optional
address2	string	查找具有特定地址行的联系人 2	Optional
city	string	查找特定城市的联系人	Optional
state	string	查找具有特定状态的联系人	Optional
postcode	string	查找具有特定邮政编码的联系人	Optional
country	string	查找与特定国家/地区的联系人	Optional
phonenumber	string	查找具有特定电话号码的联系人	Optional

响应参数

参数	类型	说明
result	string	操作结果：成功或错误
totalresults	int	可用结果总数
startnumber	int	返回结果的起始编号
numreturned	int	返回的结果数
contacts	array	返回的联系人条目

示例请求 (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' => 'GetContacts',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'userid' => '1',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

示例请求(本地 API)

$command = 'GetContacts';
$postData = array(
    'userid' => '1',
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

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

示例响应 JSON

{
    "result": "success",
    "totalresults": 1,
    "startnumber": 0,
    "numreturned": 1,
    "contacts": {
        "contact": [
            {
                "id": 1,
                "userid": 1,
                "firstname": "Test",
                "lastname": "Contact",
                "email": "[email protected]",
                "address1": "404 Street Not Found",
                "address2": "",
                "city": "Test",
                "state": "Test",
                "postcode": "TE5 5ST",
                "country": "GB",
                "phonenumber": "",
                "domainemails": true,
                "generalemails": true,
                "invoiceemails": true,
                "productemails": true,
                "supportemails": true,
                "affiliateemails": true,
                "created_at": "0000-00-00 00:00:00",
                "updated_at": "0000-00-00 00:00:00"
            }
        ]
    }
}