完成接入准备后，商家/服务商可根据本文指引快速接入消息（支付消息、订单消息、订阅消息）。

说明：

消息仅支持自研商家/服务商通过自研应用或第三方应用代调用方式，调用 API 接入。

消息暂不支持沙箱调试。

接入流程图

卡券消息 无需开发投入，可查看新版消息工作台运营教程完成接入。

支付消息

支付消息有两种接入方式：

查看新版消息工作台运营教程在商家平台进行相关配置，完成接入。

根据本文内容，调用接口完成接入。

小程序支付消息

商家可调用 alipay.open.mini.templatemsg.tinypayswitch.confirm（小程序支付消息确认接口）确认动作完成小程序入口的添加。

调用流程图

示例代码

package com.java.sdk.demo;

import com.alipay.v3.ApiException;
import com.alipay.v3.ApiClient;
import com.alipay.v3.util.model.AlipayConfig;
import com.alipay.v3.Configuration;
import com.alipay.v3.api.AlipayOpenMiniTemplatemsgTinypayswitchApi;
import com.alipay.v3.model.*;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class AlipayOpenMiniTemplatemsgTinypayswitchApiConfirm {

    public static void main(String[] args) throws ApiException {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // 初始化alipay参数（全局设置一次）
        AlipayConfig alipayConfig = new AlipayConfig();
        alipayConfig.setServerUrl("https://openapi.alipay.com");
        alipayConfig.setAppId("<-- 请填写您的AppId，例如：2019091767145019 -->");
        alipayConfig.setPrivateKey("<-- 请填写您的应用私钥，例如：MIIEvQIBADANB ... ... -->");
        alipayConfig.setAlipayPublicKey("<-- 请填写您的支付宝公钥，例如：MIIBIjANBg... -->");
        defaultClient.setAlipayConfig(alipayConfig);
        AlipayOpenMiniTemplatemsgTinypayswitchApi api = new AlipayOpenMiniTemplatemsgTinypayswitchApi();
        try {
            Object response = api.confirm();
        } catch (ApiException e) {
            AlipayOpenMiniTemplatemsgTinypayswitchConfirmDefaultResponse errorObject = (AlipayOpenMiniTemplatemsgTinypayswitchConfirmDefaultResponse) e.getErrorObject();
            System.out.println("调用失败:" + errorObject);
        }
    }
}

非小程序支付消息

查询可关联 PID

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

调用流程图

示例代码

package com.java.sdk.demo;

import com.alipay.v3.ApiException;
import com.alipay.v3.ApiClient;
import com.alipay.v3.util.model.AlipayConfig;
import com.alipay.v3.Configuration;
import com.alipay.v3.api.AntMerchantExpandApprecommendAvailableApi;
import com.alipay.v3.model.*;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class AntMerchantExpandApprecommendAvailableApiQuery {

    public static void main(String[] args) throws ApiException {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // 初始化alipay参数（全局设置一次）
        AlipayConfig alipayConfig = new AlipayConfig();
        alipayConfig.setServerUrl("https://openapi.alipay.com");
        alipayConfig.setAppId("<-- 请填写您的AppId，例如：2019091767145019 -->");
        alipayConfig.setPrivateKey("<-- 请填写您的应用私钥，例如：MIIEvQIBADANB ... ... -->");
        alipayConfig.setAlipayPublicKey("<-- 请填写您的支付宝公钥，例如：MIIBIjANBg... -->");
        defaultClient.setAlipayConfig(alipayConfig);
        AntMerchantExpandApprecommendAvailableApi api = new AntMerchantExpandApprecommendAvailableApi();
        Integer pageSize = 10;
        Integer pageNumber = 1;
        try {
            AntMerchantExpandApprecommendAvailableQueryResponseModel response = api.query(pageSize, pageNumber);
        } catch (ApiException e) {
            AntMerchantExpandApprecommendAvailableQueryDefaultResponse errorObject = (AntMerchantExpandApprecommendAvailableQueryDefaultResponse) e.getErrorObject();
            System.out.println("调用失败:" + errorObject);
        }
    }
}

关联 PID 和小程序

商家可调用 ant.merchant.expand.apprecommend.account.create（关联账号和小程序）将账号与小程序进行绑定。

调用流程图

示例代码

package com.java.sdk.demo;

import com.alipay.v3.ApiException;
import com.alipay.v3.ApiClient;
import com.alipay.v3.util.model.AlipayConfig;
import com.alipay.v3.Configuration;
import com.alipay.v3.api.AntMerchantExpandApprecommendAccountApi;
import com.alipay.v3.model.*;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class AntMerchantExpandApprecommendAccountApiCreate {

    public static void main(String[] args) throws ApiException {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // 初始化alipay参数（全局设置一次）
        AlipayConfig alipayConfig = new AlipayConfig();
        alipayConfig.setServerUrl("https://openapi.alipay.com");
        alipayConfig.setAppId("<-- 请填写您的AppId，例如：2019091767145019 -->");
        alipayConfig.setPrivateKey("<-- 请填写您的应用私钥，例如：MIIEvQIBADANB ... ... -->");
        alipayConfig.setAlipayPublicKey("<-- 请填写您的支付宝公钥，例如：MIIBIjANBg... -->");
        defaultClient.setAlipayConfig(alipayConfig);
        AntMerchantExpandApprecommendAccountApi api = new AntMerchantExpandApprecommendAccountApi();
        AntMerchantExpandApprecommendAccountCreateModel data = new AntMerchantExpandApprecommendAccountCreateModel();
        data.setAppNo("2021000155639069");
        data.setAccNo("2088001969784501");
        try {
            Object response = api.create(data);
        } catch (ApiException e) {
            AntMerchantExpandApprecommendAccountCreateDefaultResponse errorObject = (AntMerchantExpandApprecommendAccountCreateDefaultResponse) e.getErrorObject();
            System.out.println("调用失败:" + errorObject);
        }
    }
}

查询己关联 PID

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

调用流程图

示例代码

package com.java.sdk.demo;

import com.alipay.v3.ApiException;
import com.alipay.v3.ApiClient;
import com.alipay.v3.util.model.AlipayConfig;
import com.alipay.v3.Configuration;
import com.alipay.v3.api.AntMerchantExpandApprecommendAccountApi;
import com.alipay.v3.model.*;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class AntMerchantExpandApprecommendAccountApiQuery {

    public static void main(String[] args) throws ApiException {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // 初始化alipay参数（全局设置一次）
        AlipayConfig alipayConfig = new AlipayConfig();
        alipayConfig.setServerUrl("https://openapi.alipay.com");
        alipayConfig.setAppId("<-- 请填写您的AppId，例如：2019091767145019 -->");
        alipayConfig.setPrivateKey("<-- 请填写您的应用私钥，例如：MIIEvQIBADANB ... ... -->");
        alipayConfig.setAlipayPublicKey("<-- 请填写您的支付宝公钥，例如：MIIBIjANBg... -->");
        defaultClient.setAlipayConfig(alipayConfig);
        AntMerchantExpandApprecommendAccountApi api = new AntMerchantExpandApprecommendAccountApi();
        String appNo = "2021000155639069";
        Integer pageSize = 10;
        Integer pageNumber = 1;
        try {
            AntMerchantExpandApprecommendAccountQueryResponseModel response = api.query(appNo, pageSize, pageNumber);
        } catch (ApiException e) {
            AntMerchantExpandApprecommendAccountQueryDefaultResponse errorObject = (AntMerchantExpandApprecommendAccountQueryDefaultResponse) e.getErrorObject();
            System.out.println("调用失败:" + errorObject);
        }
    }
}

取消关联

商家可调用 ant.merchant.expand.apprecommend.account.delete（取消关联账号和小程序）取消账号与小程序的绑定。

调用流程图

示例代码

package com.java.sdk.demo;

import com.alipay.v3.ApiException;
import com.alipay.v3.ApiClient;
import com.alipay.v3.util.model.AlipayConfig;
import com.alipay.v3.Configuration;
import com.alipay.v3.api.AntMerchantExpandApprecommendAccountApi;
import com.alipay.v3.model.*;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class AntMerchantExpandApprecommendAccountApiDelete {

    public static void main(String[] args) throws ApiException {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // 初始化alipay参数（全局设置一次）
        AlipayConfig alipayConfig = new AlipayConfig();
        alipayConfig.setServerUrl("https://openapi.alipay.com");
        alipayConfig.setAppId("<-- 请填写您的AppId，例如：2019091767145019 -->");
        alipayConfig.setPrivateKey("<-- 请填写您的应用私钥，例如：MIIEvQIBADANB ... ... -->");
        alipayConfig.setAlipayPublicKey("<-- 请填写您的支付宝公钥，例如：MIIBIjANBg... -->");
        defaultClient.setAlipayConfig(alipayConfig);
        AntMerchantExpandApprecommendAccountApi api = new AntMerchantExpandApprecommendAccountApi();
        String appNo = "2021000155639069";
        String accNo = "2088001969784501";
        try {
            Object response = api.delete(appNo, accNo);
        } catch (ApiException e) {
            AntMerchantExpandApprecommendAccountDeleteDefaultResponse errorObject = (AntMerchantExpandApprecommendAccountDeleteDefaultResponse) e.getErrorObject();
            System.out.println("调用失败:" + errorObject);
        }
    }
}

订单消息

接入流程可查看订单中心接入指南。

订阅消息

订阅消息 的接入流程包括：

领用订阅消息模板。

调用订阅组件。

发送订阅消息。

领用订阅消息模板

方式一

点击左侧召回 > 消息，进入小程序消息页面选择接入订阅消息，点击 去接入。

进入接入订阅消息模板页面，可根据自身行业类型选择对应行业下的消息模板，也可根据订阅类型 一次性订阅、长期订阅 来选择消息模板，还可在搜索框中搜索所需模板关键字，查询相关消息模板。若无合适的模板也可点击 创建模板，申请新模板，审核通过后也可做领用。注意：小程序不同主营行业展示的模板库列表不同，例如：银行行业不会展示取餐提醒模板。

选择模板后，配置关键词及顺序。
说明：右侧示例图会实时展示该订阅消息在用户界面效果。

完成消息模板配置后，可点击 立即接入，进行技术对接。

方式二

第一步：开发者可先调用 alipay.open.mini.message.templatelib.batchquery（消息母板批量查询接口）查询该小程序可领取的订阅模板。

第二步：根据第一步查询结果，通过 alipay.open.mini.message.template.apply（消息模板申领接口）领取相应的订阅模板。

另外，可调用 alipay.open.mini.message.template.batchquery（消息子板批量查询接口）查询该 APPID 下所有已经领取过的订阅模板。

调用订阅组件

订阅组件是订阅消息发送过程中，积累订阅用户的核心产品能力。订阅组件提供多种样式及接入方式，支持商家快速积累订阅关系，降低商家接入成本，提升商家消息运营灵活度。

订阅组件现有两种样式，为 半弹层 及 嵌入式，样式如下图所示：

订阅组件案例展示

一次性订阅消息

长期性订阅消息

订阅组件接入方式说明

消息订阅组件接入方式支持以下 2 种：

订阅组件类型	适用商家类型及场景	接入方式	支持订阅消息类型	使用规则	示例与说明
订阅半弹层组件	有较强开发能力及前端资源，需要有自定义的弹层拉齐逻辑	调用 OpenAPI	一次性订阅、长期订阅	仅支持应用于小程序页面，暂不支持 H5。一个小程序可创建多个订阅半弹层组件，可进行自行调用。一个组件最多可包含 3 个订阅消息模版。
嵌入式订阅组件	开发能力有限或开发资源紧张，需快速上线相应模版	后台配置组件生成代码，商家技术将放入页面中	长期订阅	仅支持应用于小程序页面，暂不支持 H5。一个小程序可创建多个嵌入式订阅组件，每个组件有唯一的 ID，审核通过后即可生效使用。一个嵌入式订阅组件可以最多包含 3 个订阅消息模板。嵌入式订阅组件标题支持自定义，建议具备概括性，不得带有营销诱导性文案。按钮文案订阅、副标题描述文案均不支持自定义。

商家/服务商可根据自己业务需求选择 订阅半弹层组件 或 订阅嵌入式组件。

订阅半弹层组件

开发者需在小程序中调用 my.requestSubscribeMessage 消息订阅接口，引导用户完成消息订阅。
注意：基础库 v1.x 从 1.25.7 开始支持，基础库 v2.x 从 2.7.10 开始支持。

示例代码：

my.requestSubscribeMessage({
  //需要用户订阅的消息模板的id的集合
  entityIds: ['ac768fca1ce245ccae9404bb5243c49b', '9aa357acb7c6434aba294aded1cdfb7c'],
  success: (res) => {
    // res.behavior=='subscribe'
    console.log("接口调用成功的回调", res);
  },
  fail: (res) => {
    console.log("接口调用失败的回调", res); 
  },
  complete: (res) => {
    console.log("接口调用结束的回调", res)
  }
});

订阅嵌入式组件

整体流程：

在商家平台配置及管理订阅组件。

开发接入嵌入式订阅组件。

在 商家平台 进行后续持续维护管理。

具体流程如下：

配置及管理订阅组件

登录商家平台运营中心 > 选择需要操作的小程序，点击进入小程序详情页。

点击左侧消息进入消息配置页。

点击 订阅消息：

选择 嵌入式组件管理，进入组件配置页面：

点击 配置组件。

点击 立即接入组件 进入组件配置。

选择此组件中需要的模版，并填写订阅组件标题，点击提交（提交前可在右侧查看线上展示样式）。
注意：

关联消息模板：嵌入式组件目前只支持 长期订阅模版，且最多可选择 3 个模版。

订阅组件标题：标题命名需和绑定模版名称有关联，如绑定的模版为活动类相关模版，订阅组件命名不可无法表达活动场景，取名示例如下：订阅会员活动相关通知、订阅上新活动相关通知等。

提交后，进入审核，一般 1 ～ 5 个工作日审核通过后，组件即可生效。

进入组件管理页面，选择已生效组件，点击应用。

点击 复制代码，可得到 .axml 代码，根据下文 接入嵌入式订阅组件，完成组件接入。

接入嵌入式订阅组件

开发者需在小程序页面中使用嵌入式订阅组件 subscribe-message，引导用户完成消息订阅，subscribe-message 组件具体使用说明、示例代码、属性说明可查看 subscribe-message 嵌入式订阅组件。

管理组件

后续可点击详情对订阅嵌入式组件进行管理，例如如失效等。

发送订阅消息

当小程序用户基于消息订阅接口产生订阅行为后，开发者可调用 alipay.open.app.mini.templatemessage.send（小程序发送模板消息），向订阅模板的用户发送模板消息。

说明：针对内容一致、可以普发给用户的消息，还支持免代码开发的方式发送，商家可在消息运营 > 消息接入 > 订阅消息 > 批量发送 进行操作。

调用流程图

示例代码

package com.java.sdk.demo;

import com.alipay.v3.ApiException;
import com.alipay.v3.ApiClient;
import com.alipay.v3.util.model.AlipayConfig;
import com.alipay.v3.Configuration;
import com.alipay.v3.api.AlipayOpenAppMiniTemplatemessageApi;
import com.alipay.v3.model.*;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class AlipayOpenAppMiniTemplatemessageApiSend {

    public static void main(String[] args) throws ApiException {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // 初始化alipay参数（全局设置一次）
        AlipayConfig alipayConfig = new AlipayConfig();
        alipayConfig.setServerUrl("https://openapi.alipay.com");
        alipayConfig.setAppId("<-- 请填写您的AppId，例如：2019091767145019 -->");
        alipayConfig.setPrivateKey("<-- 请填写您的应用私钥，例如：MIIEvQIBADANB ... ... -->");
        alipayConfig.setAlipayPublicKey("<-- 请填写您的支付宝公钥，例如：MIIBIjANBg... -->");
        defaultClient.setAlipayConfig(alipayConfig);
        AlipayOpenAppMiniTemplatemessageApi api = new AlipayOpenAppMiniTemplatemessageApi();
        AlipayOpenAppMiniTemplatemessageSendModel data = new AlipayOpenAppMiniTemplatemessageSendModel();
        data.setFormId("2017010100000000580012345678");
        data.setData("{\"keyword1\": {\"value\" : \"12:00\"},\"keyword2\": {\"value\" : \"20180808\"},\"keyword3\": {\"value\" : \"支付宝\"}}");
        data.setPage("page/component/index");
        data.setUserTemplateId("MDI4YzIxMDE2M2I5YTQzYjUxNWE4MjA4NmU1MTIyYmM=");
        data.setToUserId("2088102122458832");
        try {
            Object response = api.send(data);
        } catch (ApiException e) {
            AlipayOpenAppMiniTemplatemessageSendDefaultResponse errorObject = (AlipayOpenAppMiniTemplatemessageSendDefaultResponse) e.getErrorObject();
            System.out.println("调用失败:" + errorObject);
        }
    }
}

重要入参说明：

to_user_id：必填，接收模板消息用户支付宝 user_id，可通过用户授权获取。

user_template_id：必填，消息模板 ID。登录运营中心进入消息运营添加订阅信息后点详情即可看到，详情可查看上文 选用消息模板。

page：必填，模板消息 进入小程序查看 按钮跳转的小程序页面地址。

data：必填，开发者需要发送模板消息中的自定义部分来替换模板的占位符。**
注意**：占位符必须和申请模板时的关键词一一匹配（包括顺序）。

辅助功能

查询消息订阅关系

开发者可调用 alipay.open.app.messagetemplate.subscribe.query（模板订阅关系查询），提前查询用户对指定消息模板的订阅关系，再根据订阅关系引导用户进行订阅和精准触达消息。

说明：若开发者想实现去订阅类型的引导功能，可以通过本接口进行订阅关系判断，根据响应结果展示引导文案。

示例代码

package com.java.sdk.demo;

import com.alipay.v3.ApiException;
import com.alipay.v3.ApiClient;
import com.alipay.v3.util.model.AlipayConfig;
import com.alipay.v3.Configuration;
import com.alipay.v3.api.AlipayOpenAppMessagetemplateSubscribeApi;
import com.alipay.v3.model.*;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class AlipayOpenAppMessagetemplateSubscribeApiQuery {

    public static void main(String[] args) throws ApiException {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // 初始化alipay参数（全局设置一次）
        AlipayConfig alipayConfig = new AlipayConfig();
        alipayConfig.setServerUrl("https://openapi.alipay.com");
        alipayConfig.setAppId("<-- 请填写您的AppId，例如：2019091767145019 -->");
        alipayConfig.setPrivateKey("<-- 请填写您的应用私钥，例如：MIIEvQIBADANB ... ... -->");
        alipayConfig.setAlipayPublicKey("<-- 请填写您的支付宝公钥，例如：MIIBIjANBg... -->");
        defaultClient.setAlipayConfig(alipayConfig);
        AlipayOpenAppMessagetemplateSubscribeApi api = new AlipayOpenAppMessagetemplateSubscribeApi();
        AlipayOpenAppMessagetemplateSubscribeQueryModel data = new AlipayOpenAppMessagetemplateSubscribeQueryModel();
        List<String> templateIdList = new ArrayList<String>();
        templateIdList.add("6511999536b14ba5830e3a0289ea69a");
        templateIdList.add("0b1fcca882aa435382ae98641e14d37");
        templateIdList.add("a3b396be6fd345579221af5dea35028");
        data.setTemplateIdList(templateIdList);
        data.setUserId("2088202882050410");
        try {
            AlipayOpenAppMessagetemplateSubscribeQueryResponseModel response = api.query(data);
        } catch (ApiException e) {
            AlipayOpenAppMessagetemplateSubscribeQueryDefaultResponse errorObject = (AlipayOpenAppMessagetemplateSubscribeQueryDefaultResponse) e.getErrorObject();
            System.out.println("调用失败:" + errorObject);
        }
    }
}

重要入参说明

user_id：必填，接收模板消息的用户支付宝 user_id，可通过 my.getAuthCode 获取。

template_id_list：消息模板 id 列表，最多不超过 3 个。模板 id 需要保持同一个应用主体，并且展示在同一个订阅窗口中的模板 id。

商家接入指南

接入流程图#

支付消息#

小程序支付消息#

调用流程图#

示例代码#

非小程序支付消息#

查询可关联 PID#

调用流程图#

示例代码#

关联 PID 和小程序#

调用流程图#

示例代码#

查询己关联 PID#

调用流程图#

示例代码#

取消关联#

调用流程图#

示例代码#

订单消息#

订阅消息#

领用订阅消息模板#

方式一#

方式二#

调用订阅组件#

订阅组件案例展示#

一次性订阅消息#

长期性订阅消息#

订阅组件接入方式说明#

订阅半弹层组件#

订阅嵌入式组件#

配置及管理订阅组件#

接入嵌入式订阅组件#

管理组件#

发送订阅消息#

调用流程图#

示例代码#

辅助功能#

查询消息订阅关系#

示例代码#

重要入参说明#

接入流程图

支付消息

小程序支付消息

调用流程图

示例代码

非小程序支付消息

查询可关联 PID

调用流程图

示例代码

关联 PID 和小程序

调用流程图

示例代码

查询己关联 PID

调用流程图

示例代码

取消关联

调用流程图

示例代码

订单消息

订阅消息

领用订阅消息模板

方式一

方式二

调用订阅组件

订阅组件案例展示

一次性订阅消息

长期性订阅消息

订阅组件接入方式说明

订阅半弹层组件

订阅嵌入式组件

配置及管理订阅组件

接入嵌入式订阅组件

管理组件

发送订阅消息

调用流程图

示例代码

辅助功能

查询消息订阅关系

示例代码

重要入参说明