InícioReferência da API
Referencia apiLive streams

Lives Buscar

GET
/v1/live-streams/{key}

GET /v1/live-streams/{key}. Contrato do handler livesBuscar. Requer autenticação e autorização no contexto da conta; permissões e suspensão podem impedir a operação.

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

JWT de usuário/console ou API token, conforme a autorização e as permissões da conta. Não enviar tokens reais nos exemplos.

Parâmetros de path

key*string

Identificador utilizado pelo handler.

Parâmetros de query

ignorar_ip?boolean
uid?string

Corpo da resposta

Operação concluída.

application/json
  1. response
actualEndTime?string
Formatodate-time
actualStartTime?string
Formatodate-time
ads?
allowPublicAccess?boolean
assets?
createdAt?string
Formatodate-time
description?string
enableAutoStart?boolean
enableChat?boolean
gaTag?string
googleDAI?
isPaused?boolean
liveId?string
outputQualities?array<string>
playerCustomization?
rawSettings?
robotCustomization?
scheduledEndTime?string
Formatodate-time
scheduledStartTime?string
Formatodate-time
security?
status?string
streamPull?boolean
subtitles?boolean
tencentChatUserId?string
tencentChatUserSig?string
title?string
transcode?
type?string
updatedAt?string
Formatodate-time
wherebyMeetingId?string
wherebyRoomName?string
curl -X GET "https://example.com/v1/live-streams/0123456789abcdefghijklmnopq"
{  "actualEndTime": "2026-01-15T12:00:00Z",  "actualStartTime": "2026-01-15T12:00:00Z",  "ads": {    "googleIMA": [],    "vast": [],    "vmap": []  },  "assets": {    "chatIframe": "https://media.example.com/exemplo",    "endingScreen": "",    "hls": "https://media.example.com/exemplo",    "iframe": "https://media.example.com/exemplo",    "pauseScreen": "",    "player": "https://media.example.com/exemplo",    "playerColor": "",    "startSoonScreen": "",    "thumbnail": "https://media.example.com/exemplo",    "wss": ""  },  "createdAt": "2026-01-15T12:00:00Z",  "description": "Exemplo sintético para documentação.",  "enableAutoStart": false,  "enableChat": false,  "googleDAI": {    "apiKey": "0123456789abcdefghijklmnopq",    "assetKey": "0123456789abcdefghijklmnopq",    "contentSourceId": "https://media.example.com/exemplo",    "enabled": false,    "type": "",    "videoId": "0123456789abcdefghijklmnopq"  },  "isPaused": false,  "liveId": "0123456789abcdefghijklmnopq",  "outputQualities": [],  "playerCustomization": {    "backgroundColor": "",    "colorTone": "",    "iconTextColor": "",    "playButtonLocation": false,    "primaryColor": "",    "showConfigurations": false,    "showFullscreen": false,    "showLike": false,    "showSeekControls": false,    "showSound": false,    "showSpeed": false,    "showStatistics": false,    "showTitle": false  },  "rawSettings": {    "streaming": {      "geoAccessControl": "",      "geoRegionList": [],      "ipWhitelist": [],      "referrerWhitelist": [],      "streamingProfile": ""    }  },  "robotCustomization": {    "assistantAction": [],    "decreaseVolumeActions": [],    "enableVolumeActions": [],    "increaseVolumeActions": [],    "interruptAssistantActions": [],    "interruptionActions": [],    "momentSearchActions": [],    "muteVolumeActions": [],    "playbackActions": [],    "selectedImage": "https://media.example.com/exemplo",    "videoAdvanceActions": [],    "videoRewindActions": [],    "voiceAssistant": false,    "welcomePhrase": ""  },  "scheduledEndTime": "2026-01-15T12:00:00Z",  "scheduledStartTime": "2026-01-15T12:00:00Z",  "security": {    "geoAccessControl": "",    "geoRegionList": [],    "ipWhitelist": [],    "referrerWhitelist": []  },  "status": "",  "streamPull": false,  "subtitles": false,  "tencentChatUserId": "0123456789abcdef01234567",  "tencentChatUserSig": "",  "title": "Exemplo sintético",  "transcode": {    "enableAudioOnly": false,    "enableCut": false,    "enableDvr": false,    "enableLive2vod": false,    "endpoints": {      "backup": "",      "primary": "",      "streamName": "Exemplo sintético",      "type": ""    },    "latencyPreference": "",    "status": []  },  "type": "",  "updatedAt": "2026-01-15T12:00:00Z",  "wherebyMeetingId": "0123456789abcdef01234567",  "wherebyRoomName": "Exemplo sintético"}

Lives Aplicar Preset PATCH

PATCH /v1/live-streams/preset. Contrato do handler livesAplicarPreset. Requer autenticação e autorização no contexto da conta; permissões e suspensão podem impedir a operação.

Lives Atualizar PATCH

PATCH /v1/live-streams/{key}. Contrato do handler livesAtualizar. Requer autenticação e autorização no contexto da conta; permissões e suspensão podem impedir a operação.