智慧硬件开发
智慧硬件开发
硬件云端接入
打印/扫描设备
接口调用
获取打印任务列表
获取打印任务列表
最后更新:2024/08/20

本接口适用于云端接入打印机获取打印任务列表。

1.支持分页拉取,分页获取任务时,需填写offset和limit参数,打印机可以根据自身的情况决定分页大小。默认按任务提交时间排序,任务最多存储7天。
2.同时支持按特定jobid来获取任务,jobid_list不填或者填为空调数组则忽略该参数,填写jobid_list时,接口自动忽略status、cursor、offset、limit、begin_time、end_time等参数。

请求方式:POST(HTTPS
请求地址: https://qyapi.weixin.qq.com/cgi-bin/openhw/device/get_printer_job_list?device_access_token=DEVICE_ACCESS_TOKEN
请求包体:

{
		"open_userid": "zhangsan",
		"status": 0,
		"cursor": 0,
		"limit": 10,
		"begin_time":123,
		"end_time":456,
		"jobid_list":["aa","bb","cc"]
}

参数说明:

参数名是否必须类型描述
device_access_tokenstringdevice_access_token ,获取方式见获取设备调用凭证
open_useridString(40)成员id
cursorstring请求偏移量
limitUint32本次请求任务数,不填默认为100,最大为200
jobid_listArray(String)任务id列表 ,最大支持传入200个jobid
statusUint32任务状态:
0:获取未打印的任务;
1:获取打印成功的任务;
2:获取打印失败的任务;
不填则获取所有任务
begin_timeuint32打印任务起始时间
end_timeuint32打印任务结束时间

 

返回结果:

{
    "printer_job_list": [
        {
            "open_userid": "xxxxx",
            "createtime": 12345678,
            "submitted": 1,
            "status": 0,
            "errcode": 0,
            "errmsg": "ok",
            "doc_name": "aa.doc",
            "doc_size": 3317,
            "jobid": "job_id_xxxxx",
            "setting_list": [
                {
                    "key": "纸张大小",
                    "value": [
                        "A4"
                    ]
                },
                {
                    "key": "单双面",
                    "value": [
                        "单面"
                    ]
                }
            ]
        },
        {
            "open_userid": "yyyyy",
            "createtime": 12345678,
            "submitted": 0,
            "state": "machine_02",
            "status": 2,
            "errcode": 1,
            "errmsg": "打印机缺纸",
            "jobid": "job_id_yyyyy",
            "doc_name": "bb.pdf",
            "doc_size": 3317,
            "setting_list": [
                {
                    "key": "纸张大小",
                    "value": [
                        "A4"
                    ]
                },
                {
                    "key": "单双面",
                    "value": [
                        "单面"
                    ]
                }
            ]
        }
    ],
    "errcode": 0,
    "errmsg": "ok",
    "next_cursor": "ssdfasdfa"
}

 

参数说明:

参数名描述
errcode错误码
errmsg错误码描述
printer_job_list打印任务列表
createtime任务提交时间
submitted表示该任务是否扫码后提交:
0:否
1:是
open_userid成员id,表示该任务是谁提交的
status任务状态:
0:未打印
1:打印成功
2:打印失败
printer_job_list:errcode该任务错误码
printer_job_list:errmsg该任务的错误描述
jobid任务id
doc_name文档名称
doc_size文档大小,单位字节,仅当printer_format为jpg时可以忽略该参数
setting_list该任务的一些设置,所有设置都是key-value对
key设置项名称,字符串类型,utf8编码
value设置项的值,字符串数组,utf8编码,可以表示复选值
next_cursor请求偏移量,当没有next_cursor时表示列表已拉完
上一篇识别信息删除回调
下一篇获取打印文件
    本节内容
硬件直连接入
更新日志
联系我们