# 获取消息推送配置

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

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

接口英文名：getCallBackConfig

通过本接口可以获取消息推送配置。使用过程中如遇到问题，可在[开放平台服务商专区](https://developers.weixin.qq.com/community/minihome/mixflow/1355698687267438595)发帖交流。

## 1. 调用方式

### HTTPS 调用

```bash
POST https://api.weixin.qq.com/tcb/getcallbackconfig?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`

无

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误信息"
  },
  {
    "参数名": "data",
    "类型": "object",
    "说明": "数据"
  }
]
```

### Res.data `Object Payload`

数据

```json
[
  {
    "参数名": "function_config",
    "类型": "object",
    "说明": "云函数配置，若不填则不更新"
  },
  {
    "参数名": "container_config",
    "类型": "object",
    "说明": "云托管配置，若不填则不更新"
  }
]
```

### Res.data.function_config `Object Payload`

云函数配置，若不填则不更新

```json
[
  {
    "参数名": "enable",
    "类型": "boolean",
    "说明": "状态"
  },
  {
    "参数名": "callbacks",
    "类型": "objarray",
    "说明": "配置项"
  }
]
```

">

### Res.data.function_config.callbacks(Array) `Object Payload`

配置项

```json
[
  {
    "参数名": "msgType",
    "类型": "string",
    "说明": "消息类型"
  },
  {
    "参数名": "event",
    "类型": "string",
    "说明": "事件类型"
  },
  {
    "参数名": "env",
    "类型": "string",
    "说明": "环境id"
  },
  {
    "参数名": "functionName",
    "类型": "string",
    "说明": "云函数名称"
  },
  {
    "参数名": "enable",
    "类型": "boolean",
    "说明": "状态"
  }
]
```

### Res.data.container_config `Object Payload`

云托管配置，若不填则不更新

```json
[
  {
    "参数名": "enable",
    "类型": "boolean",
    "说明": "状态"
  },
  {
    "参数名": "qbase_env",
    "类型": "string",
    "说明": "环境id"
  },
  {
    "参数名": "qbase_container_path",
    "类型": "string",
    "说明": "路径"
  },
  {
    "参数名": "text_mode",
    "类型": "number",
    "说明": "文本格式"
  }
]
```

## 4. 注意事项

本接口无特殊注意事项

## 5. 代码示例

请求示例

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

返回示例

```json
{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "function_config": {
      "enable": false,
      "callbacks": [
        {
          "msgType": "event",
          "event": "user_enter_tempsession",
          "env": "test-env-6gni9ity244a6ea3",
          "functionName": "callback",
          "enable": false
        },
        {
          "msgType": "image",
          "event": "",
          "env": "test-env-6gni9ity244a6ea3",
          "functionName": "callback",
          "enable": true
        }
      ]
    },
    "container_config": {
      "enable": true,
      "qbase_env": "test-env-6gni9ity244a6ea3",
      "qbase_container_path": "/container-echo",
      "text_mode": 1
    }
  }
}
```

## 6. 错误码

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

```json
[
  {
    "错误码": "-1000",
    "错误描述": "system error",
    "解决方案": "系统错误"
  },
  {
    "错误码": "-1",
    "错误描述": "system error",
    "解决方案": "系统繁忙，此时请开发者稍候再试"
  },
  {
    "错误码": "0",
    "错误描述": "ok",
    "解决方案": "ok"
  },
  {
    "错误码": "40014",
    "错误描述": "invalid access_token",
    "解决方案": "不合法的 access_token ，请开发者认真比对 access_token 的有效性（如是否过期），或查看是否正在为恰当的公众号调用接口"
  },
  {
    "错误码": "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 请求"
  }
]
```

## 7. 适用范围

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