# wx.getChannelsLiveInfo(Object object)

> 基础库 2.15.0 开始支持，低版本需做[兼容处理](1003706)。

> __以 [Promise 风格](/miniprogram/dev/framework/app-service/api.md#异步-API-返回-Promise) 调用__：不支持
> 
> __小程序插件__：不支持
> 
> __微信 Windows 版__：支持
> 
> __微信 Mac 版__：支持
> 
> __微信 鸿蒙 OS 版__：支持

> 相关文档: [视频号直播](/miniprogram/dev/framework/open-ability/channels-live.md)

## 功能描述

获取视频号直播信息

## 参数

### Object object

| 属性 | 类型 | 默认值 | 必填 | 说明 | 最低版本 |
| ---- | ---- | ------ | -------- | ---- | -------- |
| finderUserName | string |  | 是 | 视频号 id，以“sph”开头的id，可在视频号助手获取 |  |
| startTime | number |  | 否 | 起始时间，筛选指定时间段的直播。若上传了endTime，未上传startTime，则startTime默认为0 | [2.29.0](1003706) |
| endTime | number |  | 否 | 结束时间，筛选指定时间段的直播。若上传了startTime，未上传endTime，则endTime默认取当前时间 | [2.29.0](1003706) |
| success | function |  | 否 | 接口调用成功的回调函数 |  |
| fail | function |  | 否 | 接口调用失败的回调函数 |  |
| complete | function |  | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |  |

#### object.success 回调函数
##### 参数

###### Object res


```json
[
  {
    "属性": "feedId",
    "类型": "string",
    "说明": "直播 feedId",
    "最低版本": ""
  },
  {
    "属性": "nonceId",
    "类型": "string",
    "说明": "直播 nonceId",
    "最低版本": ""
  },
  {
    "属性": "description",
    "类型": "string",
    "说明": "直播主题",
    "最低版本": ""
  },
  {
    "属性": "status",
    "类型": "number",
    "说明": "直播状态",
    "最低版本": "",
    "子项": [
      {
        "合法值": "1",
        "说明": "直播状态不存在（针对未开过直播的主播）"
      },
      {
        "合法值": "2",
        "说明": "直播中"
      },
      {
        "合法值": "3",
        "说明": "直播已结束"
      },
      {
        "合法值": "4",
        "说明": "直播准备中（未开播）"
      }
    ]
  },
  {
    "属性": "headUrl",
    "类型": "string",
    "说明": "视频号头像",
    "最低版本": ""
  },
  {
    "属性": "nickname",
    "类型": "string",
    "说明": "视频号昵称",
    "最低版本": ""
  },
  {
    "属性": "replayStatus",
    "类型": "string",
    "说明": "直播回放状态",
    "最低版本": "[2.29.0](1003706)",
    "子项": [
      {
        "合法值": "0",
        "说明": "未生成"
      },
      {
        "合法值": "1",
        "说明": "已生成"
      },
      {
        "合法值": "3",
        "说明": "生成中"
      },
      {
        "合法值": "6",
        "说明": "已过期"
      }
    ]
  },
  {
    "属性": "otherInfos",
    "类型": "Array.<Object>",
    "说明": "除最近的一条直播外，其他的直播列表（注意：每次最多返回按时间戳增序排列的15个直播信息，其中时间最近的那个直播会在接口其他的返回参数中展示，其余的直播会在该字段中展示）。",
    "最低版本": "[2.29.0](1003706)"
  }
]
```

## 常见错误码说明

100008  视频号需要认证
40097 入参异常
1416104  视频号获取到的数据为空
1416100  非法的视频号id