Get Real-Time Call Status
功能说明
App 管理员可以通过该接口获取实时通话状态。
警告:
我们如果您使用的是
TUICallKit.call()
或者TUICallKit.groupCall()
接口发起通话的,请查看:Deprecated Document 目录,如果您还有任何疑问,您可以联系:info_rtc@tencent.com 。接口调用说明
请求 URL 示例
https://xxxxxx/v4/call_engine_http_srv/get_call_info?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
参数 | 说明 |
xxxxxx | SDKAppID 所在国家/地区对应的专属域名: 中国: console.tim.qq.com 新加坡: adminapisgp.im.qcloud.com 首尔: adminapikr.im.qcloud.com |
v4/call_engine_http_srv/get_call_info | 请求接口 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数,取值范围0 - 4294967295 |
contenttype | 请求格式固定值为`json` |
最高调用频率
200次/秒。
请求包示例
基础形式
{"CallId": "055662e1-bc8a-469c-a334-1126c8c17d58"}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
CallId | String | 必填 | 通话 ID |
应答包体示例
基础形式
{"ErrorCode": 0,"ErrorInfo": "","ActionStatus": "OK","RequestId": "Id-431454f25a44462d8155bdff4fed38cc-O-Seq-19029769","Response": {"CallInfo": {"CallId": "055662e1-bc8a-469c-a334-1126c8c17d58","MediaType": "Audio","ChatGroupId": "","RoomId": "","RoomIdType": 0},"UserList": [{"User_Account": "user1","Status": "Calling"},{"User_Account": "user2","Status": "Waiting"}]}}
应答包字段说明
字段 | 类型 | 说明 |
ErrorCode | Integer | 错误码,0表示成功,非0表示失败 |
ErrorInfo | String | 错误信息 |
ActionStatus | String | 请求处理的结果,OK 表示处理成功,FAIL 表示失败 |
RequestId | String | 唯一请求 ID,每次请求都会返回,定位问题时需要提供该次请求的 RequestId |
CallId | String | 通话 ID |
MediaType | String | 媒体类型: Video 视频通话Audio 音频通话 |
ChatGroupId | String | IM 群 ID |
RoomId | String | TRTC 房间 ID |
RoomIdType | Integer | TRTC 房间 ID 类型: 1 数字房间号2 字符串房间号 |
UserList | Array | 通话成员列表 |
User_Account | String | 通话用户 ID |
Status | String | 通话状态: Calling 通话中Waiting 等待接通 |
错误码说明
除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
本 API 私有错误码如下:
错误码 | 含义说明 |
101001 | 服务器内部错误,请重试 |
101002 | 请参数非法,请根据错误描述检查请求是否正确 |
101004 | 通话不存在,或者曾经存在过,但是目前已经结束 |