# 获取永久素材列表

[调试诊断](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_tools)

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：batchGetMaterial

分类型获取永久素材列表，包含公众号在官网素材管理模块新建的素材

## 1. 调用方式

### HTTPS 调用

```bash
POST https://api.weixin.qq.com/cgi-bin/material/batchget_material?access_token=ACCESS_TOKEN
```

### 云调用

- 调用方法：officialAccount.material.batchGetMaterial

- 出入参和 HTTPS 调用相同，调用方式可查看 [云调用](/doc/oplatform/developers/dev/cloudCall.md) 说明文档。

### 第三方调用

- 本接口支持第三方平台代商家调用。

- 该接口所属的权限集 id 为：11、100

- 服务商获得其中之一权限集授权后，可通过使用 [authorizer_access_token](/doc/oplatform/developers/dev/AuthorizerAccessToken.md) 代商家进行调用，具体可查看 [第三方调用](/doc/oplatform/Third-party_Platforms/2.0/Before_Develop/call_interface.md) 说明文档。

## 2. 请求参数

### 查询参数 `Query String Parameters`

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "说明": "接口调用凭证，可使用 [access_token](/doc/subscription/api/base/api_getaccesstoken)、[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "type",
    "类型": "string",
    "必填": "是",
    "示例": "image",
    "说明": "素材的类型，图片（image）、视频（video）、语音 （voice）、图文（news）",
    "枚举": "image\nvideo\nvoice\nnews"
  },
  {
    "参数名": "offset",
    "类型": "number",
    "必填": "是",
    "示例": "0",
    "说明": "从全部素材的该偏移位置开始返回，0表示从第一个素材 返回",
    "枚举": "-"
  },
  {
    "参数名": "count",
    "类型": "number",
    "必填": "是",
    "示例": "20",
    "说明": "返回素材的数量，取值在1到20之间",
    "枚举": "-"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "item",
    "类型": "objarray",
    "说明": "多个图文消息"
  },
  {
    "参数名": "total_count",
    "类型": "number",
    "说明": "该类型的素材的总数"
  },
  {
    "参数名": "item_count",
    "类型": "number",
    "说明": "本次调用获取的素材的数量"
  }
]
```

">

### Res.item(Array) `Object Payload`

多个图文消息

```json
[
  {
    "参数名": "media_id",
    "类型": "string",
    "说明": "消息ID"
  },
  {
    "参数名": "content",
    "类型": "object",
    "说明": "图文消息，内容"
  },
  {
    "参数名": "update_time",
    "类型": "number",
    "说明": "更新日期"
  },
  {
    "参数名": "name",
    "类型": "string",
    "说明": "图片、语音、视频素材的名字"
  },
  {
    "参数名": "url",
    "类型": "string",
    "说明": "图片、语音、视频素材URL"
  }
]
```

__content">

### Res.item(Array).content `Object Payload`

图文消息，内容

```json
[
  {
    "参数名": "news_item",
    "类型": "objarray",
    "说明": "图文消息内的1篇或多篇文章"
  }
]
```

__content__news_item">

### Res.item(Array).content.news_item `Object Payload`

图文消息内的1篇或多篇文章

```json
[
  {
    "参数名": "title",
    "类型": "string",
    "说明": "图文消息的标题"
  },
  {
    "参数名": "author",
    "类型": "string",
    "说明": "作者"
  },
  {
    "参数名": "digest",
    "类型": "string",
    "说明": "图文消息的摘要，仅有单图文消息才有摘要，多图文此处为空"
  },
  {
    "参数名": "content",
    "类型": "string",
    "说明": "图文消息的具体内容，支持HTML标签，必须少于2万字符，小于1M，且此处会去除JS"
  },
  {
    "参数名": "content_source_url",
    "类型": "string",
    "说明": "图文消息的原文地址，即点击“阅读原文”后的URL"
  },
  {
    "参数名": "thumb_media_id",
    "类型": "string",
    "说明": "图文消息的封面图片素材id（必须是永久mediaID）"
  },
  {
    "参数名": "show_cover_pic",
    "类型": "number",
    "说明": "是否显示封面，0为false，即不显示，1为true，即显示"
  },
  {
    "参数名": "url",
    "类型": "string",
    "说明": "图文页的URL，或者，当获取的列表是图片素材列表时，该字段是图片的URL"
  },
  {
    "参数名": "thumb_url",
    "类型": "string",
    "说明": "图文消息的封面图片素材id（必须是永久mediaID）"
  }
]
```

## 4. 注意事项

1、包含公众平台官网新建的图文消息、语音、视频等素材
2、临时素材无法通过本接口获取
3、需https协议调用

## 5. 代码示例

### 5.1 获取图文素材

请求示例

``` json
{
  "type": "news",
  "offset": 0,
  "count": 20
}
```

返回示例

``` json
{
  "total_count": 100,
  "item_count": 20,
  "item": [
    {
      "media_id": "MEDIA_ID",
      "content": {
        "news_item": [
          {
            "title": "TITLE",
            "thumb_media_id": "THUMB_MEDIA_ID",
            "show_cover_pic": 1,
            "author": "AUTHOR",
            "digest": "DIGEST",
            "content": "CONTENT",
            "url": "URL",
            "content_source_url": "CONTENT_SOURCE_URL"
          }
        ]
      },
      "update_time": 1620000000
    }
  ]
}
```

### 5.2 获取图片素材

请求示例

``` json
{
  "type": "image",
  "offset": 0,
  "count": 10
}
```

返回示例

``` json
{
  "total_count": 50,
  "item_count": 10,
  "item": [
    {
      "media_id": "MEDIA_ID",
      "name": "IMAGE.jpg",
      "update_time": 1620000000,
      "url": "http://mmbiz.qpic.cn/xxx"
    }
  ]
}
```

## 6. 错误码

以下是本接口的错误码列表，其他错误码可参考 [通用错误码](/doc/oplatform/developers/errCode/README.md)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

```json
[
  {
    "错误码": "-1",
    "错误描述": "system error",
    "解决方案": "系统繁忙，此时请开发者稍候再试"
  },
  {
    "错误码": "40001",
    "错误描述": "invalid credential  access_token isinvalid or not latest",
    "解决方案": "获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口"
  },
  {
    "错误码": "40004",
    "错误描述": "invalid media type",
    "解决方案": "不合法的媒体文件类型"
  },
  {
    "错误码": "40007",
    "错误描述": "invalid media_id",
    "解决方案": "无效媒体ID错误"
  }
]
```

## 7. 适用范围

本接口在不同账号类型下的可调用情况：

```json
[
  {
    "公众号": "✔",
    "服务号": "✔"
  }
]
```

- ✔：该账号可调用此接口。
- 其他未明确声明的账号类型，如无特殊说明，均不可调用此接口。