PHP WHMCS GetTickets用法及代码示例

获取符合通过条件的票证

请求参数

参数	类型	说明	必需的
action	string	“GetTickets”	Required
limitstart	int	返回引号数据的偏移量(默认值：0)	Optional
limitnum	int	返回的记录数(默认：25)	Optional
deptid	int	获取特定部门的票	Optional
clientid	int	查找特定客户 ID 的票证	Optional
email	string	查找特定非客户电子邮件地址的票证	Optional
status	string	查找符合特定状态的票证。任何配置的状态加：Awaiting Reply、All Active Tickets、My Flagged Tickets	Optional
subject	string	查找包含特定主题的票证 - 使用近似字符串匹配。	Optional
ignore_dept_assignments	bool	传递为 true 以不遵守 API 用户所属的部门。	Optional

响应参数

参数	类型	说明
result	string	操作结果：成功或错误
totalresults	int	可用结果总数
startnumber	int	返回结果的起始编号
numreturned	int	返回的结果数
tickets	array	与通过的条件匹配的票证数组
requestor_name	string	票证提交者的姓名。
requestor_type	string	工单提交者的类型。
requestor_email	string	票证提交者的电子邮件。
owner_name	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' => 'GetTickets',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

示例请求(本地 API)

$command = 'GetTickets';
$postData = array(
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

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

示例响应 JSON

{
    "result": "success",
    "totalresults": "1",
    "startnumber": 0,
    "numreturned": 1,
    "tickets": {
        "ticket": [
            {
                "id": "1",
                "tid": "516757",
                "deptid": "1",
                "userid": "1",
                "name": "Cynthia Reilly",
                "owner_name": "Cynthia Reilly",
                "email": "[email protected]",
                "requestor_name": "Cynthia Reilly",
                "requestor_email": "[email protected]",
                "requestor_type": "Owner",
                "cc": "",
                "c": "KPqH7yG3",
                "date": "2016-01-01 06:26:29",
                "subject": "This is a sample ticket",
                "status": "Answered",
                "priority": "Medium",
                "admin": "admin admin",
                "attachment": "123456_attachment_name.png",
                "attachments": [
                    {
                        "filename": "attachment_name.png",
                        "index": 0
                    }
                ],
                "attachments_removed": true,
                "lastreply": "2016-01-01 06:30:16",
                "flag": "0",
                "service": ""
            }
        ]
    }
}