生活号发送消息

该功能解决服务提供者向用户精准推送各类信息服务的需求。生活号可以向目标用户推送业务待办、业务通知、营销活动、公告等消息。

生活号提供的发送消息相关接口如下:

接口英文名 接口中文名 API文档

alipay.open.public.message.custom.send

异步单发消息(客服接口)

查看文档

alipay.open.public.message.total.send

群发消息接口

查看文档

alipay.open.public.message.single.send

单发模板消息接口

查看文档

发送消息接口流程:

异步单发消息(客服接口)

接口名称:alipay.open.public.message.custom.send

使用场景举例:开发者可以使用该接口实现对用户消息的回复功能,也可以使用该接口实现客服等扩展功能。

注:用户主动与生活号交互的48小时之内,生活号可以使用该接口向该用户进行消息推送。

该接口可以发送以下2种类型的消息:

  1. 文本消息
  2. 图文消息--图片宽高比为2:1,建议尺寸540*270,不符合比例的图片显示时将会被部分切割

 

请求参数如下:

文本消息

{
    "to_user_id": "2088283746283746",
    "msg_type": "text",
    "text": {
        "content": "你好"
    }
}
参数名 是否必须 参数说明

to_user_id

消息接收用户的userid

msg_type

消息类型,text

content

文本消息内容

 

图文消息

单条图文消息示例:

{
    "to_user_id": "2088283746283746",
    "msg_type": "image-text",
    "articles": [
        {
            "action_name": "立即查看",
            "desc": "图文内容",
            "image_url": "http: //example.com/abc.jpg",
            "title": "标题",
            "url": "https://www.example.com/a.php"
        }
    ]
}

多条图文消息示例:

{
    "to_user_id": "2088283746283746",
    "msg_type": "image-text",
    "articles": [
        {
            "action_name": "立即查看",
            "desc": "图文内容",
            "image_url": "http: //example.com/abc.jpg",
            "title": "标题",
            "url": "https://www.example.com/a.php"
        },
        {
            "action_name": "查看余额",
            "desc": "图文内容",
            "image_url": "http: //example.com/efg.jpg",
            "title": "标题2",
            "url": "https://www.example.com/b.php"
        }
    ]
}
参数名 是否必须 参数说明

to_user_id

消息接收用户的userid

msg_type

消息类型,image-text

articles

图文消息子消息项集合,单条消息最多6个子项,否则会发送失败

 

其中articles中的子项参数

参数名 是否必须 参数说明

title

图文消息标题,title、desc、image_url不可同时为空

desc

图文消息内容,title、desc、image_url不可同时为空

image_url

图片链接,对于多条图文消息的第一条消息,该字段不能为空,title、desc、image_url不可同时为空

url

点击图文消息跳转的链接

action_name

链接文字

 

群发消息接口

接口名称:alipay.open.public.message.total.send

使用场景举例:开发者可以通过本接口向所有关注该生活号的用户发送消息。

该接口可以发送以下2种类型的消息:

  1. 文本消息
  2. 图文消息--图片宽高比为2:1,建议尺寸540*270,不符合比例的图片显示时将会被部分切割

请求参数如下:

文本消息

{
    "msg_type": "text",
    "text": {
        "content": "你好"
    }
}
参数名 是否必须 参数说明

msg_type

消息类型,text

content

文本消息内容

 

图文消息

单条图文消息示例:

{
    "msg_type": "image-text",
    "articles": [
        {
            "action_name": "立即查看",
            "desc": "图文内容",
            "image_url": "http: //example.com/abc.jpg",
            "title": "标题",
            "url": "https://www.example.com/a.php"
        }
    ]
}

多条图文消息示例:

{
    "msg_type": "image-text",
    "articles": [
        {
            "action_name": "立即查看",
            "desc": "图文内容",
            "image_url": "http: //example.com/abc.jpg",
            "title": "标题",
            "url": "https://www.example.com/a.php"
        },
        {
            "action_name": "查看余额",
            "desc": "图文内容",
            "image_url": "http: //example.com/efg.jpg",
            "title": "标题2",
            "url": "https://www.example.com/b.php"
        }
    ]
}
参数名 是否必须 参数说明

msg_type

消息类型,image-text

articles

图文消息子消息项集合,单条消息最多6个子项,否则会发送失败

 

其中articles中的子项参数

参数名 是否必须 参数说明

title

图文消息标题,title、desc、image_url不可同时为空

desc

图文消息内容,title、desc、image_url不可同时为空

image_url

图片链接,对于多条图文消息的第一条消息,该字段不能为空,title、desc、image_url不可同时为空

url

点击图文消息跳转的链接

action_name

链接文字

 

单发模板消息接口

接口名称:alipay.open.public.message.single.send

使用场景举例:模板消息是指如银行动账提醒、航空公司值机提醒等对消费者非常有价值的消息类型,模板消息符合特定的格式,无需用户发生交互就可以主动向用户推送。

 

申请消息模板

要发送模板消息,首先需要申请对应的消息模板,目前支持2种申请方式:

  1. 通过接口申请
  2. 生活号后台(fuwu.alipay.com)上自助申请

 

接口申请请参照:消息模板

前台自助申请,步骤如下:

第一步:进入生活号平台,点击左侧导航消息–模板消息,首次领取模板需要选择行业;

第二步:点击“从模板库中添加”进入模板库,搜索找到需要的行业模板,点击“详情”,如图

第三步:点击“添加”按钮即可领取该模板,获取模板ID,如图

第四步:如果在模板库中找不到想要的模板,点击模板库右上角“帮助我们完善模板库”可以创建自定义模板,贡献新模板需要等待7天的审核期,请耐心等待。

 

请求参数说明:

{
   "to_user_id":"2088283746283746",
   "template":{
      "template_id":"cbb9fdded2b74fe4bb082de3ed1e1eb2",
      "context":{
         "head_color":"#85be53",
         "url":"http://m.baidu.com",
         "action_name":"查看详情",
         "keyword1":{
            "color":"#000000",
            "value":"2014-09-24"
         },
         "keyword2":{
            "color":"#85be53",
            "value":"HU7142"
         }
      }
   }
}
参数名 是否必须 参数说明

to_user_id

消息接收用户的userid

template

消息模板相关参数,其中包括template_id模板ID和context模板上下文

其中template中的各项参数分别为:

参数名 是否必须 参数说明

template_id

消息模板ID

context

消息模板上下文,即模板中定义的参数及参数值

其中context中的各项参数分别为:

参数名 是否必须 参数说明

head_color

顶部色条的色值

url

点击消息后承接页的地址

action_name

底部链接描述文字,如“查看详情”

keyword1

模板中占位符的值及文字颜色,value和color都为必填项,color为当前文字颜色

keyword2

模板中占位符的值及文字颜色,value和color都为必填项,color为当前文字颜色

 

模板消息示例图:

上图的模板消息商户占位符格式如下:

{{first.value}}
  
航班日期:{{keyword1.value}}
起降时间:{{keyword2.value}}
航班行程:{{keyword3.value}}
航班号:{{keyword4.value}}
  
{{remark.value}}

 

商户调用时入参JSON如下

{
   "template":{
      "context":{
         "keyword1":{
            "color":"#000000",
            "value":"2014-09-24"
         },
         "keyword4":{
            "color":"#85be53",
            "value":"HU7142"
         },
         "keyword3":{
            "color":"#000000",
            "value":"成都双流T2到北京首都T1"
         },
         "keyword2":{
            "color":"#000000",
            "value":"21:45起飞/00:15降落"
         },
         "remark":{
            "color":"#85be53",
            "value":"现在可以通过航旅纵横生活号值机功能提前选座,还可以为好友办理值机哦~预祝您旅途愉快!"
         },
         "head_color":"#85be53",
         "url":"http://m.baidu.com",
         "action_name":"查看详情",
         "first":{
            "color":"#000000",
            "value":"尊敬的熊先生:"
         }
      },
      "template_id":"cbb9fdded2b74fe4bb082de3ed1e1eb2"
   },
   "to_user_id":"m7DZN0VfcHYP6IRA1sP1gBuSX3JjLZtwilbxOzPGDUrbq9FV8CBamV+6ZPDwOg7401"
}
onlineServer