# Get permanent material

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: getMaterial

This interface is used to get the details of the permanent material according to media_id

# 1. How to call

# HTTPS calls

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

# Cloud Calls

  • Call method: officialAccount.material.get

  • 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.

  • This interface belongs to the permission set id: 3,11,18,30-31,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 inExampleIntroductions
media_idstringyesMEDIA_IDThe media_id of the material to get

# 3. Return Parameters

# Response Payload

Parameter NametypeIntroductions
news_itemobjarrayGraphic material, content
titlestringVideo footage, title
descriptionstringVideo footage, description
down_urlstringVideo Download, Address

# Res.news_item(Array)Object Payload

Graphic material, content

Parameter NametypeIntroductions
titlestringGraphic message title
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
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
urlstringURL
content_source_urlstringThe original address of the text message, that is, the URL after clicking "Read More"

# 4. Note

Other than text and video, other types of material messages respond directly to the material's content, which the developer can save as a file.

# 5. Code examples

# 5.1 Examples of Graphical Material Requests

Example Requests

{
  "media_id": "MEDIA_ID"
}

Return an example

{
  "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"
    }
  ]
}

# 5.2 Video Material Return Example

Example Requests

{
  "media_id": "MEDIA_ID"
}

Return an example

{
  "title":TITLE,
  "description":DESCRIPTION,
  "down_url":DOWN_URL,
}

# 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
40007invalid media_idInvalid Media ID

# 7. Scope of application

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