v1

latestOpenAPI 3.1.02026-07-2416666272.6 KB

Chat Users List

This endpoint returns the list of users who are currently viewing a specific chat in real time.

get/chat-users

Query parameters

chat_idstring

UUID

Response

200

idstring

titlestring

rtmpstring

stream_key_idstring

stream_keystring

user_idstring

{"stackTrail":"paths:/chat-users:get:responses:200:content:application/json:schema:properties:started_at","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/chat-users:get:responses:200:content:application/json:schema:properties:ended_at","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/chat-users:get:responses:200:content:application/json:schema:properties:vod_id","oasType":"schema","type":"unknown"}

statusstring

live_playerstring

live_hlsstring

bitrateobject[]

{"stackTrail":"paths:/chat-users:get:responses:200:content:application/json:schema:properties:folder_id","oasType":"schema","type":"unknown"}

active_dvrboolean

{"stackTrail":"paths:/chat-users:get:responses:200:content:application/json:schema:properties:scheduled_at","oasType":"schema","type":"unknown"}

created_atstring

{"stackTrail":"paths:/chat-users:get:responses:200:content:application/json:schema:properties:gcore_pullzone_id","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/chat-users:get:responses:200:content:application/json:schema:properties:gcore_pullzone_status","oasType":"schema","type":"unknown"}

latency_typestring

Example response

{
  "id": "X",
  "title": "X",
  "rtmp": "X",
  "stream_key_id": "X",
  "stream_key": "X",
  "user_id": "X",
  "status": "X",
  "live_player": "X",
  "live_hls": "X",
  "active_dvr": true,
  "created_at": "X",
  "latency_type": "X"
}