openapi: 3.0.0
info:
title: Webex Admin Address Book Meeting Qualities API
version: 1.0.0
description: The Webex Admin APIs provide comprehensive programmatic access to administrative functions for managing Webex organizations, users, licenses, and settings. These APIs enable automation of user provisioning, license assignment, compliance management, and audit event retrieval. Administrators can integrate with enterprise identity systems, enforce security policies, monitor usage, and streamline onboarding/offboarding processes. The APIs support granular control over organizational resources, making them ideal for large-scale deployments and custom admin tooling.
tags:
- name: Meeting Qualities
paths:
/meeting/qualities:
get:
responses:
'200':
description: OK
headers:
Link:
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/MeetingQualitiesResponse'
example:
items:
- meetingInstanceId: e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470
webexUserName: John Andersen
webexUserEmail: john.andersen@example.com
joinTime: '2020-04-10T17:00:00.000Z'
leaveTime: '2020-04-10T17:02:00.000Z'
joinMeetingTime: '5.793'
clientType: Teams_Mobile_Client (iOS)
clientVersion: 40.5.0.210
osType: mac
osVersion: Version 10.14.6 (Build 18G3020)
hardwareType: mac book
speakerName: MacBook Pro Speakers
networkType: wifi
localIP: 10.24.72.54
publicIP: 10.24.72.54
maskedLocalIP: 10.24.72.54
maskedPublicIP: 10.24.72.54
camera: FaceTime HD Camera
microphone: External Microphone
serverRegion: San Jose, USA
videoMeshCluster: Mesh Cluster One
videoMeshServer: server.example.com
participantId: 8635cbf0ca1a4573b27348e560679b25_I_158174534545967299_57
participantSessionId: 3324C9D0-9EA7-45A2-B249-5B62A384AFEF
videoIn:
- samplingInterval: 60
startTime: '2020-04-10T17:00:00.000Z'
endTime: '2020-04-10T18:00:00.000Z'
packetLoss: []
latency: []
resolutionHeight: []
frameRate:
- 25.940001
mediaBitRate: []
codec: H.264 BP
jitter:
- 170
transportType: UDP
videoOut:
- samplingInterval: 60
startTime: '2020-04-10T17:00:00.000Z'
endTime: '2020-04-10T18:00:00.000Z'
packetLoss: []
latency: []
resolutionHeight: []
frameRate:
- 25.940001
mediaBitRate: []
codec: H.264 BP
jitter: []
transportType: UDP
audioIn:
- samplingInterval: 60
startTime: '2020-04-10T17:00:00.000Z'
endTime: '2020-04-10T18:00:00.000Z'
packetLoss: []
latency: []
resolutionHeight: []
frameRate:
- 25.940001
mediaBitRate: []
codec: Opus
jitter: []
transportType: UDP
audioOut:
- samplingInterval: 60
startTime: '2020-04-10T17:00:00.000Z'
endTime: '2020-04-10T18:00:00.000Z'
packetLoss: []
latency: []
resolutionHeight: []
frameRate:
- 25.940001
mediaBitRate: []
codec: Opus
jitter: []
transportType: UDP
shareIn:
- samplingInterval: 60
startTime: '2020-04-10T17:00:00.000Z'
endTime: '2020-04-10T18:00:00.000Z'
packetLoss: []
latency: []
resolutionHeight: []
frameRate:
- 25.940001
mediaBitRate: []
codec: H.264 BP
jitter: []
transportType: UDP
shareOut:
- samplingInterval: 60
startTime: '2020-04-10T17:00:00.000Z'
endTime: '2020-04-10T18:00:00.000Z'
packetLoss: []
latency: []
resolutionHeight: []
frameRate:
- 25.940001
mediaBitRate: []
codec: H.264 BP
jitter: []
transportType: UDP
resources:
- processAverageCPU: []
processMaxCPU: []
systemAverageCPU: []
systemMaxCPU: []
'400':
description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
'401':
description: 'Unauthorized: Authentication credentials were missing or incorrect.'
'403':
description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
'404':
description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.'
'405':
description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
'409':
description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.'
'410':
description: 'Gone: The requested resource is no longer available.'
'415':
description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.'
'423':
description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.'
'428':
description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
'429':
description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.'
'500':
description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
'502':
description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
'503':
description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
'504':
description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
summary: Get Meeting Qualities
operationId: getMeetingQualities
description: Get quality data for a meeting, by `meetingId`. Only organization administrators can retrieve meeting quality data.
tags:
- Meeting Qualities
parameters:
- name: meetingId
in: query
description: Unique identifier for the specific meeting instance. **Note:** The `meetingId` can be obtained via the Meeting List API when meetingType=meeting. The `id` attribute in the Meeting List Response is what is needed, for example, `e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470`.
required: true
example: e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470
schema:
type: string
- name: max
in: query
description: Limit the maximum number of media sessions in the response.
example: 100
schema:
type: number
default: 100
- name: offset
in: query
description: Offset from the first result that you want to fetch.
example: 0
schema:
type: number
components:
schemas:
AudioIn:
type: object
properties:
samplingInterval:
type: number
example: 60
description: The sampling interval, in seconds, of the downstream audio quality data.
startTime:
type: string
example: '2020-04-10T17:00:00.000Z'
description: The date and time when this audio session started.
endTime:
type: string
example: '2020-04-10T18:00:00.000Z'
description: The date and time when this audio session ended.
packetLoss:
type: array
items:
type: number
description: The percentage of audio packet loss, as a float between 0.0 and 100.0, during each sampling interval.
latency:
type: array
items:
type: number
description: The average latency, in milliseconds, during each sampling interval.
resolutionHeight:
type: array
items:
type: number
description: Not applicable to audio.
frameRate:
type: array
items:
type: number
example: 25.940001
description: Not applicable to audio.
mediaBitRate:
type: array
items:
type: number
description: The bitrate of the incoming audio.
codec:
type: string
example: Opus
description: The codec of the incoming audio.
jitter:
type: array
items:
type: number
description: The incoming audio jitter.
transportType:
type: string
enum:
- UDP
- TCP
description: The network protocol used for video transmission.
MediaSessionQuality:
type: object
required:
- meetingInstanceId
properties:
meetingInstanceId:
type: string
example: e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470
description: The meeting identifier for the specific meeting instance.
webexUserName:
type: string
example: John Andersen
description: The display name of the participant of this media session.
webexUserEmail:
type: string
example: john.andersen@example.com
description: The email address of the participant of this media session.
joinTime:
type: string
example: '2020-04-10T17:00:00.000Z'
description: The date and time when this participant joined the meeting.
leaveTime:
type: string
example: '2020-04-10T17:02:00.000Z'
description: The date and time when this participant left the meeting.
joinMeetingTime:
type: string
example: '5.793'
description: 'The join meeting time of the participant. '
clientType:
type: string
example: Teams_Mobile_Client (iOS)
description: The type of the client (and OS) used by this media session.
clientVersion:
type: string
example: 40.5.0.210
description: The version of the client used by this media session.
osType:
type: string
example: mac
description: The operating system used for the client.
osVersion:
type: string
example: Version 10.14.6 (Build 18G3020)
description: The version of the operating system used for the client.
hardwareType:
type: string
example: mac book
description: The type of hardware used to attend the meeting
speakerName:
type: string
example: MacBook Pro Speakers
description: A description of the speaker used in the meeting.
networkType:
type: string
enum:
- wifi
- cellular
- ethernet
- unknown
description: The type of network.
localIP:
type: string
example: 10.24.72.54
description: The local IP address of the client.
publicIP:
type: string
example: 10.24.72.54
description: The public IP address of the client.
maskedLocalIP:
type: string
example: 10.24.72.54
description: The masked local IP address of the client.
maskedPublicIP:
type: string
example: 10.24.72.54
description: The masked public IP address of the client.
camera:
type: string
example: FaceTime HD Camera
description: A description of the camera used in the meeting.
microphone:
type: string
example: External Microphone
description: A description of the microphone used in the meeting.
serverRegion:
type: string
example: San Jose, USA
description: The server region.
videoMeshCluster:
type: string
example: Mesh Cluster One
description: The video mesh cluster name.
videoMeshServer:
type: string
example: server.example.com
description: The video mesh server name.
participantId:
type: string
example: 8635cbf0ca1a4573b27348e560679b25_I_158174534545967299_57
description: Identifies the participant.
participantSessionId:
type: string
example: 3324C9D0-9EA7-45A2-B249-5B62A384AFEF
description: Identifies a specific session the participant has in a given meeting.
videoIn:
type: array
items:
$ref: '#/components/schemas/VideoIn'
description: The collection of downstream (sent to the client) video quality data.
videoOut:
type: array
items:
$ref: '#/components/schemas/VideoOut'
description: The collection of upstream (sent from the client) video quality data.
audioIn:
type: array
items:
$ref: '#/components/schemas/AudioIn'
description: The collection of downstream (sent to the client) audio quality data.
audioOut:
type: array
items:
$ref: '#/components/schemas/AudioOut'
description: The collection of upstream (sent from the client) audio quality data.
shareIn:
type: array
items:
$ref: '#/components/schemas/ShareIn'
description: The collection of downstream (sent to the client) share quality data.
shareOut:
type: array
items:
$ref: '#/components/schemas/ShareOut'
description: The collection of upstream (sent from the client) share quality data.
resources:
type: array
items:
$ref: '#/components/schemas/Resources'
description: Device resources such as CPU and memory.
MeetingQualitiesResponse:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MediaSessionQuality'
VideoOut:
type: object
properties:
samplingInterval:
type: number
example: 60
description: The sampling interval, in seconds, of the upstream video quality data.
startTime:
type: string
example: '2020-04-10T17:00:00.000Z'
description: The date and time when this video session started.
endTime:
type: string
example: '2020-04-10T18:00:00.000Z'
description: The date and time when this video session ended.
packetLoss:
type: array
items:
type: number
description: The percentage of video packet loss, in float between 0.0 and 100.0, during each sampling interval.
latency:
type: array
items:
type: number
description: The average latency, in milliseconds, during each sampling interval.
resolutionHeight:
type: array
items:
type: number
description: The pixel height of the outgoing video.
frameRate:
type: array
items:
type: number
example: 25.940001
description: The frames per second of the outgoing video.
mediaBitRate:
type: array
items:
type: number
description: The bit rate of the outgoing video.
codec:
type: string
example: H.264 BP
description: The outgoing video codec.
jitter:
type: array
items:
type: number
description: The outgoing video jitter.
transportType:
type: string
enum:
- UDP
- TCP
description: The network protocol used for video transmission.
ShareOut:
type: object
properties:
samplingInterval:
type: number
example: 60
description: The sampling interval, in seconds, of the upstream content sharing data.
startTime:
type: string
example: '2020-04-10T17:00:00.000Z'
description: The date and time when this content sharing session started.
endTime:
type: string
example: '2020-04-10T18:00:00.000Z'
description: The date and time when this content sharing session ended.
packetLoss:
type: array
items:
type: number
description: The percentage of content sharing packet loss, in float between 0.0 and 100.0, during each sampling interval.
latency:
type: array
items:
type: number
description: The average latency, in milliseconds, during each sampling interval.
resolutionHeight:
type: array
items:
type: number
description: The height in pixels of the outgoing share video.
frameRate:
type: array
items:
type: number
example: 25.940001
description: The frame rate of the outgoing share video.
mediaBitRate:
type: array
items:
type: number
description: The bit rate of the outgoing share video.
codec:
type: string
example: H.264 BP
description: The codec of the outgoing share video.
jitter:
type: array
items:
type: number
description: The jitter for the outgoing share video.
transportType:
type: string
enum:
- UDP
- TCP
description: The network protocol used for video transmission.
ShareIn:
type: object
properties:
samplingInterval:
type: number
example: 60
description: The sampling interval, in seconds, of the downstream content sharing data.
startTime:
type: string
example: '2020-04-10T17:00:00.000Z'
description: The date and time when this content sharing session started.
endTime:
type: string
example: '2020-04-10T18:00:00.000Z'
description: The date and time when this content sharing session ended.
packetLoss:
type: array
items:
type: number
description: The percentage of content sharing packet loss, as a float between 0.0 and 100.0, during each sampling interval.
latency:
type: array
items:
type: number
description: The average latency, in milliseconds, during each sampling interval.
resolutionHeight:
type: array
items:
type: number
description: The height in pixels of the incoming share video.
frameRate:
type: array
items:
type: number
example: 25.940001
description: The frame rate of the incoming share video.
mediaBitRate:
type: array
items:
type: number
description: The bit rate for the incoming share video.
codec:
type: string
example: H.264 BP
description: The codec for the incoming share video.
jitter:
type: array
items:
type: number
description: The jitter for the incoming share video.
transportType:
type: string
enum:
- UDP
- TCP
description: The network protocol used for video transmission.
Resources:
type: object
properties:
processAverageCPU:
type: array
items:
type: number
description: The average percent CPU for the process.
processMaxCPU:
type: array
items:
type: number
description: The max percent CPU for the process.
systemAverageCPU:
type: array
items:
type: number
description: The average percent CPU for the system.
systemMaxCPU:
type: array
items:
type: number
description: The max percent CPU for the system.
VideoIn:
type: object
properties:
samplingInterval:
type: number
example: 60
description: The sampling interval, in seconds, of the downstream video quality data.
startTime:
type: string
example: '2020-04-10T17:00:00.000Z'
description: The date and time when this video session started.
endTime:
type: string
example: '2020-04-10T18:00:00.000Z'
description: The date and time when this video session ended.
packetLoss:
type: array
items:
type: number
description: The percentage of video packet loss, as a float between 0.0 and 100.0, during each sampling interval.
latency:
type: array
items:
type: number
description: The average latency, in milliseconds, during each sampling interval.
resolutionHeight:
type: array
items:
type: number
description: The pixel height of the incoming video.
frameRate:
type: array
items:
type: number
example: 25.940001
description: The frames per second of the incoming video.
mediaBitRate:
type: array
items:
type: number
description: The bit rate of the incoming video.
codec:
type: string
example: H.264 BP
description: The incoming video codec.
jitter:
type: array
items:
type: number
example: 170
description: The incoming video jitter.
transportType:
type: string
enum:
- UDP
- TCP
description: The network protocol used for video transmission.
AudioOut:
type: object
properties:
samplingInterval:
type: number
example: 60
description: The sampling interval, in seconds, of the upstream audio quality data.
startTime:
type: string
example: '2020-04-10T17:00:00.000Z'
description: The date and time when this audio session started.
endTime:
type: string
example: '2020-04-10T18:00:00.000Z'
description: The date and time when this audio session ended.
packetLoss:
type: array
items:
type: number
description: The percentage of audio packet loss, as a float between 0.0 and 100.0, during each sampling interval.
latency:
type: array
items:
type: number
description: The average latency, in milliseconds, during each sampling interval.
resolutionHeight:
type: array
items:
type: number
description: Not applicable to audio out.
frameRate:
type: array
items:
type: number
example: 25.940001
description: Not applicable to audio out.
mediaBitRate:
type: array
items:
type: number
description: The bit rate of the outgoing audio.
codec:
type: string
example: Opus
description: The audio codec.
jitter:
type: array
items:
type: number
description: The outgoing audio jitter.
transportType:
type: string
enum:
- UDP
- TCP
description: The network protocol used for video transmission.
securitySchemes:
oauth2:
flows:
authorizationCode:
authorizationUrl: /
scopes: {}
tokenUrl: /
type: oauth2
bearer-key:
type: http
description: e.g. Bearer YOUR_AUTHORIZATION_TOKEN
scheme: bearer
bearerFormat: JWT
bearerAuth:
type: oauth2
description: OAuth 2.0 Bearer token authentication
flows:
authorizationCode:
authorizationUrl: https://webexapis.com/v1/authorize
tokenUrl: https://webexapis.com/v1/access_token
scopes:
spark:applications_token: Create access tokens for Service Apps