tencent cloud

All product documents
Chat
DocumentationChatServer APIsRESTful APIsUser ManagementAccount ManagementImporting Multiple Accounts
Importing Multiple Accounts
Download PDF
Last updated: 2024-12-25 10:04:06
Importing Multiple Accounts
Last updated: 2024-12-25 10:04:06
Download PDF

Feature Overview

This API is used to batch import app-owned accounts into the Chat system, creating a corresponding internal ID for the account, enabling it to use Chat services.
Note:
This API supports importing up to 100 accounts at a time. Repeated import of the same account will only create one internal ID.
When batch importing accounts, if an account already exists, it will be updated with the new parameters provided (user nickname, avatar URL, etc.).

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 Packets for the Old Version

{
  "Accounts": [
    "UserID_001",
    "UserID_002",
    "UserID_003"
  ]
}

Request Packet Fields for the Old Version

Field
Type
Attribute
Description
Accounts
Array
Required
Username list, each username length not exceeding 32 bytes, up to 100 usernames can be imported at a time

Sample Request Packets for the New Version

{
  "AccountList": [
    {
      "UserID": "UserID_001",
      "Nick": "Nick_001",
      "FaceUrl": "http://www.qq.com"
    },
    {
      "UserID": "UserID_002",
      "Nick": "Nick_002",
      "FaceUrl": "http://www.qq.com"
    },
    {
      "UserID": "UserID_002",
      "Nick": "Nick_001",
      "FaceUrl": "http://www.qq.com"
    }
  ]
}

Request Packet Fields for the New Version

Field
Type
Attribute
Description
AccountList
Array
Required
List of users to be imported, up to 100 users can be imported at a time
UserID
String
Required
Username, which is a string of up to 32 bytes in length
Nick
String
Optional
User nickname
FaceUrl
String
Optional
URL of the user's profile photo

Sample response packets

{
    "ActionStatus": "OK",
    "ErrorCode": 0,
    "ErrorInfo": "",
    "FailAccounts": [
        "UserID_002",
        "UserID_003"
    ]
}

Response packet field description

Field
Type
Description
ActionStatus
String
Request result. OK: successful. FAIL: failed
ErrorCode
Integer
Error code. 0: Successful. Other values: Failed
ErrorInfo
String
Error Message
FailAccounts
Array
List of failed account

Error Code Description

Unless a network error occurs (e.g., 502 error), the HTTP status code for this API is always 200. The actual error code and error message are indicated by ErrorCode and ErrorInfo in the response body.
Common error codes (60000 to 79999) can be found in the Error Code document.
Private error codes for this API are as follows:
Error Code
Description
40006
Internal server error when setting data, please try again later.
40601
The length of the Value in the data field exceeds 500 bytes.
70169
Server-side internal timeout, please try again later
70202
Server-side internal timeout, please try again later
70398
Account number exceeds limit. To create more than 100 accounts, please upgrade the application to the professional version. For specific operation guide, see Purchase Guide.
70399
For non-IM trial applications, re-import is not allowed within three months after the account is deleted.
70402
Invalid parameters. Please check whether the required fields are filled or if the fields meet protocol requirements.
70403
Request failed. App administrator permissions are required.
70500
Internal server error, please 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)
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

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

Contact Us
Technical Support

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

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon