Suggestions

close search

Ticket note Management

Create a ticket note

URL: https://api.stringeex.com/v1/ticketNote

HTTP method: POST

Content-Type: application/json

Custom HTTP header: Name: X-STRINGEE-AUTH Value: JSON web token (JWT) see StringeeX API REST Authentication

POST data (body):

{
    "is_internal_note": false,
    "note": "noi dung note",
    "ticket_id": "tk_52uow7nijak53q7e",
    "note_type": 0,
    "task_type": 0
}

Field	Type	Required	Description
ticket_id	Text	Yes	ID of the ticket the note belongs to
note	Text	Yes	Note content
is_internal_note	Boolean	No	true: internal note (visible to agents only); false: visible note. Default: false
note_type	Number	No	Note source/type. Default: 0 (text note typed by an agent). See Note types section below. When creating notes via API you should normally use 0
task_type	Number	No	0: normal note; 1: note attached with a reminder/task. Default: 0
task_reminder_time	Number	No	Reminder time, Unix timestamp in milliseconds. Required and must be >= current time when task_type = 1
task_due_date	Number	No	Due date, Unix timestamp in milliseconds. Required and must be >= current time when task_type = 1

Response:

{
    "id": "tn_pok7oxikf2fyhee9",
    "r": 0,
    "msg": "Success"
}

When task_type = 1 and task_reminder_time or task_due_date is in the past, the request fails:

{
    "r": 3,
    "msg": "error: task_reminder_time < current_time or task_due_date < current_time"
}

Sample request (create a note with a reminder):

{
    "ticket_id": "tk_52uow7nijak53q7e",
    "note": "Call the customer back to confirm the order",
    "note_type": 0,
    "task_type": 1,
    "task_reminder_time": 1735700000000,
    "task_due_date": 1735707200000
}

Update a ticket note

URL: https://api.stringeex.com/v1/ticketNote/tn_zitk2akxa28x08d8

HTTP method: PUT

Content-Type: application/json

Custom HTTP header: Name: X-STRINGEE-AUTH Value: JSON web token (JWT), see StringeeX API REST Authentication

PUT data (body):

{
    "note": "noi dung note 111"
}

Response:

{
    "r": 0,
    "msg": "Success"
}

Delete a ticket note

URL: https://api.stringeex.com/v1/ticketNote/tn_pok7oxikf2fyhee9

HTTP method: DELETE

Content-Type: application/json

Custom HTTP header: Name: X-STRINGEE-AUTH Value: JSON web token (JWT), see StringeeX API REST Authentication

Response:

{
    "r": 0,
    "msg": "Delete success"
}

List ticket notes

URL: https://api.stringeex.com/v1/ticketNote?ticket=tk_52uow7nijak53q7e&sort_by=created&sort_order=asc

HTTP method: GET

Content-Type: application/json

Custom HTTP header: Name: X-STRINGEE-AUTH Value: JSON web token (JWT), see StringeeX API REST Authentication

Each note in the response includes a note_type field indicating its source. Notes other than 0 are generated automatically by the system (call logs, email, social channels, eKYC, etc.).

Note types

note_type	Meaning
0	Text note (typed by an agent / created via API)
1	Call log
3	Merge-ticket note
5	Live chat
6	Facebook - inbound
7	Facebook - outbound
8	Zalo - inbound
9	Zalo - outbound
10	Internal email - inbound
11	Internal email - outbound
12	Gmail - inbound
13	Gmail - outbound
14	SMS (PTI) - outbound
15	Simbox SMS - outbound
16	Simbox SMS - inbound
17	Broadcast - outbound (note in tracker ticket)
18	Broadcast - inbound (note in linked ticket)
24	eKYC - read ID card + face matching
25	eKYC - service handling after eKYC
66	eKYC - read ID card info
67	eKYC - face matching