## **接口内容列表**
[TOC]
## **上传临时素材(有效期为3天)**
* 参数`$data`内容为文件地址`{"media":'@Path\filename.jpg'}`
* 参数`$type`为素材类型,可选有图片`image`、语音`voice`、视频`video`、缩略图`thumb`
* 素材上传完成后,会反回素材对应的`media_id`
~~~
// 创建SDK实例
$media = & load_wechat('Media');
// 执行接口操作
$result = $media->uploadMedia($data,$type);
// 处理执行的结果
if($result===FALSE){
// 接口失败的处理
echo $media->errMsg;
}else{
// 接口成功的处理
}
~~~
## **获取临时微信素材**
* 参数`$media_id`为素材的`media_id`
* 参数`$is_video`指定是否为视频素材(默认`false`)
* 注意:返回图文消息数组或二进制数据,失败返回false
~~~
// 创建SDK实例
$media = & load_wechat('Media');
// 执行接口操作
$result = $media->getMedia($media_id, $is_video);
// 处理执行的结果
if($result===FALSE){
// 接口失败的处理
echo $media->errMsg;
}else{
// 接口成功的处理
}
~~~
## **上传图片到微信服务器(不占用素材资源数据)**
* 参数`$data`为文件数据`{"media":'@Path\filename.jpg'}`
* 注意:这里返回的是图片的URL地址,不再是`media_id`
~~~
// 创建SDK实例
$media = & load_wechat('Media');
// 执行接口操作
$result = $media->uploadImg($data);
// 处理执行的结果
if($result===FALSE){
// 接口失败的处理
echo $media->errMsg;
}else{
// 接口成功的处理
}
~~~
## **上传永久素材到微信服务器**
* 参数`$data`为文件数据`{"media":'@Path\filename.jpg'}`
* 参数`$type`为素材类型,可选有图片`image`、语音`voice`、视频`video`、缩略图`thumb`
* 参数`$is_video`为是否为视频文件(默认为否)
* 参数`$video_info`为视频信息数组,非视频素材不需要提供 array('title'=>'视频标题','introduction'=>'描述')
* 素材上传完成后,会反回素材对应的`media_id`
~~~
// 实例微信接口
$media = & load_wechat('Media');
// 执行接口操作
$result = $media->uploadForeverMedia($data, $type, $is_video, $video_info);
// 处理执行的结果
if($result===FALSE){
// 接口失败的处理
echo $media->errMsg;
}else{
// 接口成功的处理
}
~~~
## **上传永久图文素材到微信服务器**
* 参数`$data`为图文数据`{"articles":[{...}]}`
* 图文上传完成后,会反回素材对应的`media_id`
~~~
// 实例微信接口
$media = & load_wechat('Media');
// 执行接口操作
$result = $media->uploadForeverArticles($data);
// 处理执行的结果
if($result===FALSE){
// 接口失败的处理
echo $media->errMsg;
}else{
// 接口成功的处理
}
~~~
## **修改永久微信图文素材**
* 参数`$media_id`为文图文素材id
* 参数`$data`为文章内容`{"articles":[{...}]}`
* 参数`$index`为更新的文章在图文素材的位置,第一篇为0,仅多图文使用
~~~
// 实例微信接口
$media = & load_wechat('Media');
// 执行接口操作
$result = $media->updateForeverArticles($media_id, $data, $index);
// 处理执行的结果
if($result===FALSE){
// 接口失败的处理
echo $media->errMsg;
}else{
// 接口成功的处理
}
~~~
## **获取永久素材**
* 参数`$media_id`为素材的`media_id`
* 参数`$is_video`指定是否为视频素材(默认`false`)
* 注意:返回图文消息数组或二进制数据,失败返回false
~~~
// 创建SDK实例
$media = & load_wechat('Media');
// 执行接口操作
$result = $media->getForeverMedia($media_id, $is_video);
// 处理执行的结果
if($result===FALSE){
// 接口失败的处理
echo $media->errMsg;
}else{
// 接口成功的处理
}
~~~
## **删除永久素材**
* 参数`$media_id`为媒体文件id
~~~
// 实例微信接口
$media = & load_wechat('Media');
// 执行接口操作
$result = $media->delForeverMedia($media_id);
// 处理执行的结果
if($result===FALSE){
// 接口失败的处理
echo $media->errMsg;
}else{
// 接口成功的处理
}
~~~
## **获取永久素材列表**
* 参数`$type`为素材类型,可选有图片`image`、语音`voice`、视频`video`、缩略图`thumb`
* 参数`$offset`为全部素材的偏移位置(0表示从第一个素材)
* 参数`$count`为返回素材的数量,取值在1到20之间
~~~
// 实例微信接口
$media = & load_wechat('Media');
// 执行接口操作
$result = $media->getForeverList($type, $offset, $count);
// 处理执行的结果
if($result===FALSE){
// 接口失败的处理
echo $media->errMsg;
}else{
// 接口成功的处理
}
~~~
## **获取永久素材总数**
~~~
// 实例微信接口
$media = & load_wechat('Media');
// 执行接口操作
$result = $media->getForeverCount();
// 处理执行的结果
if($result===FALSE){
// 接口失败的处理
echo $media->errMsg;
}else{
// 接口成功的处理
}
~~~
## **上传图文消息素材(用于群发)**
* 参数`$data`为图文数据`{"articles":[{...}]}`
* 图文上传完成后,会反回素材对应的`media_id`
~~~
// 实例微信接口
$media = & load_wechat('Media');
// 执行接口操作
$result = $media->uploadArticles($data);
// 处理执行的结果
if($result===FALSE){
// 接口失败的处理
echo $media->errMsg;
}else{
// 接口成功的处理
}
~~~
## **上传视频素材**
* 参数`$data`为视频数据`{"media_id":"", "title":"TITLE","description":"Description"}`
* 视频上传成功后,会返回`{"type":"video","media_id":"mediaid","created_at":1398848981}`
~~~
// 实例微信接口
$media = & load_wechat('Media');
// 执行接口操作
$result = $media->uploadMpVideo($data);
// 处理执行的结果
if($result===FALSE){
// 接口失败的处理
echo $media->errMsg;
}else{
// 接口成功的处理
}
~~~
## **微信图文消息推送**
* 参数`$data`为图文数据包,格式可以参数微信官方文档
~~~
// 实例微信接口
$wechat = &load_wechat('Receive');
// 执行接口操作
$result = $wechat->sendGroupMassMessage($data);
// 处理执行的结果
if($result===FALSE){
// 接口失败的处理
echo $media->errMsg;
}else{
// 接口成功的处理
}
~~~