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
    • 获取接口数据处理状态(API接口数据)
      POST
  • 标签
    • 标签管理-分组列表
      POST
    • 标签管理-分组创建
      POST
    • 标签管理-分组编辑/删除
      POST
    • 标签管理-标签列表
      POST
    • 标签管理-标签创建
      POST
    • 标签管理-标签/编辑/移动
      POST
    • 对象打标签&移除标签
      POST
    • 获取对象和对象标签(对象ID必传)
      POST
    • 获取对象所有打标签流水(打标签时间倒序)
      POST
  • 分组
    • 分组列表
    • 分组下用户列表
    • 获取对象列表
    • 市场线索移入/移出分组
  • 公司
    • 公司列表V2
    • 公司编辑(单字段)
    • 公司创建
    • 获取公司详情
  • 扩展对象(业务机会等)
    • 对象列表
    • 新增/编辑对象
    • 删除对象
    • 记录类型-全部列表
    • 记录类型-根据当前账号权限返回可以的列表
  • 表结构
    • 表结构列表
    • 表结构详情
  • 潜在客户
    • 新增/编辑客群数据(仅支持外部数据源)
    • 获取客群列表数据-V2(企微外部联系人,外部数据源、留资客户、访客、潜在客户)
    • 客群字段列表(外部数据源)
  • 行为(新)
    • 新增应用
    • 获取应用
    • 添加事件
    • 获取事件
    • 添加事件属性
    • 获取事件属性
    • 添加属性选项值
    • 添加用户行为
    • 事件关联事件属性
    • 获取所有自定义事件属性
    • 获取浏览访客行为记录
  • 应用中心
    • 公众号管理
      • 获取微信授权链接
      • 根据微信code获取粉丝信息
      • 根据open_id,批量获取粉丝信息
      • 获取微信公众号列表
      • 获取粉丝信息
      • 获取取关粉丝信息
  • 系统管理
    • 获取某个用户信息
    • 获取组织信息
    • 自定义渠道-渠道列表
    • 获取管理员列表
    • 删除管理员
  • 资料下载
    • 资料下载-列表
  • 会议管理
    • 会议管理-列表数据
    • 会议管理-获取报名数据
    • 会议管理-获取签到参会数据
    • 获取分类列表(支持会议管理&资料下载)
    • 会议管理-会议报名
    • 会议管理-会议签到
    • 会议管理-获取会议详情
  • 内容中心
    • 获取内容分类
    • 获取内容列表
    • 获取内容详情
  • 会员管理
    • 会员管理-获取基础信息
    • 会员管理-获取自定义字段
    • 会员管理-变更积分
    • 根据会员id或会员手机号获取会员详细信息
    • 会员/员工(注册/更新)
    • 根据地区名称查询地区id
    • 获取会员/员工列表
    • 根据openid获取会员/员工信息
    • 会员管理-删除会员
  • 企业微信
    • 绑定外部联系人手机&邮箱&unionid
  • 其他
    • 错误码
  • 自动化工作流
    • 关闭工作流
    • 工作流列表
  1. 线索

获取线索行为记录

POST
/leads/open-api/leads-behavior-list
线索行为
最后修改时间:2024-12-16 08:23:36

接口描述#

通过该接口,拉取市场线索行为记录。

接口调用限制为#

每秒50次。

请求参数说明#

参数名称参数类型必须说明
user_idstring是系统用户的user_id,获取方法:1.通过 管理员列表接口 获取 2.登录系统获取,位置:个人设置-用户ID
leads_idint是市场线索id,通过 市场线索列表接口 获取
mobileString否市场线索手机号(首要身份识别字段)
page_numint是页码
page_sizeint是每页条数
start_timestring否开始时间(日期格式 例如 2023-04-23)
end_timestring否结束时间(日期格式 例如 2023-04-25)

返回参数说明#

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

请求参数

Query 参数
access_token
string 
必需
通过 鉴权模块-获取token接口
示例值:
{{access_token}}
Body 参数multipart/form-data
user_id
string 
必需
系统用户user_id(获取方法:1.通过 管理员列表接口 获取 2.登录系统获取,位置:个人设置-用户ID
leads_id
integer 
可选
线索id(线索id和手机号不能同时为空)
mobile
string 
可选
线索手机号(首要身份识别字段,线索id和手机号不能同时为空)
start_time
string 
可选
开始时间(日期格式 2023-04-23)0点开始
end_time
string 
可选
结束时间(日期格式 2023-04-25)23:59:59结束
page_num
integer 
可选
示例值:
1
page_size
number 
可选
示例值:
20
behavior_sort
string 
可选
desc=倒序,asc=正序,默认为倒序
behavior_json
string 
可选
根据应用事件属性筛选,数据根据线索事件属性类型获取,示例:[{"id":"5--18","attribute_name":"page_view"},{"id":"29--26","attribute_name":"watch_meeting"},{"id":"9--25","attribute_name":"watch_meeting"}]

示例代码

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/leads-behavior-list?access_token=uURA1lnYsBr22I6UYoLZH0s9y3HU2Xsn7UHA4dIDgHN_67Z5EZskh4YMcymD5enS4GGjWpOERwQtug3Y4AGwvbvLB_A3TwKBpb_J4z0MUm6oaNQmqA-3Ef9Q-PHbVPk3' \
--form 'user_id=""' \
--form 'leads_id=""' \
--form 'mobile=""' \
--form 'start_time=""' \
--form 'end_time=""' \
--form 'page_num="1"' \
--form 'page_size="20"' \
--form 'behavior_sort=""' \
--form 'behavior_json=""'

返回响应

🟢200请求成功
application/json
Body
code
integer 
必需
msg
string 
必需
data
object 
必需
list
array [object {11}] 
必需
total
integer 
总数
必需
示例
{
    "code": 0,
    "msg": "成功",
    "data": {
        "list": [
            {
                "app_id": 1,
                "app_name": "表单",
                "label": "自定义表单浏览",
                "label_display_name": "page_view",
                "target_type": "custom_form",
                "target_display_name": "自定义表单",
                "label_en": "custom_form",
                "content": [
                    "表单名称「自定义表单回归测试」",
                    "渠道「默认渠道」"
                ],
                "create_time": "2023-10-31 10:42:59",
                "type": "SCRM",
                "key": 0,
                "contentInfo_detail": [
                    {
                        "entity_display_name": "表单名称",
                        "event_attr_name": "form_name",
                        "entity_attr_value": "11623",
                        "entity_attr_display_name": "自定义表单回归测试"
                    },
                    {
                        "entity_display_name": "渠道",
                        "event_attr_name": "channel",
                        "entity_attr_value": "11623",
                        "entity_attr_display_name": "默认渠道"
                    }
                ]
            },
            {
                "app_id": 6,
                "app_name": "会议",
                "label": "会议浏览",
                "label_display_name": "page_view",
                "target_type": "meeting",
                "target_display_name": "会议",
                "label_en": "meeting",
                "content": [
                    "会议名称「测试审核」",
                    "来源「一级来源:一级来源」「二级来源:测试333」",
                    "会议形式「线下」",
                    "会议分类「auto二级641111」",
                    "渠道「默认渠道」"
                ],
                "create_time": "2023-10-27 10:40:58",
                "type": "SCRM",
                "key": 1,
                "contentInfo_detail": [
                    {
                        "entity_display_name": "会议名称",
                        "event_attr_name": "meeting_name",
                        "entity_attr_value": "84387",
                        "entity_attr_display_name": "测试审核"
                    },
                    {
                        "entity_display_name": "来源",
                        "event_attr_name": "lead_source",
                        "entity_attr_value": "84387",
                        "entity_attr_display_name": "一级来源:一级来源"
                    },
                    {
                        "entity_display_name": "来源",
                        "event_attr_name": "lead_source",
                        "entity_attr_value": "84387",
                        "entity_attr_display_name": "二级来源:测试333"
                    },
                    {
                        "entity_display_name": "会议形式",
                        "event_attr_name": "meeting_form",
                        "entity_attr_value": "84387",
                        "entity_attr_display_name": "线下"
                    },
                    {
                        "entity_display_name": "会议分类",
                        "event_attr_name": "category",
                        "entity_attr_value": "84387",
                        "entity_attr_display_name": "auto二级641111"
                    },
                    {
                        "entity_display_name": "渠道",
                        "event_attr_name": "channel",
                        "entity_attr_value": "84387",
                        "entity_attr_display_name": "默认渠道"
                    }
                ]
            },
            {
                "app_id": 9,
                "app_name": "新-邮件",
                "label": "邮件发送",
                "label_display_name": "email_sent",
                "target_type": "message_email",
                "target_display_name": "邮件新",
                "label_en": "message_email",
                "content": [
                    "任务名称「未命名邮件任务1」",
                    "发件箱「testenv@scrmtech.com」"
                ],
                "create_time": "2023-10-25 14:32:04",
                "type": "renew",
                "key": 2,
                "contentInfo_detail": [
                    {
                        "entity_display_name": "任务名称",
                        "event_attr_name": "task_name",
                        "entity_attr_value": "6471",
                        "entity_attr_display_name": "未命名邮件任务1"
                    },
                    {
                        "entity_display_name": "发件箱",
                        "event_attr_name": "service_id",
                        "entity_attr_value": "6471",
                        "entity_attr_display_name": "testenv@scrmtech.com"
                    }
                ]
            },
            {
                "app_id": 1,
                "app_name": "表单",
                "label": "单页面表单提交",
                "label_display_name": "form_submit",
                "target_type": "alone",
                "target_display_name": "单页面表单",
                "label_en": "alone",
                "content": [
                    "表单名称「T-测试-提交表单阶段推荐和归属」",
                    "是否首次留资「是」"
                ],
                "create_time": "2023-10-25 14:30:32",
                "type": "renew",
                "key": 3,
                "contentInfo_detail": [
                    {
                        "entity_display_name": "表单名称",
                        "event_attr_name": "form_name",
                        "entity_attr_value": "4454",
                        "entity_attr_display_name": "T-测试-提交表单阶段推荐和归属"
                    },
                    {
                        "entity_display_name": "是否首次留资",
                        "event_attr_name": "is_first_submit",
                        "entity_attr_value": "4454",
                        "entity_attr_display_name": "是"
                    }
                ]
            },
            {
                "app_id": 1,
                "app_name": "表单",
                "label": "单页面表单浏览",
                "label_display_name": "page_view",
                "target_type": "alone",
                "target_display_name": "单页面表单",
                "label_en": "alone",
                "content": [
                    "表单名称「T-测试-提交表单阶段推荐和归属」"
                ],
                "create_time": "2023-10-25 14:30:08",
                "type": "renew",
                "key": 4,
                "contentInfo_detail": [
                    {
                        "entity_display_name": "表单名称",
                        "event_attr_name": "form_name",
                        "entity_attr_value": "4454",
                        "entity_attr_display_name": "T-测试-提交表单阶段推荐和归属"
                    }
                ]
            }
        ],
        "total": 5
    }
}
修改于 2024-12-16 08:23:36
上一页
获取线索行为事件
下一页
获取线索分值记录
Built with