1. 默认模块
微伴助手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详情-执行记录
  • 部门管理
    • 获取部门列表
  • 群标签管理
    • 获取群聊标签分组及其子列表
    • 群聊批量打标签
  • 话术库
    • 企业话术分组列表
    • 企业话术列表
  • 企微数据专区
    • 获取会话消息(企微数据专区)
  • 锁客二维码
    • 锁客二维码通过state获取详细信息
    • 根据客户unionid查询客户添加的锁客二维码渠道信息
  • 门店活码
    • 获取门店活码配置列表
    • 获取门店活码下的门店列表
    • 获取门店活码客户记录列表
  • 席位管理
    • 查询席位关系列表
  • LTC 订单与回款
    • 用于将未提交或审批未通过的 LTC 订单重新提交至审批流程首节点
    • 查询订单列表
    • 查询订单详情
    • 查询订单创建字段配置
    • 创建订单
    • 审批通过订单
    • 查询产品列表
默认模块
111
默认模块
111
  1. 默认模块

错误码参考表

业务接口错误码#

全局错误码#

错误码错误说明排查方法
500服务器内部错误(此错误码为目前唯一不是5位数字的错误码)
10001认证错误:请提供正确的access_token ~~~~
10010企业微信api调用错误,具体错误提示和企业微信侧的错误码见errmsg中提示
10041body 参数类型错误。具体错误字段会在 errmsg 中提示
10042缺少必填的 query 或 body 参数。具体缺少的字段会在errmsg中提示
10043列表长度参数(offset)超出查询条目总数(total)
10044列表长度参数(offset)超过最大100000000限制
10045列表长度参数(limit)超过最大限制,具体限见文档对应字段描述
10046列表偏移参数(offset)必须为正数
10047列表长度参数(limit)必须为正数
10048时间参数必须为10位或13位的时间戳
10049请求参数错误,详细信息可以在 errors 中查看
10050资源不存在
10051服务器正忙,请稍后再试
10052并发访问超过限制(详情请查看openapi文档-访问频率限制)
10053api访问超过限制(详情请查看openapi文档-访问频率限制)
10054corp_id受限,详情请联系客服
30001无效的external_user_id
30002不合法的external_user_id列表
30003不合法的external_user_id列表长度查看帮助
错误码:30003#
不合法的external_user_id列表长度。确认:
1)批量获取客户积分接口,最多指定100人。
获取访问凭据
错误码说明
20101secret 或 corp_id 非法
20102未同意Api接口使用条款,禁止使用,请移步微伴后台-API-阅读OpenAPI使用条款-同意使用条款以获取使用权限,详情参考OpenAPI基本介绍
根据加入时间获取客户列表
错误码说明
20201staff_id 错误,找不到对应员工
20202type 不合法
20202order 不合法
获取流失客户列表
错误码说明
20201staff_id 错误,找不到对应员工
20202type 不合法
20202order 不合法
根据信息变更时间获取客户列表
错误码说明
20201order 错误,找不到对应员工
20202staff_id 不合法
20203type 不合法
获取客户详情
错误码说明
20206id 错误,找不到对应客户
20207unionid 错误,找不到对应客户
20208unionid 和 id 必须至少提供一个
获取客户所在群聊
错误码说明
20206id 错误,找不到对应客户
20207unionid 错误,找不到对应客户
20208unionid 和 id 必须至少提供一个
获取群聊详情
错误码说明
20209group_chat_id非法,不存在对应群聊
导入客户信息
错误码说明
20210客户external_user_id错误
20211客户unionid错误
20212请提供客户external_user_id或客户external_user_unionid
20213员工与客户无关联
20214external_user_fields格式有误
20215自定义字段不存在
20216该值内容长度超过500, 请重新修改
20217下拉框的选项值不存在
添加客户评分
错误码说明
20210客户external_user_id错误
20211客户unionid错误
20212请提供客户id或客户unionid
20215score必须为大于0的整数
external_user_id换unionid
错误码说明
20216传入ext_id列表大小超过1000
unionid换external_user_id
错误码说明
20217传入unionid_list列表大小超过1000
获取有赞订单列表
错误码说明
20301unionid 和 userid 必须至少提供一个
给客户添加企业标签
错误码说明
20301请同时提供标签组名称和标签名称
20350external_user_id错误
20351external_user_unionid错误
20352请提供external_user_id或external_user_unionid
20353找不到对应员工
给客户删除企业标签
错误码说明
20301请同时提供标签组名称和标签名称
20350external_user_id错误
20351external_user_unionid错误
20352请提供external_user_id或external_user_unionid
20353找不到对应员工
批量更新客户企业标签
错误码说明
20350add_tag_id_list和rm_tag_id_list不可同时为空
20351最多允许批量添加或删除10个标签
20352客户不存在或没有添加客服
20353批量打标签失败
20354add_tag_id_list中存在非法tag_id:{tag_ext_id},请检查并确保标签合法
20355remove_tag_id_list中存在非法tag_id:{tag_ext_id},请检查并确保标签合法
给客户添加微伴个人标签
错误码说明
20350external_user_id错误
20351external_user_unionid错误
20352请提供external_user_id或external_user_unionid
20353找不到对应员工
删除客户的微伴个人标签
错误码说明
20350external_user_id错误
20351external_user_unionid错误
20352请提供external_user_id或external_user_unionid
20353找不到对应员工
添加预打标签任务
错误码说明
20351type错误
20352请同时提供标签组名称和标签名称
20353任务已存在,task_id为xxx。 task_id为预打标签在系统中的唯一id
批量预打企业标签
错误码说明
20351type错误
删除预打标签任务
错误码说明
20355task_id错误,预打标签任务不存
获取标签列表
错误码说明
20356access_token 不合法
20357limit 不合法
20358offset 不合法
获取员工会话
错误码说明
20401排序字段值错误,请输入"id_asc"或者"last_updated_desc"
20402会话类型错误,请输入"ext_user","room"或"other_staff"
创建自定义客户事件
错误码说明
20601staff_id 错误,找不到对应员工
20602external_user_id 错误
20603external_user_unionid 错误
20604请提供external_user_id或external_user_unionid
20605content 不可为空
20606title 长度超过32个字符限制
20607custom_event_type_id对应事件类型不存在
删除自定义客户事件类型
错误码说明
20607custom_event_type_id对应事件类型不存在
更新自定义客户事件类型
错误码说明
20607custom_event_type_id对应事件类型不存在
20608custom_event_type_name超出8字符长度限制
20609该custom_event_type_name已存在
20610custom_event_type_name不能为空
20611custom_event_type_name不能与微伴基础事件类型重名
获取客户阶段状态
错误码说明
20607external_user_ids不能为空
20608external_user_ids列表长度超过限制(50)
20609未查询到任何客户阶段状态,请检查external_user_id是否合法或客户是否存在客户阶段
添加自定义客户事件类型
错误码说明
20608custom_event_type_name超出8字符长度限制
20609该custom_event_type_name已存在
20610custom_event_type_name不能为空
20611custom_event_type_name不能与微伴基础事件类型重名
20612自定义事件类型和微伴基础事件类型总数不能超过20个
发送员工通知
错误码说明
20701staff_id 错误,找不到对应员工
20702msgtype 不合法
20703content 不可为空
批量创建添加客户任务(原客户信息批量导入接口)
错误码说明
20800参数staff_ids错误,选择分配的员工不存在
20801参数staff_id错误,操作员工不存在
20802每次最多导入1000条客户数据
20803参数customer_detail_list错误
20804参数remark_name错误, 最大长度不能超过64
20805参数phone_number错误,电话号码格式错误
20806没有可以导入的数据,请检查参数customer_detail_list是否为空
20807phone_number为[xxx、xxy] 的客户已存在,其他n个客户导入成功
获取渠道码列表
错误码说明
20901staff_id 错误,找不到对应员工
20902order 不合法
订单信息同步
错误码说明
21001type错误
订单信息删除
错误码说明
21005订单不存在
订单信息批量同步
错误码说明
21006列表长度超过最大限制100
批量新建手机线索转化
错误码说明
21101线索添加失败,请重新添加
21102找不到该员工
21103线索不存在
21104自定义字段不存在
21105手机线索数量超过20的限制
21106时间格式不正确
21107电话号码不合法,不合法包括:(字母、文字、特殊字符)
获取拉新排行榜活动列表
错误码说明
21201获取拉新排行榜失败
新增素材
错误码说明
21301传递过来的标签id重复或不存在
21307参数缺失
21308mtype参数不正确,只能选择("poster", "pdf", "word", "excel", "ppt")
更新素材
错误码说明
21303素材不存在
21301传递过来的标签id重复或不存在
21307参数缺失
21308mtype参数不正确,只能选择("poster", "pdf", "word", "excel", "ppt")
删除素材
错误码说明
21303素材不存在
添加素材库标签
错误码说明
21304添加素材标签条数最多为100条
21305标签长度最大不能超过6
21306标签名重复
获取企微任务宝对应的客户数据列表
错误码说明
21401main_misson_id错误,对应裂变活动不存在
21402任务宝对应的活动id和af_type不匹配
获取企微任务宝任务详情
错误码说明
21408corp_id 错误,找不到对应的企业
21409main_session_id 不合法
21410finished 不合法
21411order 不合法
21412limit 不合法
21413offset 不合法
获取员工个人群发记录结果列表
错误码说明
21501staff_id 错误,找不到对应员工
21502msg_id 错误,找不到对应的群发记录
21503msg_id 不能为空
获取群裂变活动列表
错误码说明
21501corp_id 错误,找不到对应的企业
21502mission_status不合法
21503start_time 不合法
21504end_time 不合法
21505order 不合法
21506limit 不合法
21507offset 不合法
获取群裂变任务详情
错误码说明
21508corp_id 错误,找不到对应的企业
21509main_session_id 不合法
21510finished 不合法
21511order 不合法
21512limit 不合法
21513offset 不合法
获取群裂变客户详情列表
错误码说明
21514群裂变活动不存在
21515获取群列表客户数据详情失败
获取群打卡活动列表
错误码说明
21601corp_id 错误,找不到对应的企业
21602mission_status不合法
21603start_time 不合法
21604end_time 不合法
21605order 不合法
21606limit 不合法
21607offset 不合法
获取群打卡任务详情
错误码说明
21608corp_id 错误,找不到对应的企业
21609act_id 不合法
21610phase 不合法
21611order 不合法
21612limit 不合法
21613offset 不合法
获取雷达列表
错误码说明
21701互动雷达参数校验失败
21702互动雷达查询失败
获取雷达详情
错误码说明
21701互动雷达参数校验失败
21702互动雷达查询失败
添加雷达
错误码说明
21701参数校验失败
21702数据库查询失败
21703操作失败
21704链接解析失败
21705雷达标题已存在
修改雷达
错误码说明
21701参数校验失败
21702数据库查询失败
21703操作执行失败
21704链接解析失败
21705雷达标题已存在
上传file
错误码说明
21800文件上传参数无效
21801文件上传大小超过限制
21802文件上传失败
21803文件读取失败
21804文件保存失败
21805文件上传类型不支持(目前仅支持png,jpg,jpeg,pdf格式)
导入客户信息
错误码说明
21801最多允许批量修改10个自定义字段
21802参数option_id,field_value,field_datetime不能同时为空
21803存在无效的员工或外部联系人
21804存在无效的field_id
21805存在无效的option_id
21806存在外部联系人和员工没有好友关系
21807存在字段类型和传入的参数不正确
21808时间格式不正确
21809缺少参数
21810自定义信息更新失败,请重试
21811field_id为${field_id}的自定义字段不存在
批量修改自定义字段的值
错误码说明
21801最多允许批量修改10个自定义字段
21802参数option_id,field_value,field_datetime不能同时为空
21803存在无效的员工或外部联系人
21804存在无效的field_id
21805存在无效的option_id
21806存在外部联系人和员工没有好友关系
21807存在字段类型和传入的参数不正确
21808时间格式不正确
21809缺少参数
21810自定义信息更新失败,请重试
21811field_id为${field_id}的自定义字段不存在
添加自定义字段
错误码说明
21811字段类型必须为"text"或"option_text"或"datetime"
21812option_text类型必须添加至少一个选项
21813选项条数最多支持100条
21814添加的选项中存在重复的选项名称
21815选项名称长度最多支持15个字符
21816字段名称长度最多支持5个字符
21817当前已存在相同名称的自定义字段
21818字段总数量不能超过50条
21819option_name不能为空
批量预设客户属性
错误码说明
21820员工id错误
21821手机号格式不正确
21822union_id格式不正确
21823生日格式不正确
21824时间格式不正确
21825预设属性最少录入两列
21826无效的field_id
21827自定义字段缺少对应的类型参数
21828field_id和field_name不匹配
21829field_id和option_id不匹配
21830创建预设属性失败
21831缺少必传参数union_id或phone_number
21832value_list长度限制最多50个
自定义表单列表
错误码说明
21901自定义表单参数校验失败
21902自定义表单数据查询失败
自定义表单用户与表单关系列表
错误码说明
21901自定义表单参数校验失败
21902自定义表单数据查询失败
自定义表单提交数据详情列表
错误码说明
21901自定义表单参数校验失败
21902自定义表单数据查询失败
批量增减客户积分
错误码说明
22001批量增加或削减积分参数校验失败
自定义侧边栏身份校验
错误码说明
22101code不存在或已过期
获取商机列表
错误码说明
22201未找到商机记录
获取组织列表
错误码说明
22202未找到组织记录
获取工单的流内处理人
错误码说明
22301order_no非法,对应工单不存在
22306stage非法,工单无此阶段
流转工单
错误码说明
22301order_no非法,对应工单不存在
22302handler_id非法,对应员工不存在
22303cc_list内的id:“LiMei”非法,对应员工不存在
22304staff_id非法,对应员工不存在
22305staff_id对应员工无处理本工单权限
22307工单已关闭,不可操作
关闭工单
错误码说明
22301order_no非法,对应工单不存在
22303cc_list内的id:“LiMei”非法,对应员工不存在
22304staff_id非法,对应员工不存在
22305staff_id对应员工无处理本工单权限
22307工单已关闭,不可操作
评论工单
错误码说明
22301order_no非法,对应工单不存在
22304staff_id非法,对应员工不存在
22305staff_id对应员工无处理本工单权限
22307工单已关闭,不可操作
批量更新客户企业标签
错误码说明
40096企业微信api调用失败,客户id非法,请参~~~~考https://open.work.weixin.qq.com/devtool/query?e=40096
40003企业微信api调用失败,员工id非法,请参考https://open.work.weixin.qq.com/devtool/query?e=40003
40068企业微信api调用失败,标签id非法,请参考https://open.work.weixin.qq.com/devtool/query?e=40068
批量导入线索
错误码说明
22207线索公海不存在
22208staff_id非法,对应员工不存在
修改于 2022-04-14 12:09:11
上一页
OpenAPI基本介绍
下一页
访问频率和并发限制
Built with