Detener un canal en vivo

POST

/v1/live/channels/{id}/stop

curl --request POST \
  --url https://api.iomza.com/v1/live/channels/example/stop \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "refuse_minutes": 1 }'

• Producción

Termina la sesión en curso en unos segundos y rechaza al encoder durante refuse_minutes (2 por defecto), o hasta que el canal se reactive. El cuerpo puede ir vacío.

Autorizaciones

• apiKey

Parámetros

Parámetros de ruta

id

obligatorio

string

Cuerpo de la petición^obligatorio

Tipo de contenidoapplication/json

object

refuse_minutes

Uno o varios de:

integer

integer

<= 1440

null

null

Ejemplo ^generated

{
  "refuse_minutes": 1
}

Respuestas

200

El canal.

Tipo de contenidoapplication/json

Un canal en vivo.

object

id

obligatorio

string

object

obligatorio

string

Valor permitido: live_channel

name

obligatorio

string

status

obligatorio

preparing: el canal se está preparando, lo que puede tardar unos minutos; hasta entonces rechaza su encoder. idle: esperando un encoder. live: transmitiendo ahora. reconnecting: su encoder se cayó durante una transmisión y esta lo espera hasta 5 minutos (los espectadores conservan el DVR). stopped: rechaza su encoder (ver stopped_until).

string

Valores permitidos: preparing idle live reconnecting stopped

stopped_until

obligatorio

Hasta cuándo rechaza a su encoder tras detenerlo; null con status stopped: hasta que se reactive.

string | null

ingest

obligatorio

object

url

obligatorio

Adónde transmite el encoder, con cifrado (RTMPS): el “Servidor” de OBS.

string

rtmp_url

obligatorio

Lo mismo sin cifrado (RTMP), para encoders que no admiten RTMPS. La clave de transmisión viaja sin cifrar.

string

srt_url

obligatorio

Dónde transmite el encoder por SRT, que aguanta mejor en redes inestables: reemplaza {stream_key} por la clave de transmisión, que va en esta dirección. La clave viaja sin cifrar.

string

stream_key_hint

obligatorio

Los últimos caracteres de la clave de transmisión, para reconocerla.

string

stream_key_available

obligatorio

Si GET …/stream-key puede mostrar la clave; false en una clave antigua: rótala una vez para obtener una que se pueda mostrar.

boolean

playback

obligatorio

Desde dónde se reproduce un canal: HLS y DASH, en el borde del directo o con la ventana de DVR.

object

hls

obligatorio

HLS en el borde del directo (los últimos segundos): para reproductores que solo siguen la emisión en directo.

string

dash

obligatorio

DASH en el borde del directo.

string

dvr_hls

obligatorio

HLS con la ventana de DVR, para rebobinar (dvr_minutes).

string

dvr_dash

obligatorio

DASH con la ventana de DVR.

string

recording

obligatorio

Si las sesiones se guardan completas al terminar (las URLs de reproducción las reproducen entonces desde el principio).

boolean

dvr_minutes

obligatorio

Hasta cuánto pueden rebobinar los espectadores en las URLs de DVR, en minutos (1–120).

number

standby_language

obligatorio

El idioma de las imágenes que ven los espectadores mientras falta la señal y al terminar la sesión: es o en.

string

Valores permitidos: es en

max_duration_minutes

obligatorio

La sesión más larga, en minutos.

number

on_air_since

obligatorio

Cuándo empezó su sesión al aire; null cuando no está al aire.

string | null

ingest_allowed_ips

obligatorio

Solo los encoders en estas direcciones o rangos IPv4 pueden transmitir a él; vacío: cualquiera.

Array<string>

ingest_allowed_countries

obligatorio

Solo los encoders en estos países pueden transmitir a él; vacío: cualquiera.

Array<string>

created_at

obligatorio

string formato: date-time

Ejemplo

{
  "object": "live_channel",
  "status": "preparing",
  "standby_language": "es"
}

400

Campos inválidos: details lista cada problema con su ruta.

Tipo de contenidoapplication/json

object

error

obligatorio

object

code

obligatorio

Estable: decide con él.

string

Valores permitidos: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable

message

obligatorio

En inglés, para personas; puede cambiar.

string

details

obligatorio

Cada problema, como ruta: mensaje (errores de validación).

Array<string>

Ejemplo

{
  "error": {
    "code": "validation_error"
  }
}

401

La API key falta, no es válida o está revocada.

Tipo de contenidoapplication/json

object

error

obligatorio

object

code

obligatorio

Estable: decide con él.

string

Valores permitidos: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable

message

obligatorio

En inglés, para personas; puede cambiar.

string

details

obligatorio

Cada problema, como ruta: mensaje (errores de validación).

Array<string>

Ejemplo

{
  "error": {
    "code": "validation_error"
  }
}

403

Credenciales válidas que no pueden hacer esto (forbidden), tu plan no incluye el módulo al que pertenece la ruta (module_not_in_plan), o tu organización está suspendida (organization_suspended).

Tipo de contenidoapplication/json

object

error

obligatorio

object

code

obligatorio

Estable: decide con él.

string

Valores permitidos: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable

message

obligatorio

En inglés, para personas; puede cambiar.

string

details

obligatorio

Cada problema, como ruta: mensaje (errores de validación).

Array<string>

Ejemplo

{
  "error": {
    "code": "validation_error"
  }
}

404

No existe en tu organización.

Tipo de contenidoapplication/json

object

error

obligatorio

object

code

obligatorio

Estable: decide con él.

string

Valores permitidos: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable

message

obligatorio

En inglés, para personas; puede cambiar.

string

details

obligatorio

Cada problema, como ruta: mensaje (errores de validación).

Array<string>

Ejemplo

{
  "error": {
    "code": "validation_error"
  }
}

429

Demasiadas peticiones: espera y reintenta. Lo responde la pasarela, así que el cuerpo puede ser distinto.

Tipo de contenidoapplication/json

object

error

obligatorio

object

code

obligatorio

Estable: decide con él.

string

Valores permitidos: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable

message

obligatorio

En inglés, para personas; puede cambiar.

string

details

obligatorio

Cada problema, como ruta: mensaje (errores de validación).

Array<string>

Ejemplo

{
  "error": {
    "code": "validation_error"
  }
}

500

Nuestro: reintenta, y avísanos si persiste.

Tipo de contenidoapplication/json

object

error

obligatorio

object

code

obligatorio

Estable: decide con él.

string

Valores permitidos: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable

message

obligatorio

En inglés, para personas; puede cambiar.

string

details

obligatorio

Cada problema, como ruta: mensaje (errores de validación).

Array<string>

Ejemplo

{
  "error": {
    "code": "validation_error"
  }
}

503

No disponible por un momento: reintenta en unos segundos.

Tipo de contenidoapplication/json

object

error

obligatorio

object

code

obligatorio

Estable: decide con él.

string

Valores permitidos: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable

message

obligatorio

En inglés, para personas; puede cambiar.

string

details

obligatorio

Cada problema, como ruta: mensaje (errores de validación).

Array<string>

Ejemplo

{
  "error": {
    "code": "validation_error"
  }
}