Test Environment. You are currently using the Webex for Developers test environment. Apps created here will not be available for use with Webex Teams. Please visit Webex for Developers to manage your apps.

Get Personal Meeting Room Options

Retrieves the Personal Meeting Room options for the authenticated user.

GET/v1/meetingPreferences/personalMeetingRoom
Response Properties
topic
string

Personal Meeting Room topic. The length of topic is between 1 and 128. This attribute can be modified by Update Personal Meeting Room Options API.

hostPin
string

PIN for joining the room as host. The host PIN must be exactly 4 digits. It cannot contain sequential digits, such as 1234, or repeat a digit 4 times, such as 1111. This attribute can be modified by Update Personal Meeting Room Options API.

personalMeetingRoomLink
string

Personal Meeting Room link. It cannot be empty. Note: This is a read-only attribute.

enabledAutoLock
boolean

Option to automatically lock the Personal Room a number of minutes after a meeting starts. When a room is locked, invitees cannot enter until the owner admits them. The period after which the meeting is locked is defined by autoLockMinutes. This attribute can be modified by Update Personal Meeting Room Options API.

autoLockMinutes
number

Number of minutes after which the Personal Room is locked if enabledAutoLock is enabled. Valid options are 0, 5, 10, 15 and 20. This attribute can be modified by Update Personal Meeting Room Options API.

enabledNotifyHost
boolean

Flag to enable notifying the owner of a Personal Room when someone enters the Personal Room lobby while the owner is not in the room. This attribute can be modified by Update Personal Meeting Room Options API.

supportCoHost
boolean

Flag allowing other invitees to host a meeting in the Personal Room without the owner. This attribute can be modified by Update Personal Meeting Room Options API.

supportAnyoneAsCoHost
boolean

Flag allowing anyone with a host account on the Webex site to be a cohost for meetings in the Personal Room. If this flag is set false, the owner can choose cohosts for Personal Room meetings. This attribute can be modified by Update Personal Meeting Room Options API.

coHosts
array

Array defining cohosts for the room if the supportAnyoneAsCoHost attribute is set false. This attribute can be modified by Update Personal Meeting Room Options API.

email
string

Email address for cohost. This attribute can be modified by Update Personal Meeting Room Options API.

displayName
string

Display name for cohost. This attribute can be modified by Update Personal Meeting Room 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.
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/meetingPreferences/personalMeetingRoom
Log in to try the API.
Header
200 / OK
{
    "topic": "John's PMR",
    "hostPin": "4325",
    "enabledAutoLock": false,
    "autoLockMinutes": 10,
    "enabledNotifyHost": true,
    "supportCoHost": true,
    "supportAnyoneAsCoHost": false,
    "coHosts": [
        {
            "email": "john.andersen@example.com",
            "displayName": "John Andersen"
        }
    ],
    "personalMeetingRoomLink": "https://site4-example.webex.com/meet/john"
}