Game Version Creation
General Headers
Name | Description | Type | Sample |
Client-Id | An ID provided by AlipayHK, used to identify partner and application system. | String | 4Q5Y8W0WSG45P907917 |
Content-Type | The RFC 2616 media type of the request body, the charset should be as same as the one used for cryptographic operations. | String | application/json; charset=UTF-8 |
Signature | A key-value pairs string separated by commas (,), which keys and values are joined by equal signs (key=value). Valid keys include:
| String | algorithm=RSA256,keyVersion=1,signature=KEhXthj4bJ801Hqw8kaLvEKc0Rii8KsNUazw7kZgjxyGSPuOZ48058UVJUkkR21iD9JkHBGR rWiHPae8ZRPuBagh2H3qu7fxY5GxVDWayJUhUYkr9m%2FOW4UQVmXaQ9yn%2Fw2dCtzwAW0htPHYrKMyrT pMk%2BfDDmRflA%2FAMJhQ71yeyhufIA2PCJV8%2FCMOa46303A0WHhH0YPJ9%2FI0UeLVMWlJ1XcBo3Jr bRFvcowQwt0lP1XkoPmSLGpBevDE8%2FQ9WnxjPNDfrHnKgV2fp0hpMKVXNM%2BrLHNyMv3MkHg9iTMOD% 2FFYDAwSd%2B6%2FEOFo9UbdlKcmodJwjKlQoxZZIzmF8w%3D%3D |
Encrypt | when message content needs to be encrypted. A key-value pairs string separated by commas (,), which keys and values are joined by equal signs (key=value). Valid keys include:
| String | algorithm=RSA_AES,keyVersion=1,symmetricKey=bqS8HSmdaRrpKSuPy7CqUlyd8lJurG93 |
Request-only Headers
Name | Description | Type | Sample |
Request-Time | The ISO-8601 datetime of this API request with timezone. | String | 2024-05-22T06:42:21+05:30 |
Response-only Headers
Name | Description | Type | Sample |
Response-Time | The ISO-8601 datetime of this API response with timezone. | String | 2024-05-22T06:42:21+05:30 |
Tracer-Id | An ID for tracing this request. | String | abcdefg135202000000000263818 |
Request parameters
appType string REQUIRED
Application type. Currently, only MINI_GAME is supported.
More information:
- Maximum length: 64 characters
appId string REQUIRED
Wallet-side application identifier (GSJ prefix). Must correspond to an existing MINI_GAME application in online status. This is NOT the content provider's gameId.
More information:
- Maximum length: 64 characters
originalVersion string REQUIRED
Content provider's package version identifier. Constitutes part of the idempotency key together with appId.
More information:
- Maximum length: 64 characters
pkgUrl string REQUIRED
Package download URL. Must use HTTPS, not exceed 512 characters, and the host must be included in the platform's download domain whitelist.
More information:
- Maximum length: 512 characters
md5 string REQUIRED
MD5 checksum of the package file. A 32-character hexadecimal string, case-insensitive.
More information:
- Maximum length: 32 characters
minClientVersion string
Minimum required client version. Must follow the version number format (digits and dots). Defaults to 7.6.7 if omitted.
More information:
- Maximum length: 32 characters
forceUpdate boolean
Indicates whether the update is mandatory. Set to true for a forced update, or false otherwise. Defaults to false if omitted.
whitelistLoginIds Array<string> REQUIRED
Preview whitelist login identifiers (phone numbers for the current phase). Each entry must follow the format: country code prefix + number (852/853 prefix with 8 digits, or 86 prefix with 11 digits). The list must contain 1 to 64 entries and cannot be empty.
More information:
- Maximum size: 64 elements
Response parameters
result object REQUIRED
Result information.
appId string
Wallet-side application identifier.
More information:
- Maximum length: 64 characters
platformVersion string
Platform-generated version number in the format 1.0.YYYYMMDDNNN, where the date is in Hong Kong time and NNN is the daily sequence starting from 001.
More information:
- Maximum length: 64 characters
originalVersion string
Content provider's original version identifier. Returns the existing value when an idempotent match is found.
More information:
- Maximum length: 64 characters
versionStatus string
Version status.
P: Preview state.
More information:
- Maximum length: 16 characters
previewUrl string
Preview launch URL. Returns an empty string when the preview URL template is not configured; however, the version creation is still considered successful.
More information:
- Maximum length: 512 characters
Request
Response
Result/Error codes
| Code | Value | Message | Further action |
|---|---|---|---|
| SUCCESS | S | The request was processed successfully. | |
| APP_NOT_EXIST | F | Application not found. The specified appId does not exist or has been taken offline. | Verify the appId or contact the wallet team to confirm the application status. |
| APP_PKG_INVALID | F | Invalid package. This may be caused by a non-HTTPS URL, a domain not in the whitelist, the presence of userinfo, a non-default port, a 3xx redirect, a file exceeding 20MB, an MD5 mismatch, a download failure, or a URL exceeding 512 characters. | Inspect the package URL and package file against the listed scenarios. |
| APP_VERSION_ALREADY_EXIST | F | Version already exists. A concurrent sequence number conflict was detected. | Retry once. If the issue persists, contact the wallet team. |
| PARAM_ILLEGAL | F | Invalid parameter. Missing required fields, format errors, or missing parameters. | Review the request parameters against the field constraints and retry. |
| UNKNOWN_EXCEPTION | U | Unknown exception. The package transfer or access URL retrieval failed, or an unexpected error occurred. | Retry at a later time. If the issue persists, contact the wallet team with the request timestamp and appId. |