Documentation

Custom extends BasicWeChat
in

客服消息处理 Class Custom

Table of Contents

$config 当前微信配置 DataArray
$access_token 访问AccessToken string
$currentMethod 当前请求方法参数 array
$isTry 当前模式 bool
$cache 静态缓存 static
$GetAccessTokenCallback 注册代替函数 string
addAccount() 添加客服帐号 array
updateAccount() 修改客服帐号 array
deleteAccount() 删除客服帐号 array
inviteWorker() 邀请绑定客服帐号 array
getAccountList() 获取所有客服账号 array
uploadHeadimg() 设置客服帐号的头像 array
send() 客服接口-发消息 array
typing() 客服输入状态 array
massSendAll() 根据标签进行群发【订阅号与服务号认证后均可用】 array
massSend() 根据OpenID列表群发【订阅号不可用,服务号认证后可用】 array
massDelete() 删除群发【订阅号与服务号认证后均可用】 array
massPreview() 预览接口【订阅号与服务号认证后均可用】 array
massGet() 查询群发消息发送状态【订阅号与服务号认证后均可用】 array
massGetSeed() 获取群发速度 array
massSetSeed() 设置群发速度 array
__construct() BasicWeChat constructor. mixed
instance() 静态创建对象 static
getAccessToken() 获取访问accessToken string
setAccessToken() 设置外部接口 AccessToken mixed
delAccessToken() 清理删除 AccessToken bool
httpGetForJson() 以GET获取接口数据并转为数组 array
httpPostForJson() 以POST获取接口数据并转为数组 array
registerApi() 注册当前请求接口 mixed
callPostApi() 接口通用POST请求方法 array
callGetApi() 接口通用GET请求方法 array

Properties

$access_token

访问AccessToken

public string $access_token = ''

$currentMethod

当前请求方法参数

protected array $currentMethod = []

$GetAccessTokenCallback

注册代替函数

protected string $GetAccessTokenCallback

Methods

addAccount()

添加客服帐号

public addAccount( $kf_account : string , $nickname : string ) : array
Parameters
$kf_account : string

客服账号

$nickname : string

客服昵称

Tags
throws
throws
Return values
array

updateAccount()

修改客服帐号

public updateAccount( $kf_account : string , $nickname : string ) : array
Parameters
$kf_account : string

客服账号

$nickname : string

客服昵称

Tags
throws
throws
Return values
array

deleteAccount()

删除客服帐号

public deleteAccount( $kf_account : string ) : array
Parameters
$kf_account : string

客服账号

Tags
throws
throws
Return values
array

inviteWorker()

邀请绑定客服帐号

public inviteWorker( $kf_account : string , $invite_wx : string ) : array
Parameters
$kf_account : string

完整客服帐号,格式为:帐号前缀@公众号微信号

$invite_wx : string

接收绑定邀请的客服微信号

Tags
throws
throws
Return values
array

getAccountList()

获取所有客服账号

public getAccountList( ) : array
Tags
throws
throws
Return values
array

uploadHeadimg()

设置客服帐号的头像

public uploadHeadimg( $kf_account : string , $image : string ) : array
Parameters
$kf_account : string

客户账号

$image : string

头像文件位置

Tags
throws
throws
Return values
array

send()

客服接口-发消息

public send( $data : array ) : array
Parameters
$data : array
Tags
throws
throws
Return values
array

typing()

客服输入状态

public typing( $openid : string [, $command : string = 'Typing' ] ) : array
Parameters
$openid : string

普通用户(openid)

$command : string = 'Typing'

Typing:正在输入,CancelTyping:取消正在输入

Tags
throws
throws
Return values
array

massSendAll()

根据标签进行群发【订阅号与服务号认证后均可用】

public massSendAll( $data : array ) : array
Parameters
$data : array
Tags
throws
throws
Return values
array

massSend()

根据OpenID列表群发【订阅号不可用,服务号认证后可用】

public massSend( $data : array ) : array
Parameters
$data : array
Tags
throws
throws
Return values
array

massDelete()

删除群发【订阅号与服务号认证后均可用】

public massDelete( $msg_id : int [, $article_idx : null|int = null ] ) : array
Parameters
$msg_id : int

发送出去的消息ID

$article_idx : null|int = null

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

Tags
throws
throws
Return values
array

massPreview()

预览接口【订阅号与服务号认证后均可用】

public massPreview( $data : array ) : array
Parameters
$data : array
Tags
throws
throws
Return values
array

massGet()

查询群发消息发送状态【订阅号与服务号认证后均可用】

public massGet( $msg_id : int ) : array
Parameters
$msg_id : int

群发消息后返回的消息id

Tags
throws
throws
Return values
array

massGetSeed()

获取群发速度

public massGetSeed( ) : array
Tags
throws
throws
Return values
array

massSetSeed()

设置群发速度

public massSetSeed( $speed : int ) : array
Parameters
$speed : int

群发速度的级别

Tags
throws
throws
Return values
array

__construct()

BasicWeChat constructor.

public __construct( $options : array ) : mixed
Parameters
$options : array
Return values
mixed

instance()

静态创建对象

public static instance( $config : array ) : static
Parameters
$config : array
Return values
static

getAccessToken()

获取访问accessToken

public getAccessToken( ) : string
Tags
throws
throws
Return values
string

setAccessToken()

设置外部接口 AccessToken

public setAccessToken( $access_token : string ) : mixed
Parameters
$access_token : string
Tags
throws
author

高一平 iam@gaoyiping.com

当用户使用自己的缓存驱动时,直接实例化对象后可直接设置 AccessToekn

  • 多用于分布式项目时保持 AccessToken 统一
  • 使用此方法后就由用户来保证传入的 AccessToekn 为有效 AccessToekn
Return values
mixed

delAccessToken()

清理删除 AccessToken

public delAccessToken( ) : bool
Return values
bool

httpGetForJson()

以GET获取接口数据并转为数组

protected httpGetForJson( $url : string ) : array
Parameters
$url : string

接口地址

Tags
throws
throws
Return values
array

httpPostForJson()

以POST获取接口数据并转为数组

protected httpPostForJson( $url : string , $data : array [, $buildToJson : bool = true ] ) : array
Parameters
$url : string

接口地址

$data : array

请求数据

$buildToJson : bool = true
Tags
throws
throws
Return values
array

registerApi()

注册当前请求接口

protected registerApi( &$url : string , $method : string [, $arguments : array = [] ] ) : mixed
Parameters
$url : string

接口地址

$method : string

当前接口方法

$arguments : array = []

请求参数

Tags
throws
throws
Return values
mixed

callPostApi()

接口通用POST请求方法

public callPostApi( $url : string , $data : array [, $isBuildJson : bool = true ] ) : array
Parameters
$url : string

接口URL

$data : array

POST提交接口参数

$isBuildJson : bool = true
Tags
throws
throws
Return values
array

callGetApi()

接口通用GET请求方法

public callGetApi( $url : string ) : array
Parameters
$url : string

接口URL

Tags
throws
throws
Return values
array

Search results