PHP WHMCS GetModuleQueue用法及代码示例

获取未完成失败操作的模块队列

请求参数

参数	类型	说明	必需的
action	string	“GetModuleQueue”	Required
relatedId	int	要加载的服务的 ID。与 $serviceType 结合使用	Optional
serviceType	string	要加载的服务类型(‘domain’, ‘service’, ‘addon’ 或“))	Optional
moduleName	string	以系统格式获取队列的模块名称。例如面板	Optional
moduleAction	string	获取队列的模块操作。例如 CreateAccount，SuspendAccount	Optional
since	string	获取项目后的日期/时间。格式 Y-m-d 可以包含 H:i:s	Optional

响应参数

参数	类型	说明
result	string	操作结果：成功或错误
count	int	返回的队列项目数
queue	\Queue[]	队列项的集合

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

示例请求(本地 API)

$command = 'GetModuleQueue';
$postData = array(
    'serviceType' => 'service',
    'moduleName' => 'cpanel',
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

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

示例响应 JSON

{
    "result": "success",
    "count": "1",
    "queue[0][id]": "1",
    "queue[0][serviceType]": "service",
    "queue[0][serviceId]": "1",
    "queue[0][moduleName]": "cpanel",
    "queue[0][moduleAction]": "CreateAccount",
    "queue[0][lastAttempt]": "2016-11-01 09:00:02",
    "queue[0][lastAttemptError]": "Product attribute Package Name \"this_package_is_made_up\" not found on server",
    "queue[0][numRetries]": "0",
    "queue[0][completed]": "0",
    "queue[0][createdAt]": "2016-11-01 09:00:02",
    "queue[0][updatedAt]": "2016-11-01 09:00:02"
}