EngageLab

This API queries the VIP status and VIP expiration time of the current application. It supports AppPush and WebPush.

Note: The data center and product type are determined by the request domain or URL route. They do not need to be passed in the request parameters.

Note: The AppKey is carried in the REST API Basic Auth credentials. It does not need to be passed in the query string or request body.

Authentication

For more details, see Authentication method in the REST API overview.

Query App VIP Status

Endpoint

GET v4/app/vip/status

              
              GET v4/app/vip/status

This code block in the floating window

Request Example

Request headers

GET /v4/app/vip/status Authorization: Basic (base64 auth string) Content-Type: application/json

              
              GET /v4/app/vip/status
Authorization: Basic (base64 auth string)
Content-Type: application/json

This code block in the floating window

Request parameters

None.

Response Examples

Successful response

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8

              
              HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

This code block in the floating window

{ "vip_status": 1, "vip_end_time": 1775059200 }

              
              {
    "vip_status": 1,
    "vip_end_time": 1775059200
}

This code block in the floating window

Response parameters

Field	Type	Description
`vip_status`	int	VIP status. `0` means free trial, `1` means paid and active, `2` means available with payment pending, `-1` means free trial expired, `-2` means paid plan expired, and `-3` means unavailable because payment is pending.
`vip_end_time`	int64	VIP expiration time as a Unix timestamp in seconds.

Failed response

HTTP/1.1 401 Unauthorized Content-Type: application/json; charset=utf-8

              
              HTTP/1.1 401 Unauthorized
Content-Type: application/json; charset=utf-8

This code block in the floating window

{ "error": { "code": 21004, "message": "basic auth failed" } }

              
              {
    "error": {
        "code": 21004,
        "message": "basic auth failed"
    }
}

This code block in the floating window

Error Codes

Code	HTTP	Description	Error Message	Details
21004	401	Authentication failed	basic auth failed	The AppKey and MasterSecret do not match, or Basic Auth credentials were not provided.
21008	400	Request parameter error	app_key is not a 24 size string	The AppKey in Basic Auth is not 24 characters long.
21030	503	Internal system error. Try again later	Server response time out, please try again later	The internal service timed out.
27000	500	Internal system error	Server inner err	The internal service call failed or an unexpected error occurred.
27001	401	Invalid authentication information	app_key does not exist or basic info is invalid	The AppKey in Basic Auth has a valid length, but the application does not exist or the application authentication information is invalid.

App VIP Status API

Authentication

Query App VIP Status

Endpoint

Request Example

Response Examples

Error Codes