Help Center/ Customer Engagement Center/ API Reference/ System Configuration API Reference (API Fabric)/ SmartCare Interface/ Interface (queryfaultyuser) for Querying SmartCare Mass Fault Users
Updated on 2025-11-13 GMT+08:00
View PDF
Share

Interface (queryfaultyuser) for Querying SmartCare Mass Fault Users

Description

Query SmartCare mass fault users.

Interface Method

POST

URI

https://Domain name/apiaccess/CC-Management/v1/smartcare/queryfaultyuser (for example, service.besclouds.com)

Request Description

Table 1 Parameters in the request header

No.

Parameter

Type

Mandatory

Description

1

X-APP-Key

string

True

App key, 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 Parameters in the request body

No.

Parameter

Type

Mandatory

Description

1

msisdn

String

True

Mobile number of a user.

2

faultTime

String

True

Fault occurrence time.

Example: 1721283133000

3

complaintScene

String

True

Complaint scenario on the customer side.

4

backtraceDuration

String

False

Backtrace duration from the exception time.

The value ranges from 60 to 86400.

The unit is second.

If the duration exceeds the maximum value 86400, 86400 is used.

Set this parameter to the value of the tenant parameter The duration of SmartCare abnormal time backtracking (s).

5

sessionID

String

False

Customer-side session ID.

6

queryFlag

String

True

Complaining user sampling.

In the AICC interconnection scenario, the value is fixed to 1.

Response Description

  • Status code: 200
    Table 3 Parameters in the response body

    No.

    Parameter

    Type

    Mandatory

    Description

    1

    returnCode

    String

    True

    Response code.

    The value 0 indicates success, and other values indicate failure.

    For details, see Table 4.

    2

    description

    String

    True

    Response description.

    For details, see Table 4.

    3

    data

    List< JSONObject>

    True

    Data queried.

    3.1

    msisdn

    String

    True

    Mobile number of a user.

    3.2

    ttid

    String

    False

    Fault occurrence time.

    The time is in yyyy-MM-dd HH:mm:ss format.
    Table 4 Response code description

    Response Code

    Response Description

    0

    Query succeeded. Data is found in the query result.

    1

    Query succeeded. No data is found in the query result.

    2

    Invalid MSISDN.

    3

    Invalid fault time.

    4

    The scenario does not exist.

    5

    DAC query error.

    97

    Other errors.

    101

    Parameter verification failed.

    102

    AICC internal system error.
  • 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:

{
    "msisdn": "6680512100869",
    "faultTime": "1721283133000",
    "complaintScene": "1",
    "backtraceDuration": "3600",
    "sessionID": "20240709",
    "queryFlag": "1"
}

Response parameters:

{
    "returnCode": 0,
    "description": "Query succeeded. Data is found in the query result.",
    "data": [
        {
            "rules": [
                {
                    "reflectionRule": "FAILURE_CAUSE=DTAPSMS_CP:CP Error(17 Network Failure)",
                    "ccmSceneCode": "SMS"
                },
                {
                    "reflectionRule": "LAC_TAC=5200504B2007&SAI_CGI_ECGI=5200504B2007",
                    "ccmSceneCode": "DATA"
                }
            ],
            "msisdn": "6680512100869"
        }
    ]
}
Parent topic: SmartCare Interface