Query a Specific Meetings
Query the detailed information of a specific meeting.
Request URL
GET {base_url}/services/openapi/v1.0/room/meeting_detail?{query parameters}
Request parameters
Query parameters
Parameter | Required | Type | Description |
---|---|---|---|
meetingId | Yes | String | The ID of the meeting. Note: You can
query the meeting ID using the Query Multiple Meetings
interface. |
Response parameters
Parameter | Type | Description |
---|---|---|
data | Object <Details> | The detailed information. |
status | String | The result of the request.
|
requestId | String | The ID of the request, which can be used to quickly locate the request. |
- Details
-
Parameter Type Description subject String The subject of the meeting. startTime Long The start time of the meeting. endTime Long The end time of the meeting. hostId Long The member ID of the meeting organizer. participantIds Array <Long> The member ID(s) of internal participant(s). guestEmails Array <String> The email address(es) of external participant(s). roomId Long The ID of the meeting room. notificationTimes Array <Integer> How far in advance will the system send meeting reminders to participants before the meeting starts (Unit: minute). online Boolean Whether the meeting is a Microsoft Teams online meeting. true
: Yes.false
: No.
repeat Object <Repeat_Strategy> The recurrence pattern of recurring meetings. meetingServices Array <Meeting_Servives> The services for the meeting. remark String Remark. meetingId String The ID of the meeting. onlineUrl String The link of the online meeting. status String The current status of the meeting. NOT_STARTED
: The meeting has not started yet.WILL_START
: The meeting is about to start.STARTED
: The meeting has already started.ENDED
: The meeting has ended.CANCELED
: The meeting has been canceled.
checkedInTime Long The time when the meeting is checked in. endedTime Long The time when the meeting is ended. approvalStatus String The approval status of the reservation request for a Request-only Meeting Room. pending
: The request is waiting for approval.approved
: The request has been approved.expired
: The request has expired.rejected
: The request has been rejected.cancel
: The request has been canceled.
Examples
Query the information of a specific meeting (ID:
WzEsNzY0NzQsMCwxNjkwOTU5NjAwLDBd
).
Request
example
GET /services/openapi/v1.0/room/meeting_detail?meetingId=WzEsNzY0NzQsMCwxNjkwOTU5NjAwLDBd HTTP/1.1
Host: workplace.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJncmFudF90eXBlIjoiY2xpZW50X2NyZWRlbnRpYWxzIiwic2NvcGUiOlsiL29wZW5hcGkvIl0sImF0aSI6IjEyNGFmMGI3LWNjMzgtNGEwZC1hZWIwLTEyNWYxNzIwZWRmYyIsImVudGVycHJpc2VfaWQiOjEwMDQzMywicmVnaW9uIjoiR0wiLCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiI2ZDRkMGFhMi0wYWY4LTQ5NTctOWFkYS1hOWM4ZmFhMDc4ODciLCJjbGllbnRfaWQiOiI3OTU2OGFhMC0wYjBkLTQyZjYtOGRiNC03OWExNmQ3MzQ3MmEiLCJ0cyI6MTY4OTc2NDMwNywiZXhwX2luIjo4NjM5OX0.qJg3rOhz5rPtXKyO0mVFeL_TmHExNzhYU2g-1XIOBzo
Response example
HTTP/1.1 200 OK
{
"data": {
"subject": "Monthly meeting",
"startTime": 1690959600,
"endTime": 1690963200,
"hostId": 466,
"participantIds": [
3084
],
"guestEmails": [
"test@yeastar.com"
],
"roomId": 2810,
"notificationTimes": [],
"online": false,
"repeat": {
"type": "RELATIVE_MONTHLY",
"frequency": 1,
"dayOfWeek": [
3
],
"weekOfMonth": 1,
"endDate": "2024-07-23T17:00:00+10:00[Australia/Sydney]"
},
"meetingServices": [
{
"serviceType": "Tech Support",
"notificationRules": [
{
"meetingStatus": "NOT_STARTED",
"notificationTime": 15
}
],
"contactIds": [
2904,
3084
],
"serviceRemark": "Test service"
}
],
"remark": "Create a Test Meeting",
"meetingId": "WzEsNzY0NzQsMCwxNjkwOTU5NjAwLDBd",
"meetingStatus": "NOT_STARTED"
},
"status": "Success",
"requestId": "a94ca10dda46383496765788fb314bb9"
}