Help Center/ Customer Engagement Center/ API Reference/ System Configuration API Reference (API Fabric)/ AppCube OU Isolation Interface/ Interface for Querying System-Level Parameters in the AICC (querySysparam)
Updated on 2025-11-13 GMT+08:00
View PDF
Share

Interface for Querying System-Level Parameters in the AICC (querySysparam)

Scenario Description

Querying system-level parameters in the AICC.

Interface Method

POST

Interface URI

https://domain name/apiaccess/ipccprovision/v1/sysparam/querySysparam. For example, service.besclouds.com

Request Description

Table 1 Request header parameters

No.

Parameter

Parameter Type

Mandatory or Not

Description

1

X-APP-Key

string

True

appKey field, which is the user ID

2

Authorization

string

True

Authentication field. The format is Bearer (space){Value of AccessToken returned by the tokenByAkSk interface}. (A space is required after Bearer.)
Table 2 Request body parameters

No.

Parameter

Parameter Type

Mandatory or Not

Description

1

sysparamItemIds

List<String>

True

System-level parameter ID.

A maximum of 20 system-level parameter IDs can be configured. Use commas (,) to separate multiple IDs.

Response Description

  • Status code: 200
    Table 3 Response body parameters

    No.

    Parameter

    Parameter Type

    Mandatory or Not

    Description

    1

    returnCode

    String

    True

    Response code.

    The value 0 indicates success and other values indicates failure.

    2

    description

    String

    True

    Response result description.

    3

    result

    Map<String, value >

    True

    key indicates sysparamItemId, and value indicates the corresponding value.
  • Status code: 400

    Incorrect request. Check the request path and parameters.

  • Status code: 401

    Unauthorized operation. 1. Check whether you have purchased related services. 2. Contact customer service to check the status of your account.

  • Status code: 404

    The requested content is not found. Check the request path.

  • Status code: 500

    Business failure. Check the values of parameters in the request.

Message Example

Request header:

x-app-key:9******************************3  
Authorization:Bearer e******************************e  
Content-Type:application/json

Request parameters:

{
    "sysparamItemIds":["6009001000003","6009001000001"]
}

Response parameters:

{
    "returnCode": "0",
    "description": "query success",
    "result": {
        "6009001000003": "0|Putonghua,2|Cantonese,137|CustomizedEnglish",
        "6009001000001": "300"
    }
}