Skip to main content
POST
wechat-channels.live.detail

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
liveId
string
required

Public live-session identifier.

Required string length: 1 - 512

Response

The result

liveId
string
required

Public live-session identifier.

objectId
string

Associated video identifier.

nickname
string

Public host name.

username
string

Public host handle.

status
number

Live state code: 1 live, 2 ended.

viewers
number

Current viewers.

peakViewers
number

Peak viewers.