Help Center/ Meeting/ Server API Reference/ Meeting Management/ APIs/ Querying Participant Records of a Historical Meeting
Updated on 2023-12-22 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Participant Records of a Historical Meeting

Description

This API is used to query participant records of a historical meeting.

Debugging

You can debug this API in API Explorer.

Prototype

Table 1 Prototype

Request Method

GET

Request Address

/v1/mmc/management/conferences/history/confAttendeeRecord

Transport Protocol

HTTPS

Request Parameters

Table 2 Parameters

Parameter

Mandatory

Type

Location

Description

confUUID

Yes

String

Query

Meeting UUID.

offset

No

Integer

Query

Query offset. Default value: 0.

limit

No

Integer

Query

Number of records to query. The default value is 20 and the maximum value is 500.

searchKey

No

String

Query

Query condition.

userUUID

No

String

Query

UUID of a user.

NOTE:

This parameter will be discarded. Do not use it.

X-Access-Token

Yes

String

Header

Authorization token. Use the value of accessToken in the response to the request for Authenticating an App ID.

X-Authorization-Type

No

String

Header

Whether the request is sent from a third-party portal.

NOTE:

This parameter will be discarded. Do not use it.

X-Site-Id

No

String

Header

ID of the HCS Online site where the authentication is performed.

NOTE:

This parameter will be discarded. Do not use it.

Accept-Language

No

String

Header

Language. Default value: zh-CN.

  • zh-CN: simplified Chinese.
  • en-US: English (U.S.).

Status Codes

Table 3 Status codes

HTTP Status Code

Description

200

Operation successful.

400

Invalid parameters.

401

Authentication is not performed or fails.

403

Insufficient permissions.

500

Server exception.

Response Parameters

Table 4 Response parameters

Parameter

Type

Description

offset

Integer

Query offset.

limit

Integer

Number of records on each page.

count

Integer

Total number of records.

data

Array of data objects

Participant list.
Table 5 Data structure of data

Parameter

Type

Description

displayName

String

Participant name.

callNumber

String

Phone number of the participant.

deviceType

String

Device type.

joinTime

long

UTC time when the participant joined the meeting, in milliseconds.

leftTime

long

UTC time when the participant left the meeting, in milliseconds.

mediaType

String

Media type.

deptName

String

Department name.

Example Request

GET /v1/mmc/management/conferences/history/confAttendeeRecord?confUUID=9a0fa6d10a5b11eaae5e191763c22c0e
Connection: keep-alive
X-Access-Token: stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC
user-agent: WeLink-desktop
Host: api.meeting.huaweicloud.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

Example Response

HTTP/1.1 200 
Date: Wed, 18 Dec 2019 06:20:40 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 337
Connection: keep-alive
Expires: 0
Pragma: No-cache
Cache-Control: no-cache
http_proxy_id: 2f3aa1fe64f6784b1eb6f75a67ef2b9d
Server: api-gateway
X-Request-Id: ba03d2ae3b805d8c545c83494c862b48

{
    "data": [
        {
            "displayName": "user8002",
            "callNumber": "+991116004380",
            "deviceType": "Soft client",
            "joinTime": 1574119917872,
            "leftTime": 1574119956881,
            "mediaType": "Video",
            "deptName": "wangyue"
        },
        {
            "displayName": "+991116005905",
            "callNumber": "+991116005905",
            "deviceType": "Soft client",
            "joinTime": 1574119935467,
            "leftTime": 1574119947620,
            "mediaType": "Video",
            "deptName": "wangyue"
        }
    ],
    "offset": 0,
    "limit": 20,
    "count": 2
}

Error Codes

If an error code starting with MMC or USG is returned when you use this API, rectify the fault by following the instructions provided in Huawei Cloud API Error Center.

Example cURL Command

curl -k -i -X GET -H 'X-Access-Token:stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC' 'https://api.meeting.huaweicloud.com/v1/mmc/management/conferences/history/confAttendeeRecord?confUUID=9a0fa6d10a5b11eaae5e191763c22c0e'
Parent topic: APIs