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 digits of a predefined length, e.g. 4 digits. It cannot contain sequential digits, such as 1234 or 4321, or repeated digits of the predefined length, such as 1111. The predefined length for host PIN can be viewed in user's My Personal Room page and it can only be changed by site administrator. 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

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

Possible values: john.andersen@example.com
displayName

Display name for cohost. This attribute can be modified by Update Personal Meeting Room Options API.

Possible values: John Andersen
sipAddress
string

SIP address for callback from a video system.

dialInIpAddress
string

IP address for callback from a video system.

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/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",
    "sipAddress": "john.andersen@example.com",
    "dialInIpAddress": "192.168.100.100",
    "telephony": {
        "accessCode": "1234567890",
        "callInNumbers": [
            {
                "label": "US Toll",
                "callInNumber": "123456789",
                "tollType": "toll"
            }
        ],
        "links": [
            {
                "rel": "globalCallinNumbers",
                "href": "/v1/meetings/0fc6ec1109e0d9b6c94e1f6caccda976/globalCallinNumbers",
                "method": "GET"
            }
        ]
    }
}