Query Meeting List

Last Updated on : 2023-06-21 07:13:01download

Query the meeting reservation history by criteria, such as the meeting theme, meeting room ID, meeting status, creator, start time, and end time.

API address

GET: /v2.0/iot-03/meeting-reservations

Request parameter

Parameter name	Type	IN	Required	Description
req	MeetingReservationPageQueryReq	query	true	The request of querying the meeting reservation history.

Description of req

Parameter name	Type	Required	Description
topic	String	false	The theme of a specified meeting.
start_time	Long	true	The start time of a specified meeting.
end_time	Long	true	The end time of a specified meeting.
status	String	false	The status of a specified meeting, separated with commas (,).
meeting_room_ids	String	false	The IDs of bound meeting rooms, separated with commas (,).
creator	String	false	The ID of the user who creates the meeting.
page_no	Integer	false	The page number.
page_size	Integer	false	The quantity.

Return parameter

Parameter name	Type	Description
result	Page	The returned result.

Description of result

Parameter name	Type	Description
total	Long	The total number of meeting reservation records.
list	List	The returned list.
has_more	Boolean	Specifies whether to return the next page.

Description of list

Parameter name	Type	Description
reservation_id	String	The reservation ID.
topic	String	The theme of a specified meeting.
start_time	Long	The start time of a specified meeting.
end_time	Long	The end time of a specified meeting.
status	Integer	Indicates the status of a specified meeting. Valid values: `1`: normal. `2`: to be approved. `3`: canceled. `4`: rejected.
room_id	String	The ID of a specified meeting room.
participants	List	The ID of a specified participant in the meeting.
cc_participants	List	The ID of a specified person who is mentioned in the carbon copy.
notice	Boolean	The push notification.
notice_time	Long	The period for a push notification to be sent in advance of a meeting.
description	String	The description of a specified meeting.
creator	String	The ID of the user who creates the meeting.
modifier	String	The ID of the user who modifies the meeting.
gmt_create	Long	The time when it is created.
gmt_modified	Long	The time when it is modified.
attachments	List	The information about a specified attachment.

Description of attachments

Parameter name	Type	Description
name	String	The name of a specified attachment.
url	String	The URL of a specified attachment.
size	String	The size of a specified attachment.
type	String	The type of a specified attachment.

Request example

GET: /v2.0/iot-03/meeting-reservations?meeting_room_ids=140979237901944****,14123112756055****&creator=3&start_time=1622343649000&end_time=1627615862000

Return example

{
    "result": {
        "list": [
            {
                "gmt_create": 1637744160943,
                "room_id": "14634253124224****",
                "cc_participants": [
                ],
                "creator": "bay1632819585638****",
                "attachments": [
                    {
                        "type": "jpg",
                        "url": "https://****.com/c.jpg",
                        "size": "333.2kb",
                        "name": "c.jpg"
                    }
                ],
                "modifier": "",
                "end_time": 1637910000000,
                "description": "desc",
                "gmt_modified": 1637807314249,
                "reservation_id": "14634311956761****",
                "start_time": 1637899200000,
                "notice_time": 0,
                "topic": "xxx Meeting",
                "notice": false,
                "participants": [
                    "bay1628606646112****",
                    "bay1628676251212****",
                    "bay1628681593235****",
                    "bay1628681787548****",
                    "bay1632819585638****"
                ],
                "status": 1
            }
        ],
        "total": 301,
        "has_more": true
    },
    "t": 1641978005123,
    "success": true
}

Error code

For more information, see error code.

Prev DocModify Meeting Status

Next DocQuery Meeting Information