PHP WHMCS AddCancelRequest用法及代码示例

添加取消请求

请求参数

参数	类型	说明	必需的
action	string	“AddCancelRequest”	Required
serviceid	int	要取消的服务 ID	Required
type	string	取消的类型。 “立即”或“计费期结束”	Optional
reason	string	客户取消原因	Optional

响应参数

参数	类型	说明
result	string	操作结果：成功或错误
serviceid	int	请求所针对的服务的 ID
userid	int	服务所属用户的id

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

示例请求(本地 API)

$command = 'AddCancelRequest';
$postData = array(
    'serviceid' => '1',
    'type' => 'Immediate',
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

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

示例响应 JSON

{
    "result": "success",
    "serviceid": "1",
    "userid": "1"
}

错误响应

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

• 未找到服务 ID
• 现有取消请求存在