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

SHAKEAROUND_DEVICE_APPLYID

SHAKEAROUND_DEVICE_APPLYID = '/shakearound/device/applyid?'

SHAKEAROUND_DEVICE_APPLYSTATUS

SHAKEAROUND_DEVICE_APPLYSTATUS = '/shakearound/device/applystatus?'

SHAKEAROUND_DEVICE_UPDATE

SHAKEAROUND_DEVICE_UPDATE = '/shakearound/device/update?'

SHAKEAROUND_DEVICE_BINDLOCATION

SHAKEAROUND_DEVICE_BINDLOCATION = '/shakearound/device/bindlocation?'

SHAKEAROUND_DEVICE_BINDPAGE

SHAKEAROUND_DEVICE_BINDPAGE = '/shakearound/device/bindpage?'

SHAKEAROUND_MATERIAL_ADD

SHAKEAROUND_MATERIAL_ADD = '/shakearound/material/add?'

SHAKEAROUND_PAGE_ADD

SHAKEAROUND_PAGE_ADD = '/shakearound/page/add?'

SHAKEAROUND_PAGE_UPDATE

SHAKEAROUND_PAGE_UPDATE = '/shakearound/page/update?'

SHAKEAROUND_PAGE_DELETE

SHAKEAROUND_PAGE_DELETE = '/shakearound/page/delete?'

SHAKEAROUND_USER_GETSHAKEINFO

SHAKEAROUND_USER_GETSHAKEINFO = '/shakearound/user/getshakeinfo?'

SHAKEAROUND_STATISTICS_DEVICE

SHAKEAROUND_STATISTICS_DEVICE = '/shakearound/statistics/device?'

SHAKEAROUND_STATISTICS_PAGE

SHAKEAROUND_STATISTICS_PAGE = '/shakearound/statistics/page?'

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

applyShakeAroundDevice()

applyShakeAroundDevice(array  $data) : boolean|array

申请设备ID

Parameters

array $data

Returns

boolean|array

applyStatusShakeAroundDevice()

applyStatusShakeAroundDevice(integer  $apply_id) : boolean|array

查询设备ID申请审核状态

Parameters

integer $apply_id

Returns

boolean|array

updateShakeAroundDevice()

updateShakeAroundDevice(array  $data) : boolean

编辑设备信息

Parameters

array $data

Returns

boolean

searchShakeAroundDevice()

searchShakeAroundDevice(  $data) : boolean|array

查询设备列表

Parameters

$data

Returns

boolean|array

bindLocationShakeAroundDevice()

bindLocationShakeAroundDevice(string  $device_id, integer  $poi_id, string  $uuid = '', integer  $major, integer  $minor) : boolean|array

配置设备与门店的关联关系

Parameters

string $device_id

设备编号,若填了UUID、major、minor,则可不填设备编号,若二者都填,则以设备编号为优先

integer $poi_id

待关联的门店ID

string $uuid

UUID、major、minor,三个信息需填写完整,若填了设备编号,则可不填此信息

integer $major
integer $minor

Returns

boolean|array

bindLocationOtherShakeAroundDevice()

bindLocationOtherShakeAroundDevice(\Wechat\type  $device_identifier, \Wechat\type  $poi_id, \Wechat\type  $poi_appid) : boolean

配置设备与其他公众账号门店的关联关系

Parameters

\Wechat\type $device_identifier

设备信息

\Wechat\type $poi_id

待关联的门店ID

\Wechat\type $poi_appid

目标微信appid

Returns

boolean

bindPageShakeAroundDevice()

bindPageShakeAroundDevice(string  $device_id, array  $page_ids = array(), integer  $bind = 1, integer  $append = 1, string  $uuid = '', integer  $major, integer  $minor) : boolean|array

配置设备与页面的关联关系

Parameters

string $device_id

设备编号,若填了UUID、major、minor,则可不填设备编号,若二者都填,则以设备编号为优先

array $page_ids

待关联的页面列表

integer $bind

关联操作标志位, 0 为解除关联关系,1 为建立关联关系

integer $append

新增操作标志位, 0 为覆盖,1 为新增

string $uuid

UUID、major、minor,三个信息需填写完整,若填了设备编号,则可不填此信息

integer $major
integer $minor

Returns

boolean|array

uploadShakeAroundMedia()

uploadShakeAroundMedia(array  $data) : boolean|array

上传在摇一摇页面展示的图片素材

Parameters

array $data

{"media":'@Path\filename.jpg'}

Returns

boolean|array

addShakeAroundPage()

addShakeAroundPage(string  $title, string  $description, string  $icon_url, string  $page_url, string  $comment = '') : boolean|array

增加摇一摇出来的页面信息

Parameters

string $title

在摇一摇页面展示的主标题,不超过6 个字

string $description

在摇一摇页面展示的副标题,不超过7 个字

string $icon_url

在摇一摇页面展示的图片, 格式限定为:jpg,jpeg,png,gif; 建议120120 , 限制不超过200200

string $page_url

跳转链接

string $comment

页面的备注信息,不超过15 个字,可不填

Returns

boolean|array

updateShakeAroundPage()

updateShakeAroundPage(integer  $page_id, string  $title, string  $description, string  $icon_url, string  $page_url, string  $comment = '') : boolean|array

编辑摇一摇出来的页面信息

Parameters

integer $page_id
string $title

在摇一摇页面展示的主标题,不超过6 个字

string $description

在摇一摇页面展示的副标题,不超过7 个字

string $icon_url

在摇一摇页面展示的图片, 格式限定为:jpg,jpeg,png,gif; 建议120120 , 限制不超过200200

string $page_url

跳转链接

string $comment

页面的备注信息,不超过15 个字,可不填

Returns

boolean|array

searchShakeAroundPage()

searchShakeAroundPage(array  $page_ids = array(), integer  $begin, integer  $count = 1) : boolean|mixed

查询已有的页面

Parameters

array $page_ids
integer $begin
integer $count

Returns

boolean|mixed

deleteShakeAroundPage()

deleteShakeAroundPage(array  $page_ids = array()) : boolean|array

删除已有的页面

Parameters

array $page_ids

Returns

boolean|array

getShakeInfoShakeAroundUser()

getShakeInfoShakeAroundUser(string  $ticket) : boolean|array

获取设备信息

Parameters

string $ticket

摇周边业务的ticket(可在摇到的URL中得到,ticket生效时间为30 分钟)

Returns

boolean|array

deviceShakeAroundStatistics()

deviceShakeAroundStatistics(integer  $device_id, integer  $begin_date, integer  $end_date, string  $uuid = '', integer  $major, integer  $minor) : boolean|array

以设备为维度的数据统计接口

Parameters

integer $device_id

设备编号,若填了UUID、major、minor,即可不填设备编号,二者选其一

integer $begin_date

起始日期时间戳,最长时间跨度为30 天

integer $end_date

结束日期时间戳,最长时间跨度为30 天

string $uuid

UUID、major、minor,三个信息需填写完成,若填了设备编辑,即可不填此信息,二者选其一

integer $major
integer $minor

Returns

boolean|array

pageShakeAroundStatistics()

pageShakeAroundStatistics(integer  $page_id, integer  $begin_date, integer  $end_date) : boolean|array

以页面为维度的数据统计接口

Parameters

integer $page_id

指定页面的ID

integer $begin_date

起始日期时间戳,最长时间跨度为30 天

integer $end_date

结束日期时间戳,最长时间跨度为30 天

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