# Get a list of permanent materials

Debugging Tools

Interface should be called on the server side, not in the front end (Weixin Mini Program, web pages, APP, etc.) directly called, specific reference interface call guide

Interface name: batchGetMaterial

Get a permanent material list by type, including Official Account in the official website material management module new material

# 1. How to call

# HTTPS calls

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

# Cloud Calls

  • Call method: officialAccount.material.batchGetMaterial

  • The input and exit parameters are the same as the HTTPS call, which can be called in the cloud call documentation

# Third party invocation

  • This interface supports Third Party Platform generation business call.

  • The permission set to which this interface belongs is: 11,100

  • When a service provider is authorized by one of the permissions set, it can call on behalf of the merchant by using authorizer_access_token , which can be viewed in the third-party call documentation.

# 2. Request parameters

# Query parametersQuery String parameters

Parameter NametypeRequired to fill inIntroductions
access_tokenstringyesInterface invocation credentials, using access_token , authorizer_access_token

# Request BodyRequest Payload

Parameter NametypeRequired to fill inExampleIntroductionsto enumerate
typestringyesimageType of material, image, video (video), voice, text (news)image video voice news
offsetnumberyes0Returns from this shift position of all the material, and 0 means returning from the first material-
countnumberyes20Returns the amount of material with a value between 1 and 20.-

# 3. Return Parameters

# Response Payload

Parameter NametypeIntroductions
itemobjarrayMultiple Graphic Messages
total_countnumberTotal number of material of this type
item_countnumberThe amount of material obtained from this call

# Res.item(Array)Object Payload

Multiple Graphic Messages

Parameter NametypeIntroductions
media_idstringMessage ID
contentobjectGraphic message, content
update_timenumberDate of update
namestringThe names of pictures, voice, video material
urlstringImage, voice, video footage URL

# Res.item(Array).contentObject Payload

Graphic message, content

Parameter NametypeIntroductions
news_itemobjarray1 or more articles within the text message

# Res.item(Array).content.news_itemObject Payload

1 or more articles within the text message

Parameter NametypeIntroductions
titlestringGraphic message title
authorstringAuthor
digeststringA summary of a diagram message. Only a single diagram message has a summary. Multiple diagrams are empty here
contentstringGraphic message specific content, support HTML tags, must be less than 20,000 characters, less than 1M, and here will remove JS
content_source_urlstringThe original address of the text message, that is, the URL after clicking "Read More"
thumb_media_idstringThe cover image id of the message (must be a permanent mediaID)
show_cover_picnumberWhether to show the cover, 0 is false, that is, do not show, 1 is true, that is, show
urlstringThe URL of the picture page, or, when the fetched list is a picture material list, the field is the URL of the picture
thumb_urlstringThe cover image id of the message (must be a permanent mediaID)

# 4. Note

  1. Contains graphic messages, voice, video and other materials created by the official website of the public platform
  2. Temporary material cannot be obtained through this interface 3, need https protocol call

# 5. Code examples

# 5.1 Get graphic material

Example Requests

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

Return an example

{
  "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 Get image footage

Example Requests

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

Return an example

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

# 6. Error code

The following is a list of error codes for this interface, other error codes can refer to General error codes

Error codeError DescriptionSolutions
-1system errorThe system is busy, so the developer is asked to try again in a few minutes.
40001invalid credential  access_token isinvalid or not latestAppSecret error while getting access_token, or access_token is invalid.Developers should check that AppSecret is correct, or that they are calling interfaces for the appropriate Official Account
40004invalid media typeUnlawful Types of Media Files
40007invalid media_idInvalid Media ID Error

# 7. Scope of application

How this interface can be invoked under different account types:
Official Account Service Account
  • ✔: The account can call this interface
  • Other account types that are not expressly stated may not be called on this interface without special instructions;