please select
Docs Overview/
Chat/
Server APIs/
RESTful APIs/
User Management/
Account Management/
Importing Multiple Accounts/

Importing Multiple Accounts

Feature Overview

This API is used to batch import app-owned accounts to Tencent Cloud Chat and create an internal ID for each of these accounts to ensure that these accounts can use the Chat service.
Note:
This API can import up to 100 accounts at a time. If an account is imported repeatedly, only one internal ID will be created for it.
This API is unable to import account nicknames and profile photos. You can call the Setting Profiles API to set account nicknames and profile photos.

API Calling Description

Sample request URL

https://xxxxxx/v4/im_open_login_svc/multiaccount_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/multiaccount_import
The request API that is used.
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

100 times/second

Sample request

{
"Accounts":["test1","test2","test3","test4","test5"]
}

Request fields

Field
Type
Required
Description
Accounts
Array
Required
The user name of the account. A single user name cannot exceed 32 bytes in length. Up to 100 user names can be imported at a time.

Sample response

{
    "ActionStatus": "OK",
    "ErrorCode": 0,
    "ErrorInfo": "",
    "FailAccounts": [
        "test3",
        "test4"
    ]
}

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
FailAccounts
Array
A list of accounts that failed to be imported.

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
70169
The server timed out. Try again later.
70202
The server timed out. 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 a Single Account (v4/im_open_login_svc/account_import)
Deleting an account (v4/im_open_login_svc/account_delete)
Querying Accounts (v4/im_open_login_svc/account_check)
Invalidating Account Login States (v4/im_open_login_svc/kick)
Querying Account Online Status (v4/openim/query_online_status)