Checking Accounts

Last updated: 2020-05-14 17:54:40

    Feature Description

    This API is used to check whether a self-owned account has been imported to Instant Messaging (IM). Batch account check is supported.

    API Calling Description

    Request URL example

    https://console.tim.qq.com/v4/im_open_login_svc/account_check?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

    Request parameters

    The following table lists and describes only the parameters to be modified when this API is called. For details on other parameters, see RESTful API Overview.

    Parameter Description
    v4/im_open_login_svc/account_check The request API.
    sdkappid The SDKAppID assigned by the IM console when an app is created.
    identifier This must be the app admin account. For details, see App Admins.
    usersig The signature generated by the app admin account. For details, see Generating UserSig.
    random Enter a random 32-bit unsigned integer ranging from 0 to 4294967295.

    Maximum calling frequency

    The maximum calling frequency is 100 times per second.

    Request packet example

    {
      "CheckItem":
      [
          {
              "UserID":"UserID_1"
          },
          {
              "UserID":"UserID_2"
          }
      ]
    }

    Request packet fields

    Field Type Attribute Description
    CheckItem Array Required The array of account objects to be checked. A single request can check up to 100 accounts.
    UserID String Required The UserID of the account to be checked.

    Response packet example

    {
        "ActionStatus": "OK",
        "ErrorCode": 0,
        "ErrorInfo": "",
        "ResultItem": [
            {
                "UserID": "UserID_1",
                "ResultCode": 0,
                "ResultInfo": "",
                "AccountStatus": "Imported"
            },
            {
                "UserID": "UserID_2",
                "ResultCode": 0,
                "ResultInfo": "",
                "AccountStatus": "NotImported"
            }
        ]
    }

    Response packet fields

    Field Type Description
    ActionStatus String The request processing result. OK: succeeded. FAIL: failed.
    ErrorCode Integer The error code. 0: succeeded. Others: failed.
    ErrorInfo String Error information for request processing failure.
    ResultItem Array The result object array of an account.
    UserID String The UserID of the account to be checked.
    ResultCode Integer The check result of an account. 0: succeeded. Others: failed.
    ResultInfo String Error description for the failure of checking an account.
    AccountStatus String The import status of an account. Imported: imported. NotImported: not imported.

    Error Codes

    Unless a network error (such as error 502) occurs, the HTTP return code for this API is always 200. ErrorCode and ErrorInfo in the response packet represent the actual error code and error information, respectively.
    For common error codes (60000 to 79999), see Error Codes.
    The following table describes the error codes specific to this API.

    Error Code Description
    70169 An internal server timeout occurred. To correct it, try again later.
    70202 An internal server timeout occurred. To correct it, try again later.
    70402 A parameter is invalid. To correct it, check whether required fields are specified and the specified fields meet protocol requirements.
    70403 The request failed. It requires app admin permissions.
    70500 An internal server error occurred. To correct it, try again later.

    API Commissioning Tool

    Use the online commissioning tool for RESTful APIs to commission this API.

    References

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help