PHP WHMCS EndTaskTimer用法及代码示例

结束项目的已启动计时器

请求参数

参数	类型	说明	必需的
action	string	“EndTaskTimer”	Required
timerid	int	待结束任务的id	Required
projectid	int	任务计时器的项目 ID	Optional
adminid	int	与计时器关联的管理员 ID	Optional
end_time	int	结束时间作为 unix 时间戳。如果未提供，则默认为 time()	Optional

响应参数

参数	类型	说明
result	string	操作结果：成功或错误
message	string	“计时器已结束”

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

示例请求(本地 API)

$command = 'EndTaskTimer';
$postData = array(
    'projectid' => '1',
    'timerid' => '1',
    'adminid' => '2',
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

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

示例响应 JSON

{
    "result": "success",
    "message": "Timer Has Ended"
}

错误响应

可能的错误条件响应包括：

• 未找到项目 ID
• 未设置定时器 ID
• 未找到计时器 ID
• 未找到管理员 ID