# Get permanent material
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 Name | type | Required to fill in | Introductions |
---|---|---|---|
access_token | string | yes | Interface invocation credentials, using access_token , authorizer_access_token |
# Request BodyRequest Payload
Parameter Name | type | Required to fill in | Example | Introductions |
---|---|---|---|---|
media_id | string | yes | MEDIA_ID | The media_id of the material to get |
# 3. Return Parameters
# Response Payload
Parameter Name | type | Introductions |
---|---|---|
news_item | objarray | Graphic material, content |
title | string | Video footage, title |
description | string | Video footage, description |
down_url | string | Video Download, Address |
# Res.news_item(Array)Object Payload
Graphic material, content
Parameter Name | type | Introductions |
---|---|---|
title | string | Graphic message title |
thumb_media_id | string | The cover image id of the message (must be a permanent mediaID) |
show_cover_pic | number | Whether to show the cover, 0 is false, that is, do not show, 1 is true, that is, show |
author | string | Author |
digest | string | A summary of a diagram message. Only a single diagram message has a summary. Multiple diagrams are empty here |
content | string | Graphic message specific content, support HTML tags, must be less than 20,000 characters, less than 1M, and here will remove JS |
url | string | URL |
content_source_url | string | The 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 code | Error Description | Solutions |
---|---|---|
-1 | system error | The system is busy, so the developer is asked to try again in a few minutes. |
40001 | invalid credential access_token isinvalid or not latest | AppSecret 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 |
40007 | invalid media_id | Invalid Media ID |
# 7. Scope of application
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;