PHP WHMCS AddTicketReply用法及代碼示例

通過工單 ID 添加對工單的回複。

請求參數

參數	類型	說明	必需的
action	string	“AddTicketReply”	Required
ticketid	int	票證在數據庫中的 ID。 $ticketid 是必需的	Required
message	string	票務回複的內容	Required
markdown	bool	是否應在票證回複輸出中使用降價	Optional
clientid	int	傳遞 clientid 以將票證回複與特定客戶端相關聯	Optional
contactid	int	傳遞一個 contactid 以將票證回複與屬於 $clientid 的特定聯係人相關聯	Optional
adminusername	string	與票證回複相關聯的管理員用戶名	Optional
name	string	如果不是管理員或客戶端響應，則與票證回複關聯的名稱	Optional
email	string	如果不是管理員或客戶回複，則與工單回複相關聯的電子郵件	Optional
status	string	如果不需要管理員/客戶端響應的默認狀態，則在做出回複後在工單上設置的狀態。請參閱GetSupportStatuses API 命令	Optional
noemail	bool	設置為 true 以停止發送工單回複電子郵件	Optional
customfields	string	要更新的自定義字段的 base64 編碼數組	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' => 'AddTicketReply',
            // 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 reply',
            'clientid' => '1',
            'customfields' => base64_encode(serialize(array("1"=>"Google"))),
            '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 = 'AddTicketReply';
$postData = array(
    'ticketid' => '1',
    'message' => 'This is a sample ticket reply',
    'clientid' => '1',
    'customfields' => base64_encode(serialize(array("1"=>"Google"))),
    '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
• 未找到客戶端 ID
• 未找到聯係人 ID
• 如果不是客戶，則需要姓名和電子郵件地址
• 需要留言
• 電子郵件地址無效
• 無效的票證狀態
• 無效的日期格式
• 回複創建日期不能是將來