小程序发送模板消息

开发环境

POST

/v3/alipay/open/app/mini/templatemessage/send

alipay.open.app.mini.templatemessage

小程序通过openapi给用户触达消息，主要为支付后的触达（通过消费id）、用户提交表单后的触达（通过formId）、刷脸后的触达（通过ftoken）以及用户订阅消息模板后的触达。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://dev-cn.your-api-server.com/v3/alipay/open/app/mini/templatemessage/send' \
--header 'Content-Type: application/json' \
--data-raw ''

响应示例

200 - 示例 1

{}

请求参数

Body 参数application/json

data

string

可选

模板消息内容。商家/开发者将模板占位符替换为自定义内容。注意： * 选用模板时配置的关键字顺序与keyword_ X相互对应，填写时需注意。 * 自定义消息内容仅需替换 value 后内容即可，其余内容请勿修改。如 {"keyword1": {"value" : "2021年01月"}。表示第一个关键字数据为"2021年01月" 。 * value 最长为 50 个字符。

示例值:

{"keyword1": {"value" : "12:00"},"keyword2": {"value" : "20180808"},"keyword3": {"value" : "支付宝"}}

form_id

string

可选

*支付消息模板：需传入用户发生的交易行为的支付宝交易号 trade_no； *表单提交模板：需传入用户在小程序触发表单提交事件获得的表单号； *刷脸消息模板：需传入在IOT刷脸后得到的ftoken等，用于信息发送的校验。说明：订阅消息模板无需传入本参数。

示例值:

2017010100000000580012345678

page

string

可选

小程序的跳转页面。用于用户点击模板消息进入小程序查看按钮后，跳转至商家小程序对应页面。

示例值:

page/component/index

to_open_id

string

可选

支付宝openId，用于支付宝用户在当前应用下的用户标识。

示例值:

074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5

to_user_id

string

可选

接收模板消息的用户 user_id，一般为2088开头的16为数字。注意：需为实际支付/提交表单/刷脸/订阅消息的用户。

示例值:

2088102122458832

user_template_id

string

可选

商家在商家自运营中心选用的消息模板ID，详情参见选用消息模板。

示例值:

MDI4YzIxMDE2M2I5YTQzYjUxNWE4MjA4NmU1MTIyYmM=

示例

返回响应

🟢200common response

application/json

Body

object {0}

🔴500请求失败

修改于 2023-11-21 06:13:41

模板订阅关系查询

小程序支付消息确认接口