# 获取微信推送服务器IP

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

接口英文名：getCallbackIp

该接口用于获取微信推送服务器 ip 地址（向开发者服务器推送信息的微信服务器来源地址）

如果开发者基于安全等考虑，需要获知微信服务器的IP地址列表，以便进行相关限制，可以通过该接口获得微信服务器IP地址列表或者IP网段信息。

## 1. 调用方式

### HTTPS 调用

```bash
GET https://api.weixin.qq.com/cgi-bin/getcallbackip?access_token=ACCESS_TOKEN
```

### 云调用

- 本接口不支持云调用。

### 第三方调用

- 本接口支持第三方平台使用 [component_access_token](/doc/oplatform/developers/dev/ComponentAccessToken.md) 自己调用，同时还支持代供货商调用。[第三方服务商调用模式介绍](/doc/store/supplier/product/service_market_desc)

- 服务商获得任意权限集授权后，即可通过使用 [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](api_getaccesstoken)（供货商）、[component_access_token](/doc/oplatform/openApi/ticket-token/api_getcomponentaccesstoken.md)（服务商）、[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)（服务商代调用）"
  }
]
```

### 请求体 `Request Payload`

无

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "ip_list",
    "类型": "string",
    "说明": "微信服务器IP地址列表"
  },
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误信息"
  }
]
```

## 4. 注意事项

1. 由于出口 IP 及入口 IP 可能存在变动，建议用户每天请求接口1次，以便于及时更新IP列表。为了避免造成单点故障，强烈建议用户不要长期使用旧的 IP 列表作为 `api.weixin.qq.com` 的访问入口。
2. 使用固定IP访问 `api.weixin.qq.com` 时，请开发者注意运营商适配，跨运营商访问可能会存在高峰期丢包问题。
3. 由于出口 IP 及入口 IP 可能存在变动，建议用户每天请求接口 1 次，以便于及时更新 IP 列表。为了避免造成单点故障，强烈建议用户不要长期使用旧的IP列表作为 `api.weixin.qq.com` 的访问入口。

## 5. 代码示例

### 5.1 成功响应

请求示例

``` json
{}
```

返回示例

``` json
{
  "ip_list": [
    "106.55.206.146",
    "106.55.206.211"
  ]
}
```

### 5.2 错误响应

请求示例

``` json
{}
```

返回示例

``` json
{
  "errcode": 40013,
  "errmsg": "invalid appid"
}
```

## 6. 错误码

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

```json
[
  {
    "错误码": "40013",
    "错误描述": "invalid appid",
    "解决方案": "无效的AppID"
  }
]
```

## 7. 适用范围

本接口在不同账号类型下的可调用情况：

```json
[
  {
    "小程序": "✔",
    "公众号": "✔",
    "服务号": "✔",
    "小游戏": "✔",
    "微信小店": "✔",
    "联盟带货机构": "✔",
    "带货助手": "✔",
    "小店供货商": "✔",
    "第三方平台": "〇",
    "移动应用": "✔",
    "网站应用": "✔",
    "视频号助手": "✔",
    "多端应用": "✔"
  }
]
```

- ✔：该账号可调用此接口。
- 〇：第三方平台可使用 [component_access_token](/doc/oplatform/developers/dev/ComponentAccessToken.md) 调用，是否支持代供货商调用需看本文档 调用方式 部分。