Get Scheduling Options

Retrieves scheduling options for the authenticated user.

GET/v1/meetingPreferences/schedulingOptions
Response Properties
enabledJoinBeforeHost
boolean

Flag to enable/disable Join Before Host. The period during which invitees can join before the start time is defined by autoLockMinutes. This attribute can be modified by Update Scheduling Options API. Note: This feature is only effective if the site supports the Join Before Host feature. This attribute can be modified by Update Scheduling Options API.

joinBeforeHostMinutes
number

Number of minutes before the start time that an invitee can join a meeting if enabledJoinBeforeHost is true. Valid options are 0, 5, 10 and 15. This attribute can be modified by Update Scheduling Options API.

enabledAutoShareRecording
boolean

Flag to enable/disable the automatic sharing of the meeting recording with invitees when it is available. This attribute can be modified by Update Scheduling Options API.

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/meetingPreferences/schedulingOptions
Log in to try the API.
Header
200 / OK
{
    "enabledJoinBeforeHost": false,
    "joinBeforeHostMinutes": 10,
    "enabledAutoShareRecording": false
}