Support Ticket

get
β€Ž
https://<domain>/<api prefix>/<version>/support/get/category-list/

Node
var request = require('request');
var options = {
'method': 'GET',
'url': 'https://<domain>/<api prefix>/<version>/support/get/category-list/',
'headers': {
'apikey': '<apikey>',
'Authorization': 'Bearer <access-token>'
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
PHP
<?php
​
$curl = curl_init();
​
curl_setopt_array($curl, array(
CURLOPT_URL => "https://<domain>/<api prefix>/<version>/support/get/category-list/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => array(
"apikey: <apikey>",
"Authorization: Bearer <access-token>",
),
));
​
$response = curl_exec($curl);
​
curl_close($curl);
echo $response;

post
β€Ž
https://<domain>/<api prefix>/<version>/support/create/ticket/

Node
var request = require('request');
var fs = require('fs');
var options = {
'method': 'POST',
'url': 'https://<domain>/<api prefix>/<version>/creat/support/ticket/',
'headers': {
'apikey': '<apikey>',
'Authorization': 'Bearer <access-token>',
},
formData: {
'subject': '<subject>',
'priority': '<priority-id>',
'comment': '<comment>',
'category': '<category-id>',
'attachment': {
'value': fs.createReadStream('<file_path>'),
'options': {
'filename': '<file_name>',
'contentType': null
}
}
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
PHP
<?php
​
$curl = curl_init();
​
curl_setopt_array($curl, array(
CURLOPT_URL => "https://<domain>/<api prefix>/<version>/creat/support/ticket/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => array('subject' => '<subject>','priority' => '<priority-id>','comment' => '<comment>','category' => '<category>','attachment'=> new CURLFILE('<file_path>')),
CURLOPT_HTTPHEADER => array(
"apikey: <apikey>",
"Authorization: Bearer <access-token>",
),
));
​
$response = curl_exec($curl);
​
curl_close($curl);
echo $response;

Status Code
Error Type
Field
Description
400
Validation Error
subject, comment
This field is required.
400
Validation Error
subject
Ensure this field has no more than 500 characters.
400
Validation Error
priority
"\"priority\" is not a valid choice.
400
Validation Error
category
Invalid pk"\"category\" - object does not exist.
400
Validation Error
attachment
File is too big. Max filesize: 2MiB.
401
Request Failed
​
Currenly Open Ticket Limit Exceed.

get
β€Ž
https://<domain>/<api prefix>/<version>/support/get/ticket/history/

Node
var request = require('request');
var options = {
'method': 'GET',
'url': 'https://<domain>/<api prefix>/<version>/get/ticket/history/',
'headers': {
'apikey': '<apikey>',
'Authorization': 'Bearer <access-token>',
},
formData: {}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
​
PHP
<?php
​
$curl = curl_init();
​
curl_setopt_array($curl, array(
CURLOPT_URL => "https://<domain>/<api prefix>/<version>/get/ticket/history/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => array(
"apikey: <apikey>",
"Authorization: Bearer <access-token>"
),
));
​
$response = curl_exec($curl);
​
curl_close($curl);
echo $response;

Status Code
Error Type
Field
Description
400
Validation Error
category
Catogory id is not valid numeric
400
Validation Error
status
Status id is not valid numeric

get
β€Ž
https://<domain>/<api prefix>/<version>/support/get/ticket/tags/

Node
var request = require('request');
var options = {
'method': 'GET',
'url': 'https://<domain>/<api prefix>/<version>/get/ticket/tags/',
'headers': {
'apikey': '<apikey>',
'Authorization': 'Bearer <access-token>'
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
​
PHP
<?php
​
$curl = curl_init();
​
curl_setopt_array($curl, array(
CURLOPT_URL => "https://<domain>/<api prefix>/<version>/get/ticket/tags/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => array(
"apikey: <apikey>",
"Authorization: Bearer <access-token>"
),
));
$response = curl_exec($curl);
​
curl_close($curl);
echo $response;

post
β€Ž
https://<domain>/<api prefix>/<version>/support/update/ticket/

Node
var request = require('request');
var options = {
'method': 'POST',
'url': 'https://<domain>/<api prefix>/<version>/update/support/ticket/',
'headers': {
'apikey': '<apikey>',
'Authorization': 'Bearer <access-token>'
},
formData: {
'ticket_id': '<ticket id>',
'priority': '<priority id>',
'tags': '<tag id>'
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
PHP
<?php
​
$curl = curl_init();
​
curl_setopt_array($curl, array(
CURLOPT_URL => "https://<domain>/<api prefix>/<version>/update/support/ticket/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => array('ticket_id' => '<ticket id>','priority' => '<ticket id>','tags' => '<tag id>'),
CURLOPT_HTTPHEADER => array(
"apikey: <apikey>",
"Authorization: Bearer <accsess-token>",
),
));
​
$response = curl_exec($curl);
​
curl_close($curl);
echo $response;
​

Status Code
Error Type
Field
Description
400
Invalid Input
ticket
You are not the owner of the requested ticket,
Ticket id is not valid,
Ticket id is required and this may not be blank.
400
Validation Error
priority
"\"priority\" is not a valid choice.
400
Validation Error
tags
This list may not be empty.
Incorrect type. Expected pk value, received str.
Invalid pk \"tags\" - object does not exist.

get
β€Ž
https://<domain>/<api prefix>/<version>/support/ticket/detailed-view/

Node
var request = require('request');
var options = {
'method': 'GET',
'url': 'https://<domain>/<api prefix>/<version>/support/ticket/detailed-view/',
'headers': {
'apikey': '<apikey>',
'Authorization': 'Bearer <access token>',
},
formData: {
'ticket_id': '<ticket id>'
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
​
PHP
<?php
​
$curl = curl_init();
​
curl_setopt_array($curl, array(
CURLOPT_URL => "",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "https://<domain>/<api prefix>/<version>/support/ticket/detailed-view/",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_POSTFIELDS => array('ticket_id' => '<ticket id>'),
CURLOPT_HTTPHEADER => arra(
"apikey: <apikey>",
"Authorization: Bearer <access token>",
),
));
​
$response = curl_exec($curl);
​
curl_close($curl);
echo $response;
​
​

Status Code
Error Type
Field
Description
400
Invalid Input
ticket
You are not the owner of the requested ticket,
Ticket id is not valid.
Ticket id is required and this may not be blank.

get
β€Ž
https://<domain>/<api prefix>/<version>/support/ticket/download/<attachment_id>/

Node
var request = require('request');
var options = {
'method': 'GET',
'url': 'https://<domain>/<api prefix>/<version>/support/ticket/download/<attachment_id>/',
'headers': {
'apikey': '<apikey>',
'Authorization': 'Bearer <access token>',
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
​

<?php
​
$curl = curl_init();
​
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://<domain>/<api prefix>/<version>/support/ticket/download/<attachment_id>/',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
'apikey: <apikey>',
'Authorization: Bearer <access token>',
),
));
​
$response = curl_exec($curl);
​
curl_close($curl);
echo $response;

post
β€Ž
https://<domain>/<api prefix>/<version>/support/ticket/conversation/

var request = require('request');
var fs = require('fs');
var options = {
'method': 'POST',
'url': 'https://<domain>/<api prefix>/<version>/support/ticket/conversation/',
'headers': {
'apikey': '<apikey>',
'Authorization': 'Bearer <access token>',
},
formData: {
'ticket': '<ticket id>',
'comment': '<comment>',
'attachment': {
'value': fs.createReadStream('file path'),
'options': {
'filename': '<filename>',
'contentType': null
}
}
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
​
PHP
<?php
​
$curl = curl_init();
​
curl_setopt_array($curl, array(
CURLOPT_URL => "https://<domain>/<api prefix>/<version>/support/ticket/conversation/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => array('ticket' => '<ticket id>','comment' => '<comment>','attachment'=> new CURLFILE('file path')),
CURLOPT_HTTPHEADER => array(
"apikey: <apikey>",
"Authorization: Bearer <access token>",
),
));
​
$response = curl_exec($curl);
​
curl_close($curl);
echo $response;
​

Status Code
Error Type
Field
Description
400
Validation Error
ticket
This field is required.
You are not the owner of the requested ticket.
Incorrect type. Expected pk value, received str.
Invalid pk \"ticket\" - object does not exist.
This field may not be null.
400
Validation Error
comment
This field is required.
This field may not be blank.
400
Validation Error
attachment
File is too big. Max filesize: 2MiB.

post
β€Ž
https://<domain>/<api prefix>/<version>/β€Žsupport/ticket/status/

Node
var request = require('request');
var options = {
'method': 'POST',
'url': 'https://<domain>/<api prefix>/<version>/β€Žsupport/ticket/status/',
'headers': {
'apikey': '<apikey>',
'Authorization': 'Bearer <access token>',
},
formData: {
'ticket': '<ticket id>',
'status': '<status id>'
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});

<?php
​
$curl = curl_init();
​
curl_setopt_array($curl, array(
CURLOPT_URL => "https://<domain>/<api prefix>/<version>/β€Žsupport/ticket/status/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => array('ticket' => '<ticket id>','status' => '<status id>'),
CURLOPT_HTTPHEADER => array(
"apikey:<apikey>",
"Authorization: Bearer <access token>",
),
));
​
$response = curl_exec($curl);
​
curl_close($curl);
echo $response;
​

Status Code
Error Type
Field
Description
400
Validation Error
ticket
You Can't open or close this Ticket,
Ticket id is not valid
Ticket is already closed,
Ticket is already processing, Ticket is already open,
Ticket id is required and this may not be blank.
400
Validation Error
status
"\"status\" is not a valid choice.
Status id is required and this may not be blank.
Last modified 9mo ago
Copy link
On this page
Support Ticket Category List
get
Create Support Ticket
post
Support Ticket History
get
Support Ticket Tag List
get
Update Support Ticket
post
Get Ticket Detailed View
get
Get Attachment
get
Ticket Add Conversation
post
Change Ticket Status
post