userid
must start with @RBT#
. Users can set the nicknames, profile photos, and statuses for chatbot accounts when creating them.userid
will create only one chatbot account.https://xxxxxx/v4/openim_robot_http_svc/create_robot?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
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 | |
usersig | |
random | A random 32-bit unsigned integer ranging from 0 to 4294967295 |
contenttype | Request format, which should always be json . |
{"UserID": "@RBT#001","Nick": "Jarvis","FaceUrl": "www.example.com/head.jpg","SelfSignature": "hello, world"}
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. |
{"ActionStatus":"OK","ErrorInfo":"","ErrorCode":0}
Field | Type | Description |
ActionStatus | String | Request result. OK : Successful. FAIL : Failed |
ErrorCode | Integer | Error code. 0 : Successful. Other values: Failed |
ErrorInfo | String | Error information |
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. |
Was this page helpful?