服务号
取消
中文
中文
EN
取消
  • 服务端 API

    • # 更新草稿

    调试诊断

    接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考接口调用指南。

    接口英文名：draft_update

    本接口用于修改图文或图片消息草稿

    # 1. 调用方式

    # HTTPS 调用

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

    # 云调用

    • 本接口不支持云调用。

    # 第三方调用

    • 本接口支持第三方平台代商家调用。

    • 该接口所属的权限集 id 为：11、100

    • 服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用，具体可查看 第三方调用 说明文档。

    # 2. 请求参数

    # 查询参数 Query String Parameters

    参数名类型必填示例说明
    access_tokenstring是ACCESS_TOKEN接口调用凭证，可使用 access_token、authorizer_access_token

    # 请求体 Request Payload

    参数名类型必填示例说明
    media_idstring是MEDIA_ID要修改的图文消息的id
    indexnumber是0要更新的文章在图文消息中的位置（多图文消息时，此字段才有意义），第一篇为0
    articlesobject是-图文信息

    # Body.articles Object Payload

    图文信息

    参数名类型必填说明
    article_typestring否文章类型，分别有图文消息（news）、图片消息（newspic），不填默认为图文消息（news）
    titlestring是标题
    authorstring否作者
    digeststring否图文消息的摘要，仅有单图文消息才有摘要，多图文此处为空。如果本字段为没有填写，则默认抓取正文前54个字。
    contentstring是图文消息的具体内容，支持HTML标签，必须少于2万字符，小于1M，且此处会去除JS,涉及图片url必须来源 "上传图文消息内的图片获取URL"接口获取。外部图片url将被过滤。 图片消息则仅支持纯文本和部分特殊功能标签如商品，商品个数不可超过50个
    content_source_urlstring否图文消息的原文地址，即点击“阅读原文”后的URL
    thumb_media_idstring否图文消息的封面图片素材id（必须是永久MediaID）
    need_open_commentnumber否是否打开评论，0不打开(默认)，1打开
    only_fans_can_commentnumber否是否粉丝才可评论，0所有人可评论(默认)，1粉丝才可评论
    image_infoobject是图片消息里的图片相关信息，图片数量最多为20张，首张图片即为封面图
    cover_infoobject否封面信息，图文消息（news）和图片消息（newspic）均适用
    product_infoobject否商品信息

    # Body.articles.image_info Object Payload

    图片消息里的图片相关信息，图片数量最多为20张，首张图片即为封面图

    参数名类型必填说明
    image_listobjarray是图片列表

    # Body.articles.image_info.image_list(Array) Object Payload

    图片列表

    参数名类型必填说明
    image_media_idstring是图片消息里的图片素材id（必须是永久MediaID）

    # Body.articles.cover_info Object Payload

    封面信息，图文消息（news）和图片消息（newspic）均适用

    参数名类型必填说明
    crop_percent_listobjarray否封面裁剪信息。以图片左上角（0,0）、右下角（1,1）建立平面坐标系，裁剪区域左上角坐标填入 x1、y1，右下角坐标填入 x2、y2

    # Body.articles.cover_info.crop_percent_list(Array) Object Payload

    封面裁剪信息。以图片左上角（0,0）、右下角（1,1）建立平面坐标系，裁剪区域左上角坐标填入 x1、y1，右下角坐标填入 x2、y2

    参数名类型必填说明
    ratiostring否裁剪比例。图文消息（news）仅支持“2.35_1”“1_1”；图片消息（newspic）支持“1_1”“16_9”“2.35_1”
    x1string否裁剪区域左上角的横坐标
    y1string否裁剪区域左上角的纵坐标
    x2string否裁剪区域右下角的横坐标
    y2string否裁剪区域右下角的纵坐标

    # Body.articles.product_info Object Payload

    商品信息

    参数名类型必填说明
    footer_product_infoobject否文末插入商品相关信息

    # Body.articles.product_info.footer_product_info Object Payload

    文末插入商品相关信息

    参数名类型必填说明
    product_keystring否商品key

    # 3. 返回参数

    # 返回体 Response Payload

    参数名类型说明
    errcodenumber错误码
    errmsgstring错误信息

    # 4. 注意事项

    本接口无特殊注意事项

    # 5. 代码示例

    # 5.1 更新图文消息草稿

    请求示例

    {
    "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,
        "cover_info":{
            "crop_percent_list":[
                {
                    "ratio":"2.35_1",
                    "x1":"0.1945",
                    "y1":"0",
                    "x2":"1",
                    "y2":"0.5236"
                },
                {
                    "ratio":"1_1",
                    "x1":"0",
                    "y1":"0",
                    "x2":"1",
                    "y2":"1"
                }
            ]
        }
    }
}

    返回示例

    {
  "errcode": 0,
  "errmsg": "ok"
}

    # 5.2 更新图片消息草稿

    请求示例

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

    返回示例

    {
  "errcode": 0,
  "errmsg": "ok"
}

    # 6. 错误码

    以下是本接口的错误码列表，其他错误码可参考 通用错误码；调用接口遇到报错，可使用官方提供的 API 诊断工具 辅助定位和分析问题。

    错误码错误描述解决方案
    0ok成功
    40114invalid index value
    41039invalid content_source_url
    45166invalid content
    53404账号已被限制带货能力请删除商品后重试
    53405插入商品信息有误请检查参数及商品状态
    53406请先开通带货能力
    88000without comment privilege

    # 7. 适用范围

    本接口在不同账号类型下的可调用情况：
    公众号服务号
    ✔ ✔
    • ✔：该账号可调用此接口。
    • 其他未明确声明的账号类型，如无特殊说明，均不可调用此接口。