WeChat Get Live Detail
## Purpose Retrieve a specific WeChat Channels live room's anchor information, live status, audience counts, and replay information using its live ID. ## Inputs Pass a required `request_body` object containing: - `live_id` (required): A digits-only string, up to 32 characters, such as `2078950291205875194`. Obtain it from a live entry, shared live room, or live-history replay item. - `scene` (optional): Entry-scene integer from 0 to 1000; defaults to 5. - `finder_username` (optional): Anchor identifier in `v2_<hexadecimal characters>@finder` format, up to 256 characters. Providing it can improve matching. Defaults to an empty string; null is also allowed. - `raw` (optional): Defaults to `true`. Use `true` for the full original response or `false` for simplified fields. ## Returned information Live-room details are returned directly under `data`. - With `raw=false`, `data` uses snake_case fields: `live_id` and `object_id` identify the live room and associated video; `anchor_nickname`, `anchor_username`, and `anchor_head_url` describe the anchor; `live_cover_url` is the cover image. `live_status` indicates the live state (1 = live, 2 = ended; other values may occur), with text in `status_desc`. `online_count` and `max_online_count` represent current and peak online audiences. `replay_status`, `replay_url`, and `replay_watch_uv` describe replay availability, its address, and viewer count. - With `raw=true`, the full original structure includes `data.liveInfo` for live/replay details and `data.anchorContact` for anchor information. Examples include `data.liveInfo.liveId`, `liveStatus`, `onlineCnt`, `maxOnlineCount`, `replayUrl`, and `data.liveInfo.replayInfo.watchUv`. The associated object ID, status text, and replay URL may be empty. Online counts for ended streams are usually zero; a replay URL is not guaranteed. ## Usage notes Keep large IDs as strings throughout input and output handling. Use lossless JSON parsing rather than JavaScript `Number` to avoid rounding IDs beyond the safe-integer range. Responses can be slow; set the client request timeout to 30 seconds.
Pricing
| Condition | Charge |
|---|---|
| Each call | 20.65 credits/call |
20.65 credits/call Charges are per query. A successful query is billed even if it returns no results.
Parameters
Optional parameters use the platform defaults when omitted.
| Parameter | Type | Required | Description | Default |
|---|---|---|---|---|
request_body | object | Yes | 用于查询指定直播间详情的请求体对象:live_id 指定直播 ID;scene 指定进入场景;finder_username 提供主播标识以提高匹配命中率;raw 控制返回原始响应或精简解析结构。/Request body for retrieving a specific live room's details: live_id identifies the live room; scene specifies the entry scene; finder_username supplies the anchor identifier to improve matching; raw selects the original response or simplified parsed structure. | — |
request_body.raw | boolean | No | True=原始响应;False=精简解析结构/True=raw response; False=simplified parsed structure | true |
request_body.scene | integer | No | 进入场景,默认 5/Entry scene, default 5 | 5 |
request_body.live_id | string | Yes | 直播 ID(纯数字)/Live ID (numeric) | — |
request_body.finder_username | string | null | No | 主播 finder username(可选,提高命中)/Anchor finder username (optional, improves hit rate) | "" |
Invocation example
Parameter templateGenerated from the parameter configuration. Replace the sample values before use.
/agent-api/v1/tool/executeX-Api-Keycurl --request POST \
--url 'https://agentearth.ai/agent-api/v1/tool/execute?tool_name=ae_wechat_get_live_detail' \
--header "X-Api-Key: $AGENTEARTH_API_KEY" \
--header 'Content-Type: application/json' \
--data-raw '{
"params": {
"request_body": {
"live_id": "2078950291205875194"
}
}
}'No response example available yet.






