摇一摇周边接口

class wechatpy.client.api.WeChatShakeAround(client=None)[源代码]
add_material(media_file, media_type='icon')[源代码]

上传图片素材 详情请参考 http://mp.weixin.qq.com/wiki/5/e997428269ff189d8f9a4b9e177be2d9.html

参数:
  • media_file – 要上传的文件,一个 File-object
  • media_type – 摇一摇素材类型, 取值为 icon或者 license, 默认 icon.
返回:

上传的素材信息

add_page(title, description, icon_url, page_url, comment=None)[源代码]

新增页面 详情请参考 http://mp.weixin.qq.com/wiki/5/6626199ea8757c752046d8e46cf13251.html

参数:
  • title – 在摇一摇页面展示的主标题,不超过6个字
  • description – 在摇一摇页面展示的副标题,不超过7个字
  • icon_url – 在摇一摇页面展示的图片。图片需先上传至微信侧服务器, 用“素材管理-上传图片素材”接口上传图片,返回的图片URL再配置在此处
  • page_url – 跳转链接
  • comment – 可选,页面的备注信息,不超过15个字
返回:

页面信息

apply_device_id(quantity, reason, poi_id=None, comment=None)[源代码]

申请设备ID 详情请参考 http://mp.weixin.qq.com/wiki/15/b9e012f917e3484b7ed02771156411f3.html

参数:
  • quantity – 申请的设备ID的数量,单次新增设备超过500个,需走人工审核流程
  • reason – 申请理由,不超过100个字
  • poi_id – 可选,设备关联的门店ID
  • comment – 可选,备注,不超过15个汉字或30个英文字母
返回:

申请的设备信息

bind_device_location(poi_id, device_id=None, uuid=None, major=None, minor=None)[源代码]

配置设备与门店的关联关系 详情请参考 http://mp.weixin.qq.com/wiki/15/b9e012f917e3484b7ed02771156411f3.html

参数:
  • poi_id – 待关联的门店ID
  • device_id – 设备编号,若填了UUID、major、minor,则可不填设备编号,若二者都填,则以设备编号为优先
  • uuid – UUID
  • major – major
  • minor – minor
返回:

返回的 JSON 数据包

bind_device_pages(page_ids, bind, append, device_id=None, uuid=None, major=None, minor=None)[源代码]

配置设备与页面的关联关系 详情请参考 http://mp.weixin.qq.com/wiki/12/c8120214ec0ba08af5dfcc0da1a11400.html

参数:
  • page_ids – 待关联的页面列表
  • bind – 关联操作标志位, 0为解除关联关系,1为建立关联关系
  • append – 新增操作标志位, 0为覆盖,1为新增
  • device_id – 设备编号,若填了UUID、major、minor,则可不填设备编号,若二者都填,则以设备编号为优先
  • uuid – UUID
  • major – major
  • minor – minor
返回:

返回的 JSON 数据包

delete_page(page_id)[源代码]

删除页面 详情请参考 http://mp.weixin.qq.com/wiki/5/6626199ea8757c752046d8e46cf13251.html

参数:page_id – 指定页面的id列表
返回:返回的 JSON 数据包
get_apply_status(apply_id)[源代码]

查询设备ID申请审核状态 详情请参考 http://mp.weixin.qq.com/wiki/15/b9e012f917e3484b7ed02771156411f3.html

参数:apply_id – 批次ID,申请设备ID时所返回的批次ID
返回:批次状态信息
get_device_statistics(begin_date, end_date, device_id=None, uuid=None, major=None, minor=None)[源代码]

以设备为维度的数据统计接口 http://mp.weixin.qq.com/wiki/0/8a24bcacad40fe7ee98d1573cb8a6764.html

参数:
  • begin_date – 起始时间,最长时间跨度为30天
  • end_date – 结束时间,最长时间跨度为30天
  • device_id – 设备编号,若填了UUID、major、minor,则可不填设备编号,若二者都填,则以设备编号为优先
  • uuid – UUID
  • major – major
  • minor – minor
get_page_statistics(page_id, begin_date, end_date)[源代码]

以页面为维度的数据统计接口 详情请参考 http://mp.weixin.qq.com/wiki/0/8a24bcacad40fe7ee98d1573cb8a6764.html

参数:
  • page_id – 页面 ID
  • begin_date – 起始时间,最长时间跨度为30天
  • end_date – 结束时间,最长时间跨度为30天
返回:

统计数据

get_shake_info(ticket)[源代码]

获取摇周边的设备及用户信息 详情请参考 http://mp.weixin.qq.com/wiki/3/34904a5db3d0ec7bb5306335b8da1faf.html

参数:ticket – 摇周边业务的ticket,可在摇到的URL中得到,ticket生效时间为30分钟
返回:设备及用户信息
search_device(identifiers=None, apply_id=None, begin=0, count=10)[源代码]

查询设备列表 详情请参考 http://mp.weixin.qq.com/wiki/15/b9e012f917e3484b7ed02771156411f3.html

参数:
  • identifiers – 设备 ID 信息列表
  • apply_id – 批次ID,申请设备ID超出500个时所返回批次ID
  • begin – 设备列表的起始索引值
  • count – 待查询的设备个数
返回:

设备列表

search_pages(page_ids=None, begin=0, count=10)[源代码]

查询页面列表 详情请参考 http://mp.weixin.qq.com/wiki/5/6626199ea8757c752046d8e46cf13251.html

参数:
  • page_ids – 指定页面的id列表
  • begin – 页面列表的起始索引值
  • count – 待查询的页面个数
返回:

页面查询结果信息

update_device(device_id=None, uuid=None, major=None, minor=None, comment=None)[源代码]

更新设备信息 详情请参考 http://mp.weixin.qq.com/wiki/15/b9e012f917e3484b7ed02771156411f3.html

参数:
  • device_id – 设备编号,若填了UUID、major、minor,则可不填设备编号,若二者都填,则以设备编号为优先
  • uuid – UUID
  • major – major
  • minor – minor
  • comment – 设备的备注信息,不超过15个汉字或30个英文字母。
返回:

返回的 JSON 数据包

update_page(page_id, title, description, icon_url, page_url, comment=None)[源代码]

编辑页面信息 详情请参考 http://mp.weixin.qq.com/wiki/5/6626199ea8757c752046d8e46cf13251.html

参数:
  • page_id – 摇周边页面唯一ID
  • title – 在摇一摇页面展示的主标题,不超过6个字
  • description – 在摇一摇页面展示的副标题,不超过7个字
  • icon_url – 在摇一摇页面展示的图片。图片需先上传至微信侧服务器, 用“素材管理-上传图片素材”接口上传图片,返回的图片URL再配置在此处
  • page_url – 跳转链接
  • comment – 可选,页面的备注信息,不超过15个字
返回:

页面信息