寄雁传书服务

前提条件

• 设备已接入阿里云物联网平台。具体操作，请参见设备接入。

• 已开通寄雁传书服务。具体操作，请参见开通服务。

使用步骤

使用寄雁传书服务，需要在控制台创建项目和小票模板，然后调用API传入打印参数完成小票打印。

步骤一：创建项目

1. 登录物联网平台控制台，在左侧导航栏选择增值服务。

2. 在增值服务页面，单击寄雁传书服务下的前往服务。

3. 在左侧导航栏中选择项目管理。

4. 在项目管理页面，单击创建项目或者关联项目。

   • 创建项目：创建一个全新的项目。在弹出的对话框中配置以下参数后，单击确定。

     参数	描述
     项目名称/产品名称	项目名称在实例中唯一，支持中文、英文大小写、数字和下划线（_），长度不超过32个字符。
     项目配套产品来源	项目需要绑定具体的产品。 随项目创建一个新的产品：在物联网平台中自动创建一个与项目同名的产品。 通过现有产品创建项目：选择已创建的产品。 如果选择该项，建议使用已创建好的产品名称作为项目名称，方便匹配和识别。
     项目描述	用于备注项目背景信息，支持中文、英文大小写、数字和下划线（_），长度不超过500个字符，1个中文字符占2个字符位。

   • 关联项目：直接使用其他服务已有的项目。在面板中配置以下参数。

     参数	描述
     其它服务	目前仅支持使用千里传音语音播报服务的项目。
     项目列表	选择需要使用的具体项目。

5. 单击确定，创建项目或者关联项目成功，返回项目列表。

   在项目列表中，您可以查看项目ID，编辑、配置、停用项目等操作。

   • 查看项目ID：项目的唯一标识，在通过API进行服务调用时的重要参数。

   • 编辑项目：单击编辑，可以修改项目的描述，项目的名称和配套产品来源不支持修改。

   • 配置项目：单击配置，进入寄雁传书服务项目详情。

步骤二：创建模板

1. 在项目管理页面，单击项目右侧的配置。

2. 在模板管理页面，单击创建模板，填写参数后单击完成。

   参数	说明
   选择场景	针对不同的打印场景提供的基础模板，包括销售、外卖和后厨，请根据需要选择场景。 说明 模板中的参数不支持在控制台修改，进行API调用时传入具体的打印参数。
   模板名称	给模板设置一个方便您辨识的名称，支持中文、英文字母、数字和下划线（_），长度不超过32个字符。
   模板标识	给模板设置一个进行API调用时区分不同模板的标识名称，仅支持英文字母。
   模板规格	根据打印机设备规格进行选择，58mm或者80mm。

3. 单击数据模板，查看打印参数并下载模板至本地。

   数据模板是一个JSON格式的小票打印示例，进行API调用时，您仅需替换JSON示例中的部分值，传入具体的业务数据，即可实现动态内容打印。

   • 销售模板的数据模板为 JSON 格式，各参数与小票打印内容的对应关系如下表所示。

     参数	说明
     orderTabel	对应小票中的订单明细表格区域，内容为一个数组。每增加一个数组，小票的订单明细表格区域就会增加一条打印内容。
     name	货号。
     number	数量。
     price	价格。
     total	合计数量。
     orderTime	顶部的下单时间。
     totalPrice	合计价格。
     PaidIn	实收。
     giveChange	找零。
     title	小票的标题。

   • 外卖模板的数据模板为 JSON 格式，各参数说明如下表所示。

     参数	说明
     orderTabel	对应小票中的订单明细表格区域，内容为一个数组。每增加一个数组，小票的订单明细表格区域就会增加一条打印内容。
     name	名称。
     number	数量。
     price	价格。
     total	合计数量。
     orderTime	顶部的下单时间。
     address	地址。
     phone	电话。
     price	合计价格。
     distributionFee	配送费。
     shopName	顶部的商店名称。
     title	小票的标题。
     status	顶部的支付状态。

   • 后厨模板的数据模板为 JSON 格式，各参数说明如下表所示。

     参数	说明
     orderTabel	对应小票中的订单明细表格区域，内容为一个数组。每增加一个数组，小票的订单明细表格区域就会增加一条打印内容。
     name	货号。
     number	数量。
     total	合计数量。
     deskNo	顶部的桌号。
     orderTime	顶部的下单时间。
     orderNo	顶部的订单号。
     remark	备注。
     title	小票的标题。

步骤三：API调用

下面仅介绍部分API参数的获取方法，具体API调用，请参见PrintByTemplate。

• ParamsJsonString：打印参数，请参考前文构建数据。以下是一个示例：

  {
   "orderTable":[
    {
     "number":"1",
     "price":"32.00",
     "name":"GP-3120TU"
    }
   ],
   "total":"4",
   "orderTime":"2021-01-25 10:20:00",
   "totalPrice":"98.00",
   "paidIn":"100.00",
   "giveChange":"2.00",
   "title":"XX专营店"
  }

• ProjectCode：项目ID。在项目管理页面的项目列表中，项目ID列即为 ProjectCode 参数值，可单击该值右侧的复制获取。

• TemplateBizCode：模板标识。在项目的模板管理页面中，模板列表的模版标识列即为该参数值。