Shopping接口提供购物相关的功能,客户端在接收到RenderQrcode并展示二维码之后可以发送GetPayStatus事件查询订单支付状态,查询结果会通过SetPayStatus事件返回。
客户端需要持续发送GetPayStatus来轮训支付状态,客户端可以根据实际情况选择合适的轮询持续时间。
ExtGetPayStatus事件(扩展)
通过此事件获取订单支付状态。
Sample Message
{
"event": {
"header": {
"namespace": "Shopping",
"name": "ExtGetPayStatus",
"messageId": "{{STRING}}"
},
"payload": {
"orderId": "{{STRING}}",
"payId": "{{STRING}}"
}
}
}
Header参数
参数 |
描述 |
型态 |
messageId |
用以代表一个特定message的唯一ID。 |
字串 |
Payload参数
参数 |
描述 |
型态 |
orderId |
订单Id。 |
字串 |
payId |
支付Id。 |
字串 |
ExtSetPayStatus指令(扩展)
通过此指令返回订单支付状态。
Sample Message
{
"directive": {
"header": {
"namespace": "Shopping",
"name": "ExtSetPayStatus",
"messageId": "{{STRING}}",
"dialogRequestId": "{{STRING}}"
},
"payload": {
"orderId":{{STRING}},
"status":{{STRING}},
"payId": "{{STRING}}"
}
}
}
Header参数
参数 |
描述 |
型态 |
messageId |
用以代表一个特定message的唯一ID。 |
字串 |
dialogRequestId |
由客户端为每一个发送给TVS的 Recognize 事件所生成的唯一ID。此参数用以将TVS所下发的指令与某个特定Recognize 事件。 |
字串 |
Payload参数
参数 |
描述 |
型态 |
orderId |
订单id |
string |
status |
订单状态。允许值:PAID、UNPAID |
string |
payId |
支付Id。 |
字串 |
FAQ
关于此文档暂时还没有FAQ