當前位置: 首頁>>編程示例 >>用法及示例精選 >>正文


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"
}

相關用法


注:本文由純淨天空篩選整理自whmcs.com大神的英文原創作品 GetModuleQueue。非經特殊聲明,原始代碼版權歸原作者所有,本譯文未經允許或授權,請勿轉載或複製。