List Meetings

Retrieves details for meetings with a specified meeting number, web link, meeting type, etc.

  • If neither meetingNumber nor webLink is specified, the operation returns an array of all scheduled meeting instances.

  • If meetingNumber or webLink is specified, the operation returns an array of meeting objects specified by the meetingNumber or webLink value. Each object in the array can be a meeting series, a scheduled meeting, or a meeting instance which has actually happened or is happening, depending on the meetingType parameter. Please note that meetingNumber and webLink are mutually exclusive, which cannot be specified simultaneously.

  • If state parameter is specified, the returned array only has items in the specified state. If state is not specified, return items of all states.

  • If isModified parameter is specified, the returned array only has items which have been modified to exceptional meetings. This parameter only applies to scheduled meeting.

  • The current parameter only applies to meeting series. If current value is false, the start and end attributes of each returned meeting series object are for the first scheduled meeting of that series. If current value is true or not specified, the start and end attributes are for the meeting instance which is actually happening or the upcoming scheduled meeting.

  • If from and to are specified, the operation returns an array of meeting objects in that specified time range.

GET/v1/meetings
Query Parameters
meetingNumber
string

Meeting number for the meeting objects being requested. meetingNumber and webLink are mutually exclusive.

webLink
string

URL encoded link to information page for the meeting objects being requested. meetingNumber and webLink are mutually exclusive.

meetingType
string

Meeting type for the meeting objects being requested. The default value is meetingSeries.

Possible values: meetingSeries, scheduledMeeting, meeting
state
string

Meeting state for the meeting objects being requested. If not specified, return meetings of all states.

Possible values: active, scheduled, ready, lobby, inProgress, ended, missed, expired
participantEmail
string

Meeting participant email address for the meeting objects being requested.

current
boolean

Whether or not to only retrieve 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.

Default: true
from
string

Start date and time (inclusive) in any ISO 8601 compliant format for the meeting objects being requested.

Default: Current date and time
to
String

End date and time (exclusive) in any ISO 8601 compliant format for the meeting objects being requested.

Default: If `from` is specified, the default value is `from` plus 7 days; if `from` is not specified, the default value is current date and time plus 7 days.
max
number

Limit the maximum number of meetings in the response, up to 100.

Default: 10
Response Properties
items
array

Meetings array

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.

meetingSeriesId
string

Unique identifier for meeting series. If it's a meeting series, meetingSeriesId is the same as id; if it's a scheduled meeting from a series or a meeting instance that is happening or has happened, the meetingSeriesId is the id of the master series.

scheduledMeetingId
string

Unique identifier for scheduled meeting which current meeting is associated with. It only apples to scheduled meeting and meeting instance. If the meeting is a scheduled meeting, scheduledMeetingId is the same as id; if the meeting is a meeting instance that is happening or has happened, scheduledMeetingId is the id of the scheduled meeting this instance is associated with.

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

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.

inProgress

This state applies to meeting series, scheduled meeting and meeting instance. For meeting series, this state indicates that a meeting instance of this series is happening; for scheduled meeting, it indicates a meeting instance of this scheduled meeting is happening; for meeting instance, the current instance is happening.

ended

This state applies to scheduled meeting and meeting instance. For scheduled meeting, it indicates that one or more meeting instances have been started for this scheduled meeting and now the scheduled meeting is over since it has passed the scheduled end time of the scheduled meeting; for meeting instance, this state indicates that this instance is ended.

missed

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

expired

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

isModified
boolean

This state only applies to scheduled meeting. Flag identifying whether or not the scheduled meeting has been modified.

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.

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.

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.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe 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.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe 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.
410GoneThe requested resource is no longer available.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
423LockedThe 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.
429Too Many RequestsToo 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.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
GET
/v1/meetings{?meetingNumber,webLink,meetingType,state,participantEmail,isModified,current,max,from,to}
Log in to try the API.
Header
Query Parameters
  • Meeting number for the meeting objects being requested. `meetingNumber` and `webLink` are mutually exclusive.
  • URL encoded link to information page for the meeting objects being requested. `meetingNumber` and `webLink` are mutually exclusive.
  • Meeting type for the meeting objects being requested. The default value is `meetingSeries`.
  • Meeting state for the meeting objects being requested. If not specified, return meetings of all states.
  • Meeting participant email address for the meeting objects being requested.
  • Whether or not to only retrieve 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.
  • Start date and time (inclusive) in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format for the meeting objects being requested.
  • End date and time (exclusive) in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format for the meeting objects being requested.
  • Limit the maximum number of meetings in the response, up to 100.
https://webexapis.com/v1/meetings?meetingNumber=716052238&webLink=https%253A%252F%252Fgo.webex.com%252Fgo%252Fj.php%253FMTID%253Dm066878aef4343e74c98b48439b71acfd&meetingType=%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D&state=%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D&participantEmail=john.andersen@example.com&current=false&from=2019-03-18T09:30:00+08:00&to=2019-03-25T09:30:00+08:00&max=100
200 / OK
{
    "items": [
        {
            "id": "870f51ff287b41be84648412901e0402_20191101T120000Z",
            "meetingSeriesId": "870f51ff287b41be84648412901e0402",
            "scheduledMeetingId": "870f51ff287b41be84648412901e0402_20191101T120000Z",
            "meetingNumber": "713022345",
            "title": "Sample Daily meeting",
            "agenda": "Sample Agenda",
            "password": "BgJep@43",
            "meetingType": "scheduledMeeting",
            "state": "ready",
            "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",
            "hostKey": "184245",
            "webLink": "https://site4-example.webex.com/site4/j.php?MTID=md41817da6a55b0925530cb88b3577b1e",
            "sipAddress": "713022345@site4-example.webex.com",
            "dialInIpAddress": "10.224.10.10",
            "enabledAutoRecordMeeting": false,
            "allowAnyUserToBeCoHost": false,
            "telephony": {
                "accessCode": "713022345",
                "callInNumbers": [
                    {
                        "label": "US Toll",
                        "callInNumber": "14085452910",
                        "tollType": "toll"
                    }
                ],
                "links": [
                    {
                        "rel": "globalCallinNumbers",
                        "href": "/api/v1/meetings/870f51ff287b41be84648412901e0402_20191101T120000Z/globalCallinNumbers",
                        "method": "GET"
                    }
                ]
            }
        }
    ]
}