# 获取自动回复规则 [调试诊断](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_tools) > 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。 接口英文名：getCurrentAutoreplyInfo 获取公众号当前使用的自动回复规则，包括关注后自动回复、消息自动回复、关键词自动回复 1. 第三方平台开发者可以通过本接口，在旗下公众号将业务授权给你后，立即通过本接口检测公众号的自动回复配置。 2. 本接口仅能获取公众号在公众平台官网的自动回复功能中设置的自动回复规则，若公众号自行开发实现自动回复，或通过第三方平台开发者来实现，则无法获取。 3. 认证/未认证的服务号/订阅号，以及接口测试号，均拥有该接口权限。 4. 从第三方平台的公众号登录授权机制上来说，该接口从属于消息与菜单权限集。 5. 本接口中返回的图片/语音/视频为临时素材（临时素材每次获取都不同，3天内有效，通过素材管理-获取临时素材接口来获取这些素材），本接口返回的图文消息为永久素材素材（通过素材管理-获取永久素材接口来获取这些素材）。 ## 1. 调用方式 ### HTTPS 调用 ```bash GET https://api.weixin.qq.com/cgi-bin/get_current_autoreply_info?access_token=ACCESS_TOKEN ``` ### 云调用 - 本接口不支持云调用。 ### 第三方调用 - 本接口支持第三方平台代商家调用。 - 该接口所属的权限集 id 为：1、3、15 - 服务商获得其中之一权限集授权后，可通过使用 [authorizer_access_token](/doc/oplatform/developers/dev/AuthorizerAccessToken.md) 代商家进行调用，具体可查看 [第三方调用](/doc/oplatform/Third-party_Platforms/2.0/Before_Develop/call_interface.md) 说明文档。 ## 2. 请求参数 ### 查询参数 `Query String Parameters` ```json [ { "参数名": "access_token", "类型": "string", "必填": "是", "说明": "接口调用凭证，可使用 [access_token](/doc/subscription/api/base/api_getaccesstoken)、[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)" } ] ``` ### 请求体 `Request Payload` 无 ## 3. 返回参数 ### 返回体 `Response Payload` ```json [ { "参数名": "is_add_friend_reply_open", "类型": "number", "说明": "关注后自动回复是否开启(0-未开启 1-开启)" }, { "参数名": "is_autoreply_open", "类型": "number", "说明": "消息自动回复是否开启(0-未开启 1-开启)" }, { "参数名": "add_friend_autoreply_info", "类型": "object", "说明": "关注后自动回复的信息" }, { "参数名": "message_default_autoreply_info", "类型": "object", "说明": "消息自动回复的信息" }, { "参数名": "keyword_autoreply_info", "类型": "object", "说明": "关键词自动回复的信息" } ] ``` ### Res.add_friend_autoreply_info `Object Payload` 关注后自动回复的信息 ```json [ { "参数名": "type", "类型": "string", "示例": "text", "说明": "自动回复的类型。关注后自动回复和消息自动回复的类型仅支持文本（text）、图片（img）、语音（voice）、视频（video），关键词自动回复则还多了图文消息（news）", "枚举": "text\nimg\nvoice\nvideo\nnews" }, { "参数名": "content", "类型": "string", "示例": "示例文本", "说明": "对于文本类型，content是文本内容，对于图文、图片、语音、视频类型，content是mediaID", "枚举": "-" } ] ``` ### Res.message_default_autoreply_info `Object Payload` 消息自动回复的信息 ```json [ { "参数名": "type", "类型": "string", "示例": "text", "说明": "自动回复的类型。关注后自动回复和消息自动回复的类型仅支持文本（text）、图片（img）、语音（voice）、视频（video），关键词自动回复则还多了图文消息（news）", "枚举": "text\nimg\nvoice\nvideo\nnews" }, { "参数名": "content", "类型": "string", "示例": "示例文本", "说明": "对于文本类型，content是文本内容，对于图文、图片、语音、视频类型，content是mediaID", "枚举": "-" } ] ``` ### Res.keyword_autoreply_info `Object Payload` 关键词自动回复的信息 ```json [ { "参数名": "list", "类型": "objarray", "说明": "自动回复列表" } ] ``` "> ### Res.keyword_autoreply_info.list(Array) `Object Payload` 自动回复列表 ```json [ { "参数名": "rule_name", "类型": "string", "说明": "规则名称" }, { "参数名": "create_time", "类型": "number", "说明": "创建时间" }, { "参数名": "reply_mode", "类型": "string", "说明": "回复模式，reply_all代表全部回复，random_one代表随机回复其中一条" }, { "参数名": "keyword_list_info", "类型": "objarray", "说明": "匹配的关键词列表" }, { "参数名": "reply_list_info", "类型": "objarray", "说明": "回复列表" } ] ``` __keyword_list_info"> ### Res.keyword_autoreply_info.list(Array).keyword_list_info `Object Payload` 匹配的关键词列表 ```json [ { "参数名": "type", "类型": "string", "示例": "text", "说明": "自动回复的类型。关注后自动回复和消息自动回复的类型仅支持文本（text）、图片（img）、语音（voice）、视频（video）", "枚举": "text\nimg\nvoice\nvideo" }, { "参数名": "content", "类型": "string", "示例": "示例文本", "说明": "对于文本类型，content是文本内容，对于图文、图片、语音、视频类型，content是mediaID", "枚举": "-" }, { "参数名": "match_mode", "类型": "string", "示例": "contain", "说明": "匹配模式，contain代表消息中含有该关键词即可，equal表示消息内容必须和关键词严格相同", "枚举": "-" } ] ``` __reply_list_info"> ### Res.keyword_autoreply_info.list(Array).reply_list_info `Object Payload` 回复列表 ```json [ { "参数名": "type", "类型": "string", "示例": "text", "说明": "自动回复的类型。关注后自动回复和消息自动回复的类型仅支持文本（text）、图片（img）、语音（voice）、视频（video），关键词自动回复则还多了图文消息（news）", "枚举": "text\nimg\nvoice\nvideo\nnews" }, { "参数名": "content", "类型": "string", "示例": "示例文本", "说明": "对于文本类型，content是文本内容，对于图文、图片、语音、视频类型，content是mediaID", "枚举": "-" }, { "参数名": "news_info", "类型": "object", "示例": "-", "说明": "图文消息的信息", "枚举": "-" } ] ``` __reply_list_info__news_info"> ### Res.keyword_autoreply_info.list(Array).reply_list_info.news_info `Object Payload` 图文消息的信息 ```json [ { "参数名": "list", "类型": "objarray", "说明": "图文消息列表" } ] ``` __reply_list_info__news_info__list"> ### Res.keyword_autoreply_info.list(Array).reply_list_info.news_info.list `Object Payload` 图文消息列表 ```json [ { "参数名": "title", "类型": "string", "说明": "图文消息的标题" }, { "参数名": "digest", "类型": "string", "说明": "摘要" }, { "参数名": "author", "类型": "string", "说明": "作者" }, { "参数名": "show_cover", "类型": "number", "说明": "是否显示封面，0为不显示，1为显示" }, { "参数名": "cover_url", "类型": "string", "说明": "封面图片的URL" }, { "参数名": "content_url", "类型": "string", "说明": "正文的URL" }, { "参数名": "source_url", "类型": "string", "说明": "原文的URL，若置空则无查看原文入口" } ] ``` ## 4. 注意事项 本接口无特殊注意事项 ## 5. 代码示例 请求示例 ``` json {} ``` 返回示例 ``` json { "is_add_friend_reply_open": 1, "is_autoreply_open": 1, "add_friend_autoreply_info": { "type": "text", "content": "Thanks for your attention!" }, "message_default_autoreply_info": { "type": "text", "content": "Hello, this is autoreply!" }, "keyword_autoreply_info": { "list": [ { "rule_name": "autoreply-news", "create_time": 1423028166, "reply_mode": "reply_all", "keyword_list_info": [ { "type": "text", "match_mode": "contain", "content": "news测试"//此处content即为关键词内容 } ], "reply_list_info": [ { "type": "news", "news_info": { "list": [ { "title": "it's news", "author": "jim", "digest": "it's digest", "show_cover": 1, "cover_url": "http://mmbiz.qpic.cn/mmbiz/GE7et87vE9vicuCibqXsX9GPPLuEtBfXfKbE8sWdt2DDcL0dMfQWJWTVn1N8DxI0gcRmrtqBOuwQH euPKmFLK0ZQ/0", "content_url": "http://mp.weixin.qq.com/s?__biz=MjM5ODUwNTM3Ng==&mid=203929886&idx=1&sn=628f964cf0c6d84c026881b6959aea8b#rd", "source_url": "http://www.url.com" } ] } }, { "type": "news", "content":"KQb_w_Tiz-nSdVLoTV35Psmty8hGBulGhEdbb9SKs-o", "news_info": { "list": [ { "title": "MULTI_NEWS", "author": "JIMZHENG", "digest": "text", "show_cover": 0, "cover_url": "http://mmbiz.qpic.cn/mmbiz/GE7et87vE9vicuCibqXsX9GPPLuEtBfXfK0HKuBIa1A1cypS0uY1wickv70iaY1gf3I1DTszuJoS3lAVLv hTcm9sDA/0", "content_url": "http://mp.weixin.qq.com/s?__biz=MjM5ODUwNTM3Ng==&mid=204013432&idx=1&sn=80ce6d9abcb832237bf86c87e50fda15#rd", "source_url": "" }, { "title": "MULTI_NEWS4", "author": "JIMZHENG", "digest": "MULTI_NEWSMULTI_NEWSMULTI_NEWSMULTI_NEWSMULTI_NEWSMULT", "show_cover": 1, "cover_url": "http://mmbiz.qpic.cn/mmbiz/GE7et87vE9vicuCibqXsX9GPPLuEtBfXfKbE8sWdt2DDcL0dMfQWJWTVn1N8DxI0gcRmrtqBOuwQ HeuPKmFLK0ZQ/0", "content_url": "http://mp.weixin.qq.com/s?__biz=MjM5ODUwNTM3Ng==&mid=204013432&idx=5&sn=b4ef73a915e7c2265e437096582774af#rd", "source_url": "" } ] } } ] }, { "rule_name": "autoreply-voice", "create_time": 1423027971, "reply_mode": "random_one", "keyword_list_info": [ { "type": "text", "match_mode": "contain", "content": "voice测试" } ], "reply_list_info": [ { "type": "voice", "content": "NESsxgHEvAcg3egJTtYj4uG1PTL6iPhratdWKDLAXYErhN6oEEfMdVyblWtBY5vp" } ] }, { "rule_name": "autoreply-text", "create_time": 1423027926, "reply_mode": "random_one", "keyword_list_info": [ { "type": "text", "match_mode": "contain", "content": "text测试" } ], "reply_list_info": [ { "type": "text", "content": "hello!text!" } ] }, { "rule_name": "autoreply-video", "create_time": 1423027801, "reply_mode": "random_one", "keyword_list_info": [ { "type": "text", "match_mode": "equal", "content": "video测试" } ], "reply_list_info": [ { "type": "video", "content": "http://61.182.133.153/vweixinp.tc.qq.com/1007_114bcede9a2244eeb5ab7f76d951df5f.f10.mp4?vkey=7183E5C952B16C3AB1991BA8138673DE1037CB82A29801A504B64A77F691BF9DF7AD054A9B7FE683&sha=0&save=1" } ] } ] } } ``` ## 6. 错误码 以下是本接口的错误码列表，其他错误码可参考 [通用错误码](/doc/oplatform/developers/errCode/README.md)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。 ```json [ { "错误码": "0", "错误描述": "ok或者in a normal state", "解决方案": "ok是指从不正常变成正常 in a normal state是指本来就正常" } ] ``` ## 7. 适用范围 本接口在不同账号类型下的可调用情况： ```json [ { "公众号": "✔", "服务号": "✔" } ] ``` - ✔：该账号可调用此接口。 - 其他未明确声明的账号类型，如无特殊说明，均不可调用此接口。