卫瓴API文档
  1. 事件回调🚀🚀🚀
卫瓴API文档
  • 对接说明
  • 全局异常码
  • 联系人合并接口迁移说明
  • 一、获取访问凭据
    • 1.1 获取访问凭据
  • 二、通讯录管理
    • 2.1 获取部门列表
    • 2.2 获取员工列表
    • 2.3 获取员工详情
    • 2.4 根据条件获取员工详情
    • 2.5 获取员工ID列表
    • 2.6 批量获取员工信息
  • 三、企微好友管理(⚠️即将废弃)
    • 3.1 获取企微好友列表
    • 3.2 获取企微好友详情
    • 3.4 根据企微external_userid获取企微好友详情
    • 3.5 通过unionid查询卫瓴企微好友ID
    • 3.3 企微好友更新(即将废弃)
    • 3.6 批量获取企微好友详情
  • 四、线索管理(⚠️即将废弃)
    • 4.1 创建手机号线索
    • 4.2 获取手机号线索列表
    • 4.3 获取手机号线索详情
    • 4.4 公海信息查询
    • 4.5 手机号线索转移接口
    • 4.6 手机号线索废弃
    • 4.7 手机号线索更新
    • 4.8 手机号线索退回公海
    • 4.9 手机号线索恢复
  • 五、企业管理🚀🚀🚀
    • 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 获取对象描述接口(将近废弃)
    • 16.1 获取对象描述接口-新版
  • 十七、外呼相关
    • 获取外呼记录详情
  • 十八、个微人脉管理
    • 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. 事件回调🚀🚀🚀

事件回调概述

事件回调说明#

事件回调可以让你的应用及时响应卫瓴里的动作,实现高度整合。只需提供一个接收事件的URL,卫瓴开放平台会在事件发生时,以HTTP POST请求的方式将事件内容以JSON格式推送给你。

事件回调流程#

假设你接收事件回调的URL为 http://open.test.com 需要实现该URL对应的服务并完成事件回调配置。

STEP1.配置回调#

管理员可以在设置-开放平台,创建应用后配置回调地址。
image.png

配置项说明#

Token:用于计算签名,由 16-32 位的英文或数字组成的自定义字符串。
EncodingAESKey:用于消息内容加密,由 43 位的英文或数字组成的自定义字符串。
回调地址URL:回调服务地址,由开发者搭建,用于接收通知消息或事件。

STEP2.回调地址有效性验证#

配置回调信息时,卫瓴会发送一条验证请求,如下:
请求方式:GET
请求地址:http://open.test.com?msg_signature=MS&timestamp=TS&nonce=N&echostr=STR
请求参数说明:
参数类型说明
msg_signatureString消息签名,msg_signature计算结合了企业填写的token、请求中的timestamp、nonce、echostr
timestampString时间戳
nonceString随机数
echostrString加密的字符串
响应参数说明:
1.必须是上面echostr对应的解密明文,卫瓴会根据你返回的解密明文进行验证后才能配置成功

STEP3.接收回调#

配置通过后,当有新事件产生时,卫瓴会发送回调消息到配置的 URL,请求内容如下:
请求方式: POST
请求地址: http://open.test.com?msg_signature=MS&timestamp=TS&nonce=N
请求参数说明:
参数类型说明
msg_signatureString消息签名,msg_signature计算结合了企业填写的token、请求中的timestamp、nonce、请求体中的encrypt_msg
timestampString时间戳
nonceString随机数
响应参数说明:需在 1 秒内返回 success 字符串
修改于 2024-10-31 03:10:18
上一页
20.3 活动报名详情
下一页
回调事件格式
Built with