Support
This API retrieves a list of customer support ticket categories based on the provided query parameters.
Limit for pagination
Offset for pagination
Search keyword to filter categories
Parent Category ID to filter
Status of the category (e.g., active, inactive)
Successfully retrieved ticket categories
Failed to retrieve customer support ticket categories
GET /backend/api/api/customer-support-ticket/ticket-category HTTP/1.1
Host: 139.59.67.17
Accept: */*
{
"status": "success",
"message": "Successfully retrieved ticket categories",
"data": [
{
"createdBy": "admin",
"createdDate": "2025-04-20",
"modifiedBy": "admin",
"modifiedDate": "2025-04-20",
"id": "123",
"categoryName": "Technical Issue",
"parentCategoryId": "null",
"isActive": true,
"isDelete": false
}
]
}
This API retrieves a list of customer support tickets based on the provided query parameters.
Limit for the number of tickets to retrieve.
10
Offset for pagination.
0
Keyword to search tickets.
refund
A flag to specify if the count of tickets should be returned.
1
Authorization token (Bearer)
Bearer <token>
Successfully retrieved customer support tickets
Failed to retrieve customer support tickets
GET /backend/api/api/customer-support-ticket HTTP/1.1
Host: 139.59.67.17
Authorization: Bearer <token>
Accept: */*
{
"status": "success",
"message": "Customer support tickets retrieved successfully.",
"data": [
{
"categoryId": 1,
"subCategoryId": 2,
"refId": "TKT123",
"subject": "Issue with Product",
"description": "The product is defective.",
"status": "open",
"userId": 123,
"userType": "customer",
"createdDate": "2025-04-20T12:34:56Z",
"id": 1
}
]
}
This API allows customers to create a support ticket by submitting a category, sub-category, ticket details, message, and optional attachments.
Authorization token (Bearer)
Bearer <token>
Category ID
Sub Category ID
Ticket ID (optional)
Subject of the ticket
Description of the issue
Message body for the ticket
Successfully created customer support ticket
Failed to create customer support ticket
POST /backend/api/api/customer-support-ticket HTTP/1.1
Host: 139.59.67.17
Authorization: Bearer <token>
Content-Type: application/json
Accept: */*
Content-Length: 250
{
"categoryId": 1,
"subCategoryId": 2,
"ticketId": 123,
"subject": "Issue with Product",
"description": "The product is defective.",
"message": "Please check the issue with the product.",
"attachments": [
{
"fileName": "image1.jpg",
"filePath": "/uploads/image1.jpg"
}
]
}
{
"status": "success",
"message": "Customer support ticket created successfully.",
"data": {
"ticketId": 123,
"categoryId": 1,
"subCategoryId": 2,
"subject": "Issue with Product",
"description": "The product is defective.",
"message": "Please check the issue with the product.",
"attachments": [
{
"fileName": "image1.jpg",
"filePath": "/uploads/image1.jpg"
}
]
}
}
This API retrieves the details of a specific customer support ticket based on the provided ticket ID.
The ID of the customer support ticket.
1
Authorization token (Bearer)
Bearer <token>
Successfully retrieved customer support ticket details
Failed to retrieve customer support ticket
GET /backend/api/api/customer-support-ticket/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: Bearer <token>
Accept: */*
{
"status": "success",
"message": "Customer support ticket details retrieved successfully.",
"data": {
"createdBy": "admin",
"createdDate": "2025-04-20T12:34:56Z",
"modifiedBy": "admin",
"modifiedDate": "2025-04-21T08:45:00Z",
"id": 1,
"refId": "TKT123",
"userId": 123,
"userType": "customer",
"categoryId": 2,
"subCategoryId": 1,
"subject": "Issue with Product",
"description": "The product is defective.",
"isActive": true,
"isDelete": false,
"status": "open",
"ticketMessage": [
{
"createdBy": "customer",
"createdDate": "2025-04-20T12:34:56Z",
"modifiedBy": "admin",
"modifiedDate": "2025-04-21T08:45:00Z",
"id": 1,
"ticketId": 1,
"senderId": 123,
"senderType": "customer",
"message": "Can you please assist me with this issue?",
"sentAt": "2025-04-20T12:34:56Z",
"isActive": true,
"isDelete": false,
"createdByType": "customer",
"modifiedByType": "admin",
"ticketAttachments": []
}
]
}
}
This API updates the status of a specific customer support ticket based on the provided ticket ID.
The status of the ticket (e.g., open, closed, resolved, etc.).
2
The ID of the customer support ticket.
1
Authorization token (Bearer)
Bearer <token>
Successfully updated customer support ticket status
Failed to update customer support ticket status
PUT /backend/api/api/customer-support-ticket/{id} HTTP/1.1
Host: 139.59.67.17
Authorization: Bearer <token>
Accept: */*
{
"status": "success",
"message": "Customer support ticket status updated successfully.",
"data": {
"createdBy": "admin",
"createdDate": "2025-04-20T12:34:56Z",
"modifiedBy": "admin",
"modifiedDate": "2025-04-21T08:45:00Z",
"id": 1,
"refId": "TKT123",
"userId": 123,
"userType": "customer",
"categoryId": 2,
"subCategoryId": 1,
"subject": "Issue with Product",
"description": "The product is defective.",
"isActive": true,
"isDelete": false,
"status": "resolved"
}
}
Last updated