# Update draft
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_update
This interface is used to modify a text or a picture message draft.
# 1. How to call
# HTTPS calls
POST https://api.weixin.qq.com/cgi-bin/draft/update?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 | Example | Introductions |
---|---|---|---|---|
access_token | string | yes | ACCESS_TOKEN | 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 id of the graphic message to modify |
index | number | yes | 0 | To update the position of the article in the diagram message (this field makes sense when there are multiple diagram messages). The first article is 0 |
articles | object | yes | - | Graphic information |
# Body.articlesObject Payload
Graphic information
Parameter Name | type | Required to fill in | Introductions |
---|---|---|---|
article_type | string | no | Article types, there are graphic message (news), picture message (newspic), do not fill in the default graphic message (news) |
title | string | yes | title |
author | string | no | Author |
digest | string | no | 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 | yes | 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 | no | The original address of the text message, that is, the URL after clicking "Read More" |
thumb_media_id | string | no | The cover image id of the message (must be a permanent MediaID) |
need_open_comment | number | no | Whether to open comments, 0 does not open (default), 1 opens |
only_fans_can_comment | number | no | Whether fans can comment, 0 everyone can comment (default), 1 fan can comment |
pic_crop_235_1 | string | no | The text message cover is trimmed to a 2.35: 1 coordinate field. Using the original image (thumb_media_id), the upper left corner (0,0), the lower right corner (1,1) to establish a flat seating system, The coordinates of the cropped image are (X1, Y1), in the upper left corner, and (X2, Y2), spliced by separator_as X1, Y1, X2, Y2. The accuracy of each coordinate value is no more than six digits after the decimal point. For example, see the following figure, where (X1, Y1) is equal to (0.1945, 0), and (X2, Y2) is equal to (1,0.5236), so the request parameter value is 0.1945_0_1_0.5236。 |
pic_crop_1_1 | string | no | The cover of the graphic message is cropped to coordinate fields of 1: 1 specifications, and the principle of cropping is the same as pic_crop_235_1, The cropped picture must conform to the specifications. |
image_info | object | yes | Image messages include information about images, up to 20 images, with the first image being the cover picture |
cover_info | object | no | Image message cover information |
product_info | object | no | Product Information |
# Body.articles.image_infoObject Payload
Image messages include information about images, up to 20 images, with the first image being the cover picture
Parameter Name | type | Required to fill in | Introductions |
---|---|---|---|
image_list | objarray | yes | List of Pictures |
# Body.articles.image_info.image_list(Array)Object Payload
List of Pictures
Parameter Name | type | Required to fill in | Introductions |
---|---|---|---|
image_media_id | string | yes | The image id in the image message (must be a permanent MediaID) |
# Body.articles.cover_infoObject Payload
Image message cover information
Parameter Name | type | Required to fill in | Introductions |
---|---|---|---|
crop_percent_list | objarray | no | Cover tailoring information. Create a plane coordinate system with the upper left corner of the picture (0,0) and the lower right corner (1, 1). The coordinates in the upper right corner of a cropped picture are filled with the x1, y1 parameters, and the coordinates in lower right are filled in the x2, y2 parameters |
# Body.articles.cover_info.crop_percent_list(Array)Object Payload
Cover tailoring information. Create a plane coordinate system with the upper left corner of the picture (0,0) and the lower right corner (1, 1). The coordinates in the upper right corner of a cropped picture are filled with the x1, y1 parameters, and the coordinates in lower right are filled in the x2, y2 parameters
Parameter Name | type | Required to fill in | Introductions |
---|---|---|---|
ratio | string | no | Silhouette ratio, support: "1_1,," "16_9," "2.35_1" |
x1 | string | no | To the upper left corner of the picture (0,0), the lower right corner (1,1) to establish a plane seat system, after cutting the picture, the upper left corner of the coordinates filled in x1, y1 parameters |
y1 | string | no | To the upper left corner of the picture (0,0), the lower right corner (1,1) to establish a plane seat system, after cutting the picture, the upper left corner of the coordinates filled in x1, y1 parameters |
x2 | string | no | To the upper left corner of the picture (0,0), the lower right corner (1,1) to establish a plane seat system, after cutting the picture, its lower right corner coordinates filled in x2, y2 parameters |
y2 | string | no | To the upper left corner of the picture (0,0), the lower right corner (1,1) to establish a plane seat system, after cutting the picture, its lower right corner coordinates filled in x2, y2 parameters |
# Body.articles.product_infoObject Payload
Product Information
Parameter Name | type | Required to fill in | Introductions |
---|---|---|---|
footer_product_info | object | no | Insert merchandise-related information at the end of the text |
# Body.articles.product_info.footer_product_infoObject Payload
Insert merchandise-related information at the end of the text
Parameter Name | type | Required to fill in | Introductions |
---|---|---|---|
product_key | string | no | Product key |
# 3. Return Parameters
# Response Payload
Parameter Name | type | Introductions |
---|---|---|
errcode | number | Error code |
errmsg | string | Error message |
# 4. Note
There are no special considerations for this interface
# 5. Code examples
# 5.1 Update the draft text message
Example Requests
{
"media_id":MEDIA_ID,
"index":INDEX,
"articles":{
"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,
"pic_crop_235_1":X1_Y1_X2_Y2,
"pic_crop_1_1":X1_Y1_X2_Y2
}
}
Return an example
{
"errcode": 0,
"errmsg": "ok"
}
# 5.2 Update Photo Message Draft
Example Requests
{
"media_id":MEDIA_ID,
"index":INDEX,
"articles":{
"article_type":"newspic",
"title":TITLE,
"content":CONTENT,
"need_open_comment":0,
"only_fans_can_comment":0,
"image_info":{
"image_list":[
{
"image_media_id":IMAGE_MEDIA_ID
}
]
},
"cover_info":{
"crop_percent_list":[
{
"ratio": "1_1",
"x1":"0.166454",
"y1":"0",
"x2":"0.833545",
"y2":"1"
}
// 如有其他比例的裁剪需求,可继续在此处填写
]
},
"product_info": {
"footer_product_info": {
"product_key":PRODUCT_KEY
}
}
}
}
Return an example
{
"errcode": 0,
"errmsg": "ok"
}
# 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 | ok | success |
40114 | invalid index value | |
41039 | invalid content_source_url | |
45166 | invalid content | |
53404 | Accounts have been restricted in their ability to deliver goods | Please delete the item and try again |
53405 | The product information was inserted in error | Please check the parameters and the condition of the product |
53406 | Please turn on the delivery capability first | |
88000 | without comment privilege |
# 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;