Skip to content

远程协作

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页码,默认值 1falseint
pageSize每页数量,默认值 10falseint
meetingName会议名称,模糊匹配falsestring
companyId组织 IDtruestring
startTime查询开始时间,格式 yyyy-MM-dd HH:mm:ssfalsestring
endTime查询结束时间,格式 yyyy-MM-dd HH:mm:ssfalsestring

输出结果:

参数名称参数说明是否必须数据类型
pageNum当前页码trueint
pageSize每页数量trueint
total总记录数truelong
list会议记录列表truearray
id主键 IDtruelong
meetingId会议 IDtruestring
meetingName会议名称falsestring
gmtCreated会议开始时间falsestring
gmtModified会议结束时间falsestring
meetingDuration会议时长falsestring
egressRecordUrl录制地址falsestring
meetingStatus会议状态:进行中已结束truestring

请求示例:

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会议 IDtruestring

输出结果:

参数名称参数说明是否必须数据类型
participantUserFullName参会人姓名falsestring
participantUserName参会人用户名falsestring
startTime加入会议时间falsestring
endTime离开会议时间falsestring
meetingDuration参会时长falsestring
status参会状态:会议中已退出未进入truestring

请求示例:

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": "会议中"
  }
]