文档反馈官招募中，报名立赚积分兑换代金券！> HOT
文档中心>实时音视频>视频通话（含 UI）>服务端 API>REST API>发起通话（机器人）

发起通话（机器人）

最近更新时间：2025-08-28 18:15:31

我的收藏

本页目录：

功能说明

App 管理员可以通过该接口发起机器人通话。
注意：
如果您使用的是 TUICallKit.call()或者TUICallKit.groupCall()接口发起通话的，请点击此处跳转至 旧版文档，如果您还有任何疑问，欢迎 联系我们。

接口调用说明

请求 URL 示例

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

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明，更多参数详情请参见 REST API 简介。
参数
说明
xxxxxx
SDKAppID 所在国家/地区对应的专属域名：
中国：console.tim.qq.com
新加坡：adminapisgp.im.qcloud.com
首尔： adminapikr.im.qcloud.com
法兰克福：adminapiger.im.qcloud.com
硅谷：adminapiusa.im.qcloud.com
雅加达：adminapiidn.im.qcloud.com
v4/call_engine_http_srv/start_call_by_robot
请求接口。
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID。
identifier
必须为 App 管理员账号，更多详情请参见 App 管理员。
usersig
App 管理员账号生成的签名，具体操作请参见 生成 UserSig。
random
请输入随机的32位无符号整数，取值范围0 - 4294967295。
contenttype
请求格式固定值为 json。

最高调用频率

200次/秒。

请求包示例

基础形式
{
    "Robot_Account":"user1",
    "CalleeList_Account":["user5"],
    "Timeout":300000,
    "UserData":"userdata-12345687",
    "CallInfo":{
        "MediaType": "Audio",
        "RoomIdType":2,
        "RoomId":"roomid-1234"
    },
    "OfflinePushInfo": {
        "PushFlag": 0,
        "Title":"这是推送标题",
        "Desc": "这是离线推送内容",
        "Ext": "这是透传的内容"
    }
}

请求包字段说明

字段
类型
属性
说明
Robot_Account
String
必填
主叫机器人 UserID，后台不会对此UserID进行心跳健康检查，忙线检查。
CalleeList_Account
Array
必填
被叫 UserID 列表。
Timeout
Integer
必填
超时时间（单位：毫秒），范围（10000 - 600000）毫秒。
UserData
String
选填
自定义数据，会通过发起通话通知透传到被叫端，最大1000个字节。
CallInfo
Object
必填
通话信息。
MediaType
String
必填
媒体类型：
Video 视频通话 。
Audio 音频通话。
RoomId
String
选填
TRTC 房间 ID。
RoomIdType
Integer
选填
RoomId 类型：
1数字房间号。
2字符串房间号。
OfflinePushInfo
Object
选填
离线推送信息配置，详细可参阅 消息格式描述。

应答包体示例

基础形式
{
    "ErrorCode": 0,
    "ErrorInfo": "",
    "ActionStatus": "OK",
    "RequestId": "Id-431454f25a44462d8155bdff4fed38cc-O-Seq-19029769"
}

应答包字段说明

字段
类型
说明
ErrorCode
Integer
错误码，0表示成功，非0表示失败。
ErrorInfo
String
错误信息。
ActionStatus
String
请求处理的结果，OK 表示处理成功，FAIL 表示失败。
RequestId
String
唯一请求 ID，每次请求都会返回，定位问题时需要提供该次请求的 RequestId。

错误码说明

除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码（60000到79999）参见 错误码 文档。
本 API 私有错误码如下：
错误码
含义说明
101001
服务器内部错误，请重试。
101002
请求参数非法，请根据错误描述检查请求是否正确。
101004
通话不存在，或者曾经存在过，但是目前已经结束。


中国站
目录