Get Audio Options

Retrieves audio options options for the authenticated user.

GET/v1/meetingPreferences/audio
Response Properties
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.

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/audio
Log in to try the API.
Header
200 / OK
{
    "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
    }
}