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 nameTypeINRequiredDescription
participant_idStringuritrueThe ID of a specified participant in the meeting.
reqMeetingByParticipantPageQueryReqquerytrueThe request of querying the meeting information.

Description of req

Parameter nameTypeINRequiredDescription
start_timeLong trueThe 13-digit timestamp of the start time.
end_timeLong trueThe 13-digit timestamp of the end time.
page_noInteger falseThe current page number.
page_sizeInteger falseThe number of items returned on each page.
statusString falseThe reservation status. Valid values:
  • 1: normal.
  • 2: to be approved.
  • 3: canceled.
  • 4: rejected.
is_creatorBoolean falseIndicates whether the user is the meeting creator.
meeting_statusInteger falseIndicates the status of a specified meeting. Valid values:
  • 1: The meeting is not finished.
  • 2: The meeting is finished.

Return parameter

Parameter nameTypeDescription
resultPageThe returned result.

Description of result

Parameter nameTypeDescription
totalLongThe total entries of meeting reservations that meet the criteria.
listListThe list of meeting reservations.
has_moreBooleanSpecifies whether to return the next page.

Description of list

Parameter nameTypeDescription
reservation_idStringThe reservation ID.
topicStringThe theme of a specified meeting.
start_timeLongThe start time of a specified meeting.
end_timeLongThe end time of a specified meeting.
statusIntegerThe status of a specified meeting.
room_idStringThe ID of a specified meeting room.
participantsListThe IDs of participants in the meeting.
cc_participantsListThe IDs of persons who are mentioned in the carbon copy.
noticeBooleanIndicates whether to send push notifications.
notice_timeLongThe period for a push notification to be sent in advance of a meeting. Unit: seconds.
descriptionStringThe description of a specified meeting.
creatorStringThe ID of the user who creates the meeting.
modifierStringThe ID of the user who modifies the meeting.
gmt_createLongThe 13-digit timestamp of the creation time.
gmt_modifiedLongThe 13-digit timestamp of the modification time.
attachmentsListThe information about a specified attachment.

Description of attachments

Parameter nameTypeDescription
nameStringThe name of a specified attachment.
urlStringThe URL of a specified attachment.
sizeStringThe size of a specified attachment.
typeStringThe 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.