# 发布状态查询

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

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

接口英文名：freepublish_get

本接口用于查询发布任务的状态和详情

## 1. 调用方式

### HTTPS 调用

```bash
POST https://api.weixin.qq.com/cgi-bin/freepublish/get?access_token=ACCESS_TOKEN
```

### 云调用

- 本接口不支持云调用。

### 第三方调用

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

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

- 服务商获得其中之一权限集授权后，可通过使用 [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`

```json
[
  {
    "参数名": "publish_id",
    "类型": "string",
    "必填": "是",
    "示例": "100000001",
    "说明": "发布任务id"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "publish_id",
    "类型": "string",
    "说明": "发布任务id"
  },
  {
    "参数名": "publish_status",
    "类型": "number",
    "说明": "发布状态(0:成功,1:发布中,2:原创失败,3:常规失败,4:平台审核不通过,5:成功后用户删除所有文章,6:成功后系统封禁所有文章)"
  },
  {
    "参数名": "article_id",
    "类型": "string",
    "说明": "成功时的图文article_id"
  },
  {
    "参数名": "article_detail",
    "类型": "object",
    "说明": "文章详情"
  },
  {
    "参数名": "fail_idx",
    "类型": "numarray",
    "说明": "失败文章编号"
  }
]
```

### Res.article_detail `Object Payload`

文章详情

```json
[
  {
    "参数名": "count",
    "类型": "number",
    "说明": "当发布状态为0时（即成功）时，返回文章数量"
  },
  {
    "参数名": "item",
    "类型": "objarray",
    "说明": "当发布状态为0时（即成功）时，返回文章详情"
  }
]
```

">

### Res.article_detail.item(Array) `Object Payload`

当发布状态为0时（即成功）时，返回文章详情

```json
[
  {
    "参数名": "idx",
    "类型": "number",
    "说明": "文章对应的编号"
  },
  {
    "参数名": "article_url",
    "类型": "string",
    "说明": "图文的永久链接"
  }
]
```

## 4. 注意事项

本接口无特殊注意事项

## 5. 代码示例

### 5.1 成功示例

请求示例

``` json
{
  "publish_id": "100000001"
}
```

返回示例

``` json
{
  "publish_id": "100000001",
  "publish_status": 0,
  "article_id": "ARTICLE_ID",
  "article_detail": {
    "count": 1,
    "item": [
      {
        "idx": 1,
        "article_url": "ARTICLE_URL"
      }
    ]
  },
  "fail_idx": []
}
```

### 5.2 发布中示例

请求示例

``` json
{
  "publish_id": "100000001"
}
```

返回示例

``` json
{
  "publish_id": "100000001",
  "publish_status": 1,
  "fail_idx": [1]
}
```

### 5.3 原创审核失败示例

请求示例

``` json
{
  "publish_id": "100000001"
}
```

返回示例

``` json
{
  "publish_id": "100000001",
  "publish_status": 2,
  "fail_idx": [
    1,
    2
  ]
}
```

## 6. 错误码

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

```json
[
  {
    "错误码": "40001",
    "错误描述": "invalid credential",
    "解决方案": "不合法的调用凭证"
  },
  {
    "错误码": "40002",
    "错误描述": "invalid argument",
    "解决方案": "无效参数"
  },
  {
    "错误码": "48001",
    "错误描述": "api unauthorized",
    "解决方案": "api 功能未授权，请确认公众号/服务号已获得该接口，可以在「公众平台官网 - 开发者中心页」中查看接口权限"
  }
]
```

## 7. 适用范围

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

```json
[
  {
    "公众号": "仅认证",
    "服务号": "✔"
  }
]
```

- 仅认证：表示仅允许企业主体已认证账号调用，未认证或不支持认证的账号无法调用。
- ✔：该账号可调用此接口。
- 其他未明确声明的账号类型，如无特殊说明，均不可调用此接口。