POST api/v3/room/details
Get meeting room details (v3) by RoomKey: meeting info, room session info (live or ended), participants, transcription/summary completion status and the SummaryUrl. Authenticate with the API Secret sent as an Authorization header: "Authorization: Bearer <secret>". RoomKey is required; the result is scoped to the caller's company.
Request Information
URI Parameters
None.
Body Parameters
RoomKey (required, GUID). Authenticate via Authorization: Bearer <secret> header (required).
RoomDetailsRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| RoomKey |
Meeting room key (GUID). Required. |
string |
None. |
Request Formats
application/json, text/json
{
"RoomKey": "sample string 1"
}
application/xml, text/xml
<RoomDetailsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SeeTheProWebAPI.Controllers"> <RoomKey>sample string 1</RoomKey> </RoomDetailsRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
Meeting, Room, Participants, Recordings (each with its own transcript) and summary/status details including MarkdownSummary
RoomDetailsResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Meeting |
The meeting (campaign) the room belongs to: MeetingKey, MeetingName, MeetingId, recording/notification preferences, conference phone number and passcode. Single row. |
DataTable |
None. |
| Room |
Room session info: RoomStatus "Active" (live) or "Ended" (archived), StartDate, PickedOn, EndOn, IsVideoCall, the lead (customer) name/email/mobile when present, and Metadata - every participant's AdsParams (RoomParticipant.AdsParams, arbitrary caller-supplied JSON captured at join time) merged into a single JSON object; null when no participant supplied any. Single row. |
DataTable |
None. |
| Participants |
Attendees of the room: ParticipantKey, ParticipantName, IsHost, GeoLocation, UserEnvironment, AdsParams. One row per participant. |
DataTable |
None. |
| TranscriptionCompleted |
Whether the AI transcription for this room has completed. |
boolean |
None. |
| SummaryCompleted |
Whether the AI meeting summary for this room has completed. |
boolean |
None. |
| SummaryUrl |
Link to the shareable meeting summary page. Null until SummaryCompleted is true. |
string |
None. |
| SummaryCreatedOn |
When the summary was generated, when available. |
date |
None. |
| MarkdownSummary |
The raw AI-generated meeting summary in markdown (MeetingAssistantSummary.Summary) - distinct from SummaryUrl's rendered HTML brief. Null until SummaryCompleted is true. |
string |
None. |
| Recordings |
Recordings for this room, each with a playable VideoUrl (Azure-hosted), start/end time, duration and its own Transcription/Segments. Empty when the meeting wasn't recorded or hasn't finished processing. |
Collection of MeetingRoomRecording |
None. |
Response Formats
application/json, text/json
{
"Meeting": null,
"Room": [],
"Participants": [],
"TranscriptionCompleted": true,
"SummaryCompleted": true,
"SummaryUrl": "sample string 3",
"SummaryCreatedOn": "2026-07-31T02:26:14.4692872+00:00",
"MarkdownSummary": "sample string 4",
"Recordings": [
{
"RecordingKey": "4d93a1de-57b1-44ac-a2a3-5fcde1b78dcc",
"ArchiveId": "07b934ba-2f84-43e3-bea8-57bc96ab6aef",
"VideoUrl": "sample string 2",
"RecordingStartDate": "2026-07-31T02:26:14.4692872+00:00",
"RecordingEndDate": "2026-07-31T02:26:14.4692872+00:00",
"CreatedOn": "2026-07-31T02:26:14.4692872+00:00",
"IsUploaded": true,
"FileSize": 1,
"Duration": 1,
"Transcription": "sample string 6",
"TranscriptionUpdatedOn": "2026-07-31T02:26:14.4692872+00:00",
"Segments": "sample string 7"
},
{
"RecordingKey": "4d93a1de-57b1-44ac-a2a3-5fcde1b78dcc",
"ArchiveId": "07b934ba-2f84-43e3-bea8-57bc96ab6aef",
"VideoUrl": "sample string 2",
"RecordingStartDate": "2026-07-31T02:26:14.4692872+00:00",
"RecordingEndDate": "2026-07-31T02:26:14.4692872+00:00",
"CreatedOn": "2026-07-31T02:26:14.4692872+00:00",
"IsUploaded": true,
"FileSize": 1,
"Duration": 1,
"Transcription": "sample string 6",
"TranscriptionUpdatedOn": "2026-07-31T02:26:14.4692872+00:00",
"Segments": "sample string 7"
}
]
}
application/xml
Sample not available.
text/xml
Sample not available.