探马OpenAPI
  1. 开发指南
探马OpenAPI
  • 开发指南
    • 开发前必读
    • 对接地址说明
    • 调用说明
    • 接口鉴权说明
    • 对接测试
      POST
  • 基础接口
    • 获取客户id
      POST
    • 获取员工id
      POST
    • 自动开启探马账号及绑定互通账号
      POST
    • 代开发应用id明文转密文
      POST
  • 客户设置
    • 查询企业字段
      POST
    • 查询客户字段
      POST
    • 按时间段消除积分(已废弃)
      POST
  • 消息推送
    • 概述
    • 消息推送数据格式
    • 消息推送类型
      • 推送地址注册回调推送
      • 企微客户新增推送
      • 企微客户修改推送
      • 企微客户删除消息推送
      • 企微客户跟进数据变更推送
      • 积分/评分变更消息推送
      • 客户
        • 新增探马客户推送
        • 修改探马客户推送
        • 删除探马客户推送
        • 新增客户联系人消息推送
        • 编辑客户联系人消息推送
        • 删除客户联系人消息推送
      • 订单
        • 新增探马订单推送
        • 修改探马订单推送
      • 标签
        • 客户标签变更推送
        • 企微标签变更推送
        • 内容标签变更推送
        • 企微个人标签变更推送
      • 合同
        • 合同变更推送
      • 商机
        • 客户商机变更推送
      • 企业
        • 企业信息变更推送
        • 推送字段映射
        • 查询已映射的推送字段
      • 通话记录
        • 通话记录推送
      • 跟进记录
        • 写跟进记录推送
    • 推送注册接口
      POST
  • 客户&线索&待分配
    • 客户查询
      • 高级筛选接口(新版)
      • 查询没有群聊的客户
      • 客户高级筛选接口
    • 客户导入
      • 对接前必读
      • 字段映射
        • 客户字段映射
      • 个人线索导入
      • 个人待分配客户导入
      • 个人客户导入
      • 企业线索导入
      • 企业待分配客户导入
      • 企业客户导入
    • 客户
      • 客户数据
        • 必读说明
        • 字段映射
          • 列出客户数据字段列表
          • 映射外部CRM客户数据字段
        • 客户详情
          • 按企微客户id获取详情
          • 按新增时间查询企微客户数据
          • 按详情字段更新时间查询企微客户数据
        • 客户标签
          • 列出企微客户企业标签树
          • 按企微客户id列出客户企业标签(批量)
          • 更新企微客户企业标签
        • 客户跟进
          • 获取指定企微客户的跟进数据
          • 创建企微客户的跟进
          • 删除企微客户的跟进
          • 查询客户跟进记录
        • 客户通话
          • 查询电销手机通话记录
        • 客户文件
          • 客户文件查询接口
          • 客户文件上传
      • 客户聊天
        • 基于时间段内聊天数统计
      • 已跟进客户数据
        • 列出销售跟进的客户
        • 按跟进关系创建时间升序列出已跟进的客户
        • 按跟进关系字段更新时间升序列出已跟进的客户
        • 更新已跟进客户昵称
        • 更新已跟进客户头像
        • 更新已跟进客户备注名
        • 更新已跟进客户字段
        • 更新已跟进客户标签
        • 列出指定客户跟进内容
        • 写客户跟进
        • 跟进记录批量导入
    • 线索&待分配
      • 按创建时间列出线索&待分配客户
      • 按更新时间列出线索&待分配客户
      • 获取线索&待分配客户详情
      • 更新线索&待分配客户字段
      • 编辑 线索&待分配客户 标签
      • 列出指定线索&待分配客户跟进内容
      • 写线索&待分配客户跟进
    • 商机
      • 查询商机配置
      • 获取商机列表
      • 创建客户商机
      • 修改客户商机
      • 查询客户商机
      • 获取客户商机详情
      • 获取探马商品列表
    • 个人客户转企业客户
      • 个人客户转企业客户
    • 企业客户联系人
      • 接口须知
      • 查询联系人
      • 创建联系人
      • 修改联系人
      • 删除联系人
    • 客户旅程
      • 查询旅程
    • 客户操作
      • 修改客户
      • 合并客户
      • 转移客户
      • 变更跟进人
      • 更新企微客户详情(批量)
      • 修改客户积分
      • 添加协作人
    • 按企微员工id列出企微好友客户详情
      POST
  • 公海
    • 接口调用须知
    • 公海客户高级筛选列表
    • 公海-转出记录列表
    • 列出客户数据字段列表
    • 列出企业字段列表
    • 查询公海客户库
    • 公海-个人客户批量导入
    • 公海-企业客户批量导入
    • 公海-个人客户批量更新
    • 公海-企业客户批量更新
    • 查询公海销售对应客户的联系人信息
    • 查询错误信息
  • 企微组织架构
    • 对接前必读
    • 员工
      • 创建员工
      • 更新员工
      • 读取员工
      • 启用/禁用员工
      • 探马后台登录权限
      • 删除员工
    • 部门
      • 创建部门
      • 编辑部门
      • 获取部门信息
    • 获取组织架构信息
  • 企微标签库
    • 标签树
    • 编辑标签组
    • 删除标签组
    • 添加标签
    • 编辑标签
    • 删除标签
  • 企业
    • 获取企业信息
    • 创建企业
  • 合同
    • 必读说明
    • 保存合同字段映射
    • 获取合同和回款单自定义字段
    • 查询配置的合同映射字段
    • 查询回款单列表
    • 合同扩展字段
    • 新建合同
    • 修改合同
    • 查询销售所有部门
    • 查询客户合同关联订单
    • 查询指定客户合同信息
    • 作废/删除合同
    • 查询合同列表
    • 获取合同详情
  • 电商平台
    • 商城
      • H5商城
        • 概述
        • 注册商城
        • 导入商城商品类别
        • 导入商城商品
    • 订单
      • 概述
      • 第三方订单
        • 获取订单自定义字段
        • 自定义字段映射
        • 查询订单列表
        • 查询订单详情
        • 创建/更新订单
        • 批量创建/更新订单
        • 批量创建/更新订单结果查询接口
      • 探马订单
        • 查询探马商城订单详情
        • 查询探马商城订单列表
        • 获取探马商城订单自定义字段
        • 修改探马商城订单状态
  • 营销
    • 营销内容
      • 表单
        • 获取表单收集明细
      • 自定义
        • 创建自定义内容
        • 更新自定义内容
        • 删除自定义内容
        • 获取自定义内容详情
        • 营销内容标签查询
      • 获取营销内容分类
      • 获取营销内容及明细
      • 获取营销内容-内容标签
      • 获取营销内容-员工分享明细
    • 企微获客
      • 获取企微获客所有表单
      • 获取兑换码手机号
    • 渠道活码
      • 获取渠道活码分组-按部门查询
      • 渠道活码创建接口
      • 渠道活码更新接口
      • 获取渠道活码详情
      • 获取渠道活码分组
      • 获取渠道活码列表
      • 获取渠道活码分析数据
    • 渠道活码 Copy
      • 获取渠道活码分组-按部门查询
      • 渠道活码创建接口
      • 渠道活码更新接口
      • 获取渠道活码详情
      • 获取渠道活码分组
      • 获取渠道活码列表
      • 获取渠道活码分析数据
    • 一客一码
      • 批量删除
      • 查询/创建接口
    • 问答库
      • 层级展示分组
      • 创建问答库分组
      • 编辑分组
      • 删除分组
      • 新建问答
      • 删除问答
      • 编辑问答
      • 问答详情
      • 编辑关键词
      • 删除关键词
      • 新建关键词
      • 查询公司下所有关键词
      • 文件上传
    • 获客活动
      • 获取获客活动参与记录
  • 数据统计
    • 获取微信跟进统计数据明细
    • 获取内容营销员工统计数据明细
  • 内容访客
    • 按内容访问时间列出访客事件信息
  • 电销手机
    • 一键拨号
  • SOP任务
    • 接口说明
    • 客户SOP
      • 客户SOP-群发活动SOP
      • 客户SOP-定期提醒SOP
      • 客户SOP-新增好友SOP
      • 客户SOP-群发助手SOP
      • 创建添加客户任务(分配线索/待分配客户)
    • 群SOP
      • 创建手动发送SOP
      • 创建群发助手SOP
      • 创建群群发任务
      • 创建客户群发任务
    • 跟进客户SOP
      • 跟进客户任务-客户跟进
    • 朋友圈运营
      • 朋友圈任务执行详情
      • 创建朋友圈任务
      • 删除/中止朋友圈任务
      • 查询朋友圈列表
      • 查询朋友圈列表(边城体育)
    • 客户群群发
      • 客户群群发任务执行详情
      • 客户群群发任务列表
    • 客户群发
      • 群发任务执行详情
      • 客户群发任务列表
    • 分页查询员工信息
    • SOP任务-查询销售跟进客户关系
    • 查询标签树
    • 查询营销内容明细数据
    • 查询SOP任务中所需客户字段
    • 查询群列表
    • 查询群标签列表
    • SOP素材上传接口
    • 获取群成员列表
  • 群发消息
    • 创建客户群发消息
    • 上传文件
  • 管控
    • 敏感动作
      • 敏感动作列表接口
  • 工单
    • 工单列表
    • 工单详情
    • 模板列表
    • 创建工单
  • 素材
    • 文件上传
  • 应用通知
    • 应用通知
  • 附录
    • 全局参考文档
    • 前端SDK文档
  • 群数据
    • 群画像
    • 更新群字段
  • 店主活码
    • 店主活码state转换活码名接口
  • 通话列表
    • 语音和通话转文本api
  1. 开发指南

调用说明

请求体#

本文档接口均使用HTTP POST 方式调用,调用参数格式统一为 JSON (Content-Type: application/json),UTF8编码,数据包含转义字符请转义后处理。
在 HTTP Header 中提供认证参数,接口鉴权说明。
示例:
POST https://{{tanma_api_host}}/api/v3/echo
appId: tanma_appid
timestamp: 1594983470133
sign: aaa5c3da2e2ee077454ab3206475b87d11b5de2d645b318b8a45aa1fb6712927
Content-Type: application/json;charset=UTF-8

{"hello":"tanmarket"}

响应体#

响应内容统一为使用 UTF8 编码。
响应格式为 JSON,且有统一的外层结构。
字段类型非空说明
codeint非空[业务状态码](doc-484339)
messagestring可空结果说明
data-可空接口响应数据。类型、是否非空由各接口分别说明
示例:
{
  "code": 0,
  "message": "success",
  "data": {}
}
上一页
对接地址说明
下一页
接口鉴权说明
Built with