Gitee
\
Wechat
Lib

\WechatWechatCustom

微信SDK基础类

Summary

Methods
Properties
Constants
__construct()
getErrorCode()
getError()
getAppid()
getConfig()
valid()
getAccessToken()
resetAuth()
getCustomServiceMessage()
getCustomServiceKFlist()
getCustomServiceOnlineKFlist()
createKFSession()
closeKFSession()
getKFSession()
getCustomMsgList()
getKFSessionlist()
getKFSessionWait()
addKFAccount()
updateKFAccount()
deleteKFAccount()
setKFHeadImg()
$token
$encodingAesKey
$encrypt_type
$appid
$appsecret
$access_token
$postxml
$_msg
$errCode
$errMsg
$config
API_BASE_URL_PREFIX
API_URL_PREFIX
GET_TICKET_URL
AUTH_URL
CUSTOM_SERVICE_GET_RECORD
CUSTOM_SERVICE_GET_KFLIST
CUSTOM_SERVICE_GET_ONLINEKFLIST
CUSTOM_SESSION_CREATE
CUSTOM_SESSION_CLOSE
CUSTOM_SESSION_SWITCH
CUSTOM_SESSION_GET
CUSTOM_SESSION_GET_LIST
CUSTOM_SESSION_GET_WAIT
CS_KF_ACCOUNT_ADD_URL
CS_KF_ACCOUNT_UPDATE_URL
CS_KF_ACCOUNT_DEL_URL
CS_KF_ACCOUNT_UPLOAD_HEADIMG_URL
CUSTOM_SERVICE_GET_MSG_LIST
checkRetry()
No protected properties found
N/A
checkSignature()
$_retry
N/A

Constants

API_BASE_URL_PREFIX

API_BASE_URL_PREFIX = 'https://api.weixin.qq.com'

API接口URL需要使用此前缀

API_URL_PREFIX

API_URL_PREFIX = 'https://api.weixin.qq.com/cgi-bin'

GET_TICKET_URL

GET_TICKET_URL = '/ticket/getticket?'

AUTH_URL

AUTH_URL = '/token?grant_type=client_credential&'

CUSTOM_SERVICE_GET_RECORD

CUSTOM_SERVICE_GET_RECORD = '/customservice/getrecord?'

多客服相关地址

CUSTOM_SERVICE_GET_KFLIST

CUSTOM_SERVICE_GET_KFLIST = '/customservice/getkflist?'

CUSTOM_SERVICE_GET_ONLINEKFLIST

CUSTOM_SERVICE_GET_ONLINEKFLIST = '/customservice/getonlinekflist?'

CUSTOM_SESSION_CREATE

CUSTOM_SESSION_CREATE = '/customservice/kfsession/create?'

CUSTOM_SESSION_CLOSE

CUSTOM_SESSION_CLOSE = '/customservice/kfsession/close?'

CUSTOM_SESSION_SWITCH

CUSTOM_SESSION_SWITCH = '/customservice/kfsession/switch?'

CUSTOM_SESSION_GET

CUSTOM_SESSION_GET = '/customservice/kfsession/getsession?'

CUSTOM_SESSION_GET_LIST

CUSTOM_SESSION_GET_LIST = '/customservice/kfsession/getsessionlist?'

CUSTOM_SESSION_GET_WAIT

CUSTOM_SESSION_GET_WAIT = '/customservice/kfsession/getwaitcase?'

CS_KF_ACCOUNT_ADD_URL

CS_KF_ACCOUNT_ADD_URL = '/customservice/kfaccount/add?'

CS_KF_ACCOUNT_UPDATE_URL

CS_KF_ACCOUNT_UPDATE_URL = '/customservice/kfaccount/update?'

CS_KF_ACCOUNT_DEL_URL

CS_KF_ACCOUNT_DEL_URL = '/customservice/kfaccount/del?'

CS_KF_ACCOUNT_UPLOAD_HEADIMG_URL

CS_KF_ACCOUNT_UPLOAD_HEADIMG_URL = '/customservice/kfaccount/uploadheadimg?'

CUSTOM_SERVICE_GET_MSG_LIST

CUSTOM_SERVICE_GET_MSG_LIST = '/customservice/msgrecord/getmsglist?'

Properties

$token

$token :

Type

$encodingAesKey

$encodingAesKey :

Type

$encrypt_type

$encrypt_type :

Type

$appid

$appid :

Type

$appsecret

$appsecret :

Type

$access_token

$access_token :

Type

$postxml

$postxml :

Type

$_msg

$_msg :

Type

$errCode

$errCode :

Type

$errMsg

$errMsg :

Type

$config

$config :

Type

$_retry

$_retry :

Type

Methods

__construct()

__construct(array  $options = array())

构造方法

Parameters

array $options

getErrorCode()

getErrorCode() : integer

当前当前错误代码

Returns

integer

getError()

getError() : string

获取当前错误内容

Returns

string

getAppid()

getAppid() : string

获取当前操作公众号APPID

Returns

string

getConfig()

getConfig() : array

获取SDK配置参数

Returns

array

valid()

valid() : boolean

接口验证

Returns

boolean

getAccessToken()

getAccessToken(string  $appid = '', string  $appsecret = '', string  $token = '') : boolean|string

获取公众号访问 access_token

Parameters

string $appid

如在类初始化时已提供，则可为空
string $appsecret

如在类初始化时已提供，则可为空
string $token

手动指定access_token，非必要情况不建议用

Returns

boolean|string

resetAuth()

resetAuth(string  $appid = '') : boolean

删除验证数据

Parameters

string $appid

如在类初始化时已提供，则可为空

Returns

boolean

getCustomServiceMessage()

getCustomServiceMessage(array  $data) : boolean|array

获取多客服会话记录

Parameters

array $data

数据结构 {"starttime":123456789,"endtime":987654321,"openid":"OPENID","pagesize":10,"pageindex":1,}

Returns

boolean|array

getCustomServiceKFlist()

getCustomServiceKFlist() : boolean|array

获取多客服客服基本信息

Returns

boolean|array

getCustomServiceOnlineKFlist()

getCustomServiceOnlineKFlist() : boolean|array

获取多客服在线客服接待信息

Returns

boolean|array

createKFSession()

createKFSession(string  $openid, string  $kf_account, string  $text = '') : boolean|array

创建指定多客服会话

Parameters

string $openid

//用户openid
string $kf_account

//客服账号
string $text

//附加信息，文本会展示在客服人员的多客服客户端，可为空

Returns

boolean|array

closeKFSession()

closeKFSession(string  $openid, string  $kf_account, string  $text = '') : boolean

关闭指定多客服会话

Parameters

string $openid

//用户openid
string $kf_account

//客服账号
string $text

//附加信息，文本会展示在客服人员的多客服客户端，可为空

Returns

boolean —

| array //成功返回json数组 { "errcode": 0, "errmsg": "ok", }

getKFSession()

getKFSession(string  $openid) : boolean

获取用户会话状态

Parameters

string $openid

//用户openid

Returns

boolean —

| array //成功返回json数组 { "errcode" : 0, "errmsg" : "ok", "kf_account" : "test1@test", //正在接待的客服 "createtime": 123456789, //会话接入时间 }

getCustomMsgList()

getCustomMsgList(array  $data) : boolean|array

获取聊天记录

Parameters

array $data

数据结构 {"starttime" : 987654321,"endtime" : 987654321,"msgid" : 1,"number" : 10000}

Returns

boolean|array

getKFSessionlist()

getKFSessionlist(string  $kf_account) : boolean

获取指定客服的会话列表

Parameters

string $kf_account

//用户openid

Returns

boolean —

| array //成功返回json数组 array( 'sessionlist' => array ( array ( 'openid'=>'OPENID', //客户 openid 'createtime'=>123456789, //会话创建时间，UNIX 时间戳 ), array ( 'openid'=>'OPENID', //客户 openid 'createtime'=>123456789, //会话创建时间，UNIX 时间戳 ), ) )

getKFSessionWait()

getKFSessionWait() : boolean|array

获取未接入会话列表

Returns

boolean|array

addKFAccount()

addKFAccount(string  $account, string  $nickname, string  $password) : boolean|array

添加客服账号

Parameters

string $account

完整客服账号(账号前缀@公众号微信号，账号前缀最多10个字符)
string $nickname

客服昵称，最长6个汉字或12个英文字符
string $password

客服账号明文登录密码，会自动加密

Returns

boolean|array

updateKFAccount()

updateKFAccount(string  $account, string  $nickname, string  $password) : boolean|array

修改客服账号信息

Parameters

string $account

//完整客服账号，格式为：账号前缀@公众号微信号，账号前缀最多10个字符，必须是英文或者数字字符
string $nickname

//客服昵称，最长6个汉字或12个英文字符
string $password

//客服账号明文登录密码，会自动加密

Returns

boolean|array —

成功返回结果 { "errcode": 0, "errmsg": "ok", }

deleteKFAccount()

deleteKFAccount(string  $account) : boolean|array

删除客服账号

Parameters

string $account

完整客服账号(账号前缀@公众号微信号，账号前缀最多10个字符)

Returns

boolean|array

setKFHeadImg()

setKFHeadImg(string  $account, string  $imgfile) : boolean|array

上传客服头像

Parameters

string $account

完整客服账号(账号前缀@公众号微信号，账号前缀最多10个字符)
string $imgfile

头像文件完整路径,如：'D:\user.jpg'。头像文件必须JPG格式，像素建议640*640

Returns

boolean|array

checkRetry()

checkRetry(string  $method, array  $arguments = array()) : boolean|mixed

接口失败重试

Parameters

string $method

SDK方法名称
array $arguments

SDK方法参数

Returns

boolean|mixed

checkSignature()

checkSignature(string  $str = '') : boolean

验证来自微信服务器

Parameters

string $str

Returns

boolean