tencent cloud

Feedback

Importing a Single Account

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

    Feature Overview

    This API is used to import an app-owned account to Chat and create an internal ID for the account to ensure that the account can use the Chat service.
    Note:
    If the same account is imported to Chat repeatedly, only one internal ID will be created for the account.

    API Calling Description

    Sample request URL

    https://xxxxxx/v4/im_open_login_svc/account_import?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
    v4/im_open_login_svc/account_import
    Request API
    sdkappid
    SDKAppID assigned by the Chat console when an 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

    200 calls per second

    Sample request

    {
    "UserID":"test",
    "Nick":"test",
    "FaceUrl":"http://www.qq.com"
    }

    Request fields

    Field
    Type
    Required
    Description
    UserID
    String
    Yes
    Username, which is a string of up to 32 bytes in length
    Nick
    String
    No
    User nickname
    FaceUrl
    String
    No
    URL of the user's profile photo

    Sample response

    {
    "ActionStatus":"OK",
    "ErrorInfo":"",
    "ErrorCode":0
    }

    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

    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), see Error Codes. The following table describes the error codes specific to this API:
    Error Code
    Description
    40006
    An internal server error occurred during profile setting. Try again later.
    40601
    The value of the profile field exceeds the length limit of 500 bytes.
    70169
    Server timeout. Try again later.
    70398
    The number of accounts exceeds the limit allowed. To create more than 100 accounts, upgrade your app to the Pro edition. For specific steps, see Purchase Guide.
    70402
    Invalid parameters. Check whether the required fields have been specified or whether the fields are set according to protocol requirements.
    70403
    The request failed. It requires the app admin’s permissions.
    70500
    Internal server error. Try again later.

    API Debugging Tool

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

    References

    Importing Multiple Accounts (v4/im_open_login_svc/multiaccount_import)
    Setting Profiles (v4/profile/portrait_set)
    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