tencent cloud

Mobile Live Video Broadcasting

DocumentaçãoMobile Live Video BroadcastingServer APIs (TUILiveKit)REST APIRobotAdd Room Robot

Add Room Robot

PDF
Modo Foco
Tamanho da Fonte
Última atualização: 2026-04-09 12:11:13

Feature Description

App admins can add a chatbot to room use this API.

API Call Description

Sample Request URL

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

Request Parameters

The following table only lists the parameters involved in modification when calling this API and their descriptions. For more details about the parameters, please see RESTful API Overview.
Parameters
Description
xxxxxx
The reserved domain for the country/region where the SDKAppID is located:
Others in China: console.tim.qq.com
Singapore: adminapisgp.im.qcloud.com
Silicon Valley: adminapiusa.im.qcloud.com
Jakarta: adminapiidn.im.qcloud.com
v4/live_engine_http_srv/add_robot
Request API.
sdkappid
Create an assigned SDKAppID for the Live application.
identifier
Must be an App administrator account. For more details, see App Admin.
usersig
The generated signature of the App administrator account. For specific operations, see Generating UserSig.
random
Enter a random 32-bit unsigned integer in the range of 0 to 4294967295.
contenttype
The request format has a fixed value of json.

Maximum Calling Frequency

100 times/second.

Request Packet

Basic form
{
    "RoomId":"mix1",
    "RobotList_Account":["brennanli"]    
}

Request Packet Fields

Field
Type
Required
Description
RoomId
String
Required
room ID, up to 48 bytes.
RobotList_Account
Array
Required
Robot list Bot account, i.e. user UserID, must be an imported account.

Response Package Example

Basic form
{
  "ActionStatus": "OK",
  "ErrorInfo": "",
  "ErrorCode": 0,
  "RequestId": "Id-8c9858f01e954611ae2d4c1b1ed7d583-O-Seq-52720"
}

Response Packet Fields

Field
Type
Description
ActionStatus
String
Request processing result. OK: processing successful; FAIL: failure.
ErrorCode
Integer
Error code. 0: success; non-0: failure.
ErrorInfo
String
Error message.
RequestId
String
Unique request ID. It is returned for each request. RequestId is required for locating a problem.

Error Code Description

Unless a network error (for example, 502 error) occurs, the HTTP return code of this API is always 200. The actual error code and error information are represented by ErrorCode and ErrorInfo in the response packet body.
For common error codes (60000 to 79999), see the Error Code document.
The 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.
100006
The room type required is the Live room type.
100004
The room does not exist or is dissolved.

Anterior: Obtain Battle InformationPróximo: Delete Room Robot

Ajuda e Suporte

Esta página foi útil?

comentários