PHP WHMCS GetClients用法及代码示例

获取符合通过条件的客户端

请求参数

参数	类型	说明	必需的
action	string	“GetClients”	Required
limitstart	int	返回的日志数据的偏移量(默认值：0)	Optional
limitnum	int	返回的记录数(默认：25)	Optional
sorting	string	排序结果的方向。 ASC 或 DESC。默认值：ASC	Optional
status	string	可选的所需客户端状态。 “活跃”、“不活跃”或“关闭”。	Optional
search	string	在电子邮件、名字、姓氏、全名或公司名的开头查找的搜索词	Optional
orderby	string	要排序的列。 id、名字、姓氏、公司名、电子邮件、groupid、创建日期、状态	Optional

响应参数

参数	类型	说明
result	string	操作结果：成功或错误
totalresults	int	可用结果总数
startnumber	int	返回结果的起始编号
numreturned	int	返回的结果数
clients	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' => 'GetClients',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'search' => 'example.com',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

示例请求(本地 API)

$command = 'GetClients';
$postData = array(
    'search' => 'example.com',
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

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

示例响应 JSON

{
    "result": "success",
    "totalresults": 2,
    "startnumber": 0,
    "numreturned": 2,
    "clients": {
        "client": [
            {
                "id": 2,
                "firstname": "Angelica",
                "lastname": "Mohr",
                "companyname": "",
                "email": "[email protected]",
                "datecreated": "2016-01-15",
                "groupid": 0,
                "status": "Active"
            },
            {
                "id": 1,
                "firstname": "Price",
                "lastname": "Beier",
                "companyname": "",
                "email": "[email protected]",
                "datecreated": "2016-01-01",
                "groupid": 0,
                "status": "Active"
            }
        ]
    }
}