• Home
• Wechat

PHP Class Wechat

Datei anzeigen Open project: dodgepudding/wechat-php-sdk Class Usage Examples

Public Properties

Property	Type	Description
$DATACUBE_URL_ARR		数据分析接口
$debug
$errCode
$errMsg
$logcallback

Public Methods

Method	Description
Message ( array $msg = '', boolean $append = false )	设置发送消息
__construct ( $options )
activateMemberCard ( string $data ) : boolean	激活/绑定会员卡
addCardLocations ( array $data ) : boolean | string	批量导入门店信息
addKFAccount ( string $account, string $nickname, string $password ) : boolean | array	添加客服账号
addShakeAroundPage ( string $title, string $description, sting $icon_url, string $page_url, string $comment = '' ) : boolean | mixed	[addShakeAroundPage 增加摇一摇出来的页面信息，包括在摇一摇页面出现的主标题、副标题、图片和点击进去的超链接。]
addTagUser ( array $data ) : boolean | array	增加标签成员
addTemplateMessage ( string $tpl_id ) : boolean | string	模板消息 添加消息模板 成功返回消息模板的调用id
addconditionalMenu ( array $data ) : boolean	创建个性化菜单(认证后的订阅号可用)
applyShakeAroundDevice ( array $data ) : boolean | mixed	申请设备ID [applyShakeAroundDevice 申请配置设备所需的UUID、Major、Minor。 若激活率小于50%，不能新增设备。单次新增设备超过500 个，需走人工审核流程。 审核通过后，可用迒回的批次ID 用“查询设备列表”接口拉取本次申请的设备ID]
authSucc ( $userid ) : boolean | array	二次验证 企业在开启二次验证时，必须填写企业二次验证页面的url。 当员工绑定通讯录中的帐号后，会收到一条图文消息， 引导员工到企业的验证页面验证身份，企业在员工验证成功后， 调用如下接口即可让员工关注成功。
batchUpdateGroupMembers ( integer $groupid, string $openid_list ) : boolean | array	批量移动用户分组
bindLocationShakeAroundDevice ( string $device_id, integer $poi_id, string $uuid = '', integer $major, integer $minor ) : boolean | mixed	[bindLocationShakeAroundDevice 配置设备与门店的关联关系]
bindPageShakeAroundDevice ( string $device_id, array $page_ids = [], number $bind = 1, number $append = 1, string $uuid = '', integer $major, integer $minor ) : boolean | mixed	[bindPageShakeAroundDevice 配置设备与页面的关联关系。 支持建立或解除关联关系，也支持新增页面或覆盖页面等操作。 配置完成后，在此设备的信号范围内，即可摇出关联的页面信息。 若设备配置多个页面，则随机出现页面信息]
checkAuth ( string $appid = '', string $appsecret = '', string $token = '' )	通用auth验证方法
checkCardCode ( string $code ) : boolean | array	查询 code 的有效性（非自定义 code）
closeKFSession ( string $openid, string $kf_account, string $text = '' ) : boolean | array	关闭指定多客服会话
closeOrder ( string $order_id ) : boolean	关闭订单
consumeCardCode ( string $code, string $card_id = '' ) : boolean | array	消耗 code 自定义 code（use_custom_code 为 true）的优惠券，在 code 被核销时，必须调用此接口。
createCard ( Array $data ) : array | boolean	创建卡券
createCardQrcode ( $card_id, string $code = '', string $openid = '', integer $expire_seconds, boolean $is_unique_code = false, string $balance = '' ) : boolean | string	生成卡券二维码 成功则直接返回ticket值，可以用 getQRUrl($ticket) 换取二维码url
createDepartment ( array $data ) : boolean | array	创建部门
createGroup ( string $name ) : boolean | array	新增自定分组
createKFSession ( string $openid, string $kf_account, string $text = '' ) : boolean | array	创建指定多客服会话
createMenu ( array $data )	创建菜单(认证后的订阅号可用)
createMenu ( array $data, $agentid = '' )	创建菜单
createTag ( array $data ) : boolean | array	创建标签
createUser ( array $data ) : boolean | array	创建成员
data_to_xml ( mixed $data ) : string	数据XML编码
decryptCardCode ( string $encrypt_code ) : boolean | array	code 解码
delCard ( string $card_id ) : boolean	删除卡券 允许商户删除任意一类卡券。删除卡券后，该卡券对应已生成的领取用二维码、添加到卡包 JS API 均会失效。 注意：删除卡券不能删除已被用户领取，保存在微信客户端中的卡券，已领取的卡券依旧有效。
delForeverMedia ( string $media_id ) : boolean	删除永久素材(认证后的订阅号可用)
delTagUser ( array $data ) : boolean | array	删除标签成员
delconditionalMenu ( $data ) : boolean	删除个性化菜单(认证后的订阅号可用)
deleteDepartment ( $id ) : boolean | array	删除部门
deleteKFAccount ( string $account ) : boolean | array	删除客服账号
deleteMassMessage ( integer $msg_id ) : boolean | array	高级群发消息, 删除群发图文消息(认证后的订阅号可用)
deleteMenu ( ) : boolean	删除菜单(认证后的订阅号可用)
deleteMenu ( $agentid = '' ) : boolean	删除菜单
deleteShakeAroundPage ( array $page_ids = [] ) : boolean | mixed	[deleteShakeAroundPage 删除已有的页面，包括在摇一摇页面出现的主标题、副标题、图片和点击进去的超链接。 只有页面与设备没有关联关系时，才可被删除。]
deleteTag ( $tagid ) : boolean | array	删除标签
deleteUser ( $userid ) : boolean | array	删除成员
deleteUsers ( $userids ) : boolean | array	批量删除成员
deviceShakeAroundStatistics ( integer $device_id, integer $begin_date, integer $end_date, string $uuid = '', integer $major, integer $minor ) : boolean | mixed	[deviceShakeAroundStatistics 以设备为维度的数据统计接口。 查询单个设备进行摇周边操作的人数、次数，点击摇周边消息的人数、次数；查询的最长时间跨度为30天。]
generateNonceStr ( number $length = 16 ) : string	生成随机字串
getCardColors ( ) : boolean | array	获取颜色列表 获得卡券的最新颜色列表，用于创建卡券
getCardIdList ( $offset, $count = 50 ) : boolean | array	批量查询卡列表
getCardInfo ( string $card_id ) : boolean | array	查询卡券详情
getCardLocations ( integer $offset, integer $count ) : boolean | array	拉取门店列表 获取在公众平台上申请创建的门店列表
getCardSign ( string $card_type = '', string $card_id = '', $code = '', string $location_id = '', string $timestamp, string $noncestr = '', string $appid = '' ) : array | boolean	获取卡券签名cardSign
getCustomServiceKFlist ( ) : boolean | array	获取多客服客服基本信息
getCustomServiceMessage ( array $data ) : boolean | array	获取多客服会话记录
getCustomServiceOnlineKFlist ( ) : boolean | array	获取多客服在线客服接待信息
getDatacube ( string $type, string $subtype, string $begin_date, string $end_date = '' ) : boolean | array	获取统计数据
getDepartment ( ) : boolean | array	获取部门列表
getForeverCount ( ) : boolean | array	获取永久素材总数(认证后的订阅号可用)
getForeverList ( string $type, integer $offset, integer $count ) : boolean | array	获取永久素材列表(认证后的订阅号可用)
getForeverMedia ( string $media_id, boolean $is_video = false ) : boolean | array | raw	获取永久素材(认证后的订阅号可用) 返回图文消息数组或二进制数据，失败返回false
getGroup ( ) : boolean | array	获取用户分组列表
getJsCardTicket ( string $appid = '', string $api_ticket = '' )	获取微信卡券api_ticket
getJsSign ( string $url, string $timestamp, string $noncestr = '', string $appid = '' ) : array | boolean	获取JsApi使用签名
getJsTicket ( string $appid = '', string $jsapi_ticket = '' )	获取JSAPI授权TICKET
getKFSession ( string $openid ) : boolean | array	获取用户会话状态
getKFSessionWait ( ) : boolean | array	获取未接入会话列表
getKFSessionlist ( $kf_account ) : boolean | array	获取指定客服的会话列表
getMedia ( string $media_id ) : raw	根据媒体文件ID获取媒体文件
getMedia ( string $media_id, boolean $is_video = false ) : raw	获取临时素材(认证后的订阅号可用)
getMenu ( ) : array('menu'=>array(....s))	获取菜单(认证后的订阅号可用)
getMenu ( $agentid = '' ) : array('menu'=>array(....s))	获取菜单
getOauthAccessToken ( ) : array	通过code获取Access Token
getOauthAuth ( string $access_token, string $openid ) : boolean	检验授权凭证是否有效
getOauthRedirect ( string $callback, $state = '', $scope = 'snsapi_userinfo' ) : string	oauth 授权跳转接口
getOauthRedirect ( string $callback, string $state = 'STATE', $scope = 'snsapi_base' ) : string	oauth 授权跳转接口
getOauthRefreshToken ( string $refresh_token ) : boolean | mixed	刷新access token并续期
getOauthUserinfo ( string $access_token, string $openid ) : array	获取授权后的用户资料
getOrderByFilter ( integer $status = null, integer $begintime = null, integer $endtime = null ) : order	根据订单状态/创建时间获取订单详情
getOrderByID ( string $order_id ) : order	根据订单ID获取订单详情
getQRCode ( integer | string $scene_id, integer $type, integer $expire = 604800 ) : array('ticket'=>'qrcode字串','expire_seconds'=>604800,'url'=>'二维码图片解析后的地址')	创建二维码ticket
getQRUrl ( string $ticket ) : string	获取二维码图片
getRev ( )	获取微信服务器发来的信息
getRevAgentID ( )	获取接收消息的应用id
getRevCardDel ( ) : array | boolean	获取卡券事件推送 - 删除卡券 当Event为 user_del_card(用户删除卡券)
getRevCardGet ( ) : array | boolean	获取卡券事件推送 - 领取卡券 当Event为 user_get_card(用户领取卡券)
getRevCardPass ( ) : string | boolean	获取卡券事件推送 - 卡卷审核是否通过 当Event为 card_pass_check(审核通过) 或 card_not_pass_check(未通过)
getRevContent ( )	获取接收消息内容正文
getRevCtime ( )	获取消息发送时间
getRevData ( )	获取微信服务器发来的信息
getRevEvent ( )	获取接收事件推送
getRevEventGeo ( )	获取上报地理位置事件
getRevFrom ( )	获取消息发送者
getRevGeo ( )	获取接收地理位置
getRevID ( )	获取消息ID
getRevKFClose ( ) : string | boolean	获取多客服会话状态推送事件 - 关闭会话 当Event为 kfclosesession 即关闭会话
getRevKFCreate ( ) : string | boolean	获取多客服会话状态推送事件 - 接入会话 当Event为 kfcreatesession 即接入会话
getRevKFSwitch ( ) : array | boolean	获取多客服会话状态推送事件 - 转接会话 当Event为 kfswitchsession 即转接会话
getRevLink ( )	获取接收消息链接
getRevOrderId ( ) : orderId | boolean	获取订单ID - 订单付款通知 当Event为 merchant_order(订单付款通知)
getRevOrderSkuInfo ( ) : array | boolean	获取订单SkuInfo - 订单付款通知 当Event为 merchant_order(订单付款通知)
getRevPic ( )	获取接收消息图片
getRevPostXml ( )	获取微信服务器发来的原始加密信息
getRevResult ( )	获取群发或模板消息发送结果 当Event为 MASSSENDJOBFINISH 或 TEMPLATESENDJOBFINISH，即高级群发/模板消息
getRevScanInfo ( )	获取自定义菜单的扫码推事件信息
getRevSceneId ( )	获取二维码的场景值
getRevSendGeoInfo ( )	获取自定义菜单的地理位置选择器事件推送
getRevSendPicsInfo ( )	获取自定义菜单的图片发送事件信息
getRevStatus ( )	获取模板消息发送状态
getRevTicket ( )	获取接收TICKET
getRevTo ( )	获取消息接受者
getRevTplMsgID ( )	获取主动推送的消息ID 经过验证，这个和普通的消息MsgId不一样 当Event为 MASSSENDJOBFINISH 或 TEMPLATESENDJOBFINISH
getRevType ( )	获取接收消息的类型
getRevVideo ( )	获取接收视频推送
getRevVoice ( )	获取接收语音推送
getServerIp ( ) : '127.0.0.1')\array('127.0.0.1'	获取企业微信服务器IP地址列表
getShakeInfoShakeAroundUser ( string $ticket ) : boolean | mixed	[getShakeInfoShakeAroundUser 获取设备信息，包括UUID、major、minor，以及距离、openID 等信息。]
getShortUrl ( string $long_url ) : boolean | string	长链接转短链接接口
getSignature ( array $arrdata, string $method = "sha1" ) : boolean | string	获取签名
getTag ( $tagid ) : boolean | array	获取标签成员
getTagList ( ) : boolean | array	获取标签列表
getTicketSignature ( array $arrdata, string $method = "sha1" ) : boolean | string	获取微信卡券签名
getUserCardList ( string $openid, string $card_id ) : boolean | array	获取用户已领取卡券接口
getUserGroup ( string $openid ) : boolean | integer	获取用户所在分组
getUserId ( $code, $agentid ) : boolean | array	根据code获取成员信息 通过Oauth2.0或者设置了二次验证时获取的code，用于换取成员的UserId和DeviceId
getUserInfo ( string $openid, string $lang = 'zh_CN' ) : array	获取关注者详细信息
getUserInfo ( $userid ) : boolean | array	获取成员信息
getUserList ( unknown $next_openid = '' )	批量获取关注用户列表
getUserList ( $department_id, $fetch_child, $status ) : boolean | array	获取部门成员
getUserListInfo ( $department_id, $fetch_child, $status ) : boolean | array	获取部门成员详情
getUsersInfo ( array $openids ) : array	批量获取关注者详细信息
image ( string $mediaid = '' )	设置回复消息 Example: $obj->image('media_id')->reply();
json_encode ( array $arr )	微信api不支持中文转义的json结构
modifyCardStock ( string $data ) : boolean	库存修改
moveDepartment ( $data ) : boolean | array	移动部门
music ( string $title, string $desc, string $musicurl, string $hgmusicurl = '', string $thumbmediaid = '' )	设置回复音乐
news ( array $newsData = [] )	设置回复图文
pageShakeAroundStatistics ( integer $page_id, integer $begin_date, integer $end_date ) : boolean | mixed	[pageShakeAroundStatistics 以页面为维度的数据统计接口。 查询单个页面通过摇周边摇出来的人数、次数，点击摇周边页面的人数、次数；查询的最长时间跨度为30天。]
previewMassMessage ( array $data ) : boolean | array	高级群发消息, 预览群发消息(认证后的订阅号可用) 注意：视频需要在调用uploadMedia()方法后，再使用 uploadMpVideo() 方法生成， 然后获得的 mediaid 才能用于群发，且消息类型为 mpvideo 类型。
queryMassMessage ( integer $msg_id ) : boolean | array	高级群发消息, 查询群发消息发送状态(认证后的订阅号可用)
querySemantic ( String $uid, String $query, String $category, Float $latitude, Float $longitude, String $city = "", String $region = "" ) : boolean | array	语义理解接口
reply ( string $msg = [], boolean $return = false )	回复微信服务器, 此函数支持链式操作 Example: $this->text('msg tips')->reply();
resetAuth ( string $appid = '' )	删除验证数据
resetJsTicket ( string $appid = '' )	删除JSAPI授权TICKET
searchShakeAroundDevice ( array $data ) : boolean | mixed	查询设备列表 [searchShakeAroundDevice 查询已有的设备ID、UUID、Major、Minor、激活状态、备注信息、关联门店、关联页面等信息。 可指定设备ID 或完整的UUID、Major、Minor 查询，也可批量拉取设备信息列表。]
searchShakeAroundPage ( array $page_ids = [], integer $begin, integer $count = 1 ) : boolean | mixed	[searchShakeAroundPage 查询已有的页面，包括在摇一摇页面出现的主标题、副标题、图片和点击进去的超链接。 提供两种查询方式，①可指定页面ID 查询，②也可批量拉取页面列表。]
sendCustomMessage ( array $data ) : boolean | array	发送客服消息
sendGroupMassMessage ( array $data ) : boolean | array	高级群发消息, 根据群组id群发图文消息(认证后的订阅号可用) 注意：视频需要在调用uploadMedia()方法后，再使用 uploadMpVideo() 方法生成， 然后获得的 mediaid 才能用于群发，且消息类型为 mpvideo 类型。
sendInvite ( $userid, $invite_tips = '' ) : boolean | array	邀请成员关注 向未关注企业号的成员发送关注邀请。认证号优先判断顺序weixinid>手机号>邮箱绑定>邮件；非认证号只能邮件邀请
sendMassMessage ( array $data ) : boolean | array	高级群发消息, 根据OpenID列表群发图文消息(订阅号不可用) 注意：视频需要在调用uploadMedia()方法后，再使用 uploadMpVideo() 方法生成， 然后获得的 mediaid 才能用于群发，且消息类型为 mpvideo 类型。
sendMessage ( array $data ) : boolean | array	主动发送信息接口
sendTemplateMessage ( array $data ) : boolean | array	发送模板消息
setCardTestWhiteList ( string $openid = [], string $user = [] ) : boolean	设置卡券测试白名单
setFuncFlag ( $flag )	设置消息的星标标志，官方已取消对此功能的支持
setKFHeadImg ( string $account, string $imgfile ) : boolean | array	上传客服头像
setOrderDelivery ( string $order_id, integer $need_delivery, string $delivery_company = null, string $delivery_track_no = null, integer $is_others ) : boolean	设置订单发货信息
setTMIndustry ( integer $id1, integer $id2 = '' ) : boolean | array	模板消息 设置所属行业
text ( string $text = '' )	设置回复消息 Example: $obj->text('hello')->reply();
transfer_customer_service ( string $customer_account = '' )	转发多客服消息 Example: $obj->transfer_customer_service($customer_account)->reply();
trymatchMenu ( $data ) : boolean | array('button'=>array(....s))	测试个性化菜单匹配结果(认证后的订阅号可用)
unavailableCardCode ( string $code, string $card_id = '' ) : boolean	设置卡券失效 设置卡券失效的操作不可逆
updateCard ( string $data ) : boolean	更改卡券信息 调用该接口更新信息后会重新送审，卡券状态变更为待审核。已被用户领取的卡券会实时更新票面信息。
updateCardCode ( string $code, string $card_id, string $new_code ) : boolean	更改 code 为确保转赠后的安全性，微信允许自定义code的商户对已下发的code进行更改。 注：为避免用户疑惑，建议仅在发生转赠行为后（发生转赠后，微信会通过事件推送的方式告知商户被转赠的卡券code）对用户的code进行更改。
updateDepartment ( array $data ) : boolean | array	更新部门
updateForeverArticles ( string $media_id, array $data, integer $index ) : boolean | array	修改永久图文素材(认证后的订阅号可用) 永久素材也可以在公众平台官网素材管理模块中看到
updateGroup ( integer $groupid, string $name ) : boolean | array	更改分组名称
updateGroupMembers ( integer $groupid, string $openid ) : boolean | array	移动用户分组
updateKFAccount ( string $account, string $nickname, string $password ) : boolean | array	修改客服账号信息
updateLuckyMoney ( string $code, $balance, string $card_id = '' ) : boolean | array	更新红包金额
updateMeetingCard ( string $data ) : boolean	更新门票
updateMemberCard ( string $data ) : boolean | array	会员卡交易 会员卡交易后每次积分及余额变更需通过接口通知微信，便于后续消息通知及其他扩展功能。
updateShakeAroundDevice ( array $data ) : boolean	编辑设备信息 [updateShakeAroundDevice 编辑设备的备注信息。可用设备ID或完整的UUID、Major、Minor指定设备，二者选其一。]
updateShakeAroundPage ( integer $page_id, string $title, string $description, sting $icon_url, string $page_url, string $comment = '' ) : boolean | mixed	[updateShakeAroundPage 编辑摇一摇出来的页面信息，包括在摇一摇页面出现的主标题、副标题、图片和点击进去的超链接。]
updateTag ( array $data ) : boolean | array	更新标签
updateUser ( array $data ) : boolean | array	更新成员
updateUserRemark ( string $openid, string $remark ) : boolean | array	设置用户备注名
uploadArticles ( array $data ) : boolean | array	上传图文消息素材，用于群发(认证后的订阅号可用)
uploadForeverArticles ( array $data ) : boolean | array	上传永久图文素材(认证后的订阅号可用) 新增的永久素材也可以在公众平台官网素材管理模块中看到
uploadForeverMedia ( array $data, $type, boolean $is_video = false, array $video_info = [] ) : boolean | array	上传永久素材(认证后的订阅号可用) 新增的永久素材也可以在公众平台官网素材管理模块中看到 注意：上传大文件时可能需要先调用 set_time_limit(0) 避免超时 注意：数组的键值任意，但文件名前必须加@，使用单引号以避免本地路径斜杠被转义
uploadImg ( array $data ) : boolean | array	上传图片，本接口所上传的图片不占用公众号的素材库中图片数量的5000个的限制。图片仅支持jpg/png格式，大小必须在1MB以下。 (认证后的订阅号可用) 注意：上传大文件时可能需要先调用 set_time_limit(0) 避免超时 注意：数组的键值任意，但文件名前必须加@，使用单引号以避免本地路径斜杠被转义
uploadMedia ( array $data, $type ) : boolean | array	上传多媒体文件 (只有三天的有效期，过期自动被删除) 注意：上传大文件时可能需要先调用 set_time_limit(0) 避免超时 注意：数组的键值任意，但文件名前必须加@，使用单引号以避免本地路径斜杠被转义
uploadMpVideo ( array $data ) : boolean | array	上传视频素材(认证后的订阅号可用)
uploadShakeAroundMedia ( array $data ) : boolean | array	上传在摇一摇页面展示的图片素材 注意：数组的键值任意，但文件名前必须加@，使用单引号以避免本地路径斜杠被转义
valid ( boolean $return = false )	微信验证，包括post来的xml解密
video ( string $mediaid = '', $title = '', $description = '' )	设置回复消息 Example: $obj->video('media_id','title','description')->reply();
voice ( string $mediaid = '' )	设置回复消息 Example: $obj->voice('media_id')->reply();
xmlSafeStr ( $str )
xml_encode ( mixed $data, string $root = 'xml', string $item = 'item', string $attr = '', string $id = 'id', string $encoding = 'utf-8' ) : string	XML编码

Protected Methods

Method	Description
getCache ( string $cachename ) : mixed	获取缓存，按需重载
log ( $log )
log ( mixed $log ) : mixed	日志记录，可被重载。
removeCache ( string $cachename ) : boolean	清除缓存，按需重载
setCache ( string $cachename, mixed $value, integer $expired ) : boolean	设置缓存，按需重载

Private Methods

Method	Description
_auto_text_filter ( string $text ) : string | mixed	过滤文字回复\r\n换行符
checkSignature ( $str )	For weixin server validation
generate ( $encrypt, $signature, $timestamp, $nonce )
http_get ( string $url )	GET 请求
http_post ( string $url, array $param, boolean $post_file = false ) : string	POST 请求
parseSkuInfo ( $skuInfo )

Method Details

Property Details