pywxclient.core.api module

WeChat http request API module.

class pywxclient.core.api.WeChatAPI

Bases: object

WeChat http api.

api_url_template = '{schema}://{endpoint}{url}'

appid = 'wx782c26e4c19acffb'

batch_contact_list_url = '/cgi-bin/mmwebwx-bin/webwxbatchgetcontact'

classmethod check_sync(session)

Check sync status.

contact_list_url = '/cgi-bin/mmwebwx-bin/webwxgetcontact'

classmethod do_sync(session)

Do WeChat session status sync.

do_sync_url = '/cgi-bin/mmwebwx-bin/webwxsync'

file_sub_host = 'file.'

classmethod get_base_request(wx_session_data)

Construct base request.

classmethod get_client_msg_id()

Generate client message id.

classmethod get_contact_list(session)

Get user contact list.

classmethod get_device_id()

Generate a random device id.

classmethod get_file_endpoint(session)

Return wechat file related api endpoint.

classmethod get_head_img(session, headimg_url)

Get wechat head img.

classmethod get_icon(session, icon_url)

Get user wechat icon.

classmethod get_login_endpoint(session)

Return wechat login related api endpoint.

classmethod get_login_info(session, uuid)

Get login authorize info.

classmethod get_msg_img(session, msg_id, original=True, stream=True)

Get message image.

classmethod get_msg_media(session, from_username, media_id, filename, stream=True)

Get message media data.

classmethod get_msg_voice(session, msg_id, stream=True)

Get voice message data.

classmethod get_push_endpoint(session)

Return wechat push related api endpoint.

classmethod get_qrcode_url(session, uuid)

Get authorize qrcode url.

classmethod get_qrcode_uuid(session)

Get login qrcode uuid.

classmethod get_wx_endpoint()

Return wechat api endpoint.

high_timeout = (30, 60)

init_url = '/cgi-bin/mmwebwx-bin/webwxinit'

login_sub_host = 'login.'

login_url = '/cgi-bin/mmwebwx-bin/login'

classmethod logout(session)

Logout wechat session.

logout_url = '/cgi-bin/mmwebwx-bin/webwxlogout'

low_timeout = (10, 15)

max_file_body = 524288

classmethod mget_contact_list(session, user_list)

Batch get user contact list.

middle_timeout = (15, 30)

msg_img_url = '/cgi-bin/mmwebwx-bin/webwxgetmsgimg'

msg_media_url = '/cgi-bin/mmwebwx-bin/webwxgetmedia'

msg_voice_url = '/cgi-bin/mmwebwx-bin/webwxgetvoice'

classmethod new_login_page(session, login_api_path)

Create login page.

classmethod notify_status(session, user)

Notify session status.

oplog_url = '/cgi-bin/mmwebwx-bin/webwxoplog'

push_sub_host = 'webpush.'

qrcode_url = '/qrcode'

qrcode_uuid_url = '/jslogin'

schema = 'https'

classmethod send_app_message(session, message)

Send app message api.

classmethod send_file_message(session, message)

Send file message api.

classmethod send_gif_message(session, message)

Send gif message api.

classmethod send_image_message(session, message)

Send image message api.

classmethod send_text_message(session, message)

Send text message api.

classmethod send_video_message(session, message)

Send video message api.

sendmsg_app_url = '/cgi-bin/mmwebwx-bin/webwxsendappmsg'

sendmsg_gif_url = '/cgi-bin/mmwebwx-bin/webwxsendemoticon'

sendmsg_img_url = '/cgi-bin/mmwebwx-bin/webwxsendmsgimg'

sendmsg_url = '/cgi-bin/mmwebwx-bin/webwxsendmsg'

sendmsg_video_url = '/cgi-bin/mmwebwx-bin/webwxsendvideomsg'

classmethod set_user_remark(session, username, remark)

Set user remark api.

status_notify_url = '/cgi-bin/mmwebwx-bin/webwxstatusnotify'

sync_check_url = '/cgi-bin/mmwebwx-bin/synccheck'

classmethod upload_file(session, file_obj, from_username, to_username)

Upload file to WeChat.

upload_file_url = '/cgi-bin/mmwebwx-bin/webwxuploadmedia'

wx_endpoints = ('wx.qq.com', 'wx2.qq.com')

classmethod wx_init(session)

Initialize WeChat session.