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

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

getAllPrivateTemplate()

getAllPrivateTemplate() : boolean|array

获取模板列表

Returns

boolean|array

getTMIndustry()

getTMIndustry() : boolean|array

获取设置的行业信息

Returns

boolean|array

delPrivateTemplate()

delPrivateTemplate(string  $tpl_id) : boolean

删除模板消息

Parameters

string $tpl_id

Returns

boolean

setTMIndustry()

setTMIndustry(string  $id1, string  $id2 = '') : boolean|mixed

模板消息 设置所属行业

Parameters

string $id1

公众号模板消息所属行业编号,参看官方开发文档 行业代码

string $id2

同$id1。但如果只有一个行业,此参数可省略

Returns

boolean|mixed

addTemplateMessage()

addTemplateMessage(string  $tpl_id) : boolean|string

模板消息 添加消息模板 成功返回消息模板的调用id

Parameters

string $tpl_id

模板库中模板的编号,有“TM”和“OPENTMTM”等形式

Returns

boolean|string

sendTemplateMessage()

sendTemplateMessage(array  $data) : boolean|array

发送模板消息

Parameters

array $data

消息结构 { "touser":"OPENID", "template_id":"ngqIpbwh8bUfcSsECmogfXcV14J0tQlEpBO27izEYtY", "url":"http://weixin.qq.com/download", "topcolor":"#FF0000", "data":{ "参数名1": { "value":"参数", "color":"#173177" //参数颜色 }, "Date":{ "value":"06月07日 19时24分", "color":"#173177" }, "CardNumber":{ "value":"0426", "color":"#173177" }, "Type":{ "value":"消费", "color":"#173177" } } }

Returns

boolean|array

sendMassMessage()

sendMassMessage(array  $data) : boolean|array

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

Parameters

array $data

消息结构 注意: 视频需要在调用uploadMedia()方法后,再使用 uploadMpVideo() 方法生成, 然后获得的 mediaid 才能用于群发,且消息类型为 mpvideo 类型。

Returns

boolean|array —

{ "touser"=>array( "OPENID1", "OPENID2" ), "msgtype"=>"mpvideo", // 在下面5种类型中选择对应的参数内容 // mpnews | voice | image | mpvideo => array( "media_id"=>"MediaId") // text => array ( "content" => "hello") }

sendGroupMassMessage()

sendGroupMassMessage(array  $data) : boolean|array

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

Parameters

array $data

消息结构 注意:视频需要在调用uploadMedia()方法后,再使用 uploadMpVideo() 方法生成, 然后获得的 mediaid 才能用于群发,且消息类型为 mpvideo 类型。

Returns

boolean|array —

{ "filter"=>array( "is_to_all"=>False, //是否群发给所有用户.True不用分组id,False需填写分组id "group_id"=>"2" //群发的分组id ), "msgtype"=>"mpvideo", // 在下面5种类型中选择对应的参数内容 // mpnews | voice | image | mpvideo => array( "media_id"=>"MediaId") // text => array ( "content" => "hello") }

deleteMassMessage()

deleteMassMessage(string  $msg_id) : boolean

删除群发图文消息 ( 订阅号与服务号认证后均可用 )

Parameters

string $msg_id

消息ID

Returns

boolean

previewMassMessage()

previewMassMessage(array  $data) : boolean|array

预览群发消息 ( 订阅号与服务号认证后均可用 )

Parameters

array $data

注意: 视频需要在调用uploadMedia()方法后,再使用 uploadMpVideo() 方法生成, 然后获得的 mediaid 才能用于群发,且消息类型为 mpvideo 类型。

Returns

boolean|array

queryMassMessage()

queryMassMessage(string  $msg_id) : boolean|array

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

Parameters

string $msg_id

消息ID

Returns

boolean|array —

{ "msg_id":201053012, //群发消息后返回的消息id "msg_status":"SEND_SUCCESS", //消息发送后的状态,SENDING表示正在发送 SEND_SUCCESS表示发送成功 }

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