API reference / Connected sessions / LIVE viewer session

LIVE viewer session

Enter, heartbeat, like or leave a LIVE room from a connected session.

POSTapi.tikultra.com/v1/account/live/viewer20 credits

Upstream: /webcast/room/enter//webcast/im/fetch//webcast/room/like/
Access: Growth and up
Runs on: FullPool
Billing: Failed calls are free

Authorization & parameters

x-api-keyheader · stringrequired

Your API key. Create one in API keys.

Body

Send JSON with content-type: application/json.

account_idstringrequired

A connected account, from /dash/sessions or POST /v1/account/import. For example acc_7Hq2.

room_idstringrequired

The numeric LIVE room ID. For example 7705861000123456789.

actionstringrequired

enter, heartbeat, like or leave. One of enter, heartbeat, like, leave.

countinteger

Tap count when action is like. For example 5.

Client and egress

Executes on the dedicated FullPool mobile context and city-level egress bound to account_id. See Connected sessions.

Response

A 200 returns JSON with stable field names. Every response carries x-credits-cost, x-credits-tier and x-credits-remaining.

Response fields

Key top-level and nested fields decoded from the mobile upstream payload:

status_codeinteger

Upstream TikTok mobile status code (0 indicates success).

account_idstring

Connected session identifier bound to a dedicated FullPool mobile context.

room_idstring

64-bit LIVE room Snowflake identifier.

actionstring

Decoded action value.

viewer_countinteger

Concurrent viewers currently in the LIVE room.

im_cursorstring

Decoded im cursor value.

watch_session_idstring

Unique watch session identifier.

log_pbobject

Upstream request trace envelope from the mobile gateway.

log_pb.impr_idstring

Upstream TikTok impression / trace identifier.

Errors

Errors return a JSON body with a stable code and cost 0 credits. See Errors and retries.

Accounts you own only. Connected sessions are for accounts you own or are authorized to operate. Available on Growth and Scale.

import os from tikultra import TikUltra with TikUltra(api_key=os.environ["TIKULTRA_KEY"]) as client: res = client.request( "POST", "/v1/account/live/viewer", json_body={ "account_id": "acc_7Hq2", "room_id": "7705861000123456789", "action": "enter", }, ) print(res.credits_cost, res.data)

{ "status_code": 0, "account_id": "acc_7Hq2", "room_id": "7705861000123456789", "action": "enter", "viewer_count": 1843, "im_cursor": "1794400815000_9912", "watch_session_id": "lvw_88219a04c2", "log_pb": { "impr_id": "202611120200419F8E7D6C5B4A3210" } }