- 生活服务商家应用 OpenAPI SDK 总览
- OpenAPI
- 门店管理
- 团购核销
- 团购对账
- 会员接入
- 订单查询
- 三方码
- 商品发布及查询
- 酒旅
- 预置码
- 代运营
- 接入前准备
- 餐饮团购
- 线索经营
- 团购退款
会员入会&退会
更新时间 2024-08-30 03:29:02
收藏用户在抖音端内发起会员的绑定和解绑, 同步通知到商家侧。
使用限制
无
接口说明
- 1.用户在抖音端内发起会员的绑定和解绑，会同步通知到商家，商家接收到绑定信息后需要返回会员信息（包括积分, 等级, 是否为新会员等)。
- 2.使用抖音开放平台的 SPI 机制接入。该机制需要开发者在抖音开放平台或者服务商平台配置 SPI 回调 URL。
基本信息
HTTP URL | 地址由服务商提供 | |||
HTTP Method | POST | |||
权限申请 | 会员管理 | |||
权限要求 |
| |||
SPI 配置
- 1.入口：抖音开放平台-开发者平台/抖音开放平台-服务商平台 → 控制台 → 第三方应用 → 应用详情页 → 开发设置 →SPI 回调
- 2.配置 URL 监听会员入会和退会场景消息：抖音请求三方系统发送用户入会通知、抖音请求三方系统发送用户退会通知
-874138463772338.1.png)
签名规则
会员入会接口
请求参数
字段名 | 类型 | 解释 |
open_id | string | 加密后的uid，用户的唯一标志 |
account_id | string | 商家抖音来客品牌户 id |
mobile | string | 用户绑定手机号 |
请求示例
JSON
复制content内容
{
"open_id":"f6e35c98-1e53-4943-ad6d-f476f869deab",
"account_id":"17371731",
"mobile":"13527153122"
}
响应参数
字段名 | 类型 | 是否必填 | 解释 |
data | struct | 是 | |
.error_code | int | 是 | 业务错误码
说明 商家返回不为 100 的错误码，抖音侧会每天尝试 5 次重试，直至用户最终入会成功。200错误码抖音侧不会重试 |
.description | string | 是 | 错误消息描述 |
.point_amount_cent | int | 是 | 积分数(积分数量 * 100)。没有接入积分可以返回0 |
.user_level | int | 是 | 等级 (等级需要>=1 && <= 10)。没有接入等级可以返回1 |
.is_new_member | bool | 是 | 是否为抖音本地生活在全渠道给商家来带的新会员（品牌新会员） 说明 商家需要保证该字段的幂等性，即由于网络超时可能导致抖音侧重复发起某用户的入会请求，商家需要保证多次请求返回的结果一致。（建议商家以account_id + open_id 做标识，保持始终幂等）参见文档结尾处： is_new_member 字段的含义和注意事项。 |
响应示例
入会时要告知抖音侧用户的积分等级信息。
json复制// 成功示例
{
"data": {
"error_code": 0,
"description": "success",
"point_amount_cent": 1000,
"user_level": 1,
"is_new_member": true
}
}
// 错误示例
{
"data": {
"error_code": 11,
"description": "业务错误 错误代码11",
"point_amount_cent": 1000,
"user_level": 1,
"is_new_member": true
}
}
会员退会接口
请求参数
字段名 | 类型 | 解释 |
open_id | string | 加密后的uid，用户的唯一标志 |
account_id | string | 商家抖音来客品牌户 id |
mobile | string | 用户绑定手机号(退会暂时不提供，默认为0，保留字段) |
请求示例
JSON复制content内容
{
"open_id":"asdaksjdjhiqudbas",
"account_id":"17371731",
"mobile":"0"
}
响应参数
字段名 | 类型 | 解释 |
data | struct | |
.error_code | int | 业务错误码
|
.description | string | 错误消息描述 |
响应示例
退会接口：商家侧根据自己内部业务需求，决定商家域会员退会处理逻辑
- 1.商家需要和抖音侧保持一致，且退会失败，返回100系统异常，可触发抖音侧重试。（目前不保证强一致性，最大重试3次，间隔1s。）
- 2.不需要保持一致，可直接返回成功。
json复制{
"data": {
"error_code": 0,
"description": "success"
}
}
FAQ
is_new_member 字段的含义和注意事项
名词解释
- •全渠道新会员（品牌新会员）：表示该会员从未在抖音以外的渠道（美团、淘宝、商家自研app等）加入过会员，为抖音渠道给商家带来的新会员（is_new_member=true）
- •抖音新会员：表示该会员已经在抖音以外的渠道（美团、淘宝、商家自研app等）加入过会员（is_new_member=false）
字段使用场景
商家可以在抖音来客针对全渠道新会员（品牌新会员）单独设置开卡礼
- •入会礼配置：在抖音来客后台权益模块可以配置入会礼开卡有礼劵，可以指定适用范围为抖音新会员、品牌新会员。
- •入会礼发放：
- a.通过抖音侧入会记录，保证入会礼最多发放一次。用户入会时，抖音本地会员会首先检测用户是否在抖音渠道为首次入会，非首次入会则不再发放入会礼。即用户在抖音渠道退会后，重新入会，不会再发放入会礼。
- b.根据开卡礼适用范围，决定是否发放开卡礼。适用范围为抖音新会员的开卡礼，会发放给抖音渠道首次入会的所有会员；适用范围为品牌新会员的开卡礼，只会发放给商家全渠道新会员（商家回传字段 is_new_member=true）
入会处理注意事项
- •超时导致的全渠道新用户含义发生变化
入会链路比较长，可能因为网络等问题，导致商家的返回结果抖音侧无法收到。这个时候抖音判定该用户没有入会成功，会重新向商家推送该用户的入会事件消息。商家如果需要区分品牌新老会员，需要保证该字段返回结果幂等。
- •用户多次退会和入会导致 的全渠道新用户含义发生变化
如果某个用户首次入会，商家回传该用户为抖音本地生活带来的全渠道新用户（is_new_member=true）。则即使该用户在抖音渠道退会后重新入会，商家仍需要保证回传数据为抖音本地生活带来的全渠道新用户（is_new_member=true）。该逻辑主要是为了方便抖音侧长期为商家进行一些数据分析和统计，做一些更深度的优化工作。
点击纠错
