tencent cloud

Tencent Real-Time Communication

DocumentationTencent Real-Time CommunicationConferenceServer APIs (TUIRoomKit)REST APIRobot ManagementAdding a Robot

Adding a Robot

PDF
Focus Mode
Font Size
Last updated: 2025-07-08 14:15:06

Feature Description

The App admin can use this API to add robots in the room.

API Call Description

Sample Request URL

https://console.tim.qq.com/v4/room_engine_http_srv/add_robot?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

Request Parameters

The following table lists only the parameters involved in modification when calling this API and their descriptions. For more details about the parameters, please refer to REST API introduction.
Parameter
Description
v4/room_engine_http_srv/add_robot
Request API
sdkappid
The SDKAppID assigned by the IM console when creating an application
identifier
must be an App administrator account. For more details, see app admin
usersig
The signature generated by the App administrator account. For specific operations, see generate UserSig
random
Enter a random 32-bit unsigned integer, value ranges from 0 to 4294967295
contenttype
The request format is fixed as json.

Maximum Calling Frequency

200 requests per second.

Sample Request Packet

Basic form
{
  "RoomId": "room-test",
  "Member_Account": "user1"
}

Request Packet Fields

Field
Type
Attribute
Description
RoomId
String
Required
room ID
Member_Account
String
Required
robot ID

Sample Response Packet

Basic form
{
  "ErrorCode": 0,
  "ErrorInfo": "",
  "ActionStatus": "OK",
  "RequestId": "Id-52f049ba12d741b7a84959700acdb1d5-O-Seq-56287"
}

Response Packet Fields

Field
Type
Description
ActionStatus
String
Request processing result. OK: processing successful; FAIL: processing failed.
ErrorCode
Integer
Error code: 0 indicates success, non-0 indicates failure.
ErrorInfo
String
Error Message
RequestId
String
Unique request ID, returned for each request. To locate a problem, provide the RequestId of that request.

Error Code Description

Unless a network error (such as 502) occurs, the HTTP return code of this API is 200. The actual error code and error information are in the ErrorCode and ErrorInfo fields of the response payload.
Common error codes (60000 to 79999), please refer to the Error Code document.
Private error codes of this API are as follows:
Error Code
Description
100001
Internal server error, please retry.
100002
Invalid parameter. Check whether the request is correct according to the error description.
100004
The room does not exist, or may have existed but has been dismissed.
100005
non-room member
100006
Insufficient operation permissions
100700
The number of machines has reached the limit.
Previous Topic: Lock the SeatNext Topic: Deleting a Robot

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback