微信公众平台php开发包,细化各项接口操作,支持链式调用,欢迎Fork此项目
weixin developer SDK.
说明:这是对原有weixin_php_sdk项目的一个扩展,原有项目地址为:https://github.com/dodgepudding/wechat-php-sdk
使用前需先打开微信帐号的开发模式,详细步骤请查看微信公众平台接口使用说明:
微信公众平台: http://mp.weixin.qq.com/wiki/
微信企业平台: http://qydev.weixin.qq.com/wiki/
微信支付接入文档: https://mp.weixin.qq.com/cgi-bin/readtemplate?t=business/course2_tmpl&lang=zh_CN
微信多客服:http://dkf.qq.com
wechat.class.php 官方API类库
qywechat.class.php 企业号API类库
errCode.php|qyerrCode.php 全局返回码类
old_version/wechatpay.class.php 旧版微信支付V2接口类库
old_version/wechatext.class.php 非官方扩展API(停止维护)
old_version/wechatauth.class.php 授权登陆(停止维护)
old_version/wechat.js 内嵌JS(已废弃)
为开发框架进行适配
调用示例
调用官方API,具有更灵活的消息分类响应方式,支持链式调用操作 ;
- 接入验证 (初级权限)
- 自动回复(文本、图片、语音、视频、音乐、图文) (初级权限)
- 菜单操作(查询、创建、删除) (菜单权限)
- 客服消息(文本、图片、语音、视频、音乐、图文) (认证权限)
- 二维码(创建临时、永久二维码,获取二维码URL) (服务号、认证权限)
- 长链接转短链接接口 (服务号、认证权限)
- 分组操作(查询、创建、修改、移动用户到分组) (认证权限)
- 网页授权(基本授权,用户信息授权) (服务号、认证权限)
- 用户信息(查询用户基本信息、获取关注者列表) (认证权限)
- 多客服功能(客服管理、获取客服记录、客服会话管理) (认证权限)
- 媒体文件(上传、获取) (认证权限)
- 高级群发 (认证权限)
- 模板消息(设置所属行业、添加模板、发送模板消息) (服务号、认证权限)
- 卡券管理(创建、修改、删除、发放、门店管理等) (认证权限)
- 语义理解 (服务号、认证权限)
- 获取微信服务器IP列表 (初级权限)
- 微信JSAPI授权(获取ticket、获取签名) (初级权限)
- 数据统计(用户、图文、消息、接口分析数据) (认证权限)
备注:
初级权限:基本权限,任何正常的公众号都有此权限
菜单权限:正常的服务号、认证后的订阅号拥有此权限
认证权限:分为订阅号、服务号认证,如前缀服务号则仅认证的服务号有此权限,否则为认证后的订阅号、服务号都有此权限
支付权限:仅认证后的服务号可以申请此权限
$options = array(
'token'=>'tokenaccesskey', //填写你设定的key
'encodingaeskey'=>'encodingaeskey', //填写加密用的EncodingAESKey
'appid'=>'wxdk1234567890', //填写高级调用功能的app id, 请在微信开发模式后台查询
'appsecret'=>'xxxxxxxxxxxxxxxxxxx' //填写高级调用功能的密钥
);
$weObj = new Wechat($options); //创建实例对象
//TODO:调用$weObj各实例方法
- valid() 验证连接,被动接口处于加密模式时必须调用
- getRev() 获取微信服务器发来信息(不返回结果),被动接口必须调用
- getRevData() 返回微信服务器发来的信息(数组)
- getRevFrom() 返回消息发送者的userid
- getRevTo() 返回消息接收者的id(即公众号id)
- getRevType() 返回接收消息的类型
- getRevID() 返回消息id
- getRevCtime() 返回消息发送时间
- getRevContent() 返回消息内容正文或语音识别结果(文本型)
- getRevPic() 返回图片信息(图片型信息) 返回数组{'mediaid'=>'','picurl'=>''}
- getRevLink() 接收消息链接(链接型信息) 返回数组{'url'=>'','title'=>'','description'=>''}
- getRevGeo() 返回地理位置(位置型信息) 返回数组{'x'=>'','y'=>'','scale'=>'','label'=>''}
- getRevEventGeo() 返回事件地理位置(事件型信息) 返回数组{'x'=>'','y'=>'','precision'=>''}
- getRevEvent() 返回事件类型(事件型信息) 返回数组{'event'=>'','key'=>''}
- getRevScanInfo() 获取自定义菜单的扫码推事件信息,事件类型为
scancode_push
或scancode_waitmsg
返回数组array ('ScanType'=>'qrcode','ScanResult'=>'123123') - getRevSendPicsInfo() 获取自定义菜单的图片发送事件信息,事件类型为
pic_sysphoto
或pic_photo_or_album
或pic_weixin
数组结构见php文件内方法说明 - getRevSendGeoInfo() 获取自定义菜单的地理位置选择器事件推送,事件类型为
location_select
数组结构见php文件内方法说明 - getRevVoice() 返回语音信息(语音型信息) 返回数组{'mediaid'=>'','format'=>''}
- getRevVideo() 返回视频信息(视频型信息) 返回数组{'mediaid'=>'','thumbmediaid'=>''}
- getRevTicket() 返回接收TICKET(扫描带参数二维码,关注或SCAN事件) 返回二维码的ticket值
- getRevSceneId() 返回二维码的场景值(扫描带参数二维码的关注事件) 返回二维码的参数值
- getRevTplMsgID() 返回主动推送的消息ID(群发或模板消息事件) 返回MsgID值
- getRevStatus() 返回模板消息发送状态(模板消息事件) 返回文本:success(成功)|failed:user block(用户拒绝接收)|failed: system failed(发送失败(非用户拒绝))
- getRevResult() 返回群发或模板消息发送结果(群发或模板消息事件) 返回数组,内容依事件类型而不同,参考开发文档中群发、模板消息推送事件
- getRevKFCreate() 返回多客服-接入会话的客服账号(多客服-接入会话事件) 返回文本型
- getRevKFClose() 返回多客服-处理会话的客服账号(多客服-接入会话事件) 返回文本型
- getRevKFSwitch() 返回多客服-转接会话信息(多客服-转接会话事件) 返回数组 {'FromKfAccount' => '','ToKfAccount' => ''}
- getRevCardPass() 返回卡券-审核通过的卡券ID(卡券-卡券审核事件) 返回文本型
- getRevCardGet() 返回卡券-用户领取卡券的相关信息(卡券-领取卡券事件) 返回数组{'CardId' => '','IsGiveByFriend' => '','UserCardCode' => ''}
- getRevCardDel() 返回卡券-用户删除卡券的相关信息(卡券-删除卡券事件) 返回数组{'CardId' => '','UserCardCode' => ''}
- text($text) 设置文本型消息,参数:文本内容
- image($mediaid) 设置图片型消息,参数:图片的media_id
- voice($mediaid) 设置语音型消息,参数:语音的media_id
- video($mediaid='',$title,$description) 设置视频型消息,参数:视频的media_id、标题、摘要
- music($title,$desc,$musicurl,$hgmusicurl='',$thumbmediaid='') 设置回复音乐,参数:音乐标题、音乐描述、音乐链接、高音质链接、缩略图的媒体id
- news($newsData) 设置图文型消息,参数:数组。数组结构见php文件内方法说明
- Message($msg = '',$append = false) 设置发送的消息(一般不需要调用这个方法)
- transfer_customer_service($customer_account = '') 转接多客服,如不指定客服可不提供参数,参数:指定客服的账号
- reply() 将以上已经设置好的消息,回复给微信服务器
////消息类型,使用实例调用getRevType()方法取得
const MSGTYPE_TEXT = 'text';
const MSGTYPE_IMAGE = 'image';
const MSGTYPE_LOCATION = 'location';
const MSGTYPE_LINK = 'link';
const MSGTYPE_EVENT = 'event';
const MSGTYPE_MUSIC = 'music';
const MSGTYPE_NEWS = 'news';
const MSGTYPE_VOICE = 'voice';
const MSGTYPE_VIDEO = 'video';
////事件类型,使用实例调用getRevEvent()方法取得
const EVENT_SUBSCRIBE = 'subscribe'; //订阅
const EVENT_UNSUBSCRIBE = 'unsubscribe'; //取消订阅
const EVENT_SCAN = 'SCAN'; //扫描带参数二维码
const EVENT_LOCATION = 'LOCATION'; //上报地理位置
const EVENT_MENU_VIEW = 'VIEW'; //菜单 - 点击菜单跳转链接
const EVENT_MENU_CLICK = 'CLICK'; //菜单 - 点击菜单拉取消息
const EVENT_MENU_SCAN_PUSH = 'scancode_push'; //菜单 - 扫码推事件(客户端跳URL)
const EVENT_MENU_SCAN_WAITMSG = 'scancode_waitmsg'; //菜单 - 扫码推事件(客户端不跳URL)
const EVENT_MENU_PIC_SYS = 'pic_sysphoto'; //菜单 - 弹出系统拍照发图
const EVENT_MENU_PIC_PHOTO = 'pic_photo_or_album'; //菜单 - 弹出拍照或者相册发图
const EVENT_MENU_PIC_WEIXIN = 'pic_weixin'; //菜单 - 弹出微信相册发图器
const EVENT_MENU_LOCATION = 'location_select'; //菜单 - 弹出地理位置选择器
const EVENT_SEND_MASS = 'MASSSENDJOBFINISH'; //发送结果 - 高级群发完成
const EVENT_SEND_TEMPLATE = 'TEMPLATESENDJOBFINISH';//发送结果 - 模板消息发送结果
const EVENT_KF_SEESION_CREATE = 'kfcreatesession'; //多客服 - 接入会话
const EVENT_KF_SEESION_CLOSE = 'kfclosesession'; //多客服 - 关闭会话
const EVENT_KF_SEESION_SWITCH = 'kfswitchsession'; //多客服 - 转接会话
const EVENT_CARD_PASS = 'card_pass_check'; //卡券 - 审核通过
const EVENT_CARD_NOTPASS = 'card_not_pass_check'; //卡券 - 审核未通过
const EVENT_CARD_USER_GET = 'user_get_card'; //卡券 - 用户领取卡券
const EVENT_CARD_USER_DEL = 'user_del_card'; //卡券 - 用户删除卡券
- checkAuth($appid,$appsecret,$token) 此处传入公众后台高级接口提供的appid和appsecret, 或者手动指定$token为access_token。函数将返回access_token操作令牌
- resetAuth($appid='') 删除验证数据
- resetJsTicket($appid='') 删除JSAPI授权TICKET
- getJsTicket($appid='',$jsapi_ticket='') 获取JSAPI授权TICKET
- getJsSign($url, $timestamp=0, $noncestr='', $appid='') 获取JsApi使用签名信息数组,可只提供url地址
- createMenu($data) 创建菜单 $data菜单结构详见 自定义菜单创建接口
- getServerIp() 获取微信服务器IP地址列表 返回数组array('127.0.0.1','127.0.0.1')
- getMenu() 获取菜单
- deleteMenu() 删除菜单
- uploadMedia($data, $type) 上传临时素材,有效期为3天(注意上传大文件时可能需要先调用 set_time_limit(0) 避免超时)
- getMedia($media_id,$is_video=false) 获取临时素材(含接收到的音频、视频媒体文件)
- uploadForeverMedia($data, $type,$is_video=false,$video_info=array()) 上传永久素材,可以在公众平台官网素材管理模块中看到
- uploadForeverArticles($data) 上传永久图文素材
- updateForeverArticles($media_id,$data,$index=0) 修改永久图文素材(认证后的订阅号可用)
- getForeverMedia($media_id,$is_video=false) 获取永久素材
- delForeverMedia($media_id) 删除永久素材
- getForeverList($type,$offset,$count) 获取永久素材列表(认证后的订阅号可用)
- getForeverCount() 获取永久素材总数
- uploadMpVideo($data) 上传视频素材,当需要群发视频时,必须使用此方法得到的MediaID,否则无法显示
- uploadArticles($data) 上传图文消息素材
- sendMassMessage($data) 高级群发消息
- sendGroupMassMessage($data) 高级群发消息(全体或分组群发)
- deleteMassMessage($msg_id) 删除群发图文消息
- previewMassMessage($data) 预览群发消息
- queryMassMessage($msg_id) 查询群发消息发送状态
- getQRCode($scene_id,$type=0,$expire=1800) 获取推广二维码ticket字串
- getQRUrl($ticket) 获取二维码图片地址
- getShortUrl($long_url) 长链接转短链接接口
- getUserList($next_openid) 批量获取关注用户列表
- getUserInfo($openid) 获取关注者详细信息
- updateUserRemark($openid,$remark) 设置用户备注名
- getGroup() 获取用户分组列表
- getUserGroup($openid) 获取用户所在分组
- createGroup($name) 新增自定分组
- updateGroup($groupid,$name) 更改分组名称
- updateGroupMembers($groupid,$openid) 移动用户分组
- batchUpdateGroupMembers($groupid,$openid_list) 批量移动用户分组
- sendCustomMessage($data) 发送客服消息
- getOauthRedirect($callback,$state,$scope) 获取网页授权oAuth跳转地址
- getOauthAccessToken() 通过回调的code获取网页授权access_token
- getOauthRefreshToken($refresh_token) 通过refresh_token对access_token续期
- getOauthUserinfo($access_token,$openid) 通过网页授权的access_token获取用户资料
- getOauthAuth($access_token,$openid) 检验授权凭证access_token是否有效
- getSignature($arrdata,'sha1') 生成签名字串
- generateNonceStr($length=16) 获取随机字串
- setTMIndustry($id1,$id2='') 模板消息,设置所属行业
- addTemplateMessage($tpl_id) 模板消息,添加消息模板
- sendTemplateMessage($data) 发送模板消息
- 多客服接口:
- getCustomServiceMessage($data) 获取多客服会话记录
- transfer_customer_service($customer_account) 转发多客服消息
- getCustomServiceKFlist() 获取多客服客服基本信息
- getCustomServiceOnlineKFlist() 获取多客服在线客服接待信息
- createKFSession($openid,$kf_account,$text='') 创建指定多客服会话
- closeKFSession($openid,$kf_account,$text='') 关闭指定多客服会话
- getKFSession($openid) 获取用户会话状态
- getKFSessionlist($kf_account) 获取指定客服的会话列表
- getKFSessionWait() 获取未接入会话列表
- addKFAccount($account,$nickname,$password) 添加客服账号
- updateKFAccount($account,$nickname,$password) 修改客服账号信息
- deleteKFAccount($account) 删除客服账号
- setKFHeadImg($account,$imgfile) 上传客服头像
- querySemantic($uid,$query,$category,$latitude=0,$longitude=0,$city="",$region="") 语义理解接口 参数含义及返回的json内容请查看 微信语义理解接口
- getDatacube($type,$subtype,$begin_date,$end_date='') 获取统计数据 参数需注意$type与$subtype的定义
获取统计数据方法 参数定义
数据分类 | $type值(字符串) | 数据子分类 | $subtype值(字符串) | 时间跨度(天) |
---|---|---|---|---|
用户分析 | 'user' | 获取用户增减数据 | 'summary' | 7 |
用户分析 | 'user' | 获取累计用户数据 | 'cumulate' | 7 |
图文分析 | 'article' | 获取图文群发每日数据 | 'summary' | 1 |
图文分析 | 'article' | 获取图文群发总数据 | 'total' | 1 |
图文分析 | 'article' | 获取图文统计数据 | 'read' | 3 |
图文分析 | 'article' | 获取图文统计分时数据 | 'readhour' | 1 |
图文分析 | 'article' | 获取图文分享转发数据 | 'share' | 7 |
图文分析 | 'article' | 获取图文分享转发分时数据 | 'sharehour' | 1 |
消息分析 | 'upstreammsg' | 获取消息发送概况数据 | 'summary' | 7 |
消息分析 | 'upstreammsg' | 获取消息分送分时数据 | 'hour' | 1 |
消息分析 | 'upstreammsg' | 获取消息发送周数据 | 'week' | 30 |
消息分析 | 'upstreammsg' | 获取消息发送月数据 | 'month' | 30 |
消息分析 | 'upstreammsg' | 获取消息发送分布数据 | 'dist' | 15 |
消息分析 | 'upstreammsg' | 获取消息发送分布周数据 | 'distweek' | 30 |
消息分析 | 'upstreammsg' | 获取消息发送分布月数据 | 'distmonth' | 30 |
接口分析 | 'interface' | 获取接口分析数据 | 'summary' | 30 |
接口分析 | 'interface' | 获取接口分析分时数据 | 'summaryhour' | 1 |
需要注意 begin_date 和end_date 的差值需小于“最大时间跨度”(比如最大时间跨度为1时,begin_date 和end_date 的差值只能为0,才能小于1) |
- 卡券接口:
- createCard($data) 创建卡券
- updateCard($data) 修改卡券
- delCard($card_id) 删除卡券
- getCardInfo($card_id) 查询卡券详情
- getCardColors() 获取颜色列表
- getCardLocations() 拉取门店列表
- addCardLocations($data) 批量导入门店信息
- createCardQrcode($card_id) 生成卡券二维码
- consumeCardCode($code) 消耗 code
- decryptCardCode($encrypt_code) code 解码
- checkCardCode($code) 获取 code 的有效性
- getCardIdList($data) 批量查询卡列表
- updateCardCode($code,$card_id,$new_code) 更改 code
- unavailableCardCode($code,$card_id='') 设置卡券失效**(不可逆)**
- modifyCardStock($data) 库存修改
- activateMemberCard($data) 激活/绑定会员卡,参数结构请参看卡券开发文档(6.1.1 激活/绑定会员卡)章节
- updateMemberCard($data) 会员卡交易,参数结构请参看卡券开发文档(6.1.2 会员卡交易)章节
- updateLuckyMoney($code,$balance,$card_id='') 更新红包金额
- setCardTestWhiteList($openid=array(),$user=array()) 设置卡券测试白名单
- 摇一摇周边接口:
- applyShakeAroundDevice($data) 申请设备ID
- updateShakeAroundDevice($data) 编辑设备的备注信息
- searchShakeAroundDevice($data) 查询设备列表
- bindLocationShakeAroundDevice($device_id,$poi_id,$uuid='',$major=0,$minor=0) 配置设备与门店的关联关系
- bindPageShakeAroundDevice($device_id,$page_ids=array(),$bind=1,$append=1,$uuid='',$major=0,$minor=0) 配置设备与页面的关联关系
- uploadShakeAroundMedia($data) 上传在摇一摇页面展示的图片素材
- addShakeAroundPage($title,$description,$icon_url,$page_url,$comment='') 新增摇一摇出来的页面信息
- updateShakeAroundPage($page_id,$title,$description,$icon_url,$page_url,$comment='') 编辑摇一摇出来的页面信息
- searchShakeAroundPage($page_ids=array(),$begin=0,$count=1) 查询摇一摇已有的页面
- deleteShakeAroundPage($page_ids=array()) 删除摇一摇已有的页面,必须是未与设备关联的页面
- getShakeInfoShakeAroundUser($ticket) 获取摇周边的设备及用户信息
- deviceShakeAroundStatistics($device_id,$begin_date,$end_date,$uuid='',$major=0,$minor=0) 以设备为维度的数据统计接口
- pageShakeAroundStatistics($page_id,$begin_date,$end_date) 以页面为维度的数据统计接口
此扩展类库已经不再更新,原因是官方对公众号开放了众多接口,此类库继续维护的意义不大
非官方扩展API,需要配置公众平台账户和密码,能实现对已关注用户的点对点微信,此方式不保证长期有效。
类方法里提及的用户id在接口返回结构里表述为FakeId, 属同一概念, 在下面wechatauth类里则表示为Uin, 用户id对应的微信号必须通过getInfo()方法通过返回数组的Username值获取, 但非关注关系用户资料不能获取.
调用下列方法前必须经过login()方法和checkValid()验证方法才能获得调用权限. 有的账户无法通过登陆可能因为要求提供验证码, 可以手动登陆后把获取到的cookie写进程序存放cookie的文件解决.
程序使用了经过修改的snoopy兼容式HTTP类方法, 在类似BAE/SAE云服务器上可能不能正常运行, 因为云服务的curl方法是经过重写的, 某些header参数如网站来源参数不被支持.
- send($id,$content) 向某用户id发送微信文字信息
- sendNews($id,$msgid) 发送图文消息, 可通过getNewsList获取$msgid
- getUserList($page,$pagesize,$groupid) 获取用户信息
- getGroupList($page,$pagesize) 获取群组信息
- getNewsList($page,$pagesize) 获取图文信息列表
- uploadFile($filepath,$type) 上传附件,包括图片/音频/视频/缩略图
- getFileList($type,$page,$pagesize) 获取素材库文件列表
- sendImage($id,$fid) 发送图片消息
- sendAudio($id,$fid) 发送音频消息
- sendVideo($id,$fid) 发送视频消息
- getInfo($id) 根据id获取用户资料,注: 非关注关系用户资料不能获取
- getNewMsgNum($lastid) 获取从$lastid算起新消息的数目
- getTopMsg() 获取最新一条消息的数据, 此方法获取的消息id可以作为检测新消息的$lastid依据
- getMsg($lastid,$offset=0,$perpage=50,$day=0,$today=0,$star=0) 获取最新的消息列表, 列表将返回消息id, 用户id, 消息类型, 文字消息等参数
- 消息返回结构: {"id":"消息id","type":"类型号(1为文字,2为图片,3为语音)","fileId":"0","hasReply":"0","fakeId":"用户uid","nickName":"昵称","dateTime":"时间戳","content":"文字内容"}
- getMsgImage($msgid,$mode='large') 若消息type类型为2, 调用此方法获取图片数据
- getMsgVoice($msgid) 若消息type类型为3, 调用此方法获取语音数据
此扩展类库已经不再更新,原因是官方开放平台对网站应用开放的有授权登陆接口,更标准,更好用。请查看:微信开放平台
通过微信二维码登陆微信的API, 能实现第三方网站同步登陆, 首先程序分别通过get_login_code和get_code_image方法获取授权二维码图片, 然后利用微信手机客户端扫描二维码图片后将自动跳出授权页面, 用户点击授权后即可获取对应的用户资料和头像信息. 详细验证步骤请看test3.php例子.
- get_login_code() 获取登陆授权码, 通过授权码才能获取二维码
- get_code_image($code='') 将上面获取的授权码转换为图片二维码
- verify_code() 鉴定是否登陆成功,返回200为最终授权成功.
- get_login_info() 鉴定成功后调用此方法即可获取用户基本信息
- get_avatar($url) 获取用户头像图片数据
- logout() 注销登陆
此JS脚本已经废弃不再更新,原因是官方在微信6.0.2版本开放了全新的JSAPI接口,更全面好用。请查看:微信公众平台WIKI
- WeixinJS.hideOptionMenu() 隐藏右上角按钮
- WeixinJS.showOptionMenu() 显示右上角按钮
- WeixinJS.hideToolbar() 隐藏工具栏
- WeixinJS.showToolbar() 显示工具栏
- WeixinJS.getNetworkType() 获取网络状态
- WeixinJS.closeWindow() 关闭窗口
- WeixinJS.scanQRCode() 扫描二维码
- WeixinJS.openUrlByExtBrowser(url) 使用浏览器打开网址
- WeixinJS.jumpToBizProfile(username) 跳转到指定公众账号页面
- WeixinJS.sendEmail(title,content) 发送邮件
- WeixinJS.openProductView(latitude,longitude,name,address,scale,infoUrl) 查看地图
- WeixinJS.addContact(username) 添加微信账号
- WeixinJS.imagePreview(urls,current) 调出微信内图片预览
- WeixinJS.payCallback(appId,package,timeStamp,nonceStr,signType,paySign,callback) 微信JsApi支付接口
- WeixinJS.editAddress(appId,addrSign,timeStamp,nonceStr,callback) 微信JsApi支付接口
- 通过定义全局变量dataForWeixin配置触发分享的内容:
var dataForWeixin={
appId:"",
MsgImg:"消息图片路径",
TLImg:"时间线图路径",
url:"分享url路径",
title:"标题",
desc:"描述",
fakeid:"",
callback:function(){}
};
当调用API接口失败时,可以用此类来换取失败原因的中文说明。
注意:微信公众号引用errCode.php
,企业号引用qyerrCode.php
。
include "errCode.php"; //或 qyerrCode.php
$ret=ErrCode::getErrText(48001); //错误码可以通过公众号类库的公开变量errCode得到
if ($ret)
echo $ret;
else
echo "未找到对应的内容";
调用官方API,具有更灵活的消息分类响应方式,支持链式调用操作 ;
- 接入验证
- 自动回复(文本、图片、语音、视频、音乐、图文)
- 菜单操作(查询、创建、删除)
- 部门管理(创建、更新、删除、获取部门列表)
- 成员管理(创建、更新、删除、获取成员信息,获取部门成员列表)
- 标签管理(创建、更新、删除、获取成员、添加成员、删除成员,获取标签列表)
- 媒体文件管理(上传、获取)
- 二次验证
- OAuth2(生成授权url、获取成员信息)
- 获取企业微信服务器IP列表
- 微信JSAPI授权(获取ticket、获取签名)
$options = array(
'token'=>'tokenaccesskey', //填写应用接口的Token
'encodingaeskey'=>'encodingaeskey', //填写加密用的EncodingAESKey
'appid'=>'wxdk1234567890', //填写高级调用功能的app id
'appsecret'=>'xxxxxxxxxxxxxxxxxxx', //填写高级调用功能的密钥
'agentid'=>'1', //应用的id
'debug'=>false, //调试开关
'_logcallback'=>'logg', //调试输出方法,需要有一个string类型的参数
);
$weObj = new Wechat($options); //创建实例对象
//TODO:调用$weObj各实例方法
- valid() 验证连接,被动接口必须调用
- getRev() 获取微信服务器发来信息(不返回结果),被动接口必须调用
- getRevData() 返回微信服务器发来的信息(数组)
- getRevPostXml() 返回微信服务器发来的原始加密xml信息
- getRevFrom() 返回消息发送者的userid
- getRevTo() 返回消息接收者的id(即公众号id,一般与等同appid一致)
- getRevAgentID() 返回接收消息的应用id
- getRevType() 返回接收消息的类型
- getRevID() 返回消息id
- getRevCtime() 返回消息发送事件
- getRevContent() 返回消息内容正文(文本型消息)
- getRevPic() 返回图片信息(图片型信息) 返回数组{'mediaid'=>'','picurl'=>''}
- getRevGeo() 返回地理位置(位置型信息) 返回数组{'x'=>'','y'=>'','scale'=>'','label'=>''}
- getRevEventGeo() 返回事件地理位置(事件型信息) 返回数组{'x'=>'','y'=>'','precision'=>''}
- getRevEvent() 返回事件类型(事件型信息) 返回数组{'event'=>'','key'=>''}
- getRevScanInfo() 获取自定义菜单的扫码推事件信息,事件类型为
scancode_push
或scancode_waitmsg
返回数组array ('ScanType'=>'qrcode','ScanResult'=>'123123') - getRevSendPicsInfo() 获取自定义菜单的图片发送事件信息,事件类型为
pic_sysphoto
或pic_photo_or_album
或pic_weixin
数组结构见php文件内方法说明 - getRevSendGeoInfo() 获取自定义菜单的地理位置选择器事件推送,事件类型为
location_select
数组结构见php文件内方法说明 - getRevVoice() 返回语音信息(语音型信息) 返回数组{'mediaid'=>'','format'=>''}
- getRevVideo() 返回视频信息(视频型信息) 返回数组{'mediaid'=>'','thumbmediaid'=>''}
- text($text) 设置文本型消息,参数:文本内容
- image($mediaid) 设置图片型消息,参数:图片的media_id
- voice($mediaid) 设置语音型消息,参数:语音的media_id
- video($mediaid='',$title,$description) 设置视频型消息,参数:视频的media_id、标题、摘要
- news($newsData) 设置图文型消息,参数:数组。数组结构见php文件内方法说明
- image($mediaid) 设置图片型消息,参数:图片的media_id
- Message($msg = '',$append = false) 设置发送的消息(一般不需要调用这个方法)
- reply() 将已经设置好的消息,回复给微信服务器
////消息类型,使用实例调用getRevType()方法取得
const MSGTYPE_TEXT = 'text';
const MSGTYPE_IMAGE = 'image';
const MSGTYPE_LOCATION = 'location';
const MSGTYPE_LINK = 'link'; //暂不支持
const MSGTYPE_EVENT = 'event';
const MSGTYPE_MUSIC = 'music'; //暂不支持
const MSGTYPE_NEWS = 'news';
const MSGTYPE_VOICE = 'voice';
const MSGTYPE_VIDEO = 'video';
////事件类型,使用实例调用getRevEvent()方法取得
const EVENT_SUBSCRIBE = 'subscribe'; //订阅
const EVENT_UNSUBSCRIBE = 'unsubscribe'; //取消订阅
const EVENT_LOCATION = 'LOCATION'; //上报地理位置
const EVENT_ENTER_AGENT = 'enter_agent'; //用户进入应用
const EVENT_MENU_VIEW = 'VIEW'; //菜单 - 点击菜单跳转链接
const EVENT_MENU_CLICK = 'CLICK'; //菜单 - 点击菜单拉取消息
const EVENT_MENU_SCAN_PUSH = 'scancode_push'; //菜单 - 扫码推事件(客户端跳URL)
const EVENT_MENU_SCAN_WAITMSG = 'scancode_waitmsg'; //菜单 - 扫码推事件(客户端不跳URL)
const EVENT_MENU_PIC_SYS = 'pic_sysphoto'; //菜单 - 弹出系统拍照发图
const EVENT_MENU_PIC_PHOTO = 'pic_photo_or_album'; //菜单 - 弹出拍照或者相册发图
const EVENT_MENU_PIC_WEIXIN = 'pic_weixin'; //菜单 - 弹出微信相册发图器
const EVENT_MENU_LOCATION = 'location_select'; //菜单 - 弹出地理位置选择器
const EVENT_SEND_MASS = 'MASSSENDJOBFINISH'; //发送结果 - 高级群发完成
const EVENT_SEND_TEMPLATE = 'TEMPLATESENDJOBFINISH';//发送结果 - 模板消息发送结果
- checkAuth($appid='',$appsecret='',$token='') 通用auth验证方法,也用来换取ACCESS_TOKEN 。仅在需要手动指定access_token时才用
$token
- resetAuth($appid='') 清除记录的ACCESS_TOKEN
- resetJsTicket($appid='') 删除JSAPI授权TICKET
- getJsTicket($appid='',$jsapi_ticket='') 获取JSAPI授权TICKET
- getJsSign($url, $timestamp=0, $noncestr='', $appid='') 获取JsApi使用签名信息数组,可只提供url地址
- getSignature($arrdata,'sha1') 生成签名字串
- generateNonceStr($length=16) 获取随机字串
- createMenu($data,$agentid='') 创建菜单,参数:菜单内容数组,要创建菜单应用id
- getMenu($agentid='') 获取菜单内容,参数:要获取菜单内容的应用id
- deleteMenu($agentid='') 删除菜单,参数:要删除菜单的应用id
- uploadMedia($data, $type) 上传媒体文件,参数请看php文件内方法说明(注意上传大文件时可能需要先调用 set_time_limit(0) 避免超时)
- getMedia($media_id) 根据媒体文件ID获取媒体文件,参数:媒体id
- getServerIp() 获取企业微信服务器IP地址列表 返回数组array('127.0.0.1','127.0.0.1')
- createDepartment($data) 创建部门,参数: array("name"=>"邮箱产品组","parentid"=>"1","order" => "1")
- updateDepartment($data) 更新部门,参数: array("id"=>"1","name"=>"邮箱产品组","parentid"=>"1","order" => "1")
- deleteDepartment($id) 删除部门,参数:要删除的部门id
- moveDepartment($data) 移动部门,参数:array("department_id" => "5","to_parentid" => "2","to_position" => "1")
- getDepartment() 获取部门列表,返回部门数组。其中department部门列表数据。以部门的order字段从小到大排列
- createUser($data) 创建成员,参数请看php文件内方法说明
- updateUser($data) 更新成员,参数请看php文件内方法说明
- deleteUser($userid) 删除成员,参数:员工UserID
- deleteUsers($userids) 批量删除成员,参数:员工UserID数组
- getUserInfo($userid) 获取成员信息,参数:员工UserID
- getUserList($department_id,$fetch_child=0,$status=0) 获取部门成员,参数:部门id,是否递归获取子部门,获取类型。
0获取全部员工,1获取已关注成员列表,2获取禁用成员列表,4获取未关注成员列表。status可叠加
- getUserListInfo($department_id,$fetch_child=0,$status=0) 获取部门成员详情,参数同上
- getUserId($code,$agentid) 根据code获取员工UserID与手机设备号,参数:Oauth2.0或者二次验证返回的code值,跳转链接时所在的企业应用ID
- sendInvite($userid,$invite_tips='') 邀请成员关注
- createTag($data) 创建标签,参数:array("tagname" => "UI")
- updateTag($data) 更新标签,参数:array("tagid" => "1","tagname" => "UI")
- deleteTag($tagid) 删除标签,参数:标签TagID
- getTag($tagid) 获取标签成员,参数:标签TagID
- addTagUser($data) 增加标签成员,参数请看php文件内方法说明
- delTagUser($data) 删除标签成员,参数请看php文件内方法说明
- getTagList() 获取标签列表,返回标签数组
- sendMessage($data) 主动发送信息接口,参数请看php文件内方法说明
- authSucc($userid) 二次验证,参数: 员工UserID
- getOauthRedirect($callback,$state='STATE',$scope='snsapi_base') 组合授权跳转接口url
旧版微信支付类库(微信支付V2),已移动至old_version目录下。
自2014年8月开始申请到的微信支付都是V3接口,据官方说V2的会陆续升级为V3接口,但时间及升级渠道未确认。
- 获取access_token (初级权限)
- 调用地址组件 (支付权限)
- 生成订单签名数据 (支付权限)
- 订单成功回调 (支付权限)
- 发货通知 (支付权限)
- 支付订单查询 (支付权限)
备注:
初级权限:基本权限,任何正常的公众号都有此权限
菜单权限:正常的服务号、认证后的订阅号拥有此权限
认证权限:分为订阅号、服务号认证,如前缀服务号则仅认证的服务号有此权限,否则为认证后的订阅号、服务号都有此权限
支付权限:仅认证后的服务号可以申请此权限
$options = array(
'appid'=>'wxdk1234567890', //填写高级调用功能的app id, 请在微信开发模式后台查询
'appsecret'=>'xxxxxxxxxxxxxxxxxxx', //填写高级调用功能的密钥
'partnerid'=>'88888888', //财付通商户身份标识,支付权限专用,没有可不填
'partnerkey'=>'', //财付通商户权限密钥Key,支付权限专用
'paysignkey'=>'' //商户签名密钥Key,支付权限专用
);
$weObj = new Wechat($options); //创建实例对象
//TODO:调用$weObj各实例方法
- checkAuth($appid='',$appsecret='',$token='') 获取access_token。可根据appid和appsecret获取,或手动指定access_token
- resetAuth($appid='') 删除验证数据
- getSignature($arrdata,'sha1') 生成签名字串
- generateNonceStr($length=16) 获取随机字串
- createNativeUrl($productid) 生成原生支付url
- createPackage($out_trade_no,$body,$total_fee,$notify_url,$spbill_create_ip,$fee_type=1,$bank_type="WX",$input_charset="UTF-8",$time_start="",$time_expire="",$transport_fee="",$product_fee="",$goods_tag="",$attach="") 生成订单package字符串
- getPaySign($package, $timeStamp, $nonceStr) 支付签名(paySign)生成方法
- checkOrderSignature($orderxml='') 回调通知签名验证
- sendPayDeliverNotify($openid,$transid,$out_trade_no,$status=1,$msg='ok') 发货通知
- getPayOrder($out_trade_no) 查询订单信息
- setUserToken($user_token) 设置用户授权密钥
- getAddrSign($url, $timeStamp, $nonceStr, $user_token='') 获取收货地址JS的签名
为不同的开发框架进行适配缓存操作(保存access_token、jsapi_ticket),及输出调试日志。
由于微信api需要缓存access_token与jsapi_ticket,而在不同框架下的缓存方式不同,所以原先在Wechat.class.php和QYWechat.class.php中缓存代码做了TODO标志。 需要各位在使用不同框架时再进行修改,但确实很麻烦,因为对结构进行了修改。
取消了原先同步维护的Thinkphp版本,为Wechat类增加操作缓存3个重载方法
setCache
,getCache
,removeCache
,以及修改log
方法可以重载。 分别来实现在不同开发框架下的设置缓存、读取缓存、清除缓存、日志输出4个功能。
在不同的开发框架下使用Wechat类库,请继承Wechat类,根据需要实现这4个方法。
可参考Thinkphp版的TPWechat.class.php
为不同框架进行适配。
欢迎提交其他框架的适配文件到项目库来。
为Thinkphp进行适配的示例如下:
/**
* 微信公众平台PHP-SDK, ThinkPHP实例
* @author dodgepudding@gmail.com
* @link https://github.com/dodgepudding/wechat-php-sdk
* @version 1.2
* usage:
* $options = array(
* 'token'=>'tokenaccesskey', //填写你设定的key
* 'encodingaeskey'=>'encodingaeskey', //填写加密用的EncodingAESKey
* 'appid'=>'wxdk1234567890', //填写高级调用功能的app id
* 'appsecret'=>'xxxxxxxxxxxxxxxxxxx' //填写高级调用功能的密钥
* );
* $weObj = new TPWechat($options);
* $weObj->valid();
* ...
*
*/
class TPWechat extends Wechat
{
/**
* log overwrite
* @see Wechat::log()
*/
protected function log($log){
if ($this->debug) {
if (function_exists($this->logcallback)) {
if (is_array($log)) $log = print_r($log,true);
return call_user_func($this->logcallback,$log);
}elseif (class_exists('Log')) {
Log::write('wechat:'.$log, Log::DEBUG);
}
}
return false;
}
/**
* 重载设置缓存
* @param string $cachename
* @param mixed $value
* @param int $expired
* @return boolean
*/
protected function setCache($cachename,$value,$expired){
return S($cachename,$value,$expired);
}
/**
* 重载获取缓存
* @param string $cachename
* @return mixed
*/
protected function getCache($cachename){
return S($cachename);
}
/**
* 重载清除缓存
* @param string $cachename
* @return boolean
*/
protected function removeCache($cachename){
return S($cachename,null);
}
}
//test1.php
include "wechat.class.php";
$options = array(
'token'=>'tokenaccesskey', //填写你设定的key
'encodingaeskey'=>'encodingaeskey' //填写加密用的EncodingAESKey,如接口为明文模式可忽略
);
$weObj = new Wechat($options);
$weObj->valid();//明文或兼容模式可以在接口验证通过后注释此句,但加密模式一定不能注释,否则会验证失败
$type = $weObj->getRev()->getRevType();
switch($type) {
case Wechat::MSGTYPE_TEXT:
$weObj->text("hello, I'm wechat")->reply();
exit;
break;
case Wechat::MSGTYPE_EVENT:
break;
case Wechat::MSGTYPE_IMAGE:
break;
default:
$weObj->text("help info")->reply();
}
可参考test目录下的qydemo.php
include "wechat.class.php";
$options = array(
'token'=>'9Ixxxxxxx', //填写应用接口的Token
'encodingaeskey'=>'d4o9WVg8sxxxxxxxxxxxxxxxxxxxxxx',//填写加密用的EncodingAESKey
'appid'=>'wxa07979baxxxxxxxx', //填写高级调用功能的appid
);
$weObj = new Wechat($options);
$weObj->valid(); //注意, 企业号与普通公众号不同,必须打开验证,不要注释掉
$type = $weObj->getRev()->getRevType();
switch($type) {
case Wechat::MSGTYPE_TEXT:
$weObj->text("hello, I'm wechat")->reply();
exit;
break;
case Wechat::MSGTYPE_EVENT:
break;
case Wechat::MSGTYPE_IMAGE:
break;
default:
$weObj->text("help info")->reply();
}
// old_version/test/test2.php
include "wechatext.class.php";
function logdebug($text){
file_put_contents('./data/log.txt',$text."\n",FILE_APPEND);
};
$options = array(
'account'=>'demo@domain.com',
'password'=>'demo',
'datapath'=>'./data/cookie_',
'debug'=>true,
'logcallback'=>'logdebug'
);
$wechat = new Wechatext($options);
if ($wechat->checkValid()) {
// 获取用户信息
$data = $wechat->getInfo('3974255');
var_dump($data);
// 获取最新一条消息
$topmsg = $wechat->getTopMsg();
var_dump($topmsg);
// 主动回复消息
if ($topmsg && $topmsg['has_reply']==0)
$wechat->send($topmsg['fakeid'],'hi '.$topmsg['nick_name'].',rev:'.$topmsg['content']);
}
// old_version/test/test3.php
include "../wechatauth.class.php";
session_start();
$sid = session_id();
$options = array(
'account'=>$sid,
'datapath'=>'../data/cookiecode_',
);
$wechat = new Wechatauth($options);
if (isset($_POST['code'])) {
$logincode = $_POST['code'];
$vres = $wechat->set_login_code($logincode)->verify_code();
if ($vres===false) {
$result = array('status'=>0);
} else {
$result = array('status'=>$vres);
if ($vres==200) {
$result['info'] = $wechat->get_login_info();
$result['cookie'] = $wechat->get_login_cookie(true);
}
}
die(json_encode($result));
}
$logincode = $wechat->get_login_code(); //获取授权码
$qrimg = $wechat->get_code_image(); //待输出的二维码图片
HTML部分请看old_version/test/test3.php, 主要是定时ajax查询是否已经授权成功
请看test/jsapi目录
This is licensed under the GNU LGPL, version 2.1 or later.
For details, see: http://creativecommons.org/licenses/LGPL/2.1/