语音播报(新)

1、修订记录

修订记录 日期 说明
1.0 2026.07.31 初版

2、业务说明

(1)接口说明

该接口可用于服务商或机构在对自己产品进行自定义播报,例如可以播放类似“您有一个新的工单需要处理”、“您的积分增加XX”、“3号油枪加满,需要付费500元”等个性化语音信息。目前自定义播报的功能需满足以下几个条件:(1)华智融的部分型号喇叭 (2)罐装物联云的三元组信息 (3)向总部申请自定义播报模板。请在使用前,提前了解喇叭配置是否满足。

请求主体类型:application/json

请求方式:POST

3、请求地址

环境 HTTPS请求地址
测试环境 https://appdev.ysepay-test.com/openapi/mis/pushMsg/broadcastNewForGateway
正式环境 https://ysgate.ysepay.com/openapi/mis/pushMsg/broadcastNewForGateway

4、请求参数说明

4.1、公共请求参数

参数 类型(长度) 必填 参数说明
timeStamp String Y 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss"
method String(128) Y 接口名称,固定值:mis.pushMsg.broadcastNewForGateway
charset String(10) Y 请求使用的编码格式,如utf-8,gbk,gb2312等,固定为utf-8
sign String Y 商户请求参数的签名串(签名算法默认为国密),详见demo,注意:请用商户私钥进行签名
check String Y 银盛公钥加密随机生成的字符串(key)得到的加密值,详见demo
bizContent String Y 业务参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递。注意:需要通过AES以及随机生成的字符串(key)加密业务参数集合,得到bizContent
reqId String Y 请求唯一流水号,商户系统唯一,要求32个字符内(最少14个字符),只能是数字、大小写字母_-且在同一个商户号下唯一。最后12位要求格式为"yyMMddHHmmss" 示例值:xy1415220315145602
certId String Y 发起方商户号,服务商在银盛给自己开设的商户号,即可当作发起方商户号,由银盛生成并下发。 注意:不同于子商户号,服务商发展的商户即为子商户号
version String Y 调用的接口版本,固定为:1.0

4.2、业务请求参数

(bizContent加密前的json数据明文字符串)

参数 类型(长度) 必填 参数说明
bodySn String Y 设备 sn
broadcastType String N 默认播报和自定义播报的语料模板ID。

对于默认播报,支持传值的语料代码和播报文案分别是:
0-银盛收款XX元;
7-微信支付收款XX元;
18-支付宝收款XX元;
29-微信用户取消支付;
30-支付宝用户取消支付;

对于自定义播报,请申请特定的模板ID,并在该字段传值。
money String N 交易金额, 收款交易和取消交易对应的金额,最多两位小数。<br/>发起方不在白名单里的代理商,此字段必填;发起方在白名单里的代理商,做自定义播报时,此字段可以选填。<br/>
tradeSn String N 银盛交易流水号, 对于默认播报:
当播报语料代码为正向支付播报(0,7,18),交易流水号必传;
当播报语料代码为防逃单播报(29,30),交易流水号不用传

对于自定义播报:
如果配置的模板为”需要校验交易“,则该字段必传

5、响应参数说明

请注意:银盛后期会对返回参数保留扩展的权力,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。

5.1、公共响应参数

参数 类型(长度) 必填 参数说明
code String(5) Y 网关响应码,示例值:00000 详见网关公共响应码
msg String(50) Y 网关响应码描述
subCode String Y 业务响应码,参见具体的API接口文档
subMsg String Y 业务响应描述
timeStamp String Y 响应时间,格式"yyyy-MM-dd HH:mm:ss"
norce String(128) Y 随机参数
sign String Y 响应参数的签名串,详见demo,
注意:请用银盛公钥进行验签
businessData String Y 业务响应参数集合,
注意:银盛网关通过AES加密业务响应参数集合,得到businessData,商户需要对其进行解密,详情请见demo

6、业务响应码 网关公共响应码

响应码 响应码描述 解决方案
200 成功
404 系统繁忙
405 不支持POST请求
406 不支持GET请求
421 service服务无响应
422 第三方服务无响应
423 第三方服务异常
424 无效报文类型
425 修改失败
426 body不是json格式
520 参数格式不正确
521 没有该播报类型
522 没有该交易类型
523 交易日期格式不正确
524 没有该支付方式
525 没有该订单归属
526 没有该播报方式
527 语音播报金额不能为空
528 语音播报自定义播报内容不能为空
529 调用方【%s】无权限访问
530 设备sn没有注册
531 设备sn已被冻结
532 设备sn没有开通多用途
536 打印模板号是必传参数
537 该模板号不存在,请联系管理员申请小票模板
539 打印报文大小不能超过5K
540 调用方【%s】无推送【%s】权限
541 【%s】参数长度,不能超过50个字符串
542 该模板不是您申请的模板,请联系管理员核查模板号
543 交易时间格式不正确
544 支付类型不正确
548 请求时间不能为空
549 请求流水号不能为空
550 调用方不能为空
551 设备sn不能为空
552 logo图片大小不能超过5K
553 请求时间格式不正确
554 logo图片获取异常
558 不支持的播报类型
559 播报开关未开启
560 消支付播报开关未开启
561 该终端不允许播报
563 设备未与商户绑定
564 该设备播报模式不为外放接口触发
565 仅支持默认播报,不支持自定义播报
566 订单查询失败
567 业务异常
568 交易完成时间错误,该接口仅支持播报最近完成的交易
569 播报接口调用失败
570 无法查询到交易订单号

results matching ""

    No results matching ""