小鹅通 · 云服务 API
首页
解决方案
  • 开放API
  • APP开店
文档中心应用市场控制台
首页
解决方案
  • 开放API
  • APP开店
文档中心应用市场控制台
  1. 旧版指南
  • 开发前必读
    • 小鹅云介绍
    • 更新日志
    • 开始开发
    • 小鹅通开放API开发交流群
  • 开发指南
    • 创建并授权应用
    • 获取access_token(含代码示例)
    • 开通接口权限
    • 全局返回码
    • 常用工具
      • 日志排查工具
  • 场景方案
    • 同步用户场景
    • 同步商品场景
    • 同步订购关系场景
    • 同步积分场景
    • 同步页面统计场景
    • 同步学习数据场景
    • 同步推广员场景
  • 内嵌SDK服务场景
    • 产品简介
    • 小鹅通SDK开发者声明
    • 小鹅通SDK个人信息保护政策
    • 开发指南
    • Android-SDK 接入
    • iOS-SDK 接入
    • H5直接嵌入
    • SDK&H5账号详解
    • 常见问题
    • 原生SDK登录态
      • 先决条件
      • 登录接口
      • 登出接口
  • 消息推送
    • 使用说明
    • 消息加/解密
    • 消息接收URL校验说明
    • 账号合并推送
    • 用户手机号变更推送
    • 用户状态变更推送
    • 用户注册推送
    • 商品变更推送
    • 订单支付推送
    • 订单状态变更推送
    • 优惠券消息推送
    • 信息采集推送
    • 积分变更推送
    • 考试消息推送
    • 活动签到推送
  • API列表
    • 用户管理
      • 使用说明
      • 注册新用户
      • 更新用户信息
      • 获取用户列表2.0
      • 获取用户列表1.0.0
      • 查询单个用户信息
      • 批量查询获取用户信息
      • 获取用户消费信息
      • 获取课程学员列表
      • 查询单个用户标签列表
      • 查询用户合并记录
      • 获取标签列表
      • 添加/修改标签
      • 添加/修改用户标签
    • 学习数据管理
      • 获取学习记录列表
      • 获取每日学习记录
      • 获取指定资源学习记录信息
      • 获取营期下用户的学习情况
    • 直播管理
      • 获取直播列表
      • 获取班课列表接口
      • 获取签到列表
      • 获取签到学员列表
      • 获取直播红包列表
      • 获取红包领取记录
      • 获取直播数据概览
      • 获取直播详情
      • 获取红包数据概况
    • 商品管理
      • 查询商品列表2.0
      • 查询商品列表1.0
      • 拉取组合课的资源列表4.0
      • 拉取组合课的资源列表3.0
      • 获取训练营营期任务
      • 商品详情2.0
      • 商品详情1.0
      • 获取直播带货商品列表
      • 商品增加库存
      • 商品减少库存
      • 新建实物商品
      • 编辑实物商品
      • 删除实物商品
      • 获取实物商品列表
      • 获取C端搜索商品列表
    • 商品分组管理
      • 获取店铺商品分组列表
      • 获取商品分组内商品列表
      • 批量新建/更新商品分组
      • 删除商品分组
    • 素材管理
      • 获取素材列表
      • 获取素材分组列表
      • 素材分组编辑
      • 素材分组移动
      • 素材分组删除
    • 订单管理
      • 获取订单列表1.1
      • 获取订单列表1.0
      • 查询用户订单列表
      • 获取订单详情
    • 订购管理
      • 用户开通产品包权益
      • 查询用户订购资源列表
      • 用户购买关系查询
      • 查询用户资源权益2.0
      • 查询用户资源权益1.0
      • 取消订购
    • 物流管理
      • 普通实物单发货
    • 推广员管理
      • 查询推广员列表
      • 查询推广员客户列表
      • 查询推广员的下级推广员列表
      • 查询指定推广员的信息
      • 查询客户所属推广员
      • 新增推广员
      • 推广员绑定客户
      • 修改/解除绑定关系
      • 设置推广员上级
      • 推广订单详情
      • 按日期查询推广员的收益和新增加的下级
      • 推广订单详情(支持购物车订单返回多条记录)
    • 信息采集管理
      • 获取信息采集列表
      • 获取单个信息采集结果
      • 获取用户信息采集结果
      • 根据表单ID以及用户ID获取信息采集结果
    • 营销码卷管理
      • 优惠券列表
      • 获取优惠券详情2.0
      • 获取优惠券详情
      • 获取优惠券领券用户
      • 发放优惠券2.0
      • 发放优惠券
      • 优惠券核销
      • 获取优惠码列表
      • 获取优惠码码库列表
      • 获取优惠码效果数据
      • 创建优惠码
      • 优惠码添加库存
      • 优惠码失效
      • 编辑优惠码
      • 优惠码删除
      • 获取兑换码码库列表
      • 追加兑换码库存
      • 创建兑换码
      • 编辑兑换码
      • 兑换码失效
      • 用户使用兑换码
      • 获取兑换码批次列表
    • 积分管理
      • 业务类型说明
      • 查询用户积分日志
      • 获取单个用户积分信息
      • 批量获取用户积分列表
      • 获取店铺积分信息
      • 批量发放积分
      • 批量扣减积分
      • 解冻冻结积分
      • 设置店铺积分过期时间
    • 页面统计管理
      • 新建页面统计
      • 编辑页面统计
      • 获取页面统计列表
      • 获取页面统计详情
      • 获取页面统计订单列表
      • 新建投放渠道
      • 获取投放渠道列表
    • 打卡管理
      • 获取打卡列表
      • 获取打卡参与用户
      • 获取指定学员活动日记列表
      • 获取活动点赞列表
      • 获取指定学员被点赞总数和列表
      • 获取用户日记被点评/评论列表
    • 社群管理
      • 获取用户参与的小社群
    • 考试管理
      • 获取考试列表
      • 获取考试详情
      • 获取考试结果列表信息
      • 获取考试结果详细信息
    • 活动管理
      • 获取活动列表
      • 获取签到列表
      • 获取活动报名列表
      • 获取活动签到信息
    • 组织管理
      • 获取员工列表
      • 获取员工详细信息
      • 添加或者保存员工信息
      • 启用员工
      • 停用员工
      • 删除员工
      • 根据员工账号获取用户ID
      • 获取组织结构树
      • 添加或修改组织架构
      • 移除组织架构
    • 微页面管理
      • 获取微页面列表
    • 企学院专用
      • 学员管理
        • 企学院获取学员列表
        • 企学院添加学员
        • 企学院修改学员
        • 企学院删除学员
        • 企学院添加组织架构
        • 企学院删除组织架构
        • 企学院编辑组织架构
        • 企学院获取组织架构
        • 企学院获取部门信息
      • 活动管理
        • 企学院用户签到活动列表
      • 培训计划管理(限企学院)
        • 获取培训计划列表
        • 获取培训计划详情
        • 获取用户培训学习数据
        • 获取员工的培训计划列表
  • 旧版API
    • 使用须知
    • 旧版指南
      • 签名和请求
      • Xiaoe SDK使用简介
      • 状态码和常见问题
    • 用户
      • 用户注册
      • 用户信息修改
      • 获取用户信息
    • 支付
      • 下单
      • 更新订单状态
    • 订单
      • 订单查询1.0
      • 订单查询2.0
    • 订购
      • 订阅列表查询
      • 订阅用户列表查询
      • 取消订阅
  • 常见问题
    • 问题汇总
    • 问题反馈
  1. 旧版指南

状态码和常见问题

常见状态码#

接口返回的数据按照下列方式组织,正常情况下状态码为0;签名、权限等异常将返回小于零的状态码,业务接口异常将返回大于零的状态码。
{
    "code": 0,
    "msg": 'success',
    "data": {
    "user_id": "u_58233df97455c_iC9L6Wpk",
    "wx_union_id": "ozStBt1geNg5lh1bgb6rrH_vIYIM",
    "wx_nickname": "Zooter",
    "phone": "17817812015"
    "created_at": "2016-07-01 08:00:00",
}
状态码描述解决方案
0正常接口正常响应,无异常
-100签名错误请检查签名算法是否正确,或直接使用提供的sdk
-200没有调用权限请检查是否有这个权限
-40001appid不存在请填入小鹅通给予的appId
-40002timestamp不存在填入请求的时间戳
-40003sign加密串不存在请填入加密体,加密方法请参照加密介绍
-40004业务参数(data)不存在业务数据key不存在
-40101appid错误请填入小鹅通给予的appId
-40102时间戳错误请求的时间戳
-40103sign加密串错误请按照加密方法加密
-40104业务参数错误业务参数错误
-50001接口异常请填入正确的请求地址
1 / -1系统错误系统内部错误,请直接联系技术支持
40003参数缺失请检查请求参数是否完整
40004参数无效请检查请求参数是否有误
40005用户未注册用户未注册,需调用注册接口进行注册
40006微信union_id已被使用用户注册或者更新用户信息时出现union_id重复
40007手机号码已被使用用户注册或者更新用户信息时出现手机号码重复
备注
更多异常状态代码请查看各接口的错误描述

常见问题#

1、普通浏览器可以打开小鹅通的H5链接吗#
小鹅通目前的H5链接目前只能在微信内访问,以及pc端浏览器访问。
客户自己开发的浏览器应用暂不支持内嵌小鹅通H5页面。
2、返回码为 -40103,提示签名错误,为什么?#
API的请求格式需要按照规定格式请求,否则请求失败。API的对接通过是使用APPID和SECRETID通过特定的签名算法加密,可以直接使用小鹅通提供的SDK,SDK包含python2,python3,php,java语言,其他语言可以参考小鹅通开放API文档的开发指南的《签名与请求》章节实现。
3、资源id(resource_id)和产品包id(product_id)怎么获取?#
暂时还没有提供获取资源id的接口,资源id和产品包id目前只能去管理台对应资源的编辑页的URL获得,如下图所示:
如何获取资源id
Figure: 如何获取资源id
4、为什么通过下单接口下单了,但是用户侧还是不能观看课程?#
下单接口只是创建了订单,但订单的初始状态还是待支付状态,需要用更新订单状态接口把该订单设置成已支付状态。具体请查看订单相关接口的API文档。
5、union_id是什么?#
union_id是微信提供的一套可以帮助识别不同应用下的用户是否是同一个人的id机制,同一个微信开放平台下的不同的应用的用户的union_id都是相同的,这样在不同应用下对同一个用户提供的服务就可以通过union_id打通。具体union_id的相关的描述请查看微信公众号开发文档、微信开放平台文档。
6、为什么通过用户查询接口返回的用户信息没有union_id?#
可能有下面几种原因:
1. 公众号没有绑定到微信开放平台。
    因为union_id是基于微信开放平台的,用户拥有union_id的前提是授权给小鹅通的公众号绑定到了微信开放平台账号下。
2. 公众号绑定到微信开放平台,但是用户是在授权公众号给小鹅通之前注册的。
    这种属于老用户的情况,因为用户的union_id是需要走微信登录才能获取到,这种情况下只需要用户重新登录一次店铺,走一次授权登录流程就会补全union_id。
3. 公众号先授权给小鹅通,过了一段时间再绑定到微信开放平台上。用户在这个时间窗口注册的。
    受到微信登录规则的约束,以及用户使用体验,这部分用户的union_id不会自动补全,如果确认符合这种情况,可联系客服提交工单操作,清空用户的授权信息,后续重新登录店铺即可自动补全union_id。
7、公众号更换了微信开放平台,老用户的订购关系无法打通怎么办?#
union_id是跟着微信开放平台的账号走的,换一个账号的话,原有的union_id就无法和用户的身份匹配,请联系客服。
8、为什么从订阅列表接口里面查出A用户订阅了B商品,但是订单接口查不到A用户和B商品的订单记录?#
需要理解订购关系和订阅关系的不同,比如A购买了B商品,但是赠送给了C用户。那么A和B就有订购关系,但是没有订阅关系,C和B就有订阅关系,但是没有订购关系。
9、为什么通过用户查询接口返回的用户信息没有openid?#
可能有下面几种原因:
1. 客户没有授权公众号给小鹅通,使用的是小鹅通代收,也就是小鹅通知识助手。因为openid是属于公众号的,没有授权公众号给小鹅通,用户信息就自然没有openid。
2. 客户授权公众号给小鹅通了,但是用户是授权之前注册的。这种情况需要引导用户重新登录店铺,走授权登录流程,就会自动补全openid字段。
上一页
Xiaoe SDK使用简介
下一页
用户注册
Built with