API Requirements

This topic describes the requirements for using Yeastar Cloud PBX API.

Requirements

Before using the API feature, make sure the following configurations are ready:

PBX version
This documentation is based on API 2.0.0, you need to upgrade PBX firmware to the version that is applicable to API 2.0.0.
PBX version requirement: Firmware version 81.13.0.30 or later.
API enabled on PBX
By default, API feature on PBX is disabled. Before using API feature, you need to enable API on API Settings on PBX and configure the relevant settings.