支付宝服务端API的详细参数说明《Alipay Easy SDK API Doc》

1. 基础能力 Base

1.1 用户授权 OAuth

获取授权访问令牌

  • API声明

getToken(code: string)

  • 入参说明
字段名 类型 必填 说明
code string 授权码,用户对应用授权后得到
  • 出参说明

可前往alipay.system.oauth.token查看更加详细的参数说明。

刷新授权访问令牌

  • API声明

refreshToken(refreshToken: string)

  • 入参说明
字段名 类型 必填 说明
refreshToken string 刷新令牌,上次换取访问令牌时得到,见出参的refresh_token字段
  • 出参说明

可前往alipay.system.oauth.token查看更加详细的参数说明。


1.2 小程序二维码 Qrcode

创建小程序二维码

  • API声明

create(urlParam: string, queryParam: string, describe: string)

  • 入参说明
字段名 类型 必填 说明
urlParam string 小程序中能访问到的页面路径,例如:page/component/component-pages/view/view
queryParam string 小程序的启动参数,打开小程序的query ,在小程序 onLaunch的方法中获取
describe string 二维码描述
  • 出参说明

可前往alipay.open.app.qrcode.create查看更加详细的参数说明。


1.3 图片 Image

上传图片

  • API声明

upload(imageName: string, imageFilePath: string)

  • 入参说明
字段名 类型 必填 说明
imageName string 图片名称
imageFilePath string 待上传的本地图片文件路径
  • 出参说明

可前往alipay.offline.material.image.upload查看更加详细的参数说明。


1.4 视频 Video

上传视频

  • API声明

upload(videoName: string, videoFilePath: string)

  • 入参说明
字段名 类型 必填 说明
videoName string 视频名称
videoFilePath string 待上传的本地视频文件路径
  • 出参说明

可前往alipay.offline.material.image.upload查看更加详细的参数说明。


2. 营销能力 Marketing

2.1 生活号 OpenLife

创建图文消息内容

  • API声明

createImageTextContent(title: string, cover: string, content: string, contentComment: string, ctype: string, benefit: string, extTags: string, loginIds: string)

  • 入参说明
字段名 类型 必填 说明
title string 标题
cover string 封面图URL, 尺寸为996*450,最大不超过3M,支持.jpg、.png格式,请先调用上传图片接口获得图片URL
content string 消息正文(支持富文本)
contentComment string 是否允许评论,T:允许,F:不允许,默认不允许
ctype string 图文类型:填activity表示活动图文,不填默认普通图文
benefit string 活动利益点,图文类型ctype为activity类型时才需要传,最多10个字符
extTags string 关键词列表,英文逗号分隔,最多不超过5个
loginIds string 可预览支付宝账号列表,需要预览时才填写, 英文逗号分隔,最多不超过10个
  • 出参说明

可前往alipay.open.public.message.content.create查看更加详细的参数说明。

更新图文消息内容

  • API声明

modifyImageTextContent(contentId: string, title: string, cover: string, content: string, couldComment: string, ctype: string, benefit: string, extTags: string, loginIds: string)

  • 入参说明
字段名 类型 必填 说明
contentId string 内容ID,通过创建图文内容消息接口返回
title string 标题
cover string 封面图URL, 尺寸为996*450,最大不超过3M,支持.jpg、.png格式,请先调用上传图片接口获得图片URL
content string 消息正文(支持富文本)
contentComment string 是否允许评论,T:允许,F:不允许,默认不允许
ctype string 图文类型:填activity表示活动图文,不填默认普通图文
benefit string 活动利益点,图文类型ctype为activity类型时才需要传,最多10个字符
extTags string 关键词列表,英文逗号分隔,最多不超过5个
loginIds string 可预览支付宝账号列表,需要预览时才填写, 英文逗号分隔,最多不超过10个
  • 出参说明

可前往alipay.open.public.message.content.modify查看更加详细的参数说明。

群发本文消息

  • API声明

sendText(text: string)

  • 入参说明
字段名 类型 必填 说明
text string 文本消息内容
  • 出参说明

可前往alipay.open.public.message.total.send查看更加详细的参数说明。

群发图文消息

  • API声明

sendImageText(articles: [ Article ])

  • 入参说明
字段名 类型 必填 说明
articles Article数组 图文消息内容

Article对象说明

字段名 类型 必填 说明
title string 图文消息标题
desc string 图文消息描述
imageUrl string 特殊可选 图片链接,对于多条图文消息的第一条消息,该字段不能为空,请先调用上传图片接口获得图片URL
url string 点击图文消息跳转的链接
actionName string 链接文字
  • 出参说明

可前往alipay.open.public.message.total.send查看更加详细的参数说明。

单发模板消息

  • API声明

sendSingleMessage(toUserId: string, template: Template)

  • 入参说明
字段名 类型 必填 说明
toUserId string 消息接收用户的UserId
template Template 消息接收用户的UserId

Template对象说明

字段名 类型 必填 说明
templateId string 消息模板ID
context Context 消息模板上下文,即模板中定义的参数及参数
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

XuDream

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值