远程协作
1. 准备
基础域名:https://api.rokid.com
准备:
- 确保已经获取到了有效的 API 密钥(
API_KEY),用于身份验证。 - 确保企业下已经存在远程协作会议记录,便于查询分页结果和会议参会人信息。
2. 功能介绍
远程协作模块提供通讯记录分页查询和会议人员查询能力,帮助开发者查看企业下的会议历史、会议状态以及参会人员当前所处状态。
2.1 通讯记录分页查询
接口地址:https://api.rokid.com/ar/corporation/openapi/rtc/meeting/info/page
请求方式:POST
请求数据类型:application/json
响应数据类型:*/*
接口描述:分页查询当前企业下的远程协作通讯记录。
请求参数:
| 参数名称 | 参数说明 | 是否必须 | 数据类型 |
|---|---|---|---|
| pageNum | 页码,默认值 1 | false | int |
| pageSize | 每页数量,默认值 10 | false | int |
| meetingName | 会议名称,模糊匹配 | false | string |
| companyId | 组织 ID | true | string |
| startTime | 查询开始时间,格式 yyyy-MM-dd HH:mm:ss | false | string |
| endTime | 查询结束时间,格式 yyyy-MM-dd HH:mm:ss | false | string |
输出结果:
| 参数名称 | 参数说明 | 是否必须 | 数据类型 |
|---|---|---|---|
| pageNum | 当前页码 | true | int |
| pageSize | 每页数量 | true | int |
| total | 总记录数 | true | long |
| list | 会议记录列表 | true | array |
| id | 主键 ID | true | long |
| meetingId | 会议 ID | true | string |
| meetingName | 会议名称 | false | string |
| gmtCreated | 会议开始时间 | false | string |
| gmtModified | 会议结束时间 | false | string |
| meetingDuration | 会议时长 | false | string |
| egressRecordUrl | 录制地址 | false | string |
| meetingStatus | 会议状态:进行中、已结束 | true | string |
请求示例:
bash
curl -X POST "https://api.rokid.com/ar/corporation/openapi/rtc/meeting/info/page" \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"pageNum": 1,
"pageSize": 10,
"meetingName": "设备巡检沟通会",
"companyId": "rokid-demo-company",
"startTime": "2026-06-01 00:00:00",
"endTime": "2026-06-17 23:59:59"
}'响应示例:
json
{
"pageNum": 1,
"pageSize": 10,
"total": 1,
"list": [
{
"id": 101,
"meetingId": "RM_202606170001",
"meetingName": "设备巡检沟通会",
"gmtCreated": "2026-06-17 10:00:00",
"gmtModified": "2026-06-17 10:45:00",
"meetingDuration": "45分00秒",
"egressRecordUrl": "https://example.com/records/RM_202606170001.mp4",
"meetingStatus": "已结束"
}
]
}2.2 会议人员查询
接口地址:https://api.rokid.com/ar/corporation/openapi/rtc/meeting/record/list?id={$meetingId}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
接口描述:根据会议 ID 查询会议参会人员列表及其当前状态。
请求参数:
| 参数名称 | 参数说明 | 是否必须 | 数据类型 |
|---|---|---|---|
| id | 会议 ID | true | string |
输出结果:
| 参数名称 | 参数说明 | 是否必须 | 数据类型 |
|---|---|---|---|
| participantUserFullName | 参会人姓名 | false | string |
| participantUserName | 参会人用户名 | false | string |
| startTime | 加入会议时间 | false | string |
| endTime | 离开会议时间 | false | string |
| meetingDuration | 参会时长 | false | string |
| status | 参会状态:会议中、已退出、未进入 | true | string |
请求示例:
bash
curl -X GET "https://api.rokid.com/ar/corporation/openapi/rtc/meeting/record/list?id=RM_202606170001" \
-H "Authorization: Bearer $API_KEY"响应示例:
json
[
{
"participantUserFullName": "张三",
"participantUserName": "zhangsan",
"startTime": "2026-06-17 10:00:12",
"endTime": "2026-06-17 10:45:00",
"meetingDuration": "44分48秒",
"status": "已退出"
},
{
"participantUserFullName": "李四",
"participantUserName": "lisi",
"startTime": "2026-06-17 10:05:20",
"endTime": "",
"meetingDuration": "",
"status": "会议中"
}
]