text stringlengths 81 112k |
|---|
解绑设备
详情请参考
https://iot.weixin.qq.com/wiki/new/index.html?page=3-4-7
:param ticket: 绑定操作合法性的凭证(由微信后台生成,第三方H5通过客户端jsapi获得)
:param device_id: 设备id
:param user_id: 用户对应的openid
:return: 返回的 JSON 数据包
def unbind(self, ticket, device_id, user_id):
"""
解绑设备
... |
获取deviceid和二维码
详情请参考
https://iot.weixin.qq.com/wiki/new/index.html?page=3-4-4
:param product_id: 设备的产品编号
:return: 返回的 JSON 数据包
def get_qrcode(self, product_id=1):
"""
获取deviceid和二维码
详情请参考
https://iot.weixin.qq.com/wiki/new/index.html?page=3-4-4
... |
设备授权
详情请参考
https://iot.weixin.qq.com/wiki/new/index.html?page=3-4-5
:param devices: 设备信息的列表
:param op_type: 请求操作的类型,限定取值为:0:设备授权 1:设备更新
:return: 返回的 JSON 数据包
def authorize(self, devices, op_type=1):
"""
设备授权
详情请参考
https://iot.weixin.qq.com/wiki/n... |
创建成员
https://work.weixin.qq.com/api/doc#90000/90135/90195
def create(self, user_id, name, department=None, position=None,
mobile=None, gender=0, tel=None, email=None,
weixin_id=None, extattr=None):
"""
创建成员
https://work.weixin.qq.com/api/doc#90000/90135/9... |
批量获取部门成员 / 批量获取部门成员详情
https://work.weixin.qq.com/api/doc#90000/90135/90200
https://work.weixin.qq.com/api/doc#90000/90135/90201
此接口和 `WeChatDepartment.get_users` 是同一个接口,区别为 simple 的默认值不同。
def list(self, department_id, fetch_child=False, status=0, simple=False):
"""
批量获取部门成员 / ... |
user_id 转成 openid
https://work.weixin.qq.com/api/doc#90000/90135/90202
:param user_id: 企业微信内的成员 ID
:param agent_id: 可选,需要发送红包的应用ID,若只是使用微信支付和企业转账,则无需该参数
:return: 返回的 JSON 数据包
def convert_to_openid(self, user_id, agent_id=None):
"""
user_id 转成 openid
https://wo... |
创建群聊会话
详情请参考
https://work.weixin.qq.com/api/doc#90000/90135/90245
限制说明:
只允许企业自建应用调用,且应用的可见范围必须是根部门;
群成员人数不可超过管理端配置的“群成员人数上限”,且最大不可超过500人;
每企业创建群数不可超过1000/天;
:param chat_id: 群聊的唯一标志,不能与已有的群重复;字符串类型,最长32个字符。只允许字符0-9及字母a-zA-Z。如果不填,系统会随机生成群id
:param name: 群... |
应用推送消息
详情请参考:https://work.weixin.qq.com/api/doc#90000/90135/90248
:param chat_id: 群聊id
:param msg_type: 消息类型,可以为text/image/voice/video/file/textcard/news/mpnews/markdown
:param kwargs: 具体消息类型的扩展参数
:return:
def send(self, chat_id, msg_type, **kwargs):
"""
应用推送消息
... |
deprecated, use `send` instead
def send_msg(self, chat_id, msg_type, **kwargs):
""" deprecated, use `send` instead """
return self.send(chat_id, msg_type, **kwargs) |
发送文本消息
详情请参考:https://work.weixin.qq.com/api/doc#90000/90135/90248/文本消息/
:param chat_id: 群聊id
:param content: 消息内容
:param safe: 表示是否是保密消息,0表示否,1表示是,默认0
:return:
def send_text(self, chat_id, content, safe=0):
"""
发送文本消息
详情请参考:https://work.weixin.qq.com/a... |
构造消息内容
:param content: 消息内容,最长不超过2048个字节
:param msgtype: 消息类型,可以为text/image/voice/video/file/textcard/news/mpnews/markdown
:param kwargs: 具体消息类型的扩展参数
:return:
def _build_msg_content(self, msgtype='text', **kwargs):
"""
构造消息内容
:param content: 消息内容,最长不超过2048个字节
... |
通过ticket换取二维码
详情请参考
https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1443433542
:param ticket: 二维码 ticket 。可以通过 :func:`create` 获取到
:return: 返回的 Request 对象
使用示例::
from wechatpy import WeChatClient
client = WeChatClient('appid', 'secret')
... |
通过ticket换取二维码地址
详情请参考
https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1443433542
:param ticket: 二维码 ticket 。可以通过 :func:`create` 获取到
:return: 返回的二维码地址
使用示例::
from wechatpy import WeChatClient
client = WeChatClient('appid', 'secret')
u... |
WeChat access token
def access_token(self):
""" WeChat access token """
access_token = self.session.get(self.access_token_key)
if access_token:
if not self.expires_at:
# user provided access_token, just return it
return access_token
times... |
创建卡券
:param card_data: 卡券信息
:return: 创建的卡券 ID
def create(self, card_data):
"""
创建卡券
:param card_data: 卡券信息
:return: 创建的卡券 ID
"""
result = self._post(
'card/create',
data=card_data,
result_processor=lambda x: x['card_i... |
批量导入门店信息
:param location_data: 门店信息
:return: 门店 ID 列表,插入失败的门店元素值为 -1
def batch_add_locations(self, location_data):
"""
批量导入门店信息
:param location_data: 门店信息
:return: 门店 ID 列表,插入失败的门店元素值为 -1
"""
result = self._post(
'card/location/batchadd',
... |
创建卡券二维码
:param qrcode_data: 二维码信息
:return: 二维码 ticket,可使用 :func:show_qrcode 换取二维码文件
def create_qrcode(self, qrcode_data):
"""
创建卡券二维码
:param qrcode_data: 二维码信息
:return: 二维码 ticket,可使用 :func:show_qrcode 换取二维码文件
"""
result = self._post(
'card/... |
图文消息群发卡券
def get_html(self, card_id):
"""
图文消息群发卡券
"""
result = self._post(
'card/mpnews/gethtml',
data={
'card_id': card_id
},
result_processor=lambda x: x['content']
)
return result |
消耗 code
def consume_code(self, code, card_id=None):
"""
消耗 code
"""
card_data = {
'code': code
}
if card_id:
card_data['card_id'] = card_id
return self._post(
'card/code/consume',
data=card_data
) |
解码加密的 code
def decrypt_code(self, encrypt_code):
"""
解码加密的 code
"""
result = self._post(
'card/code/decrypt',
data={
'encrypt_code': encrypt_code
},
result_processor=lambda x: x['code']
)
return result |
查询 code 信息
def get_code(self, code, card_id=None, check_consume=True):
"""
查询 code 信息
"""
card_data = {
'code': code
}
if card_id:
card_data['card_id'] = card_id
if not check_consume:
card_data['check_consume'] = check_consume
... |
用于获取用户卡包里的,属于该appid下的卡券。
def get_card_list(self, openid, card_id=None):
"""
用于获取用户卡包里的,属于该appid下的卡券。
"""
card_data = {
'openid': openid
}
if card_id:
card_data['card_id'] = card_id
return self._post(
'card/user/getcardlist',
... |
批量查询卡券信息
def batch_get(self, offset=0, count=50, status_list=None):
"""
批量查询卡券信息
"""
card_data = {
'offset': offset,
'count': count
}
if status_list:
card_data['status_list'] = status_list
return self._post(
'card/b... |
查询卡券详情
def get(self, card_id):
"""
查询卡券详情
"""
result = self._post(
'card/get',
data={
'card_id': card_id
},
result_processor=lambda x: x['card']
)
return result |
更新卡券 code
def update_code(self, card_id, old_code, new_code):
"""
更新卡券 code
"""
return self._post(
'card/code/update',
data={
'card_id': card_id,
'code': old_code,
'new_code': new_code
}
) |
设置卡券失效
def invalid_code(self, code, card_id=None):
"""
设置卡券失效
"""
card_data = {
'code': code
}
if card_id:
card_data['card_id'] = card_id
return self._post(
'card/code/unavailable',
data=card_data
) |
激活会员卡 - 接口激活方式
详情请参见
https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1451025283
参数示例:
{
"init_bonus": 100,
"init_bonus_record":"旧积分同步",
"init_balance": 200,
"membership_number": "AAA00000001",
"code": "12312313",
... |
更新会员信息
详情请参见
https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1451025283
注意事项:
1.开发者可以同时传入add_bonus和bonus解决由于同步失败带来的幂等性问题。同时传入add_bonus和bonus时
add_bonus作为积分变动消息中的变量值,而bonus作为卡面上的总积分额度显示。余额变动同理。
2.开发者可以传入is_notify_bonus控制特殊的积分对账变动不发送消息,余额变动同理。
参数示例:
... |
新增支付后投放卡券的规则,支持支付后领卡,支付后赠券
详情请参见
https://mp.weixin.qq.com/wiki?id=mp1466494654_K9rNz
:param base_info: 营销规则结构体
:type base_info: dict
:param extra_info: 支付规则结构体
:type extra_info: dict
:param is_membercard: 本次规则是否是领卡。(领卡传入 True, 赠券传入 False)
:type is_memberc... |
查询支付后投放卡券的规则
详情请参见
https://mp.weixin.qq.com/wiki?id=mp1466494654_K9rNz
:param rule_id: 支付即会员的规则 ID
:return: 支付后投放卡券的规则
:rtype: dict
def get_pay_giftcard(self, rule_id):
"""
查询支付后投放卡券的规则
详情请参见
https://mp.weixin.qq.com/wiki?id=mp1466494654_K9rNz
... |
批量查询支付后投放卡券的规则
详情请参见
https://mp.weixin.qq.com/wiki?id=mp1466494654_K9rNz
:param effective: 是否仅查询生效的规则
:type effective: bool
:param offset: 起始偏移量
:type offset: int
:param count: 查询的数量
:type count: int
:return: 支付后投放卡券规则的总数,以及查询到的列表
def batch_get_... |
更新电影票
def update_movie_ticket(self, code, ticket_class, show_time, duration,
screening_room, seat_number, card_id=None):
"""
更新电影票
"""
ticket = {
'code': code,
'ticket_class': ticket_class,
'show_time': show_time,
... |
飞机票接口
def checkin_boardingpass(self, code, passenger_name, seat_class,
etkt_bnr, seat='', gate='', boarding_time=None,
is_cancel=False, qrcode_data=None, card_id=None):
"""
飞机票接口
"""
data = {
'code': code,
... |
更新红包余额
def update_luckymoney_balance(self, code, balance, card_id=None):
"""
更新红包余额
"""
card_data = {
'code': code,
'balance': balance
}
if card_id:
card_data['card_id'] = card_id
return self._post(
'card/luckymoney... |
获取卡券跳转外链
def get_redirect_url(self, url, encrypt_code, card_id):
"""
获取卡券跳转外链
"""
from wechatpy.utils import WeChatSigner
code = self.decrypt_code(encrypt_code)
signer = WeChatSigner()
signer.add_data(self.secret)
signer.add_data(code)
signer.ad... |
导入code
def deposit_code(self, card_id, codes):
"""
导入code
"""
card_data = {
'card_id': card_id,
'code': codes
}
return self._post(
'card/code/deposit',
data=card_data
) |
核查code
def check_code(self, card_id, codes):
"""
核查code
"""
card_data = {
'card_id': card_id,
'code': codes
}
return self._post(
'card/code/checkcode',
data=card_data
) |
修改库存
def modify_stock(self, card_id, n):
"""
修改库存
"""
if n == 0:
return
card_data = {
'card_id': card_id,
}
if n > 0:
card_data['increase_stock_value'] = n
elif n < 0:
card_data['reduce_stock_value'] = -n
... |
获取开卡插件 Url, 内含调用开卡插件所需的参数
详情请参考
https://mp.weixin.qq.com/wiki?id=mp1499332673_Unm7V
:param card_id: 会员卡的card_id
:param outer_str: 渠道值,用于统计本次领取的渠道参数
:return: 内含调用开卡插件所需的参数的 Url
def get_activate_url(self, card_id, outer_str=None):
"""
获取开卡插件 Url, 内含调用开卡插件所需的参数
... |
获取用户开卡时提交的信息
详情请参考
https://mp.weixin.qq.com/wiki?id=mp1499332673_Unm7V
:param activate_ticket: 跳转型开卡组件开卡后回调中的激活票据,可以用来获取用户开卡资料
:return: 用户开卡时填写的字段值
def get_activate_info(self, activate_ticket):
"""
获取用户开卡时提交的信息
详情请参考
https://mp.weixin.qq.com/wiki?id=mp14... |
设置开卡字段接口
详情请参考
https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1451025283
"6 激活会员卡" -> "6.2 一键激活" -> "步骤二:设置开卡字段接口"
参数示例:
{
"card_id": "pbLatjnrwUUdZI641gKdTMJzHGfc",
"service_statement": {
"name": "会员守则",
"url": "ht... |
获取 JSAPI 签名
:param prepay_id: 统一下单接口返回的 prepay_id 参数值
:param timestamp: 可选,时间戳,默认为当前时间戳
:param nonce_str: 可选,随机字符串,默认自动生成
:return: 签名
def get_jsapi_signature(self, prepay_id, timestamp=None, nonce_str=None):
"""
获取 JSAPI 签名
:param prepay_id: 统一下单接口返回的 prepay_id... |
获取 JSAPI 参数
:param prepay_id: 统一下单接口返回的 prepay_id 参数值
:param timestamp: 可选,时间戳,默认为当前时间戳
:param nonce_str: 可选,随机字符串,默认自动生成
:param jssdk: 前端调用方式,默认使用 WeixinJSBridge
使用 jssdk 调起支付的话,timestamp 的 s 为小写
使用 WeixinJSBridge 调起支付的话,timeStamp 的 S 为大写
... |
获取 access token
详情请参考 http://mp.weixin.qq.com/wiki/index.php?title=通用接口文档
:return: 返回的 JSON 数据包
def fetch_access_token(self):
"""
获取 access token
详情请参考 http://mp.weixin.qq.com/wiki/index.php?title=通用接口文档
:return: 返回的 JSON 数据包
"""
return self._fetch_acce... |
获取 access token
详情请参考 https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list\
&t=resource/res_list&verify=1&id=open1419318587&token=&lang=zh_CN
这是内部刷新机制。请不要完全依赖!
因为有可能在缓存期间没有对此公众号的操作,造成refresh_token失效。
:return: 返回的 JSON 数据包
def fetch_access_token(self):
"""
... |
更新部门
https://work.weixin.qq.com/api/doc#90000/90135/90206
:param id: 部门 id
:param name: 部门名称。长度限制为1~32个字符,字符不能包括\\:?”<>|
:param parent_id: 父亲部门id
:param order: 在父部门中的次序值。order值大的排序靠前。有效的值范围是[0, 2^32)
:return: 返回的 JSON 数据包
def update(self, id, name=None, parent_id=None,... |
获取指定部门列表
https://work.weixin.qq.com/api/doc#90000/90135/90208
权限说明:
只能拉取token对应的应用的权限范围内的部门列表
:param id: 部门id。获取指定部门及其下的子部门。 如果不填,默认获取全量组织架构
:return: 部门列表
def get(self, id=None):
"""
获取指定部门列表
https://work.weixin.qq.com/api/doc#90000/90135/90208
... |
获取部门成员:https://work.weixin.qq.com/api/doc#90000/90135/90200
获取部门成员详情:https://work.weixin.qq.com/api/doc#90000/90135/90201
:param id: 部门 id
:param status: 0 获取全部员工,1 获取已关注成员列表,
2 获取禁用成员列表,4 获取未关注成员列表。可叠加
:param fetch_child: 1/0:是否递归获取子部门下面的成员
:param simple:... |
增量更新成员
https://work.weixin.qq.com/api/doc#90000/90135/90980
:param url: 企业应用接收企业微信推送请求的访问协议和地址,支持http或https协议
:param token: 用于生成签名
:param encoding_aes_key: 用于消息体的加密,是AES密钥的Base64编码
:param media_id: 上传的csv文件的media_id
:param to_invite: 是否邀请新建的成员使用企业微信(将通过微信服务通知或短信或邮件下发邀请,... |
全量覆盖部门
https://work.weixin.qq.com/api/doc#90000/90135/90982
:param url: 企业应用接收企业微信推送请求的访问协议和地址,支持http或https协议
:param token: 用于生成签名
:param encoding_aes_key: 用于消息体的加密,是AES密钥的Base64编码
:param media_id: 上传的csv文件的media_id
:return: 返回的 JSON 数据包
def replace_party(self, url, to... |
邀请成员
https://work.weixin.qq.com/api/doc#90000/90135/90975
企业可通过接口批量邀请成员使用企业微信,邀请后将通过短信或邮件下发通知。
:param user: 成员ID列表, 最多支持1000个。
:param party: 成员ID列表, 最多支持100个。
:param tag: 成员ID列表, 最多支持100个。
:return: 返回的 JSON 数据包
def invite(self, user=None, party=None, tag=None):
... |
邀请成员关注(deprecated)
https://qydev.weixin.qq.com/wiki/index.php?title=异步任务接口
:param url: 企业应用接收企业微信推送请求的访问协议和地址,支持http或https协议
:param token: 用于生成签名
:param encoding_aes_key: 用于消息体的加密,是AES密钥的Base64编码
:param user_ids: 可选,成员ID列表,多个接收者用‘|’分隔,最多支持1000个。
:param party_ids: 可选,部门ID... |
创建分组
详情请参考
http://mp.weixin.qq.com/wiki/0/56d992c605a97245eb7e617854b169fc.html
:param name: 分组名字(30个字符以内)
:return: 返回的 JSON 数据包
使用示例::
from wechatpy import WeChatClient
client = WeChatClient('appid', 'secret')
res = client.group.create('N... |
查询所有分组或查询用户所在分组 ID
详情请参考
http://mp.weixin.qq.com/wiki/0/56d992c605a97245eb7e617854b169fc.html
:param user_id: 用户 ID,提供时查询该用户所在分组,否则查询所有分组
:return: 所有分组列表或用户所在分组 ID
使用示例::
from wechatpy import WeChatClient
client = WeChatClient('appid', 'secret')
... |
修改分组名
详情请参考
http://mp.weixin.qq.com/wiki/0/56d992c605a97245eb7e617854b169fc.html
:param group_id: 分组id,由微信分配
:param name: 分组名字(30个字符以内)
:return: 返回的 JSON 数据包
使用示例::
from wechatpy import WeChatClient
client = WeChatClient('appid', 'secret')
... |
移动用户分组
详情请参考
http://mp.weixin.qq.com/wiki/0/56d992c605a97245eb7e617854b169fc.html
:param user_id: 用户 ID, 可以是单个或者列表,为列表时为批量移动用户分组
:param group_id: 分组 ID
:return: 返回的 JSON 数据包
使用示例::
from wechatpy import WeChatClient
client = WeChatClient('appid... |
Check WeChat callback signature, raises InvalidSignatureException
if check failed.
:param token: WeChat callback token
:param signature: WeChat callback signature sent by WeChat server
:param timestamp: WeChat callback timestamp sent by WeChat server
:param nonce: WeChat callback nonce sent by WeCh... |
Convert value to unicode, default encoding is utf-8
:param value: Value to be converted
:param encoding: Desired encoding
def to_text(value, encoding='utf-8'):
"""Convert value to unicode, default encoding is utf-8
:param value: Value to be converted
:param encoding: Desired encoding
"""
... |
Convert value to binary string, default encoding is utf-8
:param value: Value to be converted
:param encoding: Desired encoding
def to_binary(value, encoding='utf-8'):
"""Convert value to binary string, default encoding is utf-8
:param value: Value to be converted
:param encoding: Desired encodin... |
Try to get timezone using pytz or python-dateutil
:param zone: timezone str
:return: timezone tzinfo or None
def timezone(zone):
"""Try to get timezone using pytz or python-dateutil
:param zone: timezone str
:return: timezone tzinfo or None
"""
try:
import pytz
return pytz... |
Get Querystring information from uri.
:param uri: uri
:return: querystring info or {}
def get_querystring(uri):
"""Get Querystring information from uri.
:param uri: uri
:return: querystring info or {}
"""
parts = urlparse.urlsplit(uri)
return urlparse.parse_qs(parts.query) |
Add data to signer
def add_data(self, *args):
"""Add data to signer"""
for data in args:
self._data.append(to_binary(data)) |
Get data signature
def signature(self):
"""Get data signature"""
self._data.sort()
str_to_sign = self._delimiter.join(self._data)
return hashlib.sha1(str_to_sign).hexdigest() |
获取门店列表
详情请参考
http://mp.weixin.qq.com/wiki/15/bcfb5d4578ea818b89913472cf2bbf8f.html
:param page_index: 可选,分页下标,默认从1开始
:param page_size: 可选,每页的个数,默认20个,最大20个
:return: 返回的 JSON 数据包
def list_shops(self, page_index=1, page_size=20):
"""
获取门店列表
详情请参考
... |
查询门店的WiFi信息
http://mp.weixin.qq.com/wiki/15/bcfb5d4578ea818b89913472cf2bbf8f.html
:param shop_id: 门店 ID
:return: 返回的 JSON 数据包
def get_shop(self, shop_id=0):
"""
查询门店的WiFi信息
http://mp.weixin.qq.com/wiki/15/bcfb5d4578ea818b89913472cf2bbf8f.html
:param shop_id: 门店... |
添加设备
详情请参考
http://mp.weixin.qq.com/wiki/10/6232005bdc497f7cf8e19d4e843c70d2.html
:param shop_id: 门店 ID
:param ssid: 无线网络设备的ssid。非认证公众号添加的ssid必需是“WX”开头(“WX”为大写字母),
认证公众号和第三方平台无此限制;所有ssid均不能包含中文字符
:param password: 无线网络设备的密码,大于8个字符,不能包含中文字符
:param bssi... |
查询设备
详情请参考
http://mp.weixin.qq.com/wiki/10/6232005bdc497f7cf8e19d4e843c70d2.html
:param shop_id: 可选,门店 ID
:param page_index: 可选,分页下标,默认从1开始
:param page_size: 可选,每页的个数,默认20个,最大20个
:return: 返回的 JSON 数据包
def list_devices(self, shop_id=None, page_index=1, page_size=20):
... |
获取物料二维码图片网址
详情请参考
http://mp.weixin.qq.com/wiki/7/fcd0378ef00617fc276be2b3baa80973.html
:param shop_id: 门店 ID
:param img_id: 物料样式编号:0-二维码,可用于自由设计宣传材料;
1-桌贴(二维码),100mm×100mm(宽×高),可直接张贴
:return: 二维码图片网址
def get_qrcode_url(self, shop_id, img_id):
"""... |
设置商家主页
详情请参考
http://mp.weixin.qq.com/wiki/6/2732f3cf83947e0e4971aa8797ee9d6a.html
:param shop_id: 门店 ID
:param template_id: 模板ID,0-默认模板,1-自定义url
:param url: 自定义链接,当template_id为1时必填
:return: 返回的 JSON 数据包
def set_homepage(self, shop_id, template_id, url=None):
""... |
查询商家主页
详情请参考
http://mp.weixin.qq.com/wiki/6/2732f3cf83947e0e4971aa8797ee9d6a.html
:param shop_id: 门店 ID
:return: 返回的 JSON 数据包
def get_homepage(self, shop_id):
"""
查询商家主页
详情请参考
http://mp.weixin.qq.com/wiki/6/2732f3cf83947e0e4971aa8797ee9d6a.html
... |
Wi-Fi数据统计
详情请参考
http://mp.weixin.qq.com/wiki/8/dfa2b756b66fca5d9b1211bc18812698.html
:param begin_date: 起始日期时间,最长时间跨度为30天
:param end_date: 结束日期时间戳,最长时间跨度为30天
:param shop_id: 可选,门店 ID,按门店ID搜索,-1为总统计
:return: 返回的 JSON 数据包
def list_statistics(self, begin_date, end_date, s... |
构造网页授权链接
详情请参考
https://work.weixin.qq.com/api/doc#90000/90135/91022
:param redirect_uri: 授权后重定向的回调链接地址
:param state: 重定向后会带上 state 参数
:return: 返回的 JSON 数据包
def authorize_url(self, redirect_uri, state=None):
"""
构造网页授权链接
详情请参考
https://work.weixin.... |
刷卡支付接口
:param device_info: 可选,终端设备号(商户自定义,如门店编号)
:param body: 商品描述
:param detail: 可选,商品详情
:param attach: 可选,附加数据,在查询API和支付通知中原样返回,该字段主要用于商户携带订单的自定义数据
:param client_ip: 可选,APP和网页支付提交用户端ip,Native支付填调用微信支付API的机器IP
:param out_trade_no: 可选,商户订单号,默认自动生成
:param total_fee... |
创建标签
:param name: 标签名(30个字符以内)
:return: 返回的 JSON 数据包
def create(self, name):
"""
创建标签
:param name: 标签名(30个字符以内)
:return: 返回的 JSON 数据包
"""
name = to_text(name)
return self._post(
'tags/create',
data={'tag': {'name': name}... |
编辑标签
:param tag_id: 标签id,由微信分配
:param name: 标签名字(30个字符以内)
:return: 返回的 JSON 数据包
def update(self, tag_id, name):
"""
编辑标签
:param tag_id: 标签id,由微信分配
:param name: 标签名字(30个字符以内)
:return: 返回的 JSON 数据包
"""
name = to_text(name)
return ... |
批量为用户打标签
:param tag_id: 标签 ID
:param user_id: 用户 ID, 可以是单个或者列表
:return: 返回的 JSON 数据包
def tag_user(self, tag_id, user_id):
"""
批量为用户打标签
:param tag_id: 标签 ID
:param user_id: 用户 ID, 可以是单个或者列表
:return: 返回的 JSON 数据包
"""
data = {'tagid': ta... |
获取用户身上的标签列表
:param user_id: 用户 ID, 可以是单个或者列表
:return: 返回的 JSON 数据包
def get_user_tag(self, user_id):
"""
获取用户身上的标签列表
:param user_id: 用户 ID, 可以是单个或者列表
:return: 返回的 JSON 数据包
"""
return self._post(
'tags/getidlist',
data={
... |
获取标签下粉丝列表
:param tag_id: 标签 ID
:param first_user_id: 可选。第一个拉取的 OPENID,不填默认从头开始拉取
:return: 返回的 JSON 数据包
def get_tag_users(self, tag_id, first_user_id=None):
"""
获取标签下粉丝列表
:param tag_id: 标签 ID
:param first_user_id: 可选。第一个拉取的 OPENID,不填默认从头开始拉取
:return: 返回的... |
获取标签下粉丝openid列表
:return: 返回一个迭代器,可以用for进行循环,得到openid
使用示例::
from wechatpy import WeChatClient
client = WeChatClient('appid', 'secret')
for openid in client.tag.iter_tag_users(0):
print(openid)
def iter_tag_users(self, tag_id, first_user_id=None):
... |
获取公众号的黑名单列表
详情请参考
https://mp.weixin.qq.com/wiki?id=mp1471422259_pJMWA
:param begin_openid: 起始的 OpenID,传空则默认从头开始拉取
:return: 返回的 JSON 数据包
:rtype: dict
def get_black_list(self, begin_openid=None):
"""
获取公众号的黑名单列表
详情请参考
https://mp.weixin.qq.com/wiki?... |
创建小程序码(接口A: 适用于需要的码数量较少的业务场景)
详情请参考
https://mp.weixin.qq.com/debug/wxadoc/dev/api/qrcode.html
def get_wxa_code(self,
path,
width=430,
auto_color=False,
line_color={"r": "0", "g": "0", "b": "0"},
is_... |
创建小程序码(接口B:适用于需要的码数量极多,或仅临时使用的业务场景)
详情请参考
https://mp.weixin.qq.com/debug/wxadoc/dev/api/qrcode.html
def get_wxa_code_unlimited(self,
scene,
width=430,
auto_color=False,
line_color... |
发送模板消息
详情请参考
https://mp.weixin.qq.com/debug/wxadoc/dev/api/notice.html
def send_template_message(self, 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
"... |
修改小程序服务器授权域名
详情请参考
https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list&id=open1489138143_WPbOO
:param action: 增删改查的操作类型,仅支持 'add', 'delete', 'set', 'get'
:param request_domain: request 合法域名
:param wsrequest_domain: socket 合法域名
:param upload_domain: upload fil... |
为授权的小程序账号上传小程序代码
详情请参考
https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list&id=open1489140610_Uavc4
:param template_id: 代码库中的代码模板 ID
:param ext_json: 第三方自定义的配置
:param version: 代码版本号,开发者可自定义
:param description: 代码描述,开发者可自定义
def commit(self, template_id, ext_js... |
将第三方提交的代码包提交审核
详情请参考
https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list&id=open1489140610_Uavc4
:param item_list: 提交审核项的一个列表(至少填写1项,至多填写5项)
:type item_list: list[dict]
:return: 审核编号
:rtype: int
def submit_audit(self, item_list):
"""
将第三方提交的代... |
获取本账号内所有模板
详情请参考
https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list&id=open1500465446_j4CgR
:param offset: 用于分页,表示起始量,最小值为0
:type offset: int
:param count: 用于分页,表示拉取数量,最大值为20
:type count: int
:return: 模板列表
:rtype: list[dict]
def list_templat... |
组合模板,并将其添加至账号下的模板列表里
详情请参考
https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list&id=open1500465446_j4CgR
:param template_short_id: 模板标题ID
:param keyword_id_list: 按照顺序排列的模板关键词列表,最多10个
:type keyword_id_list: list[int]
:return: 模板ID
def add_template(self, templat... |
创建开放平台账号,并绑定公众号/小程序
详情请参考
https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list&id=open1498704199_1bcax
:param appid: 授权公众号或小程序的 appid
:return: 开放平台的 appid
def create_open(self, appid):
"""
创建开放平台账号,并绑定公众号/小程序
详情请参考
https://open.weixin.qq.com/c... |
获取公众号/小程序所绑定的开放平台账号
详情请参考
https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list&id=open1498704199_1bcax
:param appid: 授权公众号或小程序的 appid
:return: 开放平台的 appid
def get_open(self, appid):
"""
获取公众号/小程序所绑定的开放平台账号
详情请参考
https://open.weixin.qq.com/cgi-... |
登录凭证校验。通过 wx.login() 接口获得临时登录凭证 code 后传到开发者服务器调用此接口完成登录流程。更多使用方法详见 小程序登录
详情请参考
https://developers.weixin.qq.com/miniprogram/dev/api/code2Session.html
:param js_code:
:return:
def code_to_session(self, js_code):
"""
登录凭证校验。通过 wx.login() 接口获得临时登录凭证 code 后传到开发者服务器调用此接口完成登录... |
发送语义理解请求
详情请参考
http://mp.weixin.qq.com/wiki/0/0ce78b3c9524811fee34aba3e33f3448.html
:param query: 输入文本串
:param category: 需要使用的服务类型,多个可传入列表
:param uid: 可选,用户唯一id(非开发者id),用户区分公众号下的不同用户(建议填入用户openid)
:param latitude: 可选,纬度坐标,与经度同时传入;与城市二选一传入
:param longitude: 可选,经度坐... |
设置应用
https://work.weixin.qq.com/api/doc#90000/90135/90228
:param agent_id: 企业应用的id
:param name: 企业应用名称,长度不超过32个utf8字符
:param description: 企业应用详情,长度为4至120个utf8字符
:param redirect_domain: 企业应用可信域名。注意:域名需通过所有权校验,否则jssdk功能将受限,此时返回错误码85005
:param logo_media_id: 企业应用头像的mediaid,... |
获取 JSAPI 签名
https://work.weixin.qq.com/api/doc#90001/90144/90539/签名算法/
:param noncestr: nonce string
:param ticket: JS-SDK ticket
:param timestamp: 时间戳
:param url: URL
:return: 签名
def get_jsapi_signature(self, noncestr, ticket, timestamp, url):
"""
获取 J... |
获取微信 JS-SDK ticket
该方法会通过 session 对象自动缓存管理 ticket
:return: ticket
def get_jsapi_ticket(self):
"""
获取微信 JS-SDK ticket
该方法会通过 session 对象自动缓存管理 ticket
:return: ticket
"""
ticket_key = '{}_jsapi_ticket'.format(self._client.corp_id)
expires_at_key ... |
获取应用的jsapi_ticket
该方法会通过 session 对象自动缓存管理 ticket
:return: ticket
def get_agent_jsapi_ticket(self):
"""
获取应用的jsapi_ticket
该方法会通过 session 对象自动缓存管理 ticket
:return: ticket
"""
ticket_key = '{}_agent_jsapi_ticket'.format(self._client.corp_id)
expir... |
申请退款
:param total_fee: 订单总金额,单位为分
:param refund_fee: 退款总金额,单位为分
:param out_refund_no: 商户系统内部的退款单号,商户系统内部唯一,同一退款单号多次请求只退一笔
:param transaction_id: 可选,微信订单号
:param out_trade_no: 可选,商户系统内部的订单号,与 transaction_id 二选一
:param fee_type: 可选,货币类型,符合ISO 4217标准的三位字母代码,默认人民币:CNY
... |
查询退款
:param refund_id: 微信退款单号
:param out_refund_no: 商户退款单号
:param transaction_id: 微信订单号
:param out_trade_no: 商户系统内部的订单号
:param device_info: 可选,终端设备号
:return: 返回的结果数据
def query(self, refund_id=None, out_refund_no=None, transaction_id=None,
out_trade_no=None... |
修改商品
def update(self, product_id, product_data):
"""修改商品"""
product_data['product_id'] = product_id
return self._post(
'merchant/update',
data=product_data
) |
增加库存
:param product_id: 商品ID
:param sku_info: sku信息,格式"id1:vid1;id2:vid2",如商品为统一规格,则此处赋值为空字符串即可
:param quantity: 增加的库存数量
:return: 返回的 JSON 数据包
def add_stock(self, product_id, sku_info, quantity):
"""
增加库存
:param product_id: 商品ID
:param sku_info: sku信息,格... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.