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
object

Personal Meeting Room options.

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. 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).

audio
object

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

defaultAudioType
enum

Default audio type. This attribute can be modified by Update Audio Options API.

webexAudio

Webex audio. This supports telephony and VoIP.

voipOnly

Support only VoIP.

otherTeleconferenceService

Other teleconference service. Details are defined in the otherTeleconferenceDescription parameter.

none

No audio.

otherTeleconferenceDescription
string

Phone number and other information for the teleconference provider to be used, along with instructions for invitees. This attribute can be modified by Update Audio Options API.

enabledGlobalCallIn
boolean

Flag to enable/disable global call ins. Note: If the site does not support global call-ins, you cannot set this option. This attribute can be modified by Update Audio Options API.

enabledTollFree
boolean

Flag to enable/disable call-ins from toll-free numbers. Note: If the site does not support calls from toll-free numbers, you cannot set this option. This attribute can be modified by Update Audio Options API.

enabledAutoConnection
boolean

Flag to enable/disable automatically connecting to audio using a computer. The meeting host can enable/disable this option. When this option is set to true, the user is automatically connected to audio via a computer when they start or join a Webex Meetings meeting on a desktop. This attribute can be modified by Update Audio Options API.

audioPin
string

PIN to provide a secondary level of authentication for calls where the host is using the phone and may need to invite additional invitees. It must be exactly 4 digits. It cannot contain sequential digits, such as 1234 or 4321, or repeat a digit 4 times, such as 1111. This attribute can be modified by Update Audio Options API.

officeNumber
PhoneNumberObject

Office phone number. We recommend that phone numbers be specified to facilitate connecting via audio. This attribute can be modified by Update Audio Options API.

mobileNumber
PhoneNumberObject

Mobile phone number. We recommend that phone numbers be specified to facilitate connecting via audio. This attribute can be modified by Update Audio Options API.

video
object

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.

videoDevices
array

Array of video devices. This attribute can be modified by Update Video Options API.

deviceName

Video system name. It cannot be empty. This attribute can be modified by Update Video Options API.

Possible values: device1
deviceAddress

Video address. It cannot be empty and must be in valid email format. This attribute can be modified by Update Video Options API.

Possible values: device1@example.com
isDefault

Flag identifying the device as the default video device. If user's video device list is not empty, one and only one device must be set as default. This attribute can be modified by Update Video Options API.

Possible values:
schedulingOptions
SchedulingOptionsObject

Meeting scheduling options.

sites
array

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

siteUrl

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.

Possible values: site1-example.webex.com
default

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

Possible values:
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/meetingPreferences
Log in to try the API.
Header
200 / OK
{
    "audio": {
        "defaultAudioType": "webexAudio",
        "otherTeleconferenceDescription": "Example Description",
        "enabledGlobalCallIn": true,
        "enabledTollFree": false,
        "enabledAutoConnection": false,
        "audioPin": "1314",
        "officeNumber": {
            "countryCode": "123",
            "number": "123456",
            "enabledCallInAuthentication": false,
            "enabledCallMe": false
        },
        "mobileNumber": {
            "countryCode": "1",
            "number": "123456789",
            "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": "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"
                }
            ]
        }
    }
}