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 | 是 | 消息模板上下文,即模板中定义的参数及参数 |


1932

被折叠的 条评论
为什么被折叠?



