Skip to main content

Ticket Details

Endpoint: GET /api/v6.1/ticket

Description: This API is used to retrieve detailed information of a specific support ticket based on its ticket_code identifier. The returned result includes basic and custom fields related to that ticket.


Request

Method: GET

Headers:

X-API-KEY: <your-api-key>
Cookie: <your-session-cookie>

Query Parameters:

  • ticket_code: Ticket identifier (required)
  • fields: List of fields to retrieve (optional), comma-separated. Example: id,ticket_title,ticket_content,...

Response

Status: 200 OK

Sample Content:

{
"id": 123,
"ticket_title": "Ticket Title",
"ticket_content": "<p>Support content</p>",
"cate_id": 1,
"emergency_phone": "0123456789",
"account_id": 456,
"account_name": "Customer Name",
"custom_fields": {
"custom_field": "value",
"custom_field_2": null
}
}

Field Descriptions

| Field | Data Type | Description |
|--------|---------------|-------|
| id | integer | Internal ID of the ticket |
| ticket_title | string | Title of the ticket |
| ticket_content | string (HTML) | Detailed content, can contain HTML |
| cate_id | integer | Category code of the ticket |
| emergency_phone | string | Emergency contact phone number |
| account_id | integer | ID of the related customer |
| account_name | string | Name of the related customer |
| custom_fields | object | System's custom fields, dynamically configured |\


Notes

  • ticket_code is required and unique for each ticket.\
  • The custom_fields field may vary depending on the configuration of each CRM system.

cURL Example

curl --location 'https://<your-domain>/api/v6.1/ticket?fields=id,ticket_title,ticket_content,...&ticket_code=<ticket-code>' \
--header 'X-API-KEY: <api-key>' \
--header 'Cookie: <session-cookie>'

Error Handling

| Error Code | Description |
|--------|------|
| 400 | Missing or invalid ticket_code |
| 401 | Unauthorized |
| 403 | Access Denied |
| 404 | Ticket not found |
| 500 | Internal system error |\