API reference / Connected sessions / LIVE gift & wallet

LIVE gift & wallet

Send a gift, list room gifts or inspect coin wallet balance on a connected session.

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

Upstream: /webcast/gift/send//webcast/wallet_api/diamond_buy/
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

send, list or wallet. One of send, list, wallet.

gift_idinteger

Numeric gift ID when sending. For example 5655.

countinteger

Gift combo count. For example 1.

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.

gift_idinteger

Unique gift identifier.

gift_namestring

Decoded gift name value.

repeat_countinteger

Total repeat count.

diamonds_spentinteger

Decoded diamonds spent value.

remaining_coinsinteger

Decoded remaining coins value.

send_msg_idstring

Unique send msg 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/gift", json_body={ "account_id": "acc_7Hq2", "room_id": "7705861000123456789", "action": "send", "gift_id": 5655, "count": 1, }, ) print(res.credits_cost, res.data)

{ "status_code": 0, "account_id": "acc_7Hq2", "room_id": "7705861000123456789", "action": "send", "gift_id": 5655, "gift_name": "Rose", "repeat_count": 1, "diamonds_spent": 1, "remaining_coins": 489, "send_msg_id": "7705861999111222955", "log_pb": { "impr_id": "202611120200419F8E7D6C5B4A3210" } }