# Get a list of drafts
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: draft_batchget
Once a draft is added, the draft list information can be obtained from this interface.
# 1. How to call
# HTTPS calls
POST https://api.weixin.qq.com/cgi-bin/draft/batchget?access_token=ACCESS_TOKEN
# Cloud Calls
- This interface does not support cloud calls
# 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 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 |
---|---|---|---|---|
offset | number | yes | 0 | Returns from this shifting position of all the material, and 0 means returning from the first material |
count | number | yes | 10 | Returns the amount of material with a value between 1 and 20. |
no_content | number | no | 1 | 1 means that the content field is not returned, 0 means that the normal return, the default is 0 |
# 3. Return Parameters
# Response Payload
Parameter Name | type | Introductions |
---|---|---|
total_count | number | Total number of draft material |
item_count | number | The amount of material obtained from this call |
item | objarray | List of materials |
# Res.item(Array)Object Payload
List of materials
Parameter Name | type | Introductions |
---|---|---|
media_id | string | The id of the text message |
content | object | Graphic message content |
update_time | number | When the Graphic Message was updated |
# Res.item(Array).contentObject Payload
Graphic message content
Parameter Name | type | Introductions |
---|---|---|
news_item | objarray | List of Graphic Content |
# Res.item(Array).content.news_itemObject Payload
List of Graphic Content
Parameter Name | type | Introductions |
---|---|---|
article_type | string | Article types, there are graphic message (news), picture message (newspic), do not fill in the default graphic message (news) |
title | string | title |
author | string | Author |
digest | string | A summary of a picture message. Only a single picture message has a summary; multiple pictures are empty here. If this field is not filled, the first 54 words of the text are grabbed by default. |
content | string | The specific content of the text message, which supports HTML tags, must be less than 20,000 characters and less than 1M, and the JS is removed here. The image URL involved must be from "Upload text message Image fetch URL" Interface fetch.External image URLs will be filtered. Photo messages only support plain text and some special features such as a product, and the number of products cannot exceed 50. |
content_source_url | string | The original address of the text message, that is, the URL after clicking "Read More" |
thumb_media_id | string | The cover image id of the message (must be a permanent MediaID) |
need_open_comment | number | Whether to open comments, 0 does not open (default), 1 opens |
only_fans_can_comment | number | Whether fans can comment, 0 everyone can comment (default), 1 fan can comment |
image_info | object | Image messages include information about images, up to 20 images, with the first image being the cover picture |
product_info | object | Product Information |
url | string | A temporary link to the draft |
# Res.item(Array).content.news_item.image_infoObject Payload
Image messages include information about images, up to 20 images, with the first image being the cover picture
Parameter Name | type | Introductions |
---|---|---|
image_list | objarray | List of Pictures |
# Res.item(Array).content.news_item.image_info.image_listObject Payload
List of Pictures
Parameter Name | type | Introductions |
---|---|---|
image_media_id | string | The image id in the image message (must be a permanent MediaID) |
# Res.item(Array).content.news_item.product_infoObject Payload
Product Information
Parameter Name | type | Introductions |
---|---|---|
footer_product_info | object | Insert merchandise-related information at the end of the text |
# Res.item(Array).content.news_item.product_info.footer_product_infoObject Payload
Insert merchandise-related information at the end of the text
Parameter Name | type | Introductions |
---|---|---|
product_key | string | Product key |
# 4. Note
There are no special considerations for this interface
# 5. Code examples
Example Requests
{
"offset": 0,
"count": 10,
"no_content": 1
}
Return an example
{
"total_count":TOTAL_COUNT,
"item_count":ITEM_COUNT,
"item":[
{
"media_id":MEDIA_ID,
"content": {
"news_item" : [
{
"article_type":"news",
"title":TITLE,
"author":AUTHOR,
"digest":DIGEST,
"content":CONTENT,
"content_source_url":CONTENT_SOURCE_URL,
"thumb_media_id":THUMB_MEDIA_ID,
"need_open_comment":0,
"only_fans_can_comment":0,
"url":URL
},
{
"article_type":"newspic",
"title":TITLE,
"content":CONTENT,
"thumb_media_id":THUMB_MEDIA_ID,
"need_open_comment":0,
"only_fans_can_comment":0,
"image_info":{
"image_list":[
{
"image_media_id":IMAGE_MEDIA_ID
}
]
},
"product_info": {
"footer_product_info": {
"product_key":PRODUCT_KEY
}
},
"url":URL
}
]
},
"update_time": UPDATE_TIME
}
]
}
# 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 |
---|---|---|
0 | success | OK means to go from abnormal to normal in a normal state |
# 7. Scope of application
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;