小程序接口

class wechatpy.client.api.WeChatWxa(client=None)[源代码]
add_template(template_short_id, keyword_id_list)[源代码]

组合模板,并将其添加至账号下的模板列表里 详情请参考 https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list&id=open1500465446_j4CgR

参数:
  • template_short_id – 模板标题ID
  • keyword_id_list (list[int]) – 按照顺序排列的模板关键词列表,最多10个
返回:

模板ID

bind_open(appid, open_appid)[源代码]

将公众号/小程序绑定到开放平台帐号下 详情请参考 https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list&id=open1498704199_1bcax

参数:
  • appid – 授权公众号或小程序的 appid
  • open_appid – 开放平台帐号 appid
bind_tester(wechat_id)[源代码]

绑定微信用户成为小程序体验者 详情请参考 https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list&id=open1489140588_nVUgx

参数:wechat_id – 微信号
change_visit_status(close=False)[源代码]

修改小程序线上代码的可见状态 详情请参考 https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list&id=open1489140610_Uavc4

参数:close (bool) – close 为 True 时会关闭小程序线上代码的可见状态。
commit(template_id, ext_json, version, description)[源代码]

为授权的小程序账号上传小程序代码 详情请参考 https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list&id=open1489140610_Uavc4

参数:
  • template_id – 代码库中的代码模板 ID
  • ext_json – 第三方自定义的配置
  • version – 代码版本号,开发者可自定义
  • description – 代码描述,开发者可自定义
create_open(appid)[源代码]

创建开放平台账号,并绑定公众号/小程序 详情请参考 https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list&id=open1498704199_1bcax

参数:appid – 授权公众号或小程序的 appid
返回:开放平台的 appid
create_qrcode(path, width=430)[源代码]

创建小程序二维码(接口C:适用于需要的码数量较少的业务场景) 详情请参考 https://mp.weixin.qq.com/debug/wxadoc/dev/api/qrcode.html

del_template(template_id)[源代码]

删除本账号内某个模板 详情请参考 https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list&id=open1500465446_j4CgR

参数:template_id – 模板ID
get_audit_status(auditid)[源代码]

查询某个指定版本的审核状态 详情请参考 https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list&id=open1489140610_Uavc4

参数:auditid (int) – 审核编号
返回:一个包含 status, reason 的 dict。status 0为审核成功,1为审核失败,2为审核中。
get_category()[源代码]

获取授权小程序账号的可选类目 详情请参考 https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list&id=open1489140610_Uavc4

返回类型:list[dict]
get_latest_audit_status()[源代码]

查询最近一次提交的审核状态 详情请参考 https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list&id=open1489140610_Uavc4

返回:一个包含 status, reason, auditid 的 dict。status 0为审核成功,1为审核失败,2为审核中。
get_library_template(template_short_id)[源代码]

获取小程序模板库里,某个模板的详细信息 详情请参考 https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list&id=open1500465446_j4CgR

参数:template_short_id – 模板标题ID
返回类型:dict
get_open(appid)[源代码]

获取公众号/小程序所绑定的开放平台账号 详情请参考 https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list&id=open1498704199_1bcax

参数:appid – 授权公众号或小程序的 appid
返回:开放平台的 appid
get_page()[源代码]

获取小程序的第三方提交代码的页面配置 详情请参考 https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list&id=open1489140610_Uavc4

返回类型:list
get_qrcode()[源代码]

获取体验小程序的体验二维码 返回 Response 类型,header 中带有 Content-Type 与 Content-disposition 类型 详情请参考 https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list&id=open1489140610_Uavc4

返回类型:requests.Response
get_wxa_code(path, width=430, auto_color=False, line_color={'b': '0', 'g': '0', 'r': '0'}, is_hyaline=False)[源代码]

创建小程序码(接口A: 适用于需要的码数量较少的业务场景) 详情请参考 https://mp.weixin.qq.com/debug/wxadoc/dev/api/qrcode.html

get_wxa_code_unlimited(scene, width=430, auto_color=False, line_color={'b': '0', 'g': '0', 'r': '0'}, page=None, is_hyaline=False)[源代码]

创建小程序码(接口B:适用于需要的码数量极多,或仅临时使用的业务场景) 详情请参考 https://mp.weixin.qq.com/debug/wxadoc/dev/api/qrcode.html

list_library_templates(offset=0, count=20)[源代码]

获取小程序模板库里,所有模板的ID与标题 详情请参考 https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list&id=open1500465446_j4CgR

参数:
  • offset (int) – 用于分页,表示起始量,最小值为0
  • count (int) – 用于分页,表示拉取数量,最大值为20
返回:

带有 total_count 与 list 的数据

返回类型:

dict

list_templates(offset=0, count=20)[源代码]

获取本账号内所有模板 详情请参考 https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list&id=open1500465446_j4CgR

参数:
  • offset (int) – 用于分页,表示起始量,最小值为0
  • count (int) – 用于分页,表示拉取数量,最大值为20
返回:

模板列表

返回类型:

list[dict]

modify_domain(action, request_domain=(), wsrequest_domain=(), upload_domain=(), download_domain=())[源代码]

修改小程序服务器授权域名 详情请参考 https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list&id=open1489138143_WPbOO

参数:
  • action – 增删改查的操作类型,仅支持 ‘add’, ‘delete’, ‘set’, ‘get’
  • request_domain – request 合法域名
  • wsrequest_domain – socket 合法域名
  • upload_domain – upload file 合法域名
  • download_domain – download file 合法域名
release()[源代码]

发布已通过审核的小程序 详情请参考 https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list&id=open1489140610_Uavc4

send_template_message(user_id, template_id, data, form_id, page=None, color=None, emphasis_keyword=None)[源代码]

发送模板消息 详情请参考 https://mp.weixin.qq.com/debug/wxadoc/dev/api/notice.html

submit_audit(item_list)[源代码]

将第三方提交的代码包提交审核 详情请参考 https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list&id=open1489140610_Uavc4

参数:item_list (list[dict]) – 提交审核项的一个列表(至少填写1项,至多填写5项)
返回:审核编号
返回类型:int
unbind_open(appid, open_appid)[源代码]

将公众号/小程序绑定到开放平台帐号下 详情请参考 https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list&id=open1498704199_1bcax

参数:
  • appid – 授权公众号或小程序的 appid
  • open_appid – 开放平台帐号 appid
unbind_tester(wechat_id)[源代码]

解除绑定小程序的体验者 详情请参考 https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list&id=open1489140588_nVUgx

参数:wechat_id – 微信号