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

MEDIA_UPLOAD_URL

MEDIA_UPLOAD_URL = '/media/upload?'

MEDIA_UPLOADIMG_URL

MEDIA_UPLOADIMG_URL = '/media/uploadimg?'

MEDIA_GET_URL

MEDIA_GET_URL = '/media/get?'

MEDIA_VIDEO_UPLOAD

MEDIA_VIDEO_UPLOAD = '/media/uploadvideo?'

MEDIA_FOREVER_UPLOAD_URL

MEDIA_FOREVER_UPLOAD_URL = '/material/add_material?'

MEDIA_FOREVER_NEWS_UPLOAD_URL

MEDIA_FOREVER_NEWS_UPLOAD_URL = '/material/add_news?'

MEDIA_FOREVER_NEWS_UPDATE_URL

MEDIA_FOREVER_NEWS_UPDATE_URL = '/material/update_news?'

MEDIA_FOREVER_GET_URL

MEDIA_FOREVER_GET_URL = '/material/get_material?'

MEDIA_FOREVER_DEL_URL

MEDIA_FOREVER_DEL_URL = '/material/del_material?'

MEDIA_FOREVER_COUNT_URL

MEDIA_FOREVER_COUNT_URL = '/material/get_materialcount?'

MEDIA_FOREVER_BATCHGET_URL

MEDIA_FOREVER_BATCHGET_URL = '/material/batchget_material?'

MEDIA_UPLOADNEWS_URL

MEDIA_UPLOADNEWS_URL = '/media/uploadnews?'

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

uploadMedia()

uploadMedia(array  $data, string  $type) : boolean|array

上传临时素材,有效期为3天(认证后的订阅号可用) 注意:上传大文件时可能需要先调用 set_time_limit(0) 避免超时 注意:数组的键值任意,但文件名前必须加@,使用单引号以避免本地路径斜杠被转义 注意:临时素材的media_id是可复用的!

Parameters

array $data

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

string $type

类型:图片:image 语音:voice 视频:video 缩略图:thumb

Returns

boolean|array

getMedia()

getMedia(string  $media_id, boolean  $is_video = false) : boolean|array

获取临时素材(认证后的订阅号可用)

Parameters

string $media_id

媒体文件id

boolean $is_video

是否为视频文件,默认为否

Returns

boolean|array

getMediaWithHttpInfo()

getMediaWithHttpInfo(string  $media_id, boolean  $is_video = false) : boolean|array

获取临时素材(认证后的订阅号可用) 包含返回的http头信息

Parameters

string $media_id

媒体文件id

boolean $is_video

是否为视频文件,默认为否

Returns

boolean|array

uploadImg()

uploadImg(array  $data) : boolean|array

上传图片,本接口所上传的图片不占用公众号的素材库中图片数量的5000个的限制。图片仅支持jpg/png格式,大小必须在1MB以下。 (认证后的订阅号可用) 注意:上传大文件时可能需要先调用 set_time_limit(0) 避免超时 注意:数组的键值任意,但文件名前必须加@,使用单引号以避免本地路径斜杠被转义

Parameters

array $data

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

Returns

boolean|array

uploadForeverMedia()

uploadForeverMedia(array  $data, string  $type, boolean  $is_video = false, array  $video_info = array()) : boolean|array

上传永久素材(认证后的订阅号可用) 新增的永久素材也可以在公众平台官网素材管理模块中看到 注意:上传大文件时可能需要先调用 set_time_limit(0) 避免超时 注意:数组的键值任意,但文件名前必须加@,使用单引号以避免本地路径斜杠被转义

Parameters

array $data

{"media":'@Path\filename.jpg'}, 支持base64格式

string $type

类型:图片:image 语音:voice 视频:video 缩略图:thumb

boolean $is_video

是否为视频文件,默认为否

array $video_info

视频信息数组,非视频素材不需要提供 array('title'=>'视频标题','introduction'=>'描述')

Returns

boolean|array

uploadForeverArticles()

uploadForeverArticles(array  $data) : boolean|array

上传永久图文素材(认证后的订阅号可用) 新增的永久素材也可以在公众平台官网素材管理模块中看到

Parameters

array $data

消息结构{"articles":[{...}]}

Returns

boolean|array

updateForeverArticles()

updateForeverArticles(string  $media_id, array  $data, integer  $index) : boolean|array

修改永久图文素材(认证后的订阅号可用) 永久素材也可以在公众平台官网素材管理模块中看到

Parameters

string $media_id

图文素材id

array $data

消息结构{"articles":[{...}]}

integer $index

更新的文章在图文素材的位置,第一篇为0,仅多图文使用

Returns

boolean|array

getForeverMedia()

getForeverMedia(string  $media_id, boolean  $is_video = false) : boolean|array

获取永久素材(认证后的订阅号可用) 返回图文消息数组或二进制数据,失败返回false

Parameters

string $media_id

媒体文件id

boolean $is_video

是否为视频文件,默认为否

Returns

boolean|array

delForeverMedia()

delForeverMedia(string  $media_id) : boolean

删除永久素材(认证后的订阅号可用)

Parameters

string $media_id

媒体文件id

Returns

boolean

getForeverList()

getForeverList(string  $type, integer  $offset, integer  $count) : boolean|array

获取永久素材列表(认证后的订阅号可用)

Parameters

string $type

素材的类型,图片(image)、视频(video)、语音 (voice)、图文(news)

integer $offset

全部素材的偏移位置,0表示从第一个素材

integer $count

返回素材的数量,取值在1到20之间

Returns

boolean|array —

返回数组格式: array( 'total_count'=>0, //该类型的素材的总数 'item_count'=>0, //本次调用获取的素材的数量 'item'=>array() //素材列表数组,内容定义请参考官方文档 )

getForeverCount()

getForeverCount() : boolean|array

获取永久素材总数(认证后的订阅号可用)

Returns

boolean|array —

返回数组格式: array( 'voice_count'=>0, //语音总数量 'video_count'=>0, //视频总数量 'image_count'=>0, //图片总数量 'news_count'=>0 //图文总数量 )

uploadArticles()

uploadArticles(array  $data) : boolean|array

上传图文消息素材,用于群发(认证后的订阅号可用)

Parameters

array $data

消息结构{"articles":[{...}]}

Returns

boolean|array

uploadMpVideo()

uploadMpVideo(array  $data) : boolean|array

上传视频素材(认证后的订阅号可用)

Parameters

array $data

消息结构 { "media_id"=>"", //通过上传媒体接口得到的MediaId "title"=>"TITLE", //视频标题 "description"=>"Description" //视频描述 }

Returns

boolean|array —

{ "type":"video", "media_id":"mediaid", "created_at":1398848981 }

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