PHP WHMCS GetActivityLog用法及代码示例

获取符合通过条件的活动日志

请求参数

参数	类型	说明	必需的
action	string	“GetActivityLog”	Required
limitstart	int	返回的日志数据的偏移量(默认值：0)	Optional
limitnum	int	返回的记录数(默认：25)	Optional
clientid	int	要为其获取日志的客户端的 ID。	Optional
date	string	以本地化格式检索的活动日志的日期(例如 01/01/2016)	Optional
user	string	要检索其日志条目的用户名	Optional
description	string	在日志中搜索特定字符串	Optional
ipaddress	string	用于搜索活动日志的 IP 地址	Optional

响应参数

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

示例请求(本地 API)

$command = 'GetActivityLog';
$postData = array(
    'description' => 'Cron Job',
);
$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,
    "activity": {
        "entry": [
            {
                "id": 2,
                "clientId": 0,
                "userId": 0,
                "adminId": 1,
                "date": "2021-01-01 06:56:49",
                "description": "Cron Job: Check for Updates: No new updates available",
                "username": "admin",
                "ipaddress": "172.18.0.1",
                "userid": 0
            },
            {
                "id": 1,
                "clientId": 0,
                "userId": 0,
                "adminId": 1,
                "date": "2021-01-01 06:56:49",
                "description": "Cron Job: Perform WHMCS Update Check",
                "username": "admin",
                "ipaddress": "172.18.0.1",
                "userid": 0
            }
        ]
    }
}