微伴助手OpenAPI
    微伴助手OpenAPI
    • OpenAPI基本介绍
    • 错误码参考表
    • 访问频率和并发限制
    • 消息订阅
      • 订阅消息加解密指南
      • 回调应用配置指南
      • 工单变更消息
        • 工单变更消息回调
        • 创建工单回调
        • 流转工单回调
        • 关闭工单回调
        • 重新打开工单回调
        • 评论工单回调
    • 获取访问凭据
      • 获取访问凭据
        POST
    • 员工管理
      • 获取员工列表
        GET
      • 获取员工详情
        GET
      • 发送员工通知
        POST
    • 自定义订单管理
      • 订单信息删除
        GET
      • 获取订单信息列表
        GET
      • 批量同步店铺信息
        POST
      • 批量同步商品信息
        POST
      • 批量同步订单信息v2
        POST
      • 批量删除商品信息
        POST
      • 删除店铺信息
        GET
      • 批量删除订单信息
        POST
      • 获取店铺信息详情
        POST
      • 获取店铺信息列表
        GET
      • 获取商品信息详情
        POST
      • 获取商品信息列表
        GET
    • 客户管理
      • 获取客户列表
        GET
      • 根据更新时间获取客户列表
        GET
      • 获取客户详情
        GET
      • 获取流失提醒客户列表
        GET
      • 导入客户信息
        POST
      • 添加客户评分
        POST
      • 添加自定义字段
        POST
      • 批量预设客户属性
        POST
      • 批量修改自定义字段的值
        POST
      • 创建批量加好友任务(批量创建添加客户任务)
        POST
      • 批量unionid&openid换external_user_id
        POST
      • external_user_id换unionid
        POST
      • unionid&openid换客户id
        POST
      • 获取客户自定义字段值列表
        GET
      • 批量获取客户详情
        POST
      • 获取批量加好友待添加列表
        GET
    • 客户积分管理
      • 批量增减客户积分
      • 批量获取客户积分
      • 获取单个客户积分明细记录
      • 获取全部客户积分明细记录
    • 客户标签管理
      • 获取标签列表
      • 批量更新客户企业标签
      • 给客户添加企业标签
      • 删除客户的企业标签
      • 给客户添加微伴个人标签
      • 删除客户的微伴个人标签
      • 获取预打标签信息
      • 批量预打企业标签
      • 根据手机号删除预打标签任务
      • 根据unionid删除预打标签任务
      • 获取指定用户预打标签任务详情
      • 获取预打标签任务列表
      • 添加预打标签任务
    • 客户画像管理
      • 获取客户事件列表
      • 创建自定义客户事件
      • 获取自定义客户事件类型列表
      • 获取自定义客户事件类型详情
      • 添加自定义客户事件类型
      • 删除自定义客户事件类型
      • 更新自定义客户事件类型
      • 获取客户阶段状态
    • 标签库管理
      • 获取标签列表V2
      • 获取指定标签信息
      • 新增企业标签组
      • 新增企业标签
      • 删除企业标签
      • 更新企业标签
      • 同步企业微信标签
    • 群聊管理
      • 获取群聊列表
      • 获取群聊成员列表
      • 获取客户所在群聊
      • 查看客户是否在群聊中
      • 获取群聊详情
    • 工单管理
      • 工单模块OpenAPI开发必读
      • 获取工单列表
      • 获取工单详情
      • 获取工单流内处理人
      • 获取工单模板列表
      • 获取工单模板详情
      • 新建工单
      • 修改工单
      • 流转工单
      • 评论工单
      • 关闭工单
    • 销售过程管理
      • 获取商机列表
      • 获取商机详情
      • 修改商机阶段
      • 获取线索公海列表
      • 批量导入线索
      • 修改线索
      • 获取线索列表
      • 员工单条/批量领取线索
      • 获取线索客户列表
    • 聊天记录管理
      • 获取会话消息
      • 获取会话消息2(按照消息时间逆序)
      • 获取员工会话
    • 拉新排行榜
      • 获取拉新排行榜列表
    • 群裂变
      • 获取群裂变活动列表
      • 获取群裂变任务详情
      • 获取群裂变客户详情列表
    • 群打卡
      • 获取群打卡活动列表
      • 获取群打卡任务详情
    • 企微任务宝
      • 获取企微任务宝活动列表
      • 获取企微任务宝任务详情
      • 获取企微任务宝对应的客户数据列表
      • 获取客户对应的企微任务宝数据列表
    • 拉新排行榜
      • 获取拉新排行榜活动列表
    • 自定义表单
      • 获取自定义表单列表
      • 自定义表单用户与表单关系列表
      • 自定义表单提交数据详情列表
      • 获取自定义表单分组列表
    • 客户转化
      • 批量新增手机线索转化
    • 员工个人群发记录管理
      • 获取员工个人群发记录列表
      • 获取员工个人群发记录结果列表
    • 渠道码管理
      • 获取渠道码列表
      • 获取渠道码加人数据
    • 素材库管理
      • 获取素材库列表
      • 获取素材库标签列表
      • 新增素材
      • 更新素材
      • 删除素材
      • 新建素材分组
      • 修改素材分组
      • 添加素材库标签
      • 删除素材库标签
      • 删除素材分组
      • 素材分组列表
    • 互动雷达管理
      • 获取雷达列表
      • 获取雷达详情
      • 添加雷达
      • 修改雷达
      • 删除雷达
      • 上传file
      • 获取雷达分组列表
      • 获取雷达客户访问记录
    • 自定义侧边栏身份校验
      • 侧边栏模块化-自定义卡片功能说明
      • 自定义侧边栏Code校验
    • 有赞订单管理
      • 获取有赞订单
      • 获取有赞订单列表
    • 小鹅通订单管理
      • 获取小鹅通TOKEN
    • 项目管理
      • 项目列表
    • 门店信息
      • 批量导入门店
      • 批量更新门店
      • 门店列表
    • 人群包
      • 人群包列表获取
      • 创建人群包
      • 更新人群包
      • 创建的人群包中添加数据
      • 获取人群包数据详情
    • 客户群发
      • 客户群发创建
      • 群发任务列表
      • 群群发详情获取
      • 员工群发结果
      • 客户群群发创建
      • 员工-群群发结果
      • 获取群发错误unionid/extid
    • 企微朋友圈
      • 企微朋友圈创建
      • 企微朋友圈任务列表
      • 企微朋友圈任务发表详情
    • 个人SOP
      • 个人SOP列表
      • 个人SOP详情-规则列表
      • 个人SOP详情-执行记录
    • 部门管理
      • 获取部门列表
    • 群标签管理
      • 获取群聊标签分组及其子列表
      • 群聊批量打标签
    • 话术库
      • 企业话术分组列表
      • 企业话术列表
    • 企微数据专区
      • 获取会话消息(企微数据专区)

    OpenAPI基本介绍

    微伴助手开放接口对接文档#

    version: 0.4
    注1:微伴助手开放接口已经开放公测,进入微伴后台-应用中心-开放平台接入以获取企业标识(corp_id) ,企业API调用凭据(secret)
    注2:系统内所有的时间相关字段如果没有特别说明都是以 秒 为单位。
    注3:目前open api并未提供测试模式,请研发调用的时候注意,测试完成的时候及时删除测试数据。

    阅读说明#

    微伴助手通过开放接口(Open API)为接入企业提供进一步集成和个性化定制的能力。
    所有接口都使用 HTTPS 协议,JSON 数据格式和 UTF-8 编码。
    接口使用 GET 和 POST 两种操作,其他类型操作(如 PUT)皆不会用到。
    GET 类型操作中可能需要 query参数。
    说明: query参数是放入url中的参数,例如 API https://open.weibanzhushou.com/some_api 在添加 query 参数 access_token 和 id 后完整请求为:
    https://open.weibanzhushou.com/some_api?access_token=xxx&id=xxx
    另外,POST 类型操作中除了 query参数 外还可能需要提供 body参数。具体会在相应业务 API 文档中介绍。
    请求返回值中总是包含 errcode 和 errmsg 字段,称为基础返回字段。用于描述请求的成功状态,其定义如下:
    字段类型说明
    errcodeint状态码,0为正常,非0代表错误。错误码见下文说明
    errmsgstr错误信息,成功时为'ok',错误时会以中文方式显示错误原因
    样例:
    // 正确样例
    {
      "errcode": 0,
      "errmsg": "ok"
    }
    // 错误样例
    {
      "errcode": 10001,
      "errmsg": "认证错误:请提供正确的access_token"
    }
    错误码绝大多数情况为五位数字(例如10001),其中以「1」开头的为 全局错误码 ,以「2」开头的为 业务错误码。
    全局错误码定义见:全局错误码。
    业务错误码则会在各个接口对应文档中说明。
    注:业务错误码也是全局唯一的。

    接入准备#

    1.
    进入微伴后台-应用管理-API接入以获取企业标识(corp_id) ,企业API调用凭据(secret),如图所示。
    image.png
    首先 您将会在界面上看到企业的corp_id,这是调用接口的重要凭据之一。
    点击创建secret,您将会看到OpenAPI使用声明。您需要仔细阅读并确认知晓OpenAPI的secret泄露可能造成的风险,若您同意使用声明的内容,请点击同意,若不同意,则无法使用OpenAPI。
    approve
    同意后将会弹出创建secret窗口。
    image-20210827213726765
    点击确定后,会为您展示OpenAPI的secret,请妥善保管。
    image-20210827213726765
    2.
    利用以上操作获取的corp_id和secret来获取 API 调用凭据(access_token),见:获取访问凭据。

    重新获取secret#

    由于微伴不再保存OpenAPI的secret信息,若您不慎遗失了secret,您需要到微伴后台重新获取secret。

    使用条款#

    如果您之前没有同意OpenAPI的使用说明,您将会看到OpenAPI的使用说明。
    image-20210827213726765
    如您需要继续使用OpenAPI的服务,需要仔细阅读并确认知晓OpenAPI的secret泄露可能造成的风险,若您同意使用声明的内容,请点击同意,若不同意,您的access_token将会失效,且无法使用OpenAPI的相关功能。
    同意之后您可以选择重新获取新的secret。
    image-20210827213726765

    与企业微信API的差异#

    由于微伴开放接口在数据接口和功能上与企业微信API有较多重合,因此在设计时充分考虑了熟悉企业微信文档的接入者现有的使用习惯。
    然而,由于在系统设计、数据结构和功能上并非完全一致,在具体 API 的路径、概念名称、参数和返回值数据结构等地方存在与企业微信不一致的地方,希望开发者注意其中的差异。
    需要特别注意的差异:
    1.
    员工概念的差异:微伴系统中员工对应 staff,而企业微信中员工对应 user。微伴系统内的 staff_id 皆对应企业微信成员管理API 中的 userid 字段。此字段在企业微信后台也可以查看到。
    2.
    个人标签的差异:由于企业微信并未开放操作企业微信中员工个人标签的能力,微伴系统中的个人标签是仅在微伴系统内维护的标签,并不会同步到企业微信。
    下一页
    错误码参考表
    Built with