Devoluciones de llamada de la Meetings API

Las retrollamadas de la Meetings API le permiten recibir información sobre los eventos de la sesión, la actividad de los participantes, los detalles de la grabación y la caducidad de la sala.

Configuración de las retrollamadas

Para utilizar las retrollamadas, active la función Meetings API en su aplicación mediante la opción Panel de API de Vonage. Hay tres URL que puede configurar:

Enable the Meetings API for your application using the dashboard
  • URL de las habitaciones - Obtenga información sobre las salas de reuniones que gestiona.
  • Sesiones URL - Obtenga información sobre las sesiones, como la hora de inicio, los participantes inscritos, etc.
  • URL de grabación - Reciba información sobre la grabación y enlaces de descarga cuando estén disponibles.

Tipos de devolución de llamada

La siguiente tabla describe cada tipo de notificación de devolución de llamada:

Nombre Descripción
room:expired La sala está inactiva. No se pueden crear sesiones para salas inactivas.
session:started Se ha iniciado una sesión.
session:ended Una sesión ha terminado.
recording:started Comienza una grabación dentro de una sesión.
recording:ended Se ha detenido una grabación dentro de una sesión.
recording:uploaded La grabación está lista para ser descargada.
participant:joined Alguien se ha unido a una sesión.
session:participant:left Alguien ha abandonado una sesión.

Ejemplo de carga útil

Habitación caducada

Notificación de que una sala ha caducado. No se pueden crear sesiones para salas inactivas.

{
   "event": "room:expired",
   "room_id": "9f6fe8ae-3458-4a72-b532-8276d5533e97",
   "room_type": "instant",
   "expires_at": "2023-06-06T06:55:07.134Z",
   "created_at": "2023-06-06T06:45:07.135Z"
}

Sesión iniciada

Notificación de que se ha iniciado una sesión.

{
    "event": "session:started",
    "session_id": "2_MX40NjMzOTg5Mn5-MTYzNTg2ODQwODY4NH41cXIzMDdSa1BZa05BUDFpYnhxcTV4MCt-fg",
    "room_id": "b307d837-c0ce-4619-8c5c-70e418ef9693",
    "started_at": "2021-11-02T15:53:28.753Z"
}

Sesión finalizada

Notificación de que una sesión ha finalizado.

{
   "event": "session:ended",
   "session_id": "2_MX40NjMwODczMn5-MTU3NTgyODEwNzQ2MH5OZDJrVmdBRUNDbG5MUzNqNX20yQ1Z-fg",
   "room_id": "9f6fe8ae-3458-4a72-b532-8276d5533e97",
   "started_at": "2023-06-06T07:15:13.974Z",
   "ended_at": "2023-06-06T08:15:13.974Z"
}

Grabación iniciada

Notificación de que se ha iniciado la grabación de una sesión.

{
   "event": "recording:started",
   "recording_id": "9f6fe8ae-3458-4a72-b532-8276d5533e97",
   "session_id": "2_MX40NjMwODczMn5-MTU3NTgyODEwNzQ2MH5OZDJrVmdBRUNDbG5MUzNqNX20yQ1Z-fg"
}

Grabación Ended

Notificación de que ha finalizado la grabación de una sesión.

{
   "event": "recording:ended",
   "recording_id": "9f6fe8ae-3458-4a72-b532-8276d5533e97",
   "session_id": "2_MX40NjMwODczMn5-MTU3NTgyODEwNzQ2MH5OZDJrVmdBRUNDbG5MUzNqNX20yQ1Z-fg",
   "started_at": "2023-06-06T07:15:13.974Z",
   "ended_at": "2023-06-06T08:15:13.974Z",
   "duration": 3600
}

Grabación cargada

Notificación de que se ha cargado una grabación de una sesión, a la que se puede acceder a través de la función url.

{
   "event": "recording:uploaded",
   "recording_id": "9f6fe8ae-3458-4a72-b532-8276d5533e97",
   "session_id": "2_MX40NjMwODczMn5-MTU3NTgyODEwNzQ2MH5OZDJrVmdBRUNDbG5MUzNqNX20yQ1Z-fg",
   "room_id": "9f6fe8ae-3458-4a72-b532-8276d5533e97",
   "started_at": "2023-06-06T07:15:13.974Z",
   "ended_at": "2023-06-06T08:15:13.974Z",
   "duration": "2023-06-06T08:15:13.974Z",
   "url": "https://prod-meetings-recordings.s3.amazonaws.com/123/9f6fe8ae-3458-4a72-b532-8276d5533e97/archive.mp4"
}

Participante Incorporado

Notificación de que alguien ha entrado en una sesión.

{
    "event": "session:participant:joined",
    "participant_id": "b424e1c4-e988-4ce2-8ab9-e3efea7de542",
    "session_id": "2_MX40NjMzOTg5Mn5-MTYzNTg2ODQwODY4NH41cXIzMDdSa1BZa05BUDFpYnhxcTV4MCt-fg",
    "room_id": "b307d837-c0ce-4619-8c5c-70e418ef9693",
    "name": "New Joiner",
    "type": "Guest",
    "is_host": true
}

Participante Izquierda

Una notificación sobre alguien que abandona una sesión.

{
   "event": "session:participant:left",
   "participant_id": "9f6fe8ae-3458-4a72-b532-8276d5533e97",
   "session_id": "2_MX40NjMwODczMn5-MTU3NTgyODEwNzQ2MH5OZDJrVmdBRUNDbG5MUzNqNX20yQ1Z-fg",
   "room_id": "9f6fe8ae-3458-4a72-b532-8276d5533e97",
   "name": "John Doe",
   "type": "Guest",
   "is_host": true
}