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

QR_LIMIT_SCENE

QR_LIMIT_SCENE = 1

SEMANTIC_API_URL

SEMANTIC_API_URL = '/semantic/semproxy/search?'

语义理解

QRCODE_IMG_URL

QRCODE_IMG_URL = 'https://mp.weixin.qq.com/cgi-bin/showqrcode?ticket='

QRCODE_CREATE_URL

QRCODE_CREATE_URL = '/qrcode/create?'

SHORT_URL

SHORT_URL = '/shorturl?'

QR_SCENE

QR_SCENE = 0

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

$DATACUBE_URL_ARR

$DATACUBE_URL_ARR : 

数据分析接口

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

getQRUrl()

getQRUrl(string  $ticket) : string

获取二维码图片

Parameters

string $ticket

传入由getQRCode方法生成的ticket参数

Returns

string —

url 返回http地址

getShortUrl()

getShortUrl(string  $long_url) : boolean|string

长链接转短链接接口

Parameters

string $long_url

传入要转换的长url

Returns

boolean|string —

url 成功则返回转换后的短url

getQRCode()

getQRCode(integer|string  $scene_id, integer  $type, integer  $expire = 2592000) : boolean|array

创建二维码ticket

Parameters

integer|string $scene_id

自定义追踪id,临时二维码只能用数值型

integer $type

0:临时二维码;1:永久二维码(此时expire参数无效);2:永久二维码(此时expire参数无效)

integer $expire

临时二维码有效期,最大为2592000秒(30天)

Returns

boolean|array —

('ticket'=>'qrcode字串','expire_seconds'=>2592000,'url'=>'二维码图片解析后的地址')

querySemantic()

querySemantic(string  $uid, string  $query, string  $category, float  $latitude = 0.0, float  $longitude = 0.0, string  $city = "", string  $region = "") : boolean|array

语义理解接口

Parameters

string $uid

用户唯一id(非开发者id),用户区分公众号下的不同用户(建议填入用户openid)

string $query

输入文本串

string $category

需要使用的服务类型,多个用“,”隔开,不能为空

float $latitude

纬度坐标,与经度同时传入;与城市二选一传入

float $longitude

经度坐标,与纬度同时传入;与城市二选一传入

string $city

城市名称,与经纬度二选一传入

string $region

区域名称,在城市存在的情况下可省略;与经纬度二选一传入

Returns

boolean|array

getDatacube()

getDatacube(string  $type, string  $subtype, string  $begin_date, string  $end_date = '') : boolean|array

获取统计数据

Parameters

string $type

数据分类(user|article|upstreammsg|interface)分别为(用户分析|图文分析|消息分析|接口分析)

string $subtype

数据子分类,参考 DATACUBE_URL_ARR 常量定义部分 或者README.md说明文档

string $begin_date

开始时间

string $end_date

结束时间

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