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 Meeting Preference Details

Retrieves meeting preferences for the authenticated user.

GET/v1/meetingPreferences
Response Properties
personalMeetingRoom
PMRObject

Personal Meeting Room options.

audio
AudioObject

Audio Preferences. Note: These audio settings do not apply to Personal Room meetings

video
GetVideoObject

Information for video conferencing systems used to connect to Webex meetings. Note: The Call My Video System feature is available only if it has been purchased for your site and your administrator has enabled it.

schedulingOptions
SchedulingOptionsObject

Meeting scheduling options.

sites
array

List of user's Webex meeting sites including default site.

siteUrl
string

Access URL for the site. Note: This is a read-only attribute. The value can be assigned as user's default site by Update Default Site of Meeting Preference API.

default
boolean

Flag identifying the site as the default site. Users can list meetings and recordings, and create meetings on the default site.

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
Log in to try the API.
Header
200 / OK
{
    "audio": {
        "defaultAudioType": "webexAudio",
        "otherTeleconferenceDescription": "alxm2",
        "enabledGlobalCallIn": true,
        "enabledTollFree": false,
        "enabledAutoConnection": false,
        "audioPin": "1314",
        "officeNumber": {
            "countryCode": "123",
            "number": "123456",
            "enabledCallInAuthentication": false,
            "enabledCallMe": false
        },
        "mobileNumber": {
            "countryCode": "1",
            "number": "10000000000",
            "enabledCallInAuthentication": false,
            "enabledCallMe": true
        }
    },
    "video": {
        "videoDevices": [
            {
                "deviceName": "device1",
                "deviceAddress": "device1@example.com",
                "isDefault": false
            },
            {
                "deviceName": "device2",
                "deviceAddress": "device2@example.com",
                "isDefault": true
            }
        ]
    },
    "schedulingOptions": {
        "enabledJoinBeforeHost": false,
        "joinBeforeHostMinutes": 0,
        "enabledAutoShareRecording": false
    },
    "sites": [
        {
            "siteUrl": "site1-example.webex.com",
            "default": false
        },
        {
            "siteUrl": "site2-example.webex.com",
            "default": false
        },
        {
            "siteUrl": "site3-example.webex.com",
            "default": false
        },
        {
            "siteUrl": "site4-example.webex.com",
            "default": true
        }
    ],
    "personalMeetingRoom": {
        "topic": "John's PMR",
        "hostPin": "5914",
        "enabledAutoLock": true,
        "autoLockMinutes": 15,
        "enabledNotifyHost": true,
        "supportCoHost": true,
        "supportAnyoneAsCoHost": false,
        "coHosts": [
            {
                "email": "brenda.song@example.com",
                "displayName": "Brenda Song"
            }
        ],
        "personalMeetingRoomLink": "https://site4-example.webex.com/meet/john"
    }
}