WeRoBot.Client
—— 微信 API 操作类¶
-
class
werobot.client.
Client
(config)¶ 微信 API 操作类 通过这个类可以方便的通过微信 API 进行一系列操作,比如主动发送消息、创建自定义菜单等
-
create_group
(name)¶ 创建分组 详情请参考 http://mp.weixin.qq.com/wiki/index.php?title=分组管理接口
参数: name – 分组名字(30个字符以内) 返回: 返回的 JSON 数据包
创建自定义菜单
client = Client("id", "secret") client.create_menu({ "button":[ { "type":"click", "name":"今日歌曲", "key":"V1001_TODAY_MUSIC" }, { "type":"click", "name":"歌手简介", "key":"V1001_TODAY_SINGER" }, { "name":"菜单", "sub_button":[ { "type":"view", "name":"搜索", "url":"http://www.soso.com/" }, { "type":"view", "name":"视频", "url":"http://v.qq.com/" }, { "type":"click", "name":"赞一下我们", "key":"V1001_GOOD" } ] } ]})
详情请参考 http://mp.weixin.qq.com/wiki/index.php?title=自定义菜单创建接口
参数: menu_data – Python 字典 返回: 返回的 JSON 数据包
-
create_qrcode
(**data)¶ 创建二维码 详情请参考 http://mp.weixin.qq.com/wiki/index.php?title=生成带参数的二维码
参数: data – 你要发送的参数 dict 返回: 返回的 JSON 数据包
删除自定义菜单。 详情请参考 http://mp.weixin.qq.com/wiki/index.php?title=自定义菜单删除接口
返回: 返回的 JSON 数据包
-
download_media
(media_id)¶ 下载多媒体文件。 详情请参考 http://mp.weixin.qq.com/wiki/index.php?title=上传下载多媒体文件
参数: media_id – 媒体文件 ID 返回: requests 的 Response 实例
-
get_access_token
()¶ 判断现有的token是否过期。 用户需要多进程或者多机部署可以手动重写这个函数 来自定义token的存储,刷新策略。
:return:返回token
-
get_followers
(first_user_id=None)¶ 获取关注者列表 详情请参考 http://mp.weixin.qq.com/wiki/index.php?title=获取关注者列表
参数: first_user_id – 可选。第一个拉取的OPENID,不填默认从头开始拉取 返回: 返回的 JSON 数据包
-
get_group_by_id
(openid)¶ 查询用户所在分组 详情请参考 http://mp.weixin.qq.com/wiki/index.php?title=分组管理接口
参数: openid – 用户的OpenID 返回: 返回的 JSON 数据包
-
get_groups
()¶ 查询所有分组 详情请参考 http://mp.weixin.qq.com/wiki/index.php?title=分组管理接口
返回: 返回的 JSON 数据包
查询自定义菜单。 详情请参考 http://mp.weixin.qq.com/wiki/index.php?title=自定义菜单查询接口
返回: 返回的 JSON 数据包
-
get_user_info
(user_id, lang='zh_CN')¶ 获取用户基本信息 详情请参考 http://mp.weixin.qq.com/wiki/index.php?title=获取用户基本信息
参数: - user_id – 用户 ID 。 就是你收到的 Message 的 source
- lang – 返回国家地区语言版本,zh_CN 简体,zh_TW 繁体,en 英语
返回: 返回的 JSON 数据包
-
grant_token
()¶ 获取 Access Token 。 详情请参考 http://mp.weixin.qq.com/wiki/index.php?title=通用接口文档
返回: 返回的 JSON 数据包
-
move_user
(user_id, group_id)¶ 移动用户分组 详情请参考 http://mp.weixin.qq.com/wiki/index.php?title=分组管理接口
参数: - user_id – 用户 ID 。 就是你收到的 Message 的 source
- group_id – 分组 ID
返回: 返回的 JSON 数据包
-
send_article_message
(user_id, articles)¶ 发送图文消息 详情请参考 http://mp.weixin.qq.com/wiki/index.php?title=发送客服消息
参数: - user_id – 用户 ID 。 就是你收到的 Message 的 source
- articles – 一个包含至多10个
Article
实例的数组
返回: 返回的 JSON 数据包
-
send_image_message
(user_id, media_id)¶ 发送图片消息 详情请参考 http://mp.weixin.qq.com/wiki/index.php?title=发送客服消息
参数: - user_id – 用户 ID 。 就是你收到的 Message 的 source
- media_id – 图片的媒体ID。 可以通过
upload_media()
上传。
返回: 返回的 JSON 数据包
-
send_music_message
(user_id, url, hq_url, thumb_media_id, title=None, description=None)¶ 发送音乐消息 详情请参考 http://mp.weixin.qq.com/wiki/index.php?title=发送客服消息
参数: - user_id – 用户 ID 。 就是你收到的 Message 的 source
- url – 音乐链接
- hq_url – 高品质音乐链接,wifi环境优先使用该链接播放音乐
- thumb_media_id – 缩略图的媒体ID。 可以通过
upload_media()
上传。 - title – 音乐标题
- description – 音乐描述
返回: 返回的 JSON 数据包
-
send_template_message
(user_id, template_id, data, url='')¶ 发送模板消息 详情请参考 http://mp.weixin.qq.com/wiki/17/304c1885ea66dbedf7dc170d84999a9d.html
参数: - user_id – 用户 ID 。 就是你收到的 Message 的 source
- template_id – 模板 ID。
- data – 用于渲染模板的数据。
- url – 模板消息的可选链接。
返回: 返回的 JSON 数据包
-
send_text_message
(user_id, content)¶ 发送文本消息 详情请参考 http://mp.weixin.qq.com/wiki/index.php?title=发送客服消息
参数: - user_id – 用户 ID 。 就是你收到的 Message 的 source
- content – 消息正文
返回: 返回的 JSON 数据包
-
send_video_message
(user_id, media_id, title=None, description=None)¶ 发送视频消息 详情请参考 http://mp.weixin.qq.com/wiki/index.php?title=发送客服消息
参数: - user_id – 用户 ID 。 就是你收到的 Message 的 source
- media_id – 发送的视频的媒体ID。 可以通过
upload_media()
上传。 - title – 视频消息的标题
- description – 视频消息的描述
返回: 返回的 JSON 数据包
-
send_voice_message
(user_id, media_id)¶ 发送语音消息 详情请参考 http://mp.weixin.qq.com/wiki/index.php?title=发送客服消息
参数: - user_id – 用户 ID 。 就是你收到的 Message 的 source
- media_id – 发送的语音的媒体ID。 可以通过
upload_media()
上传。
返回: 返回的 JSON 数据包
-
show_qrcode
(ticket)¶ 通过ticket换取二维码 详情请参考 http://mp.weixin.qq.com/wiki/index.php?title=生成带参数的二维码
参数: ticket – 二维码 ticket 。可以通过 create_qrcode()
获取到返回: 返回的 Request 对象
-
update_group
(group_id, name)¶ 修改分组名 详情请参考 http://mp.weixin.qq.com/wiki/index.php?title=分组管理接口
参数: - group_id – 分组id,由微信分配
- name – 分组名字(30个字符以内)
返回: 返回的 JSON 数据包
-
upload_media
(media_type, media_file)¶ 上传多媒体文件。 详情请参考 http://mp.weixin.qq.com/wiki/index.php?title=上传下载多媒体文件
参数: - media_type – 媒体文件类型,分别有图片(image)、语音(voice)、视频(video)和缩略图(thumb)
- media_file – 要上传的文件,一个 File-object
返回: 返回的 JSON 数据包
-