Get a Meeting

Retrieves details for a meeting with a specified meeting ID.

  • 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.

GET/v1/meetings/{meetingId}
URI Parameters
meetingId
stringrequired

Unique identifier for the meeting being requested.

Query Parameters
current
boolean

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.

Default: false
Response Properties
id
string

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.

meetingNumber
string

Meeting number. This attribute applies to meeting series, scheduled meeting and meeting instance, but it does not apply to meeting instances which have ended.

title
string

Meeting title. This attribute can be modified for meeting series or scheduled meeting by Update a Meeting API.

agenda
string

Meeting agenda. The agenda can be a maximum of 2500 characters long. This attribute can be modified for meeting series or scheduled meeting by Update a Meeting API.

password
string

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.

phoneAndVideoSystemPassword
string

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.

meetingType
enum

Meeting type.

meetingSeries

Master of a scheduled series of meetings which consists of one or more scheduled meeting based on a recurrence rule.

scheduledMeeting

Instance from a master meeting series.

meeting

meeting instance that is actually happening or has happened.

state
enum

Meeting state.

active

This state only applies to meeting series. It indicates that one or more future scheduled meeting exist for this meeting series.

scheduled

This state only applies to scheduled meeting. It indicates that the meeting is scheduled in the future.

ready

This state only applies to scheduled meeting. It indicates that this scheduled meeting is ready to start or join now.

lobby

This state only applies to meeting instance. It indicates that a locked meeting has been joined by participants, but no hosts have joined.

inProgress

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.

ended

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.

missed

This state only applies to scheduled meeting. It indicates that the meeting was scheduled in the past but never happened.

expired

This state only applies to meeting series. It indicates that all scheduled meetings of this series have passed.

timezone
string

Time zone of start and end, conforming with the IANA time zone database.

start
string

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
string

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.

recurrence
string

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.

hostUserId
string

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=.

hostDisplayName
string

Display name for meeting host.

hostEmail
string

Email address for meeting host.

hostKey
string

Key for joining meeting as host.

webLink
string

Link to meeting information page where meeting client will be launched if the meeting is ready for start or join.

sipAddress
string

SIP address for callback from a video system.

dialInIpAddress
string

IP address for callback from a video system.

enabledAutoRecordMeeting
boolean

Whether or not meeting is recorded automatically. This attribute can be modified for meeting series or scheduled meeting by Update a Meeting API.

allowAnyUserToBeCoHost
boolean

Whether or not to allow any invitee to be a cohost. This attribute can be modified for meeting series or scheduled meeting by Update a Meeting API.

telephony
object

Information for callbacks from meeting to phone or for joining a teleconference using a phone.

accessCode
string

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.

callInNumbers
array

Array of call-in numbers for joining teleconference from a phone.

label

Label for call-in number.

Possible values: Call-in toll-free number (US/Canada)
callInNumber

Call-in number to join teleconference from a phone.

Possible values: 123456789
tollType

Type of toll for the call-in number.

Possible values: toll, tollFree
links
object

HATEOAS information of global call-in numbers for joining teleconference from a phone.

rel
string

Link relation describing how the target resource is related to the current context (conforming with RFC5998).

href
string

Target resource URI (conforming with RFC5998).

method
string

Target resource method (conforming with RFC5998).

Response Codes

The list below describes the common success and error responses you should expect from the API.

CodeStatusDescription
200OKSuccessful request with body content.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
  1. | 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. |
GET
/v1/meetings/{?current}
Log in to try the API.
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.
https://webexapis.com/v1/meetings/25bbf831-5be9-4c25-b4b0-9b592c8a086b?current=false
200 / OK
{
    "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",
    "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,
    "telephony": {
        "accessCode": "1234567890",
        "callInNumbers": [
            {
                "label": "US Toll",
                "callInNumber": "123456789",
                "tollType": "toll"
            }
        ],
        "links": [
            {
                "rel": "globalCallinNumbers",
                "href": "/api/v1/meetings/870f51ff287b41be84648412901e0402/globalCallinNumbers",
                "method": "GET"
            }
        ]
    }
}