openapi: 3.0.0
info:
title: Webex Admin Address Book Meetings 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: Meetings
paths:
/admin/meetings/{meetingId}:
get:
responses:
'200':
description: OK
headers:
Link:
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/MeetingObjectForAdminListMeeting'
example:
id: 870f51ff287b41be84648412901e0402_20191101T120000Z
meetingSeriesId: 870f51ff287b41be84648412901e0402
meetingNumber: '123456789'
title: Example Daily Meeting
meetingType: scheduledMeeting
state: ready
hostDidJoin: true
attendeeDidJoin: true
isModified: false
timezone: UTC
start: '2019-11-01T12:00:00Z'
end: '2019-11-01T13:00:00Z'
hostUserId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jN2ZkNzNmMi05ZjFlLTQ3ZjctYWEwNS05ZWI5OGJiNjljYzY
hostDisplayName: John Andersen
hostEmail: john.andersen@example.com
siteUrl: site4-example.webex.com
enabledAutoRecordMeeting: false
allowAnyUserToBeCoHost: false
enabledJoinBeforeHost: false
enableConnectAudioBeforeHost: false
joinBeforeHostMinutes: 0
excludePassword: false
publicMeeting: false
reminderTime: 10
unlockedMeetingJoinSecurity: allowJoin
sessionTypeId: 3
enableAutomaticLock: false
automaticLockMinutes: 0
allowFirstUserToBeCoHost: false
allowAuthenticatedDevices: false
telephony:
callInNumbers:
- label: US Toll
callInNumber: '123456789'
tollType: toll
links:
- rel: globalCallinNumbers
href: /api/v1/meetings/870f51ff287b41be84648412901e0402/globalCallinNumbers
method: GET
meetingOptions:
enabledChat: true
enabledVideo: true
enabledPolling: false
enabledNote: true
noteType: allowAll
enabledFileTransfer: false
enabledUCFRichMedia: false
attendeePrivileges:
enabledShareContent: true
enabledSaveDocument: false
enabledPrintDocument: false
enabledAnnotate: false
enabledViewParticipantList: true
enabledViewThumbnails: false
enabledRemoteControl: true
enabledViewAnyDocument: false
enabledViewAnyPage: false
enabledContactOperatorPrivately: false
enabledChatHost: true
enabledChatPresenter: true
enabledChatOtherParticipants: true
integrationTags:
- dbaeceebea5c4a63ac9d5ef1edfe36b9
- 85e1d6319aa94c0583a6891280e3437d
- 27226d1311b947f3a68d6bdf8e4e19a1
scheduledType: meeting
enabledBreakoutSessions: true
links:
- rel: breakoutSessions
href: /v1/meetings/870f51ff287b41be84648412901e0402/breakoutSessions
method: GET
trackingCodes:
- name: Department
value: Engineering
- name: Division
value: Full-time
enabledAudioWatermark: true
enabledVisualWatermark: true
visualWatermarkOpacity: 10
audioConnectionOptions:
audioConnectionType: VoIP
enabledTollFreeCallIn: false
enabledGlobalCallIn: false
enabledAudienceCallBack: false
entryAndExitTone: beep
allowHostToUnmuteParticipants: false
allowAttendeeToUnmuteSelf: true
muteAttendeeUponEntry: false
enabledLiveStream: true
liveStream:
destination: Youtube
rtmpUrl: rtmps://example.com:1935/MediaLive/WebexStreaming
streamUrl: https://example.com/Webex-Streaming/index_a.m3u8
layoutWithoutSharedContent: grid
layoutWithSharedContent: stack
allowChangeLayoutInMeeting: false
followStageLayoutWhenSynced: true
resolution: 1920x1080
'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 a Meeting By an Admin
operationId: adminGetMeetingById
description: 'Retrieves details for a meeting with a specified meeting ID by an admin. The following sensitive attributes are hidden from the response: `agenda`, `hostKey`, `password`, `phoneAndVideoSystemPassword`, `panelistPassword`, `phoneAndVideoSystemPanelistPassword`, `webLink`, `sipAddress`, `dialInIpAddress`, `registration` and `telephony.accessCode`.
* If the `meetingId` value specified is for a meeting series and `current` is `true`, the operation returns details for the current scheduled meeting of the series, i.e. the scheduled meeting ready to join or start or the upcoming scheduled meeting of the meeting series.
* If the `meetingId` value specified is for a meeting series and `current` is `false` or `current` is not specified, the operation returns details for the entire meeting series.
* If the `meetingId` value specified is for a scheduled meeting from a meeting series, the operation returns details for that scheduled meeting.
* If the `meetingId` value specified is for a meeting instance which is happening or has happened, the operation returns details for that meeting instance.
* `trackingCodes` is not supported for ended meeting instances.
* To learn more about which attributes are available for different meeting states, please refer to [Available Meeting Attributes for Different Meeting States](/docs/meetings#available-meeting-attributes-for-different-meeting-states).
#### Request Header
* `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) for time stamps in response body, defined in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default value is `UTC` if not specified.'
tags:
- Meetings
parameters:
- name: meetingId
in: path
description: Unique identifier for the meeting being requested.
required: true
example: 25bbf831-5be9-4c25-b4b0-9b592c8a086b
schema:
type: string
- name: current
in: query
description: Whether or not to retrieve only the current scheduled meeting of the meeting series, i.e. the meeting ready to join or start or the upcoming meeting of the meeting series. If it's `true`, return details for the current scheduled meeting of the series, i.e. the scheduled meeting ready to join or start or the upcoming scheduled meeting of the meeting series. If it's `false` or not specified, return details for the entire meeting series. This parameter only applies to meeting series. The default value is `false`.
example: false
schema:
type: boolean
default: false
- name: timezone
in: header
description: e.g. UTC
required: false
schema:
type: string
example: UTC
/admin/meetings:
get:
responses:
'200':
description: OK
headers:
Link:
schema:
type: string
content:
application/json;charset=UTF-8:
schema:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MeetingObjectForAdminListMeeting'
description: Meetings array.
example:
items:
- id: 870f51ff287b41be84648412901e0402_20191101T120000Z
meetingSeriesId: 870f51ff287b41be84648412901e0402
meetingNumber: '123456789'
title: Example Daily Meeting
meetingType: scheduledMeeting
state: ready
hostDidJoin: true
attendeeDidJoin: true
isModified: false
timezone: UTC
start: '2019-11-01T12:00:00Z'
end: '2019-11-01T13:00:00Z'
hostUserId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jN2ZkNzNmMi05ZjFlLTQ3ZjctYWEwNS05ZWI5OGJiNjljYzY
hostDisplayName: John Andersen
hostEmail: john.andersen@example.com
siteUrl: site4-example.webex.com
enabledAutoRecordMeeting: false
allowAnyUserToBeCoHost: false
enabledJoinBeforeHost: false
enableConnectAudioBeforeHost: false
joinBeforeHostMinutes: 0
excludePassword: false
publicMeeting: false
reminderTime: 10
unlockedMeetingJoinSecurity: allowJoin
sessionTypeId: 3
enableAutomaticLock: false
automaticLockMinutes: 0
allowFirstUserToBeCoHost: false
allowAuthenticatedDevices: false
telephony:
callInNumbers:
- label: US Toll
callInNumber: '123456789'
tollType: toll
links:
- rel: globalCallinNumbers
href: /api/v1/meetings/870f51ff287b41be84648412901e0402/globalCallinNumbers
method: GET
meetingOptions:
enabledChat: true
enabledVideo: true
enabledPolling: false
enabledNote: true
noteType: allowAll
enabledFileTransfer: false
enabledUCFRichMedia: false
attendeePrivileges:
enabledShareContent: true
enabledSaveDocument: false
enabledPrintDocument: false
enabledAnnotate: false
enabledViewParticipantList: true
enabledViewThumbnails: false
enabledRemoteControl: true
enabledViewAnyDocument: false
enabledViewAnyPage: false
enabledContactOperatorPrivately: false
enabledChatHost: true
enabledChatPresenter: true
enabledChatOtherParticipants: true
integrationTags:
- dbaeceebea5c4a63ac9d5ef1edfe36b9
- 85e1d6319aa94c0583a6891280e3437d
- 27226d1311b947f3a68d6bdf8e4e19a1
scheduledType: meeting
enabledBreakoutSessions: true
links:
- rel: breakoutSessions
href: /v1/meetings/870f51ff287b41be84648412901e0402/breakoutSessions
method: GET
trackingCodes:
- name: Department
value: Engineering
- name: Division
value: Full-time
enabledAudioWatermark: true
enabledVisualWatermark: true
visualWatermarkOpacity: 10
audioConnectionOptions:
audioConnectionType: VoIP
enabledTollFreeCallIn: false
enabledGlobalCallIn: false
enabledAudienceCallBack: false
entryAndExitTone: beep
allowHostToUnmuteParticipants: false
allowAttendeeToUnmuteSelf: true
muteAttendeeUponEntry: false
enabledLiveStream: true
liveStream:
destination: Youtube
rtmpUrl: rtmps://example.com:1935/MediaLive/WebexStreaming
streamUrl: https://example.com/Webex-Streaming/index_a.m3u8
layoutWithoutSharedContent: grid
layoutWithSharedContent: stack
allowChangeLayoutInMeeting: false
followStageLayoutWhenSynced: true
resolution: 1920x1080
'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: List Meetings By an Admin
operationId: adminListMeetings
description: 'Retrieves details for meetings by an admin with a specified meeting number or web link. Please note that there are various products in the [Webex Suite](https://www.webex.com/collaboration-suite.html) such as `Meetings` and `Events`. Currently, only meetings of the `Meetings` product are supported by this API, meetings of others in the suite are not supported. Ad-hoc meetings created by [Create a Meeting](/docs/api/v1/meetings/create-a-meeting) with `adhoc` of `true` and a `roomId` will not be listed, but the ended and ongoing ad-hoc meeting instances will be listed. The following sensitive attributes are hidden from the response: `agenda`, `hostKey`, `password`, `phoneAndVideoSystemPassword`, `panelistPassword`, `phoneAndVideoSystemPanelistPassword`, `webLink`, `sipAddress`, `dialInIpAddress`, `registration` and `telephony.accessCode`.
* If `meetingNumber` is specified, the operation returns an array of meeting objects specified by the `meetingNumber`. Each object in the array can be a scheduled meeting or a meeting series depending on whether the `current` parameter is `true` or `false`, and each object contains the simultaneous interpretation object. Please note that `meetingNumber` and `webLink` are mutually exclusive and they cannot be specified simultaneously.
* If `webLink` is specified, the operation returns an array of meeting objects specified by the `webLink`. Each object in the array can be a scheduled meeting or a meeting series depending on whether the `current` parameter is `true` or `false`, and each object contains the simultaneous interpretation object. Please note that `meetingNumber` and `webLink` are mutually exclusive and they cannot be specified simultaneously.
* The `current` parameter only applies to meeting series. If it''s `false`, the `start` and `end` attributes of each returned meeting series object are for the first scheduled meeting of that series. If it''s `true` or not specified, the `start` and `end` attributes are for the scheduled meeting which is ready to start or join or the upcoming scheduled meeting of that series.
* To learn more about which attributes are available for different meeting states, please refer to [Available Meeting Attributes for Different Meeting States](/docs/meetings#available-meeting-attributes-for-different-meeting-states).
#### Request Header
* `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) for time stamps in response body, defined in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default value is `UTC` if not specified.'
tags:
- Meetings
parameters:
- name: meetingNumber
in: query
description: Meeting number for the meeting objects being requested. `meetingNumber` and `webLink` are mutually exclusive. If it's an exceptional meeting from a meeting series, the exceptional meeting instead of the primary meeting series is returned.
example: '123456789'
schema:
type: string
- name: webLink
in: query
description: URL encoded link to information page for the meeting objects being requested. `meetingNumber` and `webLink` are mutually exclusive.
example: https%3A%2F%2Fgo.webex.com%2Fgo%2Fj.php%3FMTID%3Dm066878aef4343e74c98b48439b71acfd
schema:
type: string
- name: current
in: query
description: Flag identifying to retrieve the current scheduled meeting of the meeting series or the entire meeting series. This parameter only applies to scenarios where `meetingNumber` is specified and the meeting is not an exceptional meeting from a meeting series. If it's `true`, return the scheduled meeting of the meeting series which is ready to join or start or the upcoming scheduled meeting of the meeting series; if it's `false`, return the entire meeting series. The default value is `true`.
example: false
schema:
type: boolean
default: true
- name: timezone
in: header
description: e.g. UTC
required: false
schema:
type: string
example: UTC
/meetings:
post:
responses:
'200':
description: OK
headers: {}
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/MeetingSeriesObject'
example:
id: 870f51ff287b41be84648412901e0402
meetingNumber: '123456789'
title: Example Daily Meeting
agenda: Example Agenda
password: BgJep@43
phoneAndVideoSystemPassword: '12345678'
meetingType: meetingSeries
state: active
timezone: Asia/Shanghai
start: '2019-11-01T20:00:00+08:00'
end: '2019-11-01T21:00:00+08:00'
recurrence: FREQ=DAILY;COUNT=10;INTERVAL=1
hostUserId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jN2ZkNzNmMi05ZjFlLTQ3ZjctYWEwNS05ZWI5OGJiNjljYzY
hostDisplayName: John Andersen
hostEmail: john.andersen@example.com
hostKey: '123456'
siteUrl: site4-example.webex.com
webLink: https://site4-example.webex.com/site4/j.php?MTID=md41817da6a55b0925530cb88b3577b1e
registerLink: https://cisco.webex.com/weblink/register/r55981368ee48e2a6f00b93231508c404
sipAddress: 123456789@site4-example.webex.com
dialInIpAddress: 192.168.100.100
enabledAutoRecordMeeting: false
allowAnyUserToBeCoHost: false
enabledJoinBeforeHost: false
enableConnectAudioBeforeHost: false
joinBeforeHostMinutes: 0
excludePassword: false
publicMeeting: false
reminderTime: 10
unlockedMeetingJoinSecurity: allowJoin
sessionTypeId: 3
enableAutomaticLock: false
automaticLockMinutes: 0
allowFirstUserToBeCoHost: false
allowAuthenticatedDevices: false
telephony:
accessCode: '1234567890'
callInNumbers:
- label: US Toll
callInNumber: '123456789'
tollType: toll
links:
- rel: globalCallinNumbers
href: /api/v1/meetings/870f51ff287b41be84648412901e0402/globalCallinNumbers
method: GET
meetingOptions:
enabledChat: true
enabledVideo: true
enabledPolling: false
enabledNote: true
noteType: allowAll
enabledFileTransfer: false
enabledUCFRichMedia: false
attendeePrivileges:
enabledShareContent: true
enabledSaveDocument: false
enabledPrintDocument: false
enabledAnnotate: false
enabledViewParticipantList: true
enabledViewThumbnails: false
enabledRemoteControl: true
enabledViewAnyDocument: false
enabledViewAnyPage: false
enabledContactOperatorPrivately: false
enabledChatHost: true
enabledChatPresenter: true
enabledChatOtherParticipants: true
registration:
autoAcceptRequest: false
requireFirstName: true
requireLastName: true
requireEmail: true
requireCompanyName: true
requireCountryRegion: false
requireWorkPhone: true
enabledRegistrationId: false
customizedQuestions:
- id: '3386787'
question: What color do you like?
required: true
type: checkbox
options:
- id: '1'
value: green
- id: '2'
value: black
- id: '3'
value: yellow
- id: '4'
value: red
rules:
- condition: notEquals
value: red
result: reject
matchCase: true
order: 1
- id: '3386792'
question: Project Team
required: false
type: singleLineTextBox
maxLength: 120
- id: '3386797'
question: How are you
required: false
type: multiLineTextBox
maxLength: 999
- id: '3386802'
question: Dropdownlist Q
required: false
type: dropdownList
options:
- id: '1'
value: A1
- id: '2'
value: A2
- id: '3386891'
question: weather
required: false
type: radioButtons
maxLength: 120
options:
- id: '1'
value: sunny
- id: '2'
value: rain
rules:
- question: lastName
condition: endsWith
value: tom
result: reject
matchCase: false
order: 1
integrationTags:
- dbaeceebea5c4a63ac9d5ef1edfe36b9
- 85e1d6319aa94c0583a6891280e3437d
- 27226d1311b947f3a68d6bdf8e4e19a1
scheduledType: meeting
simultaneousInterpretation:
enabled: true
interpreters:
- id: OGQ0OGRiM2U3ZTAxNDZiMGFjYzJjMzYxNDNmNGZhN2RfZTA5MTJiZDBjNWVlNDA4YjgxMTZlMjU4Zjg2NWIzZmM
languageCode1: en
languageCode2: de
email: marcus.hoffmann@example.com
displayName: Hoffmann
- id: 3GQ0OGRiM2U3ZTAxNDZiMGFjYzJjMzYxNDNmNGZhN2RfZTA5MAJiZDBjNWVlNDC4YjgxMTZlMjU4Zjg2NWIzZmM
languageCode1: en
languageCode2: fr
email: antoine.martin@example.com
displayName: Martin
enabledBreakoutSessions: true
links:
- rel: breakoutSessions
href: /v1/meetings/870f51ff287b41be84648412901e0402/breakoutSessions
method: GET
trackingCodes:
- name: Department
value: Engineering
- name: Division
value: Full-time
enabledAudioWatermark: true
enabledVisualWatermark: true
visualWatermarkOpacity: 10
audioConnectionOptions:
audioConnectionType: VoIP
enabledTollFreeCallIn: false
enabledGlobalCallIn: false
enabledAudienceCallBack: false
entryAndExitTone: beep
allowHostToUnmuteParticipants: false
allowAttendeeToUnmuteSelf: true
muteAttendeeUponEntry: false
enabledLiveStream: true
liveStream:
destination: Youtube
rtmpUrl: rtmps://example.com:1935/MediaLive/WebexStreaming
streamUrl: https://example.com/Webex-Streaming/index_a.m3u8
layoutWithoutSharedContent: grid
layoutWithSharedContent: stack
allowChangeLayoutInMeeting: false
followStageLayoutWhenSynced: true
resolution: 1920x1080
'400':
description: Bad Request
headers: {}
content:
application/json;charset=UTF-8:
schema:
type: object
properties:
message:
type: string
errors:
type: array
items:
type: object
properties:
description:
type: string
trackingId:
type: string
example:
message: The input parameters contain invalid items.
errors:
- description: Meeting password validation failed. A mix of uppercase and lowercase letters (A, a, B, b, C, c, etc.) is required.
trackingId: 19085D1FCFEE445DA358375500D25E44_1598154356721
'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.'
# --- truncated at 32 KB (580 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/webex/refs/heads/main/openapi/webex-meetings-api-openapi.yml