# Get participant meeting quality data
Get participant meeting quality data.(Only supports ended meetings) For specific permission requirements, please refer to "Resource introduction".
## Request
Facts |
---|---
HTTP URL | https://open.feishu.cn/open-apis/vc/v1/participant_quality_list
HTTP Method | GET
Rate Limit | [100 per minute](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
Supported app types | Custom App、Store App
Required scopes
**To use this API, you must have at least 1 of the listed scopes.** | Obtain video conference meeting room information(vc:room:readonly)
Required field scopes | **Notice**：The response body of the API contains the following sensitive fields, and they will be returned only after corresponding scopes are added. If you do not need the fields, it is not recommended that you request the scopes.
Obtain user ID(contact:user.employee_id:readonly)
### Request header
Parameter | Type | Required | Description
---|---|---|---
Authorization | string | Yes | `tenant_access_token`
or
`user_access_token`
**Value format**: "Bearer `access_token`"
**Example value**: "Bearer u-7f1bcd13fc57d46bac21793a18e560"
[How to choose and get access token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use)
### Query parameters
Parameter | Type | Required | Description
---|---|---|---
meeting_start_time | string | Yes | Meeting start time(need to be accurate to the minute,unix time,unit second)
**Example value**: 1655276858
meeting_end_time | string | Yes | Meeting end time
**Example value**: 1655276858
meeting_no | string | Yes | Meeting number
**Example value**: 123456789
join_time | string | Yes | Time of joining the meeting.It can be obtained from the results returned by "Participant Details".
**Example value**: 1655276858
user_id | string | No | User ID.Fill in when the participant is a Lark user, and room_id and user_id must be filled in only one.
**Example value**: ou_3ec3f6a28a0d08c45d895276e8e5e19b
room_id | string | No | Room ID.Fill in when the participant is a Room, and room_id and user_id must be filled in only one
**Example value**: omm_eada1d61a550955240c28757e7dec3af
page_size | int | No | **Example value**: 20
**Default value**: `20`
**Data validation rules**:
- Value range: `20` ～ `100`
page_token | string | No | Page identifier. It is not filled in the first request, indicating traversal from the beginning; when there will be more groups, the new page_token will be returned at the same time, and the next traversal can use the page_token to get more groups
**Example value**: 20
user_id_type | string | No | User ID categories
**Example value**: open_id
**Optional values are**:
- open_id：Identifies a user to an app. The same user has different Open IDs in different apps. [How to get Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)
- union_id：Identifies a user to a tenant that acts as a developer. A user has the same Union ID in apps developed by the same developer, and has different Union IDs in apps developed by different developers. A developer can use Union ID to link the same user's identities in multiple apps.[How to get Union ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-union-id)
- user_id：Identifies a user to a tenant. The same user has different User IDs in different tenants. In one single tenant, a user has the same User ID in all apps （including store apps）. User ID is usually used to communicate user data between different apps. [How to get User ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-user-id)
**Default value**: `open_id`
**When the value is `user_id`, the following field scopes are required**:
Obtain user ID(contact:user.employee_id:readonly)
## Response
### Response body
Parameter | Type | Description
---|---|---
code | int | Error codes, fail if not zero
msg | string | Error descriptions
data | \- | \-
participant_quality_list | participant_quality\[\] | Participant quality list
network | quality_network | Network
time | string | Time
network_delay | string | Network delay
bitrate_received | string | Bit rate (reception)
packet_loss_avg_received | string | Packet Loss - Average (Received)
packet_loss_max_received | string | Packet loss - max (received)
bitrate_sent | string | Bit rate (send)
packet_loss_avg_sent | string | Packet loss - average (sent)
packet_loss_max_sent | string | Packet loss - max (send)
audio | quality_audio | Audio
time | string | Time
mic_input_volume | string | Microphone capture volume
speaker_volume | string | Speaker playback volume
bitrate_received | string | Bit rate (reception)
latency_received | string | Delay (reception)
jitter_received | string | Dithering (receiving)
bitrate_sent | string | Bit rate (send)
latency_sent | string | Delayed (send)
jitter_sent | string | Dithering (send)
video | quality_video_sharing | Video
time | string | Time
bitrate_received | string | Bit rate (reception)
latency_received | string | Delay (reception)
jitter_received | string | Dithering (receiving)
maximum_resolution_received | string | Maximum resolution (reception)
framerate_received | string | Frame rate (receive)
bitrate_sent | string | Bit rate (send)
latency_sent | string | Delayed (send)
jitter_sent | string | Dithering (send)
maximum_resolution_sent | string | Maximum resolution (send)
framerate_sent | string | Frame rate (send)
screen_sharing | quality_video_sharing | Share screen
time | string | Time
bitrate_received | string | Bit rate (reception)
latency_received | string | Delay (reception)
jitter_received | string | Dithering (receiving)
maximum_resolution_received | string | Maximum resolution (reception)
framerate_received | string | Frame rate (receive)
bitrate_sent | string | Bit rate (send)
latency_sent | string | Delayed (send)
jitter_sent | string | Dithering (send)
maximum_resolution_sent | string | Maximum resolution (send)
framerate_sent | string | Frame rate (send)
cpu_usage | quality_cpu_usage | CPU usage
time | string | Time
client_avg_cpu_usage | string | Average CPU usage on the client side
client_max_cpu_usage | string | Maximum CPU usage on client side
system_avg_cpu_usage | string | Average CPU usage of the system
system_max_cpu_usage | string | System maximum CPU usage
page_token | string | Page identifier, when has_more is true, a new page_token will also be returned. Otherwise, page_token will not be returned
has_more | boolean | Whether the response body has more parameters
### Response body example
```json
{
"code": 0,
"msg": "success",
"data": {
"participant_quality_list": [
{
"network": {
"time": "2022.12.23 11:16:00 (GMT+08:00)",
"network_delay": "100ms",
"bitrate_received": "8kbps",
"packet_loss_avg_received": "8%",
"packet_loss_max_received": "9%",
"bitrate_sent": "9kbps",
"packet_loss_avg_sent": "8%",
"packet_loss_max_sent": "10%"
},
"audio": {
"time": "2022.12.23 11:16:00 (GMT+08:00)",
"mic_input_volume": "6dB",
"speaker_volume": "8dB",
"bitrate_received": "3kbps",
"latency_received": "100ms",
"jitter_received": "100ms",
"bitrate_sent": "9kbps",
"latency_sent": "100ms",
"jitter_sent": "100ms"
},
"video": {
"time": "2022.12.23 11:16:00 (GMT+08:00)",
"bitrate_received": "8kbps",
"latency_received": "100ms",
"jitter_received": "100ms",
"maximum_resolution_received": "1080P",
"framerate_received": "100fps",
"bitrate_sent": "9kbps",
"latency_sent": "100ms",
"jitter_sent": "100ms",
"maximum_resolution_sent": "4K",
"framerate_sent": "90fps"
},
"screen_sharing": {
"time": "2022.12.23 11:16:00 (GMT+08:00)",
"bitrate_received": "8kbps",
"latency_received": "100ms",
"jitter_received": "100ms",
"maximum_resolution_received": "1080P",
"framerate_received": "100fps",
"bitrate_sent": "9kbps",
"latency_sent": "100ms",
"jitter_sent": "100ms",
"maximum_resolution_sent": "4K",
"framerate_sent": "90fps"
},
"cpu_usage": {
"time": "2022.12.23 11:17:00",
"client_avg_cpu_usage": "0.8%",
"client_max_cpu_usage": "2.3%",
"system_avg_cpu_usage": "8.3%",
"system_max_cpu_usage": "30%"
}
}
],
"page_token": "20",
"has_more": true
}
}
```
### Error code
HTTP status code | Error code | Description | Troubleshooting suggestions
---|---|---|---
500 | 121001 | internal error | Internal server error. If retry still doesn't work, contact the administrator.
400 | 121002 | not support | This function is not supported.
400 | 121003 | param error | Parameter error. Check the value range of parameters (please check yourself according to the field description above).
400 | 126003 | meeting number invalid (cannot smaller than 0) | Invalid meeting number (cannot be less than 0)
400 | 126004 | meeting number length not correct (supposed to be 9) | The meeting number should be 9 digits
400 | 126005 | start time error (cannot larger than now or smaller than 0) | The start time cannot be greater than the current time or less than 0
400 | 126006 | end time cannot exceed start time for one day or smaller than start time | The end time cannot exceed the start time by one day or be less than the start time
400 | 126007 | userID and roomID cannot be set concurrently | Do not set userID and roomID at the same time
400 | 126009 | cannot find meeting according to the params you provide | Recheck the param information
400 | 126010 | cannot find device according to the params you provide | Device information could not be obtained according to the provided parameters
404 | 121004 | data not exist | The requested data doesn't exist.
403 | 121005 | no permission | No permission. Check the token type, operator identity and resource.