消息管理

客服接口

详细请参考 http://mp.weixin.qq.com/wiki/11/c88c270ae8935291626538f9c64bd123.html 发送卡券接口暂时未支持。可自行实现。

Client.add_custom_service_account(account, nickname, password)

添加客服帐号。

• 参数

  • account – 客服账号的用户名

  • nickname – 客服账号的昵称

  • password – 客服账号的密码

  返回

  返回的 JSON 数据包

Client.update_custom_service_account(account, nickname, password)

修改客服帐号。

• 参数

  • account – 客服账号的用户名

  • nickname – 客服账号的昵称

  • password – 客服账号的密码

  返回

  返回的 JSON 数据包

Client.delete_custom_service_account(account, nickname, password)

删除客服帐号。

• 参数

  • account – 客服账号的用户名

  • nickname – 客服账号的昵称

  • password – 客服账号的密码

  返回

  返回的 JSON 数据包

Client.upload_custom_service_account_avatar(account, avatar)

设置客服帐号的头像。

• 参数

  • account – 客服账号的用户名

  • avatar – 头像文件，必须是 jpg 格式

  返回

  返回的 JSON 数据包

Client.get_custom_service_account_list()

获取所有客服账号。

• 返回

  返回的 JSON 数据包

Client.get_online_custom_service_account_list()

获取状态为”在线”的客服账号列表。

• 返回

  返回的 JSON 数据包

Client.send_text_message(user_id, content, kf_account=None)

发送文本消息。

• 参数

  • user_id – 用户 ID 。 就是你收到的 Message 的 source

  • content – 消息正文

  • kf_account – 发送消息的客服账户，默认值为 None，None 为不指定

  返回

  返回的 JSON 数据包

Client.send_image_message(user_id, media_id, kf_account=None)

发送图片消息。

• 参数

  • user_id – 用户 ID 。 就是你收到的 Message 的 source

  • media_id – 图片的媒体ID。 可以通过 upload_media() 上传。

  • kf_account – 发送消息的客服账户，默认值为 None，None 为不指定

  返回

  返回的 JSON 数据包

Client.send_voice_message(user_id, media_id, kf_account=None)

发送语音消息。

• 参数

  • user_id – 用户 ID 。 就是你收到的 Message 的 source

  • media_id – 发送的语音的媒体ID。 可以通过 upload_media() 上传。

  • kf_account – 发送消息的客服账户，默认值为 None，None 为不指定

  返回

  返回的 JSON 数据包

Client.send_video_message(user_id, media_id, title=None, description=None, kf_account=None)

发送视频消息。

• 参数

  • user_id – 用户 ID 。 就是你收到的 Message 的 source

  • media_id – 发送的视频的媒体ID。 可以通过 upload_media() 上传。

  • title – 视频消息的标题

  • description – 视频消息的描述

  • kf_account – 发送消息的客服账户，默认值为 None，None 为不指定

  返回

  返回的 JSON 数据包

Client.send_music_message(user_id, url, hq_url, thumb_media_id, title=None, description=None, kf_account=None)

发送音乐消息。 注意如果你遇到了缩略图不能正常显示的问题， 不要慌张； 目前来看是微信服务器端的问题。 对此我们也无能为力 ( #197 )

• 参数

  • user_id – 用户 ID 。 就是你收到的 Message 的 source

  • url – 音乐链接

  • hq_url – 高品质音乐链接，wifi环境优先使用该链接播放音乐

  • thumb_media_id – 缩略图的媒体ID。 可以通过 upload_media() 上传。

  • title – 音乐标题

  • description – 音乐描述

  • kf_account – 发送消息的客服账户，默认值为 None，None 为不指定

  返回

  返回的 JSON 数据包

Client.send_article_message(user_id, articles, kf_account=None)

发送图文消息:

articles = [
    {
        "title":"Happy Day",
        "description":"Is Really A Happy Day",
        "url":"URL",
        "picurl":"PIC_URL"
    },
    {
        "title":"Happy Day",
        "description":"Is Really A Happy Day",
        "url":"URL",
        "picurl":"PIC_URL"
    }
]
client.send_acticle_message("user_id", acticles)

• 参数

  • user_id – 用户 ID 。 就是你收到的 Message 的 source

  • articles – 一个包含至多8个 article 字典或 Article 对象的数组

  • kf_account – 发送消息的客服账户，默认值为 None，None 为不指定

  返回

  返回的 JSON 数据包

Client.send_news_message(user_id, media_id, kf_account=None)

发送永久素材中的图文消息。

• 参数

  • user_id – 用户 ID 。 就是你收到的 Message 的 source

  • media_id – 媒体文件 ID

  • kf_account – 发送消息的客服账户，默认值为 None，None 为不指定

  返回

  返回的 JSON 数据包

Client.send_miniprogrampage_message(user_id, title, appid, pagepath, thumb_media_id, kf_account=None)

发送小程序卡片（要求小程序与公众号已关联）

• 参数

  • user_id – 用户 ID 。 就是你收到的 Message 的 source

  • title – 小程序卡片的标题

  • appid – 小程序的 appid，要求小程序的 appid 需要与公众号有关联关系

  • pagepath – 小程序的页面路径，跟 app.json 对齐，支持参数，比如 pages/index/index?foo=bar

  • thumb_media_id – 小程序卡片图片的媒体 ID，小程序卡片图片建议大小为 520*416

  • kf_account – 需要以某个客服帐号来发消息时指定的客服账户

  返回

  返回的 JSON 数据包

群发接口

Client.send_mass_msg(msg_type, content, user_list=None, send_ignore_reprint=False, client_msg_id=None)

向指定对象群发信息。

• 参数

  • msg_type – 群发类型，图文消息为 mpnews，文本消息为 text，语音为 voice，音乐为 music，图片为 image，视频为 video，卡券为 wxcard。

  • content – 群发内容。

  • user_list – 发送对象，整型代表用户组，列表代表指定用户，如果为 None 则代表全部发送。

  • send_ignore_reprint – 图文消息被判定为转载时，是否继续群发。 True 为继续群发（转载），False 为停止群发。 该参数默认为 False。

  • client_msg_id – 群发时，微信后台将对 24 小时内的群发记录进行检查，如果该 clientmsgid 已经存在一条群发记录，则会拒绝本次群发请求，返回已存在的群发 msgid, 控制再 64 个字符内。

  返回

  返回的 JSON 数据包。

Client.delete_mass_msg(msg_id, article_idx=0)

群发之后，随时可以通过该接口删除群发。

• 参数

  • msg_id – 发送出去的消息 ID。

  • article_idx – 要删除的文章在图文消息中的位置，第一篇编号为 1，该字段不填或填 0 会删除全部文章。

  返回

  微信返回的 json 数据。

Client.send_mass_preview_to_user(msg_type, content, user, user_type=’openid’)

开发者可通过该接口发送消息给指定用户，在手机端查看消息的样式和排版。为了满足第三方平台开发者的需求，在保留对 openID 预览能力的同时，增加了对指定微信号发送预览的能力，但该能力每日调用次数有限制（100 次），请勿滥用。

• 参数

  • user_type – 预览对象，openid 代表以 openid 发送，wxname 代表以微信号发送。

  • msg_type – 发送类型，图文消息为 mpnews，文本消息为 text，语音为 voice，音乐为 music，图片为 image，视频为 video，卡券为 wxcard。

  • content – 预览内容。

  • user – 预览用户。

  返回

  返回的 json。

Client.get_mass_msg_status(msg_id)

查询群发消息发送状态。

• 参数

  msg_id – 群发消息后返回的消息 id。

  返回

  返回的 json。

Client.get_mass_msg_speed()

获取群发速度。

• 返回

  返回的 json。

Client.delete_mass_msg(msg_id, article_idx=0)

群发之后，随时可以通过该接口删除群发。

• 参数

  • msg_id – 发送出去的消息 ID。

  • article_idx – 要删除的文章在图文消息中的位置，第一篇编号为 1，该字段不填或填 0 会删除全部文章。

  返回

  微信返回的 json 数据。