Support
Référence API

Authentification

Prérequis :
  • Pour utiliser cette API, vous devez nous contacter à contact@immosquare.com. Après vérification, nous vous fournirons apiKey et apiToken à inclure dans les headers de vos requêtes.
# POST
POST /path
Content-Type: application/json
apiKey: xz1232xzd213213er213213dczxcc3loizxzs12dczx
apiToken: xz1287xzdwer213213dczxcas12dczx

# GET
GET /path
apiKey: xz1232xzd213213er213213dczxcc3loizxzs12dczx
apiToken: xz1287xzdwer213213dczxcas12dczx

Codes HTTP

Nous utilisons des codes conventionnels de réponse HTTP pour indiquer le succès ou l'échec des requêtes.

💚 Succès (2xx)

HTTP Statut Description
200 - OK Succès de la requête

🚫 Erreurs client (4xx)

HTTP Statut Description
400 - Bad Request Paramètres manquants ou invalides
401 - Unauthorized API Key/token invalide
402 - Request Failed Requête valide mais échec du traitement
404 - Not Found Endpoint inexistant
429 - Too Many Requests Quota de requêtes dépassé

🔧 Erreurs serveur (5xx)

HTTP Statut Description
500, 502, 503, 504 - Server Errors Erreur technique interne

Rooms

A room represents a specific video call location and configuration. You can create, retrieve update, and delete rooms with the VIDEO CONNECT API.

Create a room

POST https://videoconnect.app/api/v1/rooms
Call
{
  "id": "aVZOke",
  "name": "My first room",
  "color": "#5f5f5f",
  "created_at": "2021-04-17T13:10:13.539229-04:00"
}
Response
{
  "id": "aVZOke",
  "name": "My first room",
  "color": "#5f5f5f",
  "created_at": "2021-04-17T13:10:13.539229-04:00"
}

Retrieve a room

GET https://videoconnect.app/fr/api/v1/rooms/aVZOke
Response
{
  "id": "aVZOke",
  "name": "My first room",
  "color": "#5f5f5f",
  "created_at": "2021-04-17T13:10:13.539229-04:00",
  "participants": [
    {
      "id": "Z8zQ4v",
      "room_id": "aVZOke",
      "username": "John Doe",
      "video_and_audio_on": true,
      "language": "fr",
      "created_at": "2021-04-25T14:13:56.466154-04:00"
    }
  ]
}

Update a room

POST https://videoconnect.app/fr/api/v1/rooms/aVZOke
Call
{
  "name": "My first room",
  "color": "#5f5f5f"
}
Response
{
  "id": "aVZOke",
  "name": "My first room",
  "color": "#5f5f5f",
  "created_at": "2021-04-17T13:10:13.539229-04:00"
}

Delete a room

DELETE https://videoconnect.app/fr/api/v1/rooms/aVZOke
Response
{
  "id": "aVZOke",
  "name": "My first room",
  "color": "#5f5f5f",
  "created_at": "2021-04-17T13:10:13.539229-04:00"
}

Participants

Participants control room access and session configuration on a per-user basis.A participant can join a room with a valid meeting token. You can use the parameters to configure how a participant experiences the meeting (e.g. what call features are available).

Create a participant

POST https://videoconnect.app/api/v1/participants
Call
{
  "id": "Z8zQ4v",
  "room_id": "aVZOke",
  "username": "John Doe",
  "video_and_audio_on": true,
  "language": "fr",
  "created_at": "2021-04-25T14:13:56.466154-04:00"
}
Response
{
  "id": "Z8zQ4v",
  "room_id": "aVZOke",
  "username": "John Doe",
  "video_and_audio_on": true,
  "language": "fr",
  "created_at": "2021-04-25T14:13:56.466154-04:00"
}

Retrieve a participant

GET https://videoconnect.app/fr/api/v1/participants/Z8zQ4v
Response
{
  "id": "Z8zQ4v",
  "room_id": "aVZOke",
  "username": "John Doe",
  "video_and_audio_on": true,
  "language": "fr",
  "created_at": "2021-04-25T14:13:56.466154-04:00"
}

Update a participant

POST https://videoconnect.app/fr/api/v1/participants/Z8zQ4v
Call
{
  "room_id": "aVZOke",
  "username": "John Doe",
  "video_and_audio_on": true,
  "language": "fr"
}
Response
{
  "id": "Z8zQ4v",
  "room_id": "aVZOke",
  "username": "John Doe",
  "video_and_audio_on": true,
  "language": "fr",
  "created_at": "2021-04-25T14:13:56.466154-04:00"
}

Delete a participant

DELETE https://videoconnect.app/fr/api/v1/participants/Z8zQ4v
Response
{
  "id": "Z8zQ4v",
  "room_id": "aVZOke",
  "username": "John Doe",
  "video_and_audio_on": true,
  "language": "fr",
  "created_at": "2021-04-25T14:13:56.466154-04:00"
}

Events

Vous pouvez paser des events lorsque le meeting est en cours. Voici la liste des events disponibles
  • activate-video-and-audio (roomid & participantid)
  • desactivate-video-and-audio (roomid & participantid)
  • mute-all (room_id only)

Create an Action

POST https://videoconnect.app/fr/api/v1/events
Call
{
  "room_event": "activate-video-and-audio",
  "room_id": "aVZOke",
  "participant_id": "Z8zQ4v"
}