Get a Meeting
Retrieves details for a meeting with a specified meeting ID.
If the
meetingIdvalue specified is for a meeting series andcurrentistrue, 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
meetingIdvalue specified is for a meeting series andcurrentisfalseorcurrentis not specified, the operation returns details for the entire meeting series.If the
meetingIdvalue specified is for a scheduled meeting from a meeting series, the operation returns details for that scheduled meeting.If the
meetingIdvalue specified is for a meeting instance which is happening or has happened, the operation returns details for that meeting instance.
Request Header
password: Meeting password. It's required when the meeting is protected by a password and the current user is not privileged to view it if they are not a host, cohost or invitee of the meeting.timezone: Time zone for time stamps in response body, defined in conformance with the IANA time zone database. The default value isUTCif not specified.
URI Parameters
Unique identifier for the meeting being requested.
Query Parameters
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.
Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin-level scopes. If set, the admin may specify the email of a user in a site they manage and the API will return details for a meeting that is hosted by that user.
Response Properties
Unique identifier for meeting. If it's a meeting series, the id is used to identify the entire series; if it's a scheduled meeting from a series, the id is used to identify that scheduled meeting; if it's a meeting instance that is happening or has happened, the id is used to identify that instance.
Meeting number. This attribute applies to meeting series, scheduled meeting and meeting instance, but it does not apply to meeting instances which have ended.
Meeting title. This attribute can be modified for meeting series or scheduled meeting by Update a Meeting API.
Meeting agenda. The agenda can be a maximum of 1300 characters long. This attribute can be modified for meeting series or scheduled meeting by Update a Meeting API.
Meeting password. This attribute applies to meeting series, scheduled meeting and in-progress meeting instance, but it does not apply to meeting instances which have ended. It can be modified for meeting series or scheduled meeting by Update a Meeting API.
8-digit numeric password to join meeting from audio and video devices. This attribute applies to meeting series, scheduled meeting and in-progress meeting instance, but it does not apply to meeting instances which have ended.
Meeting type.
Master of a scheduled series of meetings which consists of one or more scheduled meeting based on a recurrence rule.
Instance from a master meeting series.
meeting instance that is actually happening or has happened.
Meeting state.
This state only applies to meeting series. It indicates that one or more future scheduled meeting exist for this meeting series.
This state only applies to scheduled meeting. It indicates that the meeting is scheduled in the future.
This state only applies to scheduled meeting. It indicates that this scheduled meeting is ready to start or join now.
This state only applies to meeting instance. It indicates that a locked meeting has been joined by participants, but no hosts have joined.
This state applies to meeting series and meeting instance. For meeting series, this state indicates that an instance of this series is happening now; for meeting instance, it indicates that the meeting has been joined and unlocked.
This state applies to scheduled meeting and meeting instance. For scheduled meeting, it indicates that this scheduled meeting was started and is now over; for meeting instance, this state indicates that this meeting instance has concluded.
This state only applies to scheduled meeting. It indicates that the meeting was scheduled in the past but never happened.
This state only applies to meeting series. It indicates that all scheduled meetings of this series have passed.
Time zone of start and end, conforming with the IANA time zone database.
Start time for meeting in ISO 8601 compliant format. If the meeting is a meeting series, start is the date and time the first meeting of the series starts; if the meeting is a meeting series and current filter is true, start is the date and time the upcoming or ongoing meeting of the series starts; if the meeting is a scheduled meeting from a meeting series, start is the date and time when that scheduled meeting starts; if the meeting is a meeting instance that has happened or is happening, start is the date and time that instance actually starts. This attribute can be modified for meeting series or scheduled meeting by Update a Meeting API.
End time for meeting in ISO 8601 compliant format. If the meeting is a meeting series, end is the date and time the first meeting of the series ends; if the meeting is a meeting series and current filter is true, end is the date and time the upcoming or ongoing meeting of the series ends; if the meeting is a scheduled meeting from a meeting series, end is the date and time when that scheduled meeting ends; if the meeting is a meeting instance that has happened, end is the date and time that instance actually ends; if a meeting intance is in progress, end is not available. This attribute can be modified for meeting series or scheduled meeting by Update a Meeting API.
Meeting series recurrence rule (conforming with RFC 2445), applying only to recurring meeting series. It does not apply to meeting series with only one scheduled meeting. This attribute can be modified for meeting series by Update a Meeting API.
Unique identifier for meeting host. It's in the format of Base64Encode(ciscospark://us/PEOPLE/hostUserId). For example, a hostUserId is 7BABBE99-B43E-4D3F-9147-A1E9D46C9CA0, the actual value for it is Y2lzY29zcGFyazovL3VzL1BFT1BMRS83QkFCQkU5OS1CNDNFLTREM0YtOTE0Ny1BMUU5RDQ2QzlDQTA=.
Display name for meeting host.
Email address for meeting host.
Key for joining meeting as host.
Site URL for the meeting.
Link to meeting information page where meeting client will be launched if the meeting is ready for start or join.
SIP address for callback from a video system.
IP address for callback from a video system.
Room ID of the associated Teams space. This attribute only applies to space meeting.
Whether or not meeting is recorded automatically. This attribute can be modified for meeting series or scheduled meeting by Update a Meeting API.
Whether or not to allow any attendee with a host account on the target site to become a cohost when joining the meeting. The target site is specified by siteUrl parameter when creating the meeting; if not specified, it's user's preferred site. The allowAnyUserToBeCoHost attribute can be modified for meeting series or scheduled meeting by Update a Meeting API.
Whether or not to allow any attendee to join the meeting before the host joins the meeting. The enabledJoinBeforeHost attribute can be modified for meeting series or scheduled meeting by Update a Meeting API.
Whether or not to allow any attendee to connect audio in the meeting before host joins the meeting. This attribute is only applicable if the enabledJoinBeforeHost attribute is set to true. The enableConnectAudioBeforeHost attribute can be modified for meeting series or scheduled meeting by Update a Meeting API.
the number of minutes an attendee can join the meeting before the meeting start time and the host joins. This attribute is only applicable if the enabledJoinBeforeHost attribute is set to true. The joinBeforeHostMinutes attribute can be modified for meeting series or scheduled meeting by Update a Meeting API. Valid options are 0, 5, 10 and 15. Default is 0 if not specified.
Whether or not to exclude password from the meeting email invitation.
Whether or not to allow the meeting to be listed on the public calendar.
The number of minutes before the meeting begins, for sending an email reminder to the host.
Whether or not to automatically lock the meeting after it starts.
The number of minutes after the meeting begins, for automatically locking it.
Whether or not to allow the first attendee of the meeting with a host account on the target site to become a cohost. The target site is specified by siteUrl parameter when creating the meeting; if not specified, it's user's preferred site. The allowFirstUserToBeCoHost attribute can be modified for meeting series or scheduled meeting by Update a Meeting API.
Whether or not to allow authenticated video devices in the meeting's organization to start or join the meeting without a prompt. This attribute can be modified for meeting series or scheduled meeting by Update a Meeting API.
Information for callbacks from meeting to phone or for joining a teleconference using a phone.
Code for authenticating a user to join teleconference. Users join the teleconference using the call-in number or the global call-in number, followed by the value of the accessCode.
Array of call-in numbers for joining teleconference from a phone.
Label for call-in number.
Call-in number to join teleconference from a phone.
Type of toll for the call-in number.
HATEOAS information of global call-in numbers for joining teleconference from a phone.
Meeting registration. When this option is enabled, meeting invitee must register personal information in order to join the meeting. Meeting invitee will receive an email with a registration link for the registration. When the registration form has been submitted and approved, an email with a real meeting link will be received. By clicking that link the meeting invitee can join the meeting. Please note that meeting registration does not apply to a meeting when it's a recurring meeting with recurrence field or it has no password, or the Join Before Host option is enabled for the meeting. Read Register for a Meeting in Cisco Webex Meetings for details.
Whether or not meeting registration request is accepted automatically.
Whether or not registrant's first name is required for meeting registration.
Whether or not registrant's last name is required for meeting registration.
Whether or not registrant's email is required for meeting registration.
Whether or not registrant's job title is required for meeting registration.
Whether or not registrant's company name is required for meeting registration.
Whether or not registrant's 1st address is required for meeting registration.
Whether or not registrant's 2nd address is required for meeting registration.
Whether or not registrant's city is required for meeting registration.
Whether or not registrant's state is required for meeting registration.
Whether or not registrant's zip code is required for meeting registration.
Whether or not registrant's country or region is required for meeting registration.
Whether or not registrant's work phone number is required for meeting registration.
Whether or not registrant's fax number is required for meeting registration.
External keys created by an integration application in its own domain. They could be Zendesk ticket IDs, Jira IDs, Salesforce Opportunity IDs, etc.
Response Codes
The list below describes the common success and error responses you should expect from the API.
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | 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 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | 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 | Gone | The requested resource is no longer available. |
| 415 | 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 | 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 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | 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 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
Header
Query Parameters
- 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.
- Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin-level scopes. If set, the admin may specify the email of a user in a site they manage and the API will return details for a meeting that is hosted by that user.
{
"id": "870f51ff287b41be84648412901e0402",
"meetingNumber": "123456789",
"title": "Example Daily Meeting",
"agenda": "Example Agenda",
"password": "BgJep@43",
"phoneAndVideoSystemPassword": "12345678",
"meetingType": "meetingSeries",
"state": "active",
"timezone": "UTC",
"start": "2019-11-01T12:00:00Z",
"end": "2019-11-01T13:00:00Z",
"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",
"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,
"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"
}
]
},
"registration": {
"autoAcceptRequest": "false",
"requireFirstName": "true",
"requireLastName": "true",
"requireEmail": "true",
"requireJobTitle": "false",
"requireCompanyName": "true",
"requireAddress1": "false",
"requireAddress2": "false",
"requireCity": "false",
"requireState": "false",
"requireZipCode": "false",
"requireCountryRegion": "true",
"requireWorkPhone": "true",
"requireFax": "false"
},
"integrationTags": [
"dbaeceebea5c4a63ac9d5ef1edfe36b9",
"85e1d6319aa94c0583a6891280e3437d",
"27226d1311b947f3a68d6bdf8e4e19a1"
]
}