Property | Type | Description | |
---|---|---|---|
$appId | 开发者中心-配置项-AppID(应用ID) | ||
$appSecret | 开发者中心-配置项-AppSecret(应用密钥) | ||
$get_access_token_diy | callable | 用户自定义获取access_token的方法 | |
$get_jsapi_ticket_diy | callable | 用户自定义获取jsapi_ticket的方法 | |
$key | API密钥,微信商户平台(pay.weixin.qq.com)-->账户设置-->API安全-->密钥设置 | ||
$mchId | 微信支付商户号,商户申请微信支付后,由微信支付分配的商户收款账号 | ||
$save_access_token_diy | callable | 用户自定义保存access_token的方法 | |
$save_jsapi_ticket_diy | callable | 用户自定义保存jsapi_ticket的方法 |
Method | Description | |
---|---|---|
__construct ( array $config ) | 设定配置项 | |
add_kf ( string $kf_account, string $nickname, string $password ) : array(err, | 添加客服账号 | |
add_material ( string $type, string $path, string $title = '', string $introduction = '' ) : array(err, | 新增永久素材 | |
add_news ( array $articles ) : array(err, | 新增永久图文素材 | |
batchupdate_user_group ( array $open_id_arr, integer $to_groupid ) : array(err, | 用户分组管理 - 批量移动用户分组 | |
close_kf_session ( string $openid, string $kf_account, string $text = '' ) : array(err, | 关闭客户与客服的会话 | |
create_group ( string $group_name ) : array(err, | 用户分组管理 - 创建分组 | |
create_kf_session ( string $openid, string $kf_account, string $text = '' ) : array(err, | 创建客户与客服的会话 | |
create_menu ( string $json ) : array(err, | 自定义菜单创建接口 | |
create_qrcode ( $scene_id, $expire_seconds ) : array(err, | 生成带参数的二维码 | |
del_kf ( string $kf_account ) : array(err, | 删除客服帐号 | |
del_material ( string $media_id ) : array(err, | 删除永久素材 | |
delete_group ( integer $group_id ) : array(err, | 用户分组管理 - 删除分组 | |
delete_menu ( ) : array(err, | 自定义菜单删除接口 | |
download_media ( string $media_id ) : array(err, | 下载临时素材 | |
getWxPayJsApiParameters ( string $prepayId ) : string | 微信支付 - 获取jsapi支付的参数 用于直接填入js函数作为参数 | |
get_access_token ( ) : string | 获取access_token | |
get_authorize_url ( string $scope, string $redirect_uri, string $state = '' ) : string | 得到获取用户授权需要打开的页面链接 | |
get_groups ( ) : array(err, | 用户分组管理 - 查询所有分组 | |
get_jsapi_config ( string $url = '', string $type = '', $jsonp_callback = 'callback' ) : mixed | JS-SDK 获取JS-SDK配置需要的信息 | |
get_jsapi_ticket ( ) : string | JS-SDK 获取jsapi_ticket | |
get_kf_list ( ) : array(err, | 获取所有客服账号 | |
get_kf_records ( integer $starttime, integer $endtime, integer $pageindex, integer $pagesize ) : array(err, | 获取客服聊天记录接口 | |
get_kf_session ( string $openid ) : array(err, | 获取客户的会话状态 | |
get_kf_session_list ( string $kf_account ) : array(err, | 获取客服的会话列表 | |
get_material ( string $media_id ) : array(err, | 获取永久素材 | |
get_material_count ( ) : array(err, | 获取素材总数 | |
get_materials ( string $type, string $offset, string $count ) : array(err, | 获取素材列表 | |
get_media ( string $media_id ) : string | 获取临时素材URL | |
get_menu ( ) : array(err, | 自定义菜单查询接口 | |
get_online_kf_list ( ) : array(err, | 获取在线客服接待信息 | |
get_qrcode ( $ticket ) : string | 通过ticket换取二维码,返回二维码图片的内容 | |
get_qrcode_url ( $ticket ) : string | 通过ticket换取二维码,返回二维码url地址 | |
get_selfmenu ( ) : array(err, | 获取自定义菜单配置接口 | |
get_user_group ( string $open_id ) : array(err, | 用户分组管理 - 查询用户所在分组 | |
get_user_info ( string $open_id, string $lang = '' ) : array(err, | 获取用户基本信息 | |
get_user_list ( string $next_openid = '' ) : array(err, | 获取用户列表 | |
get_userinfo_by_authorize ( $scope, string $lang = 'zh_CN' ) : array | object | 获取用户授权后回调页面根据获取到的code,获取用户信息 注:本函数将获取access_token和拉取用户信息集成在了一起,未对获取到的access_token进行保存 | |
get_waitcase_list ( ) : array(err, | 获取未接入会话列表的客户 | |
new_access_token ( ) : mixed | 生成新的access_token | |
new_jsapi_ticket ( ) : mixed | JS-SDK 生成一个新的jsapi_ticket | |
progressWxPayNotify ( ) : array | 处理微信支付异步通知 | |
replyWxPayNotify ( array $info ) | 回复微信异步通知 | |
send ( string $openid, array $msg ) : array(err, | 发送客服消息(文本、图片、语音、视频、音乐、图文) | |
set_kf_avatar ( string $kf_account, string $path ) : array(err, | 上传客服头像 | |
shorturl ( $long_url ) : array(err, | 长链接转短链接接口 | |
update_group ( integer $group_id, string $group_name ) : array(err, | 用户分组管理 - 修改分组名 | |
update_kf ( string $kf_account, string $nickname, string $password ) : array(err, | 设置客服信息 | |
update_news ( string $media_id, string $article, string $index ) : array(err, | 修改永久图文素材 | |
update_user_group ( string $open_id, integer $to_groupid ) : array(err, | 用户分组管理 - 移动用户分组 | |
update_user_remark ( string $open_id, string $remark ) : array(err, | 设置用户备注名 | |
upload_media ( string $type, string $path ) : array(err, | 新增临时素材 | |
valid_access_token ( string $token ) : boolean | 校验access_token是否过期 | |
valid_jsapi_ticket ( object $ticket ) : boolean | JS-SDK 校验jsapi_ticket是否过期 | |
wxPayUnifiedOrder ( string $openid, array $conf = [] ) : boolean | mixed | 微信支付 - 生成预订单 |
public batchupdate_user_group ( array $open_id_arr, integer $to_groupid ) : array(err, | ||
$open_id_arr | array | |
$to_groupid | integer | |
return | array(err, |
public create_group ( string $group_name ) : array(err, | ||
$group_name | string | [分组名字(30个字符以内)] |
return | array(err, |
public create_qrcode ( $scene_id, $expire_seconds ) : array(err, | ||
return | array(err, |
public del_material ( string $media_id ) : array(err, | ||
$media_id | string | 要删除的素材的media_id |
return | array(err, |
public delete_group ( integer $group_id ) : array(err, | ||
$group_id | integer | |
return | array(err, |
public download_media ( string $media_id ) : array(err, | ||
$media_id | string | 媒体文件ID |
return | array(err, |
public getWxPayJsApiParameters ( string $prepayId ) : string | ||
$prepayId | string | 预生成订单ID |
return | string |
public get_authorize_url ( string $scope, string $redirect_uri, string $state = '' ) : string | ||
$scope | string | 应用授权作用域 `snsapi_base` 不弹出授权页面,直接跳转,只能获取用户openid `snsapi_userinfo` 弹出授权页面,可通过openid拿到昵称、性别、所在地。即使在未关注的情况下,只要用户授权,也能获取其信息 |
$redirect_uri | string | 授权后要跳转到的地址 |
$state | string | 非必须, 重定向后会带上state参数,开发者可以填写a-zA-Z0-9的参数值,最多128字节 |
return | string |
public get_groups ( ) : array(err, | ||
return | array(err, |
public get_jsapi_config ( string $url = '', string $type = '', $jsonp_callback = 'callback' ) : mixed | ||
$url | string | 可选:调取JS-SDK的页面url,默认为HTTP_REFERER |
$type | string | 可选:返回配置信息的格式 json & jsonp, 默认为对象数组 |
return | mixed | Examples: ``` $api->get_jsapi_config(); $api->get_jsapi_config('http://www.baidu.com/'); ``` Result: ``` { errcode: 0, appId: "wx733d7f24bd29224a", timestamp: 1440073485, nonceStr: "5Ars5fLaLuPEXSgm", signature: "7f830aff99ff11fa931cae61b5b932b1f2c8ee10", url: "http://www.baidu.com/" } ``` Examples: ``` $api->get_jsapi_config('', 'json'); ``` Result: ``` {"errcode":0,"appId":"wx733d7f24bd29224a","timestamp":1440073708,"nonceStr":"caFkkXnOhVrcq3Ke","signature":"1c6c08ddf6e0e3c0fd33aafcb160a9f67d6b8f94","url":null} ``` Examples: ``` $api->get_jsapi_config('', 'jsonp'); $api->get_jsapi_config('', 'jsonp', 'callback'); ``` Result: ``` ;jQuery17105012127514928579_1440073858610({"errcode":0,"appId":"wx733d7f24bd29224a","timestamp":1440073875,"nonceStr":"vsGBSM0MMiWeIJFQ","signature":"616005786e404fe0da226a6decc2730624bedbfc","url":null}) ``` |
public get_jsapi_ticket ( ) : string | ||
return | string | $ticket |
public get_kf_session ( string $openid ) : array(err, | ||
$openid | string | |
return | array(err, |
public get_kf_session_list ( string $kf_account ) : array(err, | ||
$kf_account | string | |
return | array(err, |
public get_material ( string $media_id ) : array(err, | ||
$media_id | string | 要获取的素材的media_id |
return | array(err, |
public get_material_count ( ) : array(err, | ||
return | array(err, |
public get_online_kf_list ( ) : array(err, | ||
return | array(err, |
public get_qrcode ( $ticket ) : string | ||
return | string | [二维码图片的内容] Examples: ``` list($err, $data) = $api->get_qrcode('gQGa8ToAAAAAAAAAASxodHRwOi8vd2VpeGluLnFxLmNvbS9xLzlVeXJZWS1seGNlODZ2SV9XMkMwAAIEo5rVVQMEAAAAAA=='); header('Content-type: image/jpg'); echo $data; ``` |
public get_qrcode_url ( $ticket ) : string | ||
return | string | 二维码的url地址 Examples: ``` echo $api->get_qrcode_url('gQH58DoAAAAAAAAAASxodHRwOi8vd2VpeGluLnFxLmNvbS9xLzQweUctT2psME1lcEJPYWJkbUswAAIEApzVVQMEZAAAAA=='); ``` Result: ``` https://mp.weixin.qq.com/cgi-bin/showqrcode?ticket=gQH58DoAAAAAAAAAASxodHRwOi8vd2VpeGluLnFxLmNvbS9xLzQweUctT2psME1lcEJPYWJkbUswAAIEApzVVQMEZAAAAA== ``` |
public get_user_group ( string $open_id ) : array(err, | ||
$open_id | string | [用户的OpenID] |
return | array(err, |
public get_user_info ( string $open_id, string $lang = '' ) : array(err, | ||
$open_id | string | [普通用户的标识,对当前公众号唯一] |
$lang | string | [可选:返回国家地区语言版本,zh_CN 简体,zh_TW 繁体,en 英语] |
return | array(err, |
public get_user_list ( string $next_openid = '' ) : array(err, | ||
$next_openid | string | [可选:第一个拉取的OPENID,不填默认从头开始拉取] |
return | array(err, |
public get_waitcase_list ( ) : array(err, | ||
return | array(err, |
public new_jsapi_ticket ( ) : mixed | ||
return | mixed |
public progressWxPayNotify ( ) : array | ||
return | array | [是否支付成功, 异步通知的原始数据, 回复微信异步通知的数据] |
public static replyWxPayNotify ( array $info ) | ||
$info | array | 回复内容数组 |
public set_kf_avatar ( string $kf_account, string $path ) : array(err, | ||
$kf_account | string | |
$path | string | |
return | array(err, |
public update_group ( integer $group_id, string $group_name ) : array(err, | ||
$group_id | integer | [分组id,由微信分配] |
$group_name | string | [分组名字(30个字符以内)] |
return | array(err, |
public update_user_group ( string $open_id, integer $to_groupid ) : array(err, | ||
$open_id | string | [用户唯一标识符] |
$to_groupid | integer | [分组id] |
return | array(err, |
public update_user_remark ( string $open_id, string $remark ) : array(err, | ||
$open_id | string | [用户标识] |
$remark | string | [新的备注名,长度必须小于30字符] |
return | array(err, |
public upload_media ( string $type, string $path ) : array(err, | ||
$type | string | 媒体文件类型,分别有图片(image)、语音(voice)、视频(video)和缩略图(thumb,主要用于视频与音乐格式的缩略图) |
$path | string | 素材的绝对路径 |
return | array(err, |
public valid_access_token ( string $token ) : boolean | ||
$token | string | |
return | boolean |
public valid_jsapi_ticket ( object $ticket ) : boolean | ||
$ticket | object | |
return | boolean |
protected callable $get_access_token_diy | ||
return | callable |
protected callable $get_jsapi_ticket_diy | ||
return | callable |
protected callable $save_access_token_diy | ||
return | callable |
protected callable $save_jsapi_ticket_diy | ||
return | callable |