Query Available Firmwares

Query the available firmwares of P-Series Cloud PBX in specific region(s).

Request URL

GET {base_url}/dm/open_api/v1/firmware

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String Pass the access token in the header.

Format: Bearer {access_token}.
Query parameters
Parameter Required Type Description
type Yes String Firmware type.

Valid value: pbx
regionIds No Array <Integer> The ID list of the desired regions.
Note: You can query the region ID using Query Available Regions.

Response parameters

Parameter Type Description
data Array <Details> The detailed information.
requestId String The unique ID of the request, which can be used to quickly locate the request.
status String Request result:
  • Success
  • Failed
time Long The response time.
Note: The YCM API response returns a timestamp, you can convert the timestamp to detailed date and time as needed. For more information, see Convert Timestamp to Local Date and Time.
Details
Parameter Type Description
versionId Integer The ID of the firmware version.
version String The firmware version.
regionIds Array <Integer> The ID list of the region where the firmware is available.

Example

Request example

Query the available PBX firmware for a region (ID:16).
GET /dm/open_api/v1/firmware?type=pbx&regionIds=16 HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NzM0OSwidmVyc2lvbiI6MTYzODk1OTkwOSwicmVmcmVzaFZlcnNpb24iOjE2NjM1NTkwMDZ9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjYzNTYwODA2LCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiI2N2FmZDY4OS01N2M4LTQ3ZjAtYjg5OS04MmJjNjMzZjZhNmQiLCJjbGllbnRfaWQiOiJrcDl5eW50bXVlc3VrNWpvV3ZNa1RiQ0J4cU82TEtSaCJ9.RkrDaoBpepDUY4FurjRsRZ8JvlwVbEdPguWgsHIjFuk
Response example
HTTP/1.1 200 OK
{
  "data": [
    {
      "versionId": 764,
      "version": "84.8.0.25",
      "regionIds": [
        4,
        16
      ]
    },
    {
      "versionId": 757,
      "version": "84.7.0.51",
      "regionIds": [
        16,
        4
      ]
    }, 
    {
      "versionId": 237,
      "version": "84.6.0.47",
      "regionIds": [
        4,
        16,
        22,
        24,
        28
      ]
    }
  ],
  "requestId": "9a981b12-2cf5-40c9-9b32-498913222ba3",
  "status": "Success",
  "time": 1664275935
}