APIs
XML API DeprecationGetting StartedREST API BasicsComplianceWebhooksWebex APIs
Admin
Calling
Contact Center
Devices
Meetings
Messaging
Webex Assistant Skills
FedRAMP
Full API Reference
Admin Audit EventsAttachment ActionsAuthorizationsBroadWorks Device ProvisioningBroadWorks EnterprisesBroadWorks SubscribersCall ControlsDevice ConfigurationsDevicesEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting ParticipantsMeeting PreferencesMeeting QualitiesMeeting TranscriptsMeetingsMeetings Test FileMembershipsMessagesMock API for integration testOrganizationsPeoplePlacesRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesRoom TabsRoomsSpace ClassificationsTeam MembershipsTeamsWebex Calling Organization SettingsWebex Calling Organization Settings with NumbersWebex Calling Person SettingsWebex Calling Voice MessagingWebex Calling Workspace Settings with NumbersWebhooksWholesale CustomersWholesale SubscribersWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
API Changelog

List Meeting Session Types

List all the meeting session types enabled for a given user.

GET/v1/meetings/sessionTypes
Query Parameters
hostEmail
string

Email address for the user. 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 list all the meeting session types enabled for the user.

siteUrl
string

Webex site URL to query. If siteUrl is not specified, the users' preferred site will be used. If the authorization token has the admin-level scopes, the admin can set the Webex site URL on behalf of the user specified in the hostEmail parameter.

Response Properties
items
array[MeetingSessionTypeObject]

Meeting session type array

id
string

Unique identifier for the meeting session type.

name
string

Name of the meeting session type.

type
enum

Meeting session type.

meeting
string

Meeting session type for a meeting.

webinar
string

Meeting session type for a webinar.

privateMeeting
string

Meeting session type for a private meeting.

attendeesCapacity
number

The maximum number of attendees for the meeting session type.

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.
428Precondition RequiredFile(s) cannot be scanned for malware and need to be force downloaded.
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.
504Gateway TimeoutAn upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.
GET
/v1/meetings/sessionTypes{?hostEmail,siteUrl}
Log in to try the API.
Header
Query Parameters
  • Email address for the user. 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 list all the meeting session types enabled for the user.
  • Webex site URL to query. If `siteUrl` is not specified, the users' preferred site will be used. If the authorization token has the admin-level scopes, the admin can set the Webex site URL on behalf of the user specified in the `hostEmail` parameter.
https://webexapis.com/v1/meetings/sessionTypes?hostEmail=john.andersen@example.com&siteUrl=site4-example.webex.com
200 / OK
{
  "items": [
    {
      "id": "628",
      "name": "Webex Meetings EC 2.0 meeting",
      "type": "meeting",
      "attendeesCapacity": 1000
    }
  ]
}