Ticket information
A returned ticket consists of the following information:
Ticket Name [title]
The title or subject of the ticket.
Ticket ID [id]
The unique string that identifies a ticket.
Ticket Status [ticketStatus]
The current status of the ticket.
Owner [owner]
The ID of who the ticket is assigned to, if it is assigned.
Opened [opened]
Shows whether the ticket has been opened or not.
Department [department]
The current department of the ticket.
Trash [trash]
Shows whether the ticket is currently in the trash.
Creation Date [creationDate]
The date the ticket was created.
This method returns a single ticket.
You will need to use the
required information, and may need to use the
optional information below.
Required Information:
Example 1:
https://rhinosupport.com/API/Ticket/?apiCode=
[apiCode]&id=
[id]
Example 2:
https://rhinosupport.com/API/Ticket/?apiCode=
[apiCode]&id=
[id]&showNotes&responseType=json
PHP Curl Example
$request = curl_init('https://api.rhinosupport.com/API/Ticket/?apiCode=[apiCode]&id=[id]');
curl_setopt($request, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($request);
curl_close($request);
echo $result;
?>
This method returns a list of tickets specified by ticket id's.
You will need to use the
required information, and may need to use the
optional information below.
Required Information:
Example 1:
https://rhinosupport.com/API/Ticket/?apiCode=
[apiCode]&id=
[IDList]
Note that that this is identical to getting a single ticket except that now separate each ticket id with a comma
Example 2:
https://rhinosupport.com/API/Ticket/?apiCode=
[apiCode]&id=
[IDList]&showNotes&responseType=json
This method returns a list of tickets created by the given email address.
You will need to use the
required information, and may need to use the
optional information below.
Required Information:
Example 1:
https://rhinosupport.com/API/Ticket/?apiCode=
[apiCode]&emailAddress=
[emailAddress]
Example 2:
https://rhinosupport.com/API/Ticket/?apiCode=
[apiCode]&emailAddress=
[emailAddress]&showNotes&sortOrder=
[sortOrder]&offset=
[offset]&limit=
[limit]&responseType=json
PHP Curl Example
$request = curl_init('https://api.rhinosupport.com/API/Ticket/?apiCode=[apiCode]&emailAddress=[emailAddress]');
curl_setopt($request, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($request);
curl_close($request);
echo $result;
?>
This method returns a list of tickets by the specified tag name.
You will need to use the
required information, and may need to use the
optional information below.
Required Information:
Example 1:
https://rhinosupport.com/API/Ticket/?apiCode=
[apiCode]&tagName=
[emailAddress]
Example 2:
https://rhinosupport.com/API/Ticket/?apiCode=
[apiCode]&tagName=
[emailAddress]&showNotes&sortOrder=
[sortOrder]&offset=
[offset]&limit=
[limit]&responseType=json
PHP Curl Example
$request = curl_init('https://api.rhinosupport.com/API/Ticket/?apiCode=[apiCode]&tagName=[tagName]');
curl_setopt($request, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($request);
curl_close($request);
echo $result;
?>
This method returns a list of tickets specified by the ticket status (open, closed, or pending).
You will need to use the
required information, and may need to use the
optional information below.
Required Information:
Example 1:
https://rhinosupport.com/API/Ticket/?apiCode=
[apiCode]&type=
[type]
Example 2:
https://rhinosupport.com/API/Ticket/?apiCode=
[apiCode]&type=
[type]&showNotes&sortField=
[sortField]&sortOrder=
[sortOrder]&offset=
[offset]&limit=
[limit]&responseType=json
PHP Curl Example
$request = curl_init('https://api.rhinosupport.com/API/Ticket/?apiCode=[apiCode]&type=[ticketType]');
curl_setopt($request, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($request);
curl_close($request);
echo $result;
?>
This method lets you create a new ticket.
You will need to use the
required information, and may need to use the
optional information below.
Required Information:
PHP Curl Example 1:
$request = curl_init ('https://www.rhinosupport.com/API/Ticket/');
$postFields = array();
$postFields['apiCode'] = '
[apiCode]';
$postFields['name'] = '
[ticketName]';
$postFields['emailTo'] = '
[emailTo]';
$postFields['body'] = '
[message]';
curl_setopt ($request, CURLOPT_POST, true);
curl_setopt ($request, CURLOPT_POSTFIELDS, http_build_query($postFields));
curl_setopt ($request, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec ($request);
curl_close ($request);
echo $result;
PHP Curl Example 2:
$request = curl_init ('https://www.rhinosupport.com/API/Ticket/');
$postFields = array();
$postFields['apiCode'] = '
[apiCode]';
$postFields['name'] = '
[ticketName]';
$postFields['emailTo'] = '
[emailTo]';
$postFields['body'] = '
[message]';
$postFields['ticketFromCustomer'] = '
1';
$postFields['firstName'] = '
[firstName]';
$postFields['lastName'] = '
[lastName]';
$postFields['companyName'] = '
[companyName]';
$postFields['websiteURL'] = '
[websiteURL]';
$postFields['phoneNumber'] = '
[phoneNumber]';
$postFields['ticketStatus'] = '
[ticketStatus]';
$postFields['department'] = '
[department]';
$postFields['attachmentName'] = '
[attachmentName]';
$postFields['attachment'] =
base64_encode(file_get_contents('yourfolder/yourimage.png'));
$postFields['cc'] = '
[cc]';
$postFields['bcc'] = '
[bcc]';
$postFields['ticketNote'] = '
[ticketNote]';
$postFields['suppressEmail'] = '
1';
$postFields['suppressStaffNotifications'] = '
1';
curl_setopt ($request, CURLOPT_POST, true);
curl_setopt ($request, CURLOPT_POSTFIELDS, http_build_query($postFields));
curl_setopt ($request, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec ($request);
curl_close ($request);
echo $result;
This method lets you update an existing ticket.
You will need to use the
required information, and may need to use the
optional information below.
Required Information:
PHP Curl Example 1:
$request = curl_init ('https://www.rhinosupport.com/API/Ticket/');
$postFields = array();
$postFields['apiCode'] = '
[apiCode]';
$postFields['id'] = '
[id]';
$postFields['owner'] = '
[owner]';
curl_setopt ($request, CURLOPT_POST, true);
curl_setopt ($request, CURLOPT_POSTFIELDS, http_build_query($postFields));
curl_setopt ($request, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec ($request);
curl_close ($request);
echo $result;
PHP Curl Example 2:
$request = curl_init ('https://www.rhinosupport.com/API/Ticket/');
$postFields = array();
$postFields['apiCode'] = '
[apiCode]';
$postFields['id'] = '
[id]';
$postFields['ticketStatus'] = '
[ticketStatus]';
$postFields['department'] = '
[department]';
$postFields['owner'] = '
[owner]';
curl_setopt ($request, CURLOPT_POST, true);
curl_setopt ($request, CURLOPT_POSTFIELDS, http_build_query($postFields));
curl_setopt ($request, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec ($request);
curl_close ($request);
echo $result;
This method lets you update an existing ticket.
You will need to use the
required information, and may need to use the
optional information below.
Required Information:
PHP Curl Example 1:
$request = curl_init ('https://www.rhinosupport.com/API/Ticket/');
$postFields = array();
$postFields['apiCode'] = '
[apiCode]';
$postFields['id'] = '
[id]';
$postFields['owner'] = '
[owner]';
curl_setopt ($request, CURLOPT_POST, true);
curl_setopt ($request, CURLOPT_POSTFIELDS, http_build_query($postFields));
curl_setopt ($request, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec ($request);
curl_close ($request);
echo $result;
PHP Curl Example 2:
$request = curl_init ('https://www.rhinosupport.com/API/Ticket/');
$postFields = array();
$postFields['apiCode'] = '
[apiCode]';
$postFields['id'] = '
[id]';
$postFields['ticketStatus'] = '
[ticketStatus]';
$postFields['department'] = '
[department]';
$postFields['owner'] = '
[owner]';
curl_setopt ($request, CURLOPT_POST, true);
curl_setopt ($request, CURLOPT_POSTFIELDS, http_build_query($postFields));
curl_setopt ($request, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec ($request);
curl_close ($request);
echo $result;
Delete an existing ticket and its messages.
You will need to use the
required information below.
Required Information:
PHP Curl Example 1:
$request = curl_init ('https://www.rhinosupport.com/API/Ticket/');
$postFields = array();
$postFields['apiCode'] = '
[apiCode]';
$postFields['trashID'] = '
[trashID]';
curl_setopt ($request, CURLOPT_POST, true);
curl_setopt ($request, CURLOPT_POSTFIELDS, http_build_query($postFields));
curl_setopt ($request, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec ($request);
curl_close ($request);
echo $result;
Join a ticket to one or more existing tickets.
You will need to use the
required information below.
Required Information:
PHP Curl Example 1:
$request = curl_init ('https://www.rhinosupport.com/API/Ticket/');
$postFields = array();
$postFields['apiCode'] = '
[apiCode]';
$postFields['joinID'] = '
[joinID]';
$postFields['idList'] = '
[idList]';
curl_setopt ($request, CURLOPT_POST, true);
curl_setopt ($request, CURLOPT_POSTFIELDS, http_build_query($postFields));
curl_setopt ($request, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec ($request);
curl_close ($request);
echo $result;