PHP WHMCS AddTicketNote用法及代码示例

通过工单 ID 或工单号向工单添加注释。

请求参数

参数	类型	说明	必需的
action	string	“AddTicketNote”	Required
message	string	票据内容	Required
ticketnum	string	应用注释的客户票号 ID	Optional
ticketid	int	票证在数据库中的 ID。需要 $ticketnum 或 $ticketid	Optional
markdown	bool	是否应在票据输出中使用降价	Optional
attachments	array	可选的 base64 json 编码的文件附件数组。可以是 multipart-form-data 表单提交的直接输出(PHP 中的 $_FILES 超全局)或由文件名和数据键组成的数组数组(参见下面的示例)。	Optional
created	string	票据将显示为已创建的日期和时间。格式：ISO8601 或YYYY-MM-DD HH:mm:ss	Optional

响应参数

参数	类型	说明
result	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' => 'AddTicketNote',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'ticketid' => '1',
            'message' => 'This is a sample ticket note',
            'markdown' => true,
            'attachments' => base64_encode(json_encode([['name' => 'sample_text_file.txt', 'data' => base64_encode('This is a sample text file contents')]])),
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

示例请求(本地 API)

$command = 'AddTicketNote';
$postData = array(
    'ticketid' => '1',
    'message' => 'This is a sample ticket note',
    'markdown' => true,
    'attachments' => base64_encode(json_encode([['name' => 'sample_text_file.txt', 'data' => base64_encode('This is a sample text file contents')]])),
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

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

示例响应 JSON

{
    "result": "success"
}

错误响应

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

• 未找到票证 ID
• 需要留言
• 无效的日期格式
• 工单创建日期不能是未来