please select
Docs Overview/
Chat/
Server APIs/
RESTful APIs/
Chatbots/
Creating Chatbot Accounts/

Creating Chatbot Accounts

Feature Overview

This API is used to create a chatbot account. A chatbot account is a special account whose userid must start with @RBT#. Users can set the nicknames, profile photos, and statuses for chatbot accounts when creating them.
Note:
Repeatedly calling this API with the same chatbot userid will create only one chatbot account.
Each Chat account can create up to 20 chatbot accounts.

API Calling Description

Sample request URL

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

Request parameters

The following table lists the parameters used when this API is called and their descriptions. For other parameters, see the 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/openim_robot_http_svc/create_robot
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": "@RBT#001",
    "Nick": "Jarvis",
    "FaceUrl": "www.example.com/head.jpg",
    "SelfSignature": "hello, world"
}

Request fields

Field
Type
Required
Description
UserID
String
Yes
Chatbot username, which is a string of up to 32 bytes in length and must start with @RBT#.
Nick
String
No
Chatbot nickname
FaceUrl
String
No
URL of the bot's profile photo
SelfSignature
String
No
Status of the chatbot, which is up to 500 bytes.

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
10002
Internal error. Try again.
10004
Invalid parameter. Check whether the required fields are all set and whether the parameter settings meet the protocol requirements.
10008
Invalid request. For example, the request requires app admin permissions or the number of created chatbots reaches the upper limit.
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.
70398
The number of accounts exceeds the limit allowed. To create more than 100 accounts, upgrade your app. For upgrade instructions, see Purchase Guide.

API Debugging Tool

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

References

Querying Accounts (v4/im_open_login_svc/account_check)
Setting Profiles (v4/profile/portrait_set)