WeRoBot.Client —— 微信 API 操作类

class werobot.client.Client(appid, appsecret)

微信 API 操作类 通过这个类可以方便的通过微信 API 进行一系列操作,比如主动发送消息、创建自定义菜单等

create_group(name)

创建分组 详情请参考 http://mp.weixin.qq.com/wiki/index.php?title=分组管理接口

Parameters:name – 分组名字(30个字符以内)
Returns:返回的 JSON 数据包
create_menu(menu_data)

创建自定义菜单

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=自定义菜单创建接口

Parameters:menu_data – Python 字典
Returns:返回的 JSON 数据包
create_qrcode(**data)

创建二维码 详情请参考 http://mp.weixin.qq.com/wiki/index.php?title=生成带参数的二维码

Parameters:data – 你要发送的参数 dict
Returns:返回的 JSON 数据包
delete_menu()

删除自定义菜单。 详情请参考 http://mp.weixin.qq.com/wiki/index.php?title=自定义菜单删除接口

Returns:返回的 JSON 数据包
download_media(media_id)

下载多媒体文件。 详情请参考 http://mp.weixin.qq.com/wiki/index.php?title=上传下载多媒体文件

Parameters:media_id – 媒体文件 ID
Returns:requests 的 Response 实例
get_followers(first_user_id=None)

获取关注者列表 详情请参考 http://mp.weixin.qq.com/wiki/index.php?title=获取关注者列表

Parameters:first_user_id – 可选。第一个拉取的OPENID,不填默认从头开始拉取
Returns:返回的 JSON 数据包
get_group_by_id(openid)

查询用户所在分组 详情请参考 http://mp.weixin.qq.com/wiki/index.php?title=分组管理接口

Parameters:openid – 用户的OpenID
Returns:返回的 JSON 数据包
get_groups()

查询所有分组 详情请参考 http://mp.weixin.qq.com/wiki/index.php?title=分组管理接口

Returns:返回的 JSON 数据包
get_menu()

查询自定义菜单。 详情请参考 http://mp.weixin.qq.com/wiki/index.php?title=自定义菜单查询接口

Returns:返回的 JSON 数据包
get_user_info(user_id, lang='zh_CN')

获取用户基本信息 详情请参考 http://mp.weixin.qq.com/wiki/index.php?title=获取用户基本信息

Parameters:
  • user_id – 用户 ID 。 就是你收到的 Message 的 source
  • lang – 返回国家地区语言版本,zh_CN 简体,zh_TW 繁体,en 英语
Returns:

返回的 JSON 数据包

grant_token()

获取 Access Token 。 详情请参考 http://mp.weixin.qq.com/wiki/index.php?title=通用接口文档

Returns:返回的 JSON 数据包
move_user(user_id, group_id)

移动用户分组 详情请参考 http://mp.weixin.qq.com/wiki/index.php?title=分组管理接口

Parameters:
  • user_id – 用户 ID 。 就是你收到的 Message 的 source
  • group_id – 分组 ID
Returns:

返回的 JSON 数据包

send_article_message(user_id, articles)

发送图文消息 详情请参考 http://mp.weixin.qq.com/wiki/index.php?title=发送客服消息

Parameters:
  • user_id – 用户 ID 。 就是你收到的 Message 的 source
  • articles – 一个包含至多10个 Article 实例的数组
Returns:

返回的 JSON 数据包

send_image_message(user_id, media_id)

发送图片消息 详情请参考 http://mp.weixin.qq.com/wiki/index.php?title=发送客服消息

Parameters:
  • user_id – 用户 ID 。 就是你收到的 Message 的 source
  • media_id – 图片的媒体ID。 可以通过 upload_media() 上传。
Returns:

返回的 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=发送客服消息

Parameters:
  • user_id – 用户 ID 。 就是你收到的 Message 的 source
  • url – 音乐链接
  • hq_url – 高品质音乐链接,wifi环境优先使用该链接播放音乐
  • thumb_media_id – 缩略图的媒体ID。 可以通过 upload_media() 上传。
  • title – 音乐标题
  • description – 音乐描述
Returns:

返回的 JSON 数据包

send_text_message(user_id, content)

发送文本消息 详情请参考 http://mp.weixin.qq.com/wiki/index.php?title=发送客服消息

Parameters:
  • user_id – 用户 ID 。 就是你收到的 Message 的 source
  • content – 消息正文
Returns:

返回的 JSON 数据包

send_video_message(user_id, media_id, title=None, description=None)

发送视频消息 详情请参考 http://mp.weixin.qq.com/wiki/index.php?title=发送客服消息

Parameters:
  • user_id – 用户 ID 。 就是你收到的 Message 的 source
  • media_id – 发送的视频的媒体ID。 可以通过 upload_media() 上传。
  • title – 视频消息的标题
  • description – 视频消息的描述
Returns:

返回的 JSON 数据包

send_voice_message(user_id, media_id)

发送语音消息 详情请参考 http://mp.weixin.qq.com/wiki/index.php?title=发送客服消息

Parameters:
  • user_id – 用户 ID 。 就是你收到的 Message 的 source
  • media_id – 发送的语音的媒体ID。 可以通过 upload_media() 上传。
Returns:

返回的 JSON 数据包

show_qrcode(ticket)

通过ticket换取二维码 详情请参考 http://mp.weixin.qq.com/wiki/index.php?title=生成带参数的二维码

Parameters:ticket – 二维码 ticket 。可以通过 create_qrcode() 获取到
Returns:返回的 Request 对象
update_group(group_id, name)

修改分组名 详情请参考 http://mp.weixin.qq.com/wiki/index.php?title=分组管理接口

Parameters:
  • group_id – 分组id,由微信分配
  • name – 分组名字(30个字符以内)
Returns:

返回的 JSON 数据包

upload_media(media_type, media_file)

上传多媒体文件。 详情请参考 http://mp.weixin.qq.com/wiki/index.php?title=上传下载多媒体文件

Parameters:media_type – 媒体文件类型,分别有图片(image)、语音(voice)、视频(video)和缩略图(thumb)

:param media_file:要上传的文件,一个 File-object

Returns:返回的 JSON 数据包

Related Topics

关于

WeRoBot 是一个高中生利用闲暇时间写成的微信公共平台开发框架。如果你喜欢 WeRoBot ,请考虑捐助:

帮助

如果你在使用过程中有任何建议或者疑惑,欢迎给我发信