# WeChat Channels Stream Detail API

> Returns live-room details including anchor info, status, online count, and replay data using a live ID. Allows switching between raw and parsed output formats.

Source: https://www.sandbase.ai/apis/wechat-channels/v2/live-detail
API reference: https://www.sandbase.ai/apis/wechat-channels/v2/live-detail/docs

## Facts

- Provider: WeChat Channels
- Type: Data API
- Endpoint: `POST https://api.sandbase.ai/v1/api/wechat-channels/v2/live-detail`
- Price: $0.01 per call
- Free allowance: 100 calls per organization per UTC day, shared across eligible APIs
- Capabilities: api, wechat channels
- Billing: pay per use from one SandBase balance; no provider account or subscription needed

## Call it

`POST https://api.sandbase.ai/v1/api/wechat-channels/v2/live-detail` with `Authorization: Bearer $SANDBASE_API_KEY` and the parameters as a JSON body.

| Parameter | Type | Required | Allowed values |
| --- | --- | --- | --- |
| `live_id` | string | yes |  |
| `finder_username` | any | no |  |
| `raw` | boolean | no |  |
| `scene` | integer | no |  |

## FAQ

### How do I use the WeChat Channels Stream Detail API?

Send a POST request to https://api.sandbase.ai/v1/api/wechat-channels/v2/live-detail with your SandBase API key in the Authorization header (Bearer) and the parameters as a JSON body. You can also try it in the Playground on this page without writing code.

### How much does the WeChat Channels Stream Detail API cost?

$0.01 per call. Every organization gets 100 free calls per UTC day, shared across eligible SandBase APIs including this one; after that each call is billed at this price from your SandBase balance. There is no subscription.

### What parameters does the WeChat Channels Stream Detail API accept?

Required: live_id (string). Optional: finder_username (any), raw (boolean) and scene (integer). The Parameters table and the Playground on this page list every field.

### What does the WeChat Channels Stream Detail API return?

A JSON response returned in the same HTTP request (synchronous).

### Do I need a WeChat Channels developer account or API key?

No. WeChat Channels Stream Detail runs through SandBase, so one SandBase API key covers this endpoint and every other API and model in the catalog. You do not need to apply for WeChat Channels API access separately.

## README

### WeChat Channels Stream Detail API

Retrieve detailed room metrics, anchor information, and replay availability by passing a target `live_id` and optional `finder_username`.

#### Use cases

- Inspect anchor information and real-time room status.
- Check online viewer counts during an active session.
- Retrieve replay details from completed broadcasts.

#### Request

```bash
curl -X POST "https://api.sandbase.ai/v1/api/wechat-channels/v2/live-detail" \
  -H "Authorization: Bearer $SANDBASE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"live_id": "<live_id>"}'
```

#### Parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `live_id` | string | Yes | Live ID (numeric). |
| `raw` | boolean | No | Optional, default True. |
| `scene` | integer | No | Optional, entry scene, default 5. |
| `finder_username` | string | No | Optional, anchor finder username (`v2_…@finder` format), improves hit rate. |

#### Notes

- Set `raw` to false to obtain a simplified parsed response instead of the raw payload.
- Providing `finder_username` alongside `live_id` improves lookup accuracy.
- The `live_id` can be obtained from broadcast history items, entry points, or share links.

#### Related APIs

- [WeChat Channels ID to Username](/model/wechat-channels/v2/channel-id-to-username): Convert a public WeChat Channels Channel ID (sph… short ID) into the finder username (v2_…@finder) required by the other WeChat Channels APIs.
- [WeChat Channels Account Info](/model/wechat-channels/v2/channel-info): Get the public "More info" panel of a WeChat Channels account: Channel ID, IP and profile location, and verification details such as entity type, service categ…
- [WeChat Channels Collection Videos](/model/wechat-channels/v2/collection-videos): Returns videos contained within a WeChat Channels collection using a collection ID.