Source: ColorPark Open Platform documentation — Category: Interface – LAN Terminal (TCP); Article: Print Task Status Callback (打印机任务状态回调); id=156, cate_id=113. Published / Updated: 2026-09-22 15:55:40
Receive Task Status
Update the interface based on the task message returned by the terminal.
What do you need to prepare before starting?
Prepare the terminal software, a network connection on the same subnet, and the TCP communication configuration; first establish the connection following the integration guide.
This uses the terminal TCP event protocol — it is neither the Internet OpenAPI nor the embedded CMD protocol.
The Print Task Status Callback Event is used to push the print task's status and warning information to the third-party platform in real time, so the third party can respond with a solution promptly.
Notes:
- After placing an order, monitor the print-task status. If a print fault occurs, troubleshoot by combining the error information shown in the printing service software with the error information shown in the PrintExp printing software.
- Wait for the dispensing-complete signal before proceeding to create and print the next order.
Interface Information
| Parameter | Value | Description |
|---|---|---|
| IP | 192.168.127.11 | Use the corresponding IP within the LAN |
| Port | 63333 | Fixed port |
| Connection | TCP | Uses a TCP long connection |
| Encoding | UTF-8 | All sent and received data use UTF-8 encoding |
| Data format | JSON | Both sending and receiving use JSON format |
Callback Example
{"event":"03","code":"0","task_id":"10000002","status":"3","msg":"print completed"}
Note (source inconsistency preserved): In the callback example,
status = 3(which per the status-code description means "print cancelled") butmsgis"print completed". The two are inconsistent; preserved verbatim here.
Return Result
| Parameter | Example | Type | Description |
|---|---|---|---|
event |
03 | string | 03 = print task status callback event (initiated proactively by the server) |
code |
0 | string | Result status code: 0 on success, 1 on failure |
task_id |
10000002 | string | Unique ID assigned to the print job, provided by the service provider (returned in the three states — printing, print completed, print cancelled; returns 0 in other states) |
status |
2 | string | Print-task status: 0 preparing · 1 printing · 2 completed · 3 cancelled · 4 fault · 5 dispensing complete |
msg |
print completed | string | Displays different information according to the task status |
Note (source clarification preserved): This interface's "print-task status" uses 6 states (0–5, including "dispensing complete"), which differs from the 5-state (0–4) enum in the Create Print Job (id=154) and Cancel Task (id=158) events. The state numbers are aligned (0–4 share the same meaning); only the labels and the added
5differ. Keep the two enums distinct when handling callbacks.
Cross-reference — event
03reuse: The same event number03is used in two places: here, as a server → client status callback; and in the Cancel Task doc (id=158) as a client → server "cancel all tasks" request. They are different message directions/semantics and should not be conflated.
If the device encounters an unsolvable problem during debugging, you can contact the cloud-printing responsible person to troubleshoot and find a solution. Contact details:
- Phone: 137-5177-4454 【WeChat same number】
- Email: info@ColorPark.cn