獲取符合通過條件的用戶
請求參數
參數 | 類型 | 說明 | 必需的 |
---|---|---|---|
action | string | “GetUsers” | Required |
limitstart | int | 返回的日誌數據的偏移量(默認值:0) | Optional |
limitnum | int | 返回的記錄數(默認:25) | Optional |
sorting | string | 排序結果的方向。 ASC 或 DESC。默認值:ASC | Optional |
search | string | 在電子郵件、名字、姓氏或全名的開頭查找的搜索詞 | Optional |
響應參數
參數 | 類型 | 說明 |
---|---|---|
result | string | 操作結果:成功或錯誤 |
totalresults | int | 可用結果總數 |
startnumber | int | 返回結果的起始編號 |
numreturned | int | 返回的結果數 |
users | 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' => 'GetUsers',
// See https://developers.whmcs.com/api/authentication
'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
'password' => 'SECRET_OR_HASHED_PASSWORD',
'search' => '[email protected]',
'responsetype' => 'json',
)
)
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);
示例請求(本地 API)
$command = 'GetUsers';
$postData = array(
'search' => '[email protected]',
'responsetype' => 'json',
);
$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,
"users": [
{
"id": 1,
"firstname": "John",
"lastname": "Smith",
"email": "[email protected]",
"datecreated": "2020-12-15 15:29:49",
"validationdata": "",
"clients": [
{
"id": 1,
"isOwner": true
}
]
}
]
}
相關用法
- PHP WHMCS GetUserPermissions用法及代碼示例
- PHP WHMCS GetTicketNotes用法及代碼示例
- PHP WHMCS GetTLDPricing用法及代碼示例
- PHP WHMCS GetToDoItemStatuses用法及代碼示例
- PHP WHMCS GetPermissionsList用法及代碼示例
- PHP WHMCS GetCurrencies用法及代碼示例
- PHP WHMCS GetStaffOnline用法及代碼示例
- PHP WHMCS GetEmails用法及代碼示例
- PHP WHMCS GetClientPassword用法及代碼示例
- PHP WHMCS GetPromotions用法及代碼示例
- PHP WHMCS GetRegistrars用法及代碼示例
- PHP WHMCS GetAutomationLog用法及代碼示例
- PHP WHMCS GetQuotes用法及代碼示例
- PHP WHMCS GetActivityLog用法及代碼示例
- PHP WHMCS GetPaymentMethods用法及代碼示例
- PHP WHMCS GetModuleQueue用法及代碼示例
- PHP WHMCS GetTickets用法及代碼示例
- PHP WHMCS GetProducts用法及代碼示例
- PHP WHMCS GetProjects用法及代碼示例
- PHP WHMCS GetInvoices用法及代碼示例
- PHP WHMCS GetPayMethods用法及代碼示例
- PHP WHMCS GetServers用法及代碼示例
- PHP WHMCS GetSupportStatuses用法及代碼示例
- PHP WHMCS GetHealthStatus用法及代碼示例
- PHP WHMCS GetTicketAttachment用法及代碼示例
注:本文由純淨天空篩選整理自whmcs.com大神的英文原創作品 GetUsers。非經特殊聲明,原始代碼版權歸原作者所有,本譯文未經允許或授權,請勿轉載或複製。