Skip to main content

Получение информации о конференции

Метод и конечная точка​

GET /scc.getConferenceInfo

Описание​

Возвращает базовую информацию о конференции по её номеру.

Параметры​

Перечень параметров представлен в таблице.

НазваниеОбязательныйТип данныхОписание
conferenceNumberдаstringНомер конференции

Запрос​

curl -X 'GET' \
  'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/scc.getConferenceInfo?conferenceNumber=<CONFERENCE_NUMBER>' \
  -H 'accept: application/json' \
  -H 'X-User-Id: <USER_ID>' \
  -H 'x-auth-token: <AUTH_TOKEN>'

Где:

  • <ENV> — окружение, на котором выполняется запрос;
  • <DEFAULT_DOMAIN> — домен сервера Squadus;
  • <USER_ID> — идентификатор пользователя, от имени которого выполняется запрос;
  • <AUTH_TOKEN> — токен аутентификации пользователя;
  • <CONFERENCE_NUMBER> — номер конференции.

Ответ​

200 — Basic information about the conference — Информация о конференции. Пример вывода:

{
  "success": true,
  "data": {
    "_id": "conf_123456",
    "name": "Project Review",
    "number": "1234567890",
    "status": "CREATED",
    "type": "REGULAR",
    "rid": "GENERAL",
    "lobbyStarted": false,
    "conferenceSettings": {
      "audioMute": false,
      "videoMute": false,
      "waitingRoomEnable": true
    },
    "creator": {
      "id": "7w9BMr9r78W4RNe8x",
      "name": "John Doe"
    },
    "createdAt": "2026-06-24T10:00:00.000Z"
  }
}