Query Printer Status
Confirm the device is available — view offline, idle, printing, fault, or maintenance status.
What do you need to prepare before starting?
Prepare an onboarded device, the device ID and secret key, an accessible image URL, and the actual print dimensions. Keep the secret key on the server side; do not embed it in a web page.
Submission success does not mean printing is complete. Save the returned task number; only if the device is set to secondary confirmation do you need to additionally call "Start Printing."
Next: Submit Your First Task →
A third-party platform calls the Query Printer Status interface (
/api/printer/getPrinterStatus) to send a command to the open platform querying the printer's real-time operating status. After processing, the platform returns the printer status, status description, and notification time synchronously, enabling real-time monitoring of the device's online and working state.
Interface Information
| Item | Value |
|---|---|
| Endpoint | https://www.colorpark.cn/api/printer/getPrinterStatus |
| Method | POST |
Request Parameters
| Parameter | Sample Value | Data Type | Required | Description |
|---|---|---|---|---|
| printer_id | 500001 | string | Yes | The unique ID assigned to the printer; each print job is assigned a distinct ID. |
| once | 8305 | string | Yes | A random value used when generating the signature (nonce). |
| time | 1646790335 | string | Yes | The timestamp used when generating the signature. |
| sign | 9ce3ce7a3fccaf3d7715bd7e9bb1dc1c | string | Yes | The generated signature. For the generation method, refer to the "Signature Generation" section in the Underlying Methods [Basic Support] document. |
Response Result
| Field | Data Type | Sample Value | Description |
|---|---|---|---|
| code | string | 0 | Result status code: 0 for success, 1 for failure. |
| msg | string | Success | Result description, e.g., "Success". |
| data.msg | string | Offline | Print status description, e.g., Offline. |
| data.status | string | 0 | Printer status: 0 = offline, 1 = idle, 2 = printing, 3 = fault, 4 = maintenance. |
| data.notice_time | string | 2025-11-28 14:42:28 | Notification time. |
Note: In the source, the
data.msgfield description reads "打印状态状态" (literally "print-status status"), which is slightly inconsistent with the "printer status" context. Preserved verbatim.
If a device encounters an unsolvable issue during debugging, please contact the cloud-printing lead to troubleshoot and resolve it. Contact details: Phone: 137-5177-4454 (WeChat same number) Email: info@ColorPark.cn