Rappels de l'API Meetings

Les rappels de l'API Meetings vous permettent de recevoir des informations sur les événements de la session, l'activité des participants, les détails de l'enregistrement et l'expiration de la salle.

Configuration des rappels

Pour utiliser les rappels, activez la capacité de l'API Meetings dans votre application via l'option Tableau de bord de l'API Vonage. Vous pouvez configurer trois URL :

Enable the Meetings API for your application using the dashboard
  • URL des chambres - Obtenez des informations sur les salles de réunion que vous gérez.
  • URL des sessions - Obtenez des informations sur les sessions, telles que l'heure de début, le nombre de participants, etc.
  • URL d'enregistrement - Recevoir les informations sur l'enregistrement et les liens de téléchargement dès qu'ils sont disponibles.

Types de rappels

Le tableau suivant décrit chaque type de notification de rappel :

Nom Description
room:expired La salle est inactive. Il n'est pas possible de créer des sessions pour des salles inactives.
session:started Une session a commencé.
session:ended Une session est terminée.
recording:started Un enregistrement débute au sein d'une session.
recording:ended Un enregistrement a été interrompu au cours d'une session.
recording:uploaded Un enregistrement est prêt à être téléchargé.
participant:joined Quelqu'un a rejoint une session.
session:participant:left Quelqu'un a quitté une session.

Exemples de charges utiles

Chambre expirée

Une notification indiquant qu'une salle a expiré. Il n'est pas possible de créer des sessions pour des salles inactives.

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

Début de la session

Une notification indiquant qu'une session a démarré.

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

Session terminée

Notification de la fin d'une session.

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

Début de l'enregistrement

Une notification indiquant que l'enregistrement a commencé pour une session.

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

Enregistrement Ended

Notification de la fin de l'enregistrement d'une session.

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

Enregistrement téléchargé

Une notification indiquant qu'un enregistrement d'une session a été téléchargé et qu'il est accessible via la page d'accueil du site web de l'UE. 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"
}

Participant joint

Une notification concernant l'entrée d'une personne dans une session.

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

Participant gauche

Une notification concernant le départ d'une personne d'une session.

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