卫瓴API文档
  1. 十六、对象描述🚀🚀🚀
卫瓴API文档
  • 对接说明
  • 全局异常码
  • 联系人合并接口迁移说明
  • 一、获取访问凭据
    • 1.1 获取访问凭据
      GET
  • 二、通讯录管理
    • 2.1 获取部门列表
      GET
    • 2.2 获取员工列表
      GET
    • 2.3 获取员工详情
      GET
    • 2.4 根据条件获取员工详情
      POST
    • 2.5 获取员工ID列表
      GET
    • 2.6 批量获取员工信息
      GET
  • 三、企微好友管理（⚠️即将废弃）
    • 3.1 获取企微好友列表
      GET
    • 3.2 获取企微好友详情
      GET
    • 3.4 根据企微external_userid获取企微好友详情
      GET
    • 3.5 通过unionid查询卫瓴企微好友ID
      GET
    • 3.3 企微好友更新（即将废弃）
      POST
    • 3.6 批量获取企微好友详情
      POST
  • 四、线索管理（⚠️即将废弃）
    • 4.1 创建手机号线索
      POST
    • 4.2 获取手机号线索列表
      GET
    • 4.3 获取手机号线索详情
      POST
    • 4.4 公海信息查询
      GET
    • 4.5 手机号线索转移接口
      POST
    • 4.6 手机号线索废弃
      POST
    • 4.7 手机号线索更新
      POST
    • 4.8 手机号线索退回公海
      POST
    • 4.9 手机号线索恢复
      POST
  • 五、企业管理🚀🚀🚀
    • 5.1 获取企业列表（即将废弃）
    • 5.1 获取企业列表-新版
    • 5.2 获取企业详情
    • 5.2 获取企业详情-新版
    • 5.3 企业归属人变更
    • 5.4 创建企业
    • 5.5 企业更新
    • 5.6 添加企业外部相关人（即将废弃）
    • 5.6 企业外部相关人添加-新版
    • 5.7 移除企业外部相关人（即将废弃）
    • 5.7 企业外部相关人移除-新版
    • 5.8 添加企业内部协作人
    • 5.9 移除企业内部协作人
    • 5.10 企业公海信息查询
    • 5.11 批量获取企业详情（即将废弃）
    • 5.11 批量获取企业详情-新版
  • 六、智能码
    • 6.1 创建智能码
  • 七、三方ID转换
    • 7.1 三方ID查询卫瓴ID
    • 7.2 新增三方ID
    • 7.3 卫瓴ID查询三方ID
  • 八、跟进记录🚀🚀🚀
    • 8.1 跟进记录创建（即将废弃）
    • 8.2 跟进记录创建-新版
    • 8.2 跟进记录查询（即将废弃）
    • 8.2 跟进记录查询-新版
    • 8.3 跟进记录废弃
    • 8.4 跟进记录ID查询记录
  • 九、旅程动态🚀🚀🚀
    • 获取动态-(history_type)类型枚举
    • 9.1 创建旅程（即将废弃）
    • 9.1 创建旅程-新版
    • 9.2 获取动态（即将废弃）
    • 9.2 旅程查询-新版
  • 十、商机🚀🚀🚀
    • 10.1 获取商机详情（即将废弃）
    • 10.1 商机详情-新版
    • 10.2 商机阶段查询
    • 10.3 商机创建（即将废弃）
    • 10.3 商机新增-新版
    • 10.4 商机更新
    • 10.5 商机变更归属人
    • 10.6 商机作废
    • 10.7 商机外部对接人更新(即将废弃)
    • 10.7 商机外部相关人更新-新版
    • 10.8 商机内部协作人更新
    • 10.9 商机流程&阶段查询
  • 十一、资料库
    • 11.1 资料库获取
    • 11.2 资料访问明细
    • 11.3 微信访客详情
  • 十二、标签管理🚀🚀🚀
    • 12.1 标签库查询
    • 12.2 对象标签更新（即将废弃）
    • 12.2 对象标签更新-新版
    • 12.3 通过标签id查询对象（即将废弃）
    • 12.3 通过标签id查询对象-新版
  • 十三、营销组件
    • 13.1 营销组件获客信息查询
    • 13.2 获取员工的营销组件列表
    • 13.3 表单信息查询
  • 十四、消息推送
    • 14.1 发送企微小微通知
  • 十五、群相关
    • 15.1 获取群列表接口
    • 15.2 获取群详情接口
    • 15.3 群更新接口
  • 十六、对象描述🚀🚀🚀
    • 16.1 获取对象描述接口（将近废弃）
      GET
    • 16.1 获取对象描述接口-新版
      GET
  • 十七、外呼相关
    • 获取外呼记录详情
  • 十八、个微人脉管理
    • 18.1 获取个微人脉列表
    • 18.2 查询个微人脉详情
  • 十九、联系人🚀🚀🚀
    • 19.1 联系人单条创建
    • 19.2 批量获取联系人详情
    • 19.3 联系人查询
    • 19.4 联系人编辑
    • 19.5 联系人转移
    • 19.6 联系人废弃
    • 19.7 联系人恢复
    • 19.8 联系人退回公海
    • 19.9 公海查询
    • 19.10 根据联络方式查询联系人
  • 二十、活动管理
    • 20.1 活动列表
    • 20.2 活动详情
    • 20.3 活动报名详情
  • 事件回调🚀🚀🚀
    • 事件回调概述
    • 回调事件格式
    • 服务示例
    • 解密示例
    • 回调事件类型目录
    • 联系人新增事件🚀
    • 联系人更新事件🚀
    • 手机号线索新增事件
    • 手机号线索更新事件
    • 手机号线索动态新增事件
    • 企业新增事件（即将废弃）
    • 企业新增事件-新版🚀
    • 企业更新事件-新版🚀
    • 企业更新事件（即将废弃）
    • 企业删除事件
    • 企业归属人变更事件
    • 添加企业相关人事件
    • 新版添加企业外部相关人事件
    • 商机新增事件
    • 商机更新事件
    • 商机作废事件
    • 群新增事件
    • 群更新事件
    • 群解散事件
    • 员工新增事件
    • 员工更新事件
    • 部门新增事件
    • 添加企微好友事件
    • 企微好友更新事件
    • 企微好友动态新增事件
    • 跟进记录新增
    • 资料新增事件
    • 对象标签更新事件（即将废弃）
    • 对象标签更新事件-新版🚀
    • 发送客户朋友圈事件
  1. 十六、对象描述🚀🚀🚀

16.1 获取对象描述接口（将近废弃）

GET
https://openapi.weiling.cn/openapi/obj/{api_key}/description

请求参数

Path 参数
api_key
string 
必需
线索-clue；商机-business；企微好友-external_user; 企业-company; 群聊-dialogue_room
Query 参数
access_token
string 
必需

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://openapi.weiling.cn/openapi/obj//description?access_token'

返回响应

🟢200成功
application/json
Body
msg
string 
返回结果信息
必需
code
integer 
必需
返回结果码值-0:请求成功 500 系统错误
data
object 
必需
api_key
string 
必需
fields
array [object {9}] 
字段属性列表
必需
示例
{
    "msg": "string",
    "code": 0,
    "data": {
        "api_key": "string",
        "fields": [
            {
                "api_name": "string",
                "view_name": "string",
                "property_type": "string",
                "required": true,
                "enabled": true,
                "property_source": 0,
                "options": [
                    {
                        "label": "string",
                        "value": "string"
                    }
                ],
                "min_length": "string",
                "max_length": "string"
            }
        ]
    }
}
修改于 2025-01-15 05:49:18
上一页
15.3 群更新接口
下一页
16.1 获取对象描述接口-新版
Built with