首页 > API调用场景 > 用户标签开放接入指南 > 官方短信业务-ISV接入须知

官方短信业务-ISV接入须知

一、     业务介绍

服务市场为有效管理及规范三方服务商为京东商家提供的短信功能,要求服务商将全部短信业务迁移对接到官方短信通道,同时可基于业务规划选择是否对接官方人群标签筛选功能(具体业务介绍见https://open.jd.com/home/home#/doc/common?listId=720),官方可提供短信发送后的效果数据。

服务商与京东通过官方权益中心(quanyi.shop.jd.com)进行结算,先充值后使用,可通过接口实时查询余额,支持通过服务市场订单进行开票。商家在第三方工具中使用短信服务时向服务商充值,商家的充值价格由服务商自行制定,由服务商开票。

二、      接口说明

(一)  接口列表(最新版详见线下接口文档)

接口名

描述

jingdong.data.vender.userpack.isv.query

筛选人群包

jingdong.data.vender.userpack.isv.upload

上传人群包

jingdong.data.vender.userpack.isv.compute

计算人群包(交并差)

jingdong.data.vender.userpack.isv.create

保存人群包

jingdong.data.vender.userpack.isv.list

查询包列表信息

jingdong.data.vender.userpack.isv.delete

删除人群包

jingdong.data.vender.userpack.isv.status.get

获取人群包状态

jingdong.data.vender.userpack.isv.sms.sent

单条短信测试发送

jingdong.data.vender.userpack.isv.sensitive.word.check

短信敏感词校验

jingdong.data.vender.userpack.isv.sms.batch.sent

短信批量触达发送

jingdong.data.vender.sms.effect.get

短信效果数据

jingdong.data.vender.sms.recharge.surplus

短信资源余量查询接口

jingdong.data.vender.activity.status.query

查询活动状态

jingdong.data.vender.sms.recharge.status

充值状态查询

jingdong.shorturl.generateURL

生成短域

jingdong.data.vender.userpack.param.concat.check

检验页面埋点

jingdong.data.vender.sms.effect.getrt

获取短信实时效果数据

jingdong.data.vender.sms.sign.get

获取短信签名

jingdong.data.vender.sms.sign.add

短信签名注册与创建

jingdong.data.vender.sms.sign.status.get

获取签名审核状态

jingdong.data.vender.userpack.isv.scenesum.get

获取场景标签下人群信息

jingdong.data.vender.userpack.isv.multiupload.end

完成分片上传任务接口(用于用户标签开放)

jingdong.data.vender.userpack.isv.multiupload.process

上传单个分片接口

jingdong.data.vender.userpack.isv.multiupload.start

开始分片上传任务接口(用于用户标签开放)

jingdong.data.vender.userpack.isv.generate.activityid

生成活动ID

jingdong.data.vender.sms.effect.getrt

短信实时效果数据

备注:短信效果数据为t+1,统计维度分为点击链接人群和未点击链接人群,以人群标识flag参数作为区分,1代表点击人群数据,0代表未点击人群数据

(二)  用户标签集合

三、     接入流程

(一)ISV接入申请

非三方短信业务切换服务商:appkey工具名称、isv账号是否接入官方人群标签能力(如需接入需提交相关功能的MRD文档)邮件至jiangwen5@jd.com申请官方短信通道业务接入配置。

三方短信业务切换服务商:填写咚咚对接群内的在线文档,文档链接见群公告(群号:84024782

备注:每周二四邮件回复是否配置成功

(二)申请接口权限包

邮件回复后,isv登录open.jd.com选择对应应用的应用管理,在应用概览中选择对应接口权限包点申请权限,具体需申请的接口包信息如下:

权限id626      权限包名称:京东短信触达(必需)

权限id731权限包名称:人群上传(必需)

权限id621权限包名称:人群筛选(非必需,申请接入官方人群标签能力则申请)

权限id629权限包名称:权益中心(必需)

(三)功能开发与上线

1.创建与修改签名

所有商家在短信发送前需调用签名创建接口在官方短信通道侧注册签名,自定义签名需人工审核(每日18点审核当日提交任务),默认签名(与店铺名称保持一致)则无需审核。

2.短信发送流程开发

【会员营销场景】

场景说明:主要指的是包括但不限于基于RFM等订单或会员标签筛选后发送的营销短信。

技术方案:基于该场景服务商可选择是否对接京东平台的人群标签筛选能力,对接则使用人群筛选接口权限包,不对接则直接通过上传人群接口权限包即可。具体技术文档见“ISV人群筛选接口-v6.1-释义“。

备注:京东平台用于短信渠道的人群标签筛选底层仅支持店铺/品牌会员或已购用户,存在平台统一营销短信频控规则限制。

【指定手机号发送场景】

场景说明:主要指的是商家通过营销活动自行收集用户手机号批量上传发送营销短信。

技术方案:在上传人群包接口传入手机号即可,其余流程同上。

备注:该场景下手机号不受店铺/品牌会员或已购用户的人群规则限制,存在平台统一营销短信频控规则限制,但该类短信只能提供短信发送后的触达总数,无法提供用户行为维度的效果数据。

【订单关怀场景】

场景说明:基于订单流程支持商家针对满足条件用户的手机号按固定短信模板发送关怀类短信。

技术方案:该场景下服务商需先获取官方目前支持的短信模板类型,仅支持使用官方提供的短信模板,如不满足现有场景可通过咚咚群内公告(群号:84024782)中在线文档链接按格式提交新增模板需求。具体接口列表如下:

查询单笔订单详细信息:jingdong.shop.order.get

获取可用模板总数:jingdong.api.SmsModelConfigReadService.countSmsModelConfigByParams

获取可用模板列表:jingdong.api.SmsModelConfigReadService.getSmsModelConfigByParams

使用模板发送短信:jingdong.api.SmsModelConfigWriteService.sendSms

备注:该场景下手机号不受店铺/品牌会员或已购用户的人群规则限制,但该类短信只能提供短信发送后的触达总数,无法提供用户行为维度的效果数据。

该场景下营销类模板短信仍然受平台统一营销短信频控规则限制,通知类模板短信频控规则为每个商家的每个模板类型针对每个用户每天仅支持触达1次。

(四)短信充值与计费流程接入

1.服务商充值短信

服务商以服务商账号(已开店)登录权益中心(quanyi.shop.jd.com),开通短信账户并充值,短信价格为0.03-0.035/条,可在权益中心中查看充值记录和活动记录。

2.服务商冻结短信

服务商请求批量短信发送接口后,权益中心将在短信任务的发送时间基于人群包数量对应的短信条数冻结短信量,若短信量小于该数量,则冻结失败且短信发送请求不成功。服务商重新充值短信后需重新提交任务。

服务商请求单条短信(如测试短信)发送接口前需先调用权益中心创建计划接口进行创建(可每固定时间段调用1次),基于权益中心返回的计划token调用测试短信发送接口,否则将无法查询基于单条短信发送任务的账单。

3.服务商短信解冻和账单记录

短信发送前权益中心将基于非会员等过滤规则进行一次解冻,短信发送次日即t+1权益中心将基于实际短信发送成功量进行二次解冻,将未成功发送短信量解冻至服务商账户。

4.服务商商家账户体系

服务商需搭建基于商家维度的账户及发票体系,服务商与商家侧短信价格可自行制定。

批量发送短信任务无需先调用权益中心的计划创建接口,直接调用短信批量发送接口获取活动id并保存,基于活动id调用权益中心活动查询接口jingdong.asset.isv.activity.query查询账单,可按每个商家或每次短信任务消耗进行查询,支持T+2结算完成。

单条短信任务需先调用权益中心的计划创建接口jingdong.asset.isv.activity.create获取token(调用参数quantity1即可),单条短信发送接口使用token作为活动id传入,基于token调用权益中心活动查询接口jingdong.asset.isv.activity.query查询账单,可按每个商家或每次短信任务消耗进行查询,支持T+2结算完成。

备注:短信计数规则为签名和“回复T退订”包含在内,70个字内算一条短信,超过70个字按每67个字符算一条短信

5.接口调用流程