# 管理微信令牌权限

[调试诊断](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_tools)

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：setCloudAccessToken

通过本接口可以开启或关闭cloudbase_access_token的使用权限。使用过程中如遇到问题，可在[开放平台服务商专区](https://developers.weixin.qq.com/community/minihome/mixflow/1355698687267438595)发帖交流。

## 1. 调用方式

### HTTPS 调用

```bash
POST https://api.weixin.qq.com/tcb/usecloudaccesstoken?access_token=ACCESS_TOKEN
```

### 云调用

- 本接口不支持云调用。

### 第三方调用

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

- 该接口所属的权限集 id 为：49

- 服务商获得其中之一权限集授权后，可通过使用 [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",
    "必填": "是",
    "说明": "接口调用凭证，可使用 [authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "action",
    "类型": "string",
    "必填": "是",
    "说明": "可选get或者set"
  },
  {
    "参数名": "open",
    "类型": "boolean",
    "必填": "是",
    "说明": "true表示开启，false表示关闭。全局配置，action=set时必填。"
  },
  {
    "参数名": "api_whitelist",
    "类型": "array",
    "必填": "是",
    "说明": "api白名单，action=set时必填。"
  },
  {
    "参数名": "env",
    "类型": "string",
    "必填": "是",
    "说明": "环境 id , 白名单为环境维度配置"
  },
  {
    "参数名": "version",
    "类型": "number",
    "必填": "是",
    "说明": "版本号，action=set时必填"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误信息"
  },
  {
    "参数名": "open",
    "类型": "boolean",
    "说明": "开启/关闭，action=get时返回"
  },
  {
    "参数名": "api_whitelist",
    "类型": "array",
    "说明": "api白名单，action=get时返回"
  },
  {
    "参数名": "version",
    "类型": "number",
    "说明": "版本号，action=get时返回"
  }
]
```

## 4. 注意事项

- 此权限默认为开启状态，调用此接口关闭cloudbase_access_token的使用权限后，该账号便无法用cloudbase_access_token。按需配置允许使用微信令牌的开放接口，未配置的接口无法使用云调用。
- 如果是批量代云开发，则使用[component_access_token](/doc/oplatform/openApi/ticket-token/api_getcomponentaccesstoken)；
- 如果是普通代云开发，则使用[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken)。

## 5. 代码示例

### 5.1 get示例

请求示例

```json
{
    "action": "get",
    "env": "myttest-8gu57so0bd9f9e8a",
}
```

返回示例

```json
{
  "errcode": 0,
  "errmsg": "ok",
  "open": true,
  "api_whitelist": [
    "/*"
  ],
  "version": 2
}
```

### 5.2 set示例

请求示例

```json
{
  "action": "set",
  "open": true,
  "env": "myttest-8gu57so0bd9f9e8a",
  "api_whitelist": [
    "/*"
  ],
  "version": 6
}
```

返回示例

```json
{
  "errcode": 0,
  "errmsg": "ok",
  "open": true
}
```

## 6. 错误码

以下是本接口的错误码列表，其他错误码可参考 [通用错误码](/doc/oplatform/developers/errCode/README.md)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

```json
[
  {
    "错误码": "-1000",
    "错误描述": "system error",
    "解决方案": "系统错误"
  },
  {
    "错误码": "40014",
    "错误描述": "invalid access_token",
    "解决方案": "不合法的 access_token ，请开发者认真比对 access_token 的有效性（如是否过期），或查看是否正在为恰当的公众号调用接口"
  },
  {
    "错误码": "40097",
    "错误描述": "invalid args",
    "解决方案": "参数错误"
  },
  {
    "错误码": "40101",
    "错误描述": "missing parameter",
    "解决方案": "缺少必填参数"
  },
  {
    "错误码": "41001",
    "错误描述": "access_token missing",
    "解决方案": "缺少 access_token 参数"
  },
  {
    "错误码": "42001",
    "错误描述": "access_token expired",
    "解决方案": "access_token 超时，请检查 access_token 的有效期，请参考基础支持 - 获取 access_token 中，对 access_token 的详细机制说明"
  },
  {
    "错误码": "43002",
    "错误描述": "require POST method",
    "解决方案": "需要 POST 请求"
  },
  {
    "错误码": "44002",
    "错误描述": "empty post data",
    "解决方案": "POST 的数据包为空。post请求body参数不能为空。"
  },
  {
    "错误码": "47001",
    "错误描述": "data format error",
    "解决方案": "解析 JSON/XML 内容错误;post 数据中参数缺失;检查修正后重试。"
  },
  {
    "错误码": "85088",
    "错误描述": "no qbase privilege",
    "解决方案": "该APP未开通云开发"
  }
]
```

## 7. 适用范围

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