Add scan related events documentation

wechatpy · Mar 10, 2016 · f57a4a0 · f57a4a0
1 parent a1d709e
commit f57a4a0
Showing 1 changed file with 73 additions and 0 deletions.
diff --git a/docs/events.rst b/docs/events.rst
@@ -367,3 +367,76 @@ VerifyExpiredEvent 的属性:
 event        verify_expired
 expired_time 有效期，表示已于该时间戳认证过期，需要重新发起微信认证
 ============ ============================================
+
+微信扫一扫事件
+--------------------
+
+打开商品主页事件
+~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: UserScanProductEvent
+   :members:
+
+UserScanProductEvent 的属性:
+
+============ ============================================
+参数          值
+============ ============================================
+event        user_scan_product
+standard     商品编码标准
+key          商品编码内容
+country      用户在微信内设置的国家
+province     用户在微信内设置的省份
+city         用户在微信内设置的城市
+sex          用户的性别，1为男性，2为女性，0代表未知
+scene        打开商品主页的场景，1为扫码，2为其他打开场景（如会话、收藏或朋友圈）
+============ ============================================
+
+进入公众号事件
+~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: UserScanProductEnterSessionEvent
+   :members:
+
+UserScanProductEnterSessionEvent 的属性:
+
+============ ============================================
+参数          值
+============ ============================================
+event        user_scan_product_enter_session
+standard     商品编码标准
+key          商品编码内容
+============ ============================================
+
+地理位置信息异步推送事件
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: UserScanProductAsyncEvent
+   :members:
+
+UserScanProductAsyncEvent 的属性:
+
+============ ============================================
+参数          值
+============ ============================================
+event        user_scan_product_async
+standard     商品编码标准
+key          商品编码内容
+region_code  用户的实时地理位置信息
+============ ============================================
+
+商品审核结果事件
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: UserScanProductVerifyActionEvent
+   :members:
+
+============ ============================================
+参数          值
+============ ============================================
+event        user_scan_product_async
+standard     商品编码标准
+key          商品编码内容
+result       审核结果。verify_ok 表示审核通过，verify_not_pass 表示审核未通过
+reason       审核未通过的原因
+============ ============================================