Ver el tiempo en vivo de este mes

GET

/v1/live/usage

curl --request GET \
  --url https://api.iomza.com/v1/live/usage \
  --header 'Authorization: Bearer <token>'

• Producción

Minutos en vivo de este mes calendario (UTC), sumando todos tus canales, frente a lo que incluye tu plan. Cuando se agotan, los canales al aire se detienen y se rechazan hasta el siguiente periodo.

Autorizaciones

• apiKey

Respuestas

200

El consumo.

Tipo de contenidoapplication/json

El tiempo en vivo de una organización en este mes calendario, frente a lo que incluye su plan.

object

object

obligatorio

string

Valor permitido: live_usage

used_minutes

obligatorio

Minutos en vivo de este mes calendario (UTC), sumando los canales de la organización, incluidos los eliminados.

number

limit_minutes

obligatorio

Los minutos que su plan incluye al mes; null: sin límite. Cuando se agotan, los canales al aire se detienen y se rechazan hasta el siguiente periodo.

number | null

price_per_hour_usd

obligatorio

Lo que cuesta una hora al aire en su plan, en dólares, descontada del saldo; 0: nada.

number

included_minutes

obligatorio

Los minutos con señal que su plan incluye al mes, sin costo. Lo que los supere se paga del saldo recargado.

number

included_used_minutes

obligatorio

Los usados este mes.

number

out_of_balance

obligatorio

Sin tiempo incluido ni saldo: los canales rechazan la señal hasta que se recargue.

boolean

period_start

obligatorio

Cuándo empezó este periodo.

string

period_end

obligatorio

Cuándo empieza el siguiente.

string

Ejemplo

{
  "object": "live_usage"
}

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

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