Bes_Open_API
  1. 客群
Bes_Open_API
  • 开发指南
    • 产品概述
    • 通用项&参数说明
    • 更新日志
  • 鉴权模块(新)
    • openapi-获取token
      POST
  • 线索
    • 市场线索列表V2
      POST
    • 新增/编辑线索
      POST
    • 删除线索
      POST
    • 获取备注列表
      POST
    • 获取线索详情
      POST
    • 新增跟进记录
      POST
    • 获取线索行为事件
      POST
    • 获取线索行为记录
      POST
    • 获取线索分值记录
      POST
    • 市场线索-变更归属人
      POST
    • 批量获取线索分值记录
      POST
    • 表单管理列表
      POST
    • 表单提交数据列表
      POST
    • 获取线索来源
      POST
  • 标签
    • 标签管理-分组列表
      POST
    • 标签管理-分组创建
      POST
    • 标签管理-分组编辑/删除
      POST
    • 标签管理-标签列表
      POST
    • 标签管理-标签创建
      POST
    • 标签管理-标签/编辑/移动
      POST
    • 对象打标签&移除标签
      POST
    • 获取对象和对象标签(对象ID必传)
      POST
    • 获取对象所有打标签流水(打标签时间倒序)
      POST
  • 分组
    • 分组列表
    • 分组下用户列表
    • 获取对象列表
  • 公司
    • 公司列表V2
    • 公司编辑(单字段)
    • 公司创建
  • 表结构
    • 表结构列表
    • 表结构详情
  • 客群
    • 新增/编辑客群数据(仅支持外部数据源)
      POST
    • 获取客群对象列表(微信/外部数据源/企微外部联系人)
      POST
    • 获取客群列表数据-V2(企微外部联系人,外部数据源、留资客户、访客、潜在客户)
      POST
    • 客群字段列表(外部数据源)
      GET
  • 行为(新)
    • 新增应用
    • 获取应用
    • 添加事件
    • 获取事件
    • 添加事件属性
    • 获取事件属性
    • 添加属性选项值
    • 添加用户行为
    • 事件关联事件属性
    • 获取所有自定义事件属性
    • 获取浏览访客行为记录
  • 应用中心
    • 公众号管理
      • 获取微信授权链接
      • 根据微信code获取粉丝信息
      • 根据open_id,批量获取粉丝信息
      • 获取微信公众号列表
      • 获取粉丝信息
      • 获取取关粉丝信息
  • 系统管理
    • 获取某个用户信息
    • 获取组织信息
    • 自定义渠道-渠道列表
    • 获取管理员列表
    • 删除管理员
  • 资料下载
    • 资料下载-列表
  • 会议管理
    • 会议管理-列表数据
    • 会议管理-获取报名数据
    • 会议管理-获取签到参会数据
    • 获取分类列表(支持会议管理&资料下载)
    • 会议管理-会议报名
    • 会议管理-会议签到
    • 会议管理-获取会议详情
  • 内容中心
    • 获取内容分类
    • 获取内容列表
    • 获取内容详情
  • 会员管理
    • 会员管理-获取基础信息
    • 会员管理-获取自定义字段
    • 会员管理-变更积分
    • 根据会员id或会员手机号获取会员详细信息
    • 会员/员工(注册/更新)
    • 根据地区名称查询地区id
    • 获取会员/员工列表
    • 根据openid获取会员/员工信息
    • 会员管理-删除会员
  • 企业微信
    • 绑定外部联系人手机&邮箱&unionid
  • 其他
    • 错误码
  • 自动化工作流
    • 关闭工作流
    • 工作流列表
  1. 客群

新增/编辑客群数据(仅支持外部数据源)

POST
/leads/open-api/customers-add
最后修改时间:2025-05-09 08:06:01

接口描述#

通过该接口,新增/编辑外部数据源数据

请求参数说明#

参数名称参数类型必须说明
user_idstring是系统用户的user_id,获取方法:1.通过 管理员列表接口 获取 2.登录系统获取,位置:个人设置-用户ID
client_typestring是externalDataSource
nextIdint是外部数据源表结构ID
dataarray是请求数据体(与外部数据源表结构对象字段一一对应)

请求体-字段值传递说明#

字段类型说明示例备注
Text文本"hello world"
TextArea多行文本"hello world"
Email邮件"helloworld@qq.com"
PhoneNumber手机号"188xxxxxxxx"
Select下拉"小于100"调用表结构详情接口,字段options 即为下拉字段的选项,接口传值时使用字段选项值的显示名称(label)。options示例如下: [{"label": "小于100","value": "1"},{"label": "100-200","value": "2"},{"label": "200以上","value": "3"}]
Radio单选"小于100"同下拉
CheckBox多选"小于100","100-200"多个选项使用 , 分割
DateTime日期时间"2023-01-01 00:00:00"
Date日期"2023-01-01"
Number数字"100"---
Decimal金额"100.01"
Address地址---
Company公司"北京致趣科技"
Address地址类型传输省市区ID,以|分割。示例:10161|100050(北京|朝阳),10169|100197(河北|邯郸)

返回参数说明#

参数名称说明
code返回码
msg错误信息
data数据集

返回码#

返回码说明
0成功
12210首要身份识别字段未设置
20006请求体为空
70005请输入client_type客群类型
70006请输入nextId

请求参数

Query 参数
access_token
string 
必需
通过 鉴权模块-获取token接口
示例值:
{{access_token}}
Body 参数application/json
user_id
string 
系统用户id
必需
系统用户user_id(控制数据权限,以当前用户权限返回数据。获取方法:1.通过 管理员列表接口 获取 2.登录系统获取,位置:个人设置-用户ID
client_type
string 
客群类型
必需
externalDataSource=外部数据源
nextId
string 
必需
外部数据源表结构ID
data
object 
必需
请求数据体(外部数据源表结构对象字段一一对应)
mobile
string 
可选
示例:字段名称mobile
name
string 
可选
示例:字段名称name
示例
{
  "user_id": "usercd4adfcb940f4aad4785ca60f2b34aad",
  "nextId": "1406",
  "data": {
    "mobile": "13888888888",
    "name": "测试接口-1",
    "email": "123yt@qq.com",
    "dtime": "2023-11-07 13:14",
    "dtime1": "2023-11-07"
  },
  "client_type": "externalDataSource"
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'https://openapi.beschannels.com/leads/open-api/customers-add?access_token=uURA1lnYsBr22I6UYoLZH0s9y3HU2Xsn7UHA4dIDgHN_67Z5EZskh4YMcymD5enS4GGjWpOERwQtug3Y4AGwvbvLB_A3TwKBpb_J4z0MUm6oaNQmqA-3Ef9Q-PHbVPk3' \
--header 'Content-Type: application/json' \
--data-raw '{
    "user_id": "usercd4adfcb940f4aad4785ca60f2b34aad",
    "nextId": "1406",
    "data": {
        "mobile": "13888888888",
        "name": "测试接口-1",
        "email": "123yt@qq.com",
        "dtime": "2023-11-07 13:14",
        "dtime1": "2023-11-07"
    },
    "client_type": "externalDataSource"
}'

返回响应

🟢200成功
application/json
Body
code
integer 
必需
状态值 0 成功,其他失败
msg
string 
状态码描述
必需
data
object 
必需
customer_id
string 
必需
customer_id
示例
{
  "code": 0,
  "msg": "成功",
  "data": {
    "customer_id": "02039aa9-fd2b-39bd-b3c6-4855772adfea"
  }
}
修改于 2025-05-09 08:06:01
上一页
表结构详情
下一页
获取客群对象列表(微信/外部数据源/企微外部联系人)
Built with