# 设置小程序服务状态

调试诊断

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

接口英文名:setVisitStatus

  • 本接口用于修改小程序服务状态(仅供第三方代小程序调用)。使用过程中如遇到问题,可在开放平台服务商专区发帖交流。

  • 说明:该接口控制的服务状态信息对应的是mp控制台上的“暂停服务设置”所控制的小程序服务状态

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/wxa/change_visitstatus?access_token=ACCESS_TOKEN

# 云调用

  • 本接口不支持云调用

# 第三方调用

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

  • 该接口所属的权限集 id 为:18

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

# 2. 请求参数

# 查询参数 Query String parameters

参数名类型必填说明
access_tokenstring接口调用凭证,可使用 authorizer_access_token

# 请求体 Request Payload

参数名类型必填说明
actionstring设置可访问状态,发布后默认可访问,close 为不可见,open 为可见

# 3. 返回参数

# 返回体 Response Payload

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

# 4. 注意事项

本接口无特殊注意事项

# 5. 代码示例

请求示例

{
  "action": "close"
}

返回示例

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

# 6. 错误码

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

错误码错误描述解决方案
-1system error系统繁忙,此时请开发者稍候再试
0okok

# 7. 适用范围

本接口支持「第三方平台」账号类型代调用,权限集请参考「调用方式」部分。其他账号类型如无特殊说明,均不可调用。