Skip to content

Remote Collaboration

1. Prerequisites

Base URL: https://api.rokid.com

  • Keep a valid API_KEY for authentication.
  • Make sure your company already has remote collaboration meeting records before querying meeting history or participant details.

2. Overview

Remote Collaboration APIs provide paginated meeting history and participant lookup so integrations can inspect meeting progress, meeting lifecycle, and participant presence states.

2.1 List meeting history

Endpoint https://api.rokid.com/ar/corporation/openapi/rtc/meeting/info/page

Method POST

Request application/json

Response */*

Description Query paginated remote collaboration meeting history for the current company.

Parameters

NameDescriptionRequiredType
pageNumPage number, default 1falseint
pageSizePage size, default 10falseint
meetingNameFuzzy match on meeting namefalsestring
companyIdCompany identifiertruestring
startTimeQuery start time, format yyyy-MM-dd HH:mm:ssfalsestring
endTimeQuery end time, format yyyy-MM-dd HH:mm:ssfalsestring

Response fields

NameDescriptionRequiredType
pageNumCurrent page numbertrueint
pageSizePage sizetrueint
totalTotal recordstruelong
listMeeting recordstruearray
idPrimary keytruelong
meetingIdMeeting identifiertruestring
meetingNameMeeting namefalsestring
gmtCreatedMeeting start timefalsestring
gmtModifiedMeeting end timefalsestring
meetingDurationMeeting durationfalsestring
egressRecordUrlRecording URLfalsestring
meetingStatusMeeting status: 进行中 or 已结束truestring

Example

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": "Device Inspection Review",
  "companyId": "rokid-demo-company",
  "startTime": "2026-06-01 00:00:00",
  "endTime": "2026-06-17 23:59:59"
}'

Sample response

json
{
  "pageNum": 1,
  "pageSize": 10,
  "total": 1,
  "list": [
    {
      "id": 101,
      "meetingId": "RM_202606170001",
      "meetingName": "Device Inspection Review",
      "gmtCreated": "2026-06-17 10:00:00",
      "gmtModified": "2026-06-17 10:45:00",
      "meetingDuration": "45m00s",
      "egressRecordUrl": "https://example.com/records/RM_202606170001.mp4",
      "meetingStatus": "已结束"
    }
  ]
}

2.2 List meeting participants

Endpoint https://api.rokid.com/ar/corporation/openapi/rtc/meeting/record/list?id={$meetingId}

Method GET

Request application/x-www-form-urlencoded

Response */*

Description Query participants for a meeting by meeting ID and inspect each participant status.

Parameters

NameDescriptionRequiredType
idMeeting IDtruestring

Response fields

NameDescriptionRequiredType
participantUserFullNameParticipant full namefalsestring
participantUserNameParticipant usernamefalsestring
startTimeJoined-at timefalsestring
endTimeLeft-at timefalsestring
meetingDurationAttendance durationfalsestring
statusParticipant status: 会议中, 已退出, or 未进入truestring

Example

bash
curl -X GET "https://api.rokid.com/ar/corporation/openapi/rtc/meeting/record/list?id=RM_202606170001" \
-H "Authorization: Bearer $API_KEY"

Sample response

json
[
  {
    "participantUserFullName": "Alice",
    "participantUserName": "alice",
    "startTime": "2026-06-17 10:00:12",
    "endTime": "2026-06-17 10:45:00",
    "meetingDuration": "44m48s",
    "status": "已退出"
  },
  {
    "participantUserFullName": "Bob",
    "participantUserName": "bob",
    "startTime": "2026-06-17 10:05:20",
    "endTime": "",
    "meetingDuration": "",
    "status": "会议中"
  }
]