Olvidar

SuscripciónSin autenticación

Detenga un stream en tiempo real por su ID. Sin cambios en la nueva API.

Sin cambios importantes

La llamada forget funciona de la misma manera en la Legacy API y en la New API, por lo que no necesita modificar su código.

Comparación rápida

Aspecto	Legacy API	New API	Acción
Endpoint	forget	forget	Ninguno
Requiere autenticación	No	No	Ninguno
Patrón de ID de flujo	`^[\w-]{32,128}$`	`^[\w-]{32,128}$`	Ninguno
Campo de respuesta `forget`	Opcional	Opcional	Ninguno

Campos de solicitud y respuesta

Solicitud

forget (requerido): el ID del stream, que coincide con ^[\w-]{32,128}$. Utilice el subscription.id del stream que desea detener.
passthrough (opcional): datos que se le devuelven en echo_req.
req_id (opcional): un ID que asocia la respuesta a su solicitud.

Respuesta

echo_req y msg_type (forget): siempre se devuelven.
forget (opcional): 1 significa que el flujo se detuvo. 0 significa que el flujo no existía.
req_id: se devuelve cuando usted envía uno.

Estructura de solicitud

Legacy APIejemplo de solicitud

{
  "forget": "d1ee7d0d-3ca9-fbb4-720b-5312d487185b"
}

New APIejemplo de solicitud

{
  "forget": "d1ee7d0d-3ca9-fbb4-720b-5312d487185b"
}

Estructura de respuesta

Legacy APIejemplo de respuesta

{
  "echo_req": {
    "forget": "d1ee7d0d-3ca9-fbb4-720b-5312d487185b"
  },
  "forget": 1,
  "msg_type": "forget"
}

New APIejemplo de respuesta

{
  "echo_req": {
    "forget": "d1ee7d0d-3ca9-fbb4-720b-5312d487185b"
  },
  "forget": 1,
  "msg_type": "forget"
}

Ejemplos de código

function stopStream(streamId) {
  ws.send(JSON.stringify({ forget: streamId }));
}

ws.onmessage = (event) => {
  const response = JSON.parse(event.data);
  if (response.error) {
    console.error(response.error.message);
    return;
  }
  if (response.msg_type !== 'forget') return;

  if (response.forget === 1) {
    console.log('Stream stopped');
  } else if (response.forget === 0) {
    console.log('Stream did not exist');
  } else {
    console.log('No forget result returned');
  }
};

Endpoints de suscripción Olvidar todo

¿Alguna otra pregunta? Póngase en contacto