芯烨云网络打印机-开放平台

芯烨云API 企业微信群

接入API步骤

第一步：注册开发者账号

到 admin.xpyun.net （以下统称‘芯烨云平台’）注册开发者账号，获得开发者ID（user）和开发者密钥(UserKEY )，开发者ID和开发者密钥是开发者接入API的重要身份识别参数。

第二步：对接平台API

1、添加打印机到开发者账户（可批量）【必接】
注意：打印之前必须调用本接口进行打印机注册，即添加PID或SN（查看打印机身底部标签）到开发者ID下，开发者也可以登录芯烨云开放平台，在【打印管理 ➜ 设备管理】下进行手动添加，在开放平台添加时，设备名称由开发者自己自由设置。
2、设置打印机语音类型
3、打印小票订单【票据机必接】
4、打印标签订单【标签机必接】
5、删除打印机（可批量）
6、修改打印机信息
7、清空待打印队列
8、查询订单是否打印成功
9、查询打印机某天的订单统计数
10、查询打印机状态
11、批量查询打印机状态
12、金额播报

特别声明

1、API接口同时支持 https和http 两种方式请求，推荐使用https方式，为了便于升级维护，建议采用服务后台对接云打印
2、API请求的参数包含2部分：公共参数和私有参数，详情请看对应API接口说明。
3、API请求和返回结果皆为 json 格式数据。
特别注意：开发者自己写的请求以表单方式提交数据，请求头需要使用Content-Type: application/json;charset=UTF-8，请勿使用其它方式提交数据

请求公共参数说明

所有请求都必须传递的参数。

参数名	是否必须	类型	说明
user	必须	string	芯烨云平台注册用户名（开发者 ID）
timestamp	必须	string	当前UNIX时间戳，10位，精确到秒
sign	必须	string	对参数 user + UserKEY + timestamp 拼接后（+号表示连接符）进行SHA1加密得到签名，值为40位小写字符串，其中 UserKEY 为用户开发者密钥
debug	可选	string	debug=1返回非json格式的数据，仅测试时候使用

sign参数说明：例如：user=acc、UserKEY=abc、timestamp=acbc，那么先拼成字符串accabcacbc，再将此字符串进行SHA1加密，得到sign。

返回公共参数说明

参数名	类型	说明
code	int	返回码，正确返回0，【注意：结果正确与否的判断请用此返回参数，添加打印机接口和删除打印机接口还需结合data一起判断】，错误返回非零。
msg	string	结果提示信息，正确返回”ok”，如果有错误，返回错误信息标识。
data	不指定	数据类型和内容详看私有返回参数data，如果有错误，返回null。
serverExecutedTime	int	服务器程序执行时间，单位：毫秒。

1、添加打印机到开发者账户（可批量）【必接】

功能描述：

批量添加打印机，请严格参照请求格式说明。

请求接口：

https://open.xpyun.net/api/openapi/xprinter/addPrinters

请求方式：

POST

特别注意：

开发者自己写的请求以表单方式提交数据，请求头需要使用Content-Type: application/json;charset=UTF-8，请勿使用其它方式提交数据

公共参数：

所有请求都必须传递的参数。

参数名	是否必须	类型	说明
user	必须	string	芯烨云平台注册用户名（开发者 ID）
timestamp	必须	string	当前UNIX时间戳，10位，精确到秒
sign	必须	string	对参数 user + UserKEY + timestamp 拼接后（+号表示连接符）进行SHA1加密得到签名，值为40位小写字符串，其中 UserKEY 为用户开发者密钥
debug	可选	string	debug=1返回非json格式的数据，仅测试时候使用

sign参数说明：例如：user=acc、UserKEY=abc、timestamp=acbc，那么先拼成字符串accabcacbc，再将此字符串进行SHA1加密，得到sign。

私有参数：

参数名	是否必须	类型	说明
items	必须	array	数组元素为 json 对象： {"name":"打印机名称","sn":"打印机编号"} 其中打印机编号 sn 和名称 name 字段为必填项，每次最多添加50台

返回参数说明：

参数名	类型	说明
data	object	返回1个 json 对象，包含成功和失败的信息，详看示例

请求示例：

{
    "items":[
        {"sn":"XPY123456789A", "name":"X58A"},
        {"sn":"XPY987654321B", "name":"X58B"},
        {"sn":"XPY123456723A", "name":"X58C"},
        {"sn":"XPY987654345B", "name":"X58D"}
    ],
    "user": "testuser@google.com",
    "timestamp": "1565417654",
    "sign": "82bdcbe2cf6ac4923339b13c2aad1f95ddf0b0a8",
    "debug": "0"
}

返回示例：

成功：示例解读：总共添加4台打印机设备，添加成功2台，添加失败2台，失败原因可通过failMsg字段的原因代码1010到接口返回码中查询具体失败原因。

{
    "msg":"ok",
    "code":0,
    "data":{"success": ["XPY123456789A","XPY987654321B"], "fail": ["XPY123456723A","XPY987654345B"], "failMsg": ["XPY123456723A:1010","XPY987654345B:1010"]},
    "serverExecutedTime":1
}

失败：

{
    "msg":"REQUEST_USER_NOT_REGISTER",
    "code":-4,
    "data":null,
    "serverExecutedTime":1
}

2、设置打印机语音类型

功能描述：

设置打印机语音类型，请严格参照请求格式说明。

请求接口：

https://open.xpyun.net/api/openapi/xprinter/setVoiceType

请求方式：

POST

特别注意：

开发者自己写的请求以表单方式提交数据，请求头需要使用Content-Type: application/json;charset=UTF-8，请勿使用其它方式提交数据

公共参数：

所有请求都必须传递的参数。

参数名	是否必须	类型	说明
user	必须	string	芯烨云平台注册用户名（开发者 ID）
timestamp	必须	string	当前UNIX时间戳，10位，精确到秒
sign	必须	string	对参数 user + UserKEY + timestamp 拼接后（+号表示连接符）进行SHA1加密得到签名，值为40位小写字符串，其中 UserKEY 为用户开发者密钥
debug	可选	string	debug=1返回非json格式的数据，仅测试时候使用

sign参数说明：例如：user=acc、UserKEY=abc、timestamp=acbc，那么先拼成字符串accabcacbc，再将此字符串进行SHA1加密，得到sign。

私有参数：

参数名	是否必须	类型	说明
sn	必须	string	打印机编号
voiceType	必须	int	声音类型：打印机固件版本为V10.xx的机器取值： 0真人语音（大） 1真人语音（中） 2真人语音（小） 3 嘀嘀声 4 静音其它固件版本的机器取值：0真人语音 3 嘀嘀声 4 静音
volumeLevel	可选	int	声音大小：0大 1中 2小 3关闭说明：打印机固件版本为非V10.xx的机器支持此参数

返回参数说明：

参数名	类型	说明
data	bool	返回布尔类型：true 表示设置成功 false 表示设置失败

请求示例：

{
    "sn": "XPY123456789A",
    "voiceType": 0,
    "user": "testuser",
    "timestamp": "1565417654",
    "sign": "82bdcbe2cf6ac4923339b13c2aad1f95ddf0b0a8",
    "debug": "0"
}

返回示例：

成功：

{
    "msg":"ok",
    "code":0,
    "data":true,
    "serverExecutedTime":1
}

失败：

{
    "msg":"PRINTER_OFFLINE",
    "code":1003,
    "data":false,
    "serverExecutedTime":1
}

3、打印小票订单

功能描述：

发送用户需要打印的订单内容给芯烨云小票打印机。该接口仅用于打印票据订单，若需要打印标签订单，请使用打印标签订单即可。

请求接口：

https://open.xpyun.net/api/openapi/xprinter/print

请求方式：

POST

特别注意：

开发者自己写的请求以表单方式提交数据，请求头需要使用Content-Type: application/json;charset=UTF-8，请勿使用其它方式提交数据

公共参数：

所有请求都必须传递的参数。

参数名	是否必须	类型	说明
user	必须	string	芯烨云平台注册用户名（开发者 ID）
timestamp	必须	string	当前UNIX时间戳，10位，精确到秒
sign	必须	string	对参数 user + UserKEY + timestamp 拼接后（+号表示连接符）进行SHA1加密得到签名，值为40位小写字符串，其中 UserKEY 为用户开发者密钥
debug	可选	string	debug=1返回非json格式的数据，仅测试时候使用

sign参数说明：例如：user=acc、UserKEY=abc、timestamp=acbc，那么先拼成字符串accabcacbc，再将此字符串进行SHA1加密，得到sign。

私有参数：

参数名	是否必须	类型	说明
sn	必须	string	打印机编号
content	必须	string	打印内容,打印内容使用 GBK 编码判断,不能超过12K
copies	可选	int	打印份数，默认为1，取值[1-65535]，超出范围将视为无效参数
cutter	可选	int	切刀控制开关，默认为0，开启云端默认设置控制切刀，1关闭云端切刀，若想自己设置切刀位置，可以通过 <CUT> 标签设置切刀仅用于支持切刀的芯烨云打印机。
voice	可选	int	声音播放模式，0 为取消订单模式，1 为静音模式，2 为来单播放模式，3 为有用户申请退单了，默认为 2 来单播放模式
mode	可选	int	打印模式：值为 0 或不指定则会检查打印机是否在线，如果不在线则不生成打印订单，直接返回设备不在线状态码；如果在线则生成打印订单，并返回打印订单号。值为 1不检查打印机是否在线，直接生成打印订单，并返回打印订单号。如果打印机不在线，订单将缓存在打印队列中，打印机正常在线时会自动打印。
expiresIn	可选	int	订单有效期，单位：秒。订单打印时，超过该时间的订单将不会自动加载打印，当参数设置为 0 时，将采用系统默认设置值。使用该参数时，需要将参数mode 设置为1。取值范围：0 < expiresIn < 86400。
backurlFlag	可选	int	打印订单状态回调标识。取值范围：[ 1 - 5 ]的整数，对应于芯烨云开放平台管理后台 “功能设置” 菜单界面的打印接口回调标识。
idempotent	可选	string	唯一订单号标识,用于去重。长度范围：[ 1 - 50 ]个字符，建议20个字符以内，5分钟内同一个开发者账号如果有两个订单号相同，第二个订单将不会打印。
payType	可选	int	支付方式：取值范围41~55：支付宝 41、微信 42、云支付 43、银联刷卡 44、银联支付 45、会员卡消费 46、会员卡充值 47、翼支付 48、成功收款 49、嘉联支付 50、壹钱包 51、京东支付 52、快钱支付 53、威支付 54、享钱支付 55 仅用于支持金额播报的芯烨云打印机。
payMode	可选	int	支付与否：取值范围59~61：退款 59 到账 60 消费 61。仅用于支持金额播报的芯烨云打印机。
money	可选	float	支付金额：最多允许保留2位小数。仅用于支持金额播报的芯烨云打印机。

打印模板排版控制标签说明：(详情请参考打印模板样例和SDK示例)

 <BR>：换行符（同一行有闭合标签(如 </C> 或 </R> )则应放到闭合标签前面, 连续两个换行符<BR><BR>可以表示加一空行）
 <L></L>：左对齐
 <C></C>：居中对齐
 <R></R>：右对齐
 注意：居中（或居右）标签生效需要把 <BR> 标签放在 </CB> 或 </C> 或 </R> 标签前面。同一行内容不能使用多种对齐方式，
可通过补空格方式自定义对齐样式。与换行标签一起使用时，换行标签应放在对齐标签里面。
使用举例说明：
      右对齐且换行  <R>待右对齐内容<BR></R>
      58mm的机器，一行打印16个汉字，32个字母
      80mm的机器，一行打印24个汉字，48个字母
 
 <N></N>：字体正常大小
 <HB></HB>：字体变高一倍
 <WB></WB>：字体变宽一倍
 <B></B>：字体放大一倍
 <CB></CB>：字体放大一倍居中
 <CUT>：自定义切刀
 <HB2></HB2>：字体变高二倍
 <WB2></WB2>：字体变宽二倍
 <B2></B2>：字体放大二倍
 <BOLD></BOLD>：字体加粗
 <IMG></IMG>：打印LOGO图片，需登录开放平台在【打印管理➜设备管理】下通过设置LOGO功能进行上传。此处直接写入空标 
签,如 <IMG></IMG> 即可, 具体可参考样例。图片宽度设置：可以通过 <IMG> 标签名称自定义，如 <IMG60> 表示宽度为60，
相应的闭合标签 </IMG>不需要指定高度。<IMG> 标签不指定宽度默认为40，最小值为20，最大值为200，图片数据最大值30KB
 <QRCODE s=6 e=L l=center>二维码内容</QRCODE>：二维码（标签内容是二维码值, 最大不能超过256个字符）。
      s：二维码大小，默认6，取值范围 0-16，当s为0时，二维码大小会根据内容大小动态调整
      e：二维码纠错等级，默认L，取值范围 L/M/Q/H
      l：二维码打印位置，默认center，取值范围 left/center/right。（l为location位置单词首字母）
 <FONT w="0" h="0">需要放大的文档内容</FONT>：字体标签，字体倍数放大。
      属性w: 字体宽度放大倍数。默认0，不放大，取值[0-7]
      属性h: 字体高度放大倍数。默认0，不放大，取值[0-7]
 <BARCODE t=CODE128 w=2 h=100 p=2>条形码值</BARCODE>：条形码（标签内容是条形码值）。若不能正常打印一维码，则需
在<BARCODE>前面加上<BR>标签
      t：条码类型，取值范围：UPCA、EAN13、EAN8、CODE39、ITF、CODABAR、CODE93、CODE128。默认值：CODE128
      w：条码宽度，取值范围：2-6；默认值：2 
      h：条码高度，取值范围：1-255；默认值：100 
      p：条码值显示的位置，取值范围：0不显示，1条码上方，2条码下方，3条码上下方都显示；默认值：2
                   <RH n="3">放置需更改行间距内容</RH>：小票内容行间距设置标签，只有内容达到两行或两行以上才能生效。<RH></RH>之间的
内容是要调整行间距的小票内容，内容可以是小票其他标签包裹的内容，也可以是纯文本内容。RH标签需要放在基础标签<L></L>、
<C></C>或<R></R>之间才能生效。若有使用<BOLD>标签时,<RH>标签需放在<BOLD>标签里面。放置方式可参考下发的使用举例说
明。参数说明如下：
    n：行间距值，n的取值范围[0,5]，设置时最好让n乘以48是一个非负整数，若乘积出现小数位时，将舍弃小数位取
整数。默认行间距高是48即约高3.75mm
  使用举例说明：
    打印行间距为3且内容加粗的标签使用示例
<R><BOLD><RH n="3">欢迎使用芯烨云打印机，RH标签是小票内容行间距设置标签。需要放在基础标签L、C或R之间才能生效哟！
</RH></BOLD></R><BR>
RH标签已弃用，现启用LH标签
                   <LH h="3"></LH>放置需更改行间距内容：小票内容行间距设置标签，只有内容达到两行或两行以上才能生效。</LH>之后的
内容是要调整行间距的小票内容。其中，单独使用 <LH>标签（后面不跟着</LH>标签），表示恢复原先行间距。参数说明如下：
h:0~255 之间的整数。1h=1/8mm,例如 h=8时，间距为8*(1/8)=1mm
  举例如下：
<LH h="99"></LH>1、欢迎使用芯烨云打印机，LH标签是小票内容行间距设置标签。LH是平台新引入的标签，其他新功能会持续
更新！<BR><LH h="255"></LH>2、欢迎使用芯烨云打印机，LH标签是小票内容行间距设置标签。LH是平台新引入的标签，其他新功
能会持续更新！<BR><LH>3、欢迎使用芯烨云打印机，LH标签是小票内容行间距设置标签。LH是平台新引入的标签，其他新功能会持
续更新！
                  
                   <P></P>：开启横向左右布局(页模式)模式。需结合AREA标签使用。仅用于支持左右布局(页模式)的机器，详情可加开放平台QQ技术群或企业微信
群垂询
                  <TWO_QR><LQR></LQR><RQR></RQR></TWO_QR>：双二维码同行打印。  仅用于支持左右布局(页模式)的机器，
详情可加开放平台QQ技术群或企业微信群垂询。
 <LQR>,<RQR>为在IOS上支持中文等字符 要加大小参数n,n范围 1-16，如 <LQR3>,<RQR8> 。如果只打数字和英文，可不加参数n
  使用举例说明：
 
  <lt><CB>電子發票證明聯</CB><BR><CB>106年07-08月</CB><BR><CB>JT-82856515</CB><BR><N>2019-08-09 15:38:26 
  </N><BR><lc><TWO_QR><LQR4>*******:2:2:0:拿鐵(I):1:70:榛果拿鐵(I):1:75</LQR><RQR4>中文2222</RQR></TWO_QR> 
  <BR>

  <CB>只有英文数字内容的双二维码打印</CB><BR><CB>106年07-08月</CB><BR><CB>JT-82856515</CB><BR><N>2019-08-09 
  </N><BR><lc><TWO_QR><LQR>http://www.sina.com.cn:999</LQR><RQR>only english and number</RQR></TWO_QR> 
  <BR> 
 
  <AREA></AREA>：按区域打印，需结合P标签使用。仅用于支持左右布局(页模式)的机器，详情可加开放平台QQ技术群或企业微信群垂询。
      x:打印区域起始点的x轴；
      y:打印区域起始点的y轴；
      w:打印区域的宽度；
      h:打印区域的高度。
  使用举例说明：<P><AREA x=0 y=0 w=100 h=200>该区域需要打印的内容，区域内部文字会自动换行</AREA></P>
                   <LINE p="3,6,16" /> 和  <HT>：用于创建表格 和 跳到表格下一个单元格 (已弃用，请用后面功能更强大的 TABLE 标签) 
      <LINE p="3,6,16" />：定义一个表格，包含4列，从左到右开始数，第1列为第0个英文字符起始处,第2列为第3个英文
        字符起始处,第3列为第6个英文字符起始处,第4列为第16个英文字符起始处 
      <HT>：跳到表格的下一个单元开始处
  使用举例说明：
      <CB>芯烨云小票<BR><BR><BR></CB>
<L>
<LINE p="20,26" />菜名<HT>数量<HT>单价<BR>
--------------------------------<BR>
可乐鸡翅<HT>2<HT>9.99<BR>
水煮鱼特辣<HT>1<HT>108.00<BR>
豪华版超级无敌龙虾炒饭<BR>
<HT>1<HT>99.90<BR>
炭烤鳕鱼<HT>5<HT>19.99<BR>
--------------------------------<BR>
</L>
<R>合计：327.83元<BR></R><BR>
<L>客户地址：珠海市香洲区xx路xx号<BR>
客户电话：1363*****88<BR>
下单时间：2020-9-9 15:07:57<BR>
备注：少放辣 不吃香菜<BR>
</L>
<QRCODE s=8 e=L l=center>http://www.xpyun.net</QRCODE><BR>
 
                   <TABLE col="10,10,12" w=1 h=1 b=1 lh=68> <tr> <td> col:每一列的宽度，参数和必须等于32(58机器)或者48(80机器)，
    w: 表格内字符宽度,取值1-5，h: 表格内字符高度取值1-5, 
    b: 是否加粗，0不加粗，1加粗 。lh: 行高，取值1-255 


    使用举例说明：
      <TABLE col="10,10,12" w=1 h=1 b=1 lh=68>  
          <tr>辣椒炒肉(放葱)加西瓜<td>    1份<td>52.00</tr> 
          <tr>白切鸡<td>    1份<td>48.00</tr>  
          <tr>深井烧鹅<td> 1份(大)<td>95.00</tr>
 </TABLE> 

--------------------------------<BR>
<R>合计：327.83元<BR></R><BR>
<L>客户地址：珠海市香洲区xx路xx号<BR>
客户电话：1363*****88<BR>
下单时间：2020-9-9 15:07:57<BR>
备注：少放辣 不吃香菜<BR>
</L>
<QRCODE s=8 e=L l=center>http://www.xpyun.net</QRCODE><BR>
 
                  
 多语言支持：
     <lc> 中文简体（可以包含英文和数字）
     <le> 俄文( 代码页59 可以包含英文和数字)    
     <lr> 俄文( 代码页17 可以包含英文和数字)
     <ls> 西班牙文( 可以包含英文和数字)
     <lh> 泰文( 可以包含英文和数字)
     <lu> 维吾尔文( 可以包含英文和数字，只在行首有效，必须在行首)
     <lv> 越南文( 可以包含英文和数字)

     <lj> 日文( 可以包含英文和数字)    
     <lk> 韩文( 可以包含英文和数字)    
     <lt> 中文繁体( 可以包含英文和数字)
     <ly> 土耳其语( 可以包含英文和数字)

    每种语言只支持 和中文 英文混打，不支持相互混合打印，比如支持 中英越 混合打印，但不支持 越泰混合打印
  使用举例说明：
      <lc> Russian, 中文, use example:<BR><le>Никогда не бойтесь<BR>
      <lc> Russian, 中文, use example:<BR><lr>просто приятно <BR>
      <lc> Spanish, 中文:<BR><ls>pues el niño recién nacido había <BR>
  
                   特殊字符打印 "<" 和 ">" :  "<" 用 &lt ， ">" 用 &gt  
  使用举例说明：
    <L>你好301&lt<BR></L> <L>你好302&gt<BR></L>  
                 开启钱箱指令 <CASHBOX0> 和 <CASHBOX1> : <CASHBOX0> 常用，用于开2号脚的钱箱开启，<CASHBOX1> 个别钱箱用，
    用于开5号脚的钱箱  
 
                   多logo打印 <LOGO p=2 m=0></LOGO> : <LOGO p=2 m=0> p取值1-8,表示第几个logo,m取值0-3 
       0正常，1倍宽，2倍高，3倍高倍宽  m参数可不传，p必须指定，例子：<LOGO p=1></LOGO>  
 
                 人民币￥ 美元$ 英镑￡ 欧元€ 特殊符号   <CY ct=1></CY> : <CY ct=1></CY> ct取值1-3,1 人民币 2 英镑 3 美元  <CY ct=5 l=06>80</CY1> 这个是欧元

票据标签效果示例图：

票据排版效果示例图：

返回参数说明：

参数名	类型	说明
data	string	正确返回订单编号

请求示例：

{
    "sn": "XPY123456789A",
    "content": "----货到付款----",
    "copies": 1,     "voice": 2,
    "user": "testuser",
    "timestamp": "1565417654",
    "sign": "82bdcbe2cf6ac4923339b13c2aad1f95ddf0b0a8",
    "debug": "0"
}

返回示例：

成功：当打印机离线时：msg为PRINTER_OFFLINE 否则为ok

  {
      "msg":"ok",
      "code":0,
      "data":"OM19081005450140628261",
      "serverExecutedTime":23
  }

失败：

{
    "msg":"PRINTER_NOT_REGISTER",
    "code":1002,
    "data":null,
    "serverExecutedTime":25
}

4、打印标签订单

功能描述：

发送用户需要打印的订单内容给芯烨云标签打印机（该接口只能是标签机使用，目前支持机型（XP-T271U、XP-320B），其它型号打印机请勿使用该接口）

请求接口：

https://open.xpyun.net/api/openapi/xprinter/printLabel

请求方式：

POST

特别注意：

1、开发者自己写的请求以表单方式提交数据，请求头需要使用Content-Type: application/json;charset=UTF-8，请勿使用其它方式提交数据；
2、打印内容内（标签除外）大于号和小于号需要经过转译才能正常打印。其中，“<”用“&lt”表示，“>”用“&gt”表示；
3、1mm=8dots。

公共参数：

所有请求都必须传递的参数。

sign参数说明：例如：user=acc、UserKEY=abc、timestamp=acbc，那么先拼成字符串accabcacbc，再将此字符串进行SHA1加密，得到sign。

参数名	是否必须	类型	说明
user	必须	string	芯烨云平台注册用户名
timestamp	必须	string	当前UNIX时间戳，10位，精确到秒
sign	必须	string	对参数 user + UserKEY + timestamp 拼接后（+号表示连接符）进行SHA1加密得到签名，值为40位小写字符串，其中 UserKEY 为用户开发者密钥
debug	可选	string	debug=1返回非json格式的数据，仅测试时候使用

私有参数：

参数名	是否必须	类型	说明
sn	必须	string	打印机编号
content	必须	string	打印内容,打印内容使用 GBK 编码判断,不能超过12K
copies	可选	int	打印份数，默认为1，取值[1-65535]，超出范围将视为无效参数
voice	可选	int	声音播放模式，0 为取消订单模式，1 为静音模式，2 为来单播放模式，3 为有用户申请退单了，默认为 2 来单播放模式
mode	可选	int	打印模式：值为 0 或不指定则会检查打印机是否在线，如果不在线则不生成打印订单，直接返回设备不在线状态码；如果在线则生成打印订单，并返回打印订单号。值为 1 不检查打印机是否在线，直接生成打印订单，并返回打印订单号。如果打印机不在线，订单将缓存在打印队列中，打印机正常在线时会自动打印。
expiresIn	可选	int	订单有效期，单位：秒。订单打印时，超过该时间的订单将不会自动加载打印，当参数设置为 0 时，将采用系统默认设置值。使用该参数时，需要将参数mode 设置为1。取值范围：0 < expiresIn < 86400。
backurlFlag	可选	int	打印订单状态回调标识。取值范围：[ 1 - 5 ]的整数，对应于芯烨云开放平台管理后台 “功能设置” 菜单界面的打印接口回调标识。
idempotent	可选	string	唯一订单号标识,用于去重。长度范围：[ 1 - 50 ]个字符，建议20个字符以内，5分钟内同一个开发者账号如果有两个订单号相同，第二个订单将不会打印。
payType	可选	int	支付方式：取值范围41~55：支付宝 41、微信 42、云支付 43、银联刷卡 44、银联支付 45、会员卡消费 46、会员卡充值 47、翼支付 48、成功收款 49、嘉联支付 50、壹钱包 51、京东支付 52、快钱支付 53、威支付 54、享钱支付 55 仅用于支持金额播报的芯烨云打印机。
payMode	可选	int	支付与否：取值范围59~61：退款 59 到账 60 消费 61。仅用于支持金额播报的芯烨云打印机。
money	可选	float	支付金额：最多允许保留2位小数。仅用于支持金额播报的芯烨云打印机。

打印模板排版控制标签说明：(详情请参考打印模板样例和SDK示例)

 <PAGE n="2" l="2"></PAGE>：
 分页，用于支持打印多张不同的标签页面，不使用该标签表示所有元素只打印在一个标签页
 属性 n 为当前页打印份数，必须为正整数，当n不指定时，默认为打印1份
 属性 l 为当前两个标签纸之间的间隙。当l不指定时，默认为2mm 

 <SIZE>width,height</SIZE>：
 设置标签纸宽高，width 标签纸宽度(不含背纸)，height 标签纸高度(不含背纸)，单位mm，如<SIZE>40,30</SIZE> ，且
每个打印的标签（物理标签）都必须包含此标签，放到PAGE标签页里面才生效。否则有可能产生跳空白标签的问题
以下属性x、y均以dot为单位。例如标签纸大小为：宽40mm，高度为30mm。1mm=8dot
    x的最大值就是40*8=320，x的取值范围是0-320。
    y的最大值就是为30*8=240，y的取值范围是0-240。

 <TEXT x="10" y="100" font="9" w="1" h="2" r="0">文本内容</TEXT>：
 打印文本，其中：
 属性 x 为水平方向起始点坐标（默认为0）
 属性 y 为垂直方向起始点坐标（默认为0）
 属性 font 为字体，仅支持以下参数:
     1、 8 x 12 dot 英数字体
     2、 12 x 20 dot英数字体
     3、 16 x 24 dot英数字体
     4、 24 x 32 dot英数字体
     5、 32 x 48 dot英数字体
     6、 14 x 19 dot英数字体 OCR-B 
     7、 21 x 27 dot 英数字体OCR-B 
     8、 14 x25 dot英数字体OCR-A 
     9、 简体中文 24dot x 24dot font (GB 码)(3mm X 3mm) 
 属性 w 为文字宽度放大倍率1-10（默认为1）
 属性 h 为文字高度放大倍率1-10（默认为1）
 属性 r 为文字旋转角度(顺时针方向，默认为0)，仅支持以下参数值设置：
     0     0度
     90   90度
     180 180度
     270度
     13、韩文(新增)

 <BC128 x="10" y="100" h="60" s="1" n="1" w="1" r="0">1234567</BC128>：
 打印code128一维码，其中：
 属性 x 为水平方向起始点坐标（默认为0）
 属性 y 为垂直方向起始点坐标（默认为0）
 属性 h 为条形码高度（默认为48）
 属性 s 是否人眼可识：0 不可识，1 可识（默认为1） 
 属性 n 为窄 bar 宽度，以点(dot)表示（默认为1）
 属性 w 为宽 bar 宽度，以点(dot)表示（默认为1） 
 属性 r 为文字旋转角度 (顺时针方向，默认为0)，仅支持以下参数值设置：
     0     0度
     90   90度
     180 180度
     270 270度

 <BC39 x="10" y="100" h="60" s="1" n="1" w="1" r="0">1234567</BC39>：
 打印code39一维码，其中：
 属性 x 为水平方向起始点坐标（默认为0）
 属性 y 为垂直方向起始点坐标（默认为0）
 属性 h 为条形码高度（默认为48）
 属性 s 是否人眼可识：0 不可识，1 可识（默认为1）
 属性 n 为窄 bar 宽度，以点(dot)表示（默认为1）
 属性 w 为宽 bar 宽度，以点(dot)表示（默认为2）
 属性 r 为文字旋转角度(顺时针方向，默认为0)，仅支持以下参数值设置：
     0     0度
     90   90度
     180 180度
     270度

 <QRC x="20" y="20" s="2" e="L">二维码内容</QRC>：
 打印二维码，标签内容是二维码值, 最大不能超过256个字符，其中：
 属性 x 为水平方向起始点坐标(默认为0)，取值范围（0至标签宽度*8）1 mm=8 dots
 属性 y 为垂直方向起始点坐标(默认为0)，取值范围（0至标签高度*8）1 mm=8 dots
 属性 s 为二维码打印大小(默认为2 取值1-10)
 属性 e 为二维码纠错等级(默认为L 取值L/M/Q/H)

<IMG x="16" y="32" w="100">：
打印LOGO图片，需登录开放平台在【打印管理➜设备管理】下通过设置LOGO功能进行上传。此处直接
写入空标签,若指定了<PAGE>标签，<IMG>标签应该放到<PAGE>标签里面， <IMG>, 如 <IMG>即可, 具
体可参考样例。其中：
属性 x 为水平方向起始点坐标（默认为0）
属性 y 为垂直方向起始点坐标（默认为0）
属性 w 为logo图片最大宽度（默认为50），最小值为20，最大值为100。logo图片的高度和宽度相等

<SEQ x="8" y="8" xe="100" ye="100" s="4">：
打印方框。其中：
属性 x 为水平方向起始点坐标（默认为0）
属性 y 为垂直方向起始点坐标（默认为0）
属性 xe 为水平方向结束点坐标（默认为0）
属性 ye 为垂直方向结束点坐标（默认为0）
属性 s 为方框线条打印大小（默认为4 取值1-10）。

<L x="20" y="20" w="4" h="250">：
打印表格线。其中：
属性 x 为水平方向起始点坐标（默认为0）
属性 y 为垂直方向起始点坐标（默认为0）
属性 w 为线条的宽度（默认为4 取值1-1000）
属性 h 为线条的高度（默认为4 取值1-1000）

 打印订单效果示例，点击下载以下 html 标签格式的打印内容参考。

 标签机打印订单例子  下载

标签机效果示例图：

返回参数说明：

参数名	类型	说明
data	string	正确返回订单编号

请求示例：

{
    "sn": "XPY123456789A",
    "content": "<TEXT x=\"10\" y=\"100\" font=\"9\" w=\"1\" h=\"2\" r=\"0\">测试文本内容1</TEXT>",
    "copies": 1,    "voice": 2,
    "user": "testuser",
    "timestamp": "1565417654",
    "sign": "82bdcbe2cf6ac4923339b13c2aad1f95ddf0b0a8",
    "debug": "0"
}

返回示例：

成功：当打印机离线时：msg为PRINTER_OFFLINE 否则为ok

  {
      "msg":"ok",
      "code":0,
      "data":"OM19081005450140628261",
      "serverExecutedTime":23
  }

失败：

{
    "msg":"PRINTER_NOT_REGISTER",
    "code":1002,
    "data":null,
    "serverExecutedTime":25
}

5、批量删除打印机

功能描述：

批量删除打印机

请求接口：

https://open.xpyun.net/api/openapi/xprinter/delPrinters

请求方式：

POST

特别注意：

开发者自己写的请求以表单方式提交数据，请求头需要使用Content-Type: application/json;charset=UTF-8，请勿使用其它方式提交数据

公共参数：

所有请求都必须传递的参数。

参数名	是否必须	类型	说明
user	必须	string	芯烨云平台注册用户名（开发者 ID）
timestamp	必须	string	当前UNIX时间戳，10位，精确到秒
sign	必须	string	对参数 user + UserKEY + timestamp 拼接后（+号表示连接符）进行SHA1加密得到签名，值为40位小写字符串，其中 UserKEY 为用户开发者密钥
debug	可选	string	debug=1返回非json格式的数据，仅测试时候使用

sign参数说明：例如：user=acc、UserKEY=abc、timestamp=acbc，那么先拼成字符串accabcacbc，再将此字符串进行SHA1加密，得到sign。

私有参数：

参数名	是否必须	类型	说明
snlist	必须	array	打印机编号集合，类型为字符串数组

返回参数说明：

参数名	类型	说明
data	object	返回1个 json 对象，包含成功和失败的信息，详看示例

请求示例：

{
    "snlist": ["XPY123456789A", "XPY987654321B", "XPY123456723A", "XPY987654345B"],
    "user": "testuser",
    "timestamp": "1565417654",
    "sign": "82bdcbe2cf6ac4923339b13c2aad1f95ddf0b0a8",
    "debug": "0"
}

返回示例：

成功：示例解读：总共删除4台打印机设备，删除成功2台，删除失败2台，失败原因可通过failMsg字段的原因代码1010到接口返回码中查询具体失败原因。

{
    "msg":"ok",
    "code":0,
    "data":{"success": ["XPY123456789A","XPY987654321B"], "fail": ["XPY123456723A","XPY987654345B"], "failMsg": ["XPY123456723A:1010","XPY987654345B:1010"]},
    "serverExecutedTime":1
}

失败：

{
    "msg":"REQUEST_USER_NOT_REGISTER",
    "code":-4,
    "data":null,
    "serverExecutedTime":1
}

6、修改打印机信息

功能描述：

修改打印机信息

请求接口：

https://open.xpyun.net/api/openapi/xprinter/updPrinter

请求方式：

POST

特别注意：

开发者自己写的请求以表单方式提交数据，请求头需要使用Content-Type: application/json;charset=UTF-8，请勿使用其它方式提交数据

公共参数：

所有请求都必须传递的参数。

参数名	是否必须	类型	说明
user	必须	string	芯烨云平台注册用户名（开发者 ID）
timestamp	必须	string	当前UNIX时间戳，10位，精确到秒
sign	必须	string	对参数 user + UserKEY + timestamp 拼接后（+号表示连接符）进行SHA1加密得到签名，值为40位小写字符串，其中 UserKEY 为用户开发者密钥
debug	可选	string	debug=1返回非json格式的数据，仅测试时候使用

sign参数说明：例如：user=acc、UserKEY=abc、timestamp=acbc，那么先拼成字符串accabcacbc，再将此字符串进行SHA1加密，得到sign。

私有参数：

参数名	是否必须	类型	说明
sn	必须	string	打印机编号
name	必须	string	打印机名称
cardno	可选	string	打印机流量卡号码

返回参数说明：

参数名	类型	说明
data	bool	返回布尔类型：true 表示成功 false 表示失败

请求示例：

{
    "sn": "XPY123456789A",
    "name": "X58C1",
    "cardno": "13031547528",
    "user": "testuser",
    "timestamp": "1565417654",
    "sign": "82bdcbe2cf6ac4923339b13c2aad1f95ddf0b0a8",
    "debug": "0"
}

返回示例：

成功：

{
    "msg":"ok",
    "code":0,
    "data":true,
    "serverExecutedTime":1
}

失败：

{
    "msg":"SN_USER_NOT_MATCH",
    "code":1001,
    "data":false,
    "serverExecutedTime":1
}

7、清空待打印队列

功能描述：

清空指定打印机的待打印任务队列

请求接口：

https://open.xpyun.net/api/openapi/xprinter/delPrinterQueue

请求方式：

POST

特别注意：

开发者自己写的请求以表单方式提交数据，请求头需要使用Content-Type: application/json;charset=UTF-8，请勿使用其它方式提交数据

公共参数：

所有请求都必须传递的参数。

参数名	是否必须	类型	说明
user	必须	string	芯烨云平台注册用户名（开发者 ID）
timestamp	必须	string	当前UNIX时间戳，10位，精确到秒
sign	必须	string	对参数 user + UserKEY + timestamp 拼接后（+号表示连接符）进行SHA1加密得到签名，值为40位小写字符串，其中 UserKEY 为用户开发者密钥
debug	可选	string	debug=1返回非json格式的数据，仅测试时候使用

sign参数说明：例如：user=acc、UserKEY=abc、timestamp=acbc，那么先拼成字符串accabcacbc，再将此字符串进行SHA1加密，得到sign。

私有参数：

参数名	是否必须	类型	说明
sn	必须	string	打印机编号

返回参数说明：

参数名	类型	说明
data	bool	返回布尔类型：true 表示成功 false 表示失败

请求示例：

{
    "sn": "XPY123456789A",
    "user": "testuser",
    "timestamp": "1565417654",
    "sign": "82bdcbe2cf6ac4923339b13c2aad1f95ddf0b0a8",
    "debug": "0"
}

返回示例：

成功：

{
    "msg":"ok",
    "code":0,
    "data":true,
    "serverExecutedTime":1
}

失败：

{
    "msg":"PRINTER_NOT_REGISTER",
    "code":1002,
    "data":false,
    "serverExecutedTime":1
}

8、查询订单是否打印成功

功能描述：

根据订单编号查询订单是否打印成功，订单编号由“打印订单”接口返回

请求接口：

https://open.xpyun.net/api/openapi/xprinter/queryOrderState

请求方式：

POST

特别注意：

开发者自己写的请求以表单方式提交数据，请求头需要使用Content-Type: application/json;charset=UTF-8，请勿使用其它方式提交数据

公共参数：

所有请求都必须传递的参数。

参数名	是否必须	类型	说明
user	必须	string	芯烨云平台注册用户名（开发者 ID）
timestamp	必须	string	当前UNIX时间戳，10位，精确到秒
sign	必须	string	对参数 user + UserKEY + timestamp 拼接后（+号表示连接符）进行SHA1加密得到签名，值为40位小写字符串，其中 UserKEY 为用户开发者密钥
debug	可选	string	debug=1返回非json格式的数据，仅测试时候使用

sign参数说明：例如：user=acc、UserKEY=abc、timestamp=acbc，那么先拼成字符串accabcacbc，再将此字符串进行SHA1加密，得到sign。

私有参数：

参数名	是否必须	类型	说明
orderId	必须	string	订单编号，由“打印订单”接口返回

返回参数说明：

参数名	类型	说明
data	bool	已打印返回true,未打印返回false

请求示例：

{
    "orderId": "OM19081005152569029225",
    "user": "testuser",
    "timestamp": "1565417654",
    "sign": "82bdcbe2cf6ac4923339b13c2aad1f95ddf0b0a8",
    "debug": "0"
}

返回示例：

成功：

{
    "msg":"ok",
    "code":0,
    "data":true,
    "serverExecutedTime":1
}

失败：

{
    "msg":"ORDER_NOT_FOUND",
    "code":1005,
    "data":false,
    "serverExecutedTime":1
}

9、查询指定打印机某天的订单统计数

功能描述：

查询指定打印机某天的订单详情，返回已打印订单数和等待打印数。

请求接口：

https://open.xpyun.net/api/openapi/xprinter/queryOrderStatis

请求方式：

POST

特别注意：

开发者自己写的请求以表单方式提交数据，请求头需要使用Content-Type: application/json;charset=UTF-8，请勿使用其它方式提交数据

公共参数：

所有请求都必须传递的参数。

参数名	是否必须	类型	说明
user	必须	string	芯烨云平台注册用户名（开发者 ID）
timestamp	必须	string	当前UNIX时间戳，10位，精确到秒
sign	必须	string	对参数 user + UserKEY + timestamp 拼接后（+号表示连接符）进行SHA1加密得到签名，值为40位小写字符串，其中 UserKEY 为用户开发者密钥
debug	可选	string	debug=1返回非json格式的数据，仅测试时候使用

sign参数说明：例如：user=acc、UserKEY=abc、timestamp=acbc，那么先拼成字符串accabcacbc，再将此字符串进行SHA1加密，得到sign。

私有参数：

参数名	是否必须	类型	说明
sn	必须	string	打印机编号
date	必须	string	查询日期，格式yy-MM-dd，如：2019-08-15

返回参数说明：

参数名	类型	说明
data	object	json对象，返回已打印订单数和等待打印订单数，如：{"printed": 2, "waiting": 0}

请求示例：

{
    "sn": "XPY123456789A",
    "date": "2019-08-15",
    "user": "testuser",
    "timestamp": "1565417654",
    "sign": "82bdcbe2cf6ac4923339b13c2aad1f95ddf0b0a8",
    "debug": "0"
}

返回示例：

成功：

{
    "msg":"ok",
    "code":0,
    "data":{"printed": 2, "waiting": 0},
    "serverExecutedTime":1
}

失败：

{
    "msg":"ORDER_DATE_INVALID",
    "code":1006,
    "data":null,
    "serverExecutedTime":1
}

10、获取指定打印机状态

功能描述：

查询指定打印机状态，返回该打印机在线或离线，正常或异常的状态信息。

请求接口：

https://open.xpyun.net/api/openapi/xprinter/queryPrinterStatus

请求方式：

POST

特别注意：

开发者自己写的请求以表单方式提交数据，请求头需要使用Content-Type: application/json;charset=UTF-8，请勿使用其它方式提交数据

公共参数：

所有请求都必须传递的参数。

参数名	是否必须	类型	说明
user	必须	string	芯烨云平台注册用户名（开发者 ID）
timestamp	必须	string	当前UNIX时间戳，10位，精确到秒
sign	必须	string	对参数 user + UserKEY + timestamp 拼接后（+号表示连接符）进行SHA1加密得到签名，值为40位小写字符串，其中 UserKEY 为用户开发者密钥
debug	可选	string	debug=1返回非json格式的数据，仅测试时候使用

sign参数说明：例如：user=acc、UserKEY=abc、timestamp=acbc，那么先拼成字符串accabcacbc，再将此字符串进行SHA1加密，得到sign。

私有参数：

参数名	是否必须	类型	说明
sn	必须	string	打印机编号

返回参数说明：

参数名	类型	说明
data	int	返回打印机状态值，共三种： 0 表示离线 1 表示在线正常 2 表示在线异常备注：异常一般情况是缺纸，离线的判断是打印机与服务器失去联系超过 30 秒

请求示例：

{
    "sn": "XPY123456789A",
    "user": "testuser",
    "timestamp": "1565417654",
    "sign": "82bdcbe2cf6ac4923339b13c2aad1f95ddf0b0a8",
    "debug": "0"
}

返回示例：

成功：

{
    "msg":"ok",
    "code":0,
    "data":1,
    "serverExecutedTime":1
}

失败：

{
    "msg":"REQUEST_PARAM_INVALID",
    "code":-2,
    "data":0,
    "serverExecutedTime":1
}

11、批量获取指定打印机状态

功能描述：

批量获取指定打印机状态，返回该打印机在线或离线，正常或异常的状态信息。

请求接口：

https://open.xpyun.net/api/openapi/xprinter/queryPrintersStatus

请求方式：

POST

特别注意：

开发者自己写的请求以表单方式提交数据，请求头需要使用Content-Type: application/json;charset=UTF-8，请勿使用其它方式提交数据

公共参数：

所有请求都必须传递的参数。

参数名	是否必须	类型	说明
user	必须	string	芯烨云平台注册用户名（开发者 ID）
timestamp	必须	string	当前UNIX时间戳，10位，精确到秒
sign	必须	string	对参数 user + UserKEY + timestamp 拼接后（+号表示连接符）进行SHA1加密得到签名，值为40位小写字符串，其中 UserKEY 为用户开发者密钥
debug	可选	string	debug=1返回非json格式的数据，仅测试时候使用

sign参数说明：例如：user=acc、UserKEY=abc、timestamp=acbc，那么先拼成字符串accabcacbc，再将此字符串进行SHA1加密，得到sign。

私有参数：

参数名	是否必须	类型	说明
snlist	必须	array	打印机编号数组（一次最多查询 20 台设备）

返回参数说明：

参数名	类型	说明
data	array	批量返回打印机状态值，顺序与请求时设备编号的顺序对应，共三种： 0 表示离线 1 表示在线正常 2 表示在线异常备注：异常一般情况是缺纸，离线的判断是打印机与服务器失去联系超过 30 秒

请求示例：

{
    "snlist": ["XPY123456789A", "XPY123456789B"],
    "user": "testuser",
    "timestamp": "1565417654",
    "sign": "82bdcbe2cf6ac4923339b13c2aad1f95ddf0b0a8",
    "debug": "0"
}

返回示例：

成功：

{
    "msg":"ok",
    "code":0,
    "data":[0, 1],
    "serverExecutedTime":1
}

失败：

{
    "msg":"REQUEST_PARAM_INVALID",
    "code":-2,
    "data":[0, 0],
    "serverExecutedTime":1
}

12、金额播报

功能描述：

发送用户需要播报的语音内容给支持金额播报的芯烨云打印机

请求接口：

https://open.xpyun.net/api/openapi/xprinter/playVoice

请求方式：

POST

特别注意：

开发者自己写的请求以表单方式提交数据，请求头需要使用Content-Type: application/json;charset=UTF-8，请勿使用其它方式提交数据

公共参数：

所有请求都必须传递的参数。

参数名	是否必须	类型	说明
user	必须	string	芯烨云平台注册用户名（开发者 ID）
timestamp	必须	string	当前UNIX时间戳，10位，精确到秒
sign	必须	string	对参数 user + UserKEY + timestamp 拼接后（+号表示连接符）进行SHA1加密得到签名，值为40位小写字符串，其中 UserKEY 为用户开发者密钥
debug	可选	string	debug=1返回非json格式的数据，仅测试时候使用

sign参数说明：例如：user=acc、UserKEY=abc、timestamp=acbc，那么先拼成字符串accabcacbc，再将此字符串进行SHA1加密，得到sign。

私有参数：

参数名	是否必须	类型	说明
sn	必须	string	打印机编号
payType	可选	int	支付方式：取值范围41~55：支付宝 41、微信 42、云支付 43、银联刷卡 44、银联支付 45、会员卡消费 46、会员卡充值 47、翼支付 48、成功收款 49、嘉联支付 50、壹钱包 51、京东支付 52、快钱支付 53、威支付 54、享钱支付 55 仅用于支持金额播报的芯烨云打印机。
payMode	可选	int	支付与否：取值范围59~61：退款 59 到账 60 消费 61。仅用于支持金额播报的芯烨云打印机。
money	可选	float	支付金额：最多允许保留2位小数。仅用于支持金额播报的芯烨云打印机。

返回参数说明：

参数名	类型	说明
data	string	正确返回0

请求示例：

{
    "sn": "XPY123456789A",
    "payType": 41,
    "payMode": 60,
    "money": 25.5,
    "user": "testuser",
    "timestamp": "1565417654",
    "sign": "82bdcbe2cf6ac4923339b13c2aad1f95ddf0b0a8",
    "debug": "0"
}

返回示例：

成功：

  {
      "msg":"ok",
      "code":0,
      "data":"0",
      "serverExecutedTime":23
  }

失败：

{
    "msg":"PRINTER_NOT_REGISTER",
    "code":1002,
    "data":null,
    "serverExecutedTime":25
}

返回状态码说明

返回码	状态	返回 msg 字段信息	排错指引
0	成功	ok
-1	请求头错误	REQUEST_HEADER_ERROR	(1)检查接口请求头是否指定 Content-Type: application/json;charset=UTF-8 参数 (2)接口调用出现415错误提示，检查请求头是否设置正确，接口提交参数是否符合文档要求说明 (3)确保您发送的是正确的Content-Type标头值 (4)确认服务器可以处理Content-Type标头中定义的值 (5)检查Accept标头以查看服务器可以处理的内容。
-2	参数不合法	REQUEST_PARAM_INVALID	(1)参数值为空或格式、大小不符合要求 (2)检查接口调用必填参数是否符合文档要求
-3	参数签名失败	REQUEST_SIGN_FAILED	(1)请参考请求公共参数 sign 字段说明 (2)检查开发者秘钥或开发者ID是否包含空白字符
-4	用户未注册	REQUEST_USER_NOT_REGISTER	需前往立即注册
1001	打印机编号和用户不匹配	SN_USER_NOT_MATCH	打印机尚未添加至云平台，需要登录云平台添加或使用添加接口添加方可使用
1002	打印机未注册	PRINTER_NOT_REGISTER	打印机尚未添加至云平台，需要登录云平台添加或使用添加接口添加方可使用
1003	打印机不在线	PRINTER_OFFLINE	检查打印机是否正常联网或打印机所处网络环境是否可以正常访问互联网
1004	添加订单失败	ADD_ORDER_FAILED	检查订单内容中是否有存在非法使用的标签，如空标签
1005	未找到订单信息	ORDER_NOT_FOUND	检查订单号是否是云端接口返回的订单号
1006	订单日期格式或大小不正确	ORDER_DATE_INVALID
1007	打印内容不能超过12K	PRINT_CONTENT_MORE_THAN_12K_BYTES	打印超出12K需要自己结合业务使用做数据拆分。
1008	用户修改打印机记录失败	PRINTER_RECORD_LOCK_FAIL
1009	用户添加打印机时，打印机编号或名称不能为空	SN_OR_NAME_EMPTY	设备编号和名称为必填项，不可省略
1010	打印机设备编号无效	PRINTER_NUMBER_INVALID	当前打印机不是云打印机或打印机编号输入错误，需输入打印机底部或背部带(sn/pid)字样后面的一串英文数字字符组合的编号
1011	打印机已存在，若当前开放平台无法查询到打印机信息，请联系售后技术支持人员核实	PRINTER_EXIST	打印机已添加至云平台，若需再次添加，需在云平台删除，或调用删除(delPrinters)接口删除
1012	添加打印设备失败，请稍后再试或联系售后技术支持人员	PRINTER_EXCEPTION
1013	打印订单时触发幂等性	ORDER_IDEMPOTENT	根据幂等因子，排查是否出现重复提交订单打印内容且幂等因子要保证全局唯一
1014	幂等因子过长	ORDER_IDEMPOTENT_LIMITLEN	幂等因子有效长度为50个字符，可参考调整幂等因子长度
1016	LOGO文件格式错误	LOGO_FORMAT_ERROR	(1)请检查上传的logo文件需符合图片格式(如：png，jpg) (2)上传的图片内容需使用base64加密获得 (3)上传的图片数据需去掉‘data:image/png;base64,’或‘data:image/jpeg;base64,’等前缀
1017	LOGO文件超出规定范围	LOGO_SIZE_LARGE	logo文件大小不能超出30kb
1018	LOGO上传次数超限制	LOGO_UPLOAD_TIMES	logo文件上传每天限制最多可操作3次，若出现此提示，等待次日再上传即可，开发者不需要做其他操作
1020	LOGO删除失败	LOGO_DELETE_NO_EXIST	logo文件已删除或尚未上传，若确认已上传但还是提示该错误，需联系技术人员排查
1021	LOGO上传模式错误	LABEL_MODE_ERROR	针对标签打印机logo文件上传需在标签打印模式下上传，针对小票模式操作无效，可以通过打印自检页方式查看当前标签机的打印模式
1022	该设备属于定制设备，您当前无权使用		该打印机指定了所属账号，不能添加，有疑问请联系客服

1、微信配网操作.(☞点击进入)

2、APP配网操作.(☞点击进入)

3、手动配网操作.(☞点击进入)

4、浏览器配网操作.(☞点击进入)

5、手机热点连接操作.(☞点击进入)

6、云标签打印机（T271U,320B等机型)打印模式切换.(☞点击进入)

7、4G版SIM卡插取操作.(☞点击进入)

8、芯烨2-3寸标签打印机装纸操作.(☞点击进入)

9、芯烨58系列产品装纸操作.(☞点击进入)

10、芯烨云票据机打印自检页操作.(☞点击进入)

11、芯烨云票据机恢复出厂设置.(☞点击进入)

1、芯烨云 (T895H,T503等机型) 带扫描头打印机回调对接使用说明文档.(☞点击进入)

2、条码云打印机java版本SDK使用说明.(☞点击进入)

3、条码云打印机开放 API 开发接入文档v1.9.2.(☞点击进入)

4、芯烨票据产品打印测试工具V3.2C.(

点击下载)

5、芯烨云开放API开发接入1.9.2文档(☞点击进入)

6、芯烨云开放API开发接入1.9.2文档_海外版(☞点击进入)

7、芯烨云开放平台订单状态推送使用说明v1.1(☞点击进入)

8、芯烨云打印机状态推送说明v1.1(☞点击进入)

9、wifi配网APP下载(☞点击进入)

10、打印机国外节点切换工具(☞点击进入)

11、港澳台及外国人注册表格(☞点击进入)

开发常见问题
打印机常见问题

1、打印机单行打印多少个字符?

58mm的机器,一行打印16个汉字,32个字母;80mm的机器,一行打印24个汉字,48个字母

2、打印机字体有多少种 ?

常用分正常,倍高,倍宽,放大一倍(倍高倍宽)4种,具体可以查看api中的标签

3、二维码的大小和位置是否可以调整?

大小不能调整,根据内容的长度,动态生成,位置固定是最底部居中

4、芯烨云打印系统是免费的吗 ?

是的，购买打印机即可免费使用云打印系统，不收额外服务费

5、如何排版对齐名称,价格等?

程序判断名称的占用的字节数,然后补空格对齐

6、打印完订单的状态是实时更新的吗?

不是,服务器有5秒的缓存,就是说打印完的订单,5秒后才能查询到状态更新

7、如何区分打印机是58mm打印机还是80mm打印机?

通过打印机设备编号前两位来区分。设备编号以14、15、41、42、43、47开头的均为80mm设备打印机，除此之外均为58mm打印机。其中29、30、31、32、33、34开头的为标签打印机，其他为票据打印机

8、java版sdk如何使用maven方式引入?

芯烨云JAVA版本sdk目前已支持maven方式引入了。以1.0.1版本为例，在maven工程的pom.xml中使用以下方式引入到自己的项目中：

<dependency>
  <groupId>com.gitee.gsocode</groupId>
  <artifactId>xpyun-opensdk</artifactId>
  <version>1.0.1</version>
</dependency>

引入完成之后，还需要在resources/application.properties 配置文件中添加以下配置，即可完成整合sdk的整合，使用时，可以使用注解方式调用。其中开发者密钥需要实名认证通过后在开放平台管理后台首页获取

#中国节点 开放平台接口地址
xp.dev.domain=https://open.xpyun.net
#德国节点 开放平台接口地址
#xp.dev.domain=https://gm.open.xpyun.net
#新加坡节点 开放平台接口地址
#xp.dev.domain=https://sg.open.xpyun.net
#开发者ID
xp.dev.user=xxxxxxxx
#开发者密钥
xp.dev.user-key=xxxxxxxxxxxxxxxxxx

9、如何运行测试nodejs版本的sdk?

在window系统上,打开cmd命令窗口，传到sdk解压后 chinese-demo.js（英文版：english-demo.js）所在目录，使用 npm install 分别安装 iconv-lite、request和request-promise 依赖库。
在cmd窗口，分别输入以下三条命令，每输入完一条命令，需按回车键执行 npm install request-promise --save、npm install request --save、npm install iconv-lite --save。待安装完毕后，紧接着输入 node chinese-demo.js 按回车健即可运行chinese-demo.js解注释的相关方法。其他参数配置参见sdk注释说明修改

10、芯烨云打印机支持的语言有哪些?

其中日语、韩语、越南语、土耳其语、俄罗斯语、西班牙语、泰文打印时需要在对应语言的前面加上对应语言切换标签，其他语言在订单行首加对应标签即可切换。若多种语言混合打印时，需要在对应的语言前面加上对应语言标签切换。

简体中文标签：<lc>
繁体中文标签：<lt>
日语标签：<lj>
韩语标签：<lk>
维语标签，仅打印订单行首有效：<lu>
越南语标签：<lv>
土耳其语标签：<ly>
俄罗斯语：<le>
西班牙语：<ls>
泰文：<lh>

11、java版sdk如何打包至本地maven库?

在window系统里面打开cmd命令窗口，使用cd命令进入xpyun-opensdk.jar所在目录，然后执行如下命令加到本地maven库： mvn install:install-file -DgroupId=net.xpyun.platform -DartifactId=xpyun-opensdk -Dversion=1.0-SNAPSHOT -Dpackaging=jar -Dfile=xpyun-opensdk.jar 在maven工程中使用以下方式引入到自己的项目中：

<dependency>
  <groupId>net.xpyun.platform</groupId>
  <artifactId>xpyun-opensdk</artifactId>
  <version>1.0-SNAPSHOT</version>
</dependency>

12、有没有取消指定待打印订单的api接口的?

有的，可以参考清空待打印队列，根据文档指定对应的订单编号参数，即可实现清空指定打印订单

13、芯烨云打印支持海外业务打印吗?

支持的。用户需上官网，在网页右侧点击[技术咨询]，扫描二维码进入QQ或企业微信群咨询。

①、海外新加坡开放平台登录地址(☞点击进入)

②、海外德国开放平台登录地址(☞点击进入)

14、打印机如果离线了，离线期间的订单云平台会打印吗？订单时效性参数使用说明是什么?

①.打印模式：值为 0 或不指定则会检查打印机是否在线，如果不在线则不生成打印订单，直接返回设备不在线状态码；如果在线则生成打印订单，并返回打印订单号。值为 1不检查打印机是否在线，直接生成打印订单，并返回打印订单号。如果打印机不在线，订单将缓存在打印队列中，打印机正常在线时会自动打印。 mode参数设置为1，打印机离线期间产生的订单，待打印机重新连接网络之后会打印的，设置0则不打印。
②.订单时效性参数使用说明（print/printLabel）：参数名称 expiresIn 订单有效期，单位：秒，类型：int。参数说明：打印时超过该时间的订单将不会加载打印，当参数设置为0时，将采用系统默认设置值。取值范围：0<订单失效时间<86400。

15、打印订单什么时候出现[重]?

这个是打印机在打印订单的时候。如果一个订单打印未完成。打印机没有纸了。这个时候在打印机不关机的情况下，更换打印纸张，打印机会打印余下的部分订单。并且在完整的打印一份订单。后面这个完整打印的订单会带有“重”字

16、怎么开通推送服务?

芯烨云订单推送服务默认开通，在管理者后台配置好相关回调地址。设备状态推送服务，默认不开通。如果需要，可找管理员开通。同时提供相关回调接口即可。回调接口的域名必须是备案的域名。不支持IP地址形式回调接口

17、海外开放平台管理后台地址是多少，海外用户（含港澳台）用户怎么注册?

①、海外新加坡开放平台登录地址(☞点击进入)

②、海外德国开放平台登录地址(☞点击进入)

注册方式：若海外用户（含港澳台）没有国内身份证等证件，需联系客服获取电子表格，填写后提交给客服，客服将为海外用户处理注册账户及密码并告知用户

18、芯烨云平台支持哪些云打印机呢，有哪里购买地打印机?

①、您好，以下芯烨云打印机介绍地址，可以结合自己的业务场景，选择一款合适的打印机(☞点击跳转)

②、购买机器可以联系我们(☞点击进入) ，各大电商搜索芯烨云打印机

19、标签的尺寸是多少?

XP-T271U：宽度：20mm~60mm    高度：20mm~100mm

XP-320B：宽度：20mm~80mm    高度：20mm~150mm

XP-420B：宽度：20mm~110mm    高度：最小20mm

对以上参数值有疑问的，可以进群咨询我们的开放平台技术人员

20、芯烨传统打印机客服电话多少?

客服热线：400-613-9828
工作时间：周一至周六
08:30-12:00(周六9:00)
13:30-17:30
(法定节假日除外)

21、电子面单打印/条码云打印服务技术支持。 (企业微信二维码)

22、电子面单打印/条码云打印服务（机型XP-T451B/E、XP-420B）开发文档查看

①、条码云打印机开放 API 开发接入文档(☞点击查看)

②、条码云打印机java版本SDK使用说明(☞点击查看)

23、页模式打印机有哪些?

机型	接口	备注
C58H/T58H	U+W+4G+BT	V67.08版本支持
C58H/T58H	U+W+LAN+BT	V75开头的版本支持
58IIHV	U+W+4G+BT	V68.06版本以后支持
C58HV	U+W+4G+BT	V69.03版本以后支持
58IINT/58IINV	U+W+LAN+BT	V74.02版本以后支持
C590H	U+W+4G+BT	V78版本支持

24、打印机状态推送回调URL地址，我在开放平台配置，提示请求地址无效，但自己本地测试可以访问，这个是什么原因呢?

（1）检查域名是否备案，回调地址域名必须备案才能正常使用（2）检查回调接返回值是否符合要求，要求返回 {"data":"OK"} （3）回调地址需支持空参数（POST）请求。

25、打印机状态推送回调URL地址，我在开放平台配置提示成功了。为什么打印机状态发生变化，回调接收不到对应状态变化信息呢?

登录开放平台管理后台，在首页右下方，扫码加群，联系开放平台技术人员，提供自己的开发者ID，申请对回调接口进行授权开通。

26、芯烨云技术支持 (企业微信二维码)

1、 WIFI云打印机如何配网？

①、WIFI云打印机配网方式：

方式一：微信扫码配网(☞点击进入)

方式二：App配网(☞点击进入)

方式三：浏览器配网(☞点击进入)

②、没有WIFI如何用手机热点连接(☞点击进入)

③、云打印机连接不上WIFI常见解决(☞点击进入)

若以上仍无法解决您的问题，微信关注芯烨云自动接单外卖打印机公众号，回复人工，技术人员会及时处理的。

2、云打印机设备号如何查看？

您好，这是云打印机设备号查找教程，请参考教程步骤说明查找设备号(☞点击进入)

3、标签票据模式切换操作?

4、4G打印机SIM卡支持哪几种？

支持移动卡、联通卡和电信卡

5、4G打印机信号质量优,但是连接服务器不成功?

信号质量仅供参考,网络因素很多,可以尝试换一个手机卡试试

6、无线打印机掉线了,订单会漏吗?

由于网络异常情况导致打印机掉线,打印机程序4分钟左右会自动重连,订单是缓存在服务器上面的,机器重连上会继续打印

7、打印订单的时候,刚好没纸了,会漏打吗价格等?

不会,重新装上纸后,等几秒后,会补打一份

8、机器出现问题如何保修?

先电话咨询客服,确认故障,非人为因素机器免费保修一年

9、云打印机的“设备号”在哪里查看?

10、打印机连接完后，打印出来的小票是空白/模糊的，怎么处理?

①、热敏纸只有一面可以打印的，目前出现这种情况，有可能是纸张放反了，点击查看打印机正确放纸操作(☞点击进入)

②、打印模糊处理方式(☞点击进入)

11、怎么识别云打印机?

含有该标签的打印机即是云打印机。

12、怎么使打印机恢复出厂设置?

恢复出厂设置后，可能需要重新配网。打印机恢复出厂设置教程(☞点击进入)

13、打印机硬件返修地址多少?

芯烨云打印机维修地址：广东省珠海市香洲区前山街道华威路613号厂房2栋3楼后门收件人：李女士 0756-3894305 非人为损坏的免费保修一年，运费统一各付各的。注意： 1，麻烦留条“故障现象，如机器没有声音”，方便技术快速定位问题。 2，麻烦留条收件信息（姓名、电话、地址），避免因箱内未留信息导致不能及时返回或无法查件。 3，如果过保或者人为损坏可能会收取维修费用，具体的按照厂家检测为准。 4，电源线和机器，整套寄回检测。

接入指引

接口列表

SDK下载

接口返回码

开发者接入引导说明

接入API步骤

第一步：注册开发者账号

第二步：对接平台API

特别声明

请求公共参数说明

返回公共参数说明

1、添加打印机到开发者账户（可批量）【必接】

2、设置打印机语音类型

3、打印小票订单

4、打印标签订单

5、批量删除打印机

6、修改打印机信息

7、清空待打印队列

8、查询订单是否打印成功

9、查询指定打印机某天的订单统计数

10、获取指定打印机状态

11、批量获取指定打印机状态

12、金额播报

芯烨云API-Java版SDK

芯烨云API-C#版SDK

芯烨云API-PHP版SDK

芯烨云API-GO版SDK

芯烨云API-NodeJS版SDK

芯烨云API-Python版SDK

芯烨云API-小程序版SDK

芯烨云API-安卓SDK

返回状态码说明

接入指引

接口列表

SDK下载

接口返回码

开发者接入引导说明

接入API步骤

第一步：注册开发者账号

第二步：对接平台API

特别声明

请求公共参数说明

返回公共参数说明

1、添加打印机到开发者账户（可批量） 【必接】

2、设置打印机语音类型

3、打印小票订单

4、打印标签订单

5、批量删除打印机

6、修改打印机信息

7、清空待打印队列

8、查询订单是否打印成功

9、查询指定打印机某天的订单统计数

10、获取指定打印机状态

11、批量获取指定打印机状态

12、金额播报

芯烨云API-Java版SDK

芯烨云API-C#版SDK

芯烨云API-PHP版SDK

芯烨云API-GO版SDK

芯烨云API-NodeJS版SDK

芯烨云API-Python版SDK

芯烨云API-小程序版SDK

芯烨云API-安卓SDK

返回状态码说明

1、添加打印机到开发者账户（可批量）【必接】