开发者社区
社区提问意见反馈
开发者钉组织
扫描二维码
加入支付宝开发者钉组织
支付产品
私域产品
小程序产品
支付有礼
商家粉丝群
api 列表
支付宝电子发票
公域产品
营销产品
资金产品
会员产品
信用产品
安全产品
广告产品
开发 > 服务端 > 私域产品 >  > 接入指南
收藏
订阅更新
我的文档
设置
完成 后,商家/服务商可根据本文指引快速接入 商家粉丝群 产品。
说明:
商家粉丝群 仅支持自研商家/服务商通过 自研应用第三方应用 代调用(传入 app_auth_token)方式,调用 api 接入。
商家粉丝群 产品暂不支持沙箱调试。
若服务商调用则需要服务商主账号登录支付宝服务商工作台,进入委托授权商户的工作台,再点击商家粉丝群页面。
完整接口时序图
群组管理

群管理

群消息运营

入群有礼

支付有礼(推广计划)

群小助手(定向消息)

群小助手(快捷服务)

顶部运营位

群组管理
创建群组
商家/服务商可按照以下流程调用接口创建群组。

添加群管理员
商家/服务商调用 发起授权后,用户需要在 支付宝消息盒子 > 服务消息,点击 商家粉丝群管理员信息确认 消息,进入详情,手动确认授权,确认后,该授权关系会更新为已授权状态,便于后续在创建群组、编辑群组接口传入群主和群管理员。

分页查询群管理员列表
商家/服务商可调用  查询授权记录。
注意:创建群组、编辑群组接口中的群主和群管理员信息需要从此接口查询获得。
创建群组
商家/服务商可调用 创建商家群。
注意:
传入的群主和群管理员,需要从 接口查询获得。
传入的群组管理员,需要先行由主账号或者群超级管理员,在 商家平台服务商平台 添加群超级管理员权限或者群组管理员权限。商家调用创建接口,需要商家在 商家平台 添加。服务商代调用创建接口,需要服务商在 服务商平台 添加。

删除群管理员
商家/服务商可调用 删除群管理员。
查询群组详情
商家/服务商可调用 查询群组基础信息、群信息、入群欢迎语。
群组基础信息:包含群组 id、群组名称、群组管理员列表等信息。
群信息:包含群 id、群名称、群介绍、群主、群管理员等群配置信息。
入群欢迎语:包含图文消息、小程序消息、文本消息。
编辑群组
商家/服务商可调用 编辑群组信息。
注意:
传入的群主和群管理员,需要从 查询获得。
传入的群组管理员,需要先行由主账号或者群超级管理员,在 商家平台服务商平台 添加群超级管理员权限或者群组管理员权限。

配置入群欢迎语
商家/服务商可调用 配置入群欢迎语,支持传入群组列表批量修改入群欢迎语。
配置群公告
商家/服务商可调用 配置群公告,支持传入群组列表批量修改群公告。
分页查询群组列表
商家/服务商可调用 分页查询群组基础信息、群信息。
群组基础信息:包含群组 id、群组名称、群组管理员列表等信息。
群信息:包含群 id、群名称、群介绍、群主、群管理员等群配置信息。
生成群组推广链接
商家/服务商通过群组 id 和推广渠道可调用  获取群组推广链接。
推广渠道包含小程序推广、生活号推广、支付宝端内通用推广、直播间推广、端外推广。
查询商家群用户的入群状态
商家/服务商通过用户 id 和群组 id 可调用 查询用户是否入群。
群信息变更推送
商家/服务商可通过监听 感知用户入群/退群变化,以便商家及时更新群用户信息。
删除群组
商家/服务商可调用 删除群组。传入群组id,若群组下没有群聊,即可删除对应群组。
注意:删除群组前,必须先将群组下群聊都解散,否则删除报错。解散群聊接口参考下方 解散群聊
群管理
分页查询群组下群列表
商家/服务商通过群组 id 可调用 分页查询群组下的群信息列表。
群信息:包含群 id、群名称、群成员数量、群主、群头像、创建时间等信息。
查询群详情
商家/服务商通过群 id 和是否返回群成员信息可调用 查询群信息和群成员信息。
群信息:包含群名称、群管理员列表、群主、群成员数量、群头像、群公告、创建时间、群成员列表。
群成员信息:包含用户 openid、入群时间、邀请者的 openid、用户名称等。
注意:若需要获取用户 uid 对应的 unionid、邀请者 uid 对应的 unionid,请阅读指南 ,进行以下操作。
1openid 升级 通过
2应用分组管理 进行
解散群聊
商家/服务商可调用 解散群聊。传入群id,调用接口即可解散。
推广渠道管理
为了便于商家扩展自己的推广渠道,商家群开放了群组维度下的渠道管理能力,包含:渠道创建、渠道查询、渠道删除。
渠道创建
商家/服务商可调用 创建群组维度下的渠道,可创建一级渠道、二级渠道,也可以在已有的官方渠道下创建子渠道。
渠道查询
商家/服务商可调用 查询群组维度下的渠道信息(具体为分级和分页接口)。
渠道删除
商家/服务商可调用 删除群组维度下的渠道(只能删除非官方的渠道)。
群消息运营
分页查询群发消息记录
商家/服务商可调用 查询商家群内群发消息发送记录列表,包含消息 id、消息标题、消息类型、发送状态、发送时间、群组 id 列表等信息。
查询群发消息详情
商家/服务商可调用 传入消息id("md"开头),可查询商家群内群发消息详情和发送记录列表。
发送群消息
商家/服务商可调用 传入群组 id 列表和消息配置,发送消息支持消息类型:小程序消息、图片消息、链接消息、纯文本消息。
注意单次发送仅支持一种消息类型。
操作群发消息
商家/服务商可调用 传入消息 id和操作类型(目前支持撤回、删除),操作群发消息。
群小助手
定向消息
小助手定向消息创建
商家/服务商可调用 创建小助手定向消息,完成群内分人群精细化运营,同时在群内底部小助手的位置展示推荐内容。
注意:目前支持的推荐内容类型有:自定义活动类型、权益推荐类型。权益推荐,目前只支持导码券。
导码券:商户建券时上传自定义券码,发券时系统随机选取上传的券码发放。创建券时,对应码模式 merchant_upload。
分页查询小助手定向消息
商家/服务商可调用 分页查询小助手定向消息。传入小助手业务类型(目前支持传入自定义活动、优惠券推荐类型)和状态。返回小助手定向消息发送记录列表。包含小助手内容 id、发送时间、发送状态、消息名称等信息。
查询小助手定向消息详情
商家/服务商可调用 查询小助手定向消息详情。传入小助手内容 id。返回小助手定向消息详情,包含小助手内容 id、发送时间、发送状态、消息名称、群组 id 列表、发送内容等信息。
更新小助手定向消息状态
商家/服务商可调用 更新小助手定向消息状态。传入小助手内容 id 和待更新状态,更新小助手内容状态,目前支持上线、下线、删除状态。
快捷服务
创建或者修改小助手快捷服务
商家/服务商可按照以下流程调用接口,创建或修改小助手快捷服务。

查询小助手所有群组选项
商家/服务商调用 查询商户下所有群组,返回群组 id、群组名称、是否被禁用。
创建或者修改小助手快捷服务
商家/服务商调用创建或者修改小助手快捷服务。当小助手内容 id 不传的时候,走创建链路;当小助手内容 id 传入的时候,走修改链路。每个群组有且仅能创建一个小助手快捷服务。
注意:
传入的群组 id 列表,需要从  接口查询获得(返回群组 id、群组名称、是否被禁用),且须是未被禁用的群组 id
如若传入的群组 id 被禁用(指该群组已经创建过小助手), 会报错。
查询小助手快捷服务列表
商家/服务商调用 查询小助手快捷服务列表。支持传入快捷服务名称进行模糊搜索。支持传入状态。返回快捷服务列表,包含小助手内容 id、小助手发布时间、状态、小助手快捷服务名称、配置服务数量。
查询小助手快捷服务详情
商家/服务商调用查询快捷服务详情。传入小助手内容 id。返回快捷服务详情包含小助手业务类型、小助手内容id、小助手发布时间、状态、小助手快捷服务名称、群组id列表、服务列表。服务列表,包含服务名称、服务跳转地址、服务类型、服务logo。
修改小助手快捷服务状态
商家/服务商调用 修改快捷服务状态。传入小助手内容 id 和待更新状态,更新小助手内容状态,目前支持上线、下线状态。
入群有礼
查询入群有礼配置记录列表
商家/服务商可调用 分页查询入群有礼配置记录列表。传入群组id,可精确搜索指定群组下入群有礼配置记录。返回入群有礼配置记录,包含群组id、群组名称、配置渠道 code 列表、渠道名称列表、入群有礼渠道个数、有效入群有礼个数、失效入群有礼个数、暂停的入群有礼个数、到期的入群有礼个数、有效的入群有礼个数。
查询入群有礼
商家/服务商可调用 查询入群有礼详情。传入群组id。返回入群有礼详情,包含群组id、群组名称、入群有礼列表。入群有礼列表包含活动id、渠道、入群有礼开始时间、入群有礼结束时间、渠道名称、活动名称、入群有礼状态。
创建入群有礼
商家/服务商可调用 批量创建入群有礼。传入群组id列表和入群有礼列表,入群有礼包含活动id、渠道、入群有礼开始时间、入群有礼结束时间。
说明:本期仅支持 default 默认渠道。活动id本期仅支持导码券。
默认渠道:"default",用户从任何渠道入群都将展示该福利。
目前所有渠道有:
支付有礼(支付宝支付后推荐的主渠道)
小程序快窗(小程序快窗可投放入群)
小程序组件(商家小程序可嵌入入群官方组件)
导码券:商户建券时上传自定义券码,发券时系统随机选取上传的券码发放。创建券时,对应码模式 merchant_upload。
修改入群有礼状态
商家/服务商可调用 修改入群有礼状态。传入群组id、渠道code、状态,更新入群有礼状态。
说明:本期渠道仅支持 default 默认渠道,状态支持停用、启用、删除。
支付有礼(推广计划)
查询入群规则
商家/服务商可调用 查询入群规则列表。不需要传入参数。返回入群规则列表,包含入群规则类型、入群规则id,用于在创建推广计划传入参数。入群规则类型有 按城市入群、按门店入群。
注意:创建推广计划接口入参的绑定场景、推广计划入群规则id 需要从此接口查询获得。
创建推广计划
商家/服务商可调用 创建推广计划。在支付结果页,引导支付后的用户入群。传入推广计划名称、绑定场景、推广开始时间、推广结束时间、群组id 或者推广计划入群规则id、收款账号列表。收款账号列表包含商业主体类型、收款账号、范围类型。
注意
绑定场景:可以传入按群组入群、按城市入群、按门店入群。
选择按群组入群,则必须传入群组id。是否能选择 按城市入群 或者 按门店入群,需要从 查询获得,如果接口有返回,则可选择对应入群规则类型(按城市入群 或者 按门店入群)和入群规则id(与规则类型一起返回的规则id)。
批量查询推广计划
商家/服务商可调用 分页查询推广计划配置记录列表。传入页码、每页条数。返回推广计划配置记录,包含推广活动id、推广计划名称、绑定场景、收款账号数、审核状态、推广状态、推广开始时间、推广结束时间、提示语、群组id、群组名称。
查询推广计划详情
商家/服务商可调用 查询推广计划详情。传入推广计划id。返回推广计划详情,包含推广计划id、推广计划名称、绑定场景、收款账号列表、审核状态、推广状态、推广开始时间、推广结束时间、群组id、群组名称。
修改推广计划状态
商家/服务商可调用 更新推广计划状态。传入推广计划id和待更新状态,更新推广计划状态。目前支持启用、停用状态。
删除推广计划
商家/服务商可调用 删除推广计划。传入推广计划id,删除推广计划。
顶部运营位
查询顶部运营位列表
商家/服务商可调用 分页查询顶部运营位配置记录列表。可传入状态、业务类型列表,可精确搜索入群有礼配置记录。返回顶部运营位配置记录,包含商家群活动id、活动标题、商家群活动状态、展位位置、业务类型、展示优先级、活动开始时间、活动截止时间、群组id列表、群组数量。
查询顶部运营位
商家/服务商可调用 查询顶部运营位详情。传入商家群活动id。返回顶部运营位详情,包含商家群活动id、业务类型、活动开始时间、活动截止时间、群组id列表、展示优先级、商家群活动状态、展位位置、自定义活动顶部运营位内容、优惠群活动顶部运营位内容、商品群活动顶部运营位内容。自定义活动顶部运营位内容,包含活动标题、活动描述、图片id、活动行动点名称、活动跳转地址。优惠群活动顶部运营位内容,包含优惠券id。商品群活动顶部运营位内容,包含商品id、应用id
创建顶部运营位
商家/服务商可调用 创建顶部运营位,在群内顶部的位置展示推荐内容。传入业务类型、活动开始时间、活动截止时间、群组id列表、展示优先级、自定义活动顶部运营位内容、优惠群活动顶部运营位内容、商品群活动顶部运营位内容。自定义活动顶部运营位内容,包含活动标题、活动描述、图片id、活动行动点名称、活动跳转地址。优惠群活动顶部运营位内容,包含优惠券id。商品群活动顶部运营位内容,包含商品id、应用id。返回商家群活动id。
注意:目前支持的顶部运营位内容类型有:自定义活动类型、优惠券活动类型、商品活动类型。
编辑顶部运营位
商家/服务商可调用修改顶部运营位。传入商家群活动id、业务类型、活动开始时间、活动截止时间、群组id列表、展示优先级、自定义活动顶部运营位内容、优惠群活动顶部运营位内容、商品群活动顶部运营位内容。自定义活动顶部运营位内容,包含活动标题、活动描述、图片id、活动行动点名称、活动跳转地址。优惠群活动顶部运营位内容,包含优惠券id。商品群活动顶部运营位内容,包含商品id、应用id
注意:只能在草稿状态进行编辑操作。目前支持的顶部运营位内容类型有:自定义活动类型、优惠券活动类型、商品活动类型。
变更顶部运营位状态
商家/服务商可调用 更新小助手顶部运营位状态。传入商家群活动id和待更新状态,更新小助手内容状态。目前支持提前结束状态。
内容没有解决您的问题?您还可以前往 或 寻求帮助
凯发k8官方网娱乐官方 copyright © 支付宝(杭州)信息技术有限公司  | icp证浙b2-20160559
该文档对你是否有帮助?
当前页面目录
网站地图