沙箱环境是支付宝开放平台为开发者提供的与生产环境完全隔离的联调测试环境，开发者在沙箱环境中完成的接口调用不会对生产环境中的数据造成任何影响。

沙箱为开放的产品提供 有限功能范围的支持（覆盖的功能范围参见下面的业务用例），可以覆盖产品的绝大部分核心链路和对接逻辑，便于开发者快速学习/尝试/开发/调试，推荐开发者遵循业务用例来使用沙箱。

沙箱环境会自动完成或忽略一些场景的业务门槛，例如：开发者无需等待产品签约，即可直接在沙箱环境调用接口，使得开发集成工作可以与商务流程并行，从而提高项目整体的交付效率。

注意：

由于沙箱环境并非 100% 与生产环境一致，接口的实际响应逻辑请以生产环境为准，沙箱环境开发调试完成后，仍然需要在生产环境进行测试验收。

沙箱环境拥有完全独立的数据体系，沙箱环境下返回的数据（例如用户 ID 等）在生产环境中都是不存在的，开发者不可将沙箱环境返回的数据与生产环境中的数据混淆。

本文仅说明如何在沙箱环境中调试小程序-消息，非沙箱环境调试通用说明。

更多沙箱介绍和沙箱控制台使用说明可查看沙箱环境。

小程序-消息沙箱调试说明

沙箱通过业务用例定义支持的功能范围。业务用例描述了典型业务场景下，开发者可通过先后对接哪些接口来实现业务目标，每个业务用例会为开发者提供接口调用时序与参数示例值。

推荐开发者遵循业务用例来使用沙箱。

注意：示例参数值中与沙箱当前账号、应用上下文相关的参数，需开发者自行参照接入指南调用配套接口获取。

配套工具

沙箱环境提供了基于 Restful API 的方式来操作消息模板以供 OpenAPI 调用时使用。

订阅沙箱支持的消息模板

旧沙箱环境订阅消息模版方式：

GET http://sandboxsys.sx.alipaydev.com/prods/msgprod/template/1/${appId}/${userId}

新沙箱环境订阅消息模版方式：

GET http://sandboxsys.dl.alipaydev.com/prods/msgprod/template/1/${appId}/${userId}

说明：需要将路径中的变量替换成实际值，其中

a pp I d 替换为沙箱小程序 A PP I D ，

{userId} 为订阅消息的沙箱用户 ID。

{
    "stat": "ok",
    "code": "",
    "msg": "",
    "data": {
        "templateLibCode": "TM79d10241cd7a49abb9a30ef258f909bb",
        "templateName": "优惠券到期提醒",
        "templateId": "c76970f63e174d82ad80411c08334834",
        "msgBizType": "sub_msg",
        "sceneRuleNames": [
            "长期性订阅"
        ],
        "keywordDesc": "下单通知,到期时间,温馨提醒,使用方法,券名称,优惠内容,商户名称,券类型",
        "channelNames": [
            "支付宝服务提醒",
            "支付宝push"
        ],
        "userId": "2088622957849163",
        "appId": "2021000119616038"
    }
}

业务用例

接入小程序支付消息

确认接入小程序支付消息

调用 OpenAPI：alipay.open.mini.templatemsg.tinypayswitch.confirm（小程序支付消息确认接口）

入参示例值：

无请求参数，使用沙箱预置的小程序 APPID 发起调用即可

出参示例值：

{
 "alipay_open_mini_templatemsg_tinypayswitch_confirm_response": {
  "msg": "Success",
  "code": "10000"
 }
}

接入非小程序支付消息

查询可关联 PID

调用 OpenAPI：ant.merchant.expand.apprecommend.available.query（查询可关联APP的账号列表）

入参示例值：

{
 "page_size": 10,
 "page_number": 1
}

出参示例值：

{
 "ant_merchant_expand_apprecommend_available_query_response": {
  "msg": "Success",
  "code": "10000",
  "page_number": 1,
  "total_size": 1,
  "total_pages": 1,
  "list": [
   "2088621957795094"
  ],
  "page_size": 10
 }
}

关联 PID 和小程序

调用 OpenAPI：ant.merchant.expand.apprecommend.account.create（关联账号和小程序）

入参示例值：

{
 "app_no": "2021000119616038",
 "acc_no": "2088621957795094"
}

出参示例值：

{
 "ant_merchant_expand_apprecommend_account_create_response": {
  "msg": "Success",
  "code": "10000"
 }
}

查询己关联 PID

调用 OpenAPI：ant.merchant.expand.apprecommend.account.query（查询已关联指定APP的账号列表）

入参示例值：

{
 "app_no": "2021000119616038",
 "page_size": 10,
 "page_number": 1
}

出参示例值：

{
 "ant_merchant_expand_apprecommend_account_query_response": {
  "msg": "Success",
  "code": "10000",
  "page_number": 1,
  "total_size": 1,
  "total_pages": 1,
  "list": [
   "2088621957795094"
  ],
  "page_size": 10
 }
}

取消关联 PID 和小程序

调用 OpenAPI：ant.merchant.expand.apprecommend.account.delete（取消关联账号和小程序）

入参示例值：

{
 "app_no": "2021000119616038",
 "acc_no": "2088621957795094"
}

出参示例值：

{
 "ant_merchant_expand_apprecommend_account_delete_response": {
  "msg": "Success",
  "code": "10000"
 }
}

接入订阅消息

小程序中唤起消息订阅弹窗

调用 JSAPI：my.requestSubscribeMessage

说明：在沙箱环境中可以通过配套工具完成消息的订阅。

服务端发送订阅消息

调用 OpenAPI：alipay.open.app.mini.templatemessage.send（小程序发送模板消息）

入参示例值：

{
 "to_user_id": "2088622957849163",
 "user_template_id": "ba8b68a26aad4695a072149e278d1deb",
 "page": "page/component/index",
 "data": {
  "keyword1": {
   "value": "12:00"
  },
  "keyword2": {
   "value": "2088622957849163"
  },
  "keyword3": {
   "value": "支付宝"
  },
  "keyword4": {
   "value": "50.0"
  }
 }
}

出参示例值：

{
 "alipay_open_app_mini_templatemessage_send_response": {
  "msg": "Success",
  "code": "10000"
 }
}

查询订阅关系

调用 OpenAPI：alipay.open.app.messagetemplate.subscribe.query（模板订阅关系查询）

入参示例值：

{
 "user_id": "2088622957849163",
 "template_id_list": ["ba8b68a26aad4695a072149e278d1deb"]
}

出参示例值：

{
 "alipay_open_app_messagetemplate_subscribe_query_response": {
  "msg": "Success",
  "code": "10000",
  "show_component": true
 }
}

沙箱调试

小程序-消息沙箱调试说明#

配套工具#

订阅沙箱支持的消息模板#

业务用例#

接入小程序支付消息#

确认接入小程序支付消息#

接入非小程序支付消息#

查询可关联 PID#

关联 PID 和小程序#

查询己关联 PID#

取消关联 PID 和小程序#

接入订阅消息#

小程序中唤起消息订阅弹窗#

服务端发送订阅消息#

查询订阅关系#

小程序-消息沙箱调试说明

配套工具

订阅沙箱支持的消息模板

业务用例

接入小程序支付消息

确认接入小程序支付消息

接入非小程序支付消息

查询可关联 PID

关联 PID 和小程序

查询己关联 PID

取消关联 PID 和小程序

接入订阅消息

小程序中唤起消息订阅弹窗

服务端发送订阅消息

查询订阅关系