Hybrid App

Version Check

post

Function Description

• Retrieves the version that needs to be updated.

---

Detailed Description

• Retrieved based on appVersion, osType, and the siteNo value in the cookie.

• Only codes with usage status Y are retrieved.

• Only a single record is retrieved, based on the most recent update date and time.

Header parameters

AuthorizationanyOptional

Access Token

Body

Version Check API Request

siteDomstringRequired

Site Domain

Example: fo.x2bee.com

appVersionstringRequired

Version of the currently running app

Example: 1.0.0

osTypestringRequired

OS Type I: iOS, A: AOS

Example: I

osVersionstringOptional

Version information of the OS installed on the device

deviceNamestringOptional

Device Name

Example: iphone 15 pro

Responses

200

Success

*/*

timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

errorbooleanOptional

is error

900

Business processing error details

*/*

post/v1/app/version

POST /api/common/v1/app/version HTTP/1.1
Host: api-common.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 108

{
  "siteDom": "fo.x2bee.com",
  "appVersion": "1.0.0",
  "osType": "I",
  "osVersion": "text",
  "deviceName": "iphone 15 pro"
}

{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": {
    "versionInfo": {
      "updateType": "N",
      "storeUrl": "https://xxxxxxx"
    },
    "splashInfo": {
      "imgUrl": "https://xxxxxxx"
    }
  },
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}