Query Meeting Information

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

Query the information of a specified meeting within a specified time period based on the participant ID.

API address

GET: /v2.0/iot-03/meeting-reservations/participants/{participant_id}

Request parameter

Parameter name	Type	IN	Required	Description
participant_id	String	uri	true	The ID of a specified participant in the meeting.
req	MeetingByParticipantPageQueryReq	query	true	The request of querying the meeting information.

Description of req

Parameter name	Type	Required	Description
start_time	Long	true	The 13-digit timestamp of the start time.
end_time	Long	true	The 13-digit timestamp of the end time.
page_no	Integer	false	The current page number.
page_size	Integer	false	The number of items returned on each page.
status	String	false	The reservation status. Valid values: `1`: normal. `2`: to be approved. `3`: canceled. `4`: rejected.
is_creator	Boolean	false	Indicates whether the user is the meeting creator.
meeting_status	Integer	false	Indicates the status of a specified meeting. Valid values: `1`: The meeting is not finished. `2`: The meeting is finished.

Return parameter

Parameter name	Type	Description
result	Page	The returned result.

Description of result

Parameter name	Type	Description
total	Long	The total entries of meeting reservations that meet the criteria.
list	List	The list of meeting reservations.
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	The status of a specified meeting.
room_id	String	The ID of a specified meeting room.
participants	List	The IDs of participants in the meeting.
cc_participants	List	The IDs of persons who are mentioned in the carbon copy.
notice	Boolean	Indicates whether to send push notifications.
notice_time	Long	The period for a push notification to be sent in advance of a meeting. Unit: seconds.
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 13-digit timestamp of the creation time.
gmt_modified	Long	The 13-digit timestamp of the modification time.
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/participants/3****?start_time=1624600000000&end_time=1625802212181

Return example

{
    "result": {
        "list": [
            {
                "gmt_create": 1624803780908,
                "room_id": "",
                "cc_participants": [
                    "123****",
                    "32****"
                ],
                "creator": "chin****",
                "modifier": "01bin****",
                "end_time": 1624806812181,
                "description": "Modify meeting test added by chenbin 01.",
                "gmt_modified": 1624803904817,
                "reservation_id": "140915530793380****",
                "start_time": 1624802212181,
                "attachmens": [
                    {
                        "type": "jpg",
                        "url": "https://**.com/c.jpg",
                        "size": "332.1kb",
                        "name": "c.jpg"
                    }
                ],
                "notice_time": 1000,
                "topic": "modify_chenbin_meeting",
                "notice": true,
                "participants": [
                    "123****",
                    "aas****"
                ],
                "status": 1
            }
        ],
        "total": 1,
        "has_more": false
    },
    "t": 1625038656539,
    "success": true
}

Error code

For more information, see error code.

Prev DocQuery Meeting List

Next DocPreempt Meeting Room