Listar las sesiones de un canal en vivo

GET

/v1/live/channels/{id}/sessions

curl --request GET \
  --url 'https://api.iomza.com/v1/live/channels/example/sessions?limit=20' \
  --header 'Authorization: Bearer <token>'

• Producción

Cada vez que un encoder transmitió al canal: cuándo, cuánto tiempo y por qué terminó.

Autorizaciones

• apiKey

Parámetros

Parámetros de ruta

id

obligatorio

string

Parámetros de consulta

limit

integer

por defecto: 20 >= 1 <= 100

Cuántos, 1–100 (20 por defecto).

Respuestas

200

Las sesiones, las más recientes primero.

Tipo de contenidoapplication/json

object

object

obligatorio

Valor permitido: list

data

obligatorio

Array<object>

Una sesión de un canal: desde que un encoder se conecta hasta que se va.

object

id

obligatorio

string

object

obligatorio

string

Valor permitido: live_session

channel_id

obligatorio

string

started_at

obligatorio

string formato: date-time

ended_at

obligatorio

null mientras está en vivo.

string | null formato: date-time

end_reason

obligatorio

Uno o varios de:

string

Por qué terminó una sesión.

string

Valores permitidos: disconnect limit stopped blocked error

null

null

duration_seconds

obligatorio

Su duración, en segundos; null mientras está en vivo.

number | null

has_audio

obligatorio

Si la señal tiene audio; null hasta saberlo, en el primer minuto. Las sesiones de antes de que se informara también responden null.

boolean | null

ingest_protocol

obligatorio

Uno o varios de:

string

Cómo llega un encoder a la ingesta.

string

Valores permitidos: rtmp rtmps srt

null

null

stops_for_balance_at

obligatorio

Cuándo se detendrá la transmisión porque se agotó el saldo de la organización; null mientras tenga saldo.

string | null formato: date-time

recorded

obligatorio

Si se guardó completa.

boolean

deleted_at

obligatorio

Cuándo se eliminaron sus archivos (DELETE …/sessions/{session_id}); null mientras se conservan. De todos modos los archivos se conservan 24 horas.

string | null formato: date-time

Ejemplo

{
  "object": "list",
  "data": [
    {
      "object": "live_session",
      "end_reason": "disconnect",
      "ingest_protocol": "rtmp"
    }
  ]
}

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"
  }
}