tencent cloud

Feedback

Querying Accounts

Last updated: 2024-07-16 11:25:50

    Feature Overview

    This API is used to query whether app-owned accounts have been imported to Chat. Batch query is supported.

    API Calling Description

    Sample request URL

    https://xxxxxx/v4/im_open_login_svc/account_check?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

    Request parameters

    The following table describes the modified parameters when this API is called. For other parameters, see RESTful API Overview.
    Parameter
    Description
    xxxxxx
    Domain name corresponding to the country/region where your SDKAppID is located.
    China: console.tim.qq.com
    Singapore: adminapisgp.im.qcloud.com
    Seoul: adminapikr.im.qcloud.com
    Frankfurt: adminapiger.im.qcloud.com
    Silicon Valley: adminapiusa.im.qcloud.com
    Jakarta: adminapiidn.im.qcloud.com
    v4/im_open_login_svc/account_check
    Request API
    sdkappid
    SDKAppID assigned by the console when the app is created
    identifier
    App admin account. For more information, see the App Admin section in Login Authentication.
    usersig
    Signature generated by the app admin account. For details, see Generating UserSig.
    random
    A random 32-bit unsigned integer ranging from 0 to 4294967295
    contenttype
    Request format, which should always be json.

    Maximum call frequency

    100 times/second

    Sample request

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

    Request fields

    Field
    Type
    Required
    Description
    CheckItem
    Array
    Yes
    Account object array to check. A single request can contain up to 100 accounts.
    UserID
    String
    Yes
    UserID of the account to check

    Sample response

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

    Response fields

    Field
    Type
    Description
    ActionStatus
    String
    Request result. OK: Successful. FAIL: Failed
    ErrorCode
    Integer
    Error code. 0: Successful. Other values: Failed
    ErrorInfo
    String
    Error information about the request failure
    ResultItem
    Array
    Array of results for different accounts
    UserID
    String
    UserID of the account to check
    ResultCode
    Integer
    Check result for the account. 0: Successful. Other values: Failed
    ResultInfo
    String
    Error information about the failure to check the account
    AccountStatus
    String
    Import status of an account. Valid values: Imported and NotImported

    Error Codes

    The returned HTTP status code for this API is always 200 unless a network error (such as error 502) occurs. The specific error code and details can be found in the response fields ErrorCode and ErrorInfo respectively. For public error codes (60000 to 79999), please see Error Codes. The following table describes the error codes specific to this API:
    Error Code
    Description
    70169
    Server timeout. Try again later.
    70202
    Server timeout. Try again later.
    70402
    Invalid parameters. Make sure that the required fields are all entered and the parameter settings meet the protocol requirements.
    70403
    Request failed. App admin permissions are required to perform this operation.
    70500
    Internal server error. Try again later.

    API Debugging Tool

    Use the RESTful API online debugging tool to debug this API.

    References

    Importing a Single Account (v4/im_open_login_svc/account_import)
    Importing Multiple Accounts (v4/im_open_login_svc/multiaccount_import)
    Invalidating Account Login States (v4/im_open_login_svc/kick)
    Querying Account Online Status (v4/openim/query_online_status)
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support