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&'

USER_GET_URL

USER_GET_URL = '/user/get?'

获取粉丝列表

USER_INFO_URL

USER_INFO_URL = '/user/info?'

USER_BATCH_INFO_URL

USER_BATCH_INFO_URL = '/user/info/batchget?'

USER_UPDATEREMARK_URL

USER_UPDATEREMARK_URL = '/user/info/updateremark?'

TAGS_CREATE_URL

TAGS_CREATE_URL = '/tags/create?'

创建标签

TAGS_GET_URL

TAGS_GET_URL = '/tags/get?'

TAGS_UPDATE_URL

TAGS_UPDATE_URL = '/tags/update?'

TAGS_DELETE_URL

TAGS_DELETE_URL = '/tags/delete?'

TAGS_GET_USER_URL

TAGS_GET_USER_URL = '/user/tag/get?'

TAGS_MEMBER_BATCHTAGGING

TAGS_MEMBER_BATCHTAGGING = '/tags/members/batchtagging?'

TAGS_MEMBER_BATCHUNTAGGING

TAGS_MEMBER_BATCHUNTAGGING = '/tags/members/batchuntagging?'

TAGS_LIST

TAGS_LIST = '/tags/getidlist?'

GROUP_GET_URL

GROUP_GET_URL = '/groups/get?'

获取分组列表

USER_GROUP_URL

USER_GROUP_URL = '/groups/getid?'

GROUP_CREATE_URL

GROUP_CREATE_URL = '/groups/create?'

GROUP_UPDATE_URL

GROUP_UPDATE_URL = '/groups/update?'

GROUP_DELETE_URL

GROUP_DELETE_URL = '/groups/delete?'

GROUP_MEMBER_UPDATE_URL

GROUP_MEMBER_UPDATE_URL = '/groups/members/update?'

GROUP_MEMBER_BATCHUPDATE_URL

GROUP_MEMBER_BATCHUPDATE_URL = '/groups/members/batchupdate?'

BACKLIST_GET_URL

BACKLIST_GET_URL = '/tags/members/getblacklist?'

获取黑名单列表

BACKLIST_ADD_URL

BACKLIST_ADD_URL = '/tags/members/batchblacklist?'

BACKLIST_DEL_URL

BACKLIST_DEL_URL = '/tags/members/batchunblacklist?'

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

getUserList()

getUserList(string  $next_openid = '') : boolean|array

批量获取关注粉丝列表

Parameters

string $next_openid

Returns

boolean|array

getUserInfo()

getUserInfo(string  $openid) : boolean|array

获取关注者详细信息

Parameters

string $openid

Returns

boolean|array —

{subscribe,openid,nickname,sex,city,province,country,language,headimgurl,subscribe_time,[unionid]}

getUserBatchInfo()

getUserBatchInfo(array  $openids, string  $lang = 'zh_CN') : boolean|mixed

批量获取用户基本信息

Parameters

array $openids

用户oepnid列表(最多支持100个openid)

string $lang

指定返回语言

Returns

boolean|mixed

updateUserRemark()

updateUserRemark(string  $openid, string  $remark) : boolean|array

设置粉丝备注名

Parameters

string $openid
string $remark

备注名

Returns

boolean|array

getGroup()

getGroup() : boolean|array

获取粉丝分组列表

Returns

boolean|array

delGroup()

delGroup(\Wechat\type  $id) : boolean

删除粉丝分组

Parameters

\Wechat\type $id

Returns

boolean

getUserGroup()

getUserGroup(string  $openid) : boolean|integer

获取粉丝所在分组

Parameters

string $openid

Returns

boolean|integer —

成功则返回粉丝分组id

createGroup()

createGroup(string  $name) : boolean|array

新增自定分组

Parameters

string $name

分组名称

Returns

boolean|array

updateGroup()

updateGroup(integer  $groupid, string  $name) : boolean|array

更改分组名称

Parameters

integer $groupid

分组id

string $name

分组名称

Returns

boolean|array

updateGroupMembers()

updateGroupMembers(integer  $groupid, string  $openid) : boolean|array

移动粉丝分组

Parameters

integer $groupid

分组id

string $openid

粉丝openid

Returns

boolean|array

batchUpdateGroupMembers()

batchUpdateGroupMembers(string  $groupid, string  $openid_list) : boolean|array

批量移动粉丝分组

Parameters

string $groupid

分组ID

string $openid_list

粉丝openid数组(一次不能超过50个)

Returns

boolean|array

createTags()

createTags(string  $name) : boolean|array

新增自定标签

Parameters

string $name

标签名称

Returns

boolean|array

updateTag()

updateTag(string  $id, string  $name) : boolean|array

更新标签

Parameters

string $id

标签id

string $name

标签名称

Returns

boolean|array

getTags()

getTags() : boolean|array

获取粉丝标签列表

Returns

boolean|array

delTag()

delTag(string  $id) : boolean

删除粉丝标签

Parameters

string $id

Returns

boolean

getTagUsers()

getTagUsers(string  $tagid, string  $next_openid = '') : boolean

获取标签下的粉丝列表

Parameters

string $tagid
string $next_openid

Returns

boolean

batchAddUserTag()

batchAddUserTag(string  $tagid, array  $openid_list) : boolean|array

批量为粉丝打标签

Parameters

string $tagid

标签ID

array $openid_list

粉丝openid数组,一次不能超过50个

Returns

boolean|array

batchDeleteUserTag()

batchDeleteUserTag(string  $tagid, array  $openid_list) : boolean|array

批量为粉丝取消标签

Parameters

string $tagid

标签ID

array $openid_list

粉丝openid数组,一次不能超过50个

Returns

boolean|array

getUserTags()

getUserTags(string  $openid) : boolean|array

获取粉丝的标签列表

Parameters

string $openid

粉丝openid

Returns

boolean|array

getBacklist()

getBacklist(string  $begin_openid = '') : boolean|array

批量获取黑名单粉丝

Parameters

string $begin_openid

Returns

boolean|array

addBacklist()

addBacklist(string  $openids) : boolean|array

批量拉黑粉丝

Parameters

string $openids

Returns

boolean|array

delBacklist()

delBacklist(string  $openids) : boolean|array

批量取消拉黑粉丝

Parameters

string $openids

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