Query Multiple Meetings

Request URL

GET {base_url}/services/openapi/v1.0/room/meeting_list?{query parameters}

Request parameters

Response parameters

Details

Parameter	Type	Description
pageSize	Integer	How many records are displayed per page.
pageNo	Integer	Which page is displayed.
total	Long	The total number of records.
list	Array <Meeting_Info>	The information list of the meeting.

Meeting_Info

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.

Repeat_Strategy

Parameter	Type	Description
type	String	Recurring type. DAILY: Repeat every few days. WEEKLY: Repeat on a specific weekday of every few weeks. ABSOLUTE_MONTHLY: Repeat on a specific date of every few months. RELATIVE_MONTHLY: Repeat on a specific weekday of every few months.
frequency	Integer	Recurring frequency.
dayOfWeek	Array <Integer>	The specific weekday of the week. Note: 1 represents Monday, and so on in sequence.
dayOfMonth	Integer	The specific date of the month. Note: -1 represents the last day of the month.
weekOfMonth	Integer	The Xth specific weekday of the month. Note: 1 represents the first one, while -1 represents the last one.
endDate	String	The end date of the meeting recurrence.

Meeting_Services

Parameter	Type	Description
serviceType	String	The name of the meeting service.
notificationRules	Array <Notif_Rule>	The notification rule of the meeting service.
contactIds	Array <Long>	The member ID of the internal service contact. Note: External contacts will not be returned.
serviceRemark	String	Remark for the meeting service.

Notif_Rule

Parameter	Type	Description
meetingStatus	String	The meeting status based on which the system will send notifications to server contacts. NOT_STARTED: Send service notification before the meeting starts. You can specify the time window using the notificationTime parameter. ENDED: When the meeting ends.
notificationTime	Integer	How far in advance will the system send service notifications to the related service contacts before the meeting starts(Unit: minute).

Examples

Request example

GET /services/openapi/v1.0/room/meeting_list?startTime=1689782400&pageSize=2&pageNo=1 HTTP/1.1
Host: workplace.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJncmFudF90eXBlIjoiY2xpZW50X2NyZWRlbnRpYWxzIiwic2NvcGUiOlsiL29wZW5hcGkvIl0sImF0aSI6IjEyNGFmMGI3LWNjMzgtNGEwZC1hZWIwLTEyNWYxNzIwZWRmYyIsImVudGVycHJpc2VfaWQiOjEwMDQzMywicmVnaW9uIjoiR0wiLCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiI2ZDRkMGFhMi0wYWY4LTQ5NTctOWFkYS1hOWM4ZmFhMDc4ODciLCJjbGllbnRfaWQiOiI3OTU2OGFhMC0wYjBkLTQyZjYtOGRiNC03OWExNmQ3MzQ3MmEiLCJ0cyI6MTY4OTc2NDMwNywiZXhwX2luIjo4NjM5OX0.qJg3rOhz5rPtXKyO0mVFeL_TmHExNzhYU2g-1XIOBzo

HTTP/1.1 200 OK
{
    "data": {
        "pageSize": 2,
        "pageNo": 1,
        "total": 5,
        "list": [
            {
                "subject": "Marketing Discussion",
                "startTime": 1689836400,
                "endTime": 1689836662,
                "hostId": 466,
                "participantIds": [
                    2904,
                    23996
                ],
                "guestEmails": [],
                "roomId": 2813,
                "notificationTimes": [15],
                "online": false,
                "meetingId": "WzEsNzM1MTQsMCwxNjg5ODM2NDAwLDBd",
                "meetingStatus": "ENDED",
                "checkedInTime": 1689836120,
                "endedTime": 1689836662
            },
            {
                "subject": "Product Training",
                "startTime": 1689837300,
                "endTime": 1689840900,
                "hostId": 466,
                "participantIds": [
                    3084
                ],
                "guestEmails": [
                    "test@yeastar.com"
                ],
                "roomId": 2810,
                "notificationTimes": [15],
                "online": false,
                "meetingId": "WzEsNzM1MDEsMCwxNjg5ODM3MzAwLDBd",
                "meetingStatus": "ENDED",
                "checkedInTime": 1689837086,
                "endedTime": 1689840900
            }
        ]
    },
    "status": "Success",
    "requestId": "cac6468f1dfed63d1b331ae18b2dcac9"
}