# [](https://github.com/alipay/alipay-easysdk/blob/master/APIDoc.md#%E8%90%A5%E9%94%80%E8%83%BD%E5%8A%9B-marketing)营销能力 Marketing
## [](https://github.com/alipay/alipay-easysdk/blob/master/APIDoc.md#%E7%94%9F%E6%B4%BB%E5%8F%B7-openlife)生活号 OpenLife
### [](https://github.com/alipay/alipay-easysdk/blob/master/APIDoc.md#%E5%88%9B%E5%BB%BA%E5%9B%BE%E6%96%87%E6%B6%88%E6%81%AF%E5%86%85%E5%AE%B9)创建图文消息内容
* 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](https://docs.open.alipay.com/api_6/alipay.open.public.message.content.create)查看更加详细的参数说明。
### [](https://github.com/alipay/alipay-easysdk/blob/master/APIDoc.md#%E6%9B%B4%E6%96%B0%E5%9B%BE%E6%96%87%E6%B6%88%E6%81%AF%E5%86%85%E5%AE%B9)更新图文消息内容
* 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](https://docs.open.alipay.com/api_6/alipay.open.public.message.content.modify)查看更加详细的参数说明。
### [](https://github.com/alipay/alipay-easysdk/blob/master/APIDoc.md#%E7%BE%A4%E5%8F%91%E6%9C%AC%E6%96%87%E6%B6%88%E6%81%AF)群发本文消息
* API声明
sendText(text: string)
* 入参说明
| 字段名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| text | string | 是 | 文本消息内容 |
* 出参说明
可前往[alipay.open.public.message.total.send](https://docs.open.alipay.com/api_6/alipay.open.public.message.total.send)查看更加详细的参数说明。
### [](https://github.com/alipay/alipay-easysdk/blob/master/APIDoc.md#%E7%BE%A4%E5%8F%91%E5%9B%BE%E6%96%87%E6%B6%88%E6%81%AF)群发图文消息
* API声明
sendImageText(articles: \[ Article \])
* 入参说明
| 字段名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| articles | Article数组 | 是 | 图文消息内容 |
Article对象说明
| 字段名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| title | string | 否 | 图文消息标题 |
| desc | string | 是 | 图文消息描述 |
| imageUrl | string | 特殊可选 | 图片链接，对于多条图文消息的第一条消息，该字段不能为空，请先调用上传图片接口获得图片URL |
| url | string | 是 | 点击图文消息跳转的链接 |
| actionName | string | 否 | 链接文字 |
* 出参说明
可前往[alipay.open.public.message.total.send](https://docs.open.alipay.com/api_6/alipay.open.public.message.total.send)查看更加详细的参数说明。
### [](https://github.com/alipay/alipay-easysdk/blob/master/APIDoc.md#%E5%8D%95%E5%8F%91%E6%A8%A1%E6%9D%BF%E6%B6%88%E6%81%AF)单发模板消息
* API声明
sendSingleMessage(toUserId: string, template: Template)
* 入参说明
| 字段名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| toUserId | string | 是 | 消息接收用户的UserId |
| template | Template | 是 | 消息接收用户的UserId |
Template对象说明
| 字段名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| templateId | string | 是 | 消息模板ID |
| context | Context | 是 | 消息模板上下文，即模板中定义的参数及参数值 |
Context对象说明
| 字段名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| headColor | string | 是 | 顶部色条的色值，比如#85be53 |
| url | string | 是 | 点击消息后承接页的地址 |
| actionName | string | 是 | 底部链接描述文字，如：“查看详情”，最多能传8个汉字或16个英文字符 |
| keyword1 | Keyword | 否 | 模板中占位符的值及文字颜色 |
| keyword2 | Keyword | 否 | 模板中占位符的值及文字颜色 |
| first | Keyword | 否 | 模板中占位符的值及文字颜色 |
| remark | Keyword | 否 | 模板中占位符的值及文字颜色 |
Keyword对象说明
| 字段名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| color | string | 是 | 当前文字颜色，比如#85be53 |
| value | string | 是 | 模板中占位符的值 |
* 出参说明
可前往[alipay.open.public.message.single.send](https://docs.open.alipay.com/api_6/alipay.open.public.message.single.send)查看更加详细的参数说明。
### [](https://github.com/alipay/alipay-easysdk/blob/master/APIDoc.md#%E7%94%9F%E6%B4%BB%E5%8F%B7%E6%B6%88%E6%81%AF%E6%92%A4%E5%9B%9E)生活号消息撤回
* API声明
recallMessage(messageId: string)
* 入参说明
| 字段名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| messageId | string | 是 | 消息ID |
* 出参说明
可前往[alipay.open.public.life.msg.recall](https://docs.open.alipay.com/api_6/alipay.open.public.life.msg.recall)查看更加详细的参数说明。
### [](https://github.com/alipay/alipay-easysdk/blob/master/APIDoc.md#%E6%A8%A1%E6%9D%BF%E6%B6%88%E6%81%AF%E8%A1%8C%E4%B8%9A%E8%AE%BE%E7%BD%AE)模板消息行业设置
* API声明
setIndustry(primaryIndustryCode: string, primaryIndustryName: string, secondaryIndustryCode: string, secondaryIndustryName: string)
* 入参说明
| 字段名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| primaryIndustryCode | string | 是 | 服务窗消息模板所属主行业一级编码，查看[行业信息](https://alipay.open.taobao.com/doc2/detail?treeId=197&docType=1&articleId=105043) |
| primaryIndustryName | string | 是 | 服务窗消息模板所属主行业一级名称 |
| secondaryIndustryCode | string | 是 | 服务窗消息模板所属主行业二级编码 |
| secondaryIndustryName | string | 是 | 服务窗消息模板所属主行业二级名称 |
* 出参说明
可前往[alipay.open.public.template.message.industry.modify](https://docs.open.alipay.com/api_6/alipay.open.public.template.message.industry.modify)查看更加详细的参数说明。
### [](https://github.com/alipay/alipay-easysdk/blob/master/APIDoc.md#%E7%94%9F%E6%B4%BB%E5%8F%B7%E6%9F%A5%E8%AF%A2%E8%A1%8C%E4%B8%9A%E8%AE%BE%E7%BD%AE)生活号查询行业设置
* API声明
getIndustry()
* 入参说明
无
* 出参说明
可前往[alipay.open.public.setting.category.query](https://docs.open.alipay.com/api_6/alipay.open.public.setting.category.query)查看更加详细的参数说明。
* * *
## [](https://github.com/alipay/alipay-easysdk/blob/master/APIDoc.md#%E6%94%AF%E4%BB%98%E5%AE%9D%E5%8D%A1%E5%8C%85-pass)支付宝卡包 Pass
### [](https://github.com/alipay/alipay-easysdk/blob/master/APIDoc.md#%E5%8D%A1%E5%88%B8%E6%A8%A1%E6%9D%BF%E5%88%9B%E5%BB%BA)卡券模板创建
* API声明
createTemplate(uniqueId: string, tplContent: string)
* 入参说明
| 字段名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| uniqueId | string | 是 | 商户用于控制模版的唯一性（可以使用时间戳保证唯一性） |
| tplContent | string | 是 | 模板内容信息，遵循JSON规范，详情参见tpl\_content[参数说明](https://doc.open.alipay.com/doc2/detail.htm?treeId=193&articleId=105249&docType=1#tpl_content) |
* 出参说明
可前往[alipay.pass.template.add](https://docs.open.alipay.com/api_24/alipay.pass.template.add)查看更加详细的参数说明。
### [](https://github.com/alipay/alipay-easysdk/blob/master/APIDoc.md#%E5%8D%A1%E5%88%B8%E6%A8%A1%E6%9D%BF%E6%9B%B4%E6%96%B0)卡券模板更新
* API声明
updateTemplate(uniqueId: string, tplContent: string)
* 入参说明
| 字段名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| uniqueId | string | 是 | 商户用于控制模版的唯一性（可以使用时间戳保证唯一性） |
| tplContent | string | 是 | 模板内容信息，遵循JSON规范，详情参见tpl\_content[参数说明](https://doc.open.alipay.com/doc2/detail.htm?treeId=193&articleId=105249&docType=1#tpl_content) |
* 出参说明
可前往[alipay.pass.template.update](https://docs.open.alipay.com/api_24/alipay.pass.template.update)查看更加详细的参数说明。
### [](https://github.com/alipay/alipay-easysdk/blob/master/APIDoc.md#%E5%8D%A1%E5%88%B8%E5%AE%9E%E4%BE%8B%E5%8F%91%E6%94%BE)卡券实例发放
* API声明
addInstance(tplId: string, tplParams: string, recognitionType: string, recognitionInfo: string)
* 入参说明
| 字段名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| tplId | string | 是 | 支付宝pass模版ID，即调用模板创建接口时返回的tpl\_id |
| tplParams | string | 是 | 模版动态参数信息，对应模板中$变量名$的动态参数，见模板创建接口返回值中的tpl\_params字段。示例： |
| recognitionType | string | 是 | Alipass添加对象识别类型，填写“1”表示订单信息 |
| recognitionInfo | string | 是 | 支付宝用户识别信息，参见[UID发券组件对接文档](https://docs.open.alipay.com/199/sy3hs4) |
* 出参说明
可前往[alipay.pass.instance.add](https://docs.open.alipay.com/api_24/alipay.pass.instance.add)查看更加详细的参数说明。
### [](https://github.com/alipay/alipay-easysdk/blob/master/APIDoc.md#%E5%8D%A1%E5%88%B8%E5%AE%9E%E4%BE%8B%E6%9B%B4%E6%96%B0)卡券实例更新
* API声明
updateInstance(serialNumber: string, channelId: string, tplParams: string, status: string, verifyCode: string, verifyType: string)
* 入参说明
| 字段名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| serialNumber | string | 是 | 商户指定卡券唯一值，卡券JSON模板中fileInfo->serialNumber字段对应的值 |
| channelId | string | 是 | 代理商代替商户发放卡券后，再代替商户更新卡券时，此值为商户的PID/AppID |
| tplParams | string | 否 | Alipass添加对象识别类型，填写“1”表示订单信息 |
| status | string | 否 | 券状态，支持更新为USED、CLOSED两种状态 |
| verifyCode | string | 否 | 核销码串值（当状态变更为USED时，建议传），该值正常为模板中核销区域（Operation）对应的message值 |
| verifyType | string | 否 | 核销方式，该值正常为模板中核销区域（Operation）对应的format值，verifyCode和verifyType需同时传入 |
* 出参说明
可前往[alipay.pass.instance.update](https://docs.open.alipay.com/api_24/alipay.pass.instance.update)查看更加详细的参数说明。
* * *
## [](https://github.com/alipay/alipay-easysdk/blob/master/APIDoc.md#%E5%B0%8F%E7%A8%8B%E5%BA%8F%E6%A8%A1%E6%9D%BF%E6%B6%88%E6%81%AF-templatemessage)小程序模板消息 TemplateMessage
### [](https://github.com/alipay/alipay-easysdk/blob/master/APIDoc.md#%E5%8F%91%E9%80%81%E6%A8%A1%E6%9D%BF%E6%B6%88%E6%81%AF)发送模板消息
* API声明
send(toUserId: string, formId: string, userTemplateId: string, page: string, data: string)
* 入参说明
| 字段名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| toUserId | string | 是 | 发送消息的支付宝账号 |
| formId | string | 是 | 用户发生的交易行为的交易号，或者用户在小程序产生表单提交的表单号，用于信息发送的校验 |
| userTemplateId | string | 是 | 用户申请的模板id号，固定的模板id会发送固定的消息 |
| page | string | 是 | 小程序的跳转页面，用于消息中心用户点击之后详细跳转的小程序页面，例如：page/component/index |
| data | string | 是 | 开发者需要发送模板消息中的自定义部分来替换模板的占位符，例如：{"keyword1": {"value" : "12:00"},"keyword2": {"value" : "20180808"},"keyword3": {"value" : "支付宝"}} |
* 出参说明
可前往[alipay.open.app.mini.templatemessage.send](https://docs.open.alipay.com/api_5/alipay.open.app.mini.templatemessage.send)查看更加详细的参数说明。
* * *
