API

TrueConfAbout 1 min

API

TrueConf MCU supports OAS3 — the OpenAPI version 3 specification (formerly Swagger Specification).
/docs/mcu/media/api/en.png

Features

With the API you can:

  • manage:

    • the address book (create, edit users and groups)

    • a conference (layouts, audio channels, participants, etc.)

  • receive resource usage data

  • update the server

  • reboot the OS, shut down or restart the server

  • configure time and NTP

  • perform data backup, export, and import (also from TrueConf MCU version 1.5);

  • diagnose network problems

  • register a license

  • schedule a conference

  • and much more.

Access to API

The REST API documentation is available on the machine with TrueConf MCU installed. To access it, you need to go to {IP_or_FQDN}/api/doc/, where {IP_or_FQDN} is the IP address or fully qualified domain name (FQDN) of the MCU machine, for example, 10.110.2.244/api/doc/.

Help with API

If you have any questions regarding the product or API, feel free to ask them in our Telegram community.